Struct frame_system::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

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

Implementations

impl<T: Config> Pallet<T>

pub fn remark( _origin: OriginFor<T>, remark: Vec<u8>, ) -> DispatchResultWithPostInfo

Make some on-chain remark.

Can be executed by every origin.

pub fn set_heap_pages( origin: OriginFor<T>, pages: u64, ) -> DispatchResultWithPostInfo

Set the number of pages in the WebAssembly environment’s heap.

pub fn set_code( origin: OriginFor<T>, code: Vec<u8>, ) -> DispatchResultWithPostInfo

Set the new runtime code.

pub fn set_code_without_checks( origin: OriginFor<T>, code: Vec<u8>, ) -> DispatchResultWithPostInfo

Set the new runtime code without doing any checks of the given code.

Note that runtime upgrades will not run if this is called with a not-increasing spec version!

pub fn set_storage( origin: OriginFor<T>, items: Vec<KeyValue>, ) -> DispatchResultWithPostInfo

Set some items of storage.

pub fn kill_storage( origin: OriginFor<T>, keys: Vec<Key>, ) -> DispatchResultWithPostInfo

Kill some items from storage.

pub fn kill_prefix( origin: OriginFor<T>, prefix: Key, subkeys: u32, ) -> DispatchResultWithPostInfo

Kill all storage items with a key that starts with the given prefix.

NOTE: We rely on the Root origin to provide us the number of subkeys under the prefix we are removing to accurately calculate the weight of this function.

pub fn remark_with_event( origin: OriginFor<T>, remark: Vec<u8>, ) -> DispatchResultWithPostInfo

Make some on-chain remark and emit event.

pub fn do_task( _origin: OriginFor<T>, task: T::RuntimeTask, ) -> DispatchResultWithPostInfo

pub fn authorize_upgrade( origin: OriginFor<T>, code_hash: T::Hash, ) -> DispatchResult

Authorize an upgrade to a given code_hash for the runtime. The runtime can be supplied later.

This call requires Root origin.

pub fn authorize_upgrade_without_checks( origin: OriginFor<T>, code_hash: T::Hash, ) -> DispatchResult

Authorize an upgrade to a given code_hash for the runtime. The runtime can be supplied later.

WARNING: This authorizes an upgrade that will take place without any safety checks, for example that the spec name remains the same and that the version number increases. Not recommended for normal use. Use authorize_upgrade instead.

This call requires Root origin.

pub fn apply_authorized_upgrade( _: OriginFor<T>, code: Vec<u8>, ) -> DispatchResultWithPostInfo

Provide the preimage (runtime binary) code for an upgrade that has been authorized.

If the authorization required a version check, this call will ensure the spec name remains unchanged and that the spec version has increased.

Depending on the runtime’s OnSetCode configuration, this function may directly apply the new code in the same block or attempt to schedule the upgrade.

All origins are allowed.

impl<T: Config> Pallet<T>

pub fn account<KArg>(k: KArg) -> AccountInfo<T::Nonce, T::AccountData>

where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for Account.

impl<T: Config> Pallet<T>

pub fn block_weight() -> ConsumedWeight

An auto-generated getter for BlockWeight.

impl<T: Config> Pallet<T>

pub fn block_hash<KArg>(k: KArg) -> T::Hash

where KArg: EncodeLike<BlockNumberFor<T>>,

An auto-generated getter for BlockHash.

impl<T: Config> Pallet<T>

pub fn extrinsic_data<KArg>(k: KArg) -> Vec<u8>

where KArg: EncodeLike<u32>,

An auto-generated getter for ExtrinsicData.

impl<T: Config> Pallet<T>

pub fn block_number() -> BlockNumberFor<T>

An auto-generated getter for Number.

impl<T: Config> Pallet<T>

pub fn parent_hash() -> T::Hash

An auto-generated getter for ParentHash.

impl<T: Config> Pallet<T>

pub fn digest() -> Digest

An auto-generated getter for Digest.

impl<T: Config> Pallet<T>

pub fn event_count() -> u32

An auto-generated getter for EventCount.

impl<T: Config> Pallet<T>

pub fn event_topics<KArg>(k: KArg) -> Vec<(BlockNumberFor<T>, u32)>

where KArg: EncodeLike<T::Hash>,

An auto-generated getter for EventTopics.

impl<T: Config> Pallet<T>

pub fn authorized_upgrade() -> Option<CodeUpgradeAuthorization<T>>

An auto-generated getter for AuthorizedUpgrade.

impl<T: Config> Pallet<T>

pub fn last_runtime_upgrade_spec_version() -> u32

Returns the spec_version of the last runtime upgrade.

This function is useful for writing guarded runtime migrations in the runtime. A runtime migration can use the spec_version to ensure that it isn’t applied twice. This works similar as the storage version for pallets.

This functions returns the spec_version of the last runtime upgrade while executing the runtime migrations on_runtime_upgrade function. After all migrations are executed, this will return the spec_version of the current runtime until there is another runtime upgrade.

Example:

#[test]
fn last_runtime_upgrade_spec_version_usage() {
	#[allow(dead_code)]
	struct Migration;

	impl OnRuntimeUpgrade for Migration {
		fn on_runtime_upgrade() -> Weight {
			// Ensure to compare the spec version against some static version to prevent applying
			// the same migration multiple times.
			//
			// `1337` here is the spec version of the runtime running on chain. If there is maybe
			// a runtime upgrade in the pipeline of being applied, you should use the spec version
			// of this upgrade.
			if System::last_runtime_upgrade_spec_version() > 1337 {
				return Weight::zero()
			}

			// Do the migration.
			Weight::zero()
		}
	}
}

pub fn account_exists(who: &T::AccountId) -> bool

Returns true if the given account exists.

pub fn update_code_in_storage(code: &[u8])

Write code to the storage and emit related events and digest items.

Note this function almost never should be used directly. It is exposed for OnSetCode implementations that defer actual code being written to the storage (for instance in case of parachains).

pub fn inherents_applied() -> bool

Whether all inherents have been applied.

pub fn note_inherents_applied()

Note that all inherents have been applied.

Should be called immediately after all inherents have been applied. Must be called at least once per block.

pub fn inc_ref(who: &T::AccountId)

👎Deprecated: Use inc_consumers instead

Increment the reference counter on an account.

pub fn dec_ref(who: &T::AccountId)

👎Deprecated: Use dec_consumers instead

Decrement the reference counter on an account. This MUST only be done once for every time you called inc_consumers on who.

pub fn refs(who: &T::AccountId) -> RefCount

👎Deprecated: Use consumers instead

The number of outstanding references for the account who.

pub fn allow_death(who: &T::AccountId) -> bool

👎Deprecated: Use !is_provider_required instead

True if the account has no outstanding references.

pub fn inc_providers(who: &T::AccountId) -> IncRefStatus

Increment the provider reference counter on an account.

pub fn dec_providers(who: &T::AccountId) -> Result<DecRefStatus, DispatchError>

Decrement the provider reference counter on an account.

This MUST only be done once for every time you called inc_providers on who.

pub fn inc_sufficients(who: &T::AccountId) -> IncRefStatus

Increment the self-sufficient reference counter on an account.

pub fn dec_sufficients(who: &T::AccountId) -> DecRefStatus

Decrement the sufficients reference counter on an account.

This MUST only be done once for every time you called inc_sufficients on who.

pub fn providers(who: &T::AccountId) -> RefCount

The number of outstanding provider references for the account who.

pub fn sufficients(who: &T::AccountId) -> RefCount

The number of outstanding sufficient references for the account who.

pub fn reference_count(who: &T::AccountId) -> RefCount

The number of outstanding provider and sufficient references for the account who.

pub fn inc_consumers(who: &T::AccountId) -> Result<(), DispatchError>

Increment the reference counter on an account.

The account who’s providers must be non-zero and the current number of consumers must be less than MaxConsumers::max_consumers() or this will return an error.

pub fn inc_consumers_without_limit( who: &T::AccountId, ) -> Result<(), DispatchError>

Increment the reference counter on an account, ignoring the MaxConsumers limits.

The account who’s providers must be non-zero or this will return an error.

pub fn dec_consumers(who: &T::AccountId)

Decrement the reference counter on an account. This MUST only be done once for every time you called inc_consumers on who.

pub fn consumers(who: &T::AccountId) -> RefCount

The number of outstanding references for the account who.

pub fn is_provider_required(who: &T::AccountId) -> bool

True if the account has some outstanding consumer references.

pub fn can_dec_provider(who: &T::AccountId) -> bool

True if the account has no outstanding consumer references or more than one provider.

pub fn can_accrue_consumers(who: &T::AccountId, amount: u32) -> bool

True if the account has at least one provider reference and adding amount consumer references would not take it above the the maximum.

pub fn can_inc_consumer(who: &T::AccountId) -> bool

True if the account has at least one provider reference and fewer consumer references than the maximum.

pub fn deposit_event(event: impl Into<T::RuntimeEvent>)

Deposits an event into this block’s event record.

NOTE: Events not registered at the genesis block and quietly omitted.

pub fn deposit_event_indexed(topics: &[T::Hash], event: T::RuntimeEvent)

Deposits an event into this block’s event record adding this event to the corresponding topic indexes.

This will update storage entries that correspond to the specified topics. It is expected that light-clients could subscribe to this topics.

NOTE: Events not registered at the genesis block and quietly omitted.

pub fn extrinsic_index() -> Option<u32>

Gets the index of extrinsic that is currently executing.

pub fn extrinsic_count() -> u32

Gets extrinsics count.

pub fn all_extrinsics_len() -> u32

pub fn register_extra_weight_unchecked(weight: Weight, class: DispatchClass)

Inform the system pallet of some additional weight that should be accounted for, in the current block.

NOTE: use with extra care; this function is made public only be used for certain pallets that need it. A runtime that does not have dynamic calls should never need this and should stick to static weights. A typical use case for this is inner calls or smart contract calls. Furthermore, it only makes sense to use this when it is presumably cheap to provide the argument weight; In other words, if this function is to be used to account for some unknown, user provided call’s weight, it would only make sense to use it if you are sure you can rapidly compute the weight of the inner call.

Even more dangerous is to note that this function does NOT take any action, if the new sum of block weight is more than the block weight limit. This is what the unchecked.

Another potential use-case could be for the on_initialize and on_finalize hooks.

pub fn initialize( number: &BlockNumberFor<T>, parent_hash: &T::Hash, digest: &Digest, )

Start the execution of a particular block.

pub fn finalize() -> HeaderFor<T>

Remove temporary “environment” entries in storage, compute the storage root and return the resulting header for this block.

pub fn deposit_log(item: DigestItem)

Deposits a log and ensures it matches the block’s log data.

pub fn externalities() -> TestExternalities

Get the basic externalities for this pallet, useful for tests.

pub fn events() -> Vec<EventRecord<T::RuntimeEvent, T::Hash>>

Get the current events deposited by the runtime.

NOTE: This should only be used in tests. Reading events from the runtime can have a large impact on the PoV size of a block. Users should use alternative and well bounded storage items for any behavior like this.

NOTE: Events not registered at the genesis block and quietly omitted.

pub fn event_no_consensus(index: usize) -> Option<T::RuntimeEvent>

Get a single event at specified index.

Should only be called if you know what you are doing and outside of the runtime block execution else it can have a large impact on the PoV size of a block.

pub fn read_events_no_consensus() -> impl Iterator<Item = Box<EventRecord<T::RuntimeEvent, T::Hash>>>

Get the current events deposited by the runtime.

Should only be called if you know what you are doing and outside of the runtime block execution else it can have a large impact on the PoV size of a block.

pub fn read_events_for_pallet<E>() -> Vec<E>

where T::RuntimeEvent: TryInto<E>,

Read and return the events of a specific pallet, as denoted by E.

This is useful for a pallet that wishes to read only the events it has deposited into frame_system using the standard fn deposit_event.

pub fn set_block_number(n: BlockNumberFor<T>)

Set the block number to something in particular. Can be used as an alternative to initialize for tests that don’t need to bother with the other environment entries.

pub fn set_extrinsic_index(extrinsic_index: u32)

Sets the index of extrinsic that is currently executing.

pub fn set_parent_hash(n: T::Hash)

Set the parent hash number to something in particular. Can be used as an alternative to initialize for tests that don’t need to bother with the other environment entries.

pub fn set_block_consumed_resources(weight: Weight, len: usize)

Set the current block weight. This should only be used in some integration tests.

pub fn reset_events()

Reset events.

This needs to be used in prior calling initialize for each new block to clear events from previous block.

pub fn assert_has_event(event: T::RuntimeEvent)

Assert the given event exists.

NOTE: Events not registered at the genesis block and quietly omitted.

pub fn assert_last_event(event: T::RuntimeEvent)

Assert the last event equal to the given event.

NOTE: Events not registered at the genesis block and quietly omitted.

pub fn runtime_version() -> RuntimeVersion

Return the chain’s current runtime version.

pub fn account_nonce(who: impl EncodeLike<T::AccountId>) -> T::Nonce

Retrieve the account transaction counter from storage.

pub fn inc_account_nonce(who: impl EncodeLike<T::AccountId>)

Increment a particular account’s nonce by 1.

pub fn note_extrinsic(encoded_xt: Vec<u8>)

Note what the extrinsic data of the current extrinsic index is.

This is required to be called before applying an extrinsic. The data will used in Self::finalize to calculate the correct extrinsics root.

pub fn note_applied_extrinsic( r: &DispatchResultWithPostInfo, info: DispatchInfo, )

To be called immediately after an extrinsic has been applied.

Emits an ExtrinsicSuccess or ExtrinsicFailed event depending on the outcome. The emitted event contains the post-dispatch corrected weight including the base-weight for its dispatch class.

pub fn note_finished_extrinsics()

To be called immediately after note_applied_extrinsic of the last extrinsic of the block has been called.

pub fn note_finished_initialize()

To be called immediately after finishing the initialization of the block (e.g., called on_initialize for all pallets).

pub fn on_created_account( who: T::AccountId, _a: &mut AccountInfo<T::Nonce, T::AccountData>, )

An account is being created.

pub fn can_set_code(code: &[u8]) -> Result<(), DispatchError>

Determine whether or not it is possible to update the code.

Checks the given code if it is a valid runtime wasm blob by instantiating it and extracting the runtime version of it. It checks that the runtime version of the old and new runtime has the same spec name and that the spec version is increasing.

pub fn do_authorize_upgrade(code_hash: T::Hash, check_version: bool)

To be called after any origin/privilege checks. Put the code upgrade authorization into storage and emit an event. Infallible.

pub fn do_apply_authorize_upgrade( code: Vec<u8>, ) -> Result<PostDispatchInfo, DispatchError>

Apply an authorized upgrade, performing any validation checks, and remove the authorization. Whether or not the code is set directly depends on the OnSetCode configuration of the runtime.

pub fn validate_authorized_upgrade( code: &[u8], ) -> Result<T::Hash, DispatchError>

Check that provided code can be upgraded to. Namely, check that its hash matches an existing authorization and that it meets the specification requirements of can_set_code.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

Type of BlockNumber to provide.

fn current_block_number() -> Self::BlockNumber

Returns the current block number.

fn set_block_number(n: BlockNumberFor<T>)

Utility function only to be used in benchmarking scenarios or tests, to be implemented optionally, else a noop.

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> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

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

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_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end 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_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

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

Execute the sanity checks of this pallet, per block.

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

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> 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 blockchain execution.

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

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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 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> StoredMap<<T as Config>::AccountId, <T as Config>::AccountData> for Pallet<T>

Implement StoredMap for a simple single-item, provide-when-not-default system. This works fine for storing a single item which allows the account to continue existing as long as it’s not empty/default.

Anything more complex will need more sophisticated logic.

fn get(k: &T::AccountId) -> T::AccountData

Get the item, or its default if it doesn’t yet exist; we make no distinction between the two.

fn try_mutate_exists<R, E: From<DispatchError>>( k: &T::AccountId, f: impl FnOnce(&mut Option<T::AccountData>) -> Result<R, E>, ) -> Result<R, E>

Maybe mutate the item only if an Ok value is returned from f. Do nothing if an Err is returned. It is removed or reset to default value if it has been mutated to None. f will always be called with an option representing if the storage item exists (Some<V>) or if the storage item does not exist (None), independent of the QueryType.

fn mutate<R>(k: &K, f: impl FnOnce(&mut T) -> R) -> Result<R, DispatchError>

Mutate the item.

fn mutate_exists<R>( k: &K, f: impl FnOnce(&mut Option<T>) -> R, ) -> Result<R, DispatchError>

Mutate the item, removing or resetting to default value if it has been mutated to None.

fn insert(k: &K, t: T) -> Result<(), DispatchError>

Set the item to something new.

fn remove(k: &K) -> Result<(), DispatchError>

Remove the item or otherwise replace it with its default value; we don’t care which.

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

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> ValidateUnsigned for Pallet<T>

type Call = Call<T>

The call to validate

fn validate_unsigned( _source: TransactionSource, call: &Self::Call, ) -> TransactionValidity

Return the validity of the call

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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>