Enum miden_core::AdviceSet

pub enum AdviceSet {
    MerkleTree(MerkleTree),
    SparseMerkleTree(SparseMerkleTree),
    MerklePathSet(MerklePathSet),
}

TODO: add docs

Variants

MerkleTree(MerkleTree)

SparseMerkleTree(SparseMerkleTree)

MerklePathSet(MerklePathSet)

Implementations

impl AdviceSet

pub fn new_merkle_tree(leaves: Vec<Word>) -> Result<Self, AdviceSetError>

Returns a new AdviceSet instantiated as a Merkle tree 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 new_sparse_merkle_tree(
    keys: Vec<u64>,
    values: Vec<Word>,
    depth: u32
) -> Result<Self, AdviceSetError>

Returns a new AdviceSet instantiated as a Sparse Merkle tree 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) -> Word

Returns a root of this advice set.

pub fn depth(&self) -> u32

Returns the maximum depth of this advice set.

pub fn get_node(&self, depth: u32, index: u64) -> Result<Word, AdviceSetError>

Returns a node located at the specified depth and index.

Errors

Returns an error if:

• The specified depth is greater than the depth of this advice set.
• The specified index is invalid in the context of the specified depth.
• This advice set does not contain a node at the specified index and depth.

pub fn get_path(
    &self,
    depth: u32,
    index: u64
) -> Result<Vec<Word>, AdviceSetError>

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

Errors

Returns an error if:

• The specified depth is greater than the depth of this advice set.
• The specified index is invalid in the context of the specified depth.
• This advice set does not contain a node at the specified index and depth.

pub fn update_leaf(
    &mut self,
    index: u64,
    value: Word
) -> Result<(), AdviceSetError>

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

Errors

Returns an error if:

• The specified index is not a valid leaf index for this advice set.
• This advice set does not contain a leaf at the specified index.

Trait Implementations

impl Clone for AdviceSet

fn clone(&self) -> AdviceSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceSet

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

Formats the value using the given formatter.