referrerpolicy=no-referrer-when-downgrade
pallet_staking_async::dispatchables

Function 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:

  1. the total_balance of the stash is below min_chilled_bond or is zero.
  2. or, the ledger.total of the stash is below min_chilled_bond or 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

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