Enum pallet_elections_phragmen::Call

pub enum Call<T: Trait> {
    vote(Vec<T::AccountId>, <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance),
    remove_voter(),
    report_defunct_voter(DefunctVoter<<T::Lookup as StaticLookup>::Source>),
    submit_candidacy(u32),
    renounce_candidacy(Renouncing),
    remove_member(<T::Lookup as StaticLookup>::Source, bool),
    // some variants omitted
}

Dispatchable calls.

Each variant of this enum maps to a dispatchable function from the associated module.

Variants

vote(Vec<T::AccountId>, <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance)

Vote for a set of candidates for the upcoming round of election. This can be called to set the initial votes, or update already existing votes.

Upon initial voting, value units of who's balance is locked and a bond amount is reserved.

The votes should:

• not be empty.
• be less than the number of possible candidates. Note that all current members and runners-up are also automatically candidates for the next round.

It is the responsibility of the caller to not place all of their balance into the lock and keep some for further transactions.

Base weight: 47.93 µs State reads: - Candidates.len() + Members.len() + RunnersUp.len() - Voting (is_voter) - [AccountBalance(who) (unreserve + total_balance)] State writes: - Voting - Lock - [AccountBalance(who) (unreserve -- only when creating a new voter)]

remove_voter()

Remove origin as a voter. This removes the lock and returns the bond.

Base weight: 36.8 µs All state access is from do_remove_voter. State reads: - Voting - [AccountData(who)] State writes: - Voting - Locks - [AccountData(who)]

report_defunct_voter(DefunctVoter<<T::Lookup as StaticLookup>::Source>)

Report target for being an defunct voter. In case of a valid report, the reporter is rewarded by the bond amount of target. Otherwise, the reporter itself is removed and their bond is slashed.

A defunct voter is defined to be:

• a voter whose current submitted votes are all invalid. i.e. all of them are no longer a candidate nor an active member or a runner-up.

The origin must provide the number of current candidates and votes of the reported target for the purpose of accurate weight calculation.

No Base weight based on min square analysis. Complexity of candidate_count: 1.755 µs Complexity of vote_count: 18.51 µs State reads: - Voting(reporter) - Candidate.len() - Voting(Target) - Candidates, Members, RunnersUp (is_defunct_voter) State writes: - Lock(reporter || target) - [AccountBalance(reporter)] + AccountBalance(target) - Voting(reporter || target) Note: the db access is worse with respect to db, which is when the report is correct.

submit_candidacy(u32)

Submit oneself for candidacy.

A candidate will either:

• Lose at the end of the term and forfeit their deposit.
• Win and become a member. Members will eventually get their stash back.
• Become a runner-up. Runners-ups are reserved members in case one gets forcefully removed.

Base weight = 33.33 µs Complexity of candidate_count: 0.375 µs State reads: - Candidates.len() - Candidates - Members - RunnersUp - [AccountBalance(who)] State writes: - [AccountBalance(who)] - Candidates

renounce_candidacy(Renouncing)

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 bond is unreserved, returned and origin is removed as a candidate.
• origin is a current runner-up. In this case, the bond is unreserved, returned and origin is removed as a runner-up.
• origin is a current member. In this case, the bond is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar to [remove_voter], if replacement runners exists, they are immediately used. If a candidate is renouncing: Base weight: 17.28 µs Complexity of candidate_count: 0.235 µs State reads: - Candidates - [AccountBalance(who) (unreserve)] State writes: - Candidates - [AccountBalance(who) (unreserve)] If member is renouncing: Base weight: 46.25 µs State reads: - Members, RunnersUp (remove_and_replace_member), - [AccountData(who) (unreserve)] State writes: - Members, RunnersUp (remove_and_replace_member), - [AccountData(who) (unreserve)] If runner is renouncing: Base weight: 46.25 µs State reads: - RunnersUp (remove_and_replace_member), - [AccountData(who) (unreserve)] State writes: - RunnersUp (remove_and_replace_member), - [AccountData(who) (unreserve)]

Weight note: The call into changeMembers need to be accounted for.

remove_member(<T::Lookup as StaticLookup>::Source, bool)

Remove a particular member from the set. This is effective immediately and the bond of the outgoing member is slashed.

If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, a new phragmen election is started.

Note that this does not affect the designated block number of the next election.

If we have a replacement: - Base weight: 50.93 µs - State reads: - RunnersUp.len() - Members, RunnersUp (remove_and_replace_member) - State writes: - Members, RunnersUp (remove_and_replace_member) Else, since this is a root call and will go into phragmen, we assume full block for now.

Trait Implementations

impl<T: Trait> Clone for Call<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Trait> Debug for Call<T>

fn fmt(&self, _f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<T: Trait> Decode for Call<T> where
    Vec<T::AccountId>: Decode,
    Vec<T::AccountId>: Decode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Decode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact, 

fn decode<DecIn: Input>(input: &mut DecIn) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl<T: Trait> Encode for Call<T> where
    Vec<T::AccountId>: Encode,
    Vec<T::AccountId>: Encode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Encode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact, 

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

impl<T: Trait> EncodeLike<Call<T>> for Call<T> where
    Vec<T::AccountId>: Encode,
    Vec<T::AccountId>: Encode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Encode,
    DefunctVoter<<T::Lookup as StaticLookup>::Source>: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact, 

impl<T: Trait> Eq for Call<T>

impl<T: Trait> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Trait> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Trait> PartialEq<Call<T>> for Call<T>

fn eq(&self, _other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Trait> UnfilteredDispatchable for Call<T>

type Origin = T::Origin

The origin type of the runtime, (i.e. frame_system::Trait::Origin).

fn dispatch_bypass_filter(
    self,
    _origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.