Struct Mmr

pub struct Mmr { /* private fields */ }

A fully materialized Merkle Mountain Range, with every tree in the forest and all their elements.

Since this is a full representation of the MMR, elements are never removed and the MMR will grow roughly O(2n) in number of leaf elements.

Implementations

impl Mmr

pub fn new() -> Mmr

Constructor for an empty Mmr.

pub const fn forest(&self) -> usize

Returns the MMR forest representation.

The forest value has the following interpretations:

• its value is the number of elements in the forest
• bit count corresponds to the number of trees in the forest
• each true bit position determines the depth of a tree in the forest

pub fn open( &self, pos: usize, target_forest: usize, ) -> Result<MmrProof, MmrError>

Given a leaf position, returns the Merkle path to its corresponding peak. If the position is greater-or-equal than the tree size an error is returned.

Note: The leaf position is the 0-indexed number corresponding to the order the leaves were added, this corresponds to the MMR size prior to adding the element. So the 1st element has position 0, the second position 1, and so on.

pub fn get(&self, pos: usize) -> Result<RpoDigest, MmrError>

Returns the leaf value at position pos.

Note: The leaf position is the 0-indexed number corresponding to the order the leaves were added, this corresponds to the MMR size prior to adding the element. So the 1st element has position 0, the second position 1, and so on.

pub fn add(&mut self, el: RpoDigest)

Adds a new element to the MMR.

pub fn peaks(&self, forest: usize) -> Result<MmrPeaks, MmrError>

Returns an peaks of the MMR for the version specified by forest.

pub fn get_delta( &self, from_forest: usize, to_forest: usize, ) -> Result<MmrDelta, MmrError>

Compute the required update to original_forest.

The result is a packed sequence of the authentication elements required to update the trees that have been merged together, followed by the new peaks of the Mmr.

pub fn inner_nodes(&self) -> MmrNodes<'_>

An iterator over inner nodes in the MMR. The order of iteration is unspecified.

Trait Implementations

impl Clone for Mmr

fn clone(&self) -> Mmr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mmr

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

Formats the value using the given formatter.

impl Default for Mmr

fn default() -> Self

Returns the “default value” for a type.

impl<T: KvMap<RpoDigest, StoreNode>> From<&Mmr> for MerkleStore<T>

fn from(value: &Mmr) -> Self

Converts to this type from the input type.

impl<T> From<T> for Mmr

where T: IntoIterator<Item = RpoDigest>,

fn from(values: T) -> Self

Converts to this type from the input type.