Struct zk_kit_smt::smt::SMT

pub struct SMT { /* private fields */ }

Implementations

impl SMT

pub fn new(hash: HashFunction, big_numbers: bool) -> Self

Initializes a new instance of the Sparse Merkle Tree (SMT).

Arguments

• hash - The hash function used to hash the child nodes.
• big_numbers - A flag indicating whether the SMT supports big numbers or not.

Returns

A new instance of the SMT.

pub fn get(&self, key: Key) -> Option<Value>

Retrieves the value associated with the given key from the SMT.

Arguments

• key - The key to retrieve the value for.

Returns

An Option containing the value associated with the key, or None if the key does not exist.

pub fn add(&mut self, key: Key, value: Value) -> Result<(), SMTError>

Adds a new key-value pair to the SMT.

It retrieves a matching entry or a zero node with a top-down approach and then it updates all the hashes of the nodes in the path of the new entry with a bottom up approach.

Arguments

• key - The key to add.
• value - The value associated with the key.

Returns

An Result indicating whether the operation was successful or not.

pub fn update(&mut self, key: Key, value: Value) -> Result<(), SMTError>

Updates the value associated with the given key in the SMT.

Also in this case, all the hashes of the nodes in the path of the updated entry are updated with a bottom up approach.

Arguments

• key - The key to update the value for.
• value - The new value associated with the key.

Returns

An Result indicating whether the operation was successful or not.

pub fn delete(&mut self, key: Key) -> Result<(), SMTError>

Deletes the key-value pair associated with the given key from the SMT.

Also in this case, all the hashes of the nodes in the path of the deleted entry are updated with a bottom up approach.

Arguments

• key - The key to delete.

Returns

An Result indicating whether the operation was successful or not.

pub fn create_proof(&self, key: Key) -> MerkleProof

Creates a proof to prove the membership or the non-membership of a tree entry.

Arguments

• key - The key to create the proof for.

Returns

A MerkleProof containing the proof information.

pub fn verify_proof(&self, merkle_proof: MerkleProof) -> bool

Verifies a membership or a non-membership proof for a given key in the SMT.

Arguments

• merkle_proof - The Merkle proof to verify.

Returns

A boolean indicating whether the proof is valid or not.