pub struct StorageApi;Implementations§
Source§impl StorageApi
impl StorageApi
Sourcepub fn total_value_locked(
&self,
) -> StaticAddress<(), TotalValueLocked, Yes, Yes, ()>
pub fn total_value_locked( &self, ) -> StaticAddress<(), TotalValueLocked, Yes, Yes, ()>
The sum of funds across all pools.
This might be lower but never higher than the sum of total_balance of all [PoolMembers]
because calling pool_withdraw_unbonded might decrease the total stake of the pool’s
bonded_account without adjusting the pallet-internal UnbondingPool’s.
Sourcepub fn min_join_bond(&self) -> StaticAddress<(), MinJoinBond, Yes, Yes, ()>
pub fn min_join_bond(&self) -> StaticAddress<(), MinJoinBond, Yes, Yes, ()>
Minimum amount to bond to join a pool.
Sourcepub fn min_create_bond(&self) -> StaticAddress<(), MinCreateBond, Yes, Yes, ()>
pub fn min_create_bond(&self) -> StaticAddress<(), MinCreateBond, Yes, Yes, ()>
Minimum bond required to create a pool.
This is the amount that the depositor must put as their initial stake in the pool, as an indication of “skin in the game”.
This is the value that will always exist in the staking ledger of the pool bonded account while all other accounts leave.
Sourcepub fn max_pools(&self) -> StaticAddress<(), MaxPools, Yes, (), ()>
pub fn max_pools(&self) -> StaticAddress<(), MaxPools, Yes, (), ()>
Maximum number of nomination pools that can exist. If None, then an unbounded number of
pools can exist.
Sourcepub fn max_pool_members(&self) -> StaticAddress<(), MaxPoolMembers, Yes, (), ()>
pub fn max_pool_members(&self) -> StaticAddress<(), MaxPoolMembers, Yes, (), ()>
Maximum number of members that can exist in the system. If None, then the count
members are not bound on a system wide basis.
Sourcepub fn max_pool_members_per_pool(
&self,
) -> StaticAddress<(), MaxPoolMembersPerPool, Yes, (), ()>
pub fn max_pool_members_per_pool( &self, ) -> StaticAddress<(), MaxPoolMembersPerPool, Yes, (), ()>
Maximum number of members that may belong to pool. If None, then the count of
members is not bound on a per pool basis.
Sourcepub fn global_max_commission(
&self,
) -> StaticAddress<(), GlobalMaxCommission, Yes, (), ()>
pub fn global_max_commission( &self, ) -> StaticAddress<(), GlobalMaxCommission, Yes, (), ()>
The maximum commission that can be charged by a pool. Used on commission payouts to bound
pool commissions that are > GlobalMaxCommission, necessary if a future
GlobalMaxCommission is lower than some current pool commissions.
Sourcepub fn pool_members_iter(&self) -> StaticAddress<(), PoolMembers, (), (), Yes>
pub fn pool_members_iter(&self) -> StaticAddress<(), PoolMembers, (), (), Yes>
Active members.
TWOX-NOTE: SAFE since AccountId is a secure hash.
Sourcepub fn pool_members(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, PoolMembers, Yes, (), ()>
pub fn pool_members( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, PoolMembers, Yes, (), ()>
Active members.
TWOX-NOTE: SAFE since AccountId is a secure hash.
Sourcepub fn counter_for_pool_members(
&self,
) -> StaticAddress<(), CounterForPoolMembers, Yes, Yes, ()>
pub fn counter_for_pool_members( &self, ) -> StaticAddress<(), CounterForPoolMembers, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn bonded_pools_iter(&self) -> StaticAddress<(), BondedPools, (), (), Yes>
pub fn bonded_pools_iter(&self) -> StaticAddress<(), BondedPools, (), (), Yes>
Storage for bonded pools.
Sourcepub fn bonded_pools(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, BondedPools, Yes, (), ()>
pub fn bonded_pools( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, BondedPools, Yes, (), ()>
Storage for bonded pools.
Sourcepub fn counter_for_bonded_pools(
&self,
) -> StaticAddress<(), CounterForBondedPools, Yes, Yes, ()>
pub fn counter_for_bonded_pools( &self, ) -> StaticAddress<(), CounterForBondedPools, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn reward_pools_iter(&self) -> StaticAddress<(), RewardPools, (), (), Yes>
pub fn reward_pools_iter(&self) -> StaticAddress<(), RewardPools, (), (), Yes>
Reward pools. This is where there rewards for each pool accumulate. When a members payout is claimed, the balance comes out of the reward pool. Keyed by the bonded pools account.
Sourcepub fn reward_pools(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, RewardPools, Yes, (), ()>
pub fn reward_pools( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, RewardPools, Yes, (), ()>
Reward pools. This is where there rewards for each pool accumulate. When a members payout is claimed, the balance comes out of the reward pool. Keyed by the bonded pools account.
Sourcepub fn counter_for_reward_pools(
&self,
) -> StaticAddress<(), CounterForRewardPools, Yes, Yes, ()>
pub fn counter_for_reward_pools( &self, ) -> StaticAddress<(), CounterForRewardPools, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn sub_pools_storage_iter(
&self,
) -> StaticAddress<(), SubPoolsStorage, (), (), Yes>
pub fn sub_pools_storage_iter( &self, ) -> StaticAddress<(), SubPoolsStorage, (), (), Yes>
Groups of unbonding pools. Each group of unbonding pools belongs to a bonded pool, hence the name sub-pools. Keyed by the bonded pools account.
Sourcepub fn sub_pools_storage(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, SubPoolsStorage, Yes, (), ()>
pub fn sub_pools_storage( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, SubPoolsStorage, Yes, (), ()>
Groups of unbonding pools. Each group of unbonding pools belongs to a bonded pool, hence the name sub-pools. Keyed by the bonded pools account.
Sourcepub fn counter_for_sub_pools_storage(
&self,
) -> StaticAddress<(), CounterForSubPoolsStorage, Yes, Yes, ()>
pub fn counter_for_sub_pools_storage( &self, ) -> StaticAddress<(), CounterForSubPoolsStorage, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn metadata_iter(&self) -> StaticAddress<(), Metadata, (), Yes, Yes>
pub fn metadata_iter(&self) -> StaticAddress<(), Metadata, (), Yes, Yes>
Metadata for the pool.
Sourcepub fn metadata(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, Metadata, Yes, Yes, ()>
pub fn metadata( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, Metadata, Yes, Yes, ()>
Metadata for the pool.
Sourcepub fn counter_for_metadata(
&self,
) -> StaticAddress<(), CounterForMetadata, Yes, Yes, ()>
pub fn counter_for_metadata( &self, ) -> StaticAddress<(), CounterForMetadata, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn last_pool_id(&self) -> StaticAddress<(), LastPoolId, Yes, Yes, ()>
pub fn last_pool_id(&self) -> StaticAddress<(), LastPoolId, Yes, Yes, ()>
Ever increasing number of all pools created so far.
Sourcepub fn reverse_pool_id_lookup_iter(
&self,
) -> StaticAddress<(), ReversePoolIdLookup, (), (), Yes>
pub fn reverse_pool_id_lookup_iter( &self, ) -> StaticAddress<(), ReversePoolIdLookup, (), (), Yes>
A reverse lookup from the pool’s account id to its id.
This is only used for slashing and on automatic withdraw update. In all other instances, the pool id is used, and the accounts are deterministically derived from it.
Sourcepub fn reverse_pool_id_lookup(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, ReversePoolIdLookup, Yes, (), ()>
pub fn reverse_pool_id_lookup( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, ReversePoolIdLookup, Yes, (), ()>
A reverse lookup from the pool’s account id to its id.
This is only used for slashing and on automatic withdraw update. In all other instances, the pool id is used, and the accounts are deterministically derived from it.
Sourcepub fn counter_for_reverse_pool_id_lookup(
&self,
) -> StaticAddress<(), CounterForReversePoolIdLookup, Yes, Yes, ()>
pub fn counter_for_reverse_pool_id_lookup( &self, ) -> StaticAddress<(), CounterForReversePoolIdLookup, Yes, Yes, ()>
Counter for the related counted storage map
Sourcepub fn claim_permissions_iter(
&self,
) -> StaticAddress<(), ClaimPermissions, (), Yes, Yes>
pub fn claim_permissions_iter( &self, ) -> StaticAddress<(), ClaimPermissions, (), Yes, Yes>
Map from a pool member account to their opted claim permission.
Sourcepub fn claim_permissions(
&self,
_0: impl Borrow<Param0>,
) -> StaticAddress<StaticStorageKey<Param0>, ClaimPermissions, Yes, Yes, ()>
pub fn claim_permissions( &self, _0: impl Borrow<Param0>, ) -> StaticAddress<StaticStorageKey<Param0>, ClaimPermissions, Yes, Yes, ()>
Map from a pool member account to their opted claim permission.
Auto Trait Implementations§
impl Freeze for StorageApi
impl RefUnwindSafe for StorageApi
impl Send for StorageApi
impl Sync for StorageApi
impl Unpin for StorageApi
impl UnwindSafe for StorageApi
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.