Struct algae_mmr::MerkleMountainRange

pub struct MerkleMountainRange<T: Hashable> { /* private fields */ }

Implementations

impl<T: Hashable> MerkleMountainRange<T>

pub fn new(mmr: Vec<MerkleNode>, data: RangeMap<T>, position: Position) -> Self

pub fn get_object(&self, hash: &H256) -> Option<&T>

This function returns a reference to the data stored in the mmr It will return none if the hash does not exist

pub fn get_mut_object(&mut self, hash: &H256) -> Option<&mut T>

This function returns a mut reference to the data stored in the MMR It will return none if the hash does not exist

pub fn get_hash(&self, index: usize) -> Option<H256>

pub fn get_hash_proof<D: Digest>(&self, hash: &H256) -> Vec<H256>

This function returns the hash proof tree of a given hash. If the given hash is not in the tree, the vec will be empty. The Vec will be created in form of the Lchild-Rchild-parent(Lchild)-Rchild-parent-.. This pattern will be repeated until the parent is the root of the MMR

pub fn verify_proof<D: Digest>(&self, hashes: &Vec<H256>) -> bool

This function will verify the provided proof. Internally it uses the get_hash_proof function to construct a similar proof. This function will return true if the proof is valid If the order does not match Lchild-Rchild-parent(Lchild)-Rchild-parent-.. the validation will fail This function will only succeed if the given hash is of height 0

pub fn get_peak_height(&self) -> usize

This function returns the peak height of the mmr

pub fn get_merkle_root<D: Digest>(&self) -> H256

This function will return the single merkle root of the MMR.

pub fn add_vec<D: Digest>(&mut self, objects: Vec<T>)

This function adds a vec of leaf nodes to the mmr.

pub fn add_single<D: Digest>(&mut self, object: T)

This function adds a new leaf node to the mmr.

Trait Implementations

impl<T: Clone + Hashable> Clone for MerkleMountainRange<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Hashable> Debug for MerkleMountainRange<T>

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

Formats the value using the given formatter.

impl<T: Default + Hashable> Default for MerkleMountainRange<T>

fn default() -> MerkleMountainRange<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for MerkleMountainRange<T>where
    T: Deserialize<'de> + Hashable,

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

Deserialize this value from the given Serde deserializer.

impl<T: Hashable + Serialize> Display for MerkleMountainRange<T>

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

Formats the value using the given formatter.

impl<T: Hashable + ToString + Serialize> Hashable for MerkleMountainRange<T>

fn hash(&self) -> H256

impl<T: PartialEq + Hashable> PartialEq<MerkleMountainRange<T>> for MerkleMountainRange<T>

fn eq(&self, other: &MerkleMountainRange<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for MerkleMountainRange<T>where
    T: Serialize + Hashable,

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

Serialize this value into the given Serde serializer.

impl<T: Eq + Hashable> Eq for MerkleMountainRange<T>

impl<T: Hashable> StructuralEq for MerkleMountainRange<T>

impl<T: Hashable> StructuralPartialEq for MerkleMountainRange<T>