Module parachain_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.

Re-exports

• pub use super::*;

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

• AggregatorMetadataType
• Bond
• CandidateBondRequest
  Request scheduled to change the collator candidate self-bond
• CollatorCandidate
  Collator candidate state with self bond + delegations
• CollatorSnapshot
  Snapshot of collator state at the start of the round for which they are selected
• DelegationRequest
• Delegator
  Delegator state
• GenesisConfig
  Can be used to configure the genesis state of this pallet.
• Pallet
  Pallet for parachain staking
• PendingDelegationRequests
  Pending requests to mutate delegations for each delegator
• RoundCollatorRewardInfoType
• RoundInfo
  The current round index and transition information

Enums

• Call
  Contains a variant per dispatchable extrinsic that this pallet has.
• CandidateBondChange
  Changes allowed by an active collator candidate to their self bond
• CollatorStatus
  The activity status of the collator
• DelegationChange
  Changes requested by the delegator
• DelegatorAdded
  Convey relevant information describing if a delegator was added to the top or bottom Delegations added to the top yield a new total
• DelegatorStatus
• Error
  The Error enum of this pallet.
• Event
  The Event enum of this pallet
• PairedOrLiquidityToken

Traits

• Config
  Configuration trait of this pallet.
• StakingBenchmarkConfig

Type Definitions

• AggregatorMetadata
  Stores information about approved candidates for aggregation
• AtStake
  Snapshot of collator delegation stake at the start of the round
• AwardedPts
  Points for each collator per round
• BalanceOf
• CandidateAggregator
  Maps collator to its aggregator
• CurrencyIdOf
• ModuleDeprecated
  Type alias to Pallet, to be used by construct_runtime.
• Points
  Total points awarded to collators for block production in the round
• RoundAggregatorInfo
  Stored once per session, maps aggregator to list of assosiated candidates
• RoundCollatorRewardInfo
  Stores information about rewards per each session
• StakingLiquidityTokens
  Storage type is StorageValue with value type BTreeMap < CurrencyIdOf < T >, Option < (BalanceOf < T >, BalanceOf < T >) > >.