Struct pallet_transaction_payment::ChargeTransactionPayment

pub struct ChargeTransactionPayment<T: Config>(_);

Require the transactor pay for themselves and maybe include a tip to gain additional priority in the queue.

Transaction Validity

This extension sets the priority field of TransactionValidity depending on the amount of tip being paid per weight unit.

Operational transactions will receive an additional priority bump, so that they are normally considered before regular transactions.

Implementations

impl<T: Config> ChargeTransactionPayment<T>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: Send + Sync + FixedPointOperand,

pub fn from(
    fee: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> Self

utility constructor. Used only in client/factory code.

pub fn tip(
    &self
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance

Returns the tip as being chosen by the transaction sender.

pub fn get_priority(
    info: &DispatchInfoOf<T::RuntimeCall>,
    len: usize,
    tip: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance,
    final_fee: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> TransactionPriority

Get an appropriate priority for a transaction with the given DispatchInfo, encoded length and user-included tip.

The priority is based on the amount of tip the user is willing to pay per unit of either weight or length, depending which one is more limiting. For Operational extrinsics we add a “virtual tip” to the calculations.

The formula should simply be tip / bounded_{weight|length}, but since we are using integer division, we have no guarantees it’s going to give results in any reasonable range (might simply end up being zero). Hence we use a scaling factor: tip * (max_block_{weight|length} / bounded_{weight|length}), since given current state of-the-art blockchains, number of per-block transactions is expected to be in a range reasonable enough to not saturate the Balance type while multiplying by the tip.

Trait Implementations

impl<T: Clone + Config> Clone for ChargeTransactionPayment<T>

fn clone(&self) -> ChargeTransactionPayment<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config> Debug for ChargeTransactionPayment<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for ChargeTransactionPayment<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for ChargeTransactionPayment<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: PartialEq + Config> PartialEq<ChargeTransactionPayment<T>> for ChargeTransactionPayment<T>

fn eq(&self, other: &ChargeTransactionPayment<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> SignedExtension for ChargeTransactionPayment<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: Send + Sync + From<u64> + FixedPointOperand,
    T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

const IDENTIFIER: &'static str = "ChargeTransactionPayment"

Unique identifier of this signed extension.

type AccountId = <T as Config>::AccountId

The type which encodes the sender identity.

type Call = <T as Config>::RuntimeCall

The type which encodes the call to be dispatched.

type AdditionalSigned = ()

Any additional data that will go into the signed payload. This may be created dynamically from the transaction using the additional_signed function.

type Pre = (<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance, <ChargeTransactionPayment<T> as SignedExtension>::AccountId, <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::LiquidityInfo)

The type that encodes information that can be passed from pre_dispatch to post-dispatch.

fn additional_signed(&self) -> Result<(), TransactionValidityError>

Construct any additional data that should be in the signed payload of the transaction. Can also perform any pre-signature-verification checks and return an error if needed.

fn validate(
    &self,
    who: &Self::AccountId,
    call: &Self::Call,
    info: &DispatchInfoOf<Self::Call>,
    len: usize
) -> TransactionValidity

Validate a signed transaction for the transaction queue.

fn pre_dispatch(
    self,
    who: &Self::AccountId,
    call: &Self::Call,
    info: &DispatchInfoOf<Self::Call>,
    len: usize
) -> Result<Self::Pre, TransactionValidityError>

Do any pre-flight stuff for a signed transaction.

fn post_dispatch(
    maybe_pre: Option<Self::Pre>,
    info: &DispatchInfoOf<Self::Call>,
    post_info: &PostDispatchInfoOf<Self::Call>,
    len: usize,
    _result: &DispatchResult
) -> Result<(), TransactionValidityError>

Do any post-flight stuff for an extrinsic.

fn validate_unsigned(
    _call: &Self::Call,
    _info: &<Self::Call as Dispatchable>::Info,
    _len: usize
) -> Result<ValidTransaction, TransactionValidityError>

Validate an unsigned transaction for the transaction queue.

fn pre_dispatch_unsigned(
    call: &Self::Call,
    info: &<Self::Call as Dispatchable>::Info,
    len: usize
) -> Result<(), TransactionValidityError>

Do any pre-flight stuff for a unsigned transaction.

fn metadata() -> Vec<SignedExtensionMetadata, Global>

Returns the metadata for this signed extension.

impl<T: Config> TypeInfo for ChargeTransactionPayment<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact,
    T: Config + 'static,

type Identity = ChargeTransactionPayment<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> EncodeLike<ChargeTransactionPayment<T>> for ChargeTransactionPayment<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact,

impl<T: Eq + Config> Eq for ChargeTransactionPayment<T>

impl<T: Config> StructuralEq for ChargeTransactionPayment<T>

impl<T: Config> StructuralPartialEq for ChargeTransactionPayment<T>