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) -> Forest

Returns the MMR forest representation. See [Forest].

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

Returns an [MmrProof] for the leaf at the specified position.

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.

Errors

Returns an error if the specified leaf position is out of bounds for this MMR.

pub fn open_at(&self, pos: usize, forest: Forest) -> Result<MmrProof, MmrError>

Returns an [MmrProof] for the leaf at the specified position using the state of the MMR at the specified forest.

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.

Errors

Returns an error if:

• The specified leaf position is out of bounds for this MMR.
• The specified forest value is not valid for this MMR.

pub fn get(&self, pos: usize) -> Result<Word, 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: Word)

Adds a new element to the MMR.

pub fn peaks(&self) -> MmrPeaks

Returns the current peaks of the MMR.

pub fn peaks_at(&self, forest: Forest) -> Result<MmrPeaks, MmrError>

Returns the peaks of the MMR at the state specified by forest.

Errors

Returns an error if the specified forest value is not valid for this MMR.

pub fn get_delta( &self, from_forest: Forest, to_forest: Forest, ) -> 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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Mmr

fn default() -> Mmr

Returns the “default value” for a type.

impl Deserializable for Mmr

fn read_from<R>(source: &mut R) -> Result<Mmr, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for Mmr

fn deserialize<__D>( __deserializer: __D, ) -> Result<Mmr, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Mmr> for MerkleStore

fn from(value: &Mmr) -> MerkleStore

Converts to this type from the input type.

impl<T> From<T> for Mmr

where T: IntoIterator<Item = Word>,

fn from(values: T) -> Mmr

Converts to this type from the input type.

impl Serializable for Mmr

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for Mmr

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.