Enum pallet_staking::Call

pub enum Call<T: Config> {
    bond {
        value: BalanceOf<T>,
        payee: RewardDestination<T::AccountId>,
    },
    bond_extra {
        max_additional: BalanceOf<T>,
    },
    unbond {
        value: BalanceOf<T>,
    },
    withdraw_unbonded {
        num_slashing_spans: u32,
    },
    validate {
        prefs: ValidatorPrefs,
    },
    nominate {
        targets: Vec<<<T as Config>::Lookup as StaticLookup>::Source>,
    },
    chill {},
    set_payee {
        payee: RewardDestination<T::AccountId>,
    },
    set_controller {},
    set_validator_count {
        new: u32,
    },
    increase_validator_count {
        additional: u32,
    },
    scale_validator_count {
        factor: Percent,
    },
    force_no_eras {},
    force_new_era {},
    set_invulnerables {
        invulnerables: Vec<T::AccountId>,
    },
    force_unstake {
        stash: T::AccountId,
        num_slashing_spans: u32,
    },
    force_new_era_always {},
    cancel_deferred_slash {
        era: EraIndex,
        slash_indices: Vec<u32>,
    },
    payout_stakers {
        validator_stash: T::AccountId,
        era: EraIndex,
    },
    rebond {
        value: BalanceOf<T>,
    },
    reap_stash {
        stash: T::AccountId,
        num_slashing_spans: u32,
    },
    kick {
        who: Vec<<<T as Config>::Lookup as StaticLookup>::Source>,
    },
    set_staking_configs {
        min_nominator_bond: ConfigOp<BalanceOf<T>>,
        min_validator_bond: ConfigOp<BalanceOf<T>>,
        max_nominator_count: ConfigOp<u32>,
        max_validator_count: ConfigOp<u32>,
        chill_threshold: ConfigOp<Percent>,
        min_commission: ConfigOp<Perbill>,
        max_staked_rewards: ConfigOp<Percent>,
    },
    chill_other {
        stash: T::AccountId,
    },
    force_apply_min_commission {
        validator_stash: T::AccountId,
    },
    set_min_commission {
        new: Perbill,
    },
    payout_stakers_by_page {
        validator_stash: T::AccountId,
        era: EraIndex,
        page: Page,
    },
    update_payee {
        controller: T::AccountId,
    },
    deprecate_controller_batch {
        controllers: BoundedVec<T::AccountId, T::MaxControllersInDeprecationBatch>,
    },
    restore_ledger {
        stash: T::AccountId,
        maybe_controller: Option<T::AccountId>,
        maybe_total: Option<BalanceOf<T>>,
        maybe_unlocking: Option<BoundedVec<UnlockChunk<BalanceOf<T>>, T::MaxUnlockingChunks>>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

bond

Take the origin account as a stash and lock up value of its balance. controller will be the account that controls it.

value must be more than the minimum_balance specified by T::Currency.

The dispatch origin for this call must be Signed by the stash account.

Emits Bonded.

Complexity

• Independent of the arguments. Moderate complexity.
• O(1).
• Three extra DB entries.

NOTE: Two of the storage writes (Self::bonded, Self::payee) are never cleaned unless the origin falls below existential deposit (or equal to 0) and gets removed as dust.

Fields

value: BalanceOf<T>

payee: RewardDestination<T::AccountId>

bond_extra

Add some extra amount that have appeared in the stash free_balance into the balance up for staking.

The dispatch origin for this call must be Signed by the stash, not the controller.

Use this if there are additional funds in your stash account that you wish to bond. Unlike bond or unbond this function does not impose any limitation on the amount that can be added.

Emits Bonded.

Complexity

• Independent of the arguments. Insignificant complexity.
• O(1).

Fields

max_additional: BalanceOf<T>

unbond

Schedule a portion of the stash to be unlocked ready for transfer out after the bond period ends. If this leaves an amount actively bonded less than asset::existential_deposit, then it is increased to the full amount.

The dispatch origin for this call must be Signed by the controller, not the stash.

Once the unlock period is done, you can call withdraw_unbonded to actually move the funds out of management ready for transfer.

No more than a limited number of unlocking chunks (see MaxUnlockingChunks) can co-exists at the same time. If there are no unlocking chunks slots available Call::withdraw_unbonded is called to remove some of the chunks (if possible).

If a user encounters the InsufficientBond error when calling this extrinsic, they should call chill first in order to free up their bonded funds.

Emits Unbonded.

See also Call::withdraw_unbonded.

Fields

value: BalanceOf<T>

withdraw_unbonded

Remove any unlocked chunks from the unlocking queue from our management.

This essentially frees up that balance to be used by the stash account to do whatever it wants.

The dispatch origin for this call must be Signed by the controller.

Emits Withdrawn.

See also Call::unbond.

Parameters

• num_slashing_spans indicates the number of metadata slashing spans to clear when this call results in a complete removal of all the data related to the stash account. In this case, the num_slashing_spans must be larger or equal to the number of slashing spans associated with the stash account in the SlashingSpans storage type, otherwise the call will fail. The call weight is directly proportional to num_slashing_spans.

Complexity

O(S) where S is the number of slashing spans to remove NOTE: Weight annotation is the kill scenario, we refund otherwise.

Fields

num_slashing_spans: u32

validate

Declare the desire to validate for the origin controller.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

Fields

prefs: ValidatorPrefs

nominate

Declare the desire to nominate targets for the origin controller.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

Complexity

• The transaction’s complexity is proportional to the size of targets (N) which is capped at CompactAssignments::LIMIT (T::MaxNominations).
• Both the reads and writes follow a similar pattern.

Fields

targets: Vec<<<T as Config>::Lookup as StaticLookup>::Source>

chill

Declare no desire to either validate or nominate.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

Complexity

• Independent of the arguments. Insignificant complexity.
• Contains one read.
• Writes are limited to the origin account key.

set_payee

(Re-)set the payment target for a controller.

Effects will be felt instantly (as soon as this function is completed successfully).

The dispatch origin for this call must be Signed by the controller, not the stash.

Complexity

• O(1)
• Independent of the arguments. Insignificant complexity.
• Contains a limited number of reads.
• Writes are limited to the origin account key.

---

Fields

payee: RewardDestination<T::AccountId>

set_controller

(Re-)sets the controller of a stash to the stash itself. This function previously accepted a controller argument to set the controller to an account other than the stash itself. This functionality has now been removed, now only setting the controller to the stash, if it is not already.

Effects will be felt instantly (as soon as this function is completed successfully).

The dispatch origin for this call must be Signed by the stash, not the controller.

Complexity

O(1)

• Independent of the arguments. Insignificant complexity.
• Contains a limited number of reads.
• Writes are limited to the origin account key.

set_validator_count

Sets the ideal number of validators.

The dispatch origin must be Root.

Complexity

O(1)

Fields

new: u32

increase_validator_count

Increments the ideal number of validators up to maximum of ElectionProviderBase::MaxWinners.

The dispatch origin must be Root.

Complexity

Same as Self::set_validator_count.

Fields

additional: u32

scale_validator_count

Scale up the ideal number of validators by a factor up to maximum of ElectionProviderBase::MaxWinners.

The dispatch origin must be Root.

Complexity

Same as Self::set_validator_count.

Fields

factor: Percent

force_no_eras

Force there to be no new eras indefinitely.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. Thus the election process may be ongoing when this is called. In this case the election will continue until the next era is triggered.

Complexity

• No arguments.
• Weight: O(1)

force_new_era

Force there to be a new era at the end of the next session. After this, it will be reset to normal (non-forced) behaviour.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

Complexity

• No arguments.
• Weight: O(1)

set_invulnerables

Set the validators who cannot be slashed (if any).

The dispatch origin must be Root.

Fields

invulnerables: Vec<T::AccountId>

force_unstake

Force a current staker to become completely unstaked, immediately.

The dispatch origin must be Root.

Parameters

• num_slashing_spans: Refer to comments on Call::withdraw_unbonded for more details.

Fields

stash: T::AccountId

num_slashing_spans: u32

force_new_era_always

Force there to be a new era at the end of sessions indefinitely.

The dispatch origin must be Root.

Warning

The election process starts multiple blocks before the end of the era. If this is called just before a new era is triggered, the election process may not have enough blocks to get a result.

cancel_deferred_slash

Cancel enactment of a deferred slash.

Can be called by the T::AdminOrigin.

Parameters: era and indices of the slashes for that era to kill.

Fields

era: EraIndex

slash_indices: Vec<u32>

payout_stakers

Pay out next page of the stakers behind a validator for the given era.

• validator_stash is the stash account of the validator.
• era may be any era between [current_era - history_depth; current_era].

The origin of this call must be Signed. Any account can call this function, even if it is not one of the stakers.

The reward payout could be paged in case there are too many nominators backing the validator_stash. This call will payout unpaid pages in an ascending order. To claim a specific page, use payout_stakers_by_page.`

If all pages are claimed, it returns an error InvalidPage.

Fields

validator_stash: T::AccountId

era: EraIndex

rebond

Rebond a portion of the stash scheduled to be unlocked.

The dispatch origin must be signed by the controller.

Complexity

• Time complexity: O(L), where L is unlocking chunks
• Bounded by MaxUnlockingChunks.

Fields

value: BalanceOf<T>

reap_stash

Remove all data structures concerning a staker/stash once it is at a state where it can be considered dust in the staking system. The requirements are:

1. the total_balance of the stash is below existential deposit.
2. or, the ledger.total of the stash is below existential deposit.
3. or, existential deposit is zero and either total_balance or ledger.total is zero.

The former can happen in cases like a slash; the latter when a fully unbonded account is still receiving staking rewards in RewardDestination::Staked.

It can be called by anyone, as long as stash meets the above requirements.

Refunds the transaction fees upon successful execution.

Parameters

• num_slashing_spans: Refer to comments on Call::withdraw_unbonded for more details.

Fields

stash: T::AccountId

num_slashing_spans: u32

kick

Remove the given nominations from the calling validator.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed by the controller, not the stash.

• who: A list of nominator stash accounts who are nominating this validator which should no longer be nominating this validator.

Note: Making this call only makes sense if you first set the validator preferences to block any further nominations.

Fields

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

set_staking_configs

Update the various staking configurations .

• min_nominator_bond: The minimum active bond needed to be a nominator.
• min_validator_bond: The minimum active bond needed to be a validator.
• max_nominator_count: The max number of users who can be a nominator at once. When set to None, no limit is enforced.
• max_validator_count: The max number of users who can be a validator at once. When set to None, no limit is enforced.
• chill_threshold: The ratio of max_nominator_count or max_validator_count which should be filled in order for the chill_other transaction to work.
• min_commission: The minimum amount of commission that each validators must maintain. This is checked only upon calling validate. Existing validators are not affected.

RuntimeOrigin must be Root to call this function.

NOTE: Existing nominators and validators will not be affected by this update. to kick people under the new limits, chill_other should be called.

Fields

min_nominator_bond: ConfigOp<BalanceOf<T>>

min_validator_bond: ConfigOp<BalanceOf<T>>

max_nominator_count: ConfigOp<u32>

max_validator_count: ConfigOp<u32>

chill_threshold: ConfigOp<Percent>

min_commission: ConfigOp<Perbill>

max_staked_rewards: ConfigOp<Percent>

chill_other

Declare a controller to stop participating as either a validator or nominator.

Effects will be felt at the beginning of the next era.

The dispatch origin for this call must be Signed, but can be called by anyone.

If the caller is the same as the controller being targeted, then no further checks are enforced, and this function behaves just like chill.

If the caller is different than the controller being targeted, the following conditions must be met:

• controller must belong to a nominator who has become non-decodable,

Or:

• A ChillThreshold must be set and checked which defines how close to the max nominators or validators we must reach before users can start chilling one-another.
• A MaxNominatorCount and MaxValidatorCount must be set which is used to determine how close we are to the threshold.
• A MinNominatorBond and MinValidatorBond must be set and checked, which determines if this is a person that should be chilled because they have not met the threshold bond required.

This can be helpful if bond requirements are updated, and we need to remove old users who do not satisfy these requirements.

Fields

stash: T::AccountId

force_apply_min_commission

Force a validator to have at least the minimum commission. This will not affect a validator who already has a commission greater than or equal to the minimum. Any account can call this.

Fields

validator_stash: T::AccountId

set_min_commission

Sets the minimum amount of commission that each validators must maintain.

This call has lower privilege requirements than set_staking_config and can be called by the T::AdminOrigin. Root can always call this.

Fields

new: Perbill

payout_stakers_by_page

Pay out a page of the stakers behind a validator for the given era and page.

• validator_stash is the stash account of the validator.
• era may be any era between [current_era - history_depth; current_era].
• page is the page index of nominators to pay out with value between 0 and num_nominators / T::MaxExposurePageSize.

The origin of this call must be Signed. Any account can call this function, even if it is not one of the stakers.

If a validator has more than Config::MaxExposurePageSize nominators backing them, then the list of nominators is paged, with each page being capped at [Config::MaxExposurePageSize.] If a validator has more than one page of nominators, the call needs to be made for each page separately in order for all the nominators backing a validator to receive the reward. The nominators are not sorted across pages and so it should not be assumed the highest staker would be on the topmost page and vice versa. If rewards are not claimed in Config::HistoryDepth eras, they are lost.

Fields

validator_stash: T::AccountId

era: EraIndex

page: Page

update_payee

Migrates an account’s RewardDestination::Controller to RewardDestination::Account(controller).

Effects will be felt instantly (as soon as this function is completed successfully).

This will waive the transaction fee if the payee is successfully migrated.

Fields

controller: T::AccountId

deprecate_controller_batch

Updates a batch of controller accounts to their corresponding stash account if they are not the same. Ignores any controller accounts that do not exist, and does not operate if the stash and controller are already the same.

Effects will be felt instantly (as soon as this function is completed successfully).

The dispatch origin must be T::AdminOrigin.

Fields

controllers: BoundedVec<T::AccountId, T::MaxControllersInDeprecationBatch>

restore_ledger

Restores the state of a ledger which is in an inconsistent state.

The requirements to restore a ledger are the following:

• The stash is bonded; or
• The stash is not bonded but it has a staking lock left behind; or
• If the stash has an associated ledger and its state is inconsistent; or
• If the ledger is not corrupted but its staking lock is out of sync.

The maybe_* input parameters will overwrite the corresponding data and metadata of the ledger associated with the stash. If the input parameters are not set, the ledger will be reset values from on-chain state.

Fields

stash: T::AccountId

maybe_controller: Option<T::AccountId>

maybe_total: Option<BalanceOf<T>>

maybe_unlocking: Option<BoundedVec<UnlockChunk<BalanceOf<T>>, T::MaxUnlockingChunks>>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_bond( value: BalanceOf<T>, payee: RewardDestination<T::AccountId>, ) -> Self

Create a call with the variant bond.

pub fn new_call_variant_bond_extra(max_additional: BalanceOf<T>) -> Self

Create a call with the variant bond_extra.

pub fn new_call_variant_unbond(value: BalanceOf<T>) -> Self

Create a call with the variant unbond.

pub fn new_call_variant_withdraw_unbonded(num_slashing_spans: u32) -> Self

Create a call with the variant withdraw_unbonded.

pub fn new_call_variant_validate(prefs: ValidatorPrefs) -> Self

Create a call with the variant validate.

pub fn new_call_variant_nominate( targets: Vec<<<T as Config>::Lookup as StaticLookup>::Source>, ) -> Self

Create a call with the variant nominate.

pub fn new_call_variant_chill() -> Self

Create a call with the variant chill.

pub fn new_call_variant_set_payee( payee: RewardDestination<T::AccountId>, ) -> Self

Create a call with the variant set_payee.

pub fn new_call_variant_set_controller() -> Self

Create a call with the variant set_controller.

pub fn new_call_variant_set_validator_count(new: u32) -> Self

Create a call with the variant set_validator_count.

pub fn new_call_variant_increase_validator_count(additional: u32) -> Self

Create a call with the variant increase_validator_count.

pub fn new_call_variant_scale_validator_count(factor: Percent) -> Self

Create a call with the variant scale_validator_count.

pub fn new_call_variant_force_no_eras() -> Self

Create a call with the variant force_no_eras.

pub fn new_call_variant_force_new_era() -> Self

Create a call with the variant force_new_era.

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

Create a call with the variant set_invulnerables.

pub fn new_call_variant_force_unstake( stash: T::AccountId, num_slashing_spans: u32, ) -> Self

Create a call with the variant force_unstake.

pub fn new_call_variant_force_new_era_always() -> Self

Create a call with the variant force_new_era_always.

pub fn new_call_variant_cancel_deferred_slash( era: EraIndex, slash_indices: Vec<u32>, ) -> Self

Create a call with the variant cancel_deferred_slash.

pub fn new_call_variant_payout_stakers( validator_stash: T::AccountId, era: EraIndex, ) -> Self

Create a call with the variant payout_stakers.

pub fn new_call_variant_rebond(value: BalanceOf<T>) -> Self

Create a call with the variant rebond.

pub fn new_call_variant_reap_stash( stash: T::AccountId, num_slashing_spans: u32, ) -> Self

Create a call with the variant reap_stash.

pub fn new_call_variant_kick( who: Vec<<<T as Config>::Lookup as StaticLookup>::Source>, ) -> Self

Create a call with the variant kick.

pub fn new_call_variant_set_staking_configs( min_nominator_bond: ConfigOp<BalanceOf<T>>, min_validator_bond: ConfigOp<BalanceOf<T>>, max_nominator_count: ConfigOp<u32>, max_validator_count: ConfigOp<u32>, chill_threshold: ConfigOp<Percent>, min_commission: ConfigOp<Perbill>, max_staked_rewards: ConfigOp<Percent>, ) -> Self

Create a call with the variant set_staking_configs.

pub fn new_call_variant_chill_other(stash: T::AccountId) -> Self

Create a call with the variant chill_other.

pub fn new_call_variant_force_apply_min_commission( validator_stash: T::AccountId, ) -> Self

Create a call with the variant force_apply_min_commission.

pub fn new_call_variant_set_min_commission(new: Perbill) -> Self

Create a call with the variant set_min_commission.

pub fn new_call_variant_payout_stakers_by_page( validator_stash: T::AccountId, era: EraIndex, page: Page, ) -> Self

Create a call with the variant payout_stakers_by_page.

pub fn new_call_variant_update_payee(controller: T::AccountId) -> Self

Create a call with the variant update_payee.

pub fn new_call_variant_deprecate_controller_batch( controllers: BoundedVec<T::AccountId, T::MaxControllersInDeprecationBatch>, ) -> Self

Create a call with the variant deprecate_controller_batch.

pub fn new_call_variant_restore_ledger( stash: T::AccountId, maybe_controller: Option<T::AccountId>, maybe_total: Option<BalanceOf<T>>, maybe_unlocking: Option<BoundedVec<UnlockChunk<BalanceOf<T>>, T::MaxUnlockingChunks>>, ) -> Self

Create a call with the variant restore_ledger.

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, BalanceOf<T>: HasCompact, RewardDestination<T::AccountId>: TypeInfo + 'static, Vec<<<T as Config>::Lookup as StaticLookup>::Source>: TypeInfo + 'static, Vec<T::AccountId>: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, ConfigOp<BalanceOf<T>>: TypeInfo + 'static, BoundedVec<T::AccountId, T::MaxControllersInDeprecationBatch>: TypeInfo + 'static, Option<T::AccountId>: TypeInfo + 'static, Option<BalanceOf<T>>: TypeInfo + 'static, Option<BoundedVec<UnlockChunk<BalanceOf<T>>, T::MaxUnlockingChunks>>: 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>