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,
        state_toggler: <<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,
        state_toggler: <<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>,
    },
    update_roles {
        pool_id: PoolId,
        new_root: ConfigOp<T::AccountId>,
        new_nominator: ConfigOp<T::AccountId>,
        new_state_toggler: ConfigOp<T::AccountId>,
    },
    chill {
        pool_id: PoolId,
    },
    // some variants omitted
}

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

Variants

join

Fields

amount: BalanceOf<T>

pool_id: PoolId

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

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

bond_extra

Fields

extra: BondExtra<BalanceOf<T>>

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.

claim_payout

Fields

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 there 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”.

unbond

Fields

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

unbonding_points: BalanceOf<T>

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 state-toggler. 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.

pool_withdraw_unbonded

Fields

pool_id: PoolId

num_slashing_spans: u32

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

This is useful if their 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.

withdraw_unbonded

Fields

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

num_slashing_spans: u32

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 state-toggler.

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.

create

Fields

amount: BalanceOf<T>

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

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

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

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.
• state_toggler - The account to set as the PoolRoles::state_toggler.

Note

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

create_with_pool_id

Fields

amount: BalanceOf<T>

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

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

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

pool_id: PoolId

Create a new delegation pool with a previously used pool id

Arguments

same as create with the inclusion of

• pool_id - `A valid PoolId.

nominate

Fields

pool_id: PoolId

validators: Vec<T::AccountId>

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.

set_state

Fields

pool_id: PoolId

state: PoolState

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 state toggler, 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.

set_metadata

Fields

pool_id: PoolId

metadata: Vec<u8>

Set a new metadata for the pool.

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

set_configs

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>

Update configurations for the nomination pools. The origin for this call must be Root.

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.

update_roles

Fields

pool_id: PoolId

new_root: ConfigOp<T::AccountId>

new_nominator: ConfigOp<T::AccountId>

new_state_toggler: ConfigOp<T::AccountId>

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.

chill

Fields

pool_id: PoolId

Chill on behalf of the pool.

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

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

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, state_toggler: <<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, state_toggler: <<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> ) -> 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_state_toggler: 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.

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) -> Rwhere 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> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

👎Deprecated: Trait has moved to frame_support::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 !=. 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: 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<Call<T>> for Call<T>

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