Struct pallet_staking::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn ledger( account: StakingAccount<T::AccountId>, ) -> Result<StakingLedger<T>, Error<T>>

Fetches the ledger associated with a controller or stash account, if any.

pub fn payee( account: StakingAccount<T::AccountId>, ) -> Option<RewardDestination<T::AccountId>>

pub fn bonded(stash: &T::AccountId) -> Option<T::AccountId>

Fetches the controller bonded to a stash account, if any.

pub fn slashable_balance_of(stash: &T::AccountId) -> BalanceOf<T>

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

pub fn slashable_balance_of_vote_weight( stash: &T::AccountId, issuance: BalanceOf<T>, ) -> VoteWeight

Internal impl of Self::slashable_balance_of that returns [VoteWeight].

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

Returns a closure around slashable_balance_of_vote_weight that can be passed around.

This prevents call sites from repeatedly requesting total_issuance from backend. But it is important to be only used while the total issuance is not changing.

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

Same as weight_of_fn, but made for one time use.

pub fn trigger_new_era( start_session_index: SessionIndex, exposures: BoundedVec<(T::AccountId, Exposure<T::AccountId, BalanceOf<T>>), MaxWinnersOf<T>>, ) -> BoundedVec<T::AccountId, MaxWinnersOf<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: BoundedVec<(T::AccountId, Exposure<T::AccountId, BalanceOf<T>>), MaxWinnersOf<T>>, new_planned_era: EraIndex, ) -> BoundedVec<T::AccountId, MaxWinnersOf<T>>

Process the output of the election.

Store staking information for the new planned era

pub fn reward_by_ids( validators_points: impl IntoIterator<Item = (T::AccountId, 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.

pub fn add_era_stakers( current_era: EraIndex, stash: T::AccountId, exposure: Exposure<T::AccountId, BalanceOf<T>>, )

pub fn set_slash_reward_fraction(fraction: Perbill)

pub fn get_npos_voters(bounds: DataProviderBounds) -> Vec<VoterOf<Self>>

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;

Sets MinimumActiveStake to the minimum active nominator stake in the returned set of nominators.

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

pub fn get_npos_targets(bounds: DataProviderBounds) -> Vec<T::AccountId>

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>)

This function will add a nominator to the Nominators storage map, and VoterList.

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 VoterList.

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.

pub fn eras_stakers( era: EraIndex, account: &T::AccountId, ) -> Exposure<T::AccountId, BalanceOf<T>>

Returns full exposure of a validator for a given era.

History note: This used to be a getter for old storage item ErasStakers deprecated in v14. Since this function is used in the codebase at various places, we kept it as a custom getter that takes care of getting the full exposure of the validator in a backward compatible way.

impl<T: Config> Pallet<T>

pub fn api_nominations_quota(balance: BalanceOf<T>) -> u32

Returns the current nominations quota for nominators.

Used by the runtime API.

pub fn api_eras_stakers( era: EraIndex, account: T::AccountId, ) -> Exposure<T::AccountId, BalanceOf<T>>

pub fn api_eras_stakers_page_count(era: EraIndex, account: T::AccountId) -> Page

pub fn api_pending_rewards(era: EraIndex, account: T::AccountId) -> bool

impl<T: Config> Pallet<T>

pub fn validator_count() -> u32

Get the ideal number of active validators.

pub fn minimum_validator_count() -> u32

Get the minimum number of staking participants before emergency conditions are imposed.

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

Get the validators that may never be slashed or forcibly kicked out.

pub fn validators<EncodeLikeAccountId>( account_id: EncodeLikeAccountId, ) -> ValidatorPrefs

where EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the preferences of a given validator.

pub fn nominators<EncodeLikeAccountId>( account_id: EncodeLikeAccountId, ) -> Option<Nominations<T>>

where EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the nomination preferences of a given nominator.

pub fn current_era() -> Option<EraIndex>

Get the current era index.

pub fn active_era() -> Option<ActiveEraInfo>

Get the active era information.

pub fn eras_start_session_index<EncodeLikeEraIndex>( era_index: EncodeLikeEraIndex, ) -> Option<SessionIndex>

where EncodeLikeEraIndex: EncodeLike<EraIndex>,

Get the session index at which the era starts for the last Config::HistoryDepth eras.

pub fn eras_stakers_clipped<EncodeLikeEraIndex, EncodeLikeAccountId>( era_index: EncodeLikeEraIndex, account_id: EncodeLikeAccountId, ) -> Exposure<T::AccountId, BalanceOf<T>>

where EncodeLikeEraIndex: EncodeLike<EraIndex>, EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the clipped exposure of a given validator at an era.

pub fn claimed_rewards<EncodeLikeEraIndex, EncodeLikeAccountId>( era_index: EncodeLikeEraIndex, account_id: EncodeLikeAccountId, ) -> Vec<Page>

where EncodeLikeEraIndex: EncodeLike<EraIndex>, EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the paged history of claimed rewards by era for given validator.

pub fn eras_validator_prefs<EncodeLikeEraIndex, EncodeLikeAccountId>( era_index: EncodeLikeEraIndex, account_id: EncodeLikeAccountId, ) -> ValidatorPrefs

where EncodeLikeEraIndex: EncodeLike<EraIndex>, EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the preferences of given validator at given era.

pub fn eras_validator_reward<EncodeLikeEraIndex>( era_index: EncodeLikeEraIndex, ) -> Option<BalanceOf<T>>

where EncodeLikeEraIndex: EncodeLike<EraIndex>,

Get the total validator era payout for the last Config::HistoryDepth eras.

pub fn eras_reward_points<EncodeLikeEraIndex>( era_index: EncodeLikeEraIndex, ) -> EraRewardPoints<T::AccountId>

where EncodeLikeEraIndex: EncodeLike<EraIndex>,

Get the rewards for the last Config::HistoryDepth eras.

pub fn eras_total_stake<EncodeLikeEraIndex>( era_index: EncodeLikeEraIndex, ) -> BalanceOf<T>

where EncodeLikeEraIndex: EncodeLike<EraIndex>,

Get the total amount staked for the last Config::HistoryDepth eras.

pub fn force_era() -> Forcing

Get the mode of era forcing.

pub fn slash_reward_fraction() -> Perbill

Get the percentage of the slash that is distributed to reporters.

pub fn canceled_payout() -> BalanceOf<T>

Get the amount of canceled slash payout.

pub fn slashing_spans<EncodeLikeAccountId>( account_id: EncodeLikeAccountId, ) -> Option<SlashingSpans>

where EncodeLikeAccountId: EncodeLike<T::AccountId>,

Get the slashing spans for given account.

pub fn current_planned_session() -> SessionIndex

Get the last planned session scheduled by the session pallet.

impl<T: Config> Pallet<T>

pub fn bond( origin: OriginFor<T>, value: BalanceOf<T>, payee: RewardDestination<T::AccountId>, ) -> 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.

Complexity

• 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 (or equal to 0) and gets removed as dust.

pub fn bond_extra( origin: OriginFor<T>, max_additional: BalanceOf<T>, ) -> 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.

Complexity

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

pub fn unbond( origin: OriginFor<T>, value: BalanceOf<T>, ) -> DispatchResultWithPostInfo

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 asset::existential_deposit, 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, you can call withdraw_unbonded to actually move the funds out of management ready for transfer.

No more than a limited number of unlocking chunks (see MaxUnlockingChunks) can co-exists at the same time. If there are no unlocking chunks slots available Call::withdraw_unbonded is called 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.

Emits Unbonded.

See also Call::withdraw_unbonded.

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.

Parameters

• num_slashing_spans indicates the number of metadata slashing spans to clear when this call results in a complete removal of all the data related to the stash account. In this case, the num_slashing_spans must be larger or equal to the number of slashing spans associated with the stash account in the SlashingSpans storage type, otherwise the call will fail. The call weight is directly proportional to num_slashing_spans.

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 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 as Config>::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.

Complexity

• The transaction’s complexity is proportional to the size of targets (N) which is capped at CompactAssignments::LIMIT (T::MaxNominations).
• 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.

Complexity

• 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<T::AccountId>, ) -> DispatchResult

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

Effects will be felt instantly (as soon as this function is completed successfully).

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

Complexity

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

---

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

(Re-)sets the controller of a stash to the stash itself. This function previously accepted a controller argument to set the controller to an account other than the stash itself. This functionality has now been removed, now only setting the controller to the stash, if it is not already.

Effects will be felt instantly (as soon as this function is completed successfully).

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

Complexity

O(1)

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

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

Sets the ideal number of validators.

The dispatch origin must be Root.

Complexity

O(1)

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

Increments the ideal number of validators up to maximum of ElectionProviderBase::MaxWinners.

The dispatch origin must be Root.

Complexity

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 up to maximum of ElectionProviderBase::MaxWinners.

The dispatch origin must be Root.

Complexity

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.

Complexity

• No arguments.
• Weight: O(1)

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.

Complexity

• No arguments.
• Weight: O(1)

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

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

The dispatch origin must be Root.

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

Force a current staker to become completely unstaked, immediately.

The dispatch origin must be Root.

Parameters

• num_slashing_spans: Refer to comments on Call::withdraw_unbonded for more details.

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.

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::AdminOrigin.

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

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

Pay out next page of the stakers behind a validator for the given era.

• validator_stash is the stash account of the validator.
• 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.

The reward payout could be paged in case there are too many nominators backing the validator_stash. This call will payout unpaid pages in an ascending order. To claim a specific page, use payout_stakers_by_page.`

If all pages are claimed, it returns an error InvalidPage.

pub fn rebond( origin: OriginFor<T>, value: BalanceOf<T>, ) -> DispatchResultWithPostInfo

Rebond a portion of the stash scheduled to be unlocked.

The dispatch origin must be signed by the controller.

Complexity

• Time complexity: O(L), where L is unlocking chunks
• Bounded by MaxUnlockingChunks.

pub fn reap_stash( origin: OriginFor<T>, stash: T::AccountId, 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.
3. or, existential deposit is zero and either total_balance or ledger.total is zero.

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.

Parameters

• num_slashing_spans: Refer to comments on Call::withdraw_unbonded for more details.

pub fn kick( origin: OriginFor<T>, who: Vec<<<T as Config>::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: ConfigOp<BalanceOf<T>>, min_validator_bond: ConfigOp<BalanceOf<T>>, max_nominator_count: ConfigOp<u32>, max_validator_count: ConfigOp<u32>, chill_threshold: ConfigOp<Percent>, min_commission: ConfigOp<Perbill>, max_staked_rewards: ConfigOp<Percent>, ) -> 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.

RuntimeOrigin 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>, stash: 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:

• controller must belong to a nominator who has become non-decodable,

Or:

• 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.

pub fn force_apply_min_commission( origin: OriginFor<T>, validator_stash: T::AccountId, ) -> DispatchResult

Force a validator to have at least the minimum commission. This will not affect a validator who already has a commission greater than or equal to the minimum. Any account can call this.

pub fn set_min_commission(origin: OriginFor<T>, new: Perbill) -> DispatchResult

Sets the minimum amount of commission that each validators must maintain.

This call has lower privilege requirements than set_staking_config and can be called by the T::AdminOrigin. Root can always call this.

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

Pay out a page of the stakers behind a validator for the given era and page.

• validator_stash is the stash account of the validator.
• era may be any era between [current_era - history_depth; current_era].
• page is the page index of nominators to pay out with value between 0 and num_nominators / T::MaxExposurePageSize.

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

If a validator has more than Config::MaxExposurePageSize nominators backing them, then the list of nominators is paged, with each page being capped at [Config::MaxExposurePageSize.] If a validator has more than one page of nominators, the call needs to be made for each page separately in order for all the nominators backing a validator to receive the reward. The nominators are not sorted across pages and so it should not be assumed the highest staker would be on the topmost page and vice versa. If rewards are not claimed in Config::HistoryDepth eras, they are lost.

pub fn update_payee( origin: OriginFor<T>, controller: T::AccountId, ) -> DispatchResultWithPostInfo

Migrates an account’s RewardDestination::Controller to RewardDestination::Account(controller).

Effects will be felt instantly (as soon as this function is completed successfully).

This will waive the transaction fee if the payee is successfully migrated.

pub fn deprecate_controller_batch( origin: OriginFor<T>, controllers: BoundedVec<T::AccountId, T::MaxControllersInDeprecationBatch>, ) -> DispatchResultWithPostInfo

Updates a batch of controller accounts to their corresponding stash account if they are not the same. Ignores any controller accounts that do not exist, and does not operate if the stash and controller are already the same.

Effects will be felt instantly (as soon as this function is completed successfully).

The dispatch origin must be T::AdminOrigin.

pub fn restore_ledger( origin: OriginFor<T>, stash: T::AccountId, maybe_controller: Option<T::AccountId>, maybe_total: Option<BalanceOf<T>>, maybe_unlocking: Option<BoundedVec<UnlockChunk<BalanceOf<T>>, T::MaxUnlockingChunks>>, ) -> DispatchResult

Restores the state of a ledger which is in an inconsistent state.

The requirements to restore a ledger are the following:

• The stash is bonded; or
• The stash is not bonded but it has a staking lock left behind; or
• If the stash has an associated ledger and its state is inconsistent; or
• If the ledger is not corrupted but its staking lock is out of sync.

The maybe_* input parameters will overwrite the corresponding data and metadata of the ledger associated with the stash. If the input parameters are not set, the ledger will be reset values from on-chain state.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>

where T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

type RuntimeCall = 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>::Block as HeaderProvider>::HeaderT as Header>::Number

The block number type.

type MaxVotesPerVoter = <<T as Config>::NominationsQuota as NominationsQuota<<T as Config>::CurrencyBalance>>::MaxNominations

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

fn desired_targets() -> Result<u32>

The number of targets to elect.

fn electing_voters(bounds: DataProviderBounds) -> Result<Vec<VoterOf<Self>>>

All the voters that participate in the election, thus “electing”.

fn electable_targets(bounds: DataProviderBounds) -> Result<Vec<T::AccountId>>

All possible targets for the election, i.e. the targets that could become elected, thus “electable”.

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

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

fn add_voter( voter: T::AccountId, weight: VoteWeight, targets: BoundedVec<T::AccountId, Self::MaxVotesPerVoter>, )

Utility function only to be used in benchmarking scenarios, to be implemented optionally, else a noop.

fn add_target(target: T::AccountId)

Utility function only to be used in benchmarking scenarios, to be implemented optionally, else a noop.

fn clear()

Clear all voters and targets.

fn put_snapshot( voters: Vec<VoterOf<Self>>, targets: Vec<T::AccountId>, target_stake: Option<VoteWeight>, )

Utility function only to be used in benchmarking scenarios, to be implemented optionally, else a noop.

impl<T> EventHandler<<T as Config>::AccountId, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> 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,

fn note_author(author: T::AccountId)

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

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(_now: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumberFor<T>)

Block finalization hook. This is called at the very end of block execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

fn try_state(n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

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

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T> OnOffenceHandler<<T as Config>::AccountId, (<T as Config>::ValidatorId, <T as Config>::FullIdentification), Weight> for Pallet<T>

where T: Config<ValidatorId = <T as Config>::AccountId> + Config<FullIdentification = Exposure<<T as Config>::AccountId, BalanceOf<T>>, FullIdentificationOf = ExposureOf<T>> + Config, T::SessionHandler: SessionHandler<<T as Config>::AccountId>, T::SessionManager: SessionManager<<T as Config>::AccountId>, T::ValidatorIdOf: Convert<<T as Config>::AccountId, Option<<T as Config>::AccountId>>,

This is intended to be used with FilterHistoricalOffences.

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

A handler for an offence of a particular kind.

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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 infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Score = u64

fn score(who: &T::AccountId) -> Self::Score

Get the current Score of who.

fn set_score_of(who: &T::AccountId, weight: Self::Score)

For tests, benchmarks and fuzzing, set the score.

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

In this implementation new_session(session) must be called before end_session(session-1) i.e. the new session must be planned before the ending of the previous session.

Once the first new_session is planned, all session must start and then end in order, though some session can lag in between the newest session planned and the latest session started.

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

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

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

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> SessionManager<<T as Config>::AccountId, Exposure<<T as Config>::AccountId, <T as Config>::CurrencyBalance>> for Pallet<T>

fn new_session( new_index: SessionIndex, ) -> Option<Vec<(T::AccountId, Exposure<T::AccountId, BalanceOf<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<(T::AccountId, Exposure<T::AccountId, BalanceOf<T>>)>>

fn start_session(start_index: SessionIndex)

fn end_session(end_index: SessionIndex)

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

fn is_virtual_staker(who: &T::AccountId) -> bool

Whether who is a virtual staker whose funds are managed by another pallet.

There is an assumption that, this account is keyless and managed by another pallet in the runtime. Hence, it can never sign its own transactions.

type AccountId = <T as Config>::AccountId

AccountId type used by the staking system.

type Balance = <T as Config>::CurrencyBalance

Balance type used by the staking system.

type CurrencyToVote = <T as Config>::CurrencyToVote

Means of converting Currency to VoteWeight.

fn minimum_nominator_bond() -> Self::Balance

The minimum amount required to bond in order to set nomination intentions. This does not necessarily mean the nomination will be counted in an election, but instead just enough to be stored as a nominator. In other words, this is the minimum amount to register the intention to nominate.

fn minimum_validator_bond() -> Self::Balance

The minimum amount required to bond in order to set validation intentions.

fn stash_by_ctrl( controller: &Self::AccountId, ) -> Result<Self::AccountId, DispatchError>

Return a stash account that is controlled by a controller.

fn bonding_duration() -> EraIndex

Number of eras that staked funds must remain bonded for.

fn current_era() -> EraIndex

The current era index.

fn stake(who: &Self::AccountId) -> Result<Stake<BalanceOf<T>>, DispatchError>

Returns the [Stake] of who.

fn bond_extra(who: &Self::AccountId, extra: Self::Balance) -> DispatchResult

Bond some extra amount in who’s free balance against the active bonded balance of the account. The amount extra actually bonded will never be more than who’s free balance.

fn unbond(who: &Self::AccountId, value: Self::Balance) -> DispatchResult

Schedule a portion of the active bonded balance to be unlocked at era [Self::current_era] + [Self::bonding_duration].

fn set_payee( stash: &Self::AccountId, reward_acc: &Self::AccountId, ) -> DispatchResult

Set the reward destination for the ledger associated with the stash.

fn chill(who: &Self::AccountId) -> DispatchResult

Chill who.

fn withdraw_unbonded( who: Self::AccountId, num_slashing_spans: u32, ) -> Result<bool, DispatchError>

Unlock any funds schedule to unlock before or at the current era.

fn bond( who: &Self::AccountId, value: Self::Balance, payee: &Self::AccountId, ) -> DispatchResult

Bond (lock) value of who’s balance, while forwarding any rewards to payee.

fn nominate( who: &Self::AccountId, targets: Vec<Self::AccountId>, ) -> DispatchResult

Have who nominate validators.

fn desired_validator_count() -> u32

The ideal number of active validators.

fn election_ongoing() -> bool

Whether or not there is an ongoing election.

fn force_unstake(who: Self::AccountId) -> DispatchResult

Force a current staker to become completely unstaked, immediately.

fn is_exposed_in_era(who: &Self::AccountId, era: &EraIndex) -> bool

Checks whether an account staker has been exposed in an era.

fn status( who: &Self::AccountId, ) -> Result<StakerStatus<Self::AccountId>, DispatchError>

Return the status of the given staker, Err if not staked at all.

fn slash_reward_fraction() -> Perbill

Returns the fraction of the slash to be rewarded to reporter.

fn nominations(who: &Self::AccountId) -> Option<Vec<T::AccountId>>

Get the nominations of a stash, if they are a nominator, None otherwise.

fn add_era_stakers( current_era: &EraIndex, stash: &T::AccountId, exposures: Vec<(Self::AccountId, Self::Balance)>, )

fn set_current_era(era: EraIndex)

fn max_exposure_page_size() -> Page

fn total_stake(who: &Self::AccountId) -> Result<Self::Balance, DispatchError>

Total stake of a staker, Err if not a staker.

fn active_stake(who: &Self::AccountId) -> Result<Self::Balance, DispatchError>

Total active portion of a staker’s [Stake], Err if not a staker.

fn is_unbonding(who: &Self::AccountId) -> Result<bool, DispatchError>

Returns whether a staker is unbonding, Err if not a staker at all.

fn fully_unbond(who: &Self::AccountId) -> Result<(), DispatchError>

Returns whether a staker is FULLY unbonding, Err if not a staker at all.

fn is_validator(who: &Self::AccountId) -> bool

Checks whether or not this is a validator account.

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

fn virtual_bond( keyless_who: &Self::AccountId, value: Self::Balance, payee: &Self::AccountId, ) -> DispatchResult

Virtually bonds keyless_who to payee with value.

The payee must not be the same as the keyless_who.

fn migrate_to_virtual_staker(who: &Self::AccountId)

Migrate an existing staker to a virtual staker.

fn migrate_to_direct_staker(who: &Self::AccountId)

Migrate a virtual staker to a direct staker.

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>