pub fn init_leave_candidates<T: Config>()
Expand description

Request to leave the set of collator candidates.

On success, the account is immediately removed from the candidate pool to prevent selection as a collator in future validation rounds, but unstaking of the funds is executed with a delay of StakeDuration blocks.

The exit request can be reversed by calling cancel_leave_candidates.

This operation affects the pallet’s total stake amount. It is updated even though the funds of the candidate who signaled to leave are still locked for ExitDelay + StakeDuration more blocks.

NOTE 1: Upon starting a new session_i in new_session, the current top candidates are selected to be block authors for session_i+1. Any changes to the top candidates afterwards do not effect the set of authors for session_i+1. Thus, we have to make sure none of these collators can leave before session_i+1 ends by delaying their exit for ExitDelay many blocks.

NOTE 2: We do not increment rewards in this extrinsic as the candidate could still author blocks, and thus be eligible to receive rewards, until the end of the next session.

Emits CollatorScheduledExit.

Warning: Doc-Only

This function is an automatically generated, and is doc-only, uncallable stub. See the real version in Pallet::init_leave_candidates.