Struct ShardedNotesTree 

pub struct ShardedNotesTree { /* private fields */ }

Stateful depth-depth notes tree split into fixed-height shards.

Only the rightmost shard stores leaves and internal nodes. Completed shards are represented by one root each in a mutable cap tree. Owned notes retain their immutable within-shard path after rollover; the current cap path is attached on demand, producing a normal depth-depth inclusion proof.

Implementations

impl ShardedNotesTree

pub fn new(depth: usize, shard_height: usize) -> Result<Self, TreeError>

pub fn from_snapshot(snapshot: ShardedTreeSnapshot) -> Result<Self, TreeError>

pub fn from_parts( depth: usize, shard_height: usize, completed_roots: Vec<Fr>, live_leaves: Vec<Fr>, ) -> Result<Self, TreeError>

Restore the public tree state before owned witnesses are adopted. This is the bulk boundary used by storage adapters that persist shard roots, live leaves, and account-scoped witnesses in separate tables.

pub fn depth(&self) -> usize

pub fn shard_height(&self) -> usize

pub fn shard_size(&self) -> usize

pub fn leaf_count(&self) -> usize

pub fn completed_shard_count(&self) -> usize

pub fn owned_note_count(&self) -> usize

pub fn owned_notes(&self) -> Vec<OwnedNoteWitness>

pub fn completed_roots(&self) -> &[Fr]

pub fn live_leaves(&self) -> &[Fr]

pub fn completed_shard_root(&self, shard_index: usize) -> Result<Fr, TreeError>

pub fn append(&mut self, note_id: Fr) -> Result<(), TreeError>

Append one note commitment, updating the live shard and cap in O(depth).

pub fn append_many(&mut self, note_ids: &[Fr]) -> Result<(), TreeError>

Append a batch, bulk-building when that is cheaper than one insertion per leaf. Cap updates are coalesced to once per affected shard.

pub fn mark_owned( &mut self, note_id: Fr, leaf_index: usize, ) -> Result<(), TreeError>

Track an owned note. The note may already be in the live shard or may be marked immediately before its commitment is appended.

pub fn unmark_owned(&mut self, note_id: Fr) -> bool

pub fn adopt_frozen_witness( &mut self, note_id: Fr, leaf_index: usize, within_shard_siblings: Vec<Fr>, ) -> Result<(), TreeError>

Adopt a recovered local path for an owned note in a completed shard.

pub fn root(&self) -> Fr

pub fn witness(&self, note_id: Fr) -> Result<InclusionProof, TreeError>

Produce a conventional full-depth proof for a tracked owned note.

pub fn rewind_live_to( &mut self, leaf_count: usize, ) -> Result<Vec<Fr>, TreeError>

Rewind within the mutable live shard. Crossing a completed-shard boundary requires restoring an earlier checkpoint because completed leaves have deliberately been discarded.

pub fn drain_dirty_owned_notes(&mut self) -> Vec<OwnedNoteWitness>

pub fn snapshot(&self) -> ShardedTreeSnapshot

pub fn encode_snapshot(&self) -> Result<Vec<u8>, TreeError>

pub fn from_snapshot_bytes(bytes: &[u8]) -> Result<Self, TreeError>

Trait Implementations

impl Clone for ShardedNotesTree

fn clone(&self) -> ShardedNotesTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.