Module pallet_proof_of_stake::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

  • Pallet
    The Pallet struct, the main type that implements traits and standalone functions within the pallet.
  • PromotedPools
    Information about single token rewards

Enums

  • Call
    Contains a variant per dispatchable extrinsic that this pallet has.
  • Error
    Errors
  • Event
    The Event enum of this pallet

Traits

Type Definitions

  • ActivatedLiquidityForSchedules
    Tracks how much liquidity user activated for particular (liq token, reward token) pair StorageNMap was used because it only require single read to know if user deactivated all liquidity associated with particular liquidity_token that is rewarded. If so part of the liquididty tokens can be unlocked.
  • ActivatedLockedLiquidityForSchedules
    Tracks how much of the liquidity was activated for schedule rewards and not yet liquidity mining rewards. That information is essential to properly handle token unlcocks when liquidity is deactivated.
  • ActivatedNativeRewardsLiq
    Tracks how much of the liquidity was activated for schedule rewards and not yet liquidity mining rewards. That information is essential to properly handle token unlcocks when liquidity is deactivated.
  • ModuleDeprecated
    Type alias to Pallet, to be used by construct_runtime.
  • PromotedPoolRewards
    Stores information about pool weight and accumulated rewards. The accumulated rewards amount is the number of rewards that can be claimed per liquidity token. Here is tracked the number of rewards per liquidity token relationship. Expect larger values when the number of liquidity tokens are smaller.
  • RewardTokensPerPool
    Maps liquidity token to list of tokens that it ever was rewarded with
  • RewardsInfo
    Storage type is StorageDoubleMap with key1 type AccountIdOf < T >, key2 type CurrencyIdOf < T > and value type RewardInfo < BalanceOf < T > >.
  • RewardsInfoForScheduleRewards
    Stores information about pool weight and accumulated rewards
  • RewardsSchedules
    List of activated schedules sorted by expiry date
  • RewardsSchedulesList
    Storage type is StorageMap with key type ScheduleId and value type (Schedule < T >, Option < ScheduleId >).
  • ScheduleRewardsPerLiquidity
    Storage type is StorageMap with key type (CurrencyIdOf < T >, CurrencyIdOf < T >) and value type (U256, u64).
  • ScheduleRewardsTotal
    How much scheduled rewards per single liquidty_token should be distribute_rewards the value is multiplied by u128::MAX to avoid floating point arithmetic
  • SchedulesListMetadata
    Storage type is StorageValue with value type SchedulesList.
  • TotalActivatedLiquidity
    Storage type is StorageMap with key type CurrencyIdOf < T > and value type BalanceOf < T >.
  • TotalActivatedLiquidityForSchedules
    Tracks number of activated liquidity per schedule. It is used for calculation of “cumulative rewrds amount” per 1 liquidity token. Therefore activation/deactivation needs to be deffered same way as schedule rewards are delayed.