Struct MmrPeaks 

pub struct MmrPeaks { /* private fields */ }

Implementations

impl MmrPeaks

pub fn new(forest: Forest, peaks: Vec<Word>) -> Result<MmrPeaks, MmrError>

Returns new MmrPeaks instantiated from the provided vector of peaks and the number of leaves in the underlying MMR.

Errors

Returns an error if the number of leaves and the number of peaks are inconsistent.

pub fn forest(&self) -> Forest

Returns the underlying forest (a set of mountain range peaks).

pub fn num_leaves(&self) -> usize

Returns a count of leaves in the underlying MMR.

pub fn num_peaks(&self) -> usize

Returns the number of peaks of the underlying MMR.

pub fn peaks(&self) -> &[Word]

Returns the list of peaks of the underlying MMR.

pub fn get_peak(&self, peak_idx: usize) -> Result<&Word, MmrError>

Returns the peak by the provided index.

Errors

Returns an error if the provided peak index is greater or equal to the current number of peaks in the Mmr.

pub fn into_parts(self) -> (Forest, Vec<Word>)

Converts this MmrPeaks into its components: number of leaves (represented as a [Forest]) and a vector of peaks of the underlying MMR.

pub fn hash_peaks(&self) -> Word

Hashes the peaks.

The procedure will:

• Flatten and pad the peaks to a vector of Felts.
• Hash the vector of Felts.

pub fn verify(&self, value: Word, opening: MmrProof) -> Result<(), MmrError>

Verifies the Merkle opening proof.

Errors

Returns an error if:

• provided opening proof is invalid.
• Mmr root value computed using the provided leaf value differs from the actual one.

pub fn flatten_and_pad_peaks(&self) -> Vec<Felt>

Flattens and pads the peaks to make hashing inside of the Miden VM easier.

The procedure will:

• Flatten the vector of Words into a vector of Felts.
• Pad the peaks with ZERO to an even number of words, this removes the need to handle Poseidon2 padding.
• Pad the peaks to a minimum length of 16 words, which reduces the constant cost of hashing.

Trait Implementations

impl Clone for MmrPeaks

fn clone(&self) -> MmrPeaks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MmrPeaks

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

Formats the value using the given formatter.

impl Default for MmrPeaks

fn default() -> MmrPeaks

Returns new MmrPeaks instantiated from an empty vector of peaks and 0 leaves.

impl<'de> Deserialize<'de> for MmrPeaks

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PartialMmr> for MmrPeaks

fn from(partial_mmr: &PartialMmr) -> MmrPeaks

Converts to this type from the input type.

impl From<MmrPeaks> for Vec<Word>

fn from(peaks: MmrPeaks) -> Vec<Word>

Converts to this type from the input type.

impl From<PartialMmr> for MmrPeaks

fn from(partial_mmr: PartialMmr) -> MmrPeaks

Converts to this type from the input type.

impl PartialEq for MmrPeaks

fn eq(&self, other: &MmrPeaks) -> 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 Serialize for MmrPeaks

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.

impl Eq for MmrPeaks

impl StructuralPartialEq for MmrPeaks