Crate frame_system
source · [−]Expand description
System Pallet
The System pallet provides low-level access to core types and cross-cutting utilities. It acts as the base layer for other pallets to interact with the Substrate framework components.
Overview
The System pallet defines the core data types used in a Substrate runtime.
It also provides several utility functions (see Pallet) for other FRAME pallets.
In addition, it manages the storage items for extrinsics data, indexes, event records, and digest items, among other things that support the execution of the current block.
It also handles low-level tasks like depositing logs, basic set up and take down of temporary storage entries, and access to previous block hashes.
Interface
Dispatchable Functions
The System pallet does not implement any dispatchable functions.
Public Functions
See the Pallet struct for details of publicly available functions.
Signed Extensions
The System pallet defines the following extensions:
CheckWeight: Checks the weight and length of the block and ensure that it does not exceed the limits.CheckNonce: Checks the nonce of the transaction. Contains a single payload of typeT::Index.CheckEra: Checks the era of the transaction. Contains a single payload of typeEra.CheckGenesis: Checks the provided genesis hash of the transaction. Must be a part of the signed payload of the transaction.CheckSpecVersion: Checks that the runtime version is the same as the one used to sign the transaction.CheckTxVersion: Checks that the transaction version is the same as the one used to sign the transaction.
Lookup the runtime aggregator file (e.g. node/runtime) to see the full list of signed
extensions included in a chain.
Re-exports
pub use weights::WeightInfo;pub use pallet::*;Modules
Block resource limits configuration structures.
Provide types to help defining a mock environment when testing pallets.
Module helpers for off-chain calls.
Prelude to be used alongside pallet macro, for ease of use.
Autogenerated weights for frame_system
Structs
Information of an account.
Check for transaction mortality.
Genesis hash check to provide replay protection between different networks.
Check for transaction mortality.
Nonce check and increment to give replay protection for transactions.
Ensure the runtime version registered in the transaction is the same as at present.
Ensure the transaction version registered in the transaction is the same as at present.
Block resource (weight) limit check.
Event handler which registers a consumer when created.
The “OR gate” implementation of EnsureOrigin.
Record of an event happening.
Stores the spec_version and spec_name of when the last runtime upgrade
happened.
Event handler which registers a provider when created.
Event handler which registers a self-sufficient when created.
Enums
Some resultant status relevant to decrementing a provider/self-sufficient reference.
Some resultant status relevant to incrementing a provider/self-sufficient reference.
A type of block initialization to perform.
A phase of a block’s execution.
Origin for the System pallet.
Reference status; can be either referenced or unreferenced.
Traits
Do something when we should be setting the code.
Functions
Ensure that the origin o represents an unsigned extrinsic. Returns Ok or an Err otherwise.
Ensure that the origin o represents the root. Returns Ok or an Err otherwise.
Ensure that the origin o represents a signed extrinsic (i.e. transaction).
Returns Ok with the account that signed the extrinsic or an Err otherwise.
Compute the trie root of a list of extrinsics.
Compute the trie root of a list of extrinsics.
Split an option into two constituent options, as defined by a splitter function.
Type Definitions
An object to track the currently used extrinsic weight in a block.
Type used to encode the number of references an account has.