Struct MockWalletDb

pub struct MockWalletDb {
    pub network: Network,
    pub sapling_tree: ShardTree<MemoryShardStore<Node, BlockHeight>, { _ }, SAPLING_SHARD_HEIGHT>,
    pub orchard_tree: ShardTree<MemoryShardStore<MerkleHashOrchard, BlockHeight>, { _ }, ORCHARD_SHARD_HEIGHT>,
}

Available on crate feature test-dependencies only.

A mock wallet data source that implements the bare minimum necessary to function.

Fields

network: Network

sapling_tree: ShardTree<MemoryShardStore<Node, BlockHeight>, { _ }, SAPLING_SHARD_HEIGHT>

orchard_tree: ShardTree<MemoryShardStore<MerkleHashOrchard, BlockHeight>, { _ }, ORCHARD_SHARD_HEIGHT>

Available on crate feature orchard only.

Implementations

impl MockWalletDb

pub fn new(network: Network) -> Self

Constructs a new mock wallet data source.

Trait Implementations

impl InputSource for MockWalletDb

type Error = ()

The type of errors produced by a wallet backend.

type NoteRef = u32

Backend-specific note identifier.

type AccountId = u32

Backend-specific account identifier.

fn get_spendable_note( &self, _txid: &TxId, _protocol: ShieldedProtocol, _index: u32, ) -> Result<Option<ReceivedNote<Self::NoteRef, Note>>, Self::Error>

Fetches a spendable note by indexing into a transaction’s shielded outputs for the specified shielded protocol.

fn select_spendable_notes( &self, _account: Self::AccountId, _target_value: Zatoshis, _sources: &[ShieldedProtocol], _anchor_height: BlockHeight, _exclude: &[Self::NoteRef], ) -> Result<SpendableNotes<Self::NoteRef>, Self::Error>

Returns a list of spendable notes sufficient to cover the specified target value, if possible. Only spendable notes corresponding to the specified shielded protocol will be included.

fn get_account_metadata( &self, _account: Self::AccountId, _selector: &NoteFilter, _exclude: &[Self::NoteRef], ) -> Result<AccountMeta, Self::Error>

Returns metadata describing the structure of the wallet for the specified account.

fn get_unspent_transparent_output( &self, _outpoint: &OutPoint, ) -> Result<Option<WalletTransparentOutput>, Self::Error>

Available on crate feature transparent-inputs only.

Fetches the transparent output corresponding to the provided outpoint.

fn get_spendable_transparent_outputs( &self, _address: &TransparentAddress, _target_height: BlockHeight, _min_confirmations: u32, ) -> Result<Vec<WalletTransparentOutput>, Self::Error>

Available on crate feature transparent-inputs only.

Returns the list of spendable transparent outputs received by this wallet at address such that, at height target_height:

impl WalletCommitmentTrees for MockWalletDb

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 note commitment tree subtree roots to the data store.

type Error = Infallible

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

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

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

Available on crate feature orchard only.

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

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<Infallible>>,

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.

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.

impl WalletRead for MockWalletDb

type Error = ()

The type of errors that may be generated when querying a wallet data store.

type AccountId = u32

The type of the account identifier.

type Account = (<MockWalletDb as WalletRead>::AccountId, UnifiedFullViewingKey)

The concrete account type used by this wallet backend.

fn get_account_ids(&self) -> Result<Vec<Self::AccountId>, Self::Error>

Returns a vector with the IDs of all accounts known to this wallet.

fn get_account( &self, _account_id: Self::AccountId, ) -> Result<Option<Self::Account>, Self::Error>

Returns the account corresponding to the given ID, if any.

fn get_derived_account( &self, _seed: &SeedFingerprint, _account_id: AccountId, ) -> Result<Option<Self::Account>, Self::Error>

Returns the account corresponding to a given [SeedFingerprint] and [zip32::AccountId], if any.

fn validate_seed( &self, _account_id: Self::AccountId, _seed: &SecretVec<u8>, ) -> Result<bool, Self::Error>

Verifies that the given seed corresponds to the viewing key for the specified account.

fn seed_relevance_to_derived_accounts( &self, _seed: &SecretVec<u8>, ) -> Result<SeedRelevance<Self::AccountId>, Self::Error>

Checks whether the given seed is relevant to any of the derived accounts (where Account::source is AccountSource::Derived) in the wallet.

fn get_account_for_ufvk( &self, _ufvk: &UnifiedFullViewingKey, ) -> Result<Option<Self::Account>, Self::Error>

Returns the account corresponding to a given UnifiedFullViewingKey, if any.

fn list_addresses( &self, _account: Self::AccountId, ) -> Result<Vec<AddressInfo>, Self::Error>

Returns information about every address tracked for this account.

fn get_last_generated_address_matching( &self, _account: Self::AccountId, _request: UnifiedAddressRequest, ) -> Result<Option<UnifiedAddress>, Self::Error>

Returns the most recently generated unified address for the specified account that conforms to the specified address filter, if the account identifier specified refers to a valid account for this wallet.

fn get_account_birthday( &self, _account: Self::AccountId, ) -> Result<BlockHeight, Self::Error>

Returns the birthday height for the given account, or an error if the account is not known to the wallet.

fn get_wallet_birthday(&self) -> Result<Option<BlockHeight>, Self::Error>

Returns the birthday height for the wallet.

fn get_wallet_summary( &self, _min_confirmations: u32, ) -> Result<Option<WalletSummary<Self::AccountId>>, Self::Error>

Returns a WalletSummary that represents the sync status, and the wallet balances given the specified minimum number of confirmations for all accounts known to the wallet; or Ok(None) if the wallet has no summary data available.

fn chain_height(&self) -> Result<Option<BlockHeight>, Self::Error>

Returns the height of the chain as known to the wallet as of the most recent call to WalletWrite::update_chain_tip.

fn get_block_hash( &self, _block_height: BlockHeight, ) -> Result<Option<BlockHash>, Self::Error>

Returns the block hash for the block at the given height, if the associated block data is available. Returns Ok(None) if the hash is not found in the database.

fn block_metadata( &self, _height: BlockHeight, ) -> Result<Option<BlockMetadata>, Self::Error>

Returns the available block metadata for the block at the specified height, if any.

fn block_fully_scanned(&self) -> Result<Option<BlockMetadata>, Self::Error>

Returns the metadata for the block at the height to which the wallet has been fully scanned.

fn get_max_height_hash( &self, ) -> Result<Option<(BlockHeight, BlockHash)>, Self::Error>

Returns the block height and hash for the block at the maximum scanned block height.

fn block_max_scanned(&self) -> Result<Option<BlockMetadata>, Self::Error>

Returns block metadata for the maximum height that the wallet has scanned.

fn suggest_scan_ranges(&self) -> Result<Vec<ScanRange>, Self::Error>

Returns a vector of suggested scan ranges based upon the current wallet state.

fn get_target_and_anchor_heights( &self, _min_confirmations: NonZeroU32, ) -> Result<Option<(BlockHeight, BlockHeight)>, Self::Error>

Returns the default target height (for the block in which a new transaction would be mined) and anchor height (to use for a new transaction), given the range of block heights that the backend knows about.

fn get_tx_height(&self, _txid: TxId) -> Result<Option<BlockHeight>, Self::Error>

Returns the block height in which the specified transaction was mined, or Ok(None) if the transaction is not in the main chain.

fn get_unified_full_viewing_keys( &self, ) -> Result<HashMap<Self::AccountId, UnifiedFullViewingKey>, Self::Error>

Returns all unified full viewing keys known to this wallet.

fn get_memo(&self, _id_note: NoteId) -> Result<Option<Memo>, Self::Error>

Returns the memo for a note.

fn get_transaction( &self, _txid: TxId, ) -> Result<Option<Transaction>, Self::Error>

Returns a transaction.

fn get_sapling_nullifiers( &self, _query: NullifierQuery, ) -> Result<Vec<(Self::AccountId, Nullifier)>, Self::Error>

Returns the nullifiers for Sapling notes that the wallet is tracking, along with their associated account IDs, that are either unspent or have not yet been confirmed as spent (in that a spending transaction known to the wallet has not yet been included in a block).

fn get_orchard_nullifiers( &self, _query: NullifierQuery, ) -> Result<Vec<(Self::AccountId, Nullifier)>, Self::Error>

Available on crate feature orchard only.

Returns the nullifiers for Orchard notes that the wallet is tracking, along with their associated account IDs, that are either unspent or have not yet been confirmed as spent (in that a spending transaction known to the wallet has not yet been included in a block).

fn get_transparent_receivers( &self, _account: Self::AccountId, _include_change: bool, ) -> Result<HashMap<TransparentAddress, Option<TransparentAddressMetadata>>, Self::Error>

Available on crate feature transparent-inputs only.

Returns the set of non-ephemeral transparent receivers associated with the given account controlled by this wallet.

fn get_transparent_balances( &self, _account: Self::AccountId, _max_height: BlockHeight, ) -> Result<HashMap<TransparentAddress, Zatoshis>, Self::Error>

Available on crate feature transparent-inputs only.

Returns a mapping from each transparent receiver associated with the specified account to its not-yet-shielded UTXO balance as of the end of the block at the provided max_height, when that balance is non-zero.

fn get_transparent_address_metadata( &self, _account: Self::AccountId, _address: &TransparentAddress, ) -> Result<Option<TransparentAddressMetadata>, Self::Error>

Available on crate feature transparent-inputs only.

Returns the metadata associated with a given transparent receiver in an account controlled by this wallet, if available.

fn get_known_ephemeral_addresses( &self, _account: Self::AccountId, _index_range: Option<Range<NonHardenedChildIndex>>, ) -> Result<Vec<(TransparentAddress, TransparentAddressMetadata)>, Self::Error>

Available on crate feature transparent-inputs only.

Returns a vector of ephemeral transparent addresses associated with the given account controlled by this wallet, along with their metadata. The result includes reserved addresses, and addresses for the backend’s configured gap limit worth of additional indices (capped to the maximum index).

fn utxo_query_height( &self, _account: Self::AccountId, ) -> Result<BlockHeight, Self::Error>

Available on crate feature transparent-inputs only.

Returns the maximum block height at which a transparent output belonging to the wallet has been observed.

fn find_account_for_ephemeral_address( &self, _address: &TransparentAddress, ) -> Result<Option<Self::AccountId>, Self::Error>

Available on crate feature transparent-inputs only.

If a given ephemeral address might have been reserved, i.e. would be included in the result of get_known_ephemeral_addresses(account_id, None) for any of the wallet’s accounts, then return Ok(Some(account_id)). Otherwise return Ok(None).

fn transaction_data_requests( &self, ) -> Result<Vec<TransactionDataRequest>, Self::Error>

Returns a vector of TransactionDataRequest values that describe information needed by the wallet to complete its view of transaction history.

impl WalletWrite for MockWalletDb

fn put_received_transparent_utxo( &mut self, _output: &WalletTransparentOutput, ) -> Result<Self::UtxoRef, Self::Error>

Adds a transparent UTXO received by the wallet to the data store.

type UtxoRef = u32

The type of identifiers used to look up transparent UTXOs.

fn create_account( &mut self, _account_name: &str, seed: &SecretVec<u8>, _birthday: &AccountBirthday, _key_source: Option<&str>, ) -> Result<(Self::AccountId, UnifiedSpendingKey), Self::Error>

Tells the wallet to track the next available account-level spend authority, given the current set of ZIP 316 account identifiers known to the wallet database.

fn import_account_hd( &mut self, _account_name: &str, _seed: &SecretVec<u8>, _account_index: AccountId, _birthday: &AccountBirthday, _key_source: Option<&str>, ) -> Result<(Self::Account, UnifiedSpendingKey), Self::Error>

Tells the wallet to track a specific account index for a given seed.

fn import_account_ufvk( &mut self, _account_name: &str, _unified_key: &UnifiedFullViewingKey, _birthday: &AccountBirthday, _purpose: AccountPurpose, _key_source: Option<&str>, ) -> Result<Self::Account, Self::Error>

Tells the wallet to track an account using a unified full viewing key.

fn get_next_available_address( &mut self, _account: Self::AccountId, _request: UnifiedAddressRequest, ) -> Result<Option<(UnifiedAddress, DiversifierIndex)>, Self::Error>

Generates, persists, and marks as exposed the next available diversified address for the specified account, given the current addresses known to the wallet.

fn get_address_for_index( &mut self, _account: Self::AccountId, _diversifier_index: DiversifierIndex, _request: UnifiedAddressRequest, ) -> Result<Option<UnifiedAddress>, Self::Error>

Generates, persists, and marks as exposed a diversified address for the specified account at the provided diversifier index.

fn put_blocks( &mut self, _from_state: &ChainState, _blocks: Vec<ScannedBlock<Self::AccountId>>, ) -> Result<(), Self::Error>

Updates the state of the wallet database by persisting the provided block information, along with the note commitments that were detected when scanning the block for transactions pertaining to this wallet.

fn update_chain_tip( &mut self, _tip_height: BlockHeight, ) -> Result<(), Self::Error>

Updates the wallet’s view of the blockchain.

fn store_decrypted_tx( &mut self, _received_tx: DecryptedTransaction<'_, Self::AccountId>, ) -> Result<(), Self::Error>

Caches a decrypted transaction in the persistent wallet store.

fn store_transactions_to_be_sent( &mut self, _transactions: &[SentTransaction<'_, Self::AccountId>], ) -> Result<(), Self::Error>

Saves information about transactions constructed by the wallet to the persistent wallet store.

fn truncate_to_height( &mut self, _block_height: BlockHeight, ) -> Result<BlockHeight, Self::Error>

Truncates the wallet database to at most the specified height.

fn reserve_next_n_ephemeral_addresses( &mut self, _account_id: Self::AccountId, _n: usize, ) -> Result<Vec<(TransparentAddress, TransparentAddressMetadata)>, Self::Error>

Available on crate feature transparent-inputs only.

Reserves the next n available ephemeral addresses for the given account. This cannot be undone, so as far as possible, errors associated with transaction construction should have been reported before calling this method.

fn set_transaction_status( &mut self, _txid: TxId, _status: TransactionStatus, ) -> Result<(), Self::Error>

Updates the wallet backend with respect to the status of a specific transaction, from the perspective of the main chain.