2022-07-22 09:48:24 -07:00
|
|
|
# `bridgetree`
|
|
|
|
|
|
|
|
|
|
This is a Rust crate that provides an implementation of an append-only Merkle
|
|
|
|
|
tree structure. Individual leaves of the merkle tree may be marked such that
|
|
|
|
|
witnesses will be maintained for the marked leaves as additional nodes are
|
|
|
|
|
appended to the tree, but leaf and node data not specifically required to
|
|
|
|
|
maintain these witnesses is not retained, for space efficiency. The data
|
|
|
|
|
structure also supports checkpointing of the tree state such that the tree may
|
|
|
|
|
be reset to a previously checkpointed state, up to a fixed number of
|
|
|
|
|
checkpoints.
|
|
|
|
|
|
|
|
|
|
The crate also supports using "bridges" containing the minimal possible amount
|
|
|
|
|
of data to advance witnesses for marked leaves data up to recent checkpoints or
|
|
|
|
|
the the latest state of the tree without having to append each intermediate
|
|
|
|
|
leaf individually, given a bridge between the desired states computed by an
|
|
|
|
|
outside source. The state of the tree is internally represented as a set of such
|
|
|
|
|
bridges, and the data structure supports fusing and splitting of bridges.
|
|
|
|
|
|
|
|
|
|
## [`Documentation`](https://docs.rs/bridgetree)
|
2021-06-24 13:14:30 -07:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Licensed under either of
|
|
|
|
|
|
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
|
|
|
|
|
|
at your option.
|
|
|
|
|
|
|
|
|
|
### Contribution
|
|
|
|
|
|
2022-07-22 09:48:24 -07:00
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
|
|
|
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
|
|
|
|
|
be dual licensed as above, without any additional terms or conditions.
|
