Struct MultiOutputChangeStrategy

pub struct MultiOutputChangeStrategy<R, I> { /* private fields */ }

A change strategy that attempts to split the change value into some number of equal-sized notes as dictated by the included SplitPolicy value.

Implementations

impl<R, I> MultiOutputChangeStrategy<R, I>

pub fn new( fee_rule: R, change_memo: Option<MemoBytes>, fallback_change_pool: ShieldedProtocol, dust_output_policy: DustOutputPolicy, split_policy: SplitPolicy, ) -> Self

Constructs a new MultiOutputChangeStrategy with the specified ZIP 317 fee parameters, change memo, and change splitting policy.

This change strategy will fall back to creating a single change output if insufficient change value is available to create notes with at least the minimum value dictated by the split policy.

• fallback_change_pool: the pool to which change will be sent if when more than one shielded pool is enabled via feature flags, and the transaction has no shielded inputs.
• split_policy: A policy value describing how the change value should be returned as multiple notes.

Trait Implementations

impl<R, I> ChangeStrategy for MultiOutputChangeStrategy<R, I>

where R: Zip317FeeRule + Clone, I: InputSource, <R as FeeRule>::Error: From<BalanceError>,

type FeeRule = R

type Error = <R as FeeRule>::Error

type MetaSource = I

The type of metadata source that this change strategy requires in order to be able to retrieve required wallet metadata. If more capabilities are required of the backend than are exposed in the InputSource trait, the implementer of this trait should define their own trait that descends from InputSource and adds the required capabilities there, and then implement that trait for their desired database backend.

type AccountMetaT = AccountMeta

Tye type of wallet metadata that this change strategy relies upon in order to compute change.

fn fee_rule(&self) -> &Self::FeeRule

Returns the fee rule that this change strategy will respect when performing balance computations.

fn fetch_wallet_meta( &self, meta_source: &Self::MetaSource, account: <Self::MetaSource as InputSource>::AccountId, exclude: &[<Self::MetaSource as InputSource>::NoteRef], ) -> Result<Self::AccountMetaT, <Self::MetaSource as InputSource>::Error>

Uses the provided metadata source to obtain the wallet metadata required for change creation determinations.

fn compute_balance<P: Parameters, NoteRefT: Clone>( &self, params: &P, target_height: BlockHeight, transparent_inputs: &[impl InputView], transparent_outputs: &[impl OutputView], sapling: &impl BundleView<NoteRefT>, orchard: &impl BundleView<NoteRefT>, ephemeral_balance: Option<&EphemeralBalance>, wallet_meta: &Self::AccountMetaT, ) -> Result<TransactionBalance, ChangeError<Self::Error, NoteRefT>>

Computes the totals of inputs, suggested change amounts, and fees given the provided inputs and outputs being used to construct a transaction.