Enum pallet_nomination_pools::pallet::Call

pub enum Call<T: Config> {
    join {
        amount: BalanceOf<T>,
        pool_id: PoolId,
    },
    bond_extra {
        extra: BondExtra<BalanceOf<T>>,
    },
    claim_payout {},
    unbond {
        member_account: <<T as Config>::Lookup as StaticLookup>::Source,
        unbonding_points: BalanceOf<T>,
    },
    pool_withdraw_unbonded {
        pool_id: PoolId,
        num_slashing_spans: u32,
    },
    withdraw_unbonded {
        member_account: <<T as Config>::Lookup as StaticLookup>::Source,
        num_slashing_spans: u32,
    },
    create {
        amount: BalanceOf<T>,
        root: <<T as Config>::Lookup as StaticLookup>::Source,
        nominator: <<T as Config>::Lookup as StaticLookup>::Source,
        bouncer: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    create_with_pool_id {
        amount: BalanceOf<T>,
        root: <<T as Config>::Lookup as StaticLookup>::Source,
        nominator: <<T as Config>::Lookup as StaticLookup>::Source,
        bouncer: <<T as Config>::Lookup as StaticLookup>::Source,
        pool_id: PoolId,
    },
    nominate {
        pool_id: PoolId,
        validators: Vec<T::AccountId>,
    },
    set_state {
        pool_id: PoolId,
        state: PoolState,
    },
    set_metadata {
        pool_id: PoolId,
        metadata: Vec<u8>,
    },
    set_configs {
        min_join_bond: ConfigOp<BalanceOf<T>>,
        min_create_bond: ConfigOp<BalanceOf<T>>,
        max_pools: ConfigOp<u32>,
        max_members: ConfigOp<u32>,
        max_members_per_pool: ConfigOp<u32>,
        global_max_commission: ConfigOp<Perbill>,
    },
    update_roles {
        pool_id: PoolId,
        new_root: ConfigOp<T::AccountId>,
        new_nominator: ConfigOp<T::AccountId>,
        new_bouncer: ConfigOp<T::AccountId>,
    },
    chill {
        pool_id: PoolId,
    },
    bond_extra_other {
        member: <<T as Config>::Lookup as StaticLookup>::Source,
        extra: BondExtra<BalanceOf<T>>,
    },
    set_claim_permission {
        permission: ClaimPermission,
    },
    claim_payout_other {
        other: T::AccountId,
    },
    set_commission {
        pool_id: PoolId,
        new_commission: Option<(Perbill, T::AccountId)>,
    },
    set_commission_max {
        pool_id: PoolId,
        max_commission: Perbill,
    },
    set_commission_change_rate {
        pool_id: PoolId,
        change_rate: CommissionChangeRate<BlockNumberFor<T>>,
    },
    claim_commission {
        pool_id: PoolId,
    },
    adjust_pool_deposit {
        pool_id: PoolId,
    },
    set_commission_claim_permission {
        pool_id: PoolId,
        permission: Option<CommissionClaimPermission<T::AccountId>>,
    },
    apply_slash {
        member_account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    migrate_delegation {
        member_account: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    migrate_pool_to_delegate_stake {
        pool_id: PoolId,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

join

Stake funds with a pool. The amount to bond is transferred from the member to the pool account and immediately increases the pools bond.

The method of transferring the amount to the pool account is determined by adapter::StakeStrategyType. If the pool is configured to use adapter::StakeStrategyType::Delegate, the funds remain in the account of the origin, while the pool gains the right to use these funds for staking.

Note

• An account can only be a member of a single pool.
• An account cannot join the same pool multiple times.
• This call will not dust the member account, so the member must have at least existential deposit + amount in their account.
• Only a pool with PoolState::Open can be joined

Fields

amount: BalanceOf<T>

pool_id: PoolId

bond_extra

Bond extra more funds from origin into the pool to which they already belong.

Additional funds can come from either the free balance of the account, of from the accumulated rewards, see BondExtra.

Bonding extra funds implies an automatic payout of all pending rewards as well. See bond_extra_other to bond pending rewards of other members.

Fields

extra: BondExtra<BalanceOf<T>>

claim_payout

A bonded member can use this to claim their payout based on the rewards that the pool has accumulated since their last claimed payout (OR since joining if this is their first time claiming rewards). The payout will be transferred to the member’s account.

The member will earn rewards pro rata based on the members stake vs the sum of the members in the pools stake. Rewards do not “expire”.

See claim_payout_other to claim rewards on behalf of some other pool member.

unbond

Unbond up to unbonding_points of the member_account’s funds from the pool. It implicitly collects the rewards one last time, since not doing so would mean some rewards would be forfeited.

Under certain conditions, this call can be dispatched permissionlessly (i.e. by any account).

Conditions for a permissionless dispatch.

• The pool is blocked and the caller is either the root or bouncer. This is refereed to as a kick.
• The pool is destroying and the member is not the depositor.
• The pool is destroying, the member is the depositor and no other members are in the pool.

Conditions for permissioned dispatch (i.e. the caller is also the

member_account):

• The caller is not the depositor.
• The caller is the depositor, the pool is destroying and no other members are in the pool.

Note

If there are too many unlocking chunks to unbond with the pool account, Call::pool_withdraw_unbonded can be called to try and minimize unlocking chunks. The [StakingInterface::unbond] will implicitly call Call::pool_withdraw_unbonded to try to free chunks if necessary (ie. if unbound was called and no unlocking chunks are available). However, it may not be possible to release the current unlocking chunks, in which case, the result of this call will likely be the NoMoreChunks error from the staking system.

Fields

member_account: <<T as Config>::Lookup as StaticLookup>::Source

unbonding_points: BalanceOf<T>

pool_withdraw_unbonded

Call withdraw_unbonded for the pools account. This call can be made by any account.

This is useful if there are too many unlocking chunks to call unbond, and some can be cleared by withdrawing. In the case there are too many unlocking chunks, the user would probably see an error like NoMoreChunks emitted from the staking system when they attempt to unbond.

Fields

pool_id: PoolId

num_slashing_spans: u32

withdraw_unbonded

Withdraw unbonded funds from member_account. If no bonded funds can be unbonded, an error is returned.

Under certain conditions, this call can be dispatched permissionlessly (i.e. by any account).

Conditions for a permissionless dispatch

• The pool is in destroy mode and the target is not the depositor.
• The target is the depositor and they are the only member in the sub pools.
• The pool is blocked and the caller is either the root or bouncer.

Conditions for permissioned dispatch

• The caller is the target and they are not the depositor.

Note

• If the target is the depositor, the pool will be destroyed.
• If the pool has any pending slash, we also try to slash the member before letting them withdraw. This calculation adds some weight overhead and is only defensive. In reality, pool slashes must have been already applied via permissionless Call::apply_slash.

Fields

member_account: <<T as Config>::Lookup as StaticLookup>::Source

num_slashing_spans: u32

create

Create a new delegation pool.

Arguments

• amount - The amount of funds to delegate to the pool. This also acts of a sort of deposit since the pools creator cannot fully unbond funds until the pool is being destroyed.
• index - A disambiguation index for creating the account. Likely only useful when creating multiple pools in the same extrinsic.
• root - The account to set as PoolRoles::root.
• nominator - The account to set as the PoolRoles::nominator.
• bouncer - The account to set as the PoolRoles::bouncer.

Note

In addition to amount, the caller will transfer the existential deposit; so the caller needs at have at least amount + existential_deposit transferable.

Fields

amount: BalanceOf<T>

root: <<T as Config>::Lookup as StaticLookup>::Source

nominator: <<T as Config>::Lookup as StaticLookup>::Source

bouncer: <<T as Config>::Lookup as StaticLookup>::Source

create_with_pool_id

Create a new delegation pool with a previously used pool id

Arguments

same as create with the inclusion of

• pool_id - `A valid PoolId.

Fields

amount: BalanceOf<T>

root: <<T as Config>::Lookup as StaticLookup>::Source

nominator: <<T as Config>::Lookup as StaticLookup>::Source

bouncer: <<T as Config>::Lookup as StaticLookup>::Source

pool_id: PoolId

nominate

Nominate on behalf of the pool.

The dispatch origin of this call must be signed by the pool nominator or the pool root role.

This directly forward the call to the staking pallet, on behalf of the pool bonded account.

Note

In addition to a root or nominator role of origin, pool’s depositor needs to have at least depositor_min_bond in the pool to start nominating.

Fields

pool_id: PoolId

validators: Vec<T::AccountId>

set_state

Set a new state for the pool.

If a pool is already in the Destroying state, then under no condition can its state change again.

The dispatch origin of this call must be either:

1. signed by the bouncer, or the root role of the pool,
2. if the pool conditions to be open are NOT met (as described by ok_to_be_open), and then the state of the pool can be permissionlessly changed to Destroying.

Fields

pool_id: PoolId

state: PoolState

set_metadata

Set a new metadata for the pool.

The dispatch origin of this call must be signed by the bouncer, or the root role of the pool.

Fields

pool_id: PoolId

metadata: Vec<u8>

set_configs

Update configurations for the nomination pools. The origin for this call must be Config::AdminOrigin.

Arguments

• min_join_bond - Set MinJoinBond.
• min_create_bond - Set MinCreateBond.
• max_pools - Set MaxPools.
• max_members - Set MaxPoolMembers.
• max_members_per_pool - Set MaxPoolMembersPerPool.
• global_max_commission - Set GlobalMaxCommission.

Fields

min_join_bond: ConfigOp<BalanceOf<T>>

min_create_bond: ConfigOp<BalanceOf<T>>

max_pools: ConfigOp<u32>

max_members: ConfigOp<u32>

max_members_per_pool: ConfigOp<u32>

global_max_commission: ConfigOp<Perbill>

update_roles

Update the roles of the pool.

The root is the only entity that can change any of the roles, including itself, excluding the depositor, who can never change.

It emits an event, notifying UIs of the role change. This event is quite relevant to most pool members and they should be informed of changes to pool roles.

Fields

pool_id: PoolId

new_root: ConfigOp<T::AccountId>

new_nominator: ConfigOp<T::AccountId>

new_bouncer: ConfigOp<T::AccountId>

chill

Chill on behalf of the pool.

The dispatch origin of this call can be signed by the pool nominator or the pool root role, same as Pallet::nominate.

Under certain conditions, this call can be dispatched permissionlessly (i.e. by any account).

Conditions for a permissionless dispatch:

• When pool depositor has less than MinNominatorBond staked, otherwise pool members are unable to unbond.

Conditions for permissioned dispatch:

• The caller has a nominator or root role of the pool. This directly forward the call to the staking pallet, on behalf of the pool bonded account.

Fields

pool_id: PoolId

bond_extra_other

origin bonds funds from extra for some pool member member into their respective pools.

origin can bond extra funds from free balance or pending rewards when origin == other.

In the case of origin != other, origin can only bond extra pending rewards of other members assuming set_claim_permission for the given member is PermissionlessCompound or PermissionlessAll.

Fields

member: <<T as Config>::Lookup as StaticLookup>::Source

extra: BondExtra<BalanceOf<T>>

set_claim_permission

Allows a pool member to set a claim permission to allow or disallow permissionless bonding and withdrawing.

Arguments

• origin - Member of a pool.
• permission - The permission to be applied.

Fields

permission: ClaimPermission

claim_payout_other

origin can claim payouts on some pool member other’s behalf.

Pool member other must have a PermissionlessWithdraw or PermissionlessAll claim permission for this call to be successful.

Fields

other: T::AccountId

set_commission

Set the commission of a pool. Both a commission percentage and a commission payee must be provided in the current tuple. Where a current of None is provided, any current commission will be removed.

• If a None is supplied to new_commission, existing commission will be removed.

Fields

pool_id: PoolId

new_commission: Option<(Perbill, T::AccountId)>

set_commission_max

Set the maximum commission of a pool.

• Initial max can be set to any Perbill, and only smaller values thereafter.
• Current commission will be lowered in the event it is higher than a new max commission.

Fields

pool_id: PoolId

max_commission: Perbill

set_commission_change_rate

Set the commission change rate for a pool.

Initial change rate is not bounded, whereas subsequent updates can only be more restrictive than the current.

Fields

pool_id: PoolId

change_rate: CommissionChangeRate<BlockNumberFor<T>>

claim_commission

Claim pending commission.

The dispatch origin of this call must be signed by the root role of the pool. Pending commission is paid out and added to total claimed commission`. Total pending commission is reset to zero. the current.

Fields

pool_id: PoolId

adjust_pool_deposit

Top up the deficit or withdraw the excess ED from the pool.

When a pool is created, the pool depositor transfers ED to the reward account of the pool. ED is subject to change and over time, the deposit in the reward account may be insufficient to cover the ED deficit of the pool or vice-versa where there is excess deposit to the pool. This call allows anyone to adjust the ED deposit of the pool by either topping up the deficit or claiming the excess.

Fields

pool_id: PoolId

set_commission_claim_permission

Set or remove a pool’s commission claim permission.

Determines who can claim the pool’s pending commission. Only the Root role of the pool is able to configure commission claim permissions.

Fields

pool_id: PoolId

permission: Option<CommissionClaimPermission<T::AccountId>>

apply_slash

Apply a pending slash on a member.

Fails unless crate::pallet::Config::StakeAdapter is of strategy type: adapter::StakeStrategyType::Delegate.

The pending slash amount of the member must be equal or more than ExistentialDeposit. This call can be dispatched permissionlessly (i.e. by any account). If the execution is successful, fee is refunded and caller may be rewarded with a part of the slash based on the crate::pallet::Config::StakeAdapter configuration.

Fields

member_account: <<T as Config>::Lookup as StaticLookup>::Source

migrate_delegation

Migrates delegated funds from the pool account to the member_account.

Fails unless crate::pallet::Config::StakeAdapter is of strategy type: adapter::StakeStrategyType::Delegate.

This is a permission-less call and refunds any fee if claim is successful.

If the pool has migrated to delegation based staking, the staked tokens of pool members can be moved and held in their own account. See adapter::DelegateStake

Fields

member_account: <<T as Config>::Lookup as StaticLookup>::Source

migrate_pool_to_delegate_stake

Migrate pool from adapter::StakeStrategyType::Transfer to adapter::StakeStrategyType::Delegate.

Fails unless crate::pallet::Config::StakeAdapter is of strategy type: adapter::StakeStrategyType::Delegate.

This call can be dispatched permissionlessly, and refunds any fee if successful.

If the pool has already migrated to delegation based staking, this call will fail.

Fields

pool_id: PoolId

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_join(amount: BalanceOf<T>, pool_id: PoolId) -> Self

Create a call with the variant join.

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

Create a call with the variant bond_extra.

pub fn new_call_variant_claim_payout() -> Self

Create a call with the variant claim_payout.

pub fn new_call_variant_unbond( member_account: <<T as Config>::Lookup as StaticLookup>::Source, unbonding_points: BalanceOf<T>, ) -> Self

Create a call with the variant unbond.

pub fn new_call_variant_pool_withdraw_unbonded( pool_id: PoolId, num_slashing_spans: u32, ) -> Self

Create a call with the variant pool_withdraw_unbonded.

pub fn new_call_variant_withdraw_unbonded( member_account: <<T as Config>::Lookup as StaticLookup>::Source, num_slashing_spans: u32, ) -> Self

Create a call with the variant withdraw_unbonded.

pub fn new_call_variant_create( amount: BalanceOf<T>, root: <<T as Config>::Lookup as StaticLookup>::Source, nominator: <<T as Config>::Lookup as StaticLookup>::Source, bouncer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant create.

pub fn new_call_variant_create_with_pool_id( amount: BalanceOf<T>, root: <<T as Config>::Lookup as StaticLookup>::Source, nominator: <<T as Config>::Lookup as StaticLookup>::Source, bouncer: <<T as Config>::Lookup as StaticLookup>::Source, pool_id: PoolId, ) -> Self

Create a call with the variant create_with_pool_id.

pub fn new_call_variant_nominate( pool_id: PoolId, validators: Vec<T::AccountId>, ) -> Self

Create a call with the variant nominate.

pub fn new_call_variant_set_state(pool_id: PoolId, state: PoolState) -> Self

Create a call with the variant set_state.

pub fn new_call_variant_set_metadata(pool_id: PoolId, metadata: Vec<u8>) -> Self

Create a call with the variant set_metadata.

pub fn new_call_variant_set_configs( min_join_bond: ConfigOp<BalanceOf<T>>, min_create_bond: ConfigOp<BalanceOf<T>>, max_pools: ConfigOp<u32>, max_members: ConfigOp<u32>, max_members_per_pool: ConfigOp<u32>, global_max_commission: ConfigOp<Perbill>, ) -> Self

Create a call with the variant set_configs.

pub fn new_call_variant_update_roles( pool_id: PoolId, new_root: ConfigOp<T::AccountId>, new_nominator: ConfigOp<T::AccountId>, new_bouncer: ConfigOp<T::AccountId>, ) -> Self

Create a call with the variant update_roles.

pub fn new_call_variant_chill(pool_id: PoolId) -> Self

Create a call with the variant chill.

pub fn new_call_variant_bond_extra_other( member: <<T as Config>::Lookup as StaticLookup>::Source, extra: BondExtra<BalanceOf<T>>, ) -> Self

Create a call with the variant bond_extra_other.

pub fn new_call_variant_set_claim_permission( permission: ClaimPermission, ) -> Self

Create a call with the variant set_claim_permission.

pub fn new_call_variant_claim_payout_other(other: T::AccountId) -> Self

Create a call with the variant claim_payout_other.

pub fn new_call_variant_set_commission( pool_id: PoolId, new_commission: Option<(Perbill, T::AccountId)>, ) -> Self

Create a call with the variant set_commission.

pub fn new_call_variant_set_commission_max( pool_id: PoolId, max_commission: Perbill, ) -> Self

Create a call with the variant set_commission_max.

pub fn new_call_variant_set_commission_change_rate( pool_id: PoolId, change_rate: CommissionChangeRate<BlockNumberFor<T>>, ) -> Self

Create a call with the variant set_commission_change_rate.

pub fn new_call_variant_claim_commission(pool_id: PoolId) -> Self

Create a call with the variant claim_commission.

pub fn new_call_variant_adjust_pool_deposit(pool_id: PoolId) -> Self

Create a call with the variant adjust_pool_deposit.

pub fn new_call_variant_set_commission_claim_permission( pool_id: PoolId, permission: Option<CommissionClaimPermission<T::AccountId>>, ) -> Self

Create a call with the variant set_commission_claim_permission.

pub fn new_call_variant_apply_slash( member_account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant apply_slash.

pub fn new_call_variant_migrate_delegation( member_account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> Self

Create a call with the variant migrate_delegation.

pub fn new_call_variant_migrate_pool_to_delegate_stake(pool_id: PoolId) -> Self

Create a call with the variant migrate_pool_to_delegate_stake.

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, BondExtra<BalanceOf<T>>: TypeInfo + 'static, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, Vec<T::AccountId>: TypeInfo + 'static, ConfigOp<BalanceOf<T>>: TypeInfo + 'static, ConfigOp<T::AccountId>: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, Option<(Perbill, T::AccountId)>: TypeInfo + 'static, CommissionChangeRate<BlockNumberFor<T>>: TypeInfo + 'static, Option<CommissionClaimPermission<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>