Module wallet 

Module for wallet structs and types generated by the sync engine from block chain data or to track the wallet’s sync status. The structs will be (or be transposed into) the fundamental wallet components for the wallet interfacing with this sync engine.

Modules

serialization

Serialization and de-serialization of wallet structs in crate::wallet including utilities.

traits

Traits for interfacing a wallet with the sync engine

Structs

InitialSyncState

Initial sync state.

Ironwood

Marker for the Ironwood pool. Ironwood reuses Orchard’s note and nullifier types (note version V3), so without the marker its wallet note type would be the same type as the Orchard one.

NullifierMap

Binary tree map of nullifiers from transaction spends or actions

Orchard

Marker for the Orchard pool, distinguishing note types whose inner data is otherwise identical.

OutgoingNote

Note sent from this capability to a recipient. P is the pool marker (Sapling, Orchard or Ironwood).

OutputId

Output ID for a given pool type.

PoolActivation

A pool’s activation height: the block height at which the pool begins to exist on the chain.

Sapling

Marker for the Sapling pool, distinguishing note types whose inner data is otherwise identical.

ScanTarget

A block, or a transaction in it, that scanning must reach. A target names a block height and, when a particular transaction is wanted, its txid. Two targets naming the same block height and txid are the same target.

ShardTrees

Shard tree wallet data struct

SyncState

Encapsulates the current state of sync

TransparentCoin

Transparent coin (output) with metadata relevant to the wallet.

TreeBounds

Initial and final tree sizes.

WalletBlock

Wallet block data

WalletNote

Wallet note, shielded output with metadata relevant to the wallet. P is the pool marker (Sapling, Orchard or Ironwood).

WalletTransaction

Wallet transaction

Enums

SyncMode

Sync modes.

Traits

KeyIdInterface

Provides a common API for all key identifiers.

NoteInterface

Provides a common API for all shielded output types.

OutgoingNoteInterface

Provides a common API for all outgoing note types.

OutputInterface

Provides a common API for all output types.

Functions

pool_upgrade

The network upgrade at which a shielded pool begins to exist.

Type Aliases

IronwoodNote

Ironwood note. Shares Orchard’s note and nullifier types (version V3) but belongs to the Ironwood pool with its own note commitment tree.

OrchardNote

Orchard note.

OrchardShardStore

Type alias for orchard memory shard store

OutgoingIronwoodNote

Outgoing ironwood note. Shares Orchard’s note and receiver types.

OutgoingOrchardNote

Outgoing orchard note.

OutgoingSaplingNote

Outgoing sapling note.

SaplingNote

Sapling note.

SaplingShardStore

Type alias for sapling memory shard store