Struct GreedyInputSelector 

pub struct GreedyInputSelector<DbT> { /* private fields */ }

An InputSelector implementation that uses a greedy strategy to select between available notes.

This implementation performs input selection using methods available via the InputSource interface.

Implementations

impl<DbT> GreedyInputSelector<DbT>

pub fn new() -> Self

Constructs a new greedy input selector that uses the provided change strategy to determine change values and fee amounts.

The ChangeStrategy provided must produce exactly one ephemeral change value when computing a transaction balance if an EphemeralBalance::Output value is provided for its ephemeral balance, or the resulting GreedyInputSelector will return an error when attempting to construct a transaction proposal that requires such an output.

pub fn with_shielding_block_space_percent(self, percent: u32) -> Self

Available on crate feature transparent-inputs only.

Sets the maximum fraction of a block’s space, as an integer percentage (0–100), that a single transaction’s transparent inputs may occupy.

When shielding gathers more spendable transparent outputs than will fit within this bound, the highest-value outputs are selected first and the remainder are left unspent, to be consolidated by a subsequent shielding transaction. When a general (non-shielding) transfer’s transparent gather would otherwise require more inputs than fit within this bound, the gather stops at the cap even if the requested value has not yet been reached; the caller’s input-selection loop surfaces this as an InsufficientFunds error, the same as for any other value shortfall. Values above 100 are clamped to 100. Defaults to 10.

pub fn with_locked_input_policy(self, policy: LockedInputPolicy) -> Self

Available on crate feature transparent-inputs only.

Sets the policy governing whether shielding (via ShieldingSelector::propose_shielding and ShieldingSelector::propose_shielding_coinbase) may draw on transparent UTXOs locked by one of the given policy’s owners (default: LockedInputPolicy::Exclude, which never selects a locked output). This overrides a lock only for the purpose of selecting through it during shielding; it does not release the lock.

Trait Implementations

impl<DbT> Default for GreedyInputSelector<DbT>

fn default() -> Self

Returns the “default value” for a type.

impl<DbT: InputSource> InputSelector for GreedyInputSelector<DbT>

type Error = GreedyInputSelectorError

The type of errors that may be generated in input selection

type InputSource = DbT

The type of data source that the input selector expects to access to obtain input notes. This associated type permits input selectors that may use specialized knowledge of the internals of a particular backing data store, if the generic API of InputSource does not provide sufficiently fine-grained operations for a particular backing store to optimally perform input selection.

fn propose_transaction<ParamsT, ChangeT>( &self, params: &ParamsT, wallet_db: &Self::InputSource, target_height: TargetHeight, anchor_height: BlockHeight, zip318: &PoolMigrationParams, confirmations_policy: ConfirmationsPolicy, account: <DbT as InputSource>::AccountId, transaction_request: TransactionRequest, change_strategy: &ChangeT, spend_policy: &SpendPolicy, proposed_version: Option<TxVersion>, ) -> Result<Proposal<<ChangeT as ChangeStrategy>::FeeRule, DbT::NoteRef>, InputSelectorError<<DbT as InputSource>::Error, Self::Error, ChangeT::Error, DbT::NoteRef>>

where ParamsT: Parameters, Self::InputSource: InputSource, ChangeT: ChangeStrategy<MetaSource = DbT>,

Performs input selection and returns a proposal for transaction construction including change and fee outputs.

impl<DbT: InputSource> ShieldingSelector for GreedyInputSelector<DbT>

Available on crate feature transparent-inputs only.

type Error = GreedyInputSelectorError

The type of errors that may be generated in input selection

type InputSource = DbT

The type of data source that the input selector expects to access to obtain input transparent UTXOs. This associated type permits input selectors that may use specialized knowledge of the internals of a particular backing data store, if the generic API of InputSource does not provide sufficiently fine-grained operations for a particular backing store to optimally perform input selection.

fn propose_shielding<ParamsT, ChangeT>( &self, params: &ParamsT, wallet_db: &Self::InputSource, change_strategy: &ChangeT, shielding_threshold: Zatoshis, source_addrs: &[TransparentAddress], to_account: <Self::InputSource as InputSource>::AccountId, target_height: TargetHeight, anchor_height: BlockHeight, zip318: &PoolMigrationParams, confirmations_policy: ConfirmationsPolicy, output_filter: CoinbaseFilter, ) -> Result<Proposal<<ChangeT as ChangeStrategy>::FeeRule, Infallible>, InputSelectorError<<DbT as InputSource>::Error, Self::Error, ChangeT::Error, Infallible>>

where ParamsT: Parameters, ChangeT: ChangeStrategy<MetaSource = Self::InputSource>,

Performs input selection and returns a proposal for the construction of a shielding transaction.

fn propose_shielding_coinbase<ParamsT, FeeRuleT>( &self, params: &ParamsT, wallet_db: &Self::InputSource, fee_rule: &FeeRuleT, shielding_threshold: Zatoshis, source_addrs: &[TransparentAddress], to_address: ZcashAddress, memo: Option<MemoBytes>, limit: Option<usize>, target_height: TargetHeight, anchor_height: BlockHeight, ) -> Result<Proposal<FeeRuleT, Infallible>, InputSelectorError<<DbT as InputSource>::Error, Self::Error, FeeRuleT::Error, Infallible>>

where ParamsT: Parameters, FeeRuleT: FeeRule + Clone,

Performs input selection and returns a proposal for the construction of a transaction that shields coinbase transparent outputs to an arbitrary shielded recipient.