Struct MerkleGroup 

#[non_exhaustive]
pub struct MerkleGroup {
    pub depth: u32,
    pub leaves: Vec<Digest>,
}

Available on non-target_os="zkvm" and crate feature prove only.

Merkle tree implementation used in the recursion system to commit to a set of recursion programs, and to verify the inclusion of a given program in the set.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

depth: u32

Depth of the Merkle tree.

leaves: Vec<Digest>

Ordered list of Merkle tree leaves, as Digests. It is expected that these will be the control IDs for the committed set of recursion programs.

Implementations

impl MerkleGroup

pub fn new(leaves: Vec<Digest>) -> Result<Self>

Create a new MerkleGroup from the given leaves. Will fail if too many leaves are given for the default depth.

pub fn calc_root(&self, hashfn: &dyn HashFn<BabyBear>) -> Digest

Calculate the root of the MerkleGroup.

pub fn get_proof( &self, control_id: &Digest, hashfn: &dyn HashFn<BabyBear>, ) -> Result<MerkleProof>

Calculate and return a MerkleProof for the given leaf. Will return an error if the given leaf is not in the tree.

pub fn get_proof_by_index( &self, index: u32, hashfn: &dyn HashFn<BabyBear>, ) -> MerkleProof

Calculate and return a MerkleProof for the given leaf. Will panic if the given index is out of the range of leaves.