Function pallet_staking::dispatchables::unbond
source · pub fn unbond<T: Config>(value: BalanceOf<T>)
Expand description
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
.
§Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::unbond
.