Struct ChargeTransactionPayment

pub struct ChargeTransactionPayment<T: Config>(/* private fields */);

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,

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 decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 size_hint(&self) -> usize

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

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<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Config> TransactionExtension<<T as Config>::RuntimeCall> for ChargeTransactionPayment<T>

where T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

const IDENTIFIER: &'static str = "ChargeTransactionPayment"

Unique identifier of this signed extension.

type Implicit = ()

Any additional data which was known at the time of transaction construction and can be useful in authenticating the transaction. This is determined dynamically in part from the on-chain environment using the implicit function and not directly contained in the transaction itself and therefore is considered “implicit”.

type Val = Val<T>

The type that encodes information that can be passed from validate to prepare.

type Pre = Pre<T>

The type that encodes information that can be passed from prepare to post_dispatch.

fn weight(&self, _: &T::RuntimeCall) -> Weight

The weight consumed by executing this extension instance fully during transaction dispatch.

fn validate( &self, origin: <T::RuntimeCall as Dispatchable>::RuntimeOrigin, call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, len: usize, _: (), _implication: &impl Encode, _source: TransactionSource, ) -> Result<(ValidTransaction, Self::Val, <T::RuntimeCall as Dispatchable>::RuntimeOrigin), TransactionValidityError>

Validate a transaction for the transaction queue.

fn prepare( self, val: Self::Val, _origin: &<T::RuntimeCall as Dispatchable>::RuntimeOrigin, call: &T::RuntimeCall, info: &DispatchInfoOf<T::RuntimeCall>, _len: usize, ) -> Result<Self::Pre, TransactionValidityError>

Do any pre-flight stuff for a transaction after validation.

fn post_dispatch_details( pre: Self::Pre, info: &DispatchInfoOf<T::RuntimeCall>, post_info: &PostDispatchInfoOf<T::RuntimeCall>, len: usize, _result: &DispatchResult, ) -> Result<Weight, TransactionValidityError>

Do any post-flight stuff for an extrinsic.

fn implicit(&self) -> Result<Self::Implicit, TransactionValidityError>

Determine any additional data which was known at the time of transaction construction and can be useful in authenticating the transaction. The expected usage of this is to include in any data which is signed and verified as part of transaction validation. Also perform any pre-signature-verification checks and return an error if needed.

fn metadata() -> Vec<TransactionExtensionMetadata>

Returns the metadata for this extension.

fn post_dispatch( pre: Self::Pre, info: &<Call as Dispatchable>::Info, post_info: &mut <Call as Dispatchable>::PostInfo, len: usize, result: &Result<(), DispatchError>, ) -> Result<(), TransactionValidityError>

A wrapper for post_dispatch_details that refunds the unspent weight consumed by this extension into the post dispatch information.

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

Validation logic for bare extrinsics.

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

All pre-flight logic run before dispatching bare extrinsics.

fn bare_post_dispatch( _info: &<Call as Dispatchable>::Info, _post_info: &mut <Call as Dispatchable>::PostInfo, _len: usize, _result: &Result<(), DispatchError>, ) -> Result<(), TransactionValidityError>

Post dispatch logic run after dispatching bare extrinsics.

impl<T> 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> DecodeWithMemTracking for ChargeTransactionPayment<T>

where <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact, <<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance as HasCompact>::Type: DecodeWithMemTracking,

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

where <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: HasCompact,

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

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