Struct MerkleTree

pub struct MerkleTree { /* private fields */ }

A fully-balanced binary Merkle tree (i.e., a tree where the number of leaves is a power of two).

Implementations

impl MerkleTree

pub fn new<T>(leaves: T) -> Result<Self, MerkleError>

where T: AsRef<[Word]>,

Returns a Merkle tree instantiated from the provided leaves.

Errors

Returns an error if the number of leaves is smaller than two or is not a power of two.

pub fn root(&self) -> RpoDigest

Returns the root of this Merkle tree.

pub fn depth(&self) -> u8

Returns the depth of this Merkle tree.

Merkle tree of depth 1 has two leaves, depth 2 has four leaves etc.

pub fn get_node(&self, index: NodeIndex) -> Result<RpoDigest, MerkleError>

Returns a node at the specified depth and index value.

Errors

Returns an error if:

• The specified depth is greater than the depth of the tree.
• The specified index is not valid for the specified depth.

pub fn get_path(&self, index: NodeIndex) -> Result<MerklePath, MerkleError>

Returns a Merkle path to the node at the specified depth and index value. The node itself is not included in the path.

Errors

Returns an error if:

• The specified depth is greater than the depth of the tree.
• The specified value is not valid for the specified depth.

pub fn leaves(&self) -> impl Iterator<Item = (u64, &Word)>

Returns an iterator over the leaves of this MerkleTree.

pub fn inner_nodes(&self) -> InnerNodeIterator<'_>

Returns n iterator over every inner node of this MerkleTree.

The iterator order is unspecified.

pub fn update_leaf<'a>( &'a mut self, index_value: u64, value: Word, ) -> Result<(), MerkleError>

Replaces the leaf at the specified index with the provided value.

Errors

Returns an error if the specified index value is not a valid leaf value for this tree.

Trait Implementations

impl Clone for MerkleTree

fn clone(&self) -> MerkleTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleTree

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

Formats the value using the given formatter.

impl<T: KvMap<RpoDigest, StoreNode>> From<&MerkleTree> for MerkleStore<T>

fn from(value: &MerkleTree) -> Self

Converts to this type from the input type.

impl PartialEq for MerkleTree

fn eq(&self, other: &MerkleTree) -> 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 TryFrom<&[[BaseElement; 4]]> for MerkleTree

type Error = MerkleError

The type returned in the event of a conversion error.

fn try_from(value: &[Word]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&[RpoDigest]> for MerkleTree

type Error = MerkleError

The type returned in the event of a conversion error.

fn try_from(value: &[RpoDigest]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for MerkleTree

impl StructuralPartialEq for MerkleTree