Function pallet_staking::dispatchables::reap_stash
source · 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 existential deposit. - or, the
ledger.totalof 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.
Parameters
num_slashing_spans: Refer to comments onCall::withdraw_unbondedfor more details.
Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::reap_stash.