Struct MerkleMountainRange

pub struct MerkleMountainRange(/* private fields */);

Incrementally constructable Merkle mountain range.

Each entry in the list is a pair of (digest, max-depth), where max-depth tracks an upper bound on the size of the subtree for which the digest is the root. The largest subtree is at index 0, the smallest at index len - 1.

Note that the max size of the internal vec of digests (peaks) is equal to log_2 n where n is the number of leaves in the tree.

Implementations

impl MerkleMountainRange

pub fn empty() -> Self

Constructs a new empty Merkle mountain range.

pub fn new_finalized(root: Digest) -> Self

Construct a new MerkleMountainRange in a finalized state, given a root.

pub fn push(&mut self, leaf: Digest) -> Result<(), Error>

Push a new leaf onto the Merkle mountain range.

pub fn finalize(&mut self) -> Result<(), Error>

Finalize the MerkleMountainRange, combining all peaks into one root. No new nodes can be added to a finalized commitment.

pub fn finalized_root(self) -> Option<Digest>

Finalizes the MerkleMountainRange and returns the root, or returns None is the MerkleMountainRange is empty.

pub fn is_finalized(&self) -> bool

Returns true if the MerkleMountainRange is finalized. No new nodes can be added to a finalized MerkleMountainRange.

pub fn is_empty(&self) -> bool

Returns true if the MerkleMountainRange is empty.

pub fn encode(&self) -> Vec<u8>

A compact encoding for the MerkleMountainRange used in encoding the journal designed to be efficient for use in the EVM, and designed to ensure it is possible to construct the journal encoding of a finalized MerkleMountainRange given only the finalized root.

pub fn decode(bytes: impl AsRef<[u8]>) -> Result<Self, DecodingError>

Decode the specialized journal encoding. See MerkleMountainRange::encode.

Trait Implementations

impl Clone for MerkleMountainRange

fn clone(&self) -> MerkleMountainRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleMountainRange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MerkleMountainRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: Borrow<Digest>> Extend<D> for MerkleMountainRange

fn extend<T: IntoIterator<Item = D>>(&mut self, leaves: T)

Extend a MerkleMountainRange from an iterator of digest leaves.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<D: Borrow<Digest>> FromIterator<D> for MerkleMountainRange

fn from_iter<T: IntoIterator<Item = D>>(leaves: T) -> Self

Construct a MerkleMountainRange from an iterator of digest leaves.

impl Serialize for MerkleMountainRange

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

where __S: Serializer,

Serialize this value into the given Serde serializer.