Struct arber::MerkleMountainRange

pub struct MerkleMountainRange<T, S> where
    T: Hashable + Clone,
    S: Store<T>,  {
    pub size: u64,
    // some fields omitted
}

Merkle-Mountain-Range (MMR) implementation.

All tree positions start at '1'. MMR positions are depth-frist, post-order tree traversal node positions and should not be seen as array indices.

The MMR Store, however, is a flat list representation of the MMR, i.e. an array of nodes. Hence, Store elements are accessed using a '0' based index.

Again, positions are '1' based tree node positions, indices are '0' based Store locations.

Fields

size: u64

Total number of MMR nodes, i.e. MMR size

Implementations

impl<'a, T, S> MerkleMountainRange<T, S> where
    T: Hashable + Clone,
    S: Store<T>, 

pub fn new(store: S) -> Self

pub fn append(&mut self, elem: &T) -> Result<u64, Error>

Append elem to the MMR. Return new MMR size.

pub fn validate(&self) -> Result<bool, Error>

Validate the MMR by re-calculating the hash of all inner, i.e. parent nodes. Retrun true, if the MMR is valid or an error.

pub fn proof(&self, pos: u64) -> Result<MerkleProof, Error>

Return a MMR membership proof for a leaf node at position pos.

pub fn hash(&self, pos: u64) -> Result<Hash, Error>

Return node hash at pos.

Note that in case of an error, Error::Store is returned and the error message is referring to pss - 1, i.e. an index.

pub fn peaks(&self) -> Vec<Hash>

Return MMR peak hashes as a vec

Peaks are listed left to right, starting with the leftmost peak. The leftmost peak is also always the ‘highest’ peak.

pub fn root(&self) -> Result<Hash, Error>

Return the root hash of the MMR.

Find all the current peaks and bag them together into a single peak hash.