pub fn reap_stash<T: Config>(stash: T::AccountId, _num_slashing_spans: u32)Expand description
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:
- the
total_balanceof the stash is below the existential deposit. - or, the
ledger.totalof the stash is below the 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.
The gate is intentionally the existential deposit and not min_chilled_bond: a
governance change to MinValidatorBond / MinNominatorBond must not turn previously
safe stashes into permissionlessly reapable ones. Accounts that fall below the new
minimums after such a change should be chill_other-ed (which has a density gate and
does not destroy the ledger), not reaped.
It can be called by anyone, as long as stash meets the above requirements.
Refunds the transaction fees upon successful execution.
§Parameters
stash: The stash account to be reaped.num_slashing_spans: Deprecated. This parameter is retained for backward compatibility. It no longer has any effect.
§Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::reap_stash.