Struct Proof

pub struct Proof<M: MerkleHash> {
    pub siblings: Vec<M::Output>,
    pub range: Range<u32>,
}

A proof of some statement about a namespaced merkle tree.

This proof may prove the presence of some set of leaves, or the absence of a particular namespace

Fields

siblings: Vec<M::Output>

The siblings to be used to build the path to the root.

range: Range<u32>

The range of indices covered by the proof.

Implementations

impl<M> Proof<M>

where M: MerkleHash + Default,

pub fn verify_range( &self, root: &M::Output, leaf_hashes: &[M::Output], ) -> Result<(), RangeProofError>

Verify a range proof

impl<M> Proof<M>

where M: MerkleHash,

pub fn verify_range_with_hasher( &self, root: &M::Output, leaf_hashes: &[M::Output], hasher: M, ) -> Result<(), RangeProofError>

Verify a range proof

pub fn narrow_range_with_hasher( &self, left_extra_leaves: &[M::Output], right_extra_leaves: &[M::Output], hasher: M, ) -> Result<Self, RangeProofError>

Narrows the proof range: uses an existing proof to create a new proof for a subrange of the original proof’s range

Arguments

• left_extra_leaves: The hashes of the leaves that will narrow the range from the left side (i.e. all the leaves from the left edge of the currently proven range, to the left edge of the new desired shrunk range)
• right_extra_leaves: Analogously, hashes of all the leaves between the right edge of the desired shrunken range, and the right edge of the current proof’s range

pub fn siblings(&self) -> &Vec<M::Output>

Returns the siblings provided as part of the proof.

pub fn start_idx(&self) -> u32

Returns the index of the first leaf covered by the proof.

pub fn end_idx(&self) -> u32

Returns the index after the last leaf included in the proof.

pub fn range_len(&self) -> usize

Returns the length of the range covered by the proof.

pub fn leftmost_right_sibling(&self) -> Option<&M::Output>

Returns the leftmost node to the right of the proven range, if one exists.

pub fn rightmost_left_sibling(&self) -> Option<&M::Output>

Returns the rightmost node to the left of the proven range, if one exists.

Trait Implementations

impl<M: Clone + MerkleHash> Clone for Proof<M>

where M::Output: Clone,

fn clone(&self) -> Proof<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + MerkleHash> Debug for Proof<M>

where M::Output: Debug,

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

Formats the value using the given formatter.

impl<M: MerkleHash> Default for Proof<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: PartialEq + MerkleHash> PartialEq for Proof<M>

where M::Output: PartialEq,

fn eq(&self, other: &Proof<M>) -> 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<M: MerkleHash> StructuralPartialEq for Proof<M>