Struct pallet_nomination_pools::pallet::Pallet
source · pub struct Pallet<T>(/* private fields */);
Expand description
The Pallet
struct, the main type that implements traits and standalone
functions within the pallet.
Implementations§
source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
sourcepub fn join(
origin: OriginFor<T>,
amount: BalanceOf<T>,
pool_id: PoolId,
) -> DispatchResult
pub fn join( origin: OriginFor<T>, amount: BalanceOf<T>, pool_id: PoolId, ) -> DispatchResult
Stake funds with a pool. The amount to bond is transferred from the member to the pool account and immediately increases the pools bond.
The method of transferring the amount to the pool account is determined by
adapter::StakeStrategyType
. If the pool is configured to use
adapter::StakeStrategyType::Delegate
, the funds remain in the account of
the origin
, while the pool gains the right to use these funds for staking.
§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
sourcepub fn bond_extra(
origin: OriginFor<T>,
extra: BondExtra<BalanceOf<T>>,
) -> DispatchResult
pub fn bond_extra( origin: OriginFor<T>, extra: BondExtra<BalanceOf<T>>, ) -> DispatchResult
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.
See bond_extra_other
to bond pending rewards of other
members.
sourcepub fn claim_payout(origin: OriginFor<T>) -> DispatchResult
pub fn claim_payout(origin: OriginFor<T>) -> DispatchResult
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 their 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”.
See claim_payout_other
to claim rewards on behalf of some other
pool member.
sourcepub fn unbond(
origin: OriginFor<T>,
member_account: <<T as Config>::Lookup as StaticLookup>::Source,
unbonding_points: BalanceOf<T>,
) -> DispatchResult
pub fn unbond( origin: OriginFor<T>, member_account: <<T as Config>::Lookup as StaticLookup>::Source, unbonding_points: BalanceOf<T>, ) -> DispatchResult
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 bouncer. 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.
sourcepub fn pool_withdraw_unbonded(
origin: OriginFor<T>,
pool_id: PoolId,
num_slashing_spans: u32,
) -> DispatchResult
pub fn pool_withdraw_unbonded( origin: OriginFor<T>, pool_id: PoolId, num_slashing_spans: u32, ) -> DispatchResult
Call withdraw_unbonded
for the pools account. This call can be made by any account.
This is useful if there 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.
sourcepub fn withdraw_unbonded(
origin: OriginFor<T>,
member_account: <<T as Config>::Lookup as StaticLookup>::Source,
num_slashing_spans: u32,
) -> DispatchResultWithPostInfo
pub fn withdraw_unbonded( origin: OriginFor<T>, member_account: <<T as Config>::Lookup as StaticLookup>::Source, num_slashing_spans: u32, ) -> DispatchResultWithPostInfo
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 bouncer.
§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.
- If the pool has any pending slash, we also try to slash the member before letting them
withdraw. This calculation adds some weight overhead and is only defensive. In reality,
pool slashes must have been already applied via permissionless
Call::apply_slash
.
sourcepub fn create(
origin: OriginFor<T>,
amount: BalanceOf<T>,
root: <<T as Config>::Lookup as StaticLookup>::Source,
nominator: <<T as Config>::Lookup as StaticLookup>::Source,
bouncer: <<T as Config>::Lookup as StaticLookup>::Source,
) -> DispatchResult
pub fn create( origin: OriginFor<T>, amount: BalanceOf<T>, root: <<T as Config>::Lookup as StaticLookup>::Source, nominator: <<T as Config>::Lookup as StaticLookup>::Source, bouncer: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult
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 asPoolRoles::root
.nominator
- The account to set as thePoolRoles::nominator
.bouncer
- The account to set as thePoolRoles::bouncer
.
§Note
In addition to amount
, the caller will transfer the existential deposit; so the caller
needs at have at least amount + existential_deposit
transferable.
sourcepub fn create_with_pool_id(
origin: OriginFor<T>,
amount: BalanceOf<T>,
root: <<T as Config>::Lookup as StaticLookup>::Source,
nominator: <<T as Config>::Lookup as StaticLookup>::Source,
bouncer: <<T as Config>::Lookup as StaticLookup>::Source,
pool_id: PoolId,
) -> DispatchResult
pub fn create_with_pool_id( origin: OriginFor<T>, amount: BalanceOf<T>, root: <<T as Config>::Lookup as StaticLookup>::Source, nominator: <<T as Config>::Lookup as StaticLookup>::Source, bouncer: <<T as Config>::Lookup as StaticLookup>::Source, pool_id: PoolId, ) -> DispatchResult
Create a new delegation pool with a previously used pool id
§Arguments
same as create
with the inclusion of
pool_id
- `A valid PoolId.
sourcepub fn nominate(
origin: OriginFor<T>,
pool_id: PoolId,
validators: Vec<T::AccountId>,
) -> DispatchResult
pub fn nominate( origin: OriginFor<T>, pool_id: PoolId, validators: Vec<T::AccountId>, ) -> DispatchResult
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.
§Note
In addition to a root
or nominator
role of origin
, pool’s depositor needs to have
at least depositor_min_bond
in the pool to start nominating.
sourcepub fn set_state(
origin: OriginFor<T>,
pool_id: PoolId,
state: PoolState,
) -> DispatchResult
pub fn set_state( origin: OriginFor<T>, pool_id: PoolId, state: PoolState, ) -> DispatchResult
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:
- signed by the bouncer, or the root role of the pool,
- 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 toDestroying
.
sourcepub fn set_metadata(
origin: OriginFor<T>,
pool_id: PoolId,
metadata: Vec<u8>,
) -> DispatchResult
pub fn set_metadata( origin: OriginFor<T>, pool_id: PoolId, metadata: Vec<u8>, ) -> DispatchResult
Set a new metadata for the pool.
The dispatch origin of this call must be signed by the bouncer, or the root role of the pool.
sourcepub fn set_configs(
origin: OriginFor<T>,
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>,
global_max_commission: ConfigOp<Perbill>,
) -> DispatchResult
pub fn set_configs( origin: OriginFor<T>, 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>, global_max_commission: ConfigOp<Perbill>, ) -> DispatchResult
Update configurations for the nomination pools. The origin for this call must be
Config::AdminOrigin
.
§Arguments
min_join_bond
- SetMinJoinBond
.min_create_bond
- SetMinCreateBond
.max_pools
- SetMaxPools
.max_members
- SetMaxPoolMembers
.max_members_per_pool
- SetMaxPoolMembersPerPool
.global_max_commission
- SetGlobalMaxCommission
.
sourcepub fn update_roles(
origin: OriginFor<T>,
pool_id: PoolId,
new_root: ConfigOp<T::AccountId>,
new_nominator: ConfigOp<T::AccountId>,
new_bouncer: ConfigOp<T::AccountId>,
) -> DispatchResult
pub fn update_roles( origin: OriginFor<T>, pool_id: PoolId, new_root: ConfigOp<T::AccountId>, new_nominator: ConfigOp<T::AccountId>, new_bouncer: ConfigOp<T::AccountId>, ) -> DispatchResult
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.
sourcepub fn chill(origin: OriginFor<T>, pool_id: PoolId) -> DispatchResult
pub fn chill(origin: OriginFor<T>, pool_id: PoolId) -> DispatchResult
Chill on behalf of the pool.
The dispatch origin of this call can be signed by the pool nominator or the pool
root role, same as Pallet::nominate
.
Under certain conditions, this call can be dispatched permissionlessly (i.e. by any account).
§Conditions for a permissionless dispatch:
- When pool depositor has less than
MinNominatorBond
staked, otherwise pool members are unable to unbond.
§Conditions for permissioned dispatch:
- The caller has a nominator or root role of the pool. This directly forward the call to the staking pallet, on behalf of the pool bonded account.
sourcepub fn bond_extra_other(
origin: OriginFor<T>,
member: <<T as Config>::Lookup as StaticLookup>::Source,
extra: BondExtra<BalanceOf<T>>,
) -> DispatchResult
pub fn bond_extra_other( origin: OriginFor<T>, member: <<T as Config>::Lookup as StaticLookup>::Source, extra: BondExtra<BalanceOf<T>>, ) -> DispatchResult
origin
bonds funds from extra
for some pool member member
into their respective
pools.
origin
can bond extra funds from free balance or pending rewards when origin == other
.
In the case of origin != other
, origin
can only bond extra pending rewards of
other
members assuming set_claim_permission for the given member is
PermissionlessCompound
or PermissionlessAll
.
sourcepub fn set_claim_permission(
origin: OriginFor<T>,
permission: ClaimPermission,
) -> DispatchResult
pub fn set_claim_permission( origin: OriginFor<T>, permission: ClaimPermission, ) -> DispatchResult
Allows a pool member to set a claim permission to allow or disallow permissionless bonding and withdrawing.
§Arguments
origin
- Member of a pool.permission
- The permission to be applied.
sourcepub fn claim_payout_other(
origin: OriginFor<T>,
other: T::AccountId,
) -> DispatchResult
pub fn claim_payout_other( origin: OriginFor<T>, other: T::AccountId, ) -> DispatchResult
origin
can claim payouts on some pool member other
’s behalf.
Pool member other
must have a PermissionlessWithdraw
or PermissionlessAll
claim
permission for this call to be successful.
sourcepub fn set_commission(
origin: OriginFor<T>,
pool_id: PoolId,
new_commission: Option<(Perbill, T::AccountId)>,
) -> DispatchResult
pub fn set_commission( origin: OriginFor<T>, pool_id: PoolId, new_commission: Option<(Perbill, T::AccountId)>, ) -> DispatchResult
Set the commission of a pool.
Both a commission percentage and a commission payee must be provided in the current
tuple. Where a current
of None
is provided, any current commission will be removed.
- If a
None
is supplied tonew_commission
, existing commission will be removed.
sourcepub fn set_commission_max(
origin: OriginFor<T>,
pool_id: PoolId,
max_commission: Perbill,
) -> DispatchResult
pub fn set_commission_max( origin: OriginFor<T>, pool_id: PoolId, max_commission: Perbill, ) -> DispatchResult
Set the maximum commission of a pool.
- Initial max can be set to any
Perbill
, and only smaller values thereafter. - Current commission will be lowered in the event it is higher than a new max commission.
sourcepub fn set_commission_change_rate(
origin: OriginFor<T>,
pool_id: PoolId,
change_rate: CommissionChangeRate<BlockNumberFor<T>>,
) -> DispatchResult
pub fn set_commission_change_rate( origin: OriginFor<T>, pool_id: PoolId, change_rate: CommissionChangeRate<BlockNumberFor<T>>, ) -> DispatchResult
Set the commission change rate for a pool.
Initial change rate is not bounded, whereas subsequent updates can only be more restrictive than the current.
sourcepub fn claim_commission(origin: OriginFor<T>, pool_id: PoolId) -> DispatchResult
pub fn claim_commission(origin: OriginFor<T>, pool_id: PoolId) -> DispatchResult
Claim pending commission.
The dispatch origin of this call must be signed by the root
role of the pool. Pending
commission is paid out and added to total claimed commission`. Total pending commission
is reset to zero. the current.
sourcepub fn adjust_pool_deposit(
origin: OriginFor<T>,
pool_id: PoolId,
) -> DispatchResult
pub fn adjust_pool_deposit( origin: OriginFor<T>, pool_id: PoolId, ) -> DispatchResult
Top up the deficit or withdraw the excess ED from the pool.
When a pool is created, the pool depositor transfers ED to the reward account of the pool. ED is subject to change and over time, the deposit in the reward account may be insufficient to cover the ED deficit of the pool or vice-versa where there is excess deposit to the pool. This call allows anyone to adjust the ED deposit of the pool by either topping up the deficit or claiming the excess.
sourcepub fn set_commission_claim_permission(
origin: OriginFor<T>,
pool_id: PoolId,
permission: Option<CommissionClaimPermission<T::AccountId>>,
) -> DispatchResult
pub fn set_commission_claim_permission( origin: OriginFor<T>, pool_id: PoolId, permission: Option<CommissionClaimPermission<T::AccountId>>, ) -> DispatchResult
Set or remove a pool’s commission claim permission.
Determines who can claim the pool’s pending commission. Only the Root
role of the pool
is able to configure commission claim permissions.
sourcepub fn apply_slash(
origin: OriginFor<T>,
member_account: <<T as Config>::Lookup as StaticLookup>::Source,
) -> DispatchResultWithPostInfo
pub fn apply_slash( origin: OriginFor<T>, member_account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResultWithPostInfo
Apply a pending slash on a member.
Fails unless crate::pallet::Config::StakeAdapter
is of strategy type:
adapter::StakeStrategyType::Delegate
.
This call can be dispatched permissionlessly (i.e. by any account). If the member has slash to be applied, caller may be rewarded with the part of the slash.
sourcepub fn migrate_delegation(
origin: OriginFor<T>,
member_account: <<T as Config>::Lookup as StaticLookup>::Source,
) -> DispatchResultWithPostInfo
pub fn migrate_delegation( origin: OriginFor<T>, member_account: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResultWithPostInfo
Migrates delegated funds from the pool account to the member_account
.
Fails unless crate::pallet::Config::StakeAdapter
is of strategy type:
adapter::StakeStrategyType::Delegate
.
This is a permission-less call and refunds any fee if claim is successful.
If the pool has migrated to delegation based staking, the staked tokens of pool members
can be moved and held in their own account. See adapter::DelegateStake
sourcepub fn migrate_pool_to_delegate_stake(
origin: OriginFor<T>,
pool_id: PoolId,
) -> DispatchResultWithPostInfo
pub fn migrate_pool_to_delegate_stake( origin: OriginFor<T>, pool_id: PoolId, ) -> DispatchResultWithPostInfo
Migrate pool from adapter::StakeStrategyType::Transfer
to
adapter::StakeStrategyType::Delegate
.
Fails unless crate::pallet::Config::StakeAdapter
is of strategy type:
adapter::StakeStrategyType::Delegate
.
This call can be dispatched permissionlessly, and refunds any fee if successful.
If the pool has already migrated to delegation based staking, this call will fail.
source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
sourcepub fn depositor_min_bond() -> BalanceOf<T>
pub fn depositor_min_bond() -> BalanceOf<T>
The amount of bond that MUST REMAIN IN BONDED in ALL POOLS.
It is the responsibility of the depositor to put these funds into the pool initially. Upon unbond, they can never unbond to a value below this amount.
It is essentially max { MinNominatorBond, MinCreateBond, MinJoinBond }
, where the former
is coming from the staking pallet and the latter two are configured in this pallet.
sourcepub fn dissolve_pool(bonded_pool: BondedPool<T>)
pub fn dissolve_pool(bonded_pool: BondedPool<T>)
Remove everything related to the given bonded pool.
Metadata and all of the sub-pools are also deleted. All accounts are dusted and the leftover of the reward account is returned to the depositor.
sourcepub fn generate_bonded_account(id: PoolId) -> T::AccountId
pub fn generate_bonded_account(id: PoolId) -> T::AccountId
Create the main, bonded account of a pool with the given id.
sourcepub fn generate_reward_account(id: PoolId) -> T::AccountId
pub fn generate_reward_account(id: PoolId) -> T::AccountId
Create the reward account of a pool with the given id.
sourcepub fn unfreeze_pool_deposit(reward_acc: &T::AccountId) -> DispatchResult
pub fn unfreeze_pool_deposit(reward_acc: &T::AccountId) -> DispatchResult
Removes the ED freeze on the reward account of pool_id
.
sourcepub fn do_try_state(level: u8) -> Result<(), TryRuntimeError>
pub fn do_try_state(level: u8) -> Result<(), TryRuntimeError>
Ensure the correctness of the state of this pallet.
This should be valid before or after each state transition of this pallet.
§Invariants:
First, let’s consider pools:
BondedPools
andRewardPools
must all have the EXACT SAME key-set.SubPoolsStorage
must be a subset of the above superset.Metadata
keys must be a subset of the above superset.- the count of the above set must be less than
MaxPools
.
Then, considering members as well:
- each
BondedPool.member_counter
must be:- correct (compared to actual count of member who have
.pool_id
this pool) - less than
MaxPoolMembersPerPool
.
- correct (compared to actual count of member who have
- each
member.pool_id
must correspond to an existingBondedPool.id
(which implies the existence of the reward pool as well). - count of all members must be less than
MaxPoolMembers
. - each
BondedPool.points
must never be lower than the pool’s balance.
Then, considering unbonding members:
for each pool:
- sum of the balance that’s tracked in all unbonding pools must be the same as the unbonded balance of the main account, as reported by the staking interface.
- sum of the balance that’s tracked in all unbonding pools, plus the bonded balance of the main account should be less than or qual to the total balance of the main account.
§Sanity check level
To cater for tests that want to escape parts of these checks, this function is split into
multiple level
s, where the higher the level, the more checks we performs. So,
try_state(255)
is the strongest sanity check, and 0
performs no checks.
sourcepub fn check_ed_imbalance() -> Result<(), DispatchError>
pub fn check_ed_imbalance() -> Result<(), DispatchError>
Check if any pool have an incorrect amount of ED frozen.
This can happen if the ED has changed since the pool was created.
sourcepub fn fully_unbond(
origin: OriginFor<T>,
member: T::AccountId,
) -> DispatchResult
pub fn fully_unbond( origin: OriginFor<T>, member: T::AccountId, ) -> DispatchResult
Fully unbond the shares of member
, when executed from origin
.
This is useful for backwards compatibility with the majority of tests that only deal with full unbonding, not partial unbonding.
source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
sourcepub fn api_pending_rewards(who: T::AccountId) -> Option<BalanceOf<T>>
pub fn api_pending_rewards(who: T::AccountId) -> Option<BalanceOf<T>>
Returns the pending rewards for the specified who
account.
In the case of error, None
is returned. Used by runtime API.
sourcepub fn api_points_to_balance(
pool_id: PoolId,
points: BalanceOf<T>,
) -> BalanceOf<T>
pub fn api_points_to_balance( pool_id: PoolId, points: BalanceOf<T>, ) -> BalanceOf<T>
Returns the points to balance conversion for a specified pool.
If the pool ID does not exist, it returns 0 ratio points to balance. Used by runtime API.
sourcepub fn api_balance_to_points(
pool_id: PoolId,
new_funds: BalanceOf<T>,
) -> BalanceOf<T>
pub fn api_balance_to_points( pool_id: PoolId, new_funds: BalanceOf<T>, ) -> BalanceOf<T>
Returns the equivalent new_funds
balance to point conversion for a specified pool.
If the pool ID does not exist, returns 0 ratio balance to points. Used by runtime API.
sourcepub fn api_pool_pending_slash(pool_id: PoolId) -> BalanceOf<T>
pub fn api_pool_pending_slash(pool_id: PoolId) -> BalanceOf<T>
Returns the unapplied slash of the pool.
Pending slash is only applicable with adapter::DelegateStake
strategy.
sourcepub fn api_member_pending_slash(who: T::AccountId) -> BalanceOf<T>
pub fn api_member_pending_slash(who: T::AccountId) -> BalanceOf<T>
Returns the unapplied slash of a member.
Pending slash is only applicable with adapter::DelegateStake
strategy.
sourcepub fn api_pool_needs_delegate_migration(pool_id: PoolId) -> bool
pub fn api_pool_needs_delegate_migration(pool_id: PoolId) -> bool
Checks whether pool needs to be migrated to adapter::StakeStrategyType::Delegate
. Only
applicable when the Config::StakeAdapter
is adapter::DelegateStake
.
Useful to check this before calling Call::migrate_pool_to_delegate_stake
.
sourcepub fn api_member_needs_delegate_migration(who: T::AccountId) -> bool
pub fn api_member_needs_delegate_migration(who: T::AccountId) -> bool
Checks whether member delegation needs to be migrated to
adapter::StakeStrategyType::Delegate
. Only applicable when the Config::StakeAdapter
is adapter::DelegateStake
.
Useful to check this before calling Call::migrate_delegation
.
sourcepub fn api_member_total_balance(who: T::AccountId) -> BalanceOf<T>
pub fn api_member_total_balance(who: T::AccountId) -> BalanceOf<T>
Contribution of the member in the pool.
Includes balance that is unbonded from staking but not claimed yet from the pool, therefore this balance can be higher than the staked funds.
sourcepub fn api_pool_balance(pool_id: PoolId) -> BalanceOf<T>
pub fn api_pool_balance(pool_id: PoolId) -> BalanceOf<T>
Total balance contributed to the pool.
Trait Implementations§
source§impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
source§fn before_all_runtime_migrations() -> Weight
fn before_all_runtime_migrations() -> Weight
source§impl<T: Config> GetStorageVersion for Pallet<T>
impl<T: Config> GetStorageVersion for Pallet<T>
§type InCodeStorageVersion = StorageVersion
type InCodeStorageVersion = StorageVersion
source§fn in_code_storage_version() -> Self::InCodeStorageVersion
fn in_code_storage_version() -> Self::InCodeStorageVersion
storage_version
attribute, or
[NoStorageVersionSet
] if the attribute is missing.source§fn on_chain_storage_version() -> StorageVersion
fn on_chain_storage_version() -> StorageVersion
§fn current_storage_version() -> Self::InCodeStorageVersion
fn current_storage_version() -> Self::InCodeStorageVersion
in_code_storage_version
and will be removed after March 2024.Self::current_storage_version
] instead. Read moresource§impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>
fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>
source§fn integrity_test()
fn integrity_test()
§fn on_initialize(_n: BlockNumber) -> Weight
fn on_initialize(_n: BlockNumber) -> Weight
§fn on_finalize(_n: BlockNumber)
fn on_finalize(_n: BlockNumber)
§fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
Hooks::on_finalize
]). Read more§fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)
fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)
§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Executive
pallet. Read more§fn pre_upgrade() -> Result<Vec<u8>, DispatchError>
fn pre_upgrade() -> Result<Vec<u8>, DispatchError>
§fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>
fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>
§fn offchain_worker(_n: BlockNumber)
fn offchain_worker(_n: BlockNumber)
source§impl<T: Config> IntegrityTest for Pallet<T>
impl<T: Config> IntegrityTest for Pallet<T>
source§fn integrity_test()
fn integrity_test()
Hooks::integrity_test
].source§impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn offchain_worker(n: BlockNumberFor<T>)
fn offchain_worker(n: BlockNumberFor<T>)
source§impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_finalize(n: BlockNumberFor<T>)
fn on_finalize(n: BlockNumberFor<T>)
Hooks::on_finalize
].source§impl<T: Config> OnGenesis for Pallet<T>
impl<T: Config> OnGenesis for Pallet<T>
source§fn on_genesis()
fn on_genesis()
source§impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_initialize(n: BlockNumberFor<T>) -> Weight
fn on_initialize(n: BlockNumberFor<T>) -> Weight
Hooks::on_initialize
].source§impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§impl<T: Config> OnRuntimeUpgrade for Pallet<T>
impl<T: Config> OnRuntimeUpgrade for Pallet<T>
source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Hooks::on_runtime_upgrade
].§fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
pre_upgrade
->
on_runtime_upgrade
-> post_upgrade
hooks for a migration. Read moresource§impl<T: Config> OnStakingUpdate<<T as Config>::AccountId, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance> for Pallet<T>
impl<T: Config> OnStakingUpdate<<T as Config>::AccountId, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance> for Pallet<T>
source§fn on_slash(
pool_account: &T::AccountId,
slashed_bonded: BalanceOf<T>,
slashed_unlocking: &BTreeMap<EraIndex, BalanceOf<T>>,
total_slashed: BalanceOf<T>,
)
fn on_slash( pool_account: &T::AccountId, slashed_bonded: BalanceOf<T>, slashed_unlocking: &BTreeMap<EraIndex, BalanceOf<T>>, total_slashed: BalanceOf<T>, )
Reduces the balances of the SubPools
, that belong to the pool involved in the
slash, to the amount that is defined in the slashed_unlocking
field of
[sp_staking::OnStakingUpdate::on_slash
]
Emits the PoolsSlashed
event.
source§fn on_withdraw(pool_account: &T::AccountId, amount: BalanceOf<T>)
fn on_withdraw(pool_account: &T::AccountId, amount: BalanceOf<T>)
Reduces the overall TotalValueLocked
if a withdrawal happened for a pool involved in the
staking withdraw.
§fn on_stake_update(_who: &AccountId, _prev_stake: Option<Stake<Balance>>)
fn on_stake_update(_who: &AccountId, _prev_stake: Option<Stake<Balance>>)
§fn on_nominator_add(_who: &AccountId)
fn on_nominator_add(_who: &AccountId)
§fn on_nominator_update(_who: &AccountId, _prev_nominations: Vec<AccountId>)
fn on_nominator_update(_who: &AccountId, _prev_nominations: Vec<AccountId>)
§fn on_nominator_remove(_who: &AccountId, _nominations: Vec<AccountId>)
fn on_nominator_remove(_who: &AccountId, _nominations: Vec<AccountId>)
§fn on_validator_add(_who: &AccountId)
fn on_validator_add(_who: &AccountId)
§fn on_validator_update(_who: &AccountId)
fn on_validator_update(_who: &AccountId)
§fn on_validator_remove(_who: &AccountId)
fn on_validator_remove(_who: &AccountId)
§fn on_unstake(_who: &AccountId)
fn on_unstake(_who: &AccountId)
source§impl<T: Config> PalletInfoAccess for Pallet<T>
impl<T: Config> PalletInfoAccess for Pallet<T>
source§fn module_name() -> &'static str
fn module_name() -> &'static str
source§fn crate_version() -> CrateVersion
fn crate_version() -> CrateVersion
source§impl<T> PartialEq for Pallet<T>
impl<T> PartialEq for Pallet<T>
source§impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§impl<T: Config> WhitelistedStorageKeys for Pallet<T>
impl<T: Config> WhitelistedStorageKeys for Pallet<T>
source§fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
Vec<TrackedStorageKey>
indicating the storage keys that
should be whitelisted during benchmarking. This means that those keys
will be excluded from the benchmarking performance calculation.impl<T> Eq for Pallet<T>
Auto Trait Implementations§
impl<T> Freeze for Pallet<T>
impl<T> RefUnwindSafe for Pallet<T>where
T: RefUnwindSafe,
impl<T> Send for Pallet<T>where
T: Send,
impl<T> Sync for Pallet<T>where
T: Sync,
impl<T> Unpin for Pallet<T>where
T: Unpin,
impl<T> UnwindSafe for Pallet<T>where
T: UnwindSafe,
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
§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§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.§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.§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.§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.§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.§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.§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.§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.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> IsType<T> for T
impl<T> IsType<T> for T
§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§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 more§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 more§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
§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
§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.§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.§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.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T
. Read more§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§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 more§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 more§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 more§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 more§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 more§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 more§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.§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.§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.§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.§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.§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.§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.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
type Error = <U as TryFromKey<T>>::Error
fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.