Expand description
The pallet
module in each FRAME pallet hosts the most important items needed
to construct this pallet.
The main components of this pallet are:
Pallet
, which implements all of the dispatchable extrinsics of the pallet, among other public functions.- The subset of the functions that are dispatchable can be identified either in the
dispatchables
module or in theCall
enum.
- The subset of the functions that are dispatchable can be identified either in the
storage_types
, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.Config
, which contains the configuration trait of this pallet.Event
andError
, which are listed among the Enums.
Modules§
- dispatchables
- Auto-generated docs-only module listing all defined dispatchables for this pallet.
- storage_
types - Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.
Structs§
- Epoch
Length Default - EpochLength defaults to 100 blocks when not set
- Pallet
- The
Pallet
struct, the main type that implements traits and standalone functions within the pallet.
Enums§
- Call
- Contains a variant per dispatchable extrinsic that this pallet has.
- Error
- The
Error
enum of this pallet. - Event
- The
Event
enum of this pallet - Freeze
Reason - A reason for freezing funds.
Creates a freeze reason for this pallet that is aggregated by
construct_runtime
.
Constants§
- STORAGE_
VERSION - the storage version for this pallet
Traits§
- Config
- Configuration trait of this pallet.
Functions§
- __
type_ value_ for_ epoch_ length_ default - EpochLength defaults to 100 blocks when not set
Type Aliases§
- Capacity
Ledger - Storage for target Capacity usage.
- Current
Epoch - Storage for the current epoch number
- Current
Epoch Info - Storage for the current epoch info
- Current
EraInfo - Information about the current reward era. Checked every block.
- Current
EraProvider Boost Total - How much is staked this era
- Epoch
Length - Storage for the epoch length
- Module
Deprecated - Type alias to
Pallet
, to be used byconstruct_runtime
. - Provider
Boost Histories - Individual history for each account that has Provider-Boosted.
- Provider
Boost Reward Pools - Reward Pool history is divided into chunks of size RewardPoolChunkLength. ProviderBoostHistoryLimit is the total number of items, the key is the chunk number.
- Retargets
- stores how many times an account has retargeted, and when it last retargeted.
- Staking
Account Ledger - Storage for keeping a ledger of staked token amounts for accounts.
- Staking
Target Ledger - Storage to record how many tokens were targeted to an MSA.
- Unstake
Unlocks - Storage type is [
StorageMap
] with key typeT :: AccountId
and value typeUnlockChunkList < T >
.