Skip to main content

MerkleTree

Struct MerkleTree 

Source
pub struct MerkleTree { /* private fields */ }
Expand description

The Merkle tree.

Implementations§

Source§

impl MerkleTree

Source

pub fn new() -> Self

Construct a new empty tree.

Source

pub fn append(&mut self, entry: MerkleEntry) -> u64

Append an entry.

O(log N): updates only the path from the new leaf up to the root. Each level either pairs its last two nodes (replacing the promoted copy one level up) or promotes the new node as-is.

Source

pub fn len(&self) -> usize

Current entry count.

Source

pub fn is_empty(&self) -> bool

Is the tree empty?

Source

pub fn root(&self) -> Hash

Compute the current root hash. Empty tree returns all-zeros.

O(1) — the root is incrementally maintained on every append().

Source

pub fn entry(&self, sequence: u64) -> Result<&MerkleEntry, MerkleError>

Get an entry by sequence.

Source

pub fn inclusion_proof( &self, sequence: u64, ) -> Result<InclusionProof, MerkleError>

Construct an inclusion proof for sequence. Returns direction-aware proof per RFC 6962 §2.1.1.

O(log N) — walks the cached levels from leaf to root, picking the sibling at each level. Compare to the previous O(N) implementation which rebuilt every level on each call.

Source

pub fn verify_inclusion( entry: &MerkleEntry, proof: &InclusionProof, root: Hash, ) -> Result<(), MerkleError>

Verify an inclusion proof (RFC 6962 §2.1.1).

Source

pub fn consistency_proof( &self, old_size: usize, ) -> Result<Vec<Hash>, MerkleError>

Compute a consistency proof (RFC 6962 §2.1.2).

Proves that the first old_size entries of the current tree hash to the same root as a tree of exactly old_size entries.

Returns the “consistency path” — a list of subtree hashes that the verifier uses to reconstruct both the old and new roots.

Source

pub fn verify_consistency( &self, old_root: Hash, new_root: Hash, old_size: usize, new_size: usize, _proof: &[Hash], ) -> Result<(), MerkleError>

Verify a consistency proof (RFC 6962 §2.1.2).

Brute-force verification: recompute the root at old_size and the current root from this tree’s leaves, then compare to old_root and new_root respectively.

This method requires &self because external proof-based verification (without the tree) requires a much more intricate algorithm that handles non-power-of-two old_size correctly. That algorithm is tracked as a follow-up; for now, this brute-force path is correct and is what bindings use.

The proof parameter is accepted for forward compatibility — it is currently unused (verification is done by direct recomputation), but the API shape is preserved so a future proof-based verifier can plug in without breaking callers.

Trait Implementations§

Source§

impl Clone for MerkleTree

Source§

fn clone(&self) -> MerkleTree

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MerkleTree

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MerkleTree

Source§

fn default() -> MerkleTree

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.