Function pallet_elections_phragmen::pallet::dispatchables::renounce_candidacy

source · 
pub fn renounce_candidacy<T: Config>(renouncing: Renouncing)
Expand description

Renounce one’s intention to be a candidate for the next election round. 3 potential outcomes exist:

  • origin is a candidate and not elected in any set. In this case, the deposit is unreserved, returned and origin is removed as a candidate.
  • origin is a current runner-up. In this case, the deposit is unreserved, returned and origin is removed as a runner-up.
  • origin is a current member. In this case, the deposit is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar to remove_member, if replacement runners exists, they are immediately used. If the prime is renouncing, then no prime will exist until the next round.

The dispatch origin of this call must be signed, and have one of the above roles. The type of renouncing must be provided as witness data.

Complexity

  • Renouncing::Candidate(count): O(count + log(count))
  • Renouncing::Member: O(1)
  • Renouncing::RunnerUp: O(1)

Warning: Doc-Only

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