Struct darwinia_staking::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn account_id() -> AccountId<T>

pub fn bond_ring(
    stash: &AccountId<T>,
    controller: &AccountId<T>,
    value: RingBalance<T>,
    promise_month: u8,
    ledger: StakingLedgerT<T>
) -> Result<(TsInMs, TsInMs), DispatchError>

Update the ledger while bonding ring and compute the KTON reward

pub fn bond_kton(
    controller: &AccountId<T>,
    value: KtonBalance<T>,
    ledger: StakingLedgerT<T>
) -> DispatchResult

Update the ledger while bonding controller with KTON

pub fn clear_mature_deposits(
    ledger: StakingLedgerT<T>
) -> (StakingLedgerT<T>, bool)

Turn the expired deposit items into normal bond

pub fn currency_to_power<S: TryInto<Balance>>(active: S, pool: S) -> Power

pub fn power_of(stash: &AccountId<T>) -> Power

The total power that can be slashed from a stash account as of right now.

pub fn stake_of(who: &AccountId<T>) -> (RingBalance<T>, KtonBalance<T>)

pub fn weight_of_fn() -> Box<dyn Fn(&T::AccountId) -> VoteWeight>

pub fn weight_of(who: &AccountId<T>) -> VoteWeight

pub fn do_payout_stakers(
    validator_stash: AccountId<T>,
    era: EraIndex
) -> DispatchResultWithPostInfo

pub fn update_ledger(controller: &AccountId<T>, ledger: &StakingLedgerT<T>)

Update the ledger for a controller.

BE CAREFUL: This will also update the stash lock. DO NOT modify the locks’ staking amount outside this function.

pub fn update_staking_pool(
    active: RingBalance<T>,
    origin_active: RingBalance<T>,
    active_kton: KtonBalance<T>,
    origin_active_kton: KtonBalance<T>
)

Update the staking pool, once any account change its bond.

pub fn chill_stash(stash: &AccountId<T>)

Chill a stash account.

pub fn make_payout(
    stash: &AccountId<T>,
    amount: RingBalance<T>
) -> Option<RingPositiveImbalance<T>>

Actually make a payment to a staker. This uses the currency’s reward function to pay the right payee for the given staker account.

pub fn new_session(
    session_index: SessionIndex,
    is_genesis: bool
) -> Option<Vec<AccountId<T>>>

Plan a new session potentially trigger a new era.

pub fn start_session(start_session: SessionIndex)

Start a session potentially starting an era.

pub fn end_session(session_index: SessionIndex)

End a session potentially ending an era.

pub fn start_era(start_session: SessionIndex)

• Increment active_era.index,
• reset active_era.start,
• update BondedEras and apply slashes.

pub fn end_era(active_era: ActiveEraInfo, _session_index: SessionIndex)

Compute payout for era.

pub fn trigger_new_era(
    start_session_index: SessionIndex,
    exposures: Vec<(AccountId<T>, ExposureT<T>)>
) -> Vec<AccountId<T>>

Plan a new era.

• Bump the current era storage (which holds the latest planned era).
• Store start session index for the new planned era.
• Clean old era information.
• Store staking information for the new planned era

Returns the new validator set.

pub fn store_stakers_info(
    exposures: Vec<(AccountId<T>, ExposureT<T>)>,
    new_planned_era: EraIndex
) -> Vec<AccountId<T>>

Process the output of the election.

Store staking information for the new planned era

pub fn collect_exposures(
    supports: Supports<AccountId<T>>
) -> Vec<(AccountId<T>, ExposureT<T>)>

Consume a set of [Supports] from [sp_npos_elections] and collect them into a Exposure.

pub fn kill_stash(
    stash: &AccountId<T>,
    num_slashing_spans: u32
) -> DispatchResult

Remove all associated data of a stash account from the staking system.

Assumes storage is upgraded before calling.

This is called:

• after a withdraw_unbond() call that frees all of a stash’s bonded balance.
• through reap_stash() if the balance has fallen to zero (through slashing).

pub fn clear_era_information(era_index: EraIndex)

Clear all era information for given era.

pub fn apply_unapplied_slashes(active_era: EraIndex)

Apply previously-unapplied slashes on the beginning of a new era, after a delay.

pub fn reward_by_ids(
    validators_points: impl IntoIterator<Item = (AccountId<T>, u32)>
)

Add reward points to validators using their stash account ID.

Validators are keyed by stash account ID and must be in the current elected set.

For each element in the iterator the given number of points in u32 is added to the validator, thus duplicates are handled.

At the end of the era each the total payout will be distributed among validator relatively to their points.

COMPLEXITY: Complexity is number_of_validator_to_reward x current_elected_len. If you need to reward lots of validator consider using reward_by_indices.

pub fn ensure_new_era()

Ensures that at the end of the current session there will be a new era.

pub fn get_npos_voters(
    maybe_max_len: Option<usize>
) -> Vec<(AccountId<T>, VoteWeight, Vec<AccountId<T>>)>

Get all of the voters that are eligible for the npos election.

maybe_max_len can imposes a cap on the number of voters returned; First all the validator are included in no particular order, then remainder is taken from the nominators, as returned by Config::SortedListProvider.

This will use nominators, and all the validators will inject a self vote.

This function is self-weighing as [DispatchClass::Mandatory].

Slashing

All nominations that have been submitted before the last non-zero slash of the validator are auto-chilled, but still count towards the limit imposed by maybe_max_len.

pub fn get_npos_targets() -> Vec<AccountId<T>>

Get the targets for an upcoming npos election.

This function is self-weighing as [DispatchClass::Mandatory].

pub fn do_add_nominator(
    who: &T::AccountId,
    nominations: Nominations<T::AccountId>
)

This function will add a nominator to the Nominators storage map, and [SortedListProvider].

If the nominator already exists, their nominations will be updated.

NOTE: you must ALWAYS use this function to add nominator or update their targets. Any access to Nominators or VoterList outside of this function is almost certainly wrong.

pub fn do_remove_nominator(who: &T::AccountId) -> bool

This function will remove a nominator from the Nominators storage map, and [SortedListProvider].

Returns true if who was removed from Nominators, otherwise false.

NOTE: you must ALWAYS use this function to remove a nominator from the system. Any access to Nominators or VoterList outside of this function is almost certainly wrong.

pub fn do_add_validator(who: &T::AccountId, prefs: ValidatorPrefs)

This function will add a validator to the Validators storage map.

If the validator already exists, their preferences will be updated.

NOTE: you must ALWAYS use this function to add a validator to the system. Any access to Validators or VoterList outside of this function is almost certainly wrong.

pub fn do_remove_validator(who: &T::AccountId) -> bool

This function will remove a validator from the Validators storage map.

Returns true if who was removed from Validators, otherwise false.

NOTE: you must ALWAYS use this function to remove a validator from the system. Any access to Validators or VoterList outside of this function is almost certainly wrong.

impl<T: Config> Pallet<T>

pub fn bond(
    origin: OriginFor<T>,
    controller: <T::Lookup as StaticLookup>::Source,
    value: StakingBalanceT<T>,
    payee: RewardDestination<AccountId<T>>,
    promise_month: u8
) -> DispatchResult

Take the origin account as a stash and lock up value of its balance. controller will be the account that controls it.

value must be more than the minimum_balance specified by T::Currency.

The dispatch origin for this call must be Signed by the stash account.

Emits Bonded.

• Independent of the arguments. Moderate complexity.
• O(1).
• Three extra DB entries.

NOTE: Two of the storage writes (Self::bonded, Self::payee) are never cleaned unless the origin falls below existential deposit and gets removed as dust.

pub fn bond_extra(
    origin: OriginFor<T>,
    max_additional: StakingBalanceT<T>,
    promise_month: u8
) -> DispatchResult

Add some extra amount that have appeared in the stash free_balance into the balance up for staking.

The dispatch origin for this call must be Signed by the stash, not the controller.

Use this if there are additional funds in your stash account that you wish to bond. Unlike bond or unbond this function does not impose any limitation on the amount that can be added.

Emits Bonded.

• Independent of the arguments. Insignificant complexity.
• O(1).

pub fn deposit_extra(
    origin: OriginFor<T>,
    value: RingBalance<T>,
    promise_month: u8
) -> DispatchResult

Deposit some extra amount ring, and return kton to the controller.

The dispatch origin for this call must be Signed by the stash, not the controller.

Is a no-op if value to be deposited is zero.

• Independent of the arguments. Insignificant complexity.
• O(1).
• One DB entry.

---

DB Weight:

• Read: Era Election Status, Bonded, Ledger, [Origin Account]
• Write: [Origin Account], Ledger

pub fn unbond(origin: OriginFor<T>, value: StakingBalanceT<T>) -> DispatchResult

Schedule a portion of the stash to be unlocked ready for transfer out after the bond period ends. If this leaves an amount actively bonded less than T::Currency::minimum_balance(), then it is increased to the full amount.

The dispatch origin for this call must be Signed by the controller, not the stash.

Once the unlock period is done, the funds will be withdrew automatically and ready for transfer.

No more than a limited number of unlocking chunks (see MAX_UNLOCKING_CHUNKS) can co-exists at the same time. In that case, [StakingLock::shrink] need to be called first to remove some of the chunks (if possible).

If a user encounters the InsufficientBond error when calling this extrinsic, they should call chill first in order to free up their bonded funds.

After all pledged Ring and Kton are unbonded, the bonded accounts, namely stash and controller, will also be unbonded. Once user want to bond again, the bond method should be called. If there are still pledged Ring or Kton and user want to bond more values, the bond_extra method should be called.

pub fn withdraw_unbonded(
    origin: OriginFor<T>,
    num_slashing_spans: u32
) -> DispatchResultWithPostInfo

Remove any unlocked chunks from the unlocking queue from our management.

This essentially frees up that balance to be used by the stash account to do whatever it wants.

The dispatch origin for this call must be Signed by the controller.

Emits Withdrawn.

See also Call::unbond.

Complexity O(S) where S is the number of slashing spans to remove NOTE: Weight annotation is the kill scenario, we refund otherwise.

pub fn claim_mature_deposits(origin: OriginFor<T>) -> DispatchResult

Stash accounts can get their ring back after the depositing time exceeded, and the ring getting back is still in staking status.

• Independent of the arguments. Insignificant complexity.
• One storage read.
• One storage write.
• Writes are limited to the origin account key.

---

DB Weight:

• Read: Ledger, [Origin Account]
• Write: [Origin Account], Ledger

pub fn try_claim_deposits_with_punish(
    origin: OriginFor<T>,
    expire_time: TsInMs
) -> DispatchResult

Claim deposits while the depositing time has not been exceeded, the ring will not be slashed, but the account is required to pay KTON as punish.

Refer to https://talk.darwinia.network/topics/55

Assume the expire_time is a unique ID for the deposit

• Independent of the arguments. Insignificant complexity.
• One storage read.
• One storage write.
• Writes are limited to the origin account key.

---

DB Weight:

• Read: Ledger, Locks, [Origin Account]
• Write: [Origin Account], Locks, Ledger

pub fn validate(origin: OriginFor<T>, prefs: ValidatorPrefs) -> DispatchResult

Declare the desire to validate for the origin controller.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

pub fn nominate(
    origin: OriginFor<T>,
    targets: Vec<<T::Lookup as StaticLookup>::Source>
) -> DispatchResult

Declare the desire to nominate targets for the origin controller.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

• The transaction’s complexity is proportional to the size of targets (N) which is capped at CompactAssignments::LIMIT (MAX_NOMINATIONS).
• Both the reads and writes follow a similar pattern.

pub fn chill(origin: OriginFor<T>) -> DispatchResult

Declare no desire to either validate or nominate.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

• Independent of the arguments. Insignificant complexity.
• Contains one read.
• Writes are limited to the origin account key.

pub fn set_payee(
    origin: OriginFor<T>,
    payee: RewardDestination<AccountId<T>>
) -> DispatchResult

(Re-)set the payment target for a controller.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

• Independent of the arguments. Insignificant complexity.
• Contains a limited number of reads.
• Writes are limited to the origin account key.

---

• Weight: O(1)
• DB Weight:
  • Read: Ledger
  • Write: Payee

pub fn set_controller(
    origin: OriginFor<T>,
    controller: <T::Lookup as StaticLookup>::Source
) -> DispatchResult

(Re-)set the controller of a stash.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the stash, not the controller.

• Independent of the arguments. Insignificant complexity.
• Contains a limited number of reads.
• Writes are limited to the origin account key.

---

Weight: O(1) DB Weight:

• Read: Bonded, Ledger New Controller, Ledger Old Controller
• Write: Bonded, Ledger New Controller, Ledger Old Controller

pub fn set_validator_count(origin: OriginFor<T>, new: u32) -> DispatchResult

Sets the ideal number of validators.

The dispatch origin must be Root.

Weight: O(1) Write: Validator Count

pub fn increase_validator_count(
    origin: OriginFor<T>,
    additional: u32
) -> DispatchResult

Increments the ideal number of validators.

The dispatch origin must be Root.

Same as Self::set_validator_count.

pub fn scale_validator_count(
    origin: OriginFor<T>,
    factor: Percent
) -> DispatchResult

Scale up the ideal number of validators by a factor.

The dispatch origin must be Root.

Same as Self::set_validator_count.

pub fn force_no_eras(origin: OriginFor<T>) -> DispatchResult

Force there to be no new eras indefinitely.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. Thus the election process may be ongoing when this is called. In this case the election will continue until the next era is triggered.

• No arguments.
• Weight: O(1)
• Write: ForceEra

pub fn force_new_era(origin: OriginFor<T>) -> DispatchResult

Force there to be a new era at the end of the next session. After this, it will be reset to normal (non-forced) behaviour.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

• No arguments.
• Weight: O(1)
• Write ForceEra

pub fn set_invulnerables(
    origin: OriginFor<T>,
    invulnerables: Vec<AccountId<T>>
) -> DispatchResult

Set the validators who cannot be slashed (if any).

The dispatch origin must be Root.

• O(V)
• Write: Invulnerables

pub fn force_unstake(
    origin: OriginFor<T>,
    stash: AccountId<T>,
    num_slashing_spans: u32
) -> DispatchResult

Force a current staker to become completely unstaked, immediately.

The dispatch origin must be Root.

O(S) where S is the number of slashing spans to be removed Reads: Bonded, Slashing Spans, Account, Locks Writes: Bonded, Slashing Spans (if S > 0), Ledger, Payee, Validators, Nominators, Account, Locks Writes Each: SpanSlash * S

pub fn force_new_era_always(origin: OriginFor<T>) -> DispatchResult

Force there to be a new era at the end of sessions indefinitely.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

• Weight: O(1)
• Write: ForceEra

pub fn cancel_deferred_slash(
    origin: OriginFor<T>,
    era: EraIndex,
    slash_indices: Vec<u32>
) -> DispatchResult

Cancel enactment of a deferred slash.

Can be called by the T::SlashCancelOrigin.

Parameters: era and indices of the slashes for that era to kill.

Complexity: O(U + S) with U unapplied slashes weighted with U=1000 and S is the number of slash indices to be canceled.

• Read: Unapplied Slashes
• Write: Unapplied Slashes

pub fn payout_stakers(
    origin: OriginFor<T>,
    validator_stash: AccountId<T>,
    era: EraIndex
) -> DispatchResultWithPostInfo

Pay out all the stakers behind a single validator for a single era.

• validator_stash is the stash account of the validator. Their nominators, up to T::MaxNominatorRewardedPerValidator, will also receive their rewards.
• era may be any era between [current_era - history_depth; current_era].

The origin of this call must be Signed. Any account can call this function, even if it is not one of the stakers.

• Time complexity: at most O(MaxNominatorRewardedPerValidator).
• Contains a limited number of reads and writes.

---

N is the Number of payouts for the validator (including the validator) Weight:

• Reward Destination Staked: O(N)

• Reward Destination Controller (Creating): O(N)

  NOTE: weights are assuming that payouts are made to alive stash account (Staked). Paying even a dead controller is cheaper weight-wise. We don’t do any refunds here.

pub fn rebond(
    origin: OriginFor<T>,
    plan_to_rebond_ring: RingBalance<T>,
    plan_to_rebond_kton: KtonBalance<T>
) -> DispatchResultWithPostInfo

Rebond a portion of the stash scheduled to be unlocked.

The dispatch origin must be signed by the controller.

• Time complexity: O(L), where L is unlocking chunks
• Bounded by MAX_UNLOCKING_CHUNKS.
• Storage changes: Can’t increase storage, only decrease it.

pub fn set_history_depth(
    origin: OriginFor<T>,
    new_history_depth: EraIndex,
    _era_items_deleted: u32
) -> DispatchResult

Set HistoryDepth value. This function will delete any history information when HistoryDepth is reduced.

Parameters:

• new_history_depth: The new history depth you would like to set.
• era_items_deleted: The number of items that will be deleted by this dispatch. This should report all the storage items that will be deleted by clearing old era history. Needed to report an accurate weight for the dispatch. Trusted by Root to report an accurate number.

Origin must be root.

• E: Number of history depths removed, i.e. 10 -> 7 = 3
• Weight: O(E)
• DB Weight:
  • Reads: Current Era, History Depth
  • Writes: History Depth
  • Clear Prefix Each: Era Stakers, EraStakersClipped, ErasValidatorPrefs
  • Writes Each: ErasValidatorReward, ErasRewardPoints, ErasTotalStake, ErasStartSessionIndex

pub fn reap_stash(
    origin: OriginFor<T>,
    stash: AccountId<T>,
    num_slashing_spans: u32
) -> DispatchResultWithPostInfo

Remove all data structures concerning a staker/stash once it is at a state where it can be considered dust in the staking system. The requirements are:

1. the total_balance of the stash is below existential deposit.
2. or, the ledger.total of the stash is below existential deposit.

The former can happen in cases like a slash; the latter when a fully unbonded account is still receiving staking rewards in RewardDestination::Staked.

It can be called by anyone, as long as stash meets the above requirements.

Refunds the transaction fees upon successful execution.

pub fn kick(
    origin: OriginFor<T>,
    who: Vec<<T::Lookup as StaticLookup>::Source>
) -> DispatchResult

Remove the given nominations from the calling validator.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

• who: A list of nominator stash accounts who are nominating this validator which should no longer be nominating this validator.

Note: Making this call only makes sense if you first set the validator preferences to block any further nominations.

pub fn set_staking_configs(
    origin: OriginFor<T>,
    min_nominator_bond: RingBalance<T>,
    min_validator_bond: RingBalance<T>,
    max_nominator_count: Option<u32>,
    max_validator_count: Option<u32>,
    chill_threshold: Option<Percent>,
    min_commission: Perbill
) -> DispatchResult

Update the various staking configurations.

• min_nominator_bond: The minimum active bond needed to be a nominator.
• min_validator_bond: The minimum active bond needed to be a validator.
• max_nominator_count: The max number of users who can be a nominator at once. When set to None, no limit is enforced.
• max_validator_count: The max number of users who can be a validator at once. When set to None, no limit is enforced.
• chill_threshold: The ratio of max_nominator_count or max_validator_count which should be filled in order for the chill_other transaction to work.
• min_commission: The minimum amount of commission that each validators must maintain. This is checked only upon calling validate. Existing validators are not affected.

Origin must be Root to call this function.

NOTE: Existing nominators and validators will not be affected by this update. to kick people under the new limits, chill_other should be called.

pub fn chill_other(
    origin: OriginFor<T>,
    controller: T::AccountId
) -> DispatchResult

Declare a controller to stop participating as either a validator or nominator.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed, but can be called by anyone.

If the caller is the same as the controller being targeted, then no further checks are enforced, and this function behaves just like chill.

If the caller is different than the controller being targeted, the following conditions must be met:

• A ChillThreshold must be set and checked which defines how close to the max nominators or validators we must reach before users can start chilling one-another.
• A MaxNominatorCount and MaxValidatorCount must be set which is used to determine how close we are to the threshold.
• A MinNominatorBond and MinValidatorBond must be set and checked, which determines if this is a person that should be chilled because they have not met the threshold bond required.

This can be helpful if bond requirements are updated, and we need to remove old users who do not satisfy these requirements.

impl<T: Config> Pallet<T>

pub fn error_metadata() -> Option<PalletErrorMetadata>

impl<T: Config> Pallet<T>

pub fn history_depth() -> u32

Number of eras to keep in history.

Information is kept for eras in [current_era - history_depth; current_era].

Must be more than the number of eras delayed by session otherwise. I.e. active era must always be in history. I.e. active_era > current_era - history_depth must be guaranteed.

impl<T: Config> Pallet<T>

pub fn validator_count() -> u32

The ideal number of staking participants.

impl<T: Config> Pallet<T>

pub fn minimum_validator_count() -> u32

Minimum number of staking participants before emergency conditions are imposed.

impl<T: Config> Pallet<T>

pub fn invulnerables() -> Vec<AccountId<T>>

Any validators that may never be slashed or forcibly kicked. It’s a Vec since they’re easy to initialize and the performance hit is minimal (we expect no more than four invulnerables) and restricted to testnets.

impl<T: Config> Pallet<T>

pub fn bonded<KArg>(k: KArg) -> Option<AccountId<T>> where
    KArg: EncodeLike<AccountId<T>>, 

Map from all locked “stash” accounts to the controller account.

impl<T: Config> Pallet<T>

pub fn ledger<KArg>(k: KArg) -> Option<StakingLedgerT<T>> where
    KArg: EncodeLike<AccountId<T>>, 

Map from all (unlocked) “controller” accounts to the info regarding the staking.

impl<T: Config> Pallet<T>

pub fn payee<KArg>(k: KArg) -> RewardDestination<AccountId<T>> where
    KArg: EncodeLike<AccountId<T>>, 

Where the reward payment should be made. Keyed by stash.

impl<T: Config> Pallet<T>

pub fn validators<KArg>(k: KArg) -> ValidatorPrefs where
    KArg: EncodeLike<AccountId<T>>, 

The map from (wannabe) validator stash key to the preferences of that validator.

impl<T: Config> Pallet<T>

pub fn nominators<KArg>(k: KArg) -> Option<Nominations<AccountId<T>>> where
    KArg: EncodeLike<AccountId<T>>, 

The map from nominator stash key to the set of stash keys of all validators to nominate.

impl<T: Config> Pallet<T>

pub fn current_era() -> Option<EraIndex>

The current era index.

This is the latest planned era, depending on how the Session pallet queues the validator set, it might be active or not.

impl<T: Config> Pallet<T>

pub fn active_era() -> Option<ActiveEraInfo>

The active era information, it holds index and start.

The active era is the era being currently rewarded. Validator set of this era must be equal to SessionInterface::validators.

impl<T: Config> Pallet<T>

pub fn eras_start_session_index<KArg>(k: KArg) -> Option<SessionIndex> where
    KArg: EncodeLike<EraIndex>, 

The session index at which the era start for the last HISTORY_DEPTH eras.

Note: This tracks the starting session (i.e. session index when era start being active) for the eras in [CurrentEra - HISTORY_DEPTH, CurrentEra].

impl<T: Config> Pallet<T>

pub fn eras_stakers<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> ExposureT<T> where
    KArg1: EncodeLike<EraIndex>,
    KArg2: EncodeLike<AccountId<T>>, 

Exposure of validator at era.

This is keyed first by the era index to allow bulk deletion and then the stash account.

Is it removed after HISTORY_DEPTH eras. If stakers hasn’t been set or has been removed then empty exposure is returned.

impl<T: Config> Pallet<T>

pub fn eras_stakers_clipped<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> ExposureT<T> where
    KArg1: EncodeLike<EraIndex>,
    KArg2: EncodeLike<AccountId<T>>, 

Clipped Exposure of validator at era.

This is similar to ErasStakers but number of nominators exposed is reduced to the T::MaxNominatorRewardedPerValidator biggest stakers. (Note: the field total and own of the exposure remains unchanged). This is used to limit the i/o cost for the nominator payout.

This is keyed fist by the era index to allow bulk deletion and then the stash account.

Is it removed after HISTORY_DEPTH eras. If stakers hasn’t been set or has been removed then empty exposure is returned.

impl<T: Config> Pallet<T>

pub fn eras_validator_prefs<KArg1, KArg2>(
    k1: KArg1,
    k2: KArg2
) -> ValidatorPrefs where
    KArg1: EncodeLike<EraIndex>,
    KArg2: EncodeLike<AccountId<T>>, 

Similar to ErasStakers, this holds the preferences of validators.

This is keyed first by the era index to allow bulk deletion and then the stash account.

Is it removed after HISTORY_DEPTH eras.

impl<T: Config> Pallet<T>

pub fn eras_validator_reward<KArg>(k: KArg) -> Option<RingBalance<T>> where
    KArg: EncodeLike<EraIndex>, 

The total validator era payout for the last HISTORY_DEPTH eras.

Eras that haven’t finished yet or has been removed doesn’t have reward.

impl<T: Config> Pallet<T>

pub fn eras_reward_points<KArg>(k: KArg) -> EraRewardPoints<AccountId<T>> where
    KArg: EncodeLike<EraIndex>, 

Rewards for the last HISTORY_DEPTH eras. If reward hasn’t been set or has been removed then 0 reward is returned.

impl<T: Config> Pallet<T>

pub fn eras_total_stake<KArg>(k: KArg) -> Power where
    KArg: EncodeLike<EraIndex>, 

The total amount staked for the last HISTORY_DEPTH eras. If total hasn’t been set or has been removed then 0 stake is returned.

impl<T: Config> Pallet<T>

pub fn force_era() -> Forcing

Mode of era forcing.

impl<T: Config> Pallet<T>

pub fn slash_reward_fraction() -> Perbill

The percentage of the slash that is distributed to reporters.

The rest of the slashed value is handled by the Slash.

impl<T: Config> Pallet<T>

pub fn canceled_payout() -> Power

The amount of currency given to reporters of a slash event which was canceled by extraordinary circumstances (e.g. governance).

impl<T: Config> Pallet<T>

pub fn current_planned_session() -> SessionIndex

The last planned session scheduled by the session pallet.

This is basically in sync with the call to [pallet_session::SessionManager::new_session].

impl<T: Config> Pallet<T>

pub fn offending_validators() -> Vec<(u32, bool)>

Indices of validators that have offended in the active era and whether they are currently disabled.

This value should be a superset of disabled validators since not all offences lead to the validator being disabled (if there was no slash). This is needed to track the percentage of validators that have offended in the current era, ensuring a new era is forced if OffendingValidatorsThreshold is reached. The vec is always kept sorted so that we can find whether a given validator has previously offended using binary search. It gets cleared when the era ends.

impl<T: Config> Pallet<T>

pub fn living_time() -> TsInMs

The chain’s running time form genesis in milliseconds, use for calculate darwinia era payout

impl<T: Config> Pallet<T>

pub fn payout_fraction() -> Perbill

The percentage of the total payout that is distributed to validators and nominators

The reset might go to Treasury or something else.

impl<T: Config> Pallet<T>

pub fn ring_pool() -> RingBalance<T>

Total RING in pool.

impl<T: Config> Pallet<T>

pub fn kton_pool() -> KtonBalance<T>

Total KTON in pool.

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> ElectionDataProvider for Pallet<T>

type AccountId = <T as Config>::AccountId

The account identifier type.

type BlockNumber = <T as Config>::BlockNumber

The block number type.

const MAXIMUM_VOTES_PER_VOTER: u32 = T::MAX_NOMINATIONS

Maximum number of votes per voter that this data provider is providing.

fn desired_targets() -> Result<u32>

The number of targets to elect.

fn voters(
    maybe_max_len: Option<usize>
) -> Result<Vec<(AccountId<T>, VoteWeight, Vec<AccountId<T>>)>>

All possible voters for the election.

fn targets(maybe_max_len: Option<usize>) -> Result<Vec<T::AccountId>>

All possible targets for the election, i.e. the candidates.

fn next_election_prediction(now: BlockNumberFor<T>) -> BlockNumberFor<T>

Provide a best effort prediction about when the next election is about to happen.

impl<T> EventHandler<<T as Config>::AccountId, <T as Config>::BlockNumber> for Pallet<T> where
    T: Config + Config + Config, 

Add reward points to block authors:

• 20 points to the block producer for producing a (non-uncle) block in the relay chain,
• 2 points to the block producer for each reference to a previously unreferenced uncle, and
• 1 point to the producer of each referenced uncle block.

fn note_author(author: AccountId<T>)

Note that the given account ID is the author of the current block.

fn note_uncle(uncle_author: T::AccountId, _age: T::BlockNumber)

Note that the given account ID authored the given uncle, and how many blocks older than the current block it is (age >= 0, so siblings are allowed)

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(_now: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(_n: BlockNumberFor<T>)

The block is being finalized. Implement to have something happen.

fn integrity_test()

Run integrity test.

fn on_idle(_n: BlockNumber, _remaining_weight: u64) -> u64

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T> OnOffenceHandler<<T as Config>::AccountId, (<T as Config>::ValidatorId, <T as Config>::FullIdentification), u64> for Pallet<T> where
    T: Config + Config<ValidatorId = AccountId<T>> + Config<FullIdentification = ExposureT<T>, FullIdentificationOf = ExposureOf<T>>,
    T::SessionHandler: SessionHandler<AccountId<T>>,
    T::SessionManager: SessionManager<AccountId<T>>,
    T::ValidatorIdOf: Convert<AccountId<T>, Option<AccountId<T>>>, 

This is intended to be used with FilterHistoricalOffences.

fn on_offence(
    offenders: &[OffenceDetails<AccountId<T>, IdentificationTuple<T>>],
    slash_fraction: &[Perbill],
    slash_session: SessionIndex,
    disable_strategy: DisableStrategy
) -> Weight

A handler for an offence of a particular kind.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn accumulate(acc: &mut Vec<PalletInfoData>)

Extend the given vector by all of the pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData, Global>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Config> SessionManager<<T as Config>::AccountId, Exposure<<T as Config>::AccountId, <<T as Config>::RingCurrency as Currency<<T as Config>::AccountId>>::Balance, <<T as Config>::KtonCurrency as Currency<<T as Config>::AccountId>>::Balance>> for Pallet<T>

fn new_session(
    new_index: SessionIndex
) -> Option<Vec<(AccountId<T>, ExposureT<T>)>>

If there was a validator set change, its returns the set of new validators along with their full identifications.

fn new_session_genesis(
    new_index: SessionIndex
) -> Option<Vec<(AccountId<T>, ExposureT<T>)>>

fn start_session(start_index: SessionIndex)

fn end_session(end_index: SessionIndex)

impl<T: Config> SessionManager<<T as Config>::AccountId> for Pallet<T>

fn new_session(new_index: SessionIndex) -> Option<Vec<AccountId<T>>>

Plan a new session, and optionally provide the new validator set.

fn new_session_genesis(new_index: SessionIndex) -> Option<Vec<AccountId<T>>>

Same as new_session, but it this should only be called at genesis.

fn start_session(start_index: SessionIndex)

Start an already planned session.

fn end_session(end_index: SessionIndex)

End the session.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> VoteWeightProvider<<T as Config>::AccountId> for Pallet<T>

fn vote_weight(who: &T::AccountId) -> VoteWeight

Get the current VoteWeight of who.

impl<T> Eq for Pallet<T>