qyriad/miden-crypto
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
136 commits 10 branches 0 tags 2.3 MiB
Rust 97.1%
C 2.4%
Makefile 0.4%
Shell 0.1%
Find a file
Victor Lopez d37f3f5e84
feat: Add depth as store SMT argument 
Prior to this commit, MerkleStore allowed the creation of Sparse Merkle
tree only with the maximum depth of 63. However, this doesn't fit the
Tiered Sparse Merkle tree requirements, as it will contain trees of
depth 16.

This commit adds the `depth` argument to the MerkleStore methods that
will create Sparse Merkle trees.
2023-03-30 01:13:05 +02:00
.github chore: initial run pre-commit 2023-03-01 17:45:57 +01:00
benches feat: Add depth as store SMT argument 2023-03-30 01:13:05 +02:00
src feat: Add depth as store SMT argument 2023-03-30 01:13:05 +02:00
.git-blame-ignore-revs chore: ignore pre-commit rev 2023-03-01 18:32:24 +01:00
.gitignore Initial commit 2022-10-03 14:30:23 -07:00
.pre-commit-config.yaml feat: added pre-commit hook config 2023-03-01 17:45:33 +01:00
Cargo.toml chore: update crate versions, dependencies, and CHANGELOG 2023-03-24 14:58:19 -07:00
CHANGELOG.md chore: add winterfell dependency update to changelog 2023-03-25 00:45:17 -07:00
CONTRIBUTING.md chore: initial run pre-commit 2023-03-01 17:45:57 +01:00
LICENSE chore: update crate versions, dependencies, and CHANGELOG 2023-03-24 14:58:19 -07:00
README.md feat: Add depth as store SMT argument 2023-03-30 01:13:05 +02:00

README.md

Miden Crypto

This crate contains cryptographic primitives used in Polygon Miden.

Hash

Hash module provides a set of cryptographic hash functions which are used by the Miden VM and the Miden rollup. Currently, these functions are:

  • BLAKE3 hash function with 256-bit, 192-bit, or 160-bit output. The 192-bit and 160-bit outputs are obtained by truncating the 256-bit output of the standard BLAKE3.
  • RPO hash function with 256-bit output. This hash function is an algebraic hash function suitable for recursive STARKs.

For performance benchmarks of these hash functions and their comparison to other popular hash functions please see here.

Merkle

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 64-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.
  • MerkleStore: a collection of Merkle trees of different heights designed to efficiently store trees with common subtrees.
  • Mmr: a Merkle mountain range structure designed to function as an append-only log.

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.

Extra

Root module provides a set of constants, types, aliases, and utils required to use the primitives of this library.

Crate features

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.

Testing

You can use cargo defaults to test the library:

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.

RUSTFLAGS="-C debug-assertions -C overflow-checks -C debuginfo=2" cargo test --release

License

This project is MIT licensed.