Module staking::pallet

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

• 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

Traits

• Config
  Configuration trait of this pallet.

Type Definitions

• ModuleDeprecated
  Type alias to Pallet, to be used by construct_runtime.
• Nonce
  The nonce of the current staking pool, used in force refunds. This is a strictly increasing value.
• RewardPerToken
  Used to compute the rewards for a participant’s stake.
• RewardTally
  Accounts for previous changes in stake size.
• SlashPerToken
  Used to compute the amount to slash from a participant’s stake.
• SlashTally
  Accounts for previous changes in stake size.
• Stake
  The stake of a participant in this reward pool.
• TotalCurrentStake
  The total stake - this will increase on deposit and decrease on withdrawal or slashing.
• TotalRewards
  The total unclaimed rewards distributed to this reward pool. NOTE: this is currently only used for integration tests.
• TotalStake
  The total stake - this will increase on deposit and decrease on withdrawal.