@polkadot/api-augment 8.4.3-4 → 8.4.3-7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/substrate/tx.d.ts CHANGED
@@ -3,7 +3,7 @@ import type { Data } from '@polkadot/types';
3
3
  import type { Bytes, Compact, Option, U8aFixed, Vec, WrapperKeepOpaque, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
4
4
  import type { AnyNumber, IMethod, ITuple } from '@polkadot/types-codec/types';
5
5
  import type { AccountId32, Call, H256, MultiAddress, Perbill, Percent, Perquintill } from '@polkadot/types/interfaces/runtime';
6
- import type { FrameSupportScheduleDispatchTime, FrameSupportScheduleMaybeHashed, NodeRuntimeOriginCaller, NodeRuntimeProxyType, NodeRuntimeSessionKeys, PalletAssetsDestroyWitness, PalletConvictionVotingConviction, PalletConvictionVotingVoteAccountVote, PalletDemocracyConviction, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityBitFlags, PalletIdentityIdentityInfo, PalletIdentityJudgement, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletMultisigTimepoint, PalletNominationPoolsBondExtra, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletSocietyJudgement, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingValidatorPrefs, PalletStateTrieMigrationMigrationLimits, PalletStateTrieMigrationMigrationTask, PalletStateTrieMigrationProgress, PalletUniquesDestroyWitness, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusSlotsEquivocationProof, SpFinalityGrandpaEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeHeader, SpSessionMembershipProof, SpTransactionStorageProofTransactionStorageProof } from '@polkadot/types/lookup';
6
+ import type { FrameSupportScheduleDispatchTime, FrameSupportScheduleMaybeHashed, NodeRuntimeOriginCaller, NodeRuntimeProxyType, NodeRuntimeSessionKeys, PalletAssetsDestroyWitness, PalletConvictionVotingConviction, PalletConvictionVotingVoteAccountVote, PalletDemocracyConviction, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityBitFlags, PalletIdentityIdentityInfo, PalletIdentityJudgement, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletMultisigTimepoint, PalletNominationPoolsBondExtra, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletSocietyJudgement, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingValidatorPrefs, PalletStateTrieMigrationMigrationLimits, PalletStateTrieMigrationMigrationTask, PalletStateTrieMigrationProgress, PalletUniquesDestroyWitness, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusSlotsEquivocationProof, SpFinalityGrandpaEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeHeader, SpSessionMembershipProof, SpTransactionStorageProofTransactionStorageProof } from '@polkadot/types/lookup';
7
7
  declare module '@polkadot/api-base/types/submittable' {
8
8
  interface AugmentedSubmittables<ApiType extends ApiTypes> {
9
9
  assets: {
@@ -770,8 +770,10 @@ declare module '@polkadot/api-base/types/submittable' {
770
770
  *
771
771
  * Anyone can call this function about any potentially dislocated account.
772
772
  *
773
- * Will never return an error; if `dislocated` does not exist or doesn't need a rebag, then
774
- * it is a noop and fees are still collected from `origin`.
773
+ * Will always update the stored score of `dislocated` to the correct score, based on
774
+ * `ScoreProvider`.
775
+ *
776
+ * If `dislocated` does not exists, it returns an error.
775
777
  **/
776
778
  rebag: AugmentedSubmittable<(dislocated: AccountId32 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [AccountId32]>;
777
779
  /**
@@ -1347,6 +1349,29 @@ declare module '@polkadot/api-base/types/submittable' {
1347
1349
  * not used by any contract.
1348
1350
  **/
1349
1351
  removeCode: AugmentedSubmittable<(codeHash: H256 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [H256]>;
1352
+ /**
1353
+ * Privileged function that changes the code of an existing contract.
1354
+ *
1355
+ * This takes care of updating refcounts and all other necessary operations. Returns
1356
+ * an error if either the `code_hash` or `dest` do not exist.
1357
+ *
1358
+ * # Note
1359
+ *
1360
+ * This does **not** change the address of the contract in question. This means
1361
+ * that the contract address is no longer derived from its code hash after calling
1362
+ * this dispatchable.
1363
+ **/
1364
+ setCode: AugmentedSubmittable<(dest: MultiAddress | {
1365
+ Id: any;
1366
+ } | {
1367
+ Index: any;
1368
+ } | {
1369
+ Raw: any;
1370
+ } | {
1371
+ Address32: any;
1372
+ } | {
1373
+ Address20: any;
1374
+ } | string | Uint8Array, codeHash: H256 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, H256]>;
1350
1375
  /**
1351
1376
  * Upload new `code` without instantiating a contract from it.
1352
1377
  *
@@ -3068,7 +3093,7 @@ declare module '@polkadot/api-base/types/submittable' {
3068
3093
  **/
3069
3094
  poolWithdrawUnbonded: AugmentedSubmittable<(poolId: u32 | AnyNumber | Uint8Array, numSlashingSpans: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
3070
3095
  /**
3071
- * Update configurations for the nomination pools. The origin must for this call must be
3096
+ * Update configurations for the nomination pools. The origin for this call must be
3072
3097
  * Root.
3073
3098
  *
3074
3099
  * # Arguments
@@ -3143,6 +3168,34 @@ declare module '@polkadot/api-base/types/submittable' {
3143
3168
  * `NoMoreChunks` error from the staking system.
3144
3169
  **/
3145
3170
  unbond: AugmentedSubmittable<(memberAccount: AccountId32 | string | Uint8Array, unbondingPoints: Compact<u128> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [AccountId32, Compact<u128>]>;
3171
+ /**
3172
+ * Update the roles of the pool.
3173
+ *
3174
+ * The root is the only entity that can change any of the roles, including itself,
3175
+ * excluding the depositor, who can never change.
3176
+ *
3177
+ * It emits an event, notifying UIs of the role change. This event is quite relevant to
3178
+ * most pool members and they should be informed of changes to pool roles.
3179
+ **/
3180
+ updateRoles: AugmentedSubmittable<(poolId: u32 | AnyNumber | Uint8Array, newRoot: PalletNominationPoolsConfigOpAccountId32 | {
3181
+ Noop: any;
3182
+ } | {
3183
+ Set: any;
3184
+ } | {
3185
+ Remove: any;
3186
+ } | string | Uint8Array, newNominator: PalletNominationPoolsConfigOpAccountId32 | {
3187
+ Noop: any;
3188
+ } | {
3189
+ Set: any;
3190
+ } | {
3191
+ Remove: any;
3192
+ } | string | Uint8Array, newStateToggler: PalletNominationPoolsConfigOpAccountId32 | {
3193
+ Noop: any;
3194
+ } | {
3195
+ Set: any;
3196
+ } | {
3197
+ Remove: any;
3198
+ } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpAccountId32]>;
3146
3199
  /**
3147
3200
  * Withdraw unbonded funds from `member_account`. If no bonded funds can be unbonded, an
3148
3201
  * error is returned.
@@ -5282,19 +5335,19 @@ declare module '@polkadot/api-base/types/submittable' {
5282
5335
  };
5283
5336
  uniques: {
5284
5337
  /**
5285
- * Approve an instance to be transferred by a delegated third-party account.
5338
+ * Approve an item to be transferred by a delegated third-party account.
5286
5339
  *
5287
- * Origin must be Signed and must be the owner of the asset `instance`.
5340
+ * Origin must be Signed and must be the owner of the `item`.
5288
5341
  *
5289
- * - `class`: The class of the asset to be approved for delegated transfer.
5290
- * - `instance`: The instance of the asset to be approved for delegated transfer.
5291
- * - `delegate`: The account to delegate permission to transfer the asset.
5342
+ * - `collection`: The collection of the item to be approved for delegated transfer.
5343
+ * - `item`: The item of the item to be approved for delegated transfer.
5344
+ * - `delegate`: The account to delegate permission to transfer the item.
5292
5345
  *
5293
5346
  * Emits `ApprovedTransfer` on success.
5294
5347
  *
5295
5348
  * Weight: `O(1)`
5296
5349
  **/
5297
- approveTransfer: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, delegate: MultiAddress | {
5350
+ approveTransfer: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, delegate: MultiAddress | {
5298
5351
  Id: any;
5299
5352
  } | {
5300
5353
  Index: any;
@@ -5306,32 +5359,32 @@ declare module '@polkadot/api-base/types/submittable' {
5306
5359
  Address20: any;
5307
5360
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, MultiAddress]>;
5308
5361
  /**
5309
- * Destroy a single asset instance.
5362
+ * Destroy a single item.
5310
5363
  *
5311
- * Origin must be Signed and the sender should be the Admin of the asset `class`.
5364
+ * Origin must be Signed and the sender should be the Admin of the `collection`.
5312
5365
  *
5313
- * - `class`: The class of the asset to be burned.
5314
- * - `instance`: The instance of the asset to be burned.
5366
+ * - `collection`: The collection of the item to be burned.
5367
+ * - `item`: The item of the item to be burned.
5315
5368
  * - `check_owner`: If `Some` then the operation will fail with `WrongOwner` unless the
5316
- * asset is owned by this value.
5369
+ * item is owned by this value.
5317
5370
  *
5318
5371
  * Emits `Burned` with the actual amount burned.
5319
5372
  *
5320
5373
  * Weight: `O(1)`
5321
5374
  * Modes: `check_owner.is_some()`.
5322
5375
  **/
5323
- burn: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, checkOwner: Option<MultiAddress> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<MultiAddress>]>;
5376
+ burn: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, checkOwner: Option<MultiAddress> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<MultiAddress>]>;
5324
5377
  /**
5325
- * Cancel the prior approval for the transfer of an asset by a delegate.
5378
+ * Cancel the prior approval for the transfer of an item by a delegate.
5326
5379
  *
5327
5380
  * Origin must be either:
5328
5381
  * - the `Force` origin;
5329
- * - `Signed` with the signer being the Admin of the asset `class`;
5330
- * - `Signed` with the signer being the Owner of the asset `instance`;
5382
+ * - `Signed` with the signer being the Admin of the `collection`;
5383
+ * - `Signed` with the signer being the Owner of the `item`;
5331
5384
  *
5332
5385
  * Arguments:
5333
- * - `class`: The class of the asset of whose approval will be cancelled.
5334
- * - `instance`: The instance of the asset of whose approval will be cancelled.
5386
+ * - `collection`: The collection of the item of whose approval will be cancelled.
5387
+ * - `item`: The item of the item of whose approval will be cancelled.
5335
5388
  * - `maybe_check_delegate`: If `Some` will ensure that the given account is the one to
5336
5389
  * which permission of transfer is delegated.
5337
5390
  *
@@ -5339,74 +5392,74 @@ declare module '@polkadot/api-base/types/submittable' {
5339
5392
  *
5340
5393
  * Weight: `O(1)`
5341
5394
  **/
5342
- cancelApproval: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, maybeCheckDelegate: Option<MultiAddress> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<MultiAddress>]>;
5395
+ cancelApproval: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, maybeCheckDelegate: Option<MultiAddress> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Option<MultiAddress>]>;
5343
5396
  /**
5344
- * Clear an attribute for an asset class or instance.
5397
+ * Clear an attribute for a collection or item.
5345
5398
  *
5346
5399
  * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5347
- * asset `class`.
5400
+ * `collection`.
5348
5401
  *
5349
- * Any deposit is freed for the asset class owner.
5402
+ * Any deposit is freed for the collection's owner.
5350
5403
  *
5351
- * - `class`: The identifier of the asset class whose instance's metadata to clear.
5352
- * - `maybe_instance`: The identifier of the asset instance whose metadata to clear.
5404
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
5405
+ * - `maybe_item`: The identifier of the item whose metadata to clear.
5353
5406
  * - `key`: The key of the attribute.
5354
5407
  *
5355
5408
  * Emits `AttributeCleared`.
5356
5409
  *
5357
5410
  * Weight: `O(1)`
5358
5411
  **/
5359
- clearAttribute: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, maybeInstance: Option<u32> | null | object | string | Uint8Array, key: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Option<u32>, Bytes]>;
5412
+ clearAttribute: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, maybeItem: Option<u32> | null | object | string | Uint8Array, key: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Option<u32>, Bytes]>;
5360
5413
  /**
5361
- * Clear the metadata for an asset class.
5414
+ * Clear the metadata for a collection.
5362
5415
  *
5363
5416
  * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
5364
- * the asset `class`.
5417
+ * the `collection`.
5365
5418
  *
5366
- * Any deposit is freed for the asset class owner.
5419
+ * Any deposit is freed for the collection's owner.
5367
5420
  *
5368
- * - `class`: The identifier of the asset class whose metadata to clear.
5421
+ * - `collection`: The identifier of the collection whose metadata to clear.
5369
5422
  *
5370
- * Emits `ClassMetadataCleared`.
5423
+ * Emits `CollectionMetadataCleared`.
5371
5424
  *
5372
5425
  * Weight: `O(1)`
5373
5426
  **/
5374
- clearClassMetadata: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5427
+ clearCollectionMetadata: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5375
5428
  /**
5376
- * Clear the metadata for an asset instance.
5429
+ * Clear the metadata for an item.
5377
5430
  *
5378
5431
  * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5379
- * asset `instance`.
5432
+ * `item`.
5380
5433
  *
5381
- * Any deposit is freed for the asset class owner.
5434
+ * Any deposit is freed for the collection's owner.
5382
5435
  *
5383
- * - `class`: The identifier of the asset class whose instance's metadata to clear.
5384
- * - `instance`: The identifier of the asset instance whose metadata to clear.
5436
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
5437
+ * - `item`: The identifier of the item whose metadata to clear.
5385
5438
  *
5386
5439
  * Emits `MetadataCleared`.
5387
5440
  *
5388
5441
  * Weight: `O(1)`
5389
5442
  **/
5390
- clearMetadata: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5443
+ clearMetadata: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5391
5444
  /**
5392
- * Issue a new class of non-fungible assets from a public origin.
5445
+ * Issue a new collection of non-fungible items from a public origin.
5393
5446
  *
5394
- * This new asset class has no assets initially and its owner is the origin.
5447
+ * This new collection has no items initially and its owner is the origin.
5395
5448
  *
5396
5449
  * The origin must be Signed and the sender must have sufficient funds free.
5397
5450
  *
5398
- * `AssetDeposit` funds of sender are reserved.
5451
+ * `ItemDeposit` funds of sender are reserved.
5399
5452
  *
5400
5453
  * Parameters:
5401
- * - `class`: The identifier of the new asset class. This must not be currently in use.
5402
- * - `admin`: The admin of this class of assets. The admin is the initial address of each
5403
- * member of the asset class's admin team.
5454
+ * - `collection`: The identifier of the new collection. This must not be currently in use.
5455
+ * - `admin`: The admin of this collection. The admin is the initial address of each
5456
+ * member of the collection's admin team.
5404
5457
  *
5405
5458
  * Emits `Created` event when successful.
5406
5459
  *
5407
5460
  * Weight: `O(1)`
5408
5461
  **/
5409
- create: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, admin: MultiAddress | {
5462
+ create: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, admin: MultiAddress | {
5410
5463
  Id: any;
5411
5464
  } | {
5412
5465
  Index: any;
@@ -5418,47 +5471,47 @@ declare module '@polkadot/api-base/types/submittable' {
5418
5471
  Address20: any;
5419
5472
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress]>;
5420
5473
  /**
5421
- * Destroy a class of fungible assets.
5474
+ * Destroy a collection of fungible items.
5422
5475
  *
5423
5476
  * The origin must conform to `ForceOrigin` or must be `Signed` and the sender must be the
5424
- * owner of the asset `class`.
5477
+ * owner of the `collection`.
5425
5478
  *
5426
- * - `class`: The identifier of the asset class to be destroyed.
5427
- * - `witness`: Information on the instances minted in the asset class. This must be
5479
+ * - `collection`: The identifier of the collection to be destroyed.
5480
+ * - `witness`: Information on the items minted in the collection. This must be
5428
5481
  * correct.
5429
5482
  *
5430
5483
  * Emits `Destroyed` event when successful.
5431
5484
  *
5432
5485
  * Weight: `O(n + m)` where:
5433
- * - `n = witness.instances`
5434
- * - `m = witness.instance_metadatas`
5486
+ * - `n = witness.items`
5487
+ * - `m = witness.item_metadatas`
5435
5488
  * - `a = witness.attributes`
5436
5489
  **/
5437
- destroy: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, witness: PalletUniquesDestroyWitness | {
5438
- instances?: any;
5439
- instanceMetadatas?: any;
5490
+ destroy: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, witness: PalletUniquesDestroyWitness | {
5491
+ items?: any;
5492
+ itemMetadatas?: any;
5440
5493
  attributes?: any;
5441
5494
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, PalletUniquesDestroyWitness]>;
5442
5495
  /**
5443
- * Alter the attributes of a given asset.
5496
+ * Issue a new collection of non-fungible items from a privileged origin.
5444
5497
  *
5445
- * Origin must be `ForceOrigin`.
5498
+ * This new collection has no items initially.
5446
5499
  *
5447
- * - `class`: The identifier of the asset.
5448
- * - `owner`: The new Owner of this asset.
5449
- * - `issuer`: The new Issuer of this asset.
5450
- * - `admin`: The new Admin of this asset.
5451
- * - `freezer`: The new Freezer of this asset.
5452
- * - `free_holding`: Whether a deposit is taken for holding an instance of this asset
5453
- * class.
5454
- * - `is_frozen`: Whether this asset class is frozen except for permissioned/admin
5455
- * instructions.
5500
+ * The origin must conform to `ForceOrigin`.
5456
5501
  *
5457
- * Emits `AssetStatusChanged` with the identity of the asset.
5502
+ * Unlike `create`, no funds are reserved.
5503
+ *
5504
+ * - `collection`: The identifier of the new item. This must not be currently in use.
5505
+ * - `owner`: The owner of this collection of items. The owner has full superuser
5506
+ * permissions
5507
+ * over this item, but may later change and configure the permissions using
5508
+ * `transfer_ownership` and `set_team`.
5509
+ *
5510
+ * Emits `ForceCreated` event when successful.
5458
5511
  *
5459
5512
  * Weight: `O(1)`
5460
5513
  **/
5461
- forceAssetStatus: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5514
+ forceCreate: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5462
5515
  Id: any;
5463
5516
  } | {
5464
5517
  Index: any;
@@ -5468,7 +5521,26 @@ declare module '@polkadot/api-base/types/submittable' {
5468
5521
  Address32: any;
5469
5522
  } | {
5470
5523
  Address20: any;
5471
- } | string | Uint8Array, issuer: MultiAddress | {
5524
+ } | string | Uint8Array, freeHolding: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress, bool]>;
5525
+ /**
5526
+ * Alter the attributes of a given item.
5527
+ *
5528
+ * Origin must be `ForceOrigin`.
5529
+ *
5530
+ * - `collection`: The identifier of the item.
5531
+ * - `owner`: The new Owner of this item.
5532
+ * - `issuer`: The new Issuer of this item.
5533
+ * - `admin`: The new Admin of this item.
5534
+ * - `freezer`: The new Freezer of this item.
5535
+ * - `free_holding`: Whether a deposit is taken for holding an item of this collection.
5536
+ * - `is_frozen`: Whether this collection is frozen except for permissioned/admin
5537
+ * instructions.
5538
+ *
5539
+ * Emits `ItemStatusChanged` with the identity of the item.
5540
+ *
5541
+ * Weight: `O(1)`
5542
+ **/
5543
+ forceItemStatus: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5472
5544
  Id: any;
5473
5545
  } | {
5474
5546
  Index: any;
@@ -5478,7 +5550,7 @@ declare module '@polkadot/api-base/types/submittable' {
5478
5550
  Address32: any;
5479
5551
  } | {
5480
5552
  Address20: any;
5481
- } | string | Uint8Array, admin: MultiAddress | {
5553
+ } | string | Uint8Array, issuer: MultiAddress | {
5482
5554
  Id: any;
5483
5555
  } | {
5484
5556
  Index: any;
@@ -5488,7 +5560,7 @@ declare module '@polkadot/api-base/types/submittable' {
5488
5560
  Address32: any;
5489
5561
  } | {
5490
5562
  Address20: any;
5491
- } | string | Uint8Array, freezer: MultiAddress | {
5563
+ } | string | Uint8Array, admin: MultiAddress | {
5492
5564
  Id: any;
5493
5565
  } | {
5494
5566
  Index: any;
@@ -5498,26 +5570,7 @@ declare module '@polkadot/api-base/types/submittable' {
5498
5570
  Address32: any;
5499
5571
  } | {
5500
5572
  Address20: any;
5501
- } | string | Uint8Array, freeHolding: bool | boolean | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress, MultiAddress, MultiAddress, MultiAddress, bool, bool]>;
5502
- /**
5503
- * Issue a new class of non-fungible assets from a privileged origin.
5504
- *
5505
- * This new asset class has no assets initially.
5506
- *
5507
- * The origin must conform to `ForceOrigin`.
5508
- *
5509
- * Unlike `create`, no funds are reserved.
5510
- *
5511
- * - `class`: The identifier of the new asset. This must not be currently in use.
5512
- * - `owner`: The owner of this class of assets. The owner has full superuser permissions
5513
- * over this asset, but may later change and configure the permissions using
5514
- * `transfer_ownership` and `set_team`.
5515
- *
5516
- * Emits `ForceCreated` event when successful.
5517
- *
5518
- * Weight: `O(1)`
5519
- **/
5520
- forceCreate: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5573
+ } | string | Uint8Array, freezer: MultiAddress | {
5521
5574
  Id: any;
5522
5575
  } | {
5523
5576
  Index: any;
@@ -5527,46 +5580,46 @@ declare module '@polkadot/api-base/types/submittable' {
5527
5580
  Address32: any;
5528
5581
  } | {
5529
5582
  Address20: any;
5530
- } | string | Uint8Array, freeHolding: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress, bool]>;
5583
+ } | string | Uint8Array, freeHolding: bool | boolean | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress, MultiAddress, MultiAddress, MultiAddress, bool, bool]>;
5531
5584
  /**
5532
- * Disallow further unprivileged transfer of an asset instance.
5585
+ * Disallow further unprivileged transfer of an item.
5533
5586
  *
5534
- * Origin must be Signed and the sender should be the Freezer of the asset `class`.
5587
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
5535
5588
  *
5536
- * - `class`: The class of the asset to be frozen.
5537
- * - `instance`: The instance of the asset to be frozen.
5589
+ * - `collection`: The collection of the item to be frozen.
5590
+ * - `item`: The item of the item to be frozen.
5538
5591
  *
5539
5592
  * Emits `Frozen`.
5540
5593
  *
5541
5594
  * Weight: `O(1)`
5542
5595
  **/
5543
- freeze: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5596
+ freeze: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5544
5597
  /**
5545
- * Disallow further unprivileged transfers for a whole asset class.
5598
+ * Disallow further unprivileged transfers for a whole collection.
5546
5599
  *
5547
- * Origin must be Signed and the sender should be the Freezer of the asset `class`.
5600
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
5548
5601
  *
5549
- * - `class`: The asset class to be frozen.
5602
+ * - `collection`: The collection to be frozen.
5550
5603
  *
5551
- * Emits `ClassFrozen`.
5604
+ * Emits `CollectionFrozen`.
5552
5605
  *
5553
5606
  * Weight: `O(1)`
5554
5607
  **/
5555
- freezeClass: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5608
+ freezeCollection: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5556
5609
  /**
5557
- * Mint an asset instance of a particular class.
5610
+ * Mint an item of a particular collection.
5558
5611
  *
5559
- * The origin must be Signed and the sender must be the Issuer of the asset `class`.
5612
+ * The origin must be Signed and the sender must be the Issuer of the `collection`.
5560
5613
  *
5561
- * - `class`: The class of the asset to be minted.
5562
- * - `instance`: The instance value of the asset to be minted.
5563
- * - `beneficiary`: The initial owner of the minted asset.
5614
+ * - `collection`: The collection of the item to be minted.
5615
+ * - `item`: The item value of the item to be minted.
5616
+ * - `beneficiary`: The initial owner of the minted item.
5564
5617
  *
5565
5618
  * Emits `Issued` event when successful.
5566
5619
  *
5567
5620
  * Weight: `O(1)`
5568
5621
  **/
5569
- mint: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5622
+ mint: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5570
5623
  Id: any;
5571
5624
  } | {
5572
5625
  Index: any;
@@ -5578,50 +5631,50 @@ declare module '@polkadot/api-base/types/submittable' {
5578
5631
  Address20: any;
5579
5632
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, MultiAddress]>;
5580
5633
  /**
5581
- * Reevaluate the deposits on some assets.
5634
+ * Reevaluate the deposits on some items.
5582
5635
  *
5583
- * Origin must be Signed and the sender should be the Owner of the asset `class`.
5636
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5584
5637
  *
5585
- * - `class`: The class of the asset to be frozen.
5586
- * - `instances`: The instances of the asset class whose deposits will be reevaluated.
5638
+ * - `collection`: The collection to be frozen.
5639
+ * - `items`: The items of the collection whose deposits will be reevaluated.
5587
5640
  *
5588
- * NOTE: This exists as a best-effort function. Any asset instances which are unknown or
5641
+ * NOTE: This exists as a best-effort function. Any items which are unknown or
5589
5642
  * in the case that the owner account does not have reservable funds to pay for a
5590
- * deposit increase are ignored. Generally the owner isn't going to call this on instances
5643
+ * deposit increase are ignored. Generally the owner isn't going to call this on items
5591
5644
  * whose existing deposit is less than the refreshed deposit as it would only cost them,
5592
5645
  * so it's of little consequence.
5593
5646
  *
5594
- * It will still return an error in the case that the class is unknown of the signer is
5595
- * not permitted to call it.
5647
+ * It will still return an error in the case that the collection is unknown of the signer
5648
+ * is not permitted to call it.
5596
5649
  *
5597
- * Weight: `O(instances.len())`
5650
+ * Weight: `O(items.len())`
5598
5651
  **/
5599
- redeposit: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instances: Vec<u32> | (u32 | AnyNumber | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [u32, Vec<u32>]>;
5652
+ redeposit: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, items: Vec<u32> | (u32 | AnyNumber | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [u32, Vec<u32>]>;
5600
5653
  /**
5601
5654
  * Set (or reset) the acceptance of ownership for a particular account.
5602
5655
  *
5603
- * Origin must be `Signed` and if `maybe_class` is `Some`, then the signer must have a
5656
+ * Origin must be `Signed` and if `maybe_collection` is `Some`, then the signer must have a
5604
5657
  * provider reference.
5605
5658
  *
5606
- * - `maybe_class`: The identifier of the asset class whose ownership the signer is willing
5607
- * to accept, or if `None`, an indication that the signer is willing to accept no
5659
+ * - `maybe_collection`: The identifier of the collection whose ownership the signer is
5660
+ * willing to accept, or if `None`, an indication that the signer is willing to accept no
5608
5661
  * ownership transferal.
5609
5662
  *
5610
5663
  * Emits `OwnershipAcceptanceChanged`.
5611
5664
  **/
5612
- setAcceptOwnership: AugmentedSubmittable<(maybeClass: Option<u32> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Option<u32>]>;
5665
+ setAcceptOwnership: AugmentedSubmittable<(maybeCollection: Option<u32> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Option<u32>]>;
5613
5666
  /**
5614
- * Set an attribute for an asset class or instance.
5667
+ * Set an attribute for a collection or item.
5615
5668
  *
5616
5669
  * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5617
- * asset `class`.
5670
+ * `collection`.
5618
5671
  *
5619
5672
  * If the origin is Signed, then funds of signer are reserved according to the formula:
5620
5673
  * `MetadataDepositBase + DepositPerByte * (key.len + value.len)` taking into
5621
5674
  * account any already reserved funds.
5622
5675
  *
5623
- * - `class`: The identifier of the asset class whose instance's metadata to set.
5624
- * - `maybe_instance`: The identifier of the asset instance whose metadata to set.
5676
+ * - `collection`: The identifier of the collection whose item's metadata to set.
5677
+ * - `maybe_item`: The identifier of the item whose metadata to set.
5625
5678
  * - `key`: The key of the attribute.
5626
5679
  * - `value`: The value to which to set the attribute.
5627
5680
  *
@@ -5629,61 +5682,75 @@ declare module '@polkadot/api-base/types/submittable' {
5629
5682
  *
5630
5683
  * Weight: `O(1)`
5631
5684
  **/
5632
- setAttribute: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, maybeInstance: Option<u32> | null | object | string | Uint8Array, key: Bytes | string | Uint8Array, value: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Option<u32>, Bytes, Bytes]>;
5685
+ setAttribute: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, maybeItem: Option<u32> | null | object | string | Uint8Array, key: Bytes | string | Uint8Array, value: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Option<u32>, Bytes, Bytes]>;
5686
+ /**
5687
+ * Set the maximum amount of items a collection could have.
5688
+ *
5689
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
5690
+ * the `collection`.
5691
+ *
5692
+ * Note: This function can only succeed once per collection.
5693
+ *
5694
+ * - `collection`: The identifier of the collection to change.
5695
+ * - `max_supply`: The maximum amount of items a collection could have.
5696
+ *
5697
+ * Emits `CollectionMaxSupplySet` event when successful.
5698
+ **/
5699
+ setCollectionMaxSupply: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, maxSupply: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5633
5700
  /**
5634
- * Set the metadata for an asset class.
5701
+ * Set the metadata for a collection.
5635
5702
  *
5636
5703
  * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
5637
- * the asset `class`.
5704
+ * the `collection`.
5638
5705
  *
5639
5706
  * If the origin is `Signed`, then funds of signer are reserved according to the formula:
5640
5707
  * `MetadataDepositBase + DepositPerByte * data.len` taking into
5641
5708
  * account any already reserved funds.
5642
5709
  *
5643
- * - `class`: The identifier of the asset whose metadata to update.
5644
- * - `data`: The general information of this asset. Limited in length by `StringLimit`.
5710
+ * - `collection`: The identifier of the item whose metadata to update.
5711
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
5645
5712
  * - `is_frozen`: Whether the metadata should be frozen against further changes.
5646
5713
  *
5647
- * Emits `ClassMetadataSet`.
5714
+ * Emits `CollectionMetadataSet`.
5648
5715
  *
5649
5716
  * Weight: `O(1)`
5650
5717
  **/
5651
- setClassMetadata: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Bytes, bool]>;
5718
+ setCollectionMetadata: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, Bytes, bool]>;
5652
5719
  /**
5653
- * Set the metadata for an asset instance.
5720
+ * Set the metadata for an item.
5654
5721
  *
5655
5722
  * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5656
- * asset `class`.
5723
+ * `collection`.
5657
5724
  *
5658
5725
  * If the origin is Signed, then funds of signer are reserved according to the formula:
5659
5726
  * `MetadataDepositBase + DepositPerByte * data.len` taking into
5660
5727
  * account any already reserved funds.
5661
5728
  *
5662
- * - `class`: The identifier of the asset class whose instance's metadata to set.
5663
- * - `instance`: The identifier of the asset instance whose metadata to set.
5664
- * - `data`: The general information of this asset. Limited in length by `StringLimit`.
5729
+ * - `collection`: The identifier of the collection whose item's metadata to set.
5730
+ * - `item`: The identifier of the item whose metadata to set.
5731
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
5665
5732
  * - `is_frozen`: Whether the metadata should be frozen against further changes.
5666
5733
  *
5667
5734
  * Emits `MetadataSet`.
5668
5735
  *
5669
5736
  * Weight: `O(1)`
5670
5737
  **/
5671
- setMetadata: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Bytes, bool]>;
5738
+ setMetadata: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array, isFrozen: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, Bytes, bool]>;
5672
5739
  /**
5673
- * Change the Issuer, Admin and Freezer of an asset class.
5740
+ * Change the Issuer, Admin and Freezer of a collection.
5674
5741
  *
5675
- * Origin must be Signed and the sender should be the Owner of the asset `class`.
5742
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5676
5743
  *
5677
- * - `class`: The asset class whose team should be changed.
5678
- * - `issuer`: The new Issuer of this asset class.
5679
- * - `admin`: The new Admin of this asset class.
5680
- * - `freezer`: The new Freezer of this asset class.
5744
+ * - `collection`: The collection whose team should be changed.
5745
+ * - `issuer`: The new Issuer of this collection.
5746
+ * - `admin`: The new Admin of this collection.
5747
+ * - `freezer`: The new Freezer of this collection.
5681
5748
  *
5682
5749
  * Emits `TeamChanged`.
5683
5750
  *
5684
5751
  * Weight: `O(1)`
5685
5752
  **/
5686
- setTeam: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, issuer: MultiAddress | {
5753
+ setTeam: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, issuer: MultiAddress | {
5687
5754
  Id: any;
5688
5755
  } | {
5689
5756
  Index: any;
@@ -5715,48 +5782,48 @@ declare module '@polkadot/api-base/types/submittable' {
5715
5782
  Address20: any;
5716
5783
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress, MultiAddress, MultiAddress]>;
5717
5784
  /**
5718
- * Re-allow unprivileged transfer of an asset instance.
5785
+ * Re-allow unprivileged transfer of an item.
5719
5786
  *
5720
- * Origin must be Signed and the sender should be the Freezer of the asset `class`.
5787
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
5721
5788
  *
5722
- * - `class`: The class of the asset to be thawed.
5723
- * - `instance`: The instance of the asset to be thawed.
5789
+ * - `collection`: The collection of the item to be thawed.
5790
+ * - `item`: The item of the item to be thawed.
5724
5791
  *
5725
5792
  * Emits `Thawed`.
5726
5793
  *
5727
5794
  * Weight: `O(1)`
5728
5795
  **/
5729
- thaw: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5796
+ thaw: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
5730
5797
  /**
5731
- * Re-allow unprivileged transfers for a whole asset class.
5798
+ * Re-allow unprivileged transfers for a whole collection.
5732
5799
  *
5733
- * Origin must be Signed and the sender should be the Admin of the asset `class`.
5800
+ * Origin must be Signed and the sender should be the Admin of the `collection`.
5734
5801
  *
5735
- * - `class`: The class to be thawed.
5802
+ * - `collection`: The collection to be thawed.
5736
5803
  *
5737
- * Emits `ClassThawed`.
5804
+ * Emits `CollectionThawed`.
5738
5805
  *
5739
5806
  * Weight: `O(1)`
5740
5807
  **/
5741
- thawClass: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5808
+ thawCollection: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5742
5809
  /**
5743
- * Move an asset from the sender account to another.
5810
+ * Move an item from the sender account to another.
5744
5811
  *
5745
5812
  * Origin must be Signed and the signing account must be either:
5746
- * - the Admin of the asset `class`;
5747
- * - the Owner of the asset `instance`;
5748
- * - the approved delegate for the asset `instance` (in this case, the approval is reset).
5813
+ * - the Admin of the `collection`;
5814
+ * - the Owner of the `item`;
5815
+ * - the approved delegate for the `item` (in this case, the approval is reset).
5749
5816
  *
5750
5817
  * Arguments:
5751
- * - `class`: The class of the asset to be transferred.
5752
- * - `instance`: The instance of the asset to be transferred.
5753
- * - `dest`: The account to receive ownership of the asset.
5818
+ * - `collection`: The collection of the item to be transferred.
5819
+ * - `item`: The item of the item to be transferred.
5820
+ * - `dest`: The account to receive ownership of the item.
5754
5821
  *
5755
5822
  * Emits `Transferred`.
5756
5823
  *
5757
5824
  * Weight: `O(1)`
5758
5825
  **/
5759
- transfer: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, instance: u32 | AnyNumber | Uint8Array, dest: MultiAddress | {
5826
+ transfer: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, item: u32 | AnyNumber | Uint8Array, dest: MultiAddress | {
5760
5827
  Id: any;
5761
5828
  } | {
5762
5829
  Index: any;
@@ -5768,19 +5835,19 @@ declare module '@polkadot/api-base/types/submittable' {
5768
5835
  Address20: any;
5769
5836
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, MultiAddress]>;
5770
5837
  /**
5771
- * Change the Owner of an asset class.
5838
+ * Change the Owner of a collection.
5772
5839
  *
5773
- * Origin must be Signed and the sender should be the Owner of the asset `class`.
5840
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5774
5841
  *
5775
- * - `class`: The asset class whose owner should be changed.
5776
- * - `owner`: The new Owner of this asset class. They must have called
5777
- * `set_accept_ownership` with `class` in order for this operation to succeed.
5842
+ * - `collection`: The collection whose owner should be changed.
5843
+ * - `owner`: The new Owner of this collection. They must have called
5844
+ * `set_accept_ownership` with `collection` in order for this operation to succeed.
5778
5845
  *
5779
5846
  * Emits `OwnerChanged`.
5780
5847
  *
5781
5848
  * Weight: `O(1)`
5782
5849
  **/
5783
- transferOwnership: AugmentedSubmittable<(clazz: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5850
+ transferOwnership: AugmentedSubmittable<(collection: u32 | AnyNumber | Uint8Array, owner: MultiAddress | {
5784
5851
  Id: any;
5785
5852
  } | {
5786
5853
  Index: any;