Struct incrementalmerkletree::witness::IncrementalWitness

pub struct IncrementalWitness<H, const DEPTH: u8> { /* private fields */ }

Available on crate feature legacy-api only.

An updatable witness to a path from a position in a particular CommitmentTree.

Appending the same commitments in the same order to both the original CommitmentTree and this IncrementalWitness will result in a witness to the path from the target position to the root of the updated tree.

Examples

use incrementalmerkletree::{
    frontier::{CommitmentTree, testing::TestNode},
    witness::IncrementalWitness,
    Position
};

let mut tree = CommitmentTree::<TestNode, 8>::empty();

tree.append(TestNode(0));
tree.append(TestNode(1));
let mut witness = IncrementalWitness::from_tree(tree.clone());
assert_eq!(witness.witnessed_position(), Position::from(1));
assert_eq!(tree.root(), witness.root());

let next = TestNode(2);
tree.append(next.clone());
witness.append(next);
assert_eq!(tree.root(), witness.root());

Implementations

impl<H, const DEPTH: u8> IncrementalWitness<H, DEPTH>

pub fn from_tree(tree: CommitmentTree<H, DEPTH>) -> Self

Creates an IncrementalWitness for the most recent commitment added to the given CommitmentTree.

pub fn from_parts( tree: CommitmentTree<H, DEPTH>, filled: Vec<H>, cursor: Option<CommitmentTree<H, DEPTH>> ) -> Self

pub fn tree(&self) -> &CommitmentTree<H, DEPTH>

pub fn filled(&self) -> &Vec<H>

pub fn cursor(&self) -> &Option<CommitmentTree<H, DEPTH>>

pub fn witnessed_position(&self) -> Position

Returns the position of the witnessed leaf node in the commitment tree.

pub fn tip_position(&self) -> Position

Returns the position of the last leaf appended to the witness.

impl<H: Hashable + Clone, const DEPTH: u8> IncrementalWitness<H, DEPTH>

pub fn append(&mut self, node: H) -> Result<(), ()>

Tracks a leaf node that has been added to the underlying tree.

Returns an error if the tree is full.

pub fn root(&self) -> H

Returns the current root of the tree corresponding to the witness.

pub fn path(&self) -> Option<MerklePath<H, DEPTH>>

Returns the current witness, or None if the tree is empty.

Trait Implementations

impl<H: Clone, const DEPTH: u8> Clone for IncrementalWitness<H, DEPTH>

fn clone(&self) -> IncrementalWitness<H, DEPTH>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug, const DEPTH: u8> Debug for IncrementalWitness<H, DEPTH>

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

Formats the value using the given formatter.