Enum pallet_collator_selection::pallet::Call

pub enum Call<T: Config> {
    set_invulnerables {
        new: Vec<T::AccountId>,
    },
    set_desired_candidates {
        max: u32,
    },
    set_candidacy_bond {
        bond: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance,
    },
    register_as_candidate {},
    leave_intent {},
    withdraw_bond {},
    set_slash_destination {
        destination: Option<T::AccountId>,
    },
    add_invulnerable {
        who: T::AccountId,
    },
    remove_invulnerable {
        who: T::AccountId,
    },
    apply_for_candidacy {},
    close_application {
        who: T::AccountId,
    },
    approve_application {
        who: T::AccountId,
    },
    kick_candidate {
        who: T::AccountId,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

set_invulnerables

Set the list of invulnerable (fixed) collators.

Fields

new: Vec<T::AccountId>

set_desired_candidates

Set the ideal number of collators (not including the invulnerables). If lowering this number, then the number of running collators could be higher than this figure. Aside from that edge case, there should be no other way to have more collators than the desired number.

Fields

max: u32

set_candidacy_bond

Set the candidacy bond amount.

Fields

bond: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance

register_as_candidate

Register this account as a collator candidate. The account must (a) already have registered session keys and (b) be able to reserve the CandidacyBond.

DEPRECATED: This extrinsic is deprecated and will be removed in a future version. Applications are now automatically processed when approved via accept_application. This function now always fails to enforce the new permissioned workflow.

This call is not available to Invulnerable collators.

leave_intent

Deregister origin as a collator candidate. Note that the collator can only leave on session change. The CandidacyBond will start un-bonding process.

This call will fail if the total number of candidates would drop below MinCandidates.

This call is not available to Invulnerable collators.

withdraw_bond

Withdraw CandidacyBond after un-bonding period has finished. This call will fail called during un-bonding or if there’s no CandidacyBound reserved.

set_slash_destination

Set slash destination. Use Some to deposit slashed balance into destination or None to burn it.

Fields

destination: Option<T::AccountId>

add_invulnerable

Add an invulnerable collator.

Fields

who: T::AccountId

remove_invulnerable

Remove an invulnerable collator.

Fields

who: T::AccountId

apply_for_candidacy

Submit an application to become a collator candidate. The account must already have registered session keys.

This call is not available to Invulnerable collators or exisiting candidates.

close_application

Close a pending candidacy application and unreserve the bond.

Can only be called by the account that submitted the application or by governance origin.

Fields

who: T::AccountId

approve_application

Approve a pending candidacy application.

This will remove the application from pending status and immediately add the account to the candidates list, making them eligible for collator selection.

Fields

who: T::AccountId

kick_candidate

Forcibly remove a candidate from the active set.

This will immediately remove the candidate from the candidates list and unbond their deposit after slashing it accordigly to SlashRatio.

This call will fail if removing the candidate would bring the total number of candidates below the minimum threshold.

Fields

who: T::AccountId

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_set_invulnerables(new: Vec<T::AccountId>) -> Self

Create a call with the variant set_invulnerables.

pub fn new_call_variant_set_desired_candidates(max: u32) -> Self

Create a call with the variant set_desired_candidates.

pub fn new_call_variant_set_candidacy_bond( bond: <<T as Config>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance, ) -> Self

Create a call with the variant set_candidacy_bond.

pub fn new_call_variant_register_as_candidate() -> Self

Create a call with the variant register_as_candidate.

pub fn new_call_variant_leave_intent() -> Self

Create a call with the variant leave_intent.

pub fn new_call_variant_withdraw_bond() -> Self

Create a call with the variant withdraw_bond.

pub fn new_call_variant_set_slash_destination( destination: Option<T::AccountId>, ) -> Self

Create a call with the variant set_slash_destination.

pub fn new_call_variant_add_invulnerable(who: T::AccountId) -> Self

Create a call with the variant add_invulnerable.

pub fn new_call_variant_remove_invulnerable(who: T::AccountId) -> Self

Create a call with the variant remove_invulnerable.

pub fn new_call_variant_apply_for_candidacy() -> Self

Create a call with the variant apply_for_candidacy.

pub fn new_call_variant_close_application(who: T::AccountId) -> Self

Create a call with the variant close_application.

pub fn new_call_variant_approve_application(who: T::AccountId) -> Self

Create a call with the variant approve_application.

pub fn new_call_variant_kick_candidate(who: T::AccountId) -> Self

Create a call with the variant kick_candidate.

Trait Implementations

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

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

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 decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 size_hint(&self) -> usize

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

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

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

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.

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

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 in the same order as [GetCallIndex].

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 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 SystemConfig>::AccountId>>::Balance: TypeInfo + 'static, Option<T::AccountId>: TypeInfo + 'static, T::AccountId: 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 RuntimeOrigin = <T as Config>::RuntimeOrigin

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

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

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

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

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