32 releases (18 breaking)

0.22.1 Sep 16, 2022
0.22.0 Jun 21, 2022
0.21.0 Jul 17, 2020
0.17.0 Mar 25, 2020
0.7.1 Jul 1, 2019

#52 in Cryptography

Download history 2650/week @ 2022-12-01 3081/week @ 2022-12-08 1778/week @ 2022-12-15 598/week @ 2022-12-22 1039/week @ 2022-12-29 2404/week @ 2023-01-05 2087/week @ 2023-01-12 1949/week @ 2023-01-19 1847/week @ 2023-01-26 3136/week @ 2023-02-02 3638/week @ 2023-02-09 4111/week @ 2023-02-16 3454/week @ 2023-02-23 2217/week @ 2023-03-02 2909/week @ 2023-03-09 2801/week @ 2023-03-16

12,510 downloads per month
Used in 26 crates (10 directly)

BSD-3-Clause

255KB
5.5K SLoC

merkle

Build Status Issues License

merkle is a lightweight Rust implementation of a Merkle tree.

Features

  • external dependency agnostic
  • std::hash::Hasher compatibility
  • standard types hasher implementations
  • #[derive(Hashable)] support for simple struct
  • customizable merkle leaf/node hashing algorithm
  • support for custom hash types (e.g. [u8; 16], [u64; 4], [u128; 2], struct)
  • customizable hashing algorithm
  • linear memory layout, no nodes on heap
  • buildable from iterator, objects or hashes
  • certificate transparency style merkle hashing support
  • SPV support included (via proof type)
  • supports power of 2 arity merkletrees (only)
  • supports compound merkletrees (a tree of merkletrees)
  • supports compound-compound merkletrees (a tree of compound merkletrees)

Documentation

Documentation is available.

Examples

The most relevant examples are located in the following files:

  • test_common.rs: custom hash example xor128, misc shared utils
  • test_xor128.rs: most comprehensive tests for library features
  • proof.rs: contains impl and tests for proofs across pow2 arity trees

Building and testing

# Run tests in release mode
cargo test --release --all

# Run ignored tests in release mode
cargo test --release --all -- --ignored

Bug Reporting

Please report bugs either as pull requests or as issues in the issue tracker. merkle has a full disclosure vulnerability policy. Please do NOT attempt to report any security vulnerability in this code privately to anybody.

License

See LICENSE.

Dependencies

~3–9.5MB
~167K SLoC