Struct NominationPools 

pub struct NominationPools(/* private fields */);

Builds extrinsics for the nomination_pools pallet.

Many helpers accept MultiAddressLike values and will panic if those cannot be converted into on-chain account identifiers. Constructing the SubmittableTransaction itself does not hit the network; signing or submitting it will.

Implementations

impl NominationPools

pub fn bond_extra(&self, value: BondExtraValue) -> SubmittableTransaction

Contributes additional stake from the pool’s bonded account.

pub fn bond_extra_other( &self, member: impl Into<MultiAddressLike>, value: BondExtraValue, ) -> SubmittableTransaction

Bonds additional stake on behalf of another member.

Panics

Panics if member cannot be converted into a MultiAddress.

pub fn chill(&self, pool_id: u32) -> SubmittableTransaction

Requests the pool to chill its nominations.

pub fn claim_commission(&self, pool_id: u32) -> SubmittableTransaction

Claims pending commission for the given pool.

pub fn claim_payout(&self) -> SubmittableTransaction

Claims a pending payout for the caller.

pub fn claim_payout_other( &self, owner: impl Into<AccountIdLike>, ) -> SubmittableTransaction

Claims a pending payout for another pool member.

Panics

Panics if owner cannot be converted into an AccountId.

pub fn create( &self, amount: u128, root: impl Into<MultiAddressLike>, nominator: impl Into<MultiAddressLike>, bouncer: impl Into<MultiAddressLike>, ) -> SubmittableTransaction

Creates a new nomination pool with freshly provided roles.

Panics

Panics if any of root, nominator, or bouncer cannot be converted into a MultiAddress.

pub fn create_with_pool_id( &self, amount: u128, root: impl Into<MultiAddressLike>, nominator: impl Into<MultiAddressLike>, bouncer: impl Into<MultiAddressLike>, pool_id: u32, ) -> SubmittableTransaction

Creates a new nomination pool using a specific pool identifier.

Panics

Panics if any of root, nominator, or bouncer cannot be converted into a MultiAddress.

pub fn join(&self, amount: u128, pool_id: u32) -> SubmittableTransaction

Joins an existing pool by contributing the requested amount.

pub fn nominate( &self, pool_id: u32, validators: Vec<impl Into<AccountIdLike>>, ) -> SubmittableTransaction

Sets nominations for the pool to a new validator set.

Panics

Panics if any validator identifier cannot be converted into an AccountId.

pub fn set_claim_permission( &self, permission: ClaimPermission, ) -> SubmittableTransaction

Updates who is allowed to claim rewards for the pool.

pub fn set_commission( &self, pool_id: u32, new_commission: Option<(u32, AccountIdLike)>, ) -> SubmittableTransaction

Updates the commission settings for the pool, optionally setting a payee.

Panics

Panics if the payee provided in new_commission cannot be converted into an AccountId.

pub fn set_commission_change_rate( &self, pool_id: u32, max_increase: u32, min_delay: u32, ) -> SubmittableTransaction

Configures how frequently pool commission may change.

pub fn set_commission_max( &self, pool_id: u32, max_commission: u32, ) -> SubmittableTransaction

Caps commission at the provided maximum percentage.

pub fn set_metadata<'a>( &self, pool_id: u32, metadata: impl Into<StringOrBytes<'a>>, ) -> SubmittableTransaction

Updates pool metadata stored on chain.

pub fn set_state( &self, pool_id: u32, state: PoolState, ) -> SubmittableTransaction

Transitions the pool into a new lifecycle state.

pub fn unbond( &self, member_account: impl Into<MultiAddressLike>, unbonding_points: u128, ) -> SubmittableTransaction

Starts the unbonding process for the specified member account.

Panics

Panics if member_account cannot be converted into a MultiAddress.

pub fn update_roles( &self, pool_id: u32, new_root: ConfigOpAccount, new_nominator: ConfigOpAccount, new_bouncer: ConfigOpAccount, ) -> SubmittableTransaction

Updates the pool’s root, nominator, and bouncer roles.

pub fn withdraw_unbonded( &self, member_account: impl Into<MultiAddressLike>, num_slashing_spans: u32, ) -> SubmittableTransaction

Withdraws fully unbonded funds for the given member account.

Panics

Panics if member_account cannot be converted into a MultiAddress.