Trait WalletCommitmentTrees

pub trait WalletCommitmentTrees {
    type Error: Debug;
    type SaplingShardStore<'a>: ShardStore<H = Node, CheckpointId = BlockHeight, Error = Self::Error>;
    type OrchardShardStore<'a>: ShardStore<H = MerkleHashOrchard, CheckpointId = BlockHeight, Error = Self::Error>;

    // Required methods
    fn with_sapling_tree_mut<F, A, E>(&mut self, callback: F) -> Result<A, E>
       where for<'a> F: FnMut(&'a mut ShardTree<Self::SaplingShardStore<'a>, { sapling::NOTE_COMMITMENT_TREE_DEPTH }, SAPLING_SHARD_HEIGHT>) -> Result<A, E>,
             E: From<ShardTreeError<Self::Error>>;
    fn put_sapling_subtree_roots(
        &mut self,
        start_index: u64,
        roots: &[CommitmentTreeRoot<Node>],
    ) -> Result<(), ShardTreeError<Self::Error>>;
    fn with_orchard_tree_mut<F, A, E>(&mut self, callback: F) -> Result<A, E>
       where for<'a> F: FnMut(&'a mut ShardTree<Self::OrchardShardStore<'a>, { _ }, ORCHARD_SHARD_HEIGHT>) -> Result<A, E>,
             E: From<ShardTreeError<Self::Error>>;
    fn put_orchard_subtree_roots(
        &mut self,
        start_index: u64,
        roots: &[CommitmentTreeRoot<MerkleHashOrchard>],
    ) -> Result<(), ShardTreeError<Self::Error>>;
}

This trait describes a capability for manipulating wallet note commitment trees.

Required Associated Types

type Error: Debug

type SaplingShardStore<'a>: ShardStore<H = Node, CheckpointId = BlockHeight, Error = Self::Error>

The type of the backing [ShardStore] for the Sapling note commitment tree.

type OrchardShardStore<'a>: ShardStore<H = MerkleHashOrchard, CheckpointId = BlockHeight, Error = Self::Error>

Available on crate feature orchard only.

The type of the backing [ShardStore] for the Orchard note commitment tree.

Required Methods

fn with_sapling_tree_mut<F, A, E>(&mut self, callback: F) -> Result<A, E>

where for<'a> F: FnMut(&'a mut ShardTree<Self::SaplingShardStore<'a>, { sapling::NOTE_COMMITMENT_TREE_DEPTH }, SAPLING_SHARD_HEIGHT>) -> Result<A, E>, E: From<ShardTreeError<Self::Error>>,

Evaluates the given callback function with a reference to the Sapling note commitment tree maintained by the wallet.

fn put_sapling_subtree_roots( &mut self, start_index: u64, roots: &[CommitmentTreeRoot<Node>], ) -> Result<(), ShardTreeError<Self::Error>>

Adds a sequence of Sapling note commitment tree subtree roots to the data store.

Each such value should be the Merkle root of a subtree of the Sapling note commitment tree containing 2^SAPLING_SHARD_HEIGHT note commitments.

fn with_orchard_tree_mut<F, A, E>(&mut self, callback: F) -> Result<A, E>

where for<'a> F: FnMut(&'a mut ShardTree<Self::OrchardShardStore<'a>, { _ }, ORCHARD_SHARD_HEIGHT>) -> Result<A, E>, E: From<ShardTreeError<Self::Error>>,

Available on crate feature orchard only.

Evaluates the given callback function with a reference to the Orchard note commitment tree maintained by the wallet.

fn put_orchard_subtree_roots( &mut self, start_index: u64, roots: &[CommitmentTreeRoot<MerkleHashOrchard>], ) -> Result<(), ShardTreeError<Self::Error>>

Available on crate feature orchard only.

Adds a sequence of Orchard note commitment tree subtree roots to the data store.

Each such value should be the Merkle root of a subtree of the Orchard note commitment tree containing 2^ORCHARD_SHARD_HEIGHT note commitments.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl WalletCommitmentTrees for MockWalletDb

Available on crate feature test-dependencies only.

type Error = Infallible

type SaplingShardStore<'a> = MemoryShardStore<Node, BlockHeight>

type OrchardShardStore<'a> = MemoryShardStore<MerkleHashOrchard, BlockHeight>