Runtime Modules / NominationPools
Spec Version:
Call Functions
Name | Lookup | Parameters | |
|---|---|---|---|
| join | 1200 | 2 | |
| bond_extra | 1201 | 1 | |
| claim_payout | 1202 | - | |
| unbond | 1203 | 2 | |
| pool_withdraw_unbonded | 1204 | 2 | |
| withdraw_unbonded | 1205 | 2 | |
| create | 1206 | 4 | |
| create_with_pool_id | 1207 | 5 | |
| nominate | 1208 | 2 | |
| set_state | 1209 | 2 | |
| set_metadata | 120a | 2 | |
| set_configs | 120b | 6 | |
| update_roles | 120c | 4 | |
| chill | 120d | 1 | |
| bond_extra_other | 120e | 2 | |
| set_claim_permission | 120f | 1 | |
| claim_payout_other | 1210 | 1 | |
| set_commission | 1211 | 2 | |
| set_commission_max | 1212 | 2 | |
| set_commission_change_rate | 1213 | 2 | |
| claim_commission | 1214 | 1 |
Events
Name | Lookup | Attributes | |
|---|---|---|---|
| Created | 1200 | ["AccountId","PoolId"] | |
| Bonded | 1201 | ["AccountId","PoolId","BalanceOf","bool"] | |
| PaidOut | 1202 | ["AccountId","PoolId","BalanceOf"] | |
| Unbonded | 1203 | ["AccountId","PoolId","BalanceOf","BalanceOf","EraIndex"] | |
| Withdrawn | 1204 | ["AccountId","PoolId","BalanceOf","BalanceOf"] | |
| Destroyed | 1205 | ["PoolId"] | |
| StateChanged | 1206 | ["PoolId","PoolState"] | |
| MemberRemoved | 1207 | ["PoolId","AccountId"] | |
| RolesUpdated | 1208 | ["Option<AccountId>","Option<AccountId>","Option<AccountId>"] | |
| PoolSlashed | 1209 | ["PoolId","BalanceOf"] | |
| UnbondingPoolSlashed | 120a | ["PoolId","EraIndex","BalanceOf"] | |
| PoolCommissionUpdated | 120b | ["PoolId","Option<(Perbill, AccountId)>"] | |
| PoolMaxCommissionUpdated | 120c | ["PoolId","Perbill"] | |
| PoolCommissionChangeRateUpdated | 120d | ["PoolId","CommissionChangeRate<BlockNumberFor>"] | |
| PoolCommissionClaimed | 120e | ["PoolId","BalanceOf"] |
Storage Functions
Name | Type | |
|---|---|---|
| MinJoinBond | {"origin":"PlainType","plain_type":"U128","PlainTypeValue":6} | |
| MinCreateBond | {"origin":"PlainType","plain_type":"U128","PlainTypeValue":6} | |
| MaxPools | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| MaxPoolMembers | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| MaxPoolMembersPerPool | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| GlobalMaxCommission | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":33} | |
| PoolMembers | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["AccountId"],"value":"pallet_nomination_pools:PoolMember","keys_id":0,"value_id":330}} | |
| CounterForPoolMembers | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| BondedPools | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["U32"],"value":"pallet_nomination_pools:BondedPoolInner","keys_id":4,"value_id":335}} | |
| CounterForBondedPools | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| RewardPools | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["U32"],"value":"pallet_nomination_pools:RewardPool","keys_id":4,"value_id":340}} | |
| CounterForRewardPools | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| SubPoolsStorage | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["U32"],"value":"pallet_nomination_pools:SubPools","keys_id":4,"value_id":341}} | |
| CounterForSubPoolsStorage | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| Metadata | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["U32"],"value":"Vec<U8>","keys_id":4,"value_id":347}} | |
| CounterForMetadata | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| LastPoolId | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| ReversePoolIdLookup | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["AccountId"],"value":"U32","keys_id":0,"value_id":4}} | |
| CounterForReversePoolIdLookup | {"origin":"PlainType","plain_type":"U32","PlainTypeValue":4} | |
| ClaimPermissions | {"origin":"Map","n_map_type":{"hashers":["Twox64Concat"],"key_vec":["AccountId"],"value":"pallet_nomination_pools:ClaimPermission","keys_id":0,"value_id":285}} |
Constants
Name | Type | Value | |
|---|---|---|---|
| PalletId | [U8; 8] | 6374636e6f706c73 | |
| MaxPointsToBalance | U8 | 64 |
Error Types
Name | Docs |
|---|---|
| PoolNotFound | A (bonded) pool id does not exist. |
| PoolMemberNotFound | An account is not a member. |
| RewardPoolNotFound | A reward pool does not exist. In all cases this is a system logic error. |
| SubPoolsNotFound | A sub pool does not exist. |
| AccountBelongsToOtherPool | An account is already delegating in another pool. An account may only belong to onepool at a time. |
| FullyUnbonding | The member is fully unbonded (and thus cannot access the bonded and reward poolanymore to, for example, collect rewards). |
| MaxUnbondingLimit | The member cannot unbond further chunks due to reaching the limit. |
| CannotWithdrawAny | None of the funds can be withdrawn yet because the bonding duration has not passed. |
| MinimumBondNotMet | The amount does not meet the minimum bond to either join or create a pool.The depositor can never unbond to a value less than`Pallet::depositor_min_bond`. The caller does not have nominatingpermissions for the pool. Members can never unbond to a value below `MinJoinBond`. |
| OverflowRisk | The transaction could not be executed due to overflow risk for the pool. |
| NotDestroying | A pool must be in [`PoolState::Destroying`] in order for the depositor to unbond or forother members to be permissionlessly unbonded. |
| NotNominator | The caller does not have nominating permissions for the pool. |
| NotKickerOrDestroying | Either a) the caller cannot make a valid kick or b) the pool is not destroying. |
| NotOpen | The pool is not open to join |
| MaxPools | The system is maxed out on pools. |
| MaxPoolMembers | Too many members in the pool or system. |
| CanNotChangeState | The pools state cannot be changed. |
| DoesNotHavePermission | The caller does not have adequate permissions. |
| MetadataExceedsMaxLen | Metadata exceeds [`Config::MaxMetadataLen`] |
| Defensive | Some error occurred that should never happen. This should be reported to themaintainers. |
| PartialUnbondNotAllowedPermissionlessly | Partial unbonding now allowed permissionlessly. |
| MaxCommissionRestricted | The pool's max commission cannot be set higher than the existing value. |
| CommissionExceedsMaximum | The supplied commission exceeds the max allowed commission. |
| CommissionExceedsGlobalMaximum | The supplied commission exceeds global maximum commission. |
| CommissionChangeThrottled | Not enough blocks have surpassed since the last commission update. |
| CommissionChangeRateNotAllowed | The submitted changes to commission change rate are not allowed. |
| NoPendingCommission | There is no pending commission to claim. |
| NoCommissionCurrentSet | No commission current has been set. |
| PoolIdInUse | Pool id currently in use. |
| InvalidPoolId | Pool id provided is not correct/usable. |
| BondExtraRestricted | Bonding extra is restricted to the exact pending reward amount. |