Struct pallet_transaction_payment::CurrencyAdapter

pub struct CurrencyAdapter<C, OU>(_);

Implements the transaction payment for a pallet implementing the Currency trait (eg. the pallet_balances) using an unbalance handler (implementing OnUnbalanced).

The unbalance handler is given 2 unbalanceds in OnUnbalanced::on_unbalanceds: fee and then tip.

Trait Implementations

impl<T, C, OU> OnChargeTransaction<T> for CurrencyAdapter<C, OU>where
    T: Config,
    C: Currency<<T as Config>::AccountId>,
    C::PositiveImbalance: Imbalance<<C as Currency<<T as Config>::AccountId>>::Balance, Opposite = C::NegativeImbalance>,
    C::NegativeImbalance: Imbalance<<C as Currency<<T as Config>::AccountId>>::Balance, Opposite = C::PositiveImbalance>,
    OU: OnUnbalanced<<C as Currency<<T as Config>::AccountId>>::NegativeImbalance>,

Default implementation for a Currency and an OnUnbalanced handler.

The unbalance handler is given 2 unbalanceds in OnUnbalanced::on_unbalanceds: fee and then tip.

fn withdraw_fee(
    who: &T::AccountId,
    _call: &T::RuntimeCall,
    _info: &DispatchInfoOf<T::RuntimeCall>,
    fee: Self::Balance,
    tip: Self::Balance
) -> Result<Self::LiquidityInfo, TransactionValidityError>

Withdraw the predicted fee from the transaction origin.

Note: The fee already includes the tip.

fn correct_and_deposit_fee(
    who: &T::AccountId,
    _dispatch_info: &DispatchInfoOf<T::RuntimeCall>,
    _post_info: &PostDispatchInfoOf<T::RuntimeCall>,
    corrected_fee: Self::Balance,
    tip: Self::Balance,
    already_withdrawn: Self::LiquidityInfo
) -> Result<(), TransactionValidityError>

Hand the fee and the tip over to the [OnUnbalanced] implementation. Since the predicted fee might have been too high, parts of the fee may be refunded.

Note: The corrected_fee already includes the tip.

type LiquidityInfo = Option<<C as Currency<<T as Config>::AccountId>>::NegativeImbalance>

type Balance = <C as Currency<<T as Config>::AccountId>>::Balance

The underlying integer type in which fees are calculated.