Struct zk_kit_pmt::tree::MerkleTree

pub struct MerkleTree<D, H>
where
    D: Database,
    H: Hasher,
{
    pub db: D,
    /* private fields */
}

The Merkle Tree structure

Fields

db: D

Implementations

impl<D, H> MerkleTree<D, H>

where D: Database, H: Hasher,

pub fn default(depth: usize) -> PmtreeResult<Self>

Creates tree with specified depth and default “pmtree_db” dbpath.

pub fn new(depth: usize, db_config: D::Config) -> PmtreeResult<Self>

Creates new MerkleTree and store it to the specified path/db

pub fn load(db_config: D::Config) -> PmtreeResult<Self>

Loads existing Merkle Tree from the specified path/db

pub fn close(&mut self) -> PmtreeResult<()>

Closes the db connection

pub fn set(&mut self, key: usize, leaf: H::Fr) -> PmtreeResult<()>

Sets a leaf at the specified tree index

pub fn get_elem(&self, key: Key) -> PmtreeResult<H::Fr>

pub fn delete(&mut self, key: usize) -> PmtreeResult<()>

Deletes a leaf at the key by setting it to its default value

pub fn update_next(&mut self, leaf: H::Fr) -> PmtreeResult<()>

Inserts a leaf to the next available index

pub fn set_range<I: IntoIterator<Item = H::Fr>>( &mut self, start: usize, leaves: I, ) -> PmtreeResult<()>

Batch insertion from starting index

pub fn batch_insert( &mut self, start: Option<usize>, leaves: &[H::Fr], ) -> PmtreeResult<()>

Batch insertion, updates the tree in parallel.

pub fn proof(&self, index: usize) -> PmtreeResult<MerkleProof<H>>

Computes a Merkle proof for the leaf at the specified index

pub fn verify(&self, leaf: &H::Fr, witness: &MerkleProof<H>) -> bool

Verifies a Merkle proof with respect to the input leaf and the tree root

pub fn get(&self, key: usize) -> PmtreeResult<H::Fr>

Returns the leaf by the key

pub fn root(&self) -> H::Fr

Returns the root of the tree

pub fn leaves_set(&self) -> usize

Returns the total number of leaves set

pub fn capacity(&self) -> usize

Returns the capacity of the tree, i.e. the maximum number of leaves

pub fn depth(&self) -> usize

Returns the depth of the tree