Enum pallet_elections::Call

pub enum Call<T: Trait> {
    set_approvals(Vec<bool>, VoteIndex, u32, <<T as Trait>::Currency as Currency<<T as Trait>::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 Trait>::Currency as Currency<<T as Trait>::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
}

Dispatchable calls.

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

Variants

set_approvals(Vec<bool>, VoteIndex, u32, <<T as Trait>::Currency as Currency<<T as Trait>::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 [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 as explained in [voter_at] function.

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 as explained in [voter_at] function.

Also removes the lock on the balance of the voter. See [do_set_approvals()].

• 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 Trait>::Currency as Currency<<T as Trait>::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: Trait> Clone for Call<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Trait> Decode for Call<T> where
    <T::Lookup as StaticLookup>::Source: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    <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,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact,
    T::BlockNumber: HasCompact,
    T::BlockNumber: HasCompact, 

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

Attempt to deserialise the value from input.

impl<T: Trait> Encode for Call<T> where
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <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,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact,
    T::BlockNumber: HasCompact,
    T::BlockNumber: HasCompact, 

pub fn encode_to<__CodecOutputEdqy: Output>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

pub fn size_hint(&self) -> usize

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

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub 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
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <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,
    <<T as Trait>::Currency as Currency<<T as Trait>::AccountId>>::Balance: HasCompact,
    T::BlockNumber: HasCompact,
    T::BlockNumber: HasCompact, 

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

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

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

Return the function name of the Call.

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

Return all function names.

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

pub fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

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

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

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

#[must_use]pub 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).

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

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