Module pallet

Source
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 the Call enum.
  • 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 and Error, 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§

EpochLengthDefault
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
FreezeReason
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§

CapacityLedger
Storage for target Capacity usage.
CurrentEpoch
Storage for the current epoch number
CurrentEpochInfo
Storage for the current epoch info
CurrentEraInfo
Information about the current reward era. Checked every block.
CurrentEraProviderBoostTotal
How much is staked this era
EpochLength
Storage for the epoch length
ModuleDeprecated
Type alias to Pallet, to be used by construct_runtime.
ProviderBoostHistories
Individual history for each account that has Provider-Boosted.
ProviderBoostRewardPools
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.
StakingAccountLedger
Storage for keeping a ledger of staked token amounts for accounts.
StakingTargetLedger
Storage to record how many tokens were targeted to an MSA.
UnstakeUnlocks
Storage type is [StorageMap] with key type T :: AccountId and value type UnlockChunkList < T >.