Struct pallet_transaction_payment::pallet::Pallet

pub struct Pallet<T>(_);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn next_fee_multiplier() -> Multiplier

An auto-generated getter for NextFeeMultiplier.

impl<T: Config> Pallet<T>

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,

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::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>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(_: BlockNumberFor<T>)

Block finalization hook. This is called at the very end of block execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before Hooks::on_finalize).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

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

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

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

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See Hooks::pre_upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See Hooks::post_upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>

Execute the state checks.

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>