This crate contains cryptographic primitives used in Polygon Miden.
Hash module provides a set of cryptographic hash functions which are used by the Miden VM and the Miden rollup. Currently, these functions are:
For performance benchmarks of these hash functions and their comparison to other popular hash functions please see here.
Merkle module provides a set of data structures related to Merkle trees. All these data structures are implemented using the RPO hash function described above. The data structures are:
MerkleTree: a regular fully-balanced binary Merkle tree. The depth of this tree can be at most 64.SimpleSmt: a Sparse Merkle Tree, mapping 63-bit keys to 4-element leaf values.MerklePathSet: a collection of Merkle authentication paths all resolving to the same root. The length of the paths can be at most 64.The module also contains additional supporting components such as NodeIndex, MerklePath, and MerkleError to assist with tree indexation, opening proofs, and reporting inconsistent arguments/state.
Root module provides a set of constants, types, aliases, and utils required to use the primitives of this library.
This crate can be compiled with the following features:
std - enabled by default and relies on the Rust standard library.no_std does not rely on the Rust standard library and enables compilation to WebAssembly.Both of these features imply the use of alloc to support heap-allocated collections.
To compile with no_std, disable default features via --no-default-features flag.
You can use cargo defaults to test the library:
shell
cargo test
However, some of the functions are heavy and might take a while for the tests to complete. In order to test in release mode, we have to replicate the test conditions of the development mode so all debug assertions can be verified.
We do that by enabling some special flags for the compilation.
shell
RUSTFLAGS="-C debug-assertions -C overflow-checks -C debuginfo=2" cargo test --release
This project is MIT licensed.