Enum pallet_elections::pallet::Call

pub enum Call<T: Config> {
    set_approvals(Vec<bool>, VoteIndex, u32, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance),
    reap_inactive_voter(u32, <T::Lookup as StaticLookup>::Source, u32, VoteIndex),
    retract_voter(u32),
    submit_candidacy(u32),
    present_winner(<T::Lookup as StaticLookup>::Source, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, VoteIndex),
    set_desired_seats(u32),
    remove_member(<T::Lookup as StaticLookup>::Source),
    set_presentation_duration(T::BlockNumber),
    set_term_duration(T::BlockNumber),
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

set_approvals(Vec<bool>, VoteIndex, u32, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance)

Set candidate approvals. Approval slots stay valid as long as candidates in those slots are registered.

Locks value from the balance of origin indefinitely. Only retract_voter or reap_inactive_voter can unlock the balance.

hint argument is interpreted differently based on:

• if origin is setting approvals for the first time: The index will be checked for being a valid hole in the voter list.
  • if the hint is correctly pointing to a hole, no fee is deducted from origin.
  • Otherwise, the call will succeed but the index is ignored and simply a push to the last chunk with free space happens. If the new push causes a new chunk to be created, a fee indicated by Config::VotingFee is deducted.
• if origin is already a voter: the index must be valid and point to the correct position of the origin in the current voters list.

Note that any trailing false votes in votes is ignored; In approval voting, not voting for a candidate and voting false, are equal.

• O(1).
• Two extra DB entries, one DB change.
• Argument votes is limited in length to number of candidates.

reap_inactive_voter(u32, <T::Lookup as StaticLookup>::Source, u32, VoteIndex)

Remove a voter. For it not to be a bond-consuming no-op, all approved candidate indices must now be either unregistered or registered to a candidate that registered the slot after the voter gave their last approval set.

Both indices must be provided according to the following principle: Voter index does not take holes into account. This means that any account submitting an index at any point in time should submit: VOTER_SET_SIZE * set_index + local_index, meaning that you are ignoring all holes in the first set_index sets.

May be called by anyone. Returns the voter deposit to signed.

• O(1).
• Two fewer DB entries, one DB change.

retract_voter(u32)

Remove a voter. All votes are cancelled and the voter deposit is returned.

The index must be provided according to the following principle: Voter index does not take holes into account. This means that any account submitting an index at any point in time should submit: VOTER_SET_SIZE * set_index + local_index, meaning that you are ignoring all holes in the first set_index sets.

Also removes the lock on the balance of the voter.

• O(1).
• Two fewer DB entries, one DB change.

submit_candidacy(u32)

Submit oneself for candidacy.

Account must have enough transferrable funds in it to pay the bond.

NOTE: if origin has already assigned approvals via set_approvals, it will NOT have any usable funds to pass candidacy bond and must first retract. Note that setting approvals will lock the entire balance of the voter until retraction or being reported.

• Independent of input.
• Three DB changes.

present_winner(<T::Lookup as StaticLookup>::Source, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, VoteIndex)

Claim that candidate is one of the top carry_count + desired_seats candidates. Only works iff the presentation period is active. candidate should have at least collected some non-zero total votes and origin must have enough funds to pay for a potential slash.

• O(voters) compute.
• One DB change.

set_desired_seats(u32)

Set the desired member count; if lower than the current count, then seats will not be up election when they expire. If more, then a new vote will be started if one is not already in progress.

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

Remove a particular member from the set. This is effective immediately.

Note: A tally should happen instantly (if not already in a presentation period) to fill the seat if removal means that the desired members are not met.

set_presentation_duration(T::BlockNumber)

Set the presentation duration. If there is currently a vote being presented for, will invoke finalize_vote.

set_term_duration(T::BlockNumber)

Set the presentation duration. If there is current a vote being presented for, will invoke finalize_vote.

Trait Implementations

impl<T: Config> 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: Config> Debug for Call<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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, Global>

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.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> 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: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> 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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

type Origin = OriginFor<T>

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

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

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

impl<T: Config> EncodeLike<Call<T>> for Call<T>

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