@polkadot/api-augment 8.12.2 → 8.13.1

package/cjs/package.json

@@ -1,3 +1,3 @@
 {
   "type": "commonjs"
-}
+}

package/cjs/packageInfo.js

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

package/kusama/consts.d.ts

@@ -455,13 +455,20 @@ declare module '@polkadot/api-base/types/consts' {
         };
         nominationPools: {
             /**
-             * The minimum pool points-to-balance ratio that must be maintained for it to be `open`.
+             * The maximum pool points-to-balance ratio that an `open` pool can have.
+             *
              * This is important in the event slashing takes place and the pool's points-to-balance
              * ratio becomes disproportional.
+             *
+             * Moreover, this relates to the `RewardCounter` type as well, as the arithmetic operations
+             * are a function of number of points, and by setting this value to e.g. 10, you ensure
+             * that the total number of points in the system are at most 10 times the total_issuance of
+             * the chain, in the absolute worse case.
+             *
              * 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>;
+            maxPointsToBalance: u8 & AugmentedConst<ApiType>;
             /**
              * The nomination pool's pallet id.
              **/

package/kusama/errors.d.ts

@@ -1288,14 +1288,14 @@ declare module '@polkadot/api-base/types/errors' {
              * Must vote for at least one candidate.
              **/
             NoVotes: AugmentedError<ApiType>;
-            /**
-             * Cannot report self.
-             **/
-            ReportSelf: AugmentedError<ApiType>;
             /**
              * Runner cannot re-submit candidacy.
              **/
             RunnerUpSubmit: AugmentedError<ApiType>;
+            /**
+             * Too many candidates have been created.
+             **/
+            TooManyCandidates: AugmentedError<ApiType>;
             /**
              * Cannot vote more than candidates.
              **/

package/kusama/tx.d.ts

@@ -2448,6 +2448,8 @@ declare module '@polkadot/api-base/types/submittable' {
              *
              * 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.
              **/
             bondExtra: AugmentedSubmittable<(extra: PalletNominationPoolsBondExtra | {
                 FreeBalance: any;
@@ -2578,8 +2580,14 @@ declare module '@polkadot/api-base/types/submittable' {
             /**
              * Set a new state for the pool.
              *
-             * The dispatch origin of this call must be signed by the state toggler, or the root role
-             * of 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:
+             *
+             * 1. signed by the state toggler, or the root role of the pool,
+             * 2. 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 to `Destroying`.
              **/
             setState: AugmentedSubmittable<(poolId: u32 | AnyNumber | Uint8Array, state: PalletNominationPoolsPoolState | 'Open' | 'Blocked' | 'Destroying' | number | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, PalletNominationPoolsPoolState]>;
             /**
@@ -2783,7 +2791,11 @@ declare module '@polkadot/api-base/types/submittable' {
              * the outgoing member is slashed.
              *
              * If a runner-up is available, then the best runner-up will be removed and replaces the
-             * outgoing member. Otherwise, a new phragmen election is started.
+             * outgoing member. Otherwise, if `rerun_election` is `true`, a new phragmen election is
+             * started, else, nothing happens.
+             *
+             * If `slash_bond` is set to true, the bond of the member being removed is slashed. Else,
+             * it is returned.
              *
              * The dispatch origin of this call must be root.
              *
@@ -2804,7 +2816,7 @@ declare module '@polkadot/api-base/types/submittable' {
                 Address32: any;
             } | {
                 Address20: any;
-            } | string | Uint8Array, hasReplacement: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool]>;
+            } | string | Uint8Array, slashBond: bool | boolean | Uint8Array, rerunElection: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool, bool]>;
             /**
              * Remove `origin` as a voter.
              *

package/package.json

@@ -20,7 +20,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "8.12.2",
+  "version": "8.13.1",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -186,11 +186,11 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@polkadot/api-base": "8.12.2",
-    "@polkadot/rpc-augment": "8.12.2",
-    "@polkadot/types": "8.12.2",
-    "@polkadot/types-augment": "8.12.2",
-    "@polkadot/types-codec": "8.12.2",
+    "@polkadot/api-base": "8.13.1",
+    "@polkadot/rpc-augment": "8.13.1",
+    "@polkadot/types": "8.13.1",
+    "@polkadot/types-augment": "8.13.1",
+    "@polkadot/types-codec": "8.13.1",
     "@polkadot/util": "^10.0.2"
   }
-}
+}

package/packageInfo.js

@@ -5,5 +5,5 @@ export const packageInfo = {
   name: '@polkadot/api-augment',
   path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto',
   type: 'esm',
-  version: '8.12.2'
+  version: '8.13.1'
 };

package/polkadot/errors.d.ts

@@ -1146,14 +1146,14 @@ declare module '@polkadot/api-base/types/errors' {
              * Must vote for at least one candidate.
              **/
             NoVotes: AugmentedError<ApiType>;
-            /**
-             * Cannot report self.
-             **/
-            ReportSelf: AugmentedError<ApiType>;
             /**
              * Runner cannot re-submit candidacy.
              **/
             RunnerUpSubmit: AugmentedError<ApiType>;
+            /**
+             * Too many candidates have been created.
+             **/
+            TooManyCandidates: AugmentedError<ApiType>;
             /**
              * Cannot vote more than candidates.
              **/

package/polkadot/tx.d.ts

@@ -2506,7 +2506,11 @@ declare module '@polkadot/api-base/types/submittable' {
              * the outgoing member is slashed.
              *
              * If a runner-up is available, then the best runner-up will be removed and replaces the
-             * outgoing member. Otherwise, a new phragmen election is started.
+             * outgoing member. Otherwise, if `rerun_election` is `true`, a new phragmen election is
+             * started, else, nothing happens.
+             *
+             * If `slash_bond` is set to true, the bond of the member being removed is slashed. Else,
+             * it is returned.
              *
              * The dispatch origin of this call must be root.
              *
@@ -2527,7 +2531,7 @@ declare module '@polkadot/api-base/types/submittable' {
                 Address32: any;
             } | {
                 Address20: any;
-            } | string | Uint8Array, hasReplacement: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool]>;
+            } | string | Uint8Array, slashBond: bool | boolean | Uint8Array, rerunElection: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool, bool]>;
             /**
              * Remove `origin` as a voter.
              *

package/substrate/consts.d.ts

@@ -675,13 +675,20 @@ declare module '@polkadot/api-base/types/consts' {
         };
         nominationPools: {
             /**
-             * The minimum pool points-to-balance ratio that must be maintained for it to be `open`.
+             * The maximum pool points-to-balance ratio that an `open` pool can have.
+             *
              * This is important in the event slashing takes place and the pool's points-to-balance
              * ratio becomes disproportional.
+             *
+             * Moreover, this relates to the `RewardCounter` type as well, as the arithmetic operations
+             * are a function of number of points, and by setting this value to e.g. 10, you ensure
+             * that the total number of points in the system are at most 10 times the total_issuance of
+             * the chain, in the absolute worse case.
+             *
              * 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>;
+            maxPointsToBalance: u8 & AugmentedConst<ApiType>;
             /**
              * The nomination pool's pallet id.
              **/

package/substrate/errors.d.ts

@@ -847,14 +847,14 @@ declare module '@polkadot/api-base/types/errors' {
              * Must vote for at least one candidate.
              **/
             NoVotes: AugmentedError<ApiType>;
-            /**
-             * Cannot report self.
-             **/
-            ReportSelf: AugmentedError<ApiType>;
             /**
              * Runner cannot re-submit candidacy.
              **/
             RunnerUpSubmit: AugmentedError<ApiType>;
+            /**
+             * Too many candidates have been created.
+             **/
+            TooManyCandidates: AugmentedError<ApiType>;
             /**
              * Cannot vote more than candidates.
              **/
@@ -1199,6 +1199,10 @@ declare module '@polkadot/api-base/types/errors' {
             MetadataExceedsMaxLen: AugmentedError<ApiType>;
             /**
              * 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 nominating
+             * permissions for the pool. Members can never unbond to a value below `MinJoinBond`.
              **/
             MinimumBondNotMet: AugmentedError<ApiType>;
             /**
@@ -1206,10 +1210,6 @@ declare module '@polkadot/api-base/types/errors' {
              * 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.
              **/
@@ -1218,11 +1218,6 @@ declare module '@polkadot/api-base/types/errors' {
              * 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
              **/
@@ -2050,6 +2045,10 @@ declare module '@polkadot/api-base/types/errors' {
              * Invalid witness data given.
              **/
             BadWitness: AugmentedError<ApiType>;
+            /**
+             * The provided bid is too low.
+             **/
+            BidTooLow: AugmentedError<ApiType>;
             /**
              * The item or collection is frozen.
              **/
@@ -2082,6 +2081,10 @@ declare module '@polkadot/api-base/types/errors' {
              * The signing account has no permission to do the operation.
              **/
             NoPermission: AugmentedError<ApiType>;
+            /**
+             * Item is not for sale.
+             **/
+            NotForSale: AugmentedError<ApiType>;
             /**
              * The named owner has not signed ownership of the collection is acceptable.
              **/
@@ -2094,6 +2097,10 @@ declare module '@polkadot/api-base/types/errors' {
              * The given item ID is unknown.
              **/
             UnknownCollection: AugmentedError<ApiType>;
+            /**
+             * The given item ID is unknown.
+             **/
+            UnknownItem: AugmentedError<ApiType>;
             /**
              * The delegate turned out to be different to what was expected.
              **/

package/substrate/events.d.ts

@@ -2254,6 +2254,32 @@ declare module '@polkadot/api-base/types/events' {
                 item: u32;
                 owner: AccountId32;
             }>;
+            /**
+             * An item was bought.
+             **/
+            ItemBought: AugmentedEvent<ApiType, [collection: u32, item: u32, price: u128, seller: AccountId32, buyer: AccountId32], {
+                collection: u32;
+                item: u32;
+                price: u128;
+                seller: AccountId32;
+                buyer: AccountId32;
+            }>;
+            /**
+             * The price for the instance was removed.
+             **/
+            ItemPriceRemoved: AugmentedEvent<ApiType, [collection: u32, item: u32], {
+                collection: u32;
+                item: u32;
+            }>;
+            /**
+             * The price was set for the instance.
+             **/
+            ItemPriceSet: AugmentedEvent<ApiType, [collection: u32, item: u32, price: u128, whitelistedBuyer: Option<AccountId32>], {
+                collection: u32;
+                item: u32;
+                price: u128;
+                whitelistedBuyer: Option<AccountId32>;
+            }>;
             /**
              * A `collection` has had its attributes changed by the `Force` origin.
              **/

package/substrate/query.d.ts

@@ -1771,6 +1771,10 @@ declare module '@polkadot/api-base/types/storage' {
              * Metadata of an item.
              **/
             instanceMetadataOf: AugmentedQuery<ApiType, (arg1: u32 | AnyNumber | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<PalletUniquesItemMetadata>>, [u32, u32]> & QueryableStorageEntry<ApiType, [u32, u32]>;
+            /**
+             * Price of an asset instance.
+             **/
+            itemPriceOf: AugmentedQuery<ApiType, (arg1: u32 | AnyNumber | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<ITuple<[u128, Option<AccountId32>]>>>, [u32, u32]> & QueryableStorageEntry<ApiType, [u32, u32]>;
             /**
              * The collection, if any, of which an account is willing to take ownership.
              **/

package/substrate/tx.d.ts

@@ -2405,7 +2405,11 @@ declare module '@polkadot/api-base/types/submittable' {
              * the outgoing member is slashed.
              *
              * If a runner-up is available, then the best runner-up will be removed and replaces the
-             * outgoing member. Otherwise, a new phragmen election is started.
+             * outgoing member. Otherwise, if `rerun_election` is `true`, a new phragmen election is
+             * started, else, nothing happens.
+             *
+             * If `slash_bond` is set to true, the bond of the member being removed is slashed. Else,
+             * it is returned.
              *
              * The dispatch origin of this call must be root.
              *
@@ -2426,7 +2430,7 @@ declare module '@polkadot/api-base/types/submittable' {
                 Address32: any;
             } | {
                 Address20: any;
-            } | string | Uint8Array, hasReplacement: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool]>;
+            } | string | Uint8Array, slashBond: bool | boolean | Uint8Array, rerunElection: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, bool, bool]>;
             /**
              * Remove `origin` as a voter.
              *
@@ -3337,6 +3341,8 @@ declare module '@polkadot/api-base/types/submittable' {
              *
              * 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.
              **/
             bondExtra: AugmentedSubmittable<(extra: PalletNominationPoolsBondExtra | {
                 FreeBalance: any;
@@ -3467,8 +3473,14 @@ declare module '@polkadot/api-base/types/submittable' {
             /**
              * Set a new state for the pool.
              *
-             * The dispatch origin of this call must be signed by the state toggler, or the root role
-             * of 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:
+             *
+             * 1. signed by the state toggler, or the root role of the pool,
+             * 2. 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 to `Destroying`.
              **/
             setState: AugmentedSubmittable<(poolId: u32 | AnyNumber | Uint8Array, state: PalletNominationPoolsPoolState | 'Open' | 'Blocked' | 'Destroying' | number | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, PalletNominationPoolsPoolState]>;
             /**
@@ -5906,6 +5918,18 @@ declare module '@polkadot/api-base/types/submittable' {
             } | {
                 Address20: any;
             } | string) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<MultiAddress>]>;
+            /**
+             * Allows to buy an item if it's up for sale.
+             *
+             * Origin must be Signed and must not be the owner of the `item`.
+             *
+             * - `collection`: The collection of the item.
+             * - `item`: The item the sender wants to buy.
+             * - `bid_price`: The price the sender is willing to pay.
+             *
+             * Emits `ItemBought` on success.
+             **/
+            buyItem: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, bidPrice: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, u128]>;
             /**
              * Cancel the prior approval for the transfer of an item by a delegate.
              *
@@ -6278,6 +6302,30 @@ declare module '@polkadot/api-base/types/submittable' {
              * Weight: `O(1)`
              **/
             setMetadata: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Bytes, bool]>;
+            /**
+             * Set (or reset) the price for an item.
+             *
+             * Origin must be Signed and must be the owner of the asset `item`.
+             *
+             * - `collection`: The collection of the item.
+             * - `item`: The item to set the price for.
+             * - `price`: The price for the item. Pass `None`, to reset the price.
+             * - `buyer`: Restricts the buy operation to a specific account.
+             *
+             * Emits `ItemPriceSet` on success if the price is not `None`.
+             * Emits `ItemPriceRemoved` on success if the price is `None`.
+             **/
+            setPrice: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, price: Option<u128> | null | Uint8Array | u128 | AnyNumber, whitelistedBuyer: Option<MultiAddress> | null | Uint8Array | MultiAddress | {
+                Id: any;
+            } | {
+                Index: any;
+            } | {
+                Raw: any;
+            } | {
+                Address32: any;
+            } | {
+                Address20: any;
+            } | string) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<u128>, Option<MultiAddress>]>;
             /**
              * Change the Issuer, Admin and Freezer of a collection.
              *