Skip to main content

Staking

avail_rust_client::transaction_api

Struct Staking 

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

Builds extrinsics for the staking pallet.

Methods that accept AccountIdLike or MultiAddressLike parameters will panic if the provided value cannot be converted into the expected on-chain representation.

Implementations§

Source§

impl Staking

Source

pub fn bond( &self, value: u128, payee: RewardDestination, ) -> SubmittableTransaction

Bonds funds from the controller with the provided reward destination.

§Arguments
  • value - Amount of stake to bond.
  • payee - Destination where rewards should be paid.
§Returns

Returns a SubmittableTransaction that bonds the specified amount.

§Errors

Does not perform network calls; transaction construction never fails.

Source

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

Adds additional stake on top of an existing bond.

§Arguments
  • value - Additional stake to add to the bonded balance.
§Returns

Returns a SubmittableTransaction that increases the bonded amount.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn unbond(&self, value: u128) -> SubmittableTransaction

Starts unbonding the given amount of funds.

§Arguments
  • value - Amount of stake to unbond.
§Returns

Returns a SubmittableTransaction that schedules the unbonding.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn rebond(&self, value: u128) -> SubmittableTransaction

Re-bonds a portion of funds that are currently unbonding.

§Arguments
  • value - Amount of stake to re-bond.
§Returns

Returns a SubmittableTransaction that re-bonds the requested amount.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn validate(&self, commission: u32, blocked: bool) -> SubmittableTransaction

Advertises validator preferences for the caller.

§Arguments
  • commission - Desired commission percentage.
  • blocked - Flag indicating whether new nominations are rejected.
§Returns

Returns a SubmittableTransaction that publishes the validator preferences.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn nominate( &self, targets: Vec<impl Into<MultiAddressLike>>, ) -> SubmittableTransaction

Nominates a new set of validator targets.

§Panics

Panics if any provided target cannot be converted into a MultiAddress.

§Arguments
  • targets - Validators to nominate.
§Returns

Returns a SubmittableTransaction that updates the nomination targets.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn payout_stakers( &self, validator_stash: impl Into<AccountIdLike>, era: u32, ) -> SubmittableTransaction

Pays out staking rewards for the given validator and era.

§Panics

Panics if validator_stash cannot be converted into an AccountId.

§Arguments
  • validator_stash - Stash account whose rewards are claimed.
  • era - Era for which rewards are paid out.
§Returns

Returns a SubmittableTransaction that triggers the payout.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn set_controller(&self) -> SubmittableTransaction

Switches the controller account for the stash.

§Returns

Returns a SubmittableTransaction that sets a new controller (based on the signature).

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn set_payee(&self, payee: RewardDestination) -> SubmittableTransaction

Updates the staking reward destination.

§Arguments
  • payee - Destination where new rewards should be deposited.
§Returns

Returns a SubmittableTransaction that updates the reward destination.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn chill(&self) -> SubmittableTransaction

Stops nominating for the caller.

§Returns

Returns a SubmittableTransaction that chills the caller’s nominations.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn chill_other( &self, stash: impl Into<AccountIdLike>, ) -> SubmittableTransaction

Issues a chill for another stash account.

§Panics

Panics if stash cannot be converted into an AccountId.

§Arguments
  • stash - Stash account to chill.
§Returns

Returns a SubmittableTransaction that chills the specified stash.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn withdraw_unbonded( &self, num_slashing_spans: u32, ) -> SubmittableTransaction

Withdraws funds that have completed the unbonding period.

§Arguments
  • num_slashing_spans - Number of slashing spans to consider when finalising the withdrawal.
§Returns

Returns a SubmittableTransaction that withdraws matured unbonded funds.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn reap_stash( &self, stash: impl Into<AccountIdLike>, num_slashing_spans: u32, ) -> SubmittableTransaction

Removes a stash that no longer has bonded funds.

§Panics

Panics if stash cannot be converted into an AccountId.

§Arguments
  • stash - Stash account to reap.
  • num_slashing_spans - Number of slashing spans considered during reaping.
§Returns

Returns a SubmittableTransaction that reaps the empty stash.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn kick( &self, who: Vec<impl Into<MultiAddressLike>>, ) -> SubmittableTransaction

Removes the provided nominees from the caller’s nomination list.

§Panics

Panics if any identifier in who cannot be converted into a MultiAddress.

§Arguments
  • who - Nominees to remove.
§Returns

Returns a SubmittableTransaction that removes the specified nominees.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn force_apply_min_commission( &self, validator_stash: impl Into<AccountIdLike>, ) -> SubmittableTransaction

Forces the commission for the given validator to the chain minimum.

§Panics

Panics if validator_stash cannot be converted into an AccountId.

§Arguments
  • validator_stash - Stash account whose commission is being forced.
§Returns

Returns a SubmittableTransaction that enforces the minimum commission.

§Errors

Does not perform network calls; transaction construction never fails.

Source

pub fn payout_stakers_by_page( &self, validator_stash: impl Into<AccountIdLike>, era: u32, page: u32, ) -> SubmittableTransaction

Pays out staking rewards for a subset of nominators.

§Panics

Panics if validator_stash cannot be converted into an AccountId.

§Arguments
  • validator_stash - Stash account whose rewards are being claimed.
  • era - Era for which rewards are paid.
  • page - Page index selecting which nominators to payout.
§Returns

Returns a SubmittableTransaction that triggers the paged payout.

§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> ErasedDestructor for T
where T: 'static,

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> JsonSchemaMaybe for T

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: Sized + 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: Sized + 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