Struct MerkleTree 

pub struct MerkleTree { /* private fields */ }

Represents a Merkle Tree, providing functionalities to build a binary tree from digests of the leaf nodes, get the root commitment, generate inclusion proofs, and verify them.

Implementations

impl MerkleTree

pub fn new(leaf_nodes: Vec<Hash>) -> Result<Self, DecdsError>

Creates a new Merkle Tree from a vector of BLAKE3 hashes representing the leaf nodes.

Arguments

• leaf_nodes - A Vec<blake3::Hash> where each hash is a leaf node of the tree.

Returns

• Result<Self, DecdsError> - Returns a MerkleTree instance if successful, or a DecdsError::NoLeafNodesToBuildMerkleTreeOn if leaf_nodes is empty.

pub fn get_root_commitment(&self) -> Hash

Returns the root commitment (hash) of the Merkle Tree.

Returns

• blake3::Hash - The BLAKE3 hash of the Merkle root.

pub fn generate_proof(&self, leaf_index: usize) -> Result<Vec<Hash>, DecdsError>

Generates a Merkle inclusion proof for a given leaf node at leaf_index.

This proof consists of the sibling hashes required to reconstruct the path from the leaf node to the Merkle root.

Arguments

• leaf_index - The index of the leaf node for which to generate the proof.

Returns

• Result<Vec<blake3::Hash>, DecdsError> - Returns a Vec<blake3::Hash> representing the Merkle proof if successful. Returns DecdsError::InvalidLeafNodeIndex if leaf_index is out of bounds.

pub fn verify_proof( leaf_index: usize, leaf_node: Hash, proof: &[Hash], root_hash: Hash, ) -> bool

Verifies a Merkle inclusion proof for a given leaf node against a provided Merkle root hash.

Arguments

• leaf_index - The index of the leaf node in the original set.
• leaf_node - The BLAKE3 hash of the leaf node to verify.
• proof - A slice of blake3::Hash representing the Merkle proof.
• root_hash - The expected root hash of the Merkle Tree.

Returns

• bool - true if the proof is valid and the leaf node is included in the tree with the given root hash, false otherwise.