Enum pallet_staking::Call

pub enum Call<T: Trait> {
    bond(<T::Lookup as StaticLookup>::Source, BalanceOf<T>, RewardDestination),
    bond_extra(BalanceOf<T>),
    unbond(BalanceOf<T>),
    withdraw_unbonded(),
    validate(ValidatorPrefs),
    nominate(Vec<<T::Lookup as StaticLookup>::Source>),
    chill(),
    set_payee(RewardDestination),
    set_controller(<T::Lookup as StaticLookup>::Source),
    set_validator_count(u32),
    force_no_eras(),
    force_new_era(),
    set_invulnerables(Vec<T::AccountId>),
    force_unstake(T::AccountId),
    force_new_era_always(),
    cancel_deferred_slash(EraIndex, Vec<u32>),
    rebond(BalanceOf<T>),
    reap_stash(T::AccountId),
    // some variants omitted
}

Dispatchable calls.

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

Variants

bond(<T::Lookup as StaticLookup>::Source, BalanceOf<T>, RewardDestination)

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.

• 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 and gets removed as dust.

bond_extra(BalanceOf<T>)

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

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.

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

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

unbond(BalanceOf<T>)

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 T::Currency::minimum_balance(), then it is increased to the full amount.

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 MAX_UNLOCKING_CHUNKS) can co-exists at the same time. In that case, Call::withdraw_unbonded need to be called first to remove some of the chunks (if possible).

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

See also Call::withdraw_unbonded.

• Independent of the arguments. Limited but potentially exploitable complexity.
• Contains a limited number of reads.
• Each call (requires the remainder of the bonded balance to be above minimum_balance) will cause a new entry to be inserted into a vector (Ledger.unlocking) kept in storage. The only way to clean the aforementioned storage item is also user-controlled via withdraw_unbonded.
• One DB entry.

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, not the stash.

See also Call::unbond.

• Could be dependent on the origin argument and how much unlocking chunks exist. It implies consolidate_unlocked which loops over Ledger.unlocking, which is indirectly user-controlled. See [unbond] for more detail.
• Contains a limited number of reads, yet the size of which could be large based on ledger.
• Writes are limited to the origin account key.

validate(ValidatorPrefs)

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.

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

nominate(Vec<<T::Lookup as StaticLookup>::Source>)

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.

• The transaction's complexity is proportional to the size of targets, which is capped at MAX_NOMINATIONS.
• Both the reads and writes follow a similar pattern.

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.

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

set_payee(RewardDestination)

(Re-)set the payment target for a 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.

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

set_controller(<T::Lookup as StaticLookup>::Source)

(Re-)set the controller of a stash.

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

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

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

set_validator_count(u32)

The ideal number of validators.

force_no_eras()

Force there to be no new eras indefinitely.

• No arguments.

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.

• No arguments.

set_invulnerables(Vec<T::AccountId>)

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

force_unstake(T::AccountId)

Force a current staker to become completely unstaked, immediately.

force_new_era_always()

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

• One storage write

cancel_deferred_slash(EraIndex, Vec<u32>)

Cancel enactment of a deferred slash. Can be called by either the root origin or the T::SlashCancelOrigin. passing the era and indices of the slashes for that era to kill.

• One storage write.

rebond(BalanceOf<T>)

Rebond a portion of the stash scheduled to be unlocked.

• Time complexity: O(1). Bounded by MAX_UNLOCKING_CHUNKS.
• Storage changes: Can't increase storage, only decrease it.

reap_stash(T::AccountId)

Remove all data structure concerning a staker/stash once its balance is zero. This is essentially equivalent to withdraw_unbonded except it can be called by anyone and the target stash must have no funds left.

This can be called from any origin.

• stash: The stash account to reap. Its balance must be zero.

Trait Implementations

impl<T: Trait> 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: Trait> Debug for Call<T>

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,
    Vec<<T::Lookup as StaticLookup>::Source>: Decode,
    Vec<<T::Lookup as StaticLookup>::Source>: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    <T::Lookup as StaticLookup>::Source: Decode,
    Vec<T::AccountId>: Decode,
    Vec<T::AccountId>: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    T::AccountId: Decode,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact, 

fn decode<DecIn: Input>(input: &mut DecIn) -> Result<Self, Error>

Attempt to deserialise the value from input.

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

type Trait = T

...

type Origin = T::Origin

Every function call from your runtime has an origin, which specifies where the extrinsic was generated from. In the case of a signed extrinsic (transaction), the origin contains an identifier for the caller. The origin can be empty in the case of an inherent extrinsic.

fn dispatch(self, _origin: Self::Origin) -> DispatchResult

Actually dispatch this call and result the result of it.

impl<T: Trait> Encode for Call<T> where
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    Vec<<T::Lookup as StaticLookup>::Source>: Encode,
    Vec<<T::Lookup as StaticLookup>::Source>: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    Vec<T::AccountId>: Encode,
    Vec<T::AccountId>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact, 

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

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>

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.

impl<T: Trait> EncodeLike<Call<T>> for Call<T> where
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    Vec<<T::Lookup as StaticLookup>::Source>: Encode,
    Vec<<T::Lookup as StaticLookup>::Source>: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    <T::Lookup as StaticLookup>::Source: Encode,
    Vec<T::AccountId>: Encode,
    Vec<T::AccountId>: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    T::AccountId: Encode,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact,
    BalanceOf<T>: HasCompact, 

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

impl<T: Trait> 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: Trait> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Trait> 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 ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.