Struct ChainMmr

pub struct ChainMmr { /* private fields */ }

A struct that represents the chain Merkle Mountain Range (MMR).

The MMR allows for efficient authentication of input notes during transaction execution. Authentication is achieved by providing inclusion proofs for the notes consumed in the transaction against the chain MMR root associated with the latest block known at the time of transaction execution.

ChainMmr represents a partial view into the actual MMR and contains authentication paths for a limited set of blocks. The intent is to include only the blocks relevant for execution of a specific transaction (i.e., the blocks corresponding to all input notes and the one needed to validate the seed of a new account, if applicable).

Implementations

impl ChainMmr

pub fn new( mmr: PartialMmr, blocks: impl IntoIterator<Item = BlockHeader>, ) -> Result<Self, ChainMmrError>

Returns a new ChainMmr instantiated from the provided partial MMR and a list of block headers.

Errors

Returns an error if:

• block_num for any of the blocks is greater than the chain length implied by the provided partial MMR.
• The same block appears more than once in the provided list of block headers.
• The partial MMR does not track authentication paths for any of the specified blocks.

pub fn mmr(&self) -> &PartialMmr

Returns the underlying PartialMmr.

pub fn peaks(&self) -> MmrPeaks

Returns peaks of this MMR.

pub fn chain_length(&self) -> BlockNumber

Returns total number of blocks contain in the chain described by this MMR.

pub fn contains_block(&self, block_num: BlockNumber) -> bool

Returns true if the block is present in this chain MMR.

pub fn get_block(&self, block_num: BlockNumber) -> Option<&BlockHeader>

Returns the block header for the specified block, or None if the block is not present in this chain MMR.

pub fn block_headers(&self) -> impl Iterator<Item = &BlockHeader>

Returns an iterator over the block headers in this chain MMR.

pub fn add_block(&mut self, block_header: BlockHeader, track: bool)

Appends the provided block header to this chain MMR. This method assumes that the provided block header is for the next block in the chain.

If track parameter is set to true, the authentication path for the provided block header will be added to this chain MMR.

Panics

Panics if the block_header.block_num is not equal to the current chain length (i.e., the provided block header is not the next block in the chain).

pub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_

Returns an iterator over the inner nodes of authentication paths contained in this chain MMR.

Trait Implementations

impl Clone for ChainMmr

fn clone(&self) -> ChainMmr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainMmr

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

Formats the value using the given formatter.

impl Deserializable for ChainMmr

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

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

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

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

impl PartialEq for ChainMmr

fn eq(&self, other: &ChainMmr) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for ChainMmr

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

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 Eq for ChainMmr

impl StructuralPartialEq for ChainMmr