Struct MerkleTree

pub struct MerkleTree { /* private fields */ }

Implementations

impl MerkleTree

pub fn new() -> Self

pub fn from_set<I, D>(set: I) -> Self

where I: Iterator<Item = (MerkleTreeKey, D)>, D: AsRef<[u8]>,

Build a sparse Merkle tree from a set of key-value pairs. This is equivalent to creating an empty sparse Merkle tree and sequentially calling update for each key-value pair. This constructor is more performant than calling individual sequential updates and is the preferred approach when the key-values are known upfront. Leaves can be appended to the returned tree using update to further accumulate leaf data.

pub fn root_from_set<I, D>(set: I) -> Bytes32

where I: Iterator<Item = (MerkleTreeKey, D)>, D: AsRef<[u8]>,

Calculate the sparse Merkle root from a set of key-value pairs. This is similar to constructing a new tree from a set of key-value pairs using from_set, except this method returns only the root; it does not write to storage nor return a sparse Merkle tree instance. It is equivalent to calling from_set(..), followed by root(), but does not incur the overhead of storage writes. This can be helpful when we know all the key-values in the set upfront and we will not need to update the set in the future.

pub fn nodes_from_set<I, D>(set: I) -> (Bytes32, Vec<(Bytes32, Primitive)>)

where I: Iterator<Item = (MerkleTreeKey, D)>, D: AsRef<[u8]>,

Calculate the sparse Merkle root as well as all nodes in the Merkle tree from a set of key-value pairs. This is similar to constructing a new tree from a set of key-value pairs using from_set, except this method returns only the root and the list of leaves and nodes in the tree; it does not return a sparse Merkle tree instance. This can be helpful when we know all the key-values in the set upfront and we need to defer storage writes, such as expensive database inserts, for batch operations later in the process.

pub fn update(&mut self, key: MerkleTreeKey, data: &[u8])

pub fn delete(&mut self, key: MerkleTreeKey)

pub fn root(&self) -> Bytes32

pub fn generate_proof(&self, key: &MerkleTreeKey) -> Option<Proof>

Trait Implementations

impl Debug for MerkleTree

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

Formats the value using the given formatter.

impl Default for MerkleTree

fn default() -> Self

Returns the “default value” for a type.