Struct MerkleProof 

pub struct MerkleProof { /* private fields */ }

Available on crate feature unstable only.

An inclusion proof for a leaf in a MerkleTree.

The path lists each sibling hash on the way from the leaf up to the root.

Implementations

impl MerkleProof

pub fn new(path: Vec<Node>) -> Self

Construct a proof directly from a sibling path. Mostly useful for tests and for callers reconstructing a proof from out-of-band data; most users obtain proofs via MerkleTree::get_proof.

pub fn path(&self) -> &[Node]

The sibling hashes on the path from the leaf to the root, leaf-side first.

pub fn verify_proof_with_leaf_bytes( &self, root: &Node, leaf_bytes: &[u8], leaf_index: usize, ) -> Result<(), MerkleError>

Verify that the leaf identified by the given canonical bytes at position leaf_index is included in the tree whose root is root.

leaf_bytes must be the same byte representation that was hashed into the tree when it was built — for trees built via MerkleTree::build_from_unserialized that is the leaf’s BCS encoding. Most callers that already have the leaf in its structured form should use verify_proof instead, which performs that BCS step internally.

pub fn verify_proof<L: Serialize>( &self, root: &Node, leaf: &L, leaf_index: usize, ) -> Result<(), MerkleError>

Verify that leaf at position leaf_index is included in the tree whose root is root.

The leaf is BCS-encoded internally to obtain the canonical byte representation that the tree commits to. Use verify_proof_with_leaf_bytes when the caller already has those bytes.

pub fn compute_root(&self, leaf: &[u8], leaf_index: usize) -> Option<Node>

Recompute the root from the proof and leaf at leaf_index.

Returns None if leaf_index cannot fit in a tree of self.path.len() levels (which would imply the proof was tampered with or never matched this index).

pub fn is_right_most(&self, leaf_index: usize) -> bool

Whether this proof identifies the right-most leaf in its tree.

A right-most proof has the property that every step where the leaf is a left child carries an Empty sibling — the only way to be on the extreme right of a padded power-of-two tree.

Trait Implementations

impl Clone for MerkleProof

fn clone(&self) -> MerkleProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleProof

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

Formats the value using the given formatter.

impl PartialEq for MerkleProof

fn eq(&self, other: &MerkleProof) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MerkleProof

impl StructuralPartialEq for MerkleProof