Struct MerkleMountainRange

#[repr(C)]
pub struct MerkleMountainRange<const MAX_N: u64>
where
    [(); { _ }]:,
{ /* private fields */ }

Merkle Mountain Range variant that has pre-hashed leaves with arbitrary number of elements.

This can be considered a general case of UnbalancedMerkleTree. The root and proofs are identical for both. UnbalancedMerkleTree is more efficient and should be preferred when possible, while this data structure is designed for aggregating data incrementally over long periods of time.

MAX_N generic constant defines the maximum number of elements supported and controls stack usage.

Implementations

impl<const MAX_N: u64> MerkleMountainRange<MAX_N>

where [(); { _ }]:,

pub fn new() -> Self

Create an empty instance

pub fn from_peaks(peaks: &MmrPeaks<MAX_N>) -> Option<Self>

Create a new instance from previously collected peaks.

Returns None if input is invalid.

pub fn as_bytes(&self) -> &MerkleMountainRangeBytes<MAX_N>

where [(); { _ }]:,

Get byte representation of Merkle Mountain Range

pub unsafe fn from_bytes(bytes: &MerkleMountainRangeBytes<MAX_N>) -> &Self

where [(); { _ }]:,

Create an instance from byte representation.

Safety

Bytes must be previously created by Self::as_bytes().

pub fn num_leaves(&self) -> u64

Get number of leaves aggregated in Merkle Mountain Range so far

pub fn root(&self) -> Option<[u8; 32]>

Calculate the root of Merkle Mountain Range.

In case MMR contains a single leaf hash, that leaf hash is returned, None is returned if there were no leaves added yet.

pub fn peaks(&self) -> MmrPeaks<MAX_N>

Get peaks of Merkle Mountain Range

pub fn add_leaf(&mut self, leaf: &[u8; 32]) -> bool

Add leaf to Merkle Mountain Range.

There is a more efficient version Self::add_leaves() in case multiple leaves are available.

Returns true on success, false if too many leaves were added.

pub fn add_leaves<'a, Item, Iter>(&mut self, leaves: Iter) -> bool

where Item: Into<[u8; 32]>, Iter: IntoIterator<Item = Item> + 'a,

Add many leaves to Merkle Mountain Range.

This is a more efficient version of Self::add_leaf() in case multiple leaves are available.

Returns true on success, false if too many leaves were added.

pub fn add_leaf_and_compute_proof( &mut self, leaf: &[u8; 32], ) -> Option<([u8; 32], Vec<[u8; 32]>)>

Add leaf to Merkle Mountain Range and generate inclusion proof.

Returns Some((root, proof)) on success, None if too many leaves were added.

pub fn add_leaf_and_compute_proof_in<'proof>( &mut self, leaf: &[u8; 32], proof: &'proof mut [MaybeUninit<[u8; 32]>; { _ }], ) -> Option<([u8; 32], &'proof mut [[u8; 32]])>

Add leaf to Merkle Mountain Range and generate inclusion proof.

Returns Some((root, proof)) on success, None if too many leaves were added.

pub fn add_leaf_and_compute_proof_inner( &mut self, leaf: &[u8; 32], proof: &mut [MaybeUninit<[u8; 32]>; { _ }], ) -> Option<([u8; 32], usize)>

pub fn verify( root: &[u8; 32], proof: &[[u8; 32]], leaf_index: u64, leaf: [u8; 32], num_leaves: u64, ) -> bool

Verify a Merkle proof for a leaf at the given index.

NOTE: MAX_N constant doesn’t matter here and can be anything that is >= 1.

Trait Implementations

impl<const MAX_N: u64> Clone for MerkleMountainRange<MAX_N>

where [(); { _ }]:,

fn clone(&self) -> MerkleMountainRange<MAX_N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const MAX_N: u64> Debug for MerkleMountainRange<MAX_N>

where [(); { _ }]:,

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

Formats the value using the given formatter.

impl<const MAX_N: u64> Default for MerkleMountainRange<MAX_N>

where [(); { _ }]:,

fn default() -> Self

Returns the “default value” for a type.

impl<const MAX_N: u64> Copy for MerkleMountainRange<MAX_N>

where [(); { _ }]:,