Calls
bond
Take the origin account as a stash and lock upvalue
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
.
Namespace
bondExtra
Add some extra amount that have appeared in the stashfree_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
.
Namespace
cancelDeferredSlash
Cancel enactment of a deferred slash. Can be called by theT::SlashCancelOrigin
.
Parameters: era and indices of the slashes for that era to kill.
Namespace
chill
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. NamespacechillOther
Declare acontroller
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,
-
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
andMaxValidatorCount
must be set which is used to determine how close we are to the threshold. -
A
MinNominatorBond
andMinValidatorBond
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.
forceApplyMinCommission
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. NamespaceforceNewEra
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.
forceNewEraAlways
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.
forceNoEras
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.
forceUnstake
Force a current staker to become completely unstaked, immediately. The dispatch origin must be Root. NamespaceincreaseValidatorCount
Increments the ideal number of validators. The dispatch origin must be Root. Namespacekick
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.
nominate
Declare the desire to nominatetargets
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.
Namespace
payoutStakers
Currently disabled on TRN in favour of the Vortex Distribution System
-
validator_stash
is the stash account of the validator. Their nominators, up toT::MaxNominatorRewardedPerValidator
, will also receive their rewards. -
era
may be any era between[current_era - history_depth; current_era]
.
reapStash
Remove all data structures concerning a staker/stash once it is at a state where it can be considereddust
in the staking system. The requirements are:
- the
total_balance
of the stash is below existential deposit. 2. or, theledger.total
of the stash is below existential deposit.
RewardDestination::Staked
.
It can be called by anyone, as long as stash
meets the above requirements.
Refunds the transaction fees upon successful execution.
Namespace
rebond
Rebond a portion of the stash scheduled to be unlocked. The dispatch origin must be signed by the controller. NamespacescaleValidatorCount
Scale up the ideal number of validators by a factor. The dispatch origin must be Root. NamespacesetController
(Re-)set the controller of a stash. 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. NamespacesetInvulnerables
Set the validators who cannot be slashed (if any). The dispatch origin must be Root. NamespacesetPayee
(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. NamespacesetStakingConfigs
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 toNone
, no limit is enforced. -
max_validator_count
: The max number of users who can be a validator at once. When set toNone
, no limit is enforced. -
chill_threshold
: The ratio ofmax_nominator_count
ormax_validator_count
which should be filled in order for thechill_other
transaction to work. -
min_commission
: The minimum amount of commission that each validators must maintain. This is checked only upon callingvalidate
. Existing validators are not affected.
chill_other
should be called.
Namespace
setValidatorCount
Sets the ideal number of validators. The dispatch origin must be Root. Namespaceunbond
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, you can callwithdraw_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. In that case, [Call::withdraw_unbonded
] 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.
Emits Unbonded
.
See also [Call::withdraw_unbonded
].
Namespace
validate
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. preferences contain the Validator Commission which is a Perbill value NamespacewithdrawUnbonded
Remove any unlocked chunks from theunlocking
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
].
Namespace
Storage
activeEra
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
].
Namespace
bonded
Map from all locked “stash” accounts to the controller account. NamespacebondedEras
A mapping from still-bonded eras to the first session index of that era. Must contains information for eras for the range:[active_era - bounding_duration; active_era]
Namespace
canceledSlashPayout
The amount of currency given to reporters of a slash event which was canceled by extraordinary circumstances (e.g. governance). NamespacechillThreshold
The threshold for when users can start callingchill_other
for other validators / nominators. The threshold is compared to the actual number of validators / nominators (CountFor*
) in the system compared to the configured max (Max*Count
).
Namespace
counterForNominators
Counter for the related counted storage map NamespacecounterForValidators
Counter for the related counted storage map NamespacecurrentEra
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. NamespacecurrentPlannedSession
The last planned session scheduled by the session pallet. This is basically in sync with the call to [pallet_session::SessionManager::new_session
].
Namespace
erasRewardPoints
Rewards for the lastHISTORY_DEPTH
eras. If reward hasn’t been set or has been removed then 0 reward is returned.
Namespace
erasStakers
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 afterHISTORY_DEPTH
eras. If stakers hasn’t been set or has been removed then empty exposure is returned.
Namespace
erasStakersClipped
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.
Namespace
erasStartSessionIndex
The session index at which the era start for the lastHISTORY_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]
.
Namespace
erasTotalStake
The total amount staked for the lastHISTORY_DEPTH
eras. If total hasn’t been set or has been removed then 0 stake is returned.
Namespace
erasValidatorPrefs
Similar toErasStakers
, 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.
Namespace
erasValidatorReward
The total validator era payout for the lastHISTORY_DEPTH
eras.
Eras that haven’t finished yet or has been removed doesn’t have reward.
Namespace
forceEra
Mode of era forcing. Namespaceinvulnerables
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. Namespaceledger
Map from all (unlocked) “controller” accounts to the info regarding the staking. NamespacemaxNominatorsCount
The maximum nominator count before we stop allowing new validators to join. When this value is not set, no limits are enforced. NamespacemaxValidatorsCount
The maximum validator count before we stop allowing new validators to join. When this value is not set, no limits are enforced. NamespaceminCommission
The minimum amount of commission that validators can set. If set to0
, no limit exists.
Namespace
minimumValidatorCount
Minimum number of staking participants before emergency conditions are imposed. NamespaceminNominatorBond
The minimum active bond to become and maintain the role of a nominator. NamespaceminValidatorBond
The minimum active bond to become and maintain the role of a validator. Namespacenominators
The map from nominator stash key to their nomination preferences, namely the validators that they wish to support. Note that the keys of this storage map might become non-decodable in case the [Config::MaxNominations
] configuration is decreased. In this rare case, these nominators are still existent in storage, their key is correct and retrievable (i.e. contains_key
indicates that they exist), but their value cannot be decoded. Therefore, the non-decodable nominators will effectively not-exist, until they re-submit their preferences such that it is within the bounds of the newly set Config::MaxNominations
.
This implies that ::iter_keys().count()
and ::iter().count()
might return different values for this map. Moreover, the main ::count()
is aligned with the former, namely the number of keys that exist.
Lastly, if any of the nominators become non-decodable, they can be chilled immediately via [Call::chill_other
] dispatchable by anyone.
Namespace
nominatorSlashInEra
All slashing events on nominators, mapped by era to the highest slash value of the era. NamespaceoffendingValidators
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 ifOffendingValidatorsThreshold
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.
Namespace
payee
Where the reward payment should be made. Keyed by stash. NamespaceslashingSpans
Slashing spans for stash accounts. NamespaceslashRewardFraction
The percentage of the slash that is distributed to reporters. The rest of the slashed value is handled by theSlash
.
Namespace
spanSlash
Records information about the maximum slash of a stash within a slashing span, as well as how much reward has been paid out. NamespacestorageVersion
True if network has been upgraded to this version. Storage version of the pallet. This is set to v7.0.0 for new networks. NamespaceunappliedSlashes
All unapplied slashes that are queued for later. NamespacevalidatorCount
The ideal number of staking participants. Namespacevalidators
The map from (wannabe) validator stash key to the preferences of that validator. NamespacevalidatorSlashInEra
All slashing events on validators, mapped by era to the highest slash proportion and slash value of the era. NamespaceEvents
Bonded
An account has bonded this amount. [stash, amount] NOTE: This event is only emitted when funds are bonded via a dispatchable. Notably, it will not be emitted for staking rewards when they are added to stake. NamespaceChilled
An account has stopped participating as either a validator or nominator. NamespaceEraPaid
The era payout has been set; the first balance is the validator-payout; the second is the remainder from the maximum amount of reward. NamespaceKicked
A nominator has been kicked from a validator. NamespaceOldSlashingReportDiscarded
An old slashing report from a prior era was discarded because it could not be processed. NamespacePayoutStarted
The stakers’ rewards are getting paid. NamespaceRewarded
The nominator has been rewarded by this amount. NamespaceSlashed
One staker (and potentially its nominators) has been slashed by the given amount. NamespaceStakersElected
A new set of stakers was elected. NamespaceStakingElectionFailed
The election failed. No new era is planned. NamespaceUnbonded
An account has unbonded this amount. NamespaceValidatorPrefsSet
A validator has set their preferences. NamespaceWithdrawn
An account has calledwithdraw_unbonded
and removed unbonding chunks worth Balance
from the unlocking queue.
Namespace
Errors
AlreadyBonded
Stash is already bonded. NamespaceAlreadyClaimed
Rewards for this era have already been claimed for this validator. NamespaceAlreadyPaired
Controller is already paired. NamespaceBadState
Internal state has become somehow corrupted and the operation cannot continue. NamespaceBadTarget
A nomination target was supplied that was blocked or otherwise not a validator. NamespaceBoundNotMet
Some bound is not met. NamespaceCannotChillOther
The user has enough bond and thus cannot be chilled forcefully by an external person. NamespaceCommissionTooLow
Commission is too low. Must be at leastMinCommission
.
Namespace
DuplicateIndex
Duplicate index. NamespaceEmptyTargets
Targets cannot be empty. NamespaceFundedTarget
Attempting to target a stash that still has funds. NamespaceIncorrectHistoryDepth
Incorrect previous history depth input provided. NamespaceIncorrectSlashingSpans
Incorrect number of slashing spans provided. NamespaceInsufficientBond
Cannot have a validator or nominator role, with value less than the minimum defined by governance (seeMinValidatorBond
and MinNominatorBond
). If unbonding is the intention, chill
first to remove one’s role as validator/nominator.
Namespace
InvalidEraToReward
Invalid era to reward. NamespaceInvalidNumberOfNominations
Invalid number of nominations. NamespaceInvalidSlashIndex
Slash record index out of bounds. NamespaceNoMoreChunks
Can not schedule more unlock chunks. NamespaceNotController
Not a controller account. NamespaceNotSortedAndUnique
Items are not sorted and unique. NamespaceNotStash
Not a stash account. NamespaceNoUnlockChunk
Can not rebond without unlocking chunks. NamespaceTooManyNominators
There are too many nominators in the system. Governance needs to adjust the staking settings to keep things safe for the runtime. NamespaceTooManyTargets
Too many nomination targets supplied. NamespaceTooManyValidators
There are too many validators in the system. Governance needs to adjust the staking settings to keep things safe for the runtime. NamespaceConstants
bondingDuration
Number of eras that staked funds must remain bonded for. NamespacehistoryDepth
Number of eras to keep in history. Following information is kept for eras in[current_era - HistoryDepth, current_era]
: ErasStakers
, ErasStakersClipped
, ErasValidatorPrefs
, ErasValidatorReward
, ErasRewardPoints
, ErasTotalStake
, ErasStartSessionIndex
, StakingLedger.claimed_rewards
.
Must be more than the number of eras delayed by session. I.e. active era must always be in history. I.e. active_era > current_era - history_depth
must be guaranteed.
If migrating an existing pallet from storage value to config value, this should be set to same value or greater as in storage.
Note: HistoryDepth
is used as the upper bound for the BoundedVec
item StakingLedger.claimed_rewards
. Setting this value lower than the existing value can lead to inconsistencies in the StakingLedger
and will need to be handled properly in a migration. The test reducing_history_depth_abrupt
shows this effect.
Namespace
maxNominations
Maximum number of nominations per nominator. NamespacemaxNominatorRewardedPerValidator
The maximum number of nominators rewarded for each validator. For each validator only the$MaxNominatorRewardedPerValidator
biggest stakers can claim their reward. This used to limit the i/o cost for the nominator payout.
Namespace
maxUnlockingChunks
The maximum number ofunlocking
chunks a [StakingLedger
] can have. Effectively determines how many unique eras a staker may be unbonding in.
Note: MaxUnlockingChunks
is used as the upper bound for the BoundedVec
item StakingLedger.unlocking
. Setting this value lower than the existing value can lead to inconsistencies in the StakingLedger
and will need to be handled properly in a runtime migration. The test reducing_max_unlocking_chunks_abrupt
shows this effect.
Namespace