Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antouhou/rs-merkle
The most advanced Merkle tree library for Rust
https://github.com/antouhou/rs-merkle
bitcoin ethereum hash-trees hashtree merkle merkle-multiproof merkle-proof merkle-tree rust
Last synced: 4 days ago
JSON representation
The most advanced Merkle tree library for Rust
- Host: GitHub
- URL: https://github.com/antouhou/rs-merkle
- Owner: antouhou
- License: mit
- Created: 2021-09-22T14:54:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T10:41:44.000Z (3 months ago)
- Last Synced: 2024-08-01T13:35:44.931Z (3 months ago)
- Topics: bitcoin, ethereum, hash-trees, hashtree, merkle, merkle-multiproof, merkle-proof, merkle-tree, rust
- Language: Rust
- Homepage:
- Size: 98.6 KB
- Stars: 164
- Watchers: 4
- Forks: 45
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ccamel - antouhou/rs-merkle - The most advanced Merkle tree library for Rust (Rust)
README
# rs-merkle
[](https://crates.io/crates/rs_merkle)
[](https://docs.rs/rs_merkle)
[](https://github.com/antouhou/rs-merkle/actions)
`rs-merkle` is the most advanced Merkle tree library for Rust. Basic features
include building a Merkle tree, creation, and verification of Merkle proofs for
single and several elements, i.e. multi-proofs. Advanced features include making
transactional changes to the tree and rolling back to any previously committed
tree state, similarly to Git.
The library is highly customizable. Hashing function and the way how the tree
is built can be easily configured through a special trait.
`rs-merkle` is
[available on crates.io](https://crates.io/crates/rs_merkle), and
[API Documentation is available on docs.rs](https://docs.rs/rs_merkle/).
## About Merkle trees
Merkle trees, also known as hash trees, are used to verify that two or more
parties have the same data without exchanging the entire data collection.
Merkle trees are used in Git, Mercurial, ZFS, IPFS, Bitcoin, Ethereum, Cassandra,
and many more. In Git, for example, Merkle trees are used to find a delta
between the local and remote repository states to transfer only the difference
between them over the network. In Bitcoin, Merkle trees are used to verify that
a transaction was included in the block without downloading the whole block
contents. ZFS uses Merkle trees to quickly verify data integrity, offering
protection from silent data corruption caused by phantom writes, bugs in disk
firmware, power surges, and other causes.
## Usage
Add the following to your `Cargo.toml`:
```toml
[dependencies]
rs_merkle = "1.4"
```
This crate also can be used on the no-std targets. To use as a dependency
in a project that requires no-std, disable default features:
```toml
[dependencies]
rs_merkle = { version = "1.4", default-features = false }
```
## Documentation
[Documentation is available on docs.rs](https://docs.rs/rs_merkle/).
## Contributing
Everyone is welcome to contribute in any way or form! For further details,
please read [CONTRIBUTING.md](./CONTRIBUTING.md)
## Authors
- [Anton Suprunchuk](https://github.com/antouhou) - [Website](https://antouhou.com)
Also, see the list of contributors who participated in this project.
## License
This project is licensed under the MIT License - see the
[LICENSE.md](./LICENSE.md) file for details