qyriad/miden-crypto
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
116 commits 10 branches 0 tags 2.3 MiB
Find a file
Augusto F. Hack 0375f31035
feat: added utility to format MerkleTree and MerklePath to hex 
Example formatted MerkleTree:

```
880abe452320966617646e7740b014954300f19a28780a0889d62ff33f4b0534
  1ade1369091efa31201e9b60c9c28874d0ddce5362b335135a6bb4c917285983
  3e60a9c843b4bb19f7a0572102e6507195f5240767a396335fd21981b048b807
    0100000000000000000000000000000000000000000000000000000000000000
    0200000000000000000000000000000000000000000000000000000000000000
    0300000000000000000000000000000000000000000000000000000000000000
    0400000000000000000000000000000000000000000000000000000000000000
```

Example formatted MerklePath:

```
[0400000000000000000000000000000000000000000000000000000000000000, 1ade1369091efa31201e9b60c9c28874d0ddce5362b335135a6bb4c917285983]
```
2023-03-22 21:53:05 +01:00
.github chore: initial run pre-commit 2023-03-01 17:45:57 +01:00
benches bugfix: fix store benchmark 2023-03-22 10:53:12 +01:00
src feat: added utility to format MerkleTree and MerklePath to hex 2023-03-22 21:53:05 +01: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 feat: add benchmark for storages 2023-03-21 14:29:18 +01:00
CHANGELOG.md feat: re-export winter-crypto Hasher, Digest & ElementHasher 2023-02-22 16:56:14 +01:00
CONTRIBUTING.md chore: initial run pre-commit 2023-03-01 17:45:57 +01:00
LICENSE Initial commit 2022-10-03 14:30:23 -07:00
README.md docs: fix typos in doc comments 2023-02-17 11:58:23 -08: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 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.

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.