Enum pallet_elections_phragmen::pallet::Call[−][src]

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::Lookup as StaticLookup>::Source,
        has_replacement: bool,
    },
    clean_defunct_voters {
        num_voters: u32,
        num_defunct: u32,
    },
    // some variants omitted
}

Expand description

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

Variants

vote

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 total 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.

Fields of vote

votes: Vec<T::AccountId>value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance

remove_voter

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.

Fields of remove_voter

submit_candidacy

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.

Fields of submit_candidacy

candidate_count: u32

renounce_candidacy

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.

Fields of renounce_candidacy

renouncing: Renouncing

remove_member

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.

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.

Fields of remove_member

who: <T::Lookup as StaticLookup>::Sourcehas_replacement: bool

clean_defunct_voters

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.

Fields of clean_defunct_voters

num_voters: u32num_defunct: u32

Enum pallet_elections_phragmen::pallet::Call[−][src]

Variants

Warning

Fields of vote

Fields of remove_voter

Warning

Fields of submit_candidacy

Fields of renounce_candidacy

Fields of remove_member

Fields of clean_defunct_voters

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

pub fn new_call_variant_remove_voter() -> Self

pub fn new_call_variant_submit_candidacy(candidate_count: u32) -> Self

pub fn new_call_variant_renounce_candidacy(renouncing: Renouncing) -> Self

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

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

Trait Implementations

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

fn clone(&self) -> Self

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

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

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

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

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

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

fn encoded_fixed_size() -> Option<usize>

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

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

fn size_hint(&self) -> usize

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

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

fn encoded_size(&self) -> usize

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

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

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

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

fn get_dispatch_info(&self) -> DispatchInfo

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

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

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

impl<T: Config> 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::Lookup as StaticLookup>::Source: TypeInfo + 'static, T: Config + 'static,

type Identity = Self

fn type_info() -> Type

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

type Origin = OriginFor<T>

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

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

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Call<T> where T: RefUnwindSafe, <T as Config>::AccountId: RefUnwindSafe, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: RefUnwindSafe, <<T as Config>::Lookup as StaticLookup>::Source: RefUnwindSafe,

impl<T> Send for Call<T> where T: Send, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Send, <<T as Config>::Lookup as StaticLookup>::Source: Send,

impl<T> Sync for Call<T> where T: Sync, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Sync, <<T as Config>::Lookup as StaticLookup>::Source: Sync,

impl<T> Unpin for Call<T> where T: Unpin, <T as Config>::AccountId: Unpin, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Unpin, <<T as Config>::Lookup as StaticLookup>::Source: Unpin,

impl<T> UnwindSafe for Call<T> where T: UnwindSafe, <T as Config>::AccountId: UnwindSafe, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: UnwindSafe, <<T as Config>::Lookup as StaticLookup>::Source: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> DecodeAll for T where T: Decode,

pub fn decode_all(input: &[u8]) -> Result<T, Error>

impl<T> DecodeLimit for T where T: Decode,

pub fn decode_all_with_depth_limit(limit: u32, input: &[u8]) -> Result<T, Error>

pub fn decode_and_advance_with_depth_limit<I>( limit: u32, input: &mut I) -> Result<T, Error> where I: Input,

pub fn decode_with_depth_limit(limit: u32, input: &[u8]) -> Result<T, Error>

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

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

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

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

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

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

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

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

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

impl<T: Config> 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::Lookup as StaticLookup>::Source: TypeInfo + 'static,
T: Config + 'static,

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

impl<T> RefUnwindSafe for Call<T> where
T: RefUnwindSafe,
<T as Config>::AccountId: RefUnwindSafe,
<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: RefUnwindSafe,
<<T as Config>::Lookup as StaticLookup>::Source: RefUnwindSafe,

impl<T> Send for Call<T> where
T: Send,
<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Send,
<<T as Config>::Lookup as StaticLookup>::Source: Send,

impl<T> Sync for Call<T> where
T: Sync,
<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Sync,
<<T as Config>::Lookup as StaticLookup>::Source: Sync,

impl<T> Unpin for Call<T> where
T: Unpin,
<T as Config>::AccountId: Unpin,
<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: Unpin,
<<T as Config>::Lookup as StaticLookup>::Source: Unpin,

impl<T> UnwindSafe for Call<T> where
T: UnwindSafe,
<T as Config>::AccountId: UnwindSafe,
<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance: UnwindSafe,
<<T as Config>::Lookup as StaticLookup>::Source: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

impl<T> DecodeAll for T where
T: Decode,

pub fn decode_all(input: &[u8 ]) -> Result<T, Error>

impl<T> DecodeLimit for T where
T: Decode,

pub fn decode_all_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

pub fn decode_and_advance_with_depth_limit<I>(
limit: u32,
input: &mut I
) -> Result<T, Error> where
I: Input,

pub fn decode_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> DynClone for T where
T: Clone,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

impl<T> Hashable for T where
T: Codec,

pub fn blake2_128(&self) -> [u8 ; 16]

pub fn blake2_256(&self) -> [u8 ; 32]

pub fn twox_128(&self) -> [u8 ; 16]

pub fn twox_256(&self) -> [u8 ; 32]

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

impl<T> KeyedVec for T where
T: Codec,

pub fn to_keyed_vec(&self, prepend_key: &[u8 ]) -> Vec<u8, Global>

impl<T> Pipe for T where
T: ?Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,