mssmt

Crates.io	mssmt
lib.rs	mssmt
version	0.0.7
created_at	2024-10-25 16:21:16.08227+00
updated_at	2025-03-12 17:37:06.08453+00
description	A Rust implementation of the Merkle Sum Sparse Merkle Tree (MSSMT)
homepage
repository	https://github.com/keep-starknet-strange/mssmt-rs
max_upload_size
id	1422702
size	6,598,402

0xLucqs (0xLucqs)

documentation

README

Overview

The Merkle Sum Sparse Merkle Tree combines the properties of both Merkle Sum Trees and Sparse Merkle Trees, providing:

• Efficient sparse storage with compact proofs
• Sum aggregation at each level
• Cryptographic verification
• Flexible storage backend through the Db trait
• Support for both regular and compact tree implementations

Features

• Generic over hash size and hasher type
• Thread-safe with optional multi-threading support
• Memory-efficient storage with compact leaf nodes
• Proof compression and decompression
• Comprehensive test coverage including BIP test vectors
• CI/CD pipeline with code coverage reporting

Usage

Add this to your Cargo.toml:

[dependencies]
merkle-sum-sparse-merkle-tree = "0.6.0"

Basic example using regular tree:

use merkle_sum_sparse_merkle_tree::{MSSMT, MemoryDb, Leaf};
use sha2::Sha256;

// Create a new tree with 32-byte hashes using SHA256
let db = Box::new(MemoryDb::<32, Sha256>::new());
let mut tree = MSSMT::<32, Sha256, ()>::new(db);

// Insert a leaf
let leaf = Leaf::new(vec![1, 2, 3], 100);
tree.insert(&[1; 32], leaf).unwrap();

// Get and verify a merkle proof
let proof = tree.merkle_proof(&[1; 32]).unwrap();
let root = tree.root().unwrap();
proof.verify_merkle_proof(&[1; 32], leaf, root.hash()).unwrap();

Example using compact tree for better memory efficiency:

use merkle_sum_sparse_merkle_tree::{CompactMSSMT, MemoryDb, Leaf};
use sha2::Sha256;

// Create a new compact tree
let db = Box::new(MemoryDb::<32, Sha256>::new());
let mut tree = CompactMSSMT::<32, Sha256, ()>::new(db);

// Insert leaves
let leaf = Leaf::new(vec![1, 2, 3], 100);
tree.insert(&[1; 32], leaf.clone()).unwrap();

// Get and verify compressed proofs
let proof = tree.merkle_proof(&[1; 32]).unwrap();
let compressed = proof.compress();
let decompressed = compressed.decompress().unwrap();

Development

Building

cargo build

Testing

cargo test

Code Coverage

cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info

Benchmarking

cargo bench