NominationPools

avail_rust_client::transaction_api

Struct NominationPools 

Source 
pub struct NominationPools(/* private fields */);
Expand description

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§

Source§

impl NominationPools

Source

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

Contributes additional stake from the pool’s bonded account.

§Arguments
§Returns

Returns a SubmittableTransaction that bonds the extra amount for the pool.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • member - Account that receives the increased bonded amount.
  • value - Amount to bond, expressed as a BondExtraValue.
§Returns

Returns a SubmittableTransaction that bonds extra stake for the specified member.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Requests the pool to chill its nominations.

§Arguments
  • pool_id - Identifier of the pool that should chill.
§Returns

Returns a SubmittableTransaction that issues the chill request.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Claims pending commission for the given pool.

§Arguments
  • pool_id - Identifier of the pool that should pay out commission.
§Returns

Returns a SubmittableTransaction that claims the commission.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn claim_payout(&self) -> SubmittableTransaction

Claims a pending payout for the caller.

§Returns

Returns a SubmittableTransaction that claims unpaid rewards for the signer.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • owner - Account that receives the payout.
§Returns

Returns a SubmittableTransaction that claims unpaid rewards on behalf of owner.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • amount - Initial bonded amount for the pool.
  • root - Root account controlling pool administration.
  • nominator - Account authorised to nominate validators.
  • bouncer - Account that manages membership access.
§Returns

Returns a SubmittableTransaction that creates the pool with the supplied roles.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • amount - Initial bonded amount for the pool.
  • root - Root account controlling pool administration.
  • nominator - Account authorised to nominate validators.
  • bouncer - Account that manages membership access.
  • pool_id - Identifier to assign to the new pool.
§Returns

Returns a SubmittableTransaction that creates the pool with an explicit identifier.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Joins an existing pool by contributing the requested amount.

§Arguments
  • amount - Amount of stake contributed by the caller.
  • pool_id - Identifier of the pool to join.
§Returns

Returns a SubmittableTransaction that adds the caller to the pool.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • pool_id - Identifier of the pool whose nominations are updated.
  • validators - Validators that the pool should nominate.
§Returns

Returns a SubmittableTransaction that updates the pool’s nominations.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Updates who is allowed to claim rewards for the pool.

§Arguments
  • permission - Claim policy applied to the pool.
§Returns

Returns a SubmittableTransaction that adjusts the pool’s claim permission.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • pool_id - Identifier of the pool whose commission is updated.
  • new_commission - Optional tuple of (commission, payee) describing the new rate and payee.
§Returns

Returns a SubmittableTransaction that updates commission settings.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Configures how frequently pool commission may change.

§Arguments
  • pool_id - Identifier of the pool being updated.
  • max_increase - Maximum commission increase allowed per change.
  • min_delay - Minimum number of eras between commission updates.
§Returns

Returns a SubmittableTransaction that applies the new change rate.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Caps commission at the provided maximum percentage.

§Arguments
  • pool_id - Identifier of the pool being updated.
  • max_commission - Maximum commission percentage allowed.
§Returns

Returns a SubmittableTransaction that stores the new commission cap.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Updates pool metadata stored on chain.

§Arguments
  • pool_id - Identifier of the pool being updated.
  • metadata - Metadata payload encoded as bytes or string.
§Returns

Returns a SubmittableTransaction that writes the metadata to storage.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Transitions the pool into a new lifecycle state.

§Arguments
  • pool_id - Identifier of the pool being updated.
  • state - New lifecycle state to apply.
§Returns

Returns a SubmittableTransaction that updates the pool state.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • member_account - Account leaving the pool.
  • unbonding_points - Amount of stake to unbond, expressed in pool points.
§Returns

Returns a SubmittableTransaction that schedules the unbonding.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • pool_id - Identifier of the pool being updated.
  • new_root - Operation describing how to update the root account.
  • new_nominator - Operation describing how to update the nominator account.
  • new_bouncer - Operation describing how to update the bouncer account.
§Returns

Returns a SubmittableTransaction that applies the new role assignments.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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.

§Arguments
  • member_account - Account withdrawing previously unbonded funds.
  • num_slashing_spans - Number of slashing spans to consider when finalising the withdrawal.
§Returns

Returns a SubmittableTransaction that withdraws the unbonded amount.

§Errors

Does not perform network calls; transaction construction never fails.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> JsonSchemaMaybe for T