@polkadot/api-augment 8.4.3-5 → 8.5.1

package/cjs/packageInfo.js

@@ -11,6 +11,6 @@ const packageInfo = {
   name: '@polkadot/api-augment',
   path: typeof __dirname === 'string' ? __dirname : 'auto',
   type: 'cjs',
-  version: '8.4.3-5'
+  version: '8.5.1'
 };
 exports.packageInfo = packageInfo;

package/kusama/consts.d.ts

@@ -59,58 +59,6 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
-        bagsList: {
-            /**
-             * The list of thresholds separating the various bags.
-             *
-             * Ids are separated into unsorted bags according to their score. This specifies the
-             * thresholds separating the bags. An id's bag is the largest bag for which the id's score
-             * is less than or equal to its upper threshold.
-             *
-             * When ids are iterated, higher bags are iterated completely before lower bags. This means
-             * that iteration is _semi-sorted_: ids of higher score tend to come before ids of lower
-             * score, but peer ids within a particular bag are sorted in insertion order.
-             *
-             * # Expressing the constant
-             *
-             * This constant must be sorted in strictly increasing order. Duplicate items are not
-             * permitted.
-             *
-             * There is an implied upper limit of `Score::MAX`; that value does not need to be
-             * specified within the bag. For any two threshold lists, if one ends with
-             * `Score::MAX`, the other one does not, and they are otherwise equal, the two
-             * lists will behave identically.
-             *
-             * # Calculation
-             *
-             * It is recommended to generate the set of thresholds in a geometric series, such that
-             * there exists some constant ratio such that `threshold[k + 1] == (threshold[k] *
-             * constant_ratio).max(threshold[k] + 1)` for all `k`.
-             *
-             * The helpers in the `/utils/frame/generate-bags` module can simplify this calculation.
-             *
-             * # Examples
-             *
-             * - If `BagThresholds::get().is_empty()`, then all ids are put into the same bag, and
-             * iteration is strictly in insertion order.
-             * - If `BagThresholds::get().len() == 64`, and the thresholds are determined according to
-             * the procedure given above, then the constant ratio is equal to 2.
-             * - If `BagThresholds::get().len() == 200`, and the thresholds are determined according to
-             * the procedure given above, then the constant ratio is approximately equal to 1.248.
-             * - If the threshold list begins `[1, 2, 3, ...]`, then an id with score 0 or 1 will fall
-             * into bag 0, an id with score 2 will fall into bag 1, etc.
-             *
-             * # Migration
-             *
-             * In the event that this list ever changes, a copy of the old bags list must be retained.
-             * With that `List::migrate` can be called, which will perform the appropriate migration.
-             **/
-            bagThresholds: Vec<u64> & AugmentedConst<ApiType>;
-            /**
-             * Generic const
-             **/
-            [key: string]: Codec;
-        };
         balances: {
             /**
              * The minimum amount required to keep an account open.
@@ -300,20 +248,6 @@ declare module '@polkadot/api-base/types/consts' {
              * take place over multiple blocks.
              **/
             maxElectingVoters: u32 & AugmentedConst<ApiType>;
-            /**
-             * Maximum length (bytes) that the mined solution should consume.
-             *
-             * The miner will ensure that the total length of the unsigned solution will not exceed
-             * this value.
-             **/
-            minerMaxLength: u32 & AugmentedConst<ApiType>;
-            /**
-             * Maximum weight that the miner should consume.
-             *
-             * The miner will ensure that the total weight of the unsigned solution will not exceed
-             * this value, based on [`WeightInfo::submit_unsigned`].
-             **/
-            minerMaxWeight: u64 & AugmentedConst<ApiType>;
             /**
              * The priority of the unsigned transaction submitted in the unsigned-phase
              **/
@@ -354,7 +288,9 @@ declare module '@polkadot/api-base/types/consts' {
             /**
              * Maximum weight of a signed solution.
              *
-             * This should probably be similar to [`Config::MinerMaxWeight`].
+             * If [`Config::MinerConfig`] is being implemented to submit signed solutions (outside of
+             * this pallet), then [`MinerConfig::solution_weight`] is used to compare against
+             * this value.
              **/
             signedMaxWeight: u64 & AugmentedConst<ApiType>;
             /**
@@ -515,6 +451,24 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
+        nominationPools: {
+            /**
+             * The minimum pool points-to-balance ratio that must be maintained for it to be `open`.
+             * This is important in the event slashing takes place and the pool's points-to-balance
+             * ratio becomes disproportional.
+             * For a value of 10, the threshold would be a pool points-to-balance ratio of 10:1.
+             * Such a scenario would also be the equivalent of the pool being 90% slashed.
+             **/
+            minPointsToBalance: u32 & AugmentedConst<ApiType>;
+            /**
+             * The nomination pool's pallet id.
+             **/
+            palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
+            /**
+             * Generic const
+             **/
+            [key: string]: Codec;
+        };
         paras: {
             unsignedPriority: u64 & AugmentedConst<ApiType>;
             /**
@@ -941,5 +895,57 @@ declare module '@polkadot/api-base/types/consts' {
              **/
             [key: string]: Codec;
         };
+        voterList: {
+            /**
+             * The list of thresholds separating the various bags.
+             *
+             * Ids are separated into unsorted bags according to their score. This specifies the
+             * thresholds separating the bags. An id's bag is the largest bag for which the id's score
+             * is less than or equal to its upper threshold.
+             *
+             * When ids are iterated, higher bags are iterated completely before lower bags. This means
+             * that iteration is _semi-sorted_: ids of higher score tend to come before ids of lower
+             * score, but peer ids within a particular bag are sorted in insertion order.
+             *
+             * # Expressing the constant
+             *
+             * This constant must be sorted in strictly increasing order. Duplicate items are not
+             * permitted.
+             *
+             * There is an implied upper limit of `Score::MAX`; that value does not need to be
+             * specified within the bag. For any two threshold lists, if one ends with
+             * `Score::MAX`, the other one does not, and they are otherwise equal, the two
+             * lists will behave identically.
+             *
+             * # Calculation
+             *
+             * It is recommended to generate the set of thresholds in a geometric series, such that
+             * there exists some constant ratio such that `threshold[k + 1] == (threshold[k] *
+             * constant_ratio).max(threshold[k] + 1)` for all `k`.
+             *
+             * The helpers in the `/utils/frame/generate-bags` module can simplify this calculation.
+             *
+             * # Examples
+             *
+             * - If `BagThresholds::get().is_empty()`, then all ids are put into the same bag, and
+             * iteration is strictly in insertion order.
+             * - If `BagThresholds::get().len() == 64`, and the thresholds are determined according to
+             * the procedure given above, then the constant ratio is equal to 2.
+             * - If `BagThresholds::get().len() == 200`, and the thresholds are determined according to
+             * the procedure given above, then the constant ratio is approximately equal to 1.248.
+             * - If the threshold list begins `[1, 2, 3, ...]`, then an id with score 0 or 1 will fall
+             * into bag 0, an id with score 2 will fall into bag 1, etc.
+             *
+             * # Migration
+             *
+             * In the event that this list ever changes, a copy of the old bags list must be retained.
+             * With that `List::migrate` can be called, which will perform the appropriate migration.
+             **/
+            bagThresholds: Vec<u64> & AugmentedConst<ApiType>;
+            /**
+             * Generic const
+             **/
+            [key: string]: Codec;
+        };
     }
 }

package/kusama/errors.d.ts

@@ -74,6 +74,10 @@ declare module '@polkadot/api-base/types/errors' {
              * A given equivocation report is valid but already previously reported.
              **/
             DuplicateOffenceReport: AugmentedError<ApiType>;
+            /**
+             * Submitted configuration is invalid.
+             **/
+            InvalidConfiguration: AugmentedError<ApiType>;
             /**
              * An equivocation proof provided as part of an equivocation report is invalid.
              **/
@@ -87,16 +91,6 @@ declare module '@polkadot/api-base/types/errors' {
              **/
             [key: string]: AugmentedError<ApiType>;
         };
-        bagsList: {
-            /**
-             * A error in the list interface implementation.
-             **/
-            List: AugmentedError<ApiType>;
-            /**
-             * Generic error
-             **/
-            [key: string]: AugmentedError<ApiType>;
-        };
         balances: {
             /**
              * Beneficiary account must pre-exist
@@ -891,6 +885,117 @@ declare module '@polkadot/api-base/types/errors' {
              **/
             [key: string]: AugmentedError<ApiType>;
         };
+        nominationPools: {
+            /**
+             * An account is already delegating in another pool. An account may only belong to one
+             * pool at a time.
+             **/
+            AccountBelongsToOtherPool: AugmentedError<ApiType>;
+            /**
+             * The member is already unbonding in this era.
+             **/
+            AlreadyUnbonding: AugmentedError<ApiType>;
+            /**
+             * The pools state cannot be changed.
+             **/
+            CanNotChangeState: AugmentedError<ApiType>;
+            /**
+             * None of the funds can be withdrawn yet because the bonding duration has not passed.
+             **/
+            CannotWithdrawAny: AugmentedError<ApiType>;
+            /**
+             * Some error occurred that should never happen. This should be reported to the
+             * maintainers.
+             **/
+            DefensiveError: AugmentedError<ApiType>;
+            /**
+             * The caller does not have adequate permissions.
+             **/
+            DoesNotHavePermission: AugmentedError<ApiType>;
+            /**
+             * The member is fully unbonded (and thus cannot access the bonded and reward pool
+             * anymore to, for example, collect rewards).
+             **/
+            FullyUnbonding: AugmentedError<ApiType>;
+            /**
+             * The pool has insufficient balance to bond as a nominator.
+             **/
+            InsufficientBond: AugmentedError<ApiType>;
+            /**
+             * Too many members in the pool or system.
+             **/
+            MaxPoolMembers: AugmentedError<ApiType>;
+            /**
+             * The system is maxed out on pools.
+             **/
+            MaxPools: AugmentedError<ApiType>;
+            /**
+             * The member cannot unbond further chunks due to reaching the limit.
+             **/
+            MaxUnbondingLimit: AugmentedError<ApiType>;
+            /**
+             * Metadata exceeds [`Config::MaxMetadataLen`]
+             **/
+            MetadataExceedsMaxLen: AugmentedError<ApiType>;
+            /**
+             * The amount does not meet the minimum bond to either join or create a pool.
+             **/
+            MinimumBondNotMet: AugmentedError<ApiType>;
+            /**
+             * A pool must be in [`PoolState::Destroying`] in order for the depositor to unbond or for
+             * other members to be permissionlessly unbonded.
+             **/
+            NotDestroying: AugmentedError<ApiType>;
+            /**
+             * Not enough points. Ty unbonding less.
+             **/
+            NotEnoughPointsToUnbond: AugmentedError<ApiType>;
+            /**
+             * Either a) the caller cannot make a valid kick or b) the pool is not destroying.
+             **/
+            NotKickerOrDestroying: AugmentedError<ApiType>;
+            /**
+             * The caller does not have nominating permissions for the pool.
+             **/
+            NotNominator: AugmentedError<ApiType>;
+            /**
+             * The depositor must be the only member in the bonded pool in order to unbond. And the
+             * depositor must be the only member in the sub pools in order to withdraw unbonded.
+             **/
+            NotOnlyPoolMember: AugmentedError<ApiType>;
+            /**
+             * The pool is not open to join
+             **/
+            NotOpen: AugmentedError<ApiType>;
+            /**
+             * The transaction could not be executed due to overflow risk for the pool.
+             **/
+            OverflowRisk: AugmentedError<ApiType>;
+            /**
+             * Partial unbonding now allowed permissionlessly.
+             **/
+            PartialUnbondNotAllowedPermissionlessly: AugmentedError<ApiType>;
+            /**
+             * An account is not a member.
+             **/
+            PoolMemberNotFound: AugmentedError<ApiType>;
+            /**
+             * A (bonded) pool id does not exist.
+             **/
+            PoolNotFound: AugmentedError<ApiType>;
+            /**
+             * A reward pool does not exist. In all cases this is a system logic error.
+             **/
+            RewardPoolNotFound: AugmentedError<ApiType>;
+            /**
+             * A sub pool does not exist.
+             **/
+            SubPoolsNotFound: AugmentedError<ApiType>;
+            /**
+             * Generic error
+             **/
+            [key: string]: AugmentedError<ApiType>;
+        };
         paraInclusion: {
             /**
              * Bitfield consists of zeros only.
@@ -1854,6 +1959,16 @@ declare module '@polkadot/api-base/types/errors' {
              **/
             [key: string]: AugmentedError<ApiType>;
         };
+        voterList: {
+            /**
+             * A error in the list interface implementation.
+             **/
+            List: AugmentedError<ApiType>;
+            /**
+             * Generic error
+             **/
+            [key: string]: AugmentedError<ApiType>;
+        };
         xcmPallet: {
             /**
              * The location is invalid since it already has a subscription from us.

package/kusama/events.d.ts

@@ -3,34 +3,31 @@ import type { Bytes, Null, Option, Result, U8aFixed, Vec, bool, u128, u16, u32,
 import type { ITuple } from '@polkadot/types-codec/types';
 import type { EthereumAddress } from '@polkadot/types/interfaces/eth';
 import type { AccountId32, H256 } from '@polkadot/types/interfaces/runtime';
-import type { FrameSupportScheduleLookupError, FrameSupportTokensMiscBalanceStatus, FrameSupportWeightsDispatchInfo, KusamaRuntimeProxyType, PalletDemocracyVoteAccountVote, PalletDemocracyVoteThreshold, PalletElectionProviderMultiPhaseElectionCompute, PalletImOnlineSr25519AppSr25519Public, PalletMultisigTimepoint, PalletStakingExposure, PalletStakingValidatorPrefs, PolkadotParachainPrimitivesHrmpChannelId, PolkadotPrimitivesV2CandidateReceipt, PolkadotRuntimeParachainsDisputesDisputeLocation, PolkadotRuntimeParachainsDisputesDisputeResult, SpFinalityGrandpaAppPublic, SpRuntimeDispatchError, XcmV1MultiLocation, XcmV2Response, XcmV2TraitsError, XcmV2TraitsOutcome, XcmV2Xcm, XcmVersionedMultiAssets, XcmVersionedMultiLocation } from '@polkadot/types/lookup';
+import type { FrameSupportScheduleLookupError, FrameSupportTokensMiscBalanceStatus, FrameSupportWeightsDispatchInfo, KusamaRuntimeProxyType, PalletDemocracyVoteAccountVote, PalletDemocracyVoteThreshold, PalletElectionProviderMultiPhaseElectionCompute, PalletImOnlineSr25519AppSr25519Public, PalletMultisigTimepoint, PalletNominationPoolsPoolState, PalletStakingExposure, PalletStakingValidatorPrefs, PolkadotParachainPrimitivesHrmpChannelId, PolkadotPrimitivesV2CandidateReceipt, PolkadotRuntimeParachainsDisputesDisputeLocation, PolkadotRuntimeParachainsDisputesDisputeResult, SpFinalityGrandpaAppPublic, SpRuntimeDispatchError, XcmV1MultiLocation, XcmV2Response, XcmV2TraitsError, XcmV2TraitsOutcome, XcmV2Xcm, XcmVersionedMultiAssets, XcmVersionedMultiLocation } from '@polkadot/types/lookup';
 declare module '@polkadot/api-base/types/events' {
     interface AugmentedEvents<ApiType extends ApiTypes> {
         auctions: {
             /**
-             * An auction ended. All funds become unreserved. `[auction_index]`
+             * An auction ended. All funds become unreserved.
              **/
             AuctionClosed: AugmentedEvent<ApiType, [u32]>;
             /**
              * An auction started. Provides its index and the block number where it will begin to
              * close and the first lease period of the quadruplet that is auctioned.
-             * `[auction_index, lease_period, ending]`
              **/
             AuctionStarted: AugmentedEvent<ApiType, [u32, u32, u32]>;
             /**
              * A new bid has been accepted as the current winner.
-             * `[who, para_id, amount, first_slot, last_slot]`
              **/
             BidAccepted: AugmentedEvent<ApiType, [AccountId32, u32, u128, u32, u32]>;
             /**
              * Someone attempted to lease the same slot twice for a parachain. The amount is held in reserve
              * but no parachain slot has been leased.
-             * `[parachain_id, leaser, amount]`
              **/
             ReserveConfiscated: AugmentedEvent<ApiType, [u32, AccountId32, u128]>;
             /**
              * Funds were reserved for a winning bid. First balance is the extra amount reserved.
-             * Second is the total. `[bidder, extra_reserved, total_amount]`
+             * Second is the total.
              **/
             Reserved: AugmentedEvent<ApiType, [AccountId32, u128, u128]>;
             /**
@@ -39,7 +36,6 @@ declare module '@polkadot/api-base/types/events' {
             Unreserved: AugmentedEvent<ApiType, [AccountId32, u128]>;
             /**
              * The winning offset was chosen for an auction. This will map into the `Winning` storage map.
-             * `[auction_index, block_number]`
              **/
             WinningOffset: AugmentedEvent<ApiType, [u32, u32]>;
             /**
@@ -47,16 +43,6 @@ declare module '@polkadot/api-base/types/events' {
              **/
             [key: string]: AugmentedEvent<ApiType>;
         };
-        bagsList: {
-            /**
-             * Moved an account from one bag to another.
-             **/
-            Rebagged: AugmentedEvent<ApiType, [AccountId32, u64, u64]>;
-            /**
-             * Generic event
-             **/
-            [key: string]: AugmentedEvent<ApiType>;
-        };
         balances: {
             /**
              * A balance was set by root.
@@ -163,7 +149,7 @@ declare module '@polkadot/api-base/types/events' {
         };
         claims: {
             /**
-             * Someone claimed some DOTs. `[who, ethereum_address, amount]`
+             * Someone claimed some DOTs.
              **/
             Claimed: AugmentedEvent<ApiType, [AccountId32, EthereumAddress, u128]>;
             /**
@@ -213,23 +199,23 @@ declare module '@polkadot/api-base/types/events' {
              **/
             AddedToNewRaise: AugmentedEvent<ApiType, [u32]>;
             /**
-             * All loans in a fund have been refunded. `[fund_index]`
+             * All loans in a fund have been refunded.
              **/
             AllRefunded: AugmentedEvent<ApiType, [u32]>;
             /**
-             * Contributed to a crowd sale. `[who, fund_index, amount]`
+             * Contributed to a crowd sale.
              **/
             Contributed: AugmentedEvent<ApiType, [AccountId32, u32, u128]>;
             /**
-             * Create a new crowdloaning campaign. `[fund_index]`
+             * Create a new crowdloaning campaign.
              **/
             Created: AugmentedEvent<ApiType, [u32]>;
             /**
-             * Fund is dissolved. `[fund_index]`
+             * Fund is dissolved.
              **/
             Dissolved: AugmentedEvent<ApiType, [u32]>;
             /**
-             * The configuration to a crowdloan has been edited. `[fund_index]`
+             * The configuration to a crowdloan has been edited.
              **/
             Edited: AugmentedEvent<ApiType, [u32]>;
             /**
@@ -237,16 +223,16 @@ declare module '@polkadot/api-base/types/events' {
              **/
             HandleBidResult: AugmentedEvent<ApiType, [u32, Result<Null, SpRuntimeDispatchError>]>;
             /**
-             * A memo has been updated. `[who, fund_index, memo]`
+             * A memo has been updated.
              **/
             MemoUpdated: AugmentedEvent<ApiType, [AccountId32, u32, Bytes]>;
             /**
              * The loans in a fund have been partially dissolved, i.e. there are some left
-             * over child keys that still need to be killed. `[fund_index]`
+             * over child keys that still need to be killed.
              **/
             PartiallyRefunded: AugmentedEvent<ApiType, [u32]>;
             /**
-             * Withdrew full balance of a contributor. `[who, fund_index, amount]`
+             * Withdrew full balance of a contributor.
              **/
             Withdrew: AugmentedEvent<ApiType, [AccountId32, u32, u128]>;
             /**
@@ -541,6 +527,51 @@ declare module '@polkadot/api-base/types/events' {
              **/
             [key: string]: AugmentedEvent<ApiType>;
         };
+        nominationPools: {
+            /**
+             * A member has became bonded in a pool.
+             **/
+            Bonded: AugmentedEvent<ApiType, [AccountId32, u32, u128, bool]>;
+            /**
+             * A pool has been created.
+             **/
+            Created: AugmentedEvent<ApiType, [AccountId32, u32]>;
+            /**
+             * A pool has been destroyed.
+             **/
+            Destroyed: AugmentedEvent<ApiType, [u32]>;
+            /**
+             * A member has been removed from a pool.
+             *
+             * The removal can be voluntary (withdrawn all unbonded funds) or involuntary (kicked).
+             **/
+            MemberRemoved: AugmentedEvent<ApiType, [u32, AccountId32]>;
+            /**
+             * A payout has been made to a member.
+             **/
+            PaidOut: AugmentedEvent<ApiType, [AccountId32, u32, u128]>;
+            /**
+             * The roles of a pool have been updated to the given new roles. Note that the depositor
+             * can never change.
+             **/
+            RolesUpdated: AugmentedEvent<ApiType, [Option<AccountId32>, Option<AccountId32>, Option<AccountId32>]>;
+            /**
+             * The state of a pool has changed
+             **/
+            StateChanged: AugmentedEvent<ApiType, [u32, PalletNominationPoolsPoolState]>;
+            /**
+             * A member has unbonded from their pool.
+             **/
+            Unbonded: AugmentedEvent<ApiType, [AccountId32, u32, u128]>;
+            /**
+             * A member has withdrawn from their pool.
+             **/
+            Withdrawn: AugmentedEvent<ApiType, [AccountId32, u32, u128]>;
+            /**
+             * Generic event
+             **/
+            [key: string]: AugmentedEvent<ApiType>;
+        };
         offences: {
             /**
              * There is an offence reported of the given `kind` happened at the `session_index` and
@@ -804,7 +835,6 @@ declare module '@polkadot/api-base/types/events' {
              * A para has won the right to a continuous set of lease periods as a parachain.
              * First balance is any extra amount reserved on top of the para's existing deposit.
              * Second balance is the total amount reserved.
-             * `[parachain_id, leaser, period_begin, period_count, extra_reserved, total_amount]`
              **/
             Leased: AugmentedEvent<ApiType, [u32, AccountId32, u32, u32, u128, u128]>;
             /**
@@ -1205,6 +1235,20 @@ declare module '@polkadot/api-base/types/events' {
              **/
             [key: string]: AugmentedEvent<ApiType>;
         };
+        voterList: {
+            /**
+             * Moved an account from one bag to another.
+             **/
+            Rebagged: AugmentedEvent<ApiType, [AccountId32, u64, u64]>;
+            /**
+             * Updated the score of some account to the given amount.
+             **/
+            ScoreUpdated: AugmentedEvent<ApiType, [AccountId32, u64]>;
+            /**
+             * Generic event
+             **/
+            [key: string]: AugmentedEvent<ApiType>;
+        };
         xcmPallet: {
             /**
              * Some assets have been placed in an asset trap.