Struct zcash_client_sqlite::WalletDb

pub struct WalletDb<C, P> { /* private fields */ }

A wrapper for the SQLite connection to the wallet database.

Implementations

impl<P: Parameters + Clone> WalletDb<Connection, P>

pub fn for_path<F: AsRef<Path>>(path: F, params: P) -> Result<Self, Error>

Construct a connection to the wallet database stored at the specified path.

pub fn transactionally<F, A, E: From<Error>>(&mut self, f: F) -> Result<A, E>where F: FnOnce(&mut WalletDb<SqlTransaction<'_>, P>) -> Result<A, E>,

Trait Implementations

impl<P: Parameters> WalletCommitmentTrees for WalletDb<Connection, P>

type Error = Error

type SaplingShardStore<'a> = SqliteShardStore<&'a Transaction<'a>, Node, SAPLING_SHARD_HEIGHT>

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

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

fn get_checkpoint_depth( &self, min_confirmations: NonZeroU32 ) -> Result<usize, ShardTreeError<Self::Error>>

Returns the depth of the checkpoint in the tree that can be used to create a witness at the anchor having the given number of confirmations.

impl<'conn, P: Parameters> WalletCommitmentTrees for WalletDb<SqlTransaction<'conn>, P>

type Error = Error

type SaplingShardStore<'a> = SqliteShardStore<&'a Transaction<'a>, Node, SAPLING_SHARD_HEIGHT>

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

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

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

fn get_checkpoint_depth( &self, min_confirmations: NonZeroU32 ) -> Result<usize, ShardTreeError<Self::Error>>

Returns the depth of the checkpoint in the tree that can be used to create a witness at the anchor having the given number of confirmations.

impl<C: Borrow<Connection>, P: Parameters> WalletRead for WalletDb<C, P>

type Error = SqliteClientError

The type of errors produced by a wallet backend.

type NoteRef = ReceivedNoteId

Backend-specific note identifier.

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 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 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_min_unspent_height(&self) -> Result<Option<BlockHeight>, Self::Error>

Returns the minimum block height corresponding to an unspent note in the wallet.

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 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 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_wallet_birthday(&self) -> Result<Option<BlockHeight>, Self::Error>

Returns the birthday height for the wallet.

fn get_account_birthday( &self, account: 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_current_address( &self, account: AccountId ) -> Result<Option<UnifiedAddress>, Self::Error>

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

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

Returns all unified full viewing keys known to this wallet.

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

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

fn is_valid_account_extfvk( &self, account: AccountId, extfvk: &ExtendedFullViewingKey ) -> Result<bool, Self::Error>

Checks whether the specified extended full viewing key is associated with the account.

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

Returns the wallet balances and sync status for an account given the specified minimum number of confirmations, or Ok(None) if the wallet has no balance data available.

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

Returns the memo for a note.

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

Returns a transaction.

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

Returns the nullifiers for 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_spendable_sapling_notes( &self, account: AccountId, anchor_height: BlockHeight, exclude: &[Self::NoteRef] ) -> Result<Vec<ReceivedSaplingNote<Self::NoteRef>>, Self::Error>

Return all unspent Sapling notes, excluding the specified note IDs.

fn select_spendable_sapling_notes( &self, account: AccountId, target_value: Amount, anchor_height: BlockHeight, exclude: &[Self::NoteRef] ) -> Result<Vec<ReceivedSaplingNote<Self::NoteRef>>, Self::Error>

Returns a list of spendable Sapling notes sufficient to cover the specified target value, if possible.

fn get_transparent_receivers( &self, _account: AccountId ) -> Result<HashMap<TransparentAddress, AddressMetadata>, Self::Error>

Returns the set of all transparent receivers associated with the given account.

fn get_unspent_transparent_outputs( &self, _address: &TransparentAddress, _max_height: BlockHeight, _exclude: &[OutPoint] ) -> Result<Vec<WalletTransparentOutput>, Self::Error>

Returns a list of unspent transparent UTXOs that appear in the chain at heights up to and including max_height.

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

Returns a mapping from transparent receiver to not-yet-shielded UTXO balance, for each address associated with a nonzero balance.

impl<P: Parameters> WalletWrite for WalletDb<Connection, P>

type UtxoRef = UtxoId

The type of identifiers used to look up transparent UTXOs.

fn create_account( &mut self, seed: &SecretVec<u8>, birthday: AccountBirthday ) -> Result<(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 get_next_available_address( &mut self, account: AccountId ) -> Result<Option<UnifiedAddress>, Self::Error>

Generates and persists the next available diversified address, given the current addresses known to the wallet.

fn put_blocks( &mut self, blocks: Vec<ScannedBlock<Nullifier>> ) -> 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, d_tx: DecryptedTransaction<'_> ) -> Result<(), Self::Error>

Caches a decrypted transaction in the persistent wallet store.

fn store_sent_tx( &mut self, sent_tx: &SentTransaction<'_> ) -> Result<(), Self::Error>

Saves information about a transaction that was constructed and sent by the wallet to the persistent wallet store.

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

Truncates the wallet database to the specified height.

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.