Enum darwinia_staking::pallet::Call

pub enum Call<T: Config> {
    bond {
        controller: <T::Lookup as StaticLookup>::Source,
        value: StakingBalanceT<T>,
        payee: RewardDestination<AccountId<T>>,
        promise_month: u8,
    },
    bond_extra {
        max_additional: StakingBalanceT<T>,
        promise_month: u8,
    },
    deposit_extra {
        value: RingBalance<T>,
        promise_month: u8,
    },
    unbond {
        value: StakingBalanceT<T>,
    },
    withdraw_unbonded {
        num_slashing_spans: u32,
    },
    claim_mature_deposits {},
    try_claim_deposits_with_punish {
        expire_time: TsInMs,
    },
    validate {
        prefs: ValidatorPrefs,
    },
    nominate {
        targets: Vec<<T::Lookup as StaticLookup>::Source>,
    },
    chill {},
    set_payee {
        payee: RewardDestination<AccountId<T>>,
    },
    set_controller {
        controller: <T::Lookup as StaticLookup>::Source,
    },
    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<AccountId<T>>,
    },
    force_unstake {
        stash: AccountId<T>,
        num_slashing_spans: u32,
    },
    force_new_era_always {},
    cancel_deferred_slash {
        era: EraIndex,
        slash_indices: Vec<u32>,
    },
    payout_stakers {
        validator_stash: AccountId<T>,
        era: EraIndex,
    },
    rebond {
        plan_to_rebond_ring: RingBalance<T>,
        plan_to_rebond_kton: KtonBalance<T>,
    },
    set_history_depth {
        new_history_depth: EraIndex,
        era_items_deleted: u32,
    },
    reap_stash {
        stash: AccountId<T>,
        num_slashing_spans: u32,
    },
    kick {
        who: Vec<<T::Lookup as StaticLookup>::Source>,
    },
    set_staking_configs {
        min_nominator_bond: RingBalance<T>,
        min_validator_bond: RingBalance<T>,
        max_nominator_count: Option<u32>,
        max_validator_count: Option<u32>,
        chill_threshold: Option<Percent>,
        min_commission: Perbill,
    },
    chill_other {
        controller: T::AccountId,
    },
    // some variants omitted
}

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

Variants

bond

Fields

controller: <T::Lookup as StaticLookup>::Source

value: StakingBalanceT<T>

payee: RewardDestination<AccountId<T>>

promise_month: u8

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.

• 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

Fields

max_additional: StakingBalanceT<T>

promise_month: u8

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.

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

deposit_extra

Fields

value: RingBalance<T>

promise_month: u8

Deposit some extra amount ring, and return kton to the controller.

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

Is a no-op if value to be deposited is zero.

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

---

DB Weight:

• Read: Era Election Status, Bonded, Ledger, [Origin Account]
• Write: [Origin Account], Ledger

unbond

Fields

value: StakingBalanceT<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.

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

Once the unlock period is done, the funds will be withdrew automatically and 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, [StakingLock::shrink] need to be called first 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.

After all pledged Ring and Kton are unbonded, the bonded accounts, namely stash and controller, will also be unbonded. Once user want to bond again, the bond method should be called. If there are still pledged Ring or Kton and user want to bond more values, the bond_extra method should be called.

withdraw_unbonded

Fields

num_slashing_spans: u32

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.

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

claim_mature_deposits

Fields

Stash accounts can get their ring back after the depositing time exceeded, and the ring getting back is still in staking status.

• Independent of the arguments. Insignificant complexity.
• One storage read.
• One storage write.
• Writes are limited to the origin account key.

---

DB Weight:

• Read: Ledger, [Origin Account]
• Write: [Origin Account], Ledger

try_claim_deposits_with_punish

Fields

expire_time: TsInMs

Claim deposits while the depositing time has not been exceeded, the ring will not be slashed, but the account is required to pay KTON as punish.

Refer to https://talk.darwinia.network/topics/55

Assume the expire_time is a unique ID for the deposit

• Independent of the arguments. Insignificant complexity.
• One storage read.
• One storage write.
• Writes are limited to the origin account key.

---

DB Weight:

• Read: Ledger, Locks, [Origin Account]
• Write: [Origin Account], Locks, Ledger

validate

Fields

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

nominate

Fields

targets: 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 (N) which is capped at CompactAssignments::LIMIT (MAX_NOMINATIONS).
• Both the reads and writes follow a similar pattern.

chill

Fields

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

Fields

payee: RewardDestination<AccountId<T>>

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

---

• Weight: O(1)
• DB Weight:
  • Read: Ledger
  • Write: Payee

set_controller

Fields

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.

---

Weight: O(1) DB Weight:

• Read: Bonded, Ledger New Controller, Ledger Old Controller
• Write: Bonded, Ledger New Controller, Ledger Old Controller

set_validator_count

Fields

new: u32

Sets the ideal number of validators.

The dispatch origin must be Root.

Weight: O(1) Write: Validator Count

increase_validator_count

Fields

additional: u32

Increments the ideal number of validators.

The dispatch origin must be Root.

Same as Self::set_validator_count.

scale_validator_count

Fields

factor: Percent

Scale up the ideal number of validators by a factor.

The dispatch origin must be Root.

Same as Self::set_validator_count.

force_no_eras

Fields

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.

• No arguments.
• Weight: O(1)
• Write: ForceEra

force_new_era

Fields

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.

• No arguments.
• Weight: O(1)
• Write ForceEra

set_invulnerables

Fields

invulnerables: Vec<AccountId<T>>

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

The dispatch origin must be Root.

• O(V)
• Write: Invulnerables

force_unstake

Fields

stash: AccountId<T>

num_slashing_spans: u32

Force a current staker to become completely unstaked, immediately.

The dispatch origin must be Root.

O(S) where S is the number of slashing spans to be removed Reads: Bonded, Slashing Spans, Account, Locks Writes: Bonded, Slashing Spans (if S > 0), Ledger, Payee, Validators, Nominators, Account, Locks Writes Each: SpanSlash * S

force_new_era_always

Fields

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.

• Weight: O(1)
• Write: ForceEra

cancel_deferred_slash

Fields

era: EraIndex

slash_indices: Vec<u32>

Cancel enactment of a deferred slash.

Can be called by the T::SlashCancelOrigin.

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

Complexity: O(U + S) with U unapplied slashes weighted with U=1000 and S is the number of slash indices to be canceled.

• Read: Unapplied Slashes
• Write: Unapplied Slashes

payout_stakers

Fields

validator_stash: AccountId<T>

era: EraIndex

Pay out all the stakers behind a single validator for a single era.

• validator_stash is the stash account of the validator. Their nominators, up to T::MaxNominatorRewardedPerValidator, will also receive their rewards.
• 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.

• Time complexity: at most O(MaxNominatorRewardedPerValidator).
• Contains a limited number of reads and writes.

---

N is the Number of payouts for the validator (including the validator) Weight:

• Reward Destination Staked: O(N)

• Reward Destination Controller (Creating): O(N)

  NOTE: weights are assuming that payouts are made to alive stash account (Staked). Paying even a dead controller is cheaper weight-wise. We don’t do any refunds here.

rebond

Fields

plan_to_rebond_ring: RingBalance<T>

plan_to_rebond_kton: KtonBalance<T>

Rebond a portion of the stash scheduled to be unlocked.

The dispatch origin must be signed by the controller.

• Time complexity: O(L), where L is unlocking chunks
• Bounded by MAX_UNLOCKING_CHUNKS.
• Storage changes: Can’t increase storage, only decrease it.

set_history_depth

Fields

new_history_depth: EraIndex

era_items_deleted: u32

Set HistoryDepth value. This function will delete any history information when HistoryDepth is reduced.

Parameters:

• new_history_depth: The new history depth you would like to set.
• era_items_deleted: The number of items that will be deleted by this dispatch. This should report all the storage items that will be deleted by clearing old era history. Needed to report an accurate weight for the dispatch. Trusted by Root to report an accurate number.

Origin must be root.

• E: Number of history depths removed, i.e. 10 -> 7 = 3
• Weight: O(E)
• DB Weight:
  • Reads: Current Era, History Depth
  • Writes: History Depth
  • Clear Prefix Each: Era Stakers, EraStakersClipped, ErasValidatorPrefs
  • Writes Each: ErasValidatorReward, ErasRewardPoints, ErasTotalStake, ErasStartSessionIndex

reap_stash

Fields

stash: AccountId<T>

num_slashing_spans: u32

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.

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.

kick

Fields

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

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.

set_staking_configs

Fields

min_nominator_bond: RingBalance<T>

min_validator_bond: RingBalance<T>

max_nominator_count: Option<u32>

max_validator_count: Option<u32>

chill_threshold: Option<Percent>

min_commission: Perbill

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.

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

chill_other

Fields

controller: T::AccountId

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:

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

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_bond(
    controller: <T::Lookup as StaticLookup>::Source,
    value: StakingBalanceT<T>,
    payee: RewardDestination<AccountId<T>>,
    promise_month: u8
) -> Self

Create a call with the variant bond.

pub fn new_call_variant_bond_extra(
    max_additional: StakingBalanceT<T>,
    promise_month: u8
) -> Self

Create a call with the variant bond_extra.

pub fn new_call_variant_deposit_extra(
    value: RingBalance<T>,
    promise_month: u8
) -> Self

Create a call with the variant deposit_extra.

pub fn new_call_variant_unbond(value: StakingBalanceT<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_claim_mature_deposits() -> Self

Create a call with the variant claim_mature_deposits.

pub fn new_call_variant_try_claim_deposits_with_punish(
    expire_time: TsInMs
) -> Self

Create a call with the variant try_claim_deposits_with_punish.

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::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<AccountId<T>>
) -> Self

Create a call with the variant set_payee.

pub fn new_call_variant_set_controller(
    controller: <T::Lookup as StaticLookup>::Source
) -> 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<AccountId<T>>
) -> Self

Create a call with the variant set_invulnerables.

pub fn new_call_variant_force_unstake(
    stash: AccountId<T>,
    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: AccountId<T>,
    era: EraIndex
) -> Self

Create a call with the variant payout_stakers.

pub fn new_call_variant_rebond(
    plan_to_rebond_ring: RingBalance<T>,
    plan_to_rebond_kton: KtonBalance<T>
) -> Self

Create a call with the variant rebond.

pub fn new_call_variant_set_history_depth(
    new_history_depth: EraIndex,
    era_items_deleted: u32
) -> Self

Create a call with the variant set_history_depth.

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

Create a call with the variant reap_stash.

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

Create a call with the variant kick.

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

Create a call with the variant set_staking_configs.

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

Create a call with the variant chill_other.

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) -> 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> 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 !=.

impl<T: Config> TypeInfo for Call<T> where
    PhantomData<(T,)>: TypeInfo + 'static,
    <T::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    StakingBalanceT<T>: TypeInfo + 'static,
    RewardDestination<AccountId<T>>: TypeInfo + 'static,
    StakingBalanceT<T>: TypeInfo + 'static,
    RingBalance<T>: TypeInfo + 'static,
    StakingBalanceT<T>: TypeInfo + 'static,
    Vec<<T::Lookup as StaticLookup>::Source>: TypeInfo + 'static,
    RewardDestination<AccountId<T>>: TypeInfo + 'static,
    <T::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    Vec<AccountId<T>>: TypeInfo + 'static,
    AccountId<T>: TypeInfo + 'static,
    AccountId<T>: TypeInfo + 'static,
    RingBalance<T>: HasCompact,
    KtonBalance<T>: HasCompact,
    AccountId<T>: TypeInfo + 'static,
    Vec<<T::Lookup as StaticLookup>::Source>: TypeInfo + 'static,
    RingBalance<T>: TypeInfo + 'static,
    RingBalance<T>: 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 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>