Struct FixedNotes 

pub struct FixedNotes { /* private fields */ }

Available on crate features test-dependencies only.

An InputSource holding a fixed list of shielded notes, for tests that drive input selection without a wallet database.

Selection takes the notes in the order given, within the pools asked for, until the target value is reached. Unlike zcash_client_sqlite, it does not withhold notes at or below the marginal fee. Every note is spendable by any account, and every account can receive change in every shielded pool and has no transparent receiver. The selection methods, InputSource::select_unspent_notes and InputSource::get_change_receivers are implemented; every other operation returns FixedNotesError::Unsupported.

Implementations

impl FixedNotes

pub fn new(notes: &[(ShieldedPool, u32, Zatoshis)]) -> Self

Holds one note per entry, given as its pool, identifier and value in selection order. Each note is received at its own output index of a single transaction.

Panics

When the notes’ total value exceeds the monetary range, when there are more notes than a u16 output index can number, and without the orchard feature on an Orchard or Ironwood entry.

pub fn ignoring_sources(self) -> Self

Returns the source with the sources argument of the selection methods ignored, so that it returns notes from pools it was not asked for, breaking the contract of InputSource.

pub fn ignoring_exclude(self) -> Self

Returns the source with the exclude argument of the selection methods ignored, so that it returns excluded notes, breaking the contract of InputSource.

pub fn with_selection_limit(self, limit: usize) -> Self

Returns the source failing with FixedNotesError::SelectionLimitReached past limit calls to InputSource::select_spendable_notes, so that a test of input selection’s termination fails instead of hanging.

Trait Implementations

impl InputSource for FixedNotes

type Error = FixedNotesError

The type of errors produced by a wallet backend.

type AccountId = u32

Backend-specific account identifier.

type NoteRef = u32

Backend-specific note identifier.

fn get_spendable_note( &self, _txid: &TxId, _protocol: ShieldedPool, _index: u32, _target_height: TargetHeight, _lock_filter: LockFilter<'_>, ) -> 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 anchor_computable( &self, _protocol: ShieldedPool, _height: BlockHeight, ) -> Result<bool, Self::Error>

Returns whether an anchor is COMPUTABLE at height for spends from the given pool: whether this data source can produce the note commitment tree root, and witnesses to it, as of the end of that block.

fn select_spendable_notes( &self, _account: Self::AccountId, target_value: TargetValue, sources: &[ShieldedPool], _target_height: TargetHeight, _confirmations_policy: ConfirmationsPolicy, exclude: &[Self::NoteRef], _lock_filter: LockFilter<'_>, ) -> Result<ReceivedNotes<Self::NoteRef>, Self::Error>

Returns a list of spendable notes sufficient to cover the specified target value, if possible. Only spendable notes from the pools in sources will be included, and a note in exclude is never returned. Locked outputs are selected according to lock_filter (see LockFilter; a LockFilter::Policy carrying the default Exclude selects none).

fn select_unspent_notes( &self, _account: Self::AccountId, sources: &[ShieldedPool], _target_height: TargetHeight, exclude: &[Self::NoteRef], _lock_filter: LockFilter<'_>, ) -> Result<ReceivedNotes<Self::NoteRef>, Self::Error>

Returns the list of notes belonging to the wallet that are unspent as of the specified target height. Locked outputs are selected according to lock_filter (see LockFilter; a LockFilter::Policy carrying the default Exclude selects none).

fn get_change_receivers( &self, _account: Self::AccountId, ) -> Result<ChangeReceivers, Self::Error>

Returns the outputs in which the specified account can receive change.

fn get_account_metadata( &self, _account: Self::AccountId, _selector: &NoteFilter, _target_height: TargetHeight, _exclude: &[Self::NoteRef], _lock_filter: LockFilter<'_>, ) -> Result<AccountMeta, Self::Error>

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

fn select_single_spendable_note( &self, account: Self::AccountId, value: Zatoshis, sources: &[ShieldedPool], target_height: TargetHeight, confirmations_policy: ConfirmationsPolicy, exclude: &[Self::NoteRef], lock_filter: LockFilter<'_>, ) -> Result<ReceivedNotes<Self::NoteRef>, Self::Error>

Returns the OLDEST single spendable note whose value alone is at least value, drawn from the first pool in sources (in the given preference order) that holds one. A note in exclude is never returned. The returned collection contains at most one note; it is empty when no single eligible note covers the value.

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

Available on crate feature transparent-inputs only.

Fetches the transparent output corresponding to the provided outpoint if it is considered spendable as of the provided target_height.

fn get_spendable_transparent_outputs( &self, _address: &TransparentAddress, _target_height: TargetHeight, _confirmations_policy: ConfirmationsPolicy, _output_filter: CoinbaseFilter, _lock_filter: LockFilter<'_>, ) -> Result<Vec<WalletTransparentOutput<Self::AccountId>>, Self::Error>

Available on crate feature transparent-inputs only.

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

fn get_spendable_transparent_outputs_for_addresses( &self, addresses: &[TransparentAddress], target_height: TargetHeight, confirmations_policy: ConfirmationsPolicy, output_filter: CoinbaseFilter, lock_filter: LockFilter<'_>, ) -> Result<Vec<WalletTransparentOutput<Self::AccountId>>, Self::Error>

Available on crate feature transparent-inputs only.

Returns the list of spendable transparent outputs received by this wallet at any of the given addresses, subject to the same spendability conditions as InputSource::get_spendable_transparent_outputs.

fn select_spendable_transparent_outputs( &self, account: Self::AccountId, target_height: TargetHeight, confirmations_policy: ConfirmationsPolicy, output_filter: CoinbaseFilter, address_allow_list: Option<&[TransparentAddress]>, target_value: TargetValue, max_inputs: usize, fee_rule: &StandardFeeRule, lock_filter: LockFilter<'_>, ) -> Result<Vec<WalletTransparentOutput<Self::AccountId>>, Self::Error>

Available on crate feature transparent-inputs only.

Returns the spendable transparent outputs received by account whose total post-fee value (sum of values minus the cumulative marginal fee cost of the gathered inputs themselves, per fee_rule) is at least target_value, or max_inputs outputs (whichever is reached first).