Struct MerkleTree 

pub struct MerkleTree { /* private fields */ }

Available on crate feature unstable only.

A Blake2b256 Merkle tree.

The tree is built once from a set of leaves and then queried for its root or for MerkleProofs.

Implementations

impl MerkleTree

pub fn build_from_serialized<I>(iter: I) -> Self

where I: IntoIterator, I::IntoIter: ExactSizeIterator, I::Item: AsRef<[u8]>,

Build a tree by hashing each input as a leaf.

pub fn build_from_unserialized<I>(iter: I) -> Result<Self, MerkleError>

where I: IntoIterator, I::IntoIter: ExactSizeIterator, I::Item: Serialize,

Build a tree by BCS-encoding each input and using its hash as a leaf.

Returns MerkleError::InvalidInput if any leaf fails BCS serialization, which in practice can only happen for unusual Serialize impls (e.g. infinite recursion); ordinary value types do not fail.

pub fn build_from_leaf_hashes<I>(iter: I) -> Self

where I: IntoIterator, I::IntoIter: ExactSizeIterator<Item = Node>,

Build a tree directly from already-hashed leaves.

Each input node is interpreted as a leaf hash; callers are responsible for applying the LEAF_PREFIX before hashing.

pub fn root(&self) -> Node

The Merkle root.

An empty tree (built from zero leaves) returns Node::Empty.

pub fn n_leaves(&self) -> usize

The number of leaves the tree was built from.

pub fn get_proof(&self, leaf_index: usize) -> Result<MerkleProof, MerkleError>

Build an inclusion proof for the leaf at leaf_index.

Returns MerkleError::InvalidInput if leaf_index >= n_leaves.

pub fn compute_non_inclusion_proof<L>( &self, sorted_leaves: &[L], target: &L, ) -> Result<MerkleNonInclusionProof<L>, MerkleError>

where L: Ord + Clone,

Build a non-inclusion proof showing that target does not appear in this tree.

The tree must have been built from sorted_leaves in sorted order; the caller is responsible for passing the same sorted slice it built the tree from. Returns MerkleError::InvalidInput if target is actually present in sorted_leaves.

Trait Implementations

impl Debug for MerkleTree

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.