Enum pallet_elections_phragmen::pallet::Call

pub enum Call<T: Config> {
    vote {
        votes: Vec<T::AccountId>,
        value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    },
    remove_voter {},
    submit_candidacy {
        candidate_count: u32,
    },
    renounce_candidacy {
        renouncing: Renouncing,
    },
    remove_member {
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        slash_bond: bool,
        rerun_election: bool,
    },
    clean_defunct_voters {
        num_voters: u32,
        num_defunct: u32,
    },
    // some variants omitted
}

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

Variants

vote

Fields

votes: Vec<T::AccountId>

value: <<T as Config>::Currency as Currency<<T as Config>::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 deposit amount is reserved. The deposit is based on the number of votes and can be updated over time.

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.

If value is more than who’s free balance, then the maximum of the two is used.

The dispatch origin of this call must be signed.

Warning

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

We assume the maximum weight among all 3 cases: vote_equal, vote_more and vote_less.

remove_voter

Fields

Remove origin as a voter.

This removes the lock and returns the deposit.

The dispatch origin of this call must be signed and be a voter.

submit_candidacy

Fields

candidate_count: u32

Submit oneself for candidacy. A fixed amount of deposit is recorded.

All candidates are wiped at the end of the term. They either become a member/runner-up, or leave the system while their deposit is slashed.

The dispatch origin of this call must be signed.

Warning

Even if a candidate ends up being a member, they must call Call::renounce_candidacy to get their deposit back. Losing the spot in an election will always lead to a slash.

The number of current candidates must be provided as witness data.

renounce_candidacy

Fields

renouncing: 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 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.

remove_member

Fields

who: <<T as Config>::Lookup as StaticLookup>::Source

slash_bond: bool

rerun_election: 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, if rerun_election is true, a new phragmen election is started, else, nothing happens.

If slash_bond is set to true, the bond of the member being removed is slashed. Else, it is returned.

The dispatch origin of this call must be root.

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

If we have a replacement, we use a small weight. Else, since this is a root call and will go into phragmen, we assume full block for now.

clean_defunct_voters

Fields

num_voters: u32

num_defunct: u32

Clean all voters who are defunct (i.e. they do not serve any purpose at all). The deposit of the removed voters are returned.

This is an root function to be used only for cleaning the state.

The dispatch origin of this call must be root.

The total number of voters and those that are defunct must be provided as witness data.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_vote(
    votes: Vec<T::AccountId>,
    value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance
) -> Self

Create a call with the variant vote.

pub fn new_call_variant_remove_voter() -> Self

Create a call with the variant remove_voter.

pub fn new_call_variant_submit_candidacy(candidate_count: u32) -> Self

Create a call with the variant submit_candidacy.

pub fn new_call_variant_renounce_candidacy(renouncing: Renouncing) -> Self

Create a call with the variant renounce_candidacy.

pub fn new_call_variant_remove_member(
    who: <<T as Config>::Lookup as StaticLookup>::Source,
    slash_bond: bool,
    rerun_election: bool
) -> Self

Create a call with the variant remove_member.

pub fn new_call_variant_clean_defunct_voters(
    num_voters: u32,
    num_defunct: u32
) -> Self

Create a call with the variant clean_defunct_voters.

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) -> Rwhere
    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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    Vec<T::AccountId>: TypeInfo + 'static,
    <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: HasCompact,
    <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

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

type Origin = <T as Config>::Origin

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>