Struct pallet_transaction_payment::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn next_fee_multiplier() -> Multiplier

impl<T: Config> Pallet<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: FixedPointOperand,

pub fn query_info<Extrinsic: Extrinsic + GetDispatchInfo>(
    unchecked_extrinsic: Extrinsic,
    len: u32
) -> RuntimeDispatchInfo<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo>,

Query the data that we know about the fee of a given call.

This pallet is not and cannot be aware of the internals of a signed extension, for example a tip. It only interprets the extrinsic as some encoded value and accounts for its weight and length, the runtime’s extrinsic base weight, and the current fee multiplier.

All dispatchables must be annotated with weight and will have some fee info. This function always returns.

pub fn query_fee_details<Extrinsic: Extrinsic + GetDispatchInfo>(
    unchecked_extrinsic: Extrinsic,
    len: u32
) -> FeeDetails<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo>,

Query the detailed fee of a given call.

pub fn query_call_info(
    call: T::RuntimeCall,
    len: u32
) -> RuntimeDispatchInfo<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo> + GetDispatchInfo,

Query information of a dispatch class, weight, and fee of a given encoded Call.

pub fn query_call_fee_details(
    call: T::RuntimeCall,
    len: u32
) -> FeeDetails<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo> + GetDispatchInfo,

Query fee details of a given encoded Call.

pub fn compute_fee(
    len: u32,
    info: &DispatchInfoOf<T::RuntimeCall>,
    tip: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balancewhere
    T::RuntimeCall: Dispatchable<Info = DispatchInfo>,

Compute the final fee value for a particular transaction.

pub fn compute_fee_details(
    len: u32,
    info: &DispatchInfoOf<T::RuntimeCall>,
    tip: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> FeeDetails<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo>,

Compute the fee details for a particular transaction.

pub fn compute_actual_fee(
    len: u32,
    info: &DispatchInfoOf<T::RuntimeCall>,
    post_info: &PostDispatchInfoOf<T::RuntimeCall>,
    tip: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balancewhere
    T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

Compute the actual post dispatch fee for a particular transaction.

Identical to compute_fee with the only difference that the post dispatch corrected weight is used for the weight fee calculation.

pub fn compute_actual_fee_details(
    len: u32,
    info: &DispatchInfoOf<T::RuntimeCall>,
    post_info: &PostDispatchInfoOf<T::RuntimeCall>,
    tip: <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance
) -> FeeDetails<<<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance>where
    T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

Compute the actual post dispatch fee details for a particular transaction.

pub fn length_to_fee(
    length: u32
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance

Compute the length portion of a fee by invoking the configured LengthToFee impl.

pub fn weight_to_fee(
    weight: Weight
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance

Compute the unadjusted portion of the weight fee by invoking the configured WeightToFee impl. Note that the input weight is capped by the maximum block weight before computation.

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Convert<Weight, <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance> for Pallet<T>where
    T: Config,
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: FixedPointOperand,

fn convert(
    weight: Weight
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance

Compute the fee for the specified weight.

This fee is already adjusted by the per block fee adjustment factor and is therefore the share that the weight contributes to the overall fee of a transaction. It is mainly for informational purposes and not used in the actual fee calculation.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config, AnyCall: GetDispatchInfo + Encode> EstimateCallFee<AnyCall, <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance> for Pallet<T>where
    <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance: FixedPointOperand,
    T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,

fn estimate_call_fee(
    call: &AnyCall,
    post_info: PostDispatchInfo
) -> <<T as Config>::OnChargeTransaction as OnChargeTransaction<T>>::Balance

Estimate the fee of this call.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_: T::BlockNumber)

The block is being finalized. Implement to have something happen.

fn integrity_test()

Run integrity test.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> 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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>