@dedot/chaintypes 0.20.0 → 0.22.0

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.
@@ -63,7 +63,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
63
63
  **/
64
64
  system: {
65
65
  /**
66
- * See [`Pallet::remark`].
66
+ * Make some on-chain remark.
67
+ *
68
+ * Can be executed by every `origin`.
67
69
  *
68
70
  * @param {BytesLike} remark
69
71
  **/
@@ -82,7 +84,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
82
84
  >;
83
85
 
84
86
  /**
85
- * See [`Pallet::set_heap_pages`].
87
+ * Set the number of pages in the WebAssembly environment's heap.
86
88
  *
87
89
  * @param {bigint} pages
88
90
  **/
@@ -101,7 +103,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
101
103
  >;
102
104
 
103
105
  /**
104
- * See [`Pallet::set_code`].
106
+ * Set the new runtime code.
105
107
  *
106
108
  * @param {BytesLike} code
107
109
  **/
@@ -120,7 +122,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
120
122
  >;
121
123
 
122
124
  /**
123
- * See [`Pallet::set_code_without_checks`].
125
+ * Set the new runtime code without doing any checks of the given `code`.
126
+ *
127
+ * Note that runtime upgrades will not run if this is called with a not-increasing spec
128
+ * version!
124
129
  *
125
130
  * @param {BytesLike} code
126
131
  **/
@@ -139,7 +144,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
139
144
  >;
140
145
 
141
146
  /**
142
- * See [`Pallet::set_storage`].
147
+ * Set some items of storage.
143
148
  *
144
149
  * @param {Array<[BytesLike, BytesLike]>} items
145
150
  **/
@@ -158,7 +163,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
158
163
  >;
159
164
 
160
165
  /**
161
- * See [`Pallet::kill_storage`].
166
+ * Kill some items from storage.
162
167
  *
163
168
  * @param {Array<BytesLike>} keys
164
169
  **/
@@ -177,7 +182,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
177
182
  >;
178
183
 
179
184
  /**
180
- * See [`Pallet::kill_prefix`].
185
+ * Kill all storage items with a key that starts with the given prefix.
186
+ *
187
+ * **NOTE:** We rely on the Root origin to provide us the number of subkeys under
188
+ * the prefix we are removing to accurately calculate the weight of this function.
181
189
  *
182
190
  * @param {BytesLike} prefix
183
191
  * @param {number} subkeys
@@ -200,7 +208,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
200
208
  >;
201
209
 
202
210
  /**
203
- * See [`Pallet::remark_with_event`].
211
+ * Make some on-chain remark and emit event.
204
212
  *
205
213
  * @param {BytesLike} remark
206
214
  **/
@@ -219,7 +227,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
219
227
  >;
220
228
 
221
229
  /**
222
- * See [`Pallet::authorize_upgrade`].
230
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
231
+ * later.
232
+ *
233
+ * This call requires Root origin.
223
234
  *
224
235
  * @param {H256} codeHash
225
236
  **/
@@ -238,7 +249,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
238
249
  >;
239
250
 
240
251
  /**
241
- * See [`Pallet::authorize_upgrade_without_checks`].
252
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
253
+ * later.
254
+ *
255
+ * WARNING: This authorizes an upgrade that will take place without any safety checks, for
256
+ * example that the spec name remains the same and that the version number increases. Not
257
+ * recommended for normal use. Use `authorize_upgrade` instead.
258
+ *
259
+ * This call requires Root origin.
242
260
  *
243
261
  * @param {H256} codeHash
244
262
  **/
@@ -257,7 +275,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
257
275
  >;
258
276
 
259
277
  /**
260
- * See [`Pallet::apply_authorized_upgrade`].
278
+ * Provide the preimage (runtime binary) `code` for an upgrade that has been authorized.
279
+ *
280
+ * If the authorization required a version check, this call will ensure the spec name
281
+ * remains unchanged and that the spec version has increased.
282
+ *
283
+ * Depending on the runtime's `OnSetCode` configuration, this function may directly apply
284
+ * the new `code` in the same block or attempt to schedule the upgrade.
285
+ *
286
+ * All origins are allowed.
261
287
  *
262
288
  * @param {BytesLike} code
263
289
  **/
@@ -285,7 +311,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
285
311
  **/
286
312
  parachainSystem: {
287
313
  /**
288
- * See [`Pallet::set_validation_data`].
314
+ * Set the current validation data.
315
+ *
316
+ * This should be invoked exactly once per block. It will panic at the finalization
317
+ * phase if the call was not invoked.
318
+ *
319
+ * The dispatch origin for this call must be `Inherent`
320
+ *
321
+ * As a side effect, this function upgrades the current validation function
322
+ * if the appropriate time has come.
289
323
  *
290
324
  * @param {CumulusPrimitivesParachainInherentParachainInherentData} data
291
325
  **/
@@ -304,7 +338,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
304
338
  >;
305
339
 
306
340
  /**
307
- * See [`Pallet::sudo_send_upward_message`].
308
341
  *
309
342
  * @param {BytesLike} message
310
343
  **/
@@ -323,7 +356,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
323
356
  >;
324
357
 
325
358
  /**
326
- * See [`Pallet::authorize_upgrade`].
359
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
360
+ * later.
361
+ *
362
+ * The `check_version` parameter sets a boolean flag for whether or not the runtime's spec
363
+ * version and name should be verified on upgrade. Since the authorization only has a hash,
364
+ * it cannot actually perform the verification.
365
+ *
366
+ * This call requires Root origin.
327
367
  *
328
368
  * @param {H256} codeHash
329
369
  * @param {boolean} checkVersion
@@ -346,7 +386,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
346
386
  >;
347
387
 
348
388
  /**
349
- * See [`Pallet::enact_authorized_upgrade`].
389
+ * Provide the preimage (runtime binary) `code` for an upgrade that has been authorized.
390
+ *
391
+ * If the authorization required a version check, this call will ensure the spec name
392
+ * remains unchanged and that the spec version has increased.
393
+ *
394
+ * Note that this function will not apply the new `code`, but only attempt to schedule the
395
+ * upgrade with the Relay Chain.
396
+ *
397
+ * All origins are allowed.
350
398
  *
351
399
  * @param {BytesLike} code
352
400
  **/
@@ -374,7 +422,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
374
422
  **/
375
423
  timestamp: {
376
424
  /**
377
- * See [`Pallet::set`].
425
+ * Set the current time.
426
+ *
427
+ * This call should be invoked exactly once per block. It will panic at the finalization
428
+ * phase, if this call hasn't been invoked by that time.
429
+ *
430
+ * The timestamp should be greater than the previous one by the amount specified by
431
+ * [`Config::MinimumPeriod`].
432
+ *
433
+ * The dispatch origin for this call must be _None_.
434
+ *
435
+ * This dispatch class is _Mandatory_ to ensure it gets executed in the block. Be aware
436
+ * that changing the complexity of this call could result exhausting the resources in a
437
+ * block to execute any other calls.
438
+ *
439
+ * ## Complexity
440
+ * - `O(1)` (Note that implementations of `OnTimestampSet` must also be `O(1)`)
441
+ * - 1 storage read and 1 storage mutation (codec `O(1)` because of `DidUpdate::take` in
442
+ * `on_finalize`)
443
+ * - 1 event handler `on_timestamp_set`. Must be `O(1)`.
378
444
  *
379
445
  * @param {bigint} now
380
446
  **/
@@ -411,7 +477,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
411
477
  **/
412
478
  balances: {
413
479
  /**
414
- * See [`Pallet::transfer_allow_death`].
480
+ * Transfer some liquid free balance to another account.
481
+ *
482
+ * `transfer_allow_death` will set the `FreeBalance` of the sender and receiver.
483
+ * If the sender's account is below the existential deposit as a result
484
+ * of the transfer, the account will be reaped.
485
+ *
486
+ * The dispatch origin for this call must be `Signed` by the transactor.
415
487
  *
416
488
  * @param {MultiAddressLike} dest
417
489
  * @param {bigint} value
@@ -434,7 +506,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
434
506
  >;
435
507
 
436
508
  /**
437
- * See [`Pallet::force_transfer`].
509
+ * Exactly as `transfer_allow_death`, except the origin must be root and the source account
510
+ * may be specified.
438
511
  *
439
512
  * @param {MultiAddressLike} source
440
513
  * @param {MultiAddressLike} dest
@@ -459,7 +532,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
459
532
  >;
460
533
 
461
534
  /**
462
- * See [`Pallet::transfer_keep_alive`].
535
+ * Same as the [`transfer_allow_death`] call, but with a check that the transfer will not
536
+ * kill the origin account.
537
+ *
538
+ * 99% of the time you want [`transfer_allow_death`] instead.
539
+ *
540
+ * [`transfer_allow_death`]: struct.Pallet.html#method.transfer
463
541
  *
464
542
  * @param {MultiAddressLike} dest
465
543
  * @param {bigint} value
@@ -482,7 +560,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
482
560
  >;
483
561
 
484
562
  /**
485
- * See [`Pallet::transfer_all`].
563
+ * Transfer the entire transferable balance from the caller account.
564
+ *
565
+ * NOTE: This function only attempts to transfer _transferable_ balances. This means that
566
+ * any locked, reserved, or existential deposits (when `keep_alive` is `true`), will not be
567
+ * transferred by this function. To ensure that this function results in a killed account,
568
+ * you might need to prepare the account by removing any reference counters, storage
569
+ * deposits, etc...
570
+ *
571
+ * The dispatch origin of this call must be Signed.
572
+ *
573
+ * - `dest`: The recipient of the transfer.
574
+ * - `keep_alive`: A boolean to determine if the `transfer_all` operation should send all
575
+ * of the funds the account has, causing the sender account to be killed (false), or
576
+ * transfer everything except at least the existential deposit, which will guarantee to
577
+ * keep the sender account alive (true).
486
578
  *
487
579
  * @param {MultiAddressLike} dest
488
580
  * @param {boolean} keepAlive
@@ -505,7 +597,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
505
597
  >;
506
598
 
507
599
  /**
508
- * See [`Pallet::force_unreserve`].
600
+ * Unreserve some balance from a user by force.
601
+ *
602
+ * Can only be called by ROOT.
509
603
  *
510
604
  * @param {MultiAddressLike} who
511
605
  * @param {bigint} amount
@@ -528,7 +622,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
528
622
  >;
529
623
 
530
624
  /**
531
- * See [`Pallet::upgrade_accounts`].
625
+ * Upgrade a specified account.
626
+ *
627
+ * - `origin`: Must be `Signed`.
628
+ * - `who`: The account to be upgraded.
629
+ *
630
+ * This will waive the transaction fee if at least all but 10% of the accounts needed to
631
+ * be upgraded. (We let some not have to be upgraded just in order to allow for the
632
+ * possibility of churn).
532
633
  *
533
634
  * @param {Array<AccountId32Like>} who
534
635
  **/
@@ -547,7 +648,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
547
648
  >;
548
649
 
549
650
  /**
550
- * See [`Pallet::force_set_balance`].
651
+ * Set the regular balance of a given account.
652
+ *
653
+ * The dispatch origin for this call is `root`.
551
654
  *
552
655
  * @param {MultiAddressLike} who
553
656
  * @param {bigint} newFree
@@ -570,7 +673,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
570
673
  >;
571
674
 
572
675
  /**
573
- * See [`Pallet::force_adjust_total_issuance`].
676
+ * Adjust the total issuance in a saturating way.
677
+ *
678
+ * Can only be called by root and always needs a positive `delta`.
679
+ *
680
+ * # Example
574
681
  *
575
682
  * @param {PalletBalancesAdjustmentDirection} direction
576
683
  * @param {bigint} delta
@@ -592,6 +699,35 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
592
699
  >
593
700
  >;
594
701
 
702
+ /**
703
+ * Burn the specified liquid free balance from the origin account.
704
+ *
705
+ * If the origin's account ends up below the existential deposit as a result
706
+ * of the burn and `keep_alive` is false, the account will be reaped.
707
+ *
708
+ * Unlike sending funds to a _burn_ address, which merely makes the funds inaccessible,
709
+ * this `burn` operation will reduce total issuance by the amount _burned_.
710
+ *
711
+ * @param {bigint} value
712
+ * @param {boolean} keepAlive
713
+ **/
714
+ burn: GenericTxCall<
715
+ Rv,
716
+ (
717
+ value: bigint,
718
+ keepAlive: boolean,
719
+ ) => ChainSubmittableExtrinsic<
720
+ Rv,
721
+ {
722
+ pallet: 'Balances';
723
+ palletCall: {
724
+ name: 'Burn';
725
+ params: { value: bigint; keepAlive: boolean };
726
+ };
727
+ }
728
+ >
729
+ >;
730
+
595
731
  /**
596
732
  * Generic pallet tx call
597
733
  **/
@@ -602,7 +738,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
602
738
  **/
603
739
  vesting: {
604
740
  /**
605
- * See [`Pallet::vest`].
741
+ * Unlock any vested funds of the sender account.
742
+ *
743
+ * The dispatch origin for this call must be _Signed_ and the sender must have funds still
744
+ * locked under this pallet.
745
+ *
746
+ * Emits either `VestingCompleted` or `VestingUpdated`.
747
+ *
748
+ * ## Complexity
749
+ * - `O(1)`.
606
750
  *
607
751
  **/
608
752
  vest: GenericTxCall<
@@ -619,7 +763,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
619
763
  >;
620
764
 
621
765
  /**
622
- * See [`Pallet::vest_other`].
766
+ * Unlock any vested funds of a `target` account.
767
+ *
768
+ * The dispatch origin for this call must be _Signed_.
769
+ *
770
+ * - `target`: The account whose vested funds should be unlocked. Must have funds still
771
+ * locked under this pallet.
772
+ *
773
+ * Emits either `VestingCompleted` or `VestingUpdated`.
774
+ *
775
+ * ## Complexity
776
+ * - `O(1)`.
623
777
  *
624
778
  * @param {MultiAddressLike} target
625
779
  **/
@@ -638,7 +792,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
638
792
  >;
639
793
 
640
794
  /**
641
- * See [`Pallet::vested_transfer`].
795
+ * Create a vested transfer.
796
+ *
797
+ * The dispatch origin for this call must be _Signed_.
798
+ *
799
+ * - `target`: The account receiving the vested funds.
800
+ * - `schedule`: The vesting schedule attached to the transfer.
801
+ *
802
+ * Emits `VestingCreated`.
803
+ *
804
+ * NOTE: This will unlock all schedules through the current block.
805
+ *
806
+ * ## Complexity
807
+ * - `O(1)`.
642
808
  *
643
809
  * @param {MultiAddressLike} target
644
810
  * @param {PalletVestingVestingInfo} schedule
@@ -661,7 +827,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
661
827
  >;
662
828
 
663
829
  /**
664
- * See [`Pallet::force_vested_transfer`].
830
+ * Force a vested transfer.
831
+ *
832
+ * The dispatch origin for this call must be _Root_.
833
+ *
834
+ * - `source`: The account whose funds should be transferred.
835
+ * - `target`: The account that should be transferred the vested funds.
836
+ * - `schedule`: The vesting schedule attached to the transfer.
837
+ *
838
+ * Emits `VestingCreated`.
839
+ *
840
+ * NOTE: This will unlock all schedules through the current block.
841
+ *
842
+ * ## Complexity
843
+ * - `O(1)`.
665
844
  *
666
845
  * @param {MultiAddressLike} source
667
846
  * @param {MultiAddressLike} target
@@ -686,7 +865,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
686
865
  >;
687
866
 
688
867
  /**
689
- * See [`Pallet::merge_schedules`].
868
+ * Merge two vesting schedules together, creating a new vesting schedule that unlocks over
869
+ * the highest possible start and end blocks. If both schedules have already started the
870
+ * current block will be used as the schedule start; with the caveat that if one schedule
871
+ * is finished by the current block, the other will be treated as the new merged schedule,
872
+ * unmodified.
873
+ *
874
+ * NOTE: If `schedule1_index == schedule2_index` this is a no-op.
875
+ * NOTE: This will unlock all schedules through the current block prior to merging.
876
+ * NOTE: If both schedules have ended by the current block, no new schedule will be created
877
+ * and both will be removed.
878
+ *
879
+ * Merged schedule attributes:
880
+ * - `starting_block`: `MAX(schedule1.starting_block, scheduled2.starting_block,
881
+ * current_block)`.
882
+ * - `ending_block`: `MAX(schedule1.ending_block, schedule2.ending_block)`.
883
+ * - `locked`: `schedule1.locked_at(current_block) + schedule2.locked_at(current_block)`.
884
+ *
885
+ * The dispatch origin for this call must be _Signed_.
886
+ *
887
+ * - `schedule1_index`: index of the first schedule to merge.
888
+ * - `schedule2_index`: index of the second schedule to merge.
690
889
  *
691
890
  * @param {number} schedule1Index
692
891
  * @param {number} schedule2Index
@@ -709,7 +908,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
709
908
  >;
710
909
 
711
910
  /**
712
- * See [`Pallet::force_remove_vesting_schedule`].
911
+ * Force remove a vesting schedule
912
+ *
913
+ * The dispatch origin for this call must be _Root_.
914
+ *
915
+ * - `target`: An account that has a vesting schedule
916
+ * - `schedule_index`: The vesting schedule index that should be removed
713
917
  *
714
918
  * @param {MultiAddressLike} target
715
919
  * @param {number} scheduleIndex
@@ -741,7 +945,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
741
945
  **/
742
946
  collatorSelection: {
743
947
  /**
744
- * See [`Pallet::set_invulnerables`].
948
+ * Set the list of invulnerable (fixed) collators. These collators must do some
949
+ * preparation, namely to have registered session keys.
950
+ *
951
+ * The call will remove any accounts that have not registered keys from the set. That is,
952
+ * it is non-atomic; the caller accepts all `AccountId`s passed in `new` _individually_ as
953
+ * acceptable Invulnerables, and is not proposing a _set_ of new Invulnerables.
954
+ *
955
+ * This call does not maintain mutual exclusivity of `Invulnerables` and `Candidates`. It
956
+ * is recommended to use a batch of `add_invulnerable` and `remove_invulnerable` instead. A
957
+ * `batch_all` can also be used to enforce atomicity. If any candidates are included in
958
+ * `new`, they should be removed with `remove_invulnerable_candidate` after execution.
959
+ *
960
+ * Must be called by the `UpdateOrigin`.
745
961
  *
746
962
  * @param {Array<AccountId32Like>} new_
747
963
  **/
@@ -760,7 +976,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
760
976
  >;
761
977
 
762
978
  /**
763
- * See [`Pallet::set_desired_candidates`].
979
+ * Set the ideal number of non-invulnerable collators. If lowering this number, then the
980
+ * number of running collators could be higher than this figure. Aside from that edge case,
981
+ * there should be no other way to have more candidates than the desired number.
982
+ *
983
+ * The origin for this call must be the `UpdateOrigin`.
764
984
  *
765
985
  * @param {number} max
766
986
  **/
@@ -779,7 +999,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
779
999
  >;
780
1000
 
781
1001
  /**
782
- * See [`Pallet::set_candidacy_bond`].
1002
+ * Set the candidacy bond amount.
1003
+ *
1004
+ * If the candidacy bond is increased by this call, all current candidates which have a
1005
+ * deposit lower than the new bond will be kicked from the list and get their deposits
1006
+ * back.
1007
+ *
1008
+ * The origin for this call must be the `UpdateOrigin`.
783
1009
  *
784
1010
  * @param {bigint} bond
785
1011
  **/
@@ -798,7 +1024,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
798
1024
  >;
799
1025
 
800
1026
  /**
801
- * See [`Pallet::register_as_candidate`].
1027
+ * Register this account as a collator candidate. The account must (a) already have
1028
+ * registered session keys and (b) be able to reserve the `CandidacyBond`.
1029
+ *
1030
+ * This call is not available to `Invulnerable` collators.
802
1031
  *
803
1032
  **/
804
1033
  registerAsCandidate: GenericTxCall<
@@ -815,7 +1044,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
815
1044
  >;
816
1045
 
817
1046
  /**
818
- * See [`Pallet::leave_intent`].
1047
+ * Deregister `origin` as a collator candidate. Note that the collator can only leave on
1048
+ * session change. The `CandidacyBond` will be unreserved immediately.
1049
+ *
1050
+ * This call will fail if the total number of candidates would drop below
1051
+ * `MinEligibleCollators`.
819
1052
  *
820
1053
  **/
821
1054
  leaveIntent: GenericTxCall<
@@ -832,7 +1065,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
832
1065
  >;
833
1066
 
834
1067
  /**
835
- * See [`Pallet::add_invulnerable`].
1068
+ * Add a new account `who` to the list of `Invulnerables` collators. `who` must have
1069
+ * registered session keys. If `who` is a candidate, they will be removed.
1070
+ *
1071
+ * The origin for this call must be the `UpdateOrigin`.
836
1072
  *
837
1073
  * @param {AccountId32Like} who
838
1074
  **/
@@ -851,7 +1087,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
851
1087
  >;
852
1088
 
853
1089
  /**
854
- * See [`Pallet::remove_invulnerable`].
1090
+ * Remove an account `who` from the list of `Invulnerables` collators. `Invulnerables` must
1091
+ * be sorted.
1092
+ *
1093
+ * The origin for this call must be the `UpdateOrigin`.
855
1094
  *
856
1095
  * @param {AccountId32Like} who
857
1096
  **/
@@ -870,7 +1109,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
870
1109
  >;
871
1110
 
872
1111
  /**
873
- * See [`Pallet::update_bond`].
1112
+ * Update the candidacy bond of collator candidate `origin` to a new amount `new_deposit`.
1113
+ *
1114
+ * Setting a `new_deposit` that is lower than the current deposit while `origin` is
1115
+ * occupying a top-`DesiredCandidates` slot is not allowed.
1116
+ *
1117
+ * This call will fail if `origin` is not a collator candidate, the updated bond is lower
1118
+ * than the minimum candidacy bond, and/or the amount cannot be reserved.
874
1119
  *
875
1120
  * @param {bigint} newDeposit
876
1121
  **/
@@ -889,7 +1134,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
889
1134
  >;
890
1135
 
891
1136
  /**
892
- * See [`Pallet::take_candidate_slot`].
1137
+ * The caller `origin` replaces a candidate `target` in the collator candidate list by
1138
+ * reserving `deposit`. The amount `deposit` reserved by the caller must be greater than
1139
+ * the existing bond of the target it is trying to replace.
1140
+ *
1141
+ * This call will fail if the caller is already a collator candidate or invulnerable, the
1142
+ * caller does not have registered session keys, the target is not a collator candidate,
1143
+ * and/or the `deposit` amount cannot be reserved.
893
1144
  *
894
1145
  * @param {bigint} deposit
895
1146
  * @param {AccountId32Like} target
@@ -921,7 +1172,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
921
1172
  **/
922
1173
  session: {
923
1174
  /**
924
- * See [`Pallet::set_keys`].
1175
+ * Sets the session key(s) of the function caller to `keys`.
1176
+ * Allows an account to set its session key prior to becoming a validator.
1177
+ * This doesn't take effect until the next session.
1178
+ *
1179
+ * The dispatch origin of this function must be signed.
1180
+ *
1181
+ * ## Complexity
1182
+ * - `O(1)`. Actual cost depends on the number of length of `T::Keys::key_ids()` which is
1183
+ * fixed.
925
1184
  *
926
1185
  * @param {AssetHubPolkadotRuntimeSessionKeys} keys
927
1186
  * @param {BytesLike} proof
@@ -944,7 +1203,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
944
1203
  >;
945
1204
 
946
1205
  /**
947
- * See [`Pallet::purge_keys`].
1206
+ * Removes any session key(s) of the function caller.
1207
+ *
1208
+ * This doesn't take effect until the next session.
1209
+ *
1210
+ * The dispatch origin of this function must be Signed and the account must be either be
1211
+ * convertible to a validator ID using the chain's typical addressing system (this usually
1212
+ * means being a controller account) or directly convertible into a validator ID (which
1213
+ * usually means being a stash account).
1214
+ *
1215
+ * ## Complexity
1216
+ * - `O(1)` in number of key types. Actual cost depends on the number of length of
1217
+ * `T::Keys::key_ids()` which is fixed.
948
1218
  *
949
1219
  **/
950
1220
  purgeKeys: GenericTxCall<
@@ -970,7 +1240,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
970
1240
  **/
971
1241
  xcmpQueue: {
972
1242
  /**
973
- * See [`Pallet::suspend_xcm_execution`].
1243
+ * Suspends all XCM executions for the XCMP queue, regardless of the sender's origin.
1244
+ *
1245
+ * - `origin`: Must pass `ControllerOrigin`.
974
1246
  *
975
1247
  **/
976
1248
  suspendXcmExecution: GenericTxCall<
@@ -987,7 +1259,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
987
1259
  >;
988
1260
 
989
1261
  /**
990
- * See [`Pallet::resume_xcm_execution`].
1262
+ * Resumes all XCM executions for the XCMP queue.
1263
+ *
1264
+ * Note that this function doesn't change the status of the in/out bound channels.
1265
+ *
1266
+ * - `origin`: Must pass `ControllerOrigin`.
991
1267
  *
992
1268
  **/
993
1269
  resumeXcmExecution: GenericTxCall<
@@ -1004,7 +1280,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1004
1280
  >;
1005
1281
 
1006
1282
  /**
1007
- * See [`Pallet::update_suspend_threshold`].
1283
+ * Overwrites the number of pages which must be in the queue for the other side to be
1284
+ * told to suspend their sending.
1285
+ *
1286
+ * - `origin`: Must pass `Root`.
1287
+ * - `new`: Desired value for `QueueConfigData.suspend_value`
1008
1288
  *
1009
1289
  * @param {number} new_
1010
1290
  **/
@@ -1023,7 +1303,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1023
1303
  >;
1024
1304
 
1025
1305
  /**
1026
- * See [`Pallet::update_drop_threshold`].
1306
+ * Overwrites the number of pages which must be in the queue after which we drop any
1307
+ * further messages from the channel.
1308
+ *
1309
+ * - `origin`: Must pass `Root`.
1310
+ * - `new`: Desired value for `QueueConfigData.drop_threshold`
1027
1311
  *
1028
1312
  * @param {number} new_
1029
1313
  **/
@@ -1042,7 +1326,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1042
1326
  >;
1043
1327
 
1044
1328
  /**
1045
- * See [`Pallet::update_resume_threshold`].
1329
+ * Overwrites the number of pages which the queue must be reduced to before it signals
1330
+ * that message sending may recommence after it has been suspended.
1331
+ *
1332
+ * - `origin`: Must pass `Root`.
1333
+ * - `new`: Desired value for `QueueConfigData.resume_threshold`
1046
1334
  *
1047
1335
  * @param {number} new_
1048
1336
  **/
@@ -1070,7 +1358,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1070
1358
  **/
1071
1359
  polkadotXcm: {
1072
1360
  /**
1073
- * See [`Pallet::send`].
1074
1361
  *
1075
1362
  * @param {XcmVersionedLocation} dest
1076
1363
  * @param {XcmVersionedXcm} message
@@ -1093,7 +1380,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1093
1380
  >;
1094
1381
 
1095
1382
  /**
1096
- * See [`Pallet::teleport_assets`].
1383
+ * Teleport some assets from the local chain to some destination chain.
1384
+ *
1385
+ * **This function is deprecated: Use `limited_teleport_assets` instead.**
1386
+ *
1387
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
1388
+ * index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
1389
+ * with all fees taken as needed from the asset.
1390
+ *
1391
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1392
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
1393
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
1394
+ * relay to parachain.
1395
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
1396
+ * generally be an `AccountId32` value.
1397
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1398
+ * fee on the `dest` chain.
1399
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
1400
+ * fees.
1097
1401
  *
1098
1402
  * @param {XcmVersionedLocation} dest
1099
1403
  * @param {XcmVersionedLocation} beneficiary
@@ -1125,7 +1429,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1125
1429
  >;
1126
1430
 
1127
1431
  /**
1128
- * See [`Pallet::reserve_transfer_assets`].
1432
+ * Transfer some assets from the local chain to the destination chain through their local,
1433
+ * destination or remote reserve.
1434
+ *
1435
+ * `assets` must have same reserve location and may not be teleportable to `dest`.
1436
+ * - `assets` have local reserve: transfer assets to sovereign account of destination
1437
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
1438
+ * assets to `beneficiary`.
1439
+ * - `assets` have destination reserve: burn local assets and forward a notification to
1440
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
1441
+ * deposit them to `beneficiary`.
1442
+ * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
1443
+ * reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
1444
+ * to mint and deposit reserve-based assets to `beneficiary`.
1445
+ *
1446
+ * **This function is deprecated: Use `limited_reserve_transfer_assets` instead.**
1447
+ *
1448
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
1449
+ * index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
1450
+ * with all fees taken as needed from the asset.
1451
+ *
1452
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1453
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
1454
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
1455
+ * relay to parachain.
1456
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
1457
+ * generally be an `AccountId32` value.
1458
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1459
+ * fee on the `dest` (and possibly reserve) chains.
1460
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
1461
+ * fees.
1129
1462
  *
1130
1463
  * @param {XcmVersionedLocation} dest
1131
1464
  * @param {XcmVersionedLocation} beneficiary
@@ -1157,7 +1490,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1157
1490
  >;
1158
1491
 
1159
1492
  /**
1160
- * See [`Pallet::execute`].
1493
+ * Execute an XCM message from a local, signed, origin.
1494
+ *
1495
+ * An event is deposited indicating whether `msg` could be executed completely or only
1496
+ * partially.
1497
+ *
1498
+ * No more than `max_weight` will be used in its attempted execution. If this is less than
1499
+ * the maximum amount of weight that the message could take to be executed, then no
1500
+ * execution attempt will be made.
1161
1501
  *
1162
1502
  * @param {XcmVersionedXcm} message
1163
1503
  * @param {SpWeightsWeightV2Weight} maxWeight
@@ -1180,7 +1520,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1180
1520
  >;
1181
1521
 
1182
1522
  /**
1183
- * See [`Pallet::force_xcm_version`].
1523
+ * Extoll that a particular destination can be communicated with through a particular
1524
+ * version of XCM.
1525
+ *
1526
+ * - `origin`: Must be an origin specified by AdminOrigin.
1527
+ * - `location`: The destination that is being described.
1528
+ * - `xcm_version`: The latest version of XCM that `location` supports.
1184
1529
  *
1185
1530
  * @param {StagingXcmV4Location} location
1186
1531
  * @param {number} version
@@ -1203,7 +1548,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1203
1548
  >;
1204
1549
 
1205
1550
  /**
1206
- * See [`Pallet::force_default_xcm_version`].
1551
+ * Set a safe XCM version (the version that XCM should be encoded with if the most recent
1552
+ * version a destination can accept is unknown).
1553
+ *
1554
+ * - `origin`: Must be an origin specified by AdminOrigin.
1555
+ * - `maybe_xcm_version`: The default XCM encoding version, or `None` to disable.
1207
1556
  *
1208
1557
  * @param {number | undefined} maybeXcmVersion
1209
1558
  **/
@@ -1222,7 +1571,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1222
1571
  >;
1223
1572
 
1224
1573
  /**
1225
- * See [`Pallet::force_subscribe_version_notify`].
1574
+ * Ask a location to notify us regarding their XCM version and any changes to it.
1575
+ *
1576
+ * - `origin`: Must be an origin specified by AdminOrigin.
1577
+ * - `location`: The location to which we should subscribe for XCM version notifications.
1226
1578
  *
1227
1579
  * @param {XcmVersionedLocation} location
1228
1580
  **/
@@ -1241,7 +1593,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1241
1593
  >;
1242
1594
 
1243
1595
  /**
1244
- * See [`Pallet::force_unsubscribe_version_notify`].
1596
+ * Require that a particular destination should no longer notify us regarding any XCM
1597
+ * version changes.
1598
+ *
1599
+ * - `origin`: Must be an origin specified by AdminOrigin.
1600
+ * - `location`: The location to which we are currently subscribed for XCM version
1601
+ * notifications which we no longer desire.
1245
1602
  *
1246
1603
  * @param {XcmVersionedLocation} location
1247
1604
  **/
@@ -1260,7 +1617,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1260
1617
  >;
1261
1618
 
1262
1619
  /**
1263
- * See [`Pallet::limited_reserve_transfer_assets`].
1620
+ * Transfer some assets from the local chain to the destination chain through their local,
1621
+ * destination or remote reserve.
1622
+ *
1623
+ * `assets` must have same reserve location and may not be teleportable to `dest`.
1624
+ * - `assets` have local reserve: transfer assets to sovereign account of destination
1625
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
1626
+ * assets to `beneficiary`.
1627
+ * - `assets` have destination reserve: burn local assets and forward a notification to
1628
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
1629
+ * deposit them to `beneficiary`.
1630
+ * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
1631
+ * reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
1632
+ * to mint and deposit reserve-based assets to `beneficiary`.
1633
+ *
1634
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
1635
+ * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
1636
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
1637
+ * at risk.
1638
+ *
1639
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1640
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
1641
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
1642
+ * relay to parachain.
1643
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
1644
+ * generally be an `AccountId32` value.
1645
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1646
+ * fee on the `dest` (and possibly reserve) chains.
1647
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
1648
+ * fees.
1649
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
1264
1650
  *
1265
1651
  * @param {XcmVersionedLocation} dest
1266
1652
  * @param {XcmVersionedLocation} beneficiary
@@ -1295,7 +1681,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1295
1681
  >;
1296
1682
 
1297
1683
  /**
1298
- * See [`Pallet::limited_teleport_assets`].
1684
+ * Teleport some assets from the local chain to some destination chain.
1685
+ *
1686
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
1687
+ * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
1688
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
1689
+ * at risk.
1690
+ *
1691
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1692
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
1693
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
1694
+ * relay to parachain.
1695
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
1696
+ * generally be an `AccountId32` value.
1697
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1698
+ * fee on the `dest` chain.
1699
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
1700
+ * fees.
1701
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
1299
1702
  *
1300
1703
  * @param {XcmVersionedLocation} dest
1301
1704
  * @param {XcmVersionedLocation} beneficiary
@@ -1330,7 +1733,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1330
1733
  >;
1331
1734
 
1332
1735
  /**
1333
- * See [`Pallet::force_suspension`].
1736
+ * Set or unset the global suspension state of the XCM executor.
1737
+ *
1738
+ * - `origin`: Must be an origin specified by AdminOrigin.
1739
+ * - `suspended`: `true` to suspend, `false` to resume.
1334
1740
  *
1335
1741
  * @param {boolean} suspended
1336
1742
  **/
@@ -1349,7 +1755,39 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1349
1755
  >;
1350
1756
 
1351
1757
  /**
1352
- * See [`Pallet::transfer_assets`].
1758
+ * Transfer some assets from the local chain to the destination chain through their local,
1759
+ * destination or remote reserve, or through teleports.
1760
+ *
1761
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
1762
+ * index `fee_asset_item` (hence referred to as `fees`), up to enough to pay for
1763
+ * `weight_limit` of weight. If more weight is needed than `weight_limit`, then the
1764
+ * operation will fail and the sent assets may be at risk.
1765
+ *
1766
+ * `assets` (excluding `fees`) must have same reserve location or otherwise be teleportable
1767
+ * to `dest`, no limitations imposed on `fees`.
1768
+ * - for local reserve: transfer assets to sovereign account of destination chain and
1769
+ * forward a notification XCM to `dest` to mint and deposit reserve-based assets to
1770
+ * `beneficiary`.
1771
+ * - for destination reserve: burn local assets and forward a notification to `dest` chain
1772
+ * to withdraw the reserve assets from this chain's sovereign account and deposit them
1773
+ * to `beneficiary`.
1774
+ * - for remote reserve: burn local assets, forward XCM to reserve chain to move reserves
1775
+ * from this chain's SA to `dest` chain's SA, and forward another XCM to `dest` to mint
1776
+ * and deposit reserve-based assets to `beneficiary`.
1777
+ * - for teleports: burn local assets and forward XCM to `dest` chain to mint/teleport
1778
+ * assets and deposit them to `beneficiary`.
1779
+ *
1780
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1781
+ * - `dest`: Destination context for the assets. Will typically be `X2(Parent,
1782
+ * Parachain(..))` to send from parachain to parachain, or `X1(Parachain(..))` to send
1783
+ * from relay to parachain.
1784
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
1785
+ * generally be an `AccountId32` value.
1786
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1787
+ * fee on the `dest` (and possibly reserve) chains.
1788
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
1789
+ * fees.
1790
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
1353
1791
  *
1354
1792
  * @param {XcmVersionedLocation} dest
1355
1793
  * @param {XcmVersionedLocation} beneficiary
@@ -1384,7 +1822,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1384
1822
  >;
1385
1823
 
1386
1824
  /**
1387
- * See [`Pallet::claim_assets`].
1825
+ * Claims assets trapped on this pallet because of leftover assets during XCM execution.
1826
+ *
1827
+ * - `origin`: Anyone can call this extrinsic.
1828
+ * - `assets`: The exact assets that were trapped. Use the version to specify what version
1829
+ * was the latest when they were trapped.
1830
+ * - `beneficiary`: The location/account where the claimed assets will be deposited.
1388
1831
  *
1389
1832
  * @param {XcmVersionedAssets} assets
1390
1833
  * @param {XcmVersionedLocation} beneficiary
@@ -1407,7 +1850,54 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1407
1850
  >;
1408
1851
 
1409
1852
  /**
1410
- * See [`Pallet::transfer_assets_using_type_and_then`].
1853
+ * Transfer assets from the local chain to the destination chain using explicit transfer
1854
+ * types for assets and fees.
1855
+ *
1856
+ * `assets` must have same reserve location or may be teleportable to `dest`. Caller must
1857
+ * provide the `assets_transfer_type` to be used for `assets`:
1858
+ * - `TransferType::LocalReserve`: transfer assets to sovereign account of destination
1859
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
1860
+ * assets to `beneficiary`.
1861
+ * - `TransferType::DestinationReserve`: burn local assets and forward a notification to
1862
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
1863
+ * deposit them to `beneficiary`.
1864
+ * - `TransferType::RemoteReserve(reserve)`: burn local assets, forward XCM to `reserve`
1865
+ * chain to move reserves from this chain's SA to `dest` chain's SA, and forward another
1866
+ * XCM to `dest` to mint and deposit reserve-based assets to `beneficiary`. Typically
1867
+ * the remote `reserve` is Asset Hub.
1868
+ * - `TransferType::Teleport`: burn local assets and forward XCM to `dest` chain to
1869
+ * mint/teleport assets and deposit them to `beneficiary`.
1870
+ *
1871
+ * On the destination chain, as well as any intermediary hops, `BuyExecution` is used to
1872
+ * buy execution using transferred `assets` identified by `remote_fees_id`.
1873
+ * Make sure enough of the specified `remote_fees_id` asset is included in the given list
1874
+ * of `assets`. `remote_fees_id` should be enough to pay for `weight_limit`. If more weight
1875
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
1876
+ * at risk.
1877
+ *
1878
+ * `remote_fees_id` may use different transfer type than rest of `assets` and can be
1879
+ * specified through `fees_transfer_type`.
1880
+ *
1881
+ * The caller needs to specify what should happen to the transferred assets once they reach
1882
+ * the `dest` chain. This is done through the `custom_xcm_on_dest` parameter, which
1883
+ * contains the instructions to execute on `dest` as a final step.
1884
+ * This is usually as simple as:
1885
+ * `Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }])`,
1886
+ * but could be something more exotic like sending the `assets` even further.
1887
+ *
1888
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
1889
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
1890
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
1891
+ * relay to parachain, or `(parents: 2, (GlobalConsensus(..), ..))` to send from
1892
+ * parachain across a bridge to another ecosystem destination.
1893
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
1894
+ * fee on the `dest` (and possibly reserve) chains.
1895
+ * - `assets_transfer_type`: The XCM `TransferType` used to transfer the `assets`.
1896
+ * - `remote_fees_id`: One of the included `assets` to be used to pay fees.
1897
+ * - `fees_transfer_type`: The XCM `TransferType` used to transfer the `fees` assets.
1898
+ * - `custom_xcm_on_dest`: The XCM to be executed on `dest` chain as the last step of the
1899
+ * transfer, which also determines what happens to the assets on the destination chain.
1900
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
1411
1901
  *
1412
1902
  * @param {XcmVersionedLocation} dest
1413
1903
  * @param {XcmVersionedAssets} assets
@@ -1466,7 +1956,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1466
1956
  **/
1467
1957
  toKusamaXcmRouter: {
1468
1958
  /**
1469
- * See [`Pallet::report_bridge_status`].
1959
+ * Notification about congested bridge queue.
1470
1960
  *
1471
1961
  * @param {H256} bridgeId
1472
1962
  * @param {boolean} isCongested
@@ -1498,7 +1988,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1498
1988
  **/
1499
1989
  messageQueue: {
1500
1990
  /**
1501
- * See [`Pallet::reap_page`].
1991
+ * Remove a page which has no more messages remaining to be processed or is stale.
1502
1992
  *
1503
1993
  * @param {CumulusPrimitivesCoreAggregateMessageOrigin} messageOrigin
1504
1994
  * @param {number} pageIndex
@@ -1521,7 +2011,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1521
2011
  >;
1522
2012
 
1523
2013
  /**
1524
- * See [`Pallet::execute_overweight`].
2014
+ * Execute an overweight message.
2015
+ *
2016
+ * Temporary processing errors will be propagated whereas permanent errors are treated
2017
+ * as success condition.
2018
+ *
2019
+ * - `origin`: Must be `Signed`.
2020
+ * - `message_origin`: The origin from which the message to be executed arrived.
2021
+ * - `page`: The page in the queue in which the message to be executed is sitting.
2022
+ * - `index`: The index into the queue of the message to be executed.
2023
+ * - `weight_limit`: The maximum amount of weight allowed to be consumed in the execution
2024
+ * of the message.
2025
+ *
2026
+ * Benchmark complexity considerations: O(index + weight_limit).
1525
2027
  *
1526
2028
  * @param {CumulusPrimitivesCoreAggregateMessageOrigin} messageOrigin
1527
2029
  * @param {number} page
@@ -1562,7 +2064,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1562
2064
  **/
1563
2065
  utility: {
1564
2066
  /**
1565
- * See [`Pallet::batch`].
2067
+ * Send a batch of dispatch calls.
2068
+ *
2069
+ * May be called from any origin except `None`.
2070
+ *
2071
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
2072
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
2073
+ *
2074
+ * If origin is root then the calls are dispatched without checking origin filter. (This
2075
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
2076
+ *
2077
+ * ## Complexity
2078
+ * - O(C) where C is the number of calls to be batched.
2079
+ *
2080
+ * This will return `Ok` in all circumstances. To determine the success of the batch, an
2081
+ * event is deposited. If a call failed and the batch was interrupted, then the
2082
+ * `BatchInterrupted` event is deposited, along with the number of successful calls made
2083
+ * and the error of the failed call. If all were successful, then the `BatchCompleted`
2084
+ * event is deposited.
1566
2085
  *
1567
2086
  * @param {Array<AssetHubPolkadotRuntimeRuntimeCallLike>} calls
1568
2087
  **/
@@ -1581,7 +2100,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1581
2100
  >;
1582
2101
 
1583
2102
  /**
1584
- * See [`Pallet::as_derivative`].
2103
+ * Send a call through an indexed pseudonym of the sender.
2104
+ *
2105
+ * Filter from origin are passed along. The call will be dispatched with an origin which
2106
+ * use the same filter as the origin of this call.
2107
+ *
2108
+ * NOTE: If you need to ensure that any account-based filtering is not honored (i.e.
2109
+ * because you expect `proxy` to have been used prior in the call stack and you do not want
2110
+ * the call restrictions to apply to any sub-accounts), then use `as_multi_threshold_1`
2111
+ * in the Multisig pallet instead.
2112
+ *
2113
+ * NOTE: Prior to version *12, this was called `as_limited_sub`.
2114
+ *
2115
+ * The dispatch origin for this call must be _Signed_.
1585
2116
  *
1586
2117
  * @param {number} index
1587
2118
  * @param {AssetHubPolkadotRuntimeRuntimeCallLike} call
@@ -1604,7 +2135,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1604
2135
  >;
1605
2136
 
1606
2137
  /**
1607
- * See [`Pallet::batch_all`].
2138
+ * Send a batch of dispatch calls and atomically execute them.
2139
+ * The whole transaction will rollback and fail if any of the calls failed.
2140
+ *
2141
+ * May be called from any origin except `None`.
2142
+ *
2143
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
2144
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
2145
+ *
2146
+ * If origin is root then the calls are dispatched without checking origin filter. (This
2147
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
2148
+ *
2149
+ * ## Complexity
2150
+ * - O(C) where C is the number of calls to be batched.
1608
2151
  *
1609
2152
  * @param {Array<AssetHubPolkadotRuntimeRuntimeCallLike>} calls
1610
2153
  **/
@@ -1623,7 +2166,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1623
2166
  >;
1624
2167
 
1625
2168
  /**
1626
- * See [`Pallet::dispatch_as`].
2169
+ * Dispatches a function call with a provided origin.
2170
+ *
2171
+ * The dispatch origin for this call must be _Root_.
2172
+ *
2173
+ * ## Complexity
2174
+ * - O(1).
1627
2175
  *
1628
2176
  * @param {AssetHubPolkadotRuntimeOriginCaller} asOrigin
1629
2177
  * @param {AssetHubPolkadotRuntimeRuntimeCallLike} call
@@ -1646,7 +2194,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1646
2194
  >;
1647
2195
 
1648
2196
  /**
1649
- * See [`Pallet::force_batch`].
2197
+ * Send a batch of dispatch calls.
2198
+ * Unlike `batch`, it allows errors and won't interrupt.
2199
+ *
2200
+ * May be called from any origin except `None`.
2201
+ *
2202
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
2203
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
2204
+ *
2205
+ * If origin is root then the calls are dispatch without checking origin filter. (This
2206
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
2207
+ *
2208
+ * ## Complexity
2209
+ * - O(C) where C is the number of calls to be batched.
1650
2210
  *
1651
2211
  * @param {Array<AssetHubPolkadotRuntimeRuntimeCallLike>} calls
1652
2212
  **/
@@ -1665,7 +2225,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1665
2225
  >;
1666
2226
 
1667
2227
  /**
1668
- * See [`Pallet::with_weight`].
2228
+ * Dispatch a function call with a specified weight.
2229
+ *
2230
+ * This function does not check the weight of the call, and instead allows the
2231
+ * Root origin to specify the weight of the call.
2232
+ *
2233
+ * The dispatch origin for this call must be _Root_.
1669
2234
  *
1670
2235
  * @param {AssetHubPolkadotRuntimeRuntimeCallLike} call
1671
2236
  * @param {SpWeightsWeightV2Weight} weight
@@ -1697,7 +2262,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1697
2262
  **/
1698
2263
  multisig: {
1699
2264
  /**
1700
- * See [`Pallet::as_multi_threshold_1`].
2265
+ * Immediately dispatch a multi-signature call using a single approval from the caller.
2266
+ *
2267
+ * The dispatch origin for this call must be _Signed_.
2268
+ *
2269
+ * - `other_signatories`: The accounts (other than the sender) who are part of the
2270
+ * multi-signature, but do not participate in the approval process.
2271
+ * - `call`: The call to be executed.
2272
+ *
2273
+ * Result is equivalent to the dispatched result.
2274
+ *
2275
+ * ## Complexity
2276
+ * O(Z + C) where Z is the length of the call and C its execution weight.
1701
2277
  *
1702
2278
  * @param {Array<AccountId32Like>} otherSignatories
1703
2279
  * @param {AssetHubPolkadotRuntimeRuntimeCallLike} call
@@ -1720,7 +2296,45 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1720
2296
  >;
1721
2297
 
1722
2298
  /**
1723
- * See [`Pallet::as_multi`].
2299
+ * Register approval for a dispatch to be made from a deterministic composite account if
2300
+ * approved by a total of `threshold - 1` of `other_signatories`.
2301
+ *
2302
+ * If there are enough, then dispatch the call.
2303
+ *
2304
+ * Payment: `DepositBase` will be reserved if this is the first approval, plus
2305
+ * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
2306
+ * is cancelled.
2307
+ *
2308
+ * The dispatch origin for this call must be _Signed_.
2309
+ *
2310
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
2311
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
2312
+ * dispatch. May not be empty.
2313
+ * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
2314
+ * not the first approval, then it must be `Some`, with the timepoint (block number and
2315
+ * transaction index) of the first approval transaction.
2316
+ * - `call`: The call to be executed.
2317
+ *
2318
+ * NOTE: Unless this is the final approval, you will generally want to use
2319
+ * `approve_as_multi` instead, since it only requires a hash of the call.
2320
+ *
2321
+ * Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise
2322
+ * on success, result is `Ok` and the result from the interior call, if it was executed,
2323
+ * may be found in the deposited `MultisigExecuted` event.
2324
+ *
2325
+ * ## Complexity
2326
+ * - `O(S + Z + Call)`.
2327
+ * - Up to one balance-reserve or unreserve operation.
2328
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
2329
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
2330
+ * - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len.
2331
+ * - One encode & hash, both of complexity `O(S)`.
2332
+ * - Up to one binary search and insert (`O(logS + S)`).
2333
+ * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
2334
+ * - One event.
2335
+ * - The weight of the `call`.
2336
+ * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
2337
+ * taken for its lifetime of `DepositBase + threshold * DepositFactor`.
1724
2338
  *
1725
2339
  * @param {number} threshold
1726
2340
  * @param {Array<AccountId32Like>} otherSignatories
@@ -1755,7 +2369,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1755
2369
  >;
1756
2370
 
1757
2371
  /**
1758
- * See [`Pallet::approve_as_multi`].
2372
+ * Register approval for a dispatch to be made from a deterministic composite account if
2373
+ * approved by a total of `threshold - 1` of `other_signatories`.
2374
+ *
2375
+ * Payment: `DepositBase` will be reserved if this is the first approval, plus
2376
+ * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
2377
+ * is cancelled.
2378
+ *
2379
+ * The dispatch origin for this call must be _Signed_.
2380
+ *
2381
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
2382
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
2383
+ * dispatch. May not be empty.
2384
+ * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
2385
+ * not the first approval, then it must be `Some`, with the timepoint (block number and
2386
+ * transaction index) of the first approval transaction.
2387
+ * - `call_hash`: The hash of the call to be executed.
2388
+ *
2389
+ * NOTE: If this is the final approval, you will want to use `as_multi` instead.
2390
+ *
2391
+ * ## Complexity
2392
+ * - `O(S)`.
2393
+ * - Up to one balance-reserve or unreserve operation.
2394
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
2395
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
2396
+ * - One encode & hash, both of complexity `O(S)`.
2397
+ * - Up to one binary search and insert (`O(logS + S)`).
2398
+ * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
2399
+ * - One event.
2400
+ * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
2401
+ * taken for its lifetime of `DepositBase + threshold * DepositFactor`.
1759
2402
  *
1760
2403
  * @param {number} threshold
1761
2404
  * @param {Array<AccountId32Like>} otherSignatories
@@ -1790,7 +2433,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1790
2433
  >;
1791
2434
 
1792
2435
  /**
1793
- * See [`Pallet::cancel_as_multi`].
2436
+ * Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously
2437
+ * for this operation will be unreserved on success.
2438
+ *
2439
+ * The dispatch origin for this call must be _Signed_.
2440
+ *
2441
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
2442
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
2443
+ * dispatch. May not be empty.
2444
+ * - `timepoint`: The timepoint (block number and transaction index) of the first approval
2445
+ * transaction for this dispatch.
2446
+ * - `call_hash`: The hash of the call to be executed.
2447
+ *
2448
+ * ## Complexity
2449
+ * - `O(S)`.
2450
+ * - Up to one balance-reserve or unreserve operation.
2451
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
2452
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
2453
+ * - One encode & hash, both of complexity `O(S)`.
2454
+ * - One event.
2455
+ * - I/O: 1 read `O(S)`, one remove.
2456
+ * - Storage: removes one item.
1794
2457
  *
1795
2458
  * @param {number} threshold
1796
2459
  * @param {Array<AccountId32Like>} otherSignatories
@@ -1831,7 +2494,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1831
2494
  **/
1832
2495
  proxy: {
1833
2496
  /**
1834
- * See [`Pallet::proxy`].
2497
+ * Dispatch the given `call` from an account that the sender is authorised for through
2498
+ * `add_proxy`.
2499
+ *
2500
+ * The dispatch origin for this call must be _Signed_.
2501
+ *
2502
+ * Parameters:
2503
+ * - `real`: The account that the proxy will make a call on behalf of.
2504
+ * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
2505
+ * - `call`: The call to be made by the `real` account.
1835
2506
  *
1836
2507
  * @param {MultiAddressLike} real
1837
2508
  * @param {AssetHubPolkadotRuntimeProxyType | undefined} forceProxyType
@@ -1860,7 +2531,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1860
2531
  >;
1861
2532
 
1862
2533
  /**
1863
- * See [`Pallet::add_proxy`].
2534
+ * Register a proxy account for the sender that is able to make calls on its behalf.
2535
+ *
2536
+ * The dispatch origin for this call must be _Signed_.
2537
+ *
2538
+ * Parameters:
2539
+ * - `proxy`: The account that the `caller` would like to make a proxy.
2540
+ * - `proxy_type`: The permissions allowed for this proxy account.
2541
+ * - `delay`: The announcement period required of the initial proxy. Will generally be
2542
+ * zero.
1864
2543
  *
1865
2544
  * @param {MultiAddressLike} delegate
1866
2545
  * @param {AssetHubPolkadotRuntimeProxyType} proxyType
@@ -1885,7 +2564,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1885
2564
  >;
1886
2565
 
1887
2566
  /**
1888
- * See [`Pallet::remove_proxy`].
2567
+ * Unregister a proxy account for the sender.
2568
+ *
2569
+ * The dispatch origin for this call must be _Signed_.
2570
+ *
2571
+ * Parameters:
2572
+ * - `proxy`: The account that the `caller` would like to remove as a proxy.
2573
+ * - `proxy_type`: The permissions currently enabled for the removed proxy account.
1889
2574
  *
1890
2575
  * @param {MultiAddressLike} delegate
1891
2576
  * @param {AssetHubPolkadotRuntimeProxyType} proxyType
@@ -1910,7 +2595,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1910
2595
  >;
1911
2596
 
1912
2597
  /**
1913
- * See [`Pallet::remove_proxies`].
2598
+ * Unregister all proxy accounts for the sender.
2599
+ *
2600
+ * The dispatch origin for this call must be _Signed_.
2601
+ *
2602
+ * WARNING: This may be called on accounts created by `pure`, however if done, then
2603
+ * the unreserved fees will be inaccessible. **All access to this account will be lost.**
1914
2604
  *
1915
2605
  **/
1916
2606
  removeProxies: GenericTxCall<
@@ -1927,7 +2617,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1927
2617
  >;
1928
2618
 
1929
2619
  /**
1930
- * See [`Pallet::create_pure`].
2620
+ * Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and
2621
+ * initialize it with a proxy of `proxy_type` for `origin` sender.
2622
+ *
2623
+ * Requires a `Signed` origin.
2624
+ *
2625
+ * - `proxy_type`: The type of the proxy that the sender will be registered as over the
2626
+ * new account. This will almost always be the most permissive `ProxyType` possible to
2627
+ * allow for maximum flexibility.
2628
+ * - `index`: A disambiguation index, in case this is called multiple times in the same
2629
+ * transaction (e.g. with `utility::batch`). Unless you're using `batch` you probably just
2630
+ * want to use `0`.
2631
+ * - `delay`: The announcement period required of the initial proxy. Will generally be
2632
+ * zero.
2633
+ *
2634
+ * Fails with `Duplicate` if this has already been called in this transaction, from the
2635
+ * same sender, with the same parameters.
2636
+ *
2637
+ * Fails if there are insufficient funds to pay for deposit.
1931
2638
  *
1932
2639
  * @param {AssetHubPolkadotRuntimeProxyType} proxyType
1933
2640
  * @param {number} delay
@@ -1952,7 +2659,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1952
2659
  >;
1953
2660
 
1954
2661
  /**
1955
- * See [`Pallet::kill_pure`].
2662
+ * Removes a previously spawned pure proxy.
2663
+ *
2664
+ * WARNING: **All access to this account will be lost.** Any funds held in it will be
2665
+ * inaccessible.
2666
+ *
2667
+ * Requires a `Signed` origin, and the sender account must have been created by a call to
2668
+ * `pure` with corresponding parameters.
2669
+ *
2670
+ * - `spawner`: The account that originally called `pure` to create this account.
2671
+ * - `index`: The disambiguation index originally passed to `pure`. Probably `0`.
2672
+ * - `proxy_type`: The proxy type originally passed to `pure`.
2673
+ * - `height`: The height of the chain when the call to `pure` was processed.
2674
+ * - `ext_index`: The extrinsic index in which the call to `pure` was processed.
2675
+ *
2676
+ * Fails with `NoPermission` in case the caller is not a previously created pure
2677
+ * account whose `pure` call has corresponding parameters.
1956
2678
  *
1957
2679
  * @param {MultiAddressLike} spawner
1958
2680
  * @param {AssetHubPolkadotRuntimeProxyType} proxyType
@@ -1987,7 +2709,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1987
2709
  >;
1988
2710
 
1989
2711
  /**
1990
- * See [`Pallet::announce`].
2712
+ * Publish the hash of a proxy-call that will be made in the future.
2713
+ *
2714
+ * This must be called some number of blocks before the corresponding `proxy` is attempted
2715
+ * if the delay associated with the proxy relationship is greater than zero.
2716
+ *
2717
+ * No more than `MaxPending` announcements may be made at any one time.
2718
+ *
2719
+ * This will take a deposit of `AnnouncementDepositFactor` as well as
2720
+ * `AnnouncementDepositBase` if there are no other pending announcements.
2721
+ *
2722
+ * The dispatch origin for this call must be _Signed_ and a proxy of `real`.
2723
+ *
2724
+ * Parameters:
2725
+ * - `real`: The account that the proxy will make a call on behalf of.
2726
+ * - `call_hash`: The hash of the call to be made by the `real` account.
1991
2727
  *
1992
2728
  * @param {MultiAddressLike} real
1993
2729
  * @param {H256} callHash
@@ -2010,7 +2746,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2010
2746
  >;
2011
2747
 
2012
2748
  /**
2013
- * See [`Pallet::remove_announcement`].
2749
+ * Remove a given announcement.
2750
+ *
2751
+ * May be called by a proxy account to remove a call they previously announced and return
2752
+ * the deposit.
2753
+ *
2754
+ * The dispatch origin for this call must be _Signed_.
2755
+ *
2756
+ * Parameters:
2757
+ * - `real`: The account that the proxy will make a call on behalf of.
2758
+ * - `call_hash`: The hash of the call to be made by the `real` account.
2014
2759
  *
2015
2760
  * @param {MultiAddressLike} real
2016
2761
  * @param {H256} callHash
@@ -2033,7 +2778,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2033
2778
  >;
2034
2779
 
2035
2780
  /**
2036
- * See [`Pallet::reject_announcement`].
2781
+ * Remove the given announcement of a delegate.
2782
+ *
2783
+ * May be called by a target (proxied) account to remove a call that one of their delegates
2784
+ * (`delegate`) has announced they want to execute. The deposit is returned.
2785
+ *
2786
+ * The dispatch origin for this call must be _Signed_.
2787
+ *
2788
+ * Parameters:
2789
+ * - `delegate`: The account that previously announced the call.
2790
+ * - `call_hash`: The hash of the call to be made.
2037
2791
  *
2038
2792
  * @param {MultiAddressLike} delegate
2039
2793
  * @param {H256} callHash
@@ -2056,7 +2810,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2056
2810
  >;
2057
2811
 
2058
2812
  /**
2059
- * See [`Pallet::proxy_announced`].
2813
+ * Dispatch the given `call` from an account that the sender is authorized for through
2814
+ * `add_proxy`.
2815
+ *
2816
+ * Removes any corresponding announcement(s).
2817
+ *
2818
+ * The dispatch origin for this call must be _Signed_.
2819
+ *
2820
+ * Parameters:
2821
+ * - `real`: The account that the proxy will make a call on behalf of.
2822
+ * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
2823
+ * - `call`: The call to be made by the `real` account.
2060
2824
  *
2061
2825
  * @param {MultiAddressLike} delegate
2062
2826
  * @param {MultiAddressLike} real
@@ -2097,7 +2861,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2097
2861
  **/
2098
2862
  assets: {
2099
2863
  /**
2100
- * See [`Pallet::create`].
2864
+ * Issue a new class of fungible assets from a public origin.
2865
+ *
2866
+ * This new asset class has no assets initially and its owner is the origin.
2867
+ *
2868
+ * The origin must conform to the configured `CreateOrigin` and have sufficient funds free.
2869
+ *
2870
+ * Funds of sender are reserved by `AssetDeposit`.
2871
+ *
2872
+ * Parameters:
2873
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
2874
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
2875
+ * - `admin`: The admin of this class of assets. The admin is the initial address of each
2876
+ * member of the asset class's admin team.
2877
+ * - `min_balance`: The minimum balance of this new asset that any single account must
2878
+ * have. If an account's balance is reduced below this, then it collapses to zero.
2879
+ *
2880
+ * Emits `Created` event when successful.
2881
+ *
2882
+ * Weight: `O(1)`
2101
2883
  *
2102
2884
  * @param {number} id
2103
2885
  * @param {MultiAddressLike} admin
@@ -2122,7 +2904,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2122
2904
  >;
2123
2905
 
2124
2906
  /**
2125
- * See [`Pallet::force_create`].
2907
+ * Issue a new class of fungible assets from a privileged origin.
2908
+ *
2909
+ * This new asset class has no assets initially.
2910
+ *
2911
+ * The origin must conform to `ForceOrigin`.
2912
+ *
2913
+ * Unlike `create`, no funds are reserved.
2914
+ *
2915
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
2916
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
2917
+ * - `owner`: The owner of this class of assets. The owner has full superuser permissions
2918
+ * over this asset, but may later change and configure the permissions using
2919
+ * `transfer_ownership` and `set_team`.
2920
+ * - `min_balance`: The minimum balance of this new asset that any single account must
2921
+ * have. If an account's balance is reduced below this, then it collapses to zero.
2922
+ *
2923
+ * Emits `ForceCreated` event when successful.
2924
+ *
2925
+ * Weight: `O(1)`
2126
2926
  *
2127
2927
  * @param {number} id
2128
2928
  * @param {MultiAddressLike} owner
@@ -2149,7 +2949,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2149
2949
  >;
2150
2950
 
2151
2951
  /**
2152
- * See [`Pallet::start_destroy`].
2952
+ * Start the process of destroying a fungible asset class.
2953
+ *
2954
+ * `start_destroy` is the first in a series of extrinsics that should be called, to allow
2955
+ * destruction of an asset class.
2956
+ *
2957
+ * The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.
2958
+ *
2959
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
2960
+ * asset.
2961
+ *
2962
+ * The asset class must be frozen before calling `start_destroy`.
2153
2963
  *
2154
2964
  * @param {number} id
2155
2965
  **/
@@ -2168,7 +2978,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2168
2978
  >;
2169
2979
 
2170
2980
  /**
2171
- * See [`Pallet::destroy_accounts`].
2981
+ * Destroy all accounts associated with a given asset.
2982
+ *
2983
+ * `destroy_accounts` should only be called after `start_destroy` has been called, and the
2984
+ * asset is in a `Destroying` state.
2985
+ *
2986
+ * Due to weight restrictions, this function may need to be called multiple times to fully
2987
+ * destroy all accounts. It will destroy `RemoveItemsLimit` accounts at a time.
2988
+ *
2989
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
2990
+ * asset.
2991
+ *
2992
+ * Each call emits the `Event::DestroyedAccounts` event.
2172
2993
  *
2173
2994
  * @param {number} id
2174
2995
  **/
@@ -2187,7 +3008,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2187
3008
  >;
2188
3009
 
2189
3010
  /**
2190
- * See [`Pallet::destroy_approvals`].
3011
+ * Destroy all approvals associated with a given asset up to the max (T::RemoveItemsLimit).
3012
+ *
3013
+ * `destroy_approvals` should only be called after `start_destroy` has been called, and the
3014
+ * asset is in a `Destroying` state.
3015
+ *
3016
+ * Due to weight restrictions, this function may need to be called multiple times to fully
3017
+ * destroy all approvals. It will destroy `RemoveItemsLimit` approvals at a time.
3018
+ *
3019
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
3020
+ * asset.
3021
+ *
3022
+ * Each call emits the `Event::DestroyedApprovals` event.
2191
3023
  *
2192
3024
  * @param {number} id
2193
3025
  **/
@@ -2206,7 +3038,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2206
3038
  >;
2207
3039
 
2208
3040
  /**
2209
- * See [`Pallet::finish_destroy`].
3041
+ * Complete destroying asset and unreserve currency.
3042
+ *
3043
+ * `finish_destroy` should only be called after `start_destroy` has been called, and the
3044
+ * asset is in a `Destroying` state. All accounts or approvals should be destroyed before
3045
+ * hand.
3046
+ *
3047
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
3048
+ * asset.
3049
+ *
3050
+ * Each successful call emits the `Event::Destroyed` event.
2210
3051
  *
2211
3052
  * @param {number} id
2212
3053
  **/
@@ -2225,7 +3066,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2225
3066
  >;
2226
3067
 
2227
3068
  /**
2228
- * See [`Pallet::mint`].
3069
+ * Mint assets of a particular class.
3070
+ *
3071
+ * The origin must be Signed and the sender must be the Issuer of the asset `id`.
3072
+ *
3073
+ * - `id`: The identifier of the asset to have some amount minted.
3074
+ * - `beneficiary`: The account to be credited with the minted assets.
3075
+ * - `amount`: The amount of the asset to be minted.
3076
+ *
3077
+ * Emits `Issued` event when successful.
3078
+ *
3079
+ * Weight: `O(1)`
3080
+ * Modes: Pre-existing balance of `beneficiary`; Account pre-existence of `beneficiary`.
2229
3081
  *
2230
3082
  * @param {number} id
2231
3083
  * @param {MultiAddressLike} beneficiary
@@ -2250,7 +3102,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2250
3102
  >;
2251
3103
 
2252
3104
  /**
2253
- * See [`Pallet::burn`].
3105
+ * Reduce the balance of `who` by as much as possible up to `amount` assets of `id`.
3106
+ *
3107
+ * Origin must be Signed and the sender should be the Manager of the asset `id`.
3108
+ *
3109
+ * Bails with `NoAccount` if the `who` is already dead.
3110
+ *
3111
+ * - `id`: The identifier of the asset to have some amount burned.
3112
+ * - `who`: The account to be debited from.
3113
+ * - `amount`: The maximum amount by which `who`'s balance should be reduced.
3114
+ *
3115
+ * Emits `Burned` with the actual amount burned. If this takes the balance to below the
3116
+ * minimum for the asset, then the amount burned is increased to take it to zero.
3117
+ *
3118
+ * Weight: `O(1)`
3119
+ * Modes: Post-existence of `who`; Pre & post Zombie-status of `who`.
2254
3120
  *
2255
3121
  * @param {number} id
2256
3122
  * @param {MultiAddressLike} who
@@ -2275,7 +3141,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2275
3141
  >;
2276
3142
 
2277
3143
  /**
2278
- * See [`Pallet::transfer`].
3144
+ * Move some assets from the sender account to another.
3145
+ *
3146
+ * Origin must be Signed.
3147
+ *
3148
+ * - `id`: The identifier of the asset to have some amount transferred.
3149
+ * - `target`: The account to be credited.
3150
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
3151
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
3152
+ * the case that the transfer would otherwise take the sender balance above zero but below
3153
+ * the minimum balance. Must be greater than zero.
3154
+ *
3155
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
3156
+ * to below the minimum for the asset, then the amount transferred is increased to take it
3157
+ * to zero.
3158
+ *
3159
+ * Weight: `O(1)`
3160
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
3161
+ * `target`.
2279
3162
  *
2280
3163
  * @param {number} id
2281
3164
  * @param {MultiAddressLike} target
@@ -2300,7 +3183,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2300
3183
  >;
2301
3184
 
2302
3185
  /**
2303
- * See [`Pallet::transfer_keep_alive`].
3186
+ * Move some assets from the sender account to another, keeping the sender account alive.
3187
+ *
3188
+ * Origin must be Signed.
3189
+ *
3190
+ * - `id`: The identifier of the asset to have some amount transferred.
3191
+ * - `target`: The account to be credited.
3192
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
3193
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
3194
+ * the case that the transfer would otherwise take the sender balance above zero but below
3195
+ * the minimum balance. Must be greater than zero.
3196
+ *
3197
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
3198
+ * to below the minimum for the asset, then the amount transferred is increased to take it
3199
+ * to zero.
3200
+ *
3201
+ * Weight: `O(1)`
3202
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
3203
+ * `target`.
2304
3204
  *
2305
3205
  * @param {number} id
2306
3206
  * @param {MultiAddressLike} target
@@ -2325,7 +3225,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2325
3225
  >;
2326
3226
 
2327
3227
  /**
2328
- * See [`Pallet::force_transfer`].
3228
+ * Move some assets from one account to another.
3229
+ *
3230
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
3231
+ *
3232
+ * - `id`: The identifier of the asset to have some amount transferred.
3233
+ * - `source`: The account to be debited.
3234
+ * - `dest`: The account to be credited.
3235
+ * - `amount`: The amount by which the `source`'s balance of assets should be reduced and
3236
+ * `dest`'s balance increased. The amount actually transferred may be slightly greater in
3237
+ * the case that the transfer would otherwise take the `source` balance above zero but
3238
+ * below the minimum balance. Must be greater than zero.
3239
+ *
3240
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
3241
+ * to below the minimum for the asset, then the amount transferred is increased to take it
3242
+ * to zero.
3243
+ *
3244
+ * Weight: `O(1)`
3245
+ * Modes: Pre-existence of `dest`; Post-existence of `source`; Account pre-existence of
3246
+ * `dest`.
2329
3247
  *
2330
3248
  * @param {number} id
2331
3249
  * @param {MultiAddressLike} source
@@ -2352,7 +3270,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2352
3270
  >;
2353
3271
 
2354
3272
  /**
2355
- * See [`Pallet::freeze`].
3273
+ * Disallow further unprivileged transfers of an asset `id` from an account `who`. `who`
3274
+ * must already exist as an entry in `Account`s of the asset. If you want to freeze an
3275
+ * account that does not have an entry, use `touch_other` first.
3276
+ *
3277
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
3278
+ *
3279
+ * - `id`: The identifier of the asset to be frozen.
3280
+ * - `who`: The account to be frozen.
3281
+ *
3282
+ * Emits `Frozen`.
3283
+ *
3284
+ * Weight: `O(1)`
2356
3285
  *
2357
3286
  * @param {number} id
2358
3287
  * @param {MultiAddressLike} who
@@ -2375,11 +3304,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2375
3304
  >;
2376
3305
 
2377
3306
  /**
2378
- * See [`Pallet::thaw`].
3307
+ * Allow unprivileged transfers to and from an account again.
2379
3308
  *
2380
- * @param {number} id
2381
- * @param {MultiAddressLike} who
2382
- **/
3309
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
3310
+ *
3311
+ * - `id`: The identifier of the asset to be frozen.
3312
+ * - `who`: The account to be unfrozen.
3313
+ *
3314
+ * Emits `Thawed`.
3315
+ *
3316
+ * Weight: `O(1)`
3317
+ *
3318
+ * @param {number} id
3319
+ * @param {MultiAddressLike} who
3320
+ **/
2383
3321
  thaw: GenericTxCall<
2384
3322
  Rv,
2385
3323
  (
@@ -2398,7 +3336,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2398
3336
  >;
2399
3337
 
2400
3338
  /**
2401
- * See [`Pallet::freeze_asset`].
3339
+ * Disallow further unprivileged transfers for the asset class.
3340
+ *
3341
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
3342
+ *
3343
+ * - `id`: The identifier of the asset to be frozen.
3344
+ *
3345
+ * Emits `Frozen`.
3346
+ *
3347
+ * Weight: `O(1)`
2402
3348
  *
2403
3349
  * @param {number} id
2404
3350
  **/
@@ -2417,7 +3363,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2417
3363
  >;
2418
3364
 
2419
3365
  /**
2420
- * See [`Pallet::thaw_asset`].
3366
+ * Allow unprivileged transfers for the asset again.
3367
+ *
3368
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
3369
+ *
3370
+ * - `id`: The identifier of the asset to be thawed.
3371
+ *
3372
+ * Emits `Thawed`.
3373
+ *
3374
+ * Weight: `O(1)`
2421
3375
  *
2422
3376
  * @param {number} id
2423
3377
  **/
@@ -2436,7 +3390,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2436
3390
  >;
2437
3391
 
2438
3392
  /**
2439
- * See [`Pallet::transfer_ownership`].
3393
+ * Change the Owner of an asset.
3394
+ *
3395
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
3396
+ *
3397
+ * - `id`: The identifier of the asset.
3398
+ * - `owner`: The new Owner of this asset.
3399
+ *
3400
+ * Emits `OwnerChanged`.
3401
+ *
3402
+ * Weight: `O(1)`
2440
3403
  *
2441
3404
  * @param {number} id
2442
3405
  * @param {MultiAddressLike} owner
@@ -2459,7 +3422,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2459
3422
  >;
2460
3423
 
2461
3424
  /**
2462
- * See [`Pallet::set_team`].
3425
+ * Change the Issuer, Admin and Freezer of an asset.
3426
+ *
3427
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
3428
+ *
3429
+ * - `id`: The identifier of the asset to be frozen.
3430
+ * - `issuer`: The new Issuer of this asset.
3431
+ * - `admin`: The new Admin of this asset.
3432
+ * - `freezer`: The new Freezer of this asset.
3433
+ *
3434
+ * Emits `TeamChanged`.
3435
+ *
3436
+ * Weight: `O(1)`
2463
3437
  *
2464
3438
  * @param {number} id
2465
3439
  * @param {MultiAddressLike} issuer
@@ -2486,7 +3460,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2486
3460
  >;
2487
3461
 
2488
3462
  /**
2489
- * See [`Pallet::set_metadata`].
3463
+ * Set the metadata for an asset.
3464
+ *
3465
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
3466
+ *
3467
+ * Funds of sender are reserved according to the formula:
3468
+ * `MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len)` taking into
3469
+ * account any already reserved funds.
3470
+ *
3471
+ * - `id`: The identifier of the asset to update.
3472
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
3473
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
3474
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
3475
+ *
3476
+ * Emits `MetadataSet`.
3477
+ *
3478
+ * Weight: `O(1)`
2490
3479
  *
2491
3480
  * @param {number} id
2492
3481
  * @param {BytesLike} name
@@ -2513,7 +3502,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2513
3502
  >;
2514
3503
 
2515
3504
  /**
2516
- * See [`Pallet::clear_metadata`].
3505
+ * Clear the metadata for an asset.
3506
+ *
3507
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
3508
+ *
3509
+ * Any deposit is freed for the asset owner.
3510
+ *
3511
+ * - `id`: The identifier of the asset to clear.
3512
+ *
3513
+ * Emits `MetadataCleared`.
3514
+ *
3515
+ * Weight: `O(1)`
2517
3516
  *
2518
3517
  * @param {number} id
2519
3518
  **/
@@ -2532,7 +3531,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2532
3531
  >;
2533
3532
 
2534
3533
  /**
2535
- * See [`Pallet::force_set_metadata`].
3534
+ * Force the metadata for an asset to some value.
3535
+ *
3536
+ * Origin must be ForceOrigin.
3537
+ *
3538
+ * Any deposit is left alone.
3539
+ *
3540
+ * - `id`: The identifier of the asset to update.
3541
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
3542
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
3543
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
3544
+ *
3545
+ * Emits `MetadataSet`.
3546
+ *
3547
+ * Weight: `O(N + S)` where N and S are the length of the name and symbol respectively.
2536
3548
  *
2537
3549
  * @param {number} id
2538
3550
  * @param {BytesLike} name
@@ -2561,7 +3573,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2561
3573
  >;
2562
3574
 
2563
3575
  /**
2564
- * See [`Pallet::force_clear_metadata`].
3576
+ * Clear the metadata for an asset.
3577
+ *
3578
+ * Origin must be ForceOrigin.
3579
+ *
3580
+ * Any deposit is returned.
3581
+ *
3582
+ * - `id`: The identifier of the asset to clear.
3583
+ *
3584
+ * Emits `MetadataCleared`.
3585
+ *
3586
+ * Weight: `O(1)`
2565
3587
  *
2566
3588
  * @param {number} id
2567
3589
  **/
@@ -2580,7 +3602,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2580
3602
  >;
2581
3603
 
2582
3604
  /**
2583
- * See [`Pallet::force_asset_status`].
3605
+ * Alter the attributes of a given asset.
3606
+ *
3607
+ * Origin must be `ForceOrigin`.
3608
+ *
3609
+ * - `id`: The identifier of the asset.
3610
+ * - `owner`: The new Owner of this asset.
3611
+ * - `issuer`: The new Issuer of this asset.
3612
+ * - `admin`: The new Admin of this asset.
3613
+ * - `freezer`: The new Freezer of this asset.
3614
+ * - `min_balance`: The minimum balance of this new asset that any single account must
3615
+ * have. If an account's balance is reduced below this, then it collapses to zero.
3616
+ * - `is_sufficient`: Whether a non-zero balance of this asset is deposit of sufficient
3617
+ * value to account for the state bloat associated with its balance storage. If set to
3618
+ * `true`, then non-zero balances may be stored without a `consumer` reference (and thus
3619
+ * an ED in the Balances pallet or whatever else is used to control user-account state
3620
+ * growth).
3621
+ * - `is_frozen`: Whether this asset class is frozen except for permissioned/admin
3622
+ * instructions.
3623
+ *
3624
+ * Emits `AssetStatusChanged` with the identity of the asset.
3625
+ *
3626
+ * Weight: `O(1)`
2584
3627
  *
2585
3628
  * @param {number} id
2586
3629
  * @param {MultiAddressLike} owner
@@ -2624,7 +3667,26 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2624
3667
  >;
2625
3668
 
2626
3669
  /**
2627
- * See [`Pallet::approve_transfer`].
3670
+ * Approve an amount of asset for transfer by a delegated third-party account.
3671
+ *
3672
+ * Origin must be Signed.
3673
+ *
3674
+ * Ensures that `ApprovalDeposit` worth of `Currency` is reserved from signing account
3675
+ * for the purpose of holding the approval. If some non-zero amount of assets is already
3676
+ * approved from signing account to `delegate`, then it is topped up or unreserved to
3677
+ * meet the right value.
3678
+ *
3679
+ * NOTE: The signing account does not need to own `amount` of assets at the point of
3680
+ * making this call.
3681
+ *
3682
+ * - `id`: The identifier of the asset.
3683
+ * - `delegate`: The account to delegate permission to transfer asset.
3684
+ * - `amount`: The amount of asset that may be transferred by `delegate`. If there is
3685
+ * already an approval in place, then this acts additively.
3686
+ *
3687
+ * Emits `ApprovedTransfer` on success.
3688
+ *
3689
+ * Weight: `O(1)`
2628
3690
  *
2629
3691
  * @param {number} id
2630
3692
  * @param {MultiAddressLike} delegate
@@ -2649,7 +3711,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2649
3711
  >;
2650
3712
 
2651
3713
  /**
2652
- * See [`Pallet::cancel_approval`].
3714
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
3715
+ *
3716
+ * Origin must be Signed and there must be an approval in place between signer and
3717
+ * `delegate`.
3718
+ *
3719
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
3720
+ *
3721
+ * - `id`: The identifier of the asset.
3722
+ * - `delegate`: The account delegated permission to transfer asset.
3723
+ *
3724
+ * Emits `ApprovalCancelled` on success.
3725
+ *
3726
+ * Weight: `O(1)`
2653
3727
  *
2654
3728
  * @param {number} id
2655
3729
  * @param {MultiAddressLike} delegate
@@ -2672,7 +3746,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2672
3746
  >;
2673
3747
 
2674
3748
  /**
2675
- * See [`Pallet::force_cancel_approval`].
3749
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
3750
+ *
3751
+ * Origin must be either ForceOrigin or Signed origin with the signer being the Admin
3752
+ * account of the asset `id`.
3753
+ *
3754
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
3755
+ *
3756
+ * - `id`: The identifier of the asset.
3757
+ * - `delegate`: The account delegated permission to transfer asset.
3758
+ *
3759
+ * Emits `ApprovalCancelled` on success.
3760
+ *
3761
+ * Weight: `O(1)`
2676
3762
  *
2677
3763
  * @param {number} id
2678
3764
  * @param {MultiAddressLike} owner
@@ -2697,7 +3783,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2697
3783
  >;
2698
3784
 
2699
3785
  /**
2700
- * See [`Pallet::transfer_approved`].
3786
+ * Transfer some asset balance from a previously delegated account to some third-party
3787
+ * account.
3788
+ *
3789
+ * Origin must be Signed and there must be an approval in place by the `owner` to the
3790
+ * signer.
3791
+ *
3792
+ * If the entire amount approved for transfer is transferred, then any deposit previously
3793
+ * reserved by `approve_transfer` is unreserved.
3794
+ *
3795
+ * - `id`: The identifier of the asset.
3796
+ * - `owner`: The account which previously approved for a transfer of at least `amount` and
3797
+ * from which the asset balance will be withdrawn.
3798
+ * - `destination`: The account to which the asset balance of `amount` will be transferred.
3799
+ * - `amount`: The amount of assets to transfer.
3800
+ *
3801
+ * Emits `TransferredApproved` on success.
3802
+ *
3803
+ * Weight: `O(1)`
2701
3804
  *
2702
3805
  * @param {number} id
2703
3806
  * @param {MultiAddressLike} owner
@@ -2724,7 +3827,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2724
3827
  >;
2725
3828
 
2726
3829
  /**
2727
- * See [`Pallet::touch`].
3830
+ * Create an asset account for non-provider assets.
3831
+ *
3832
+ * A deposit will be taken from the signer account.
3833
+ *
3834
+ * - `origin`: Must be Signed; the signer account must have sufficient funds for a deposit
3835
+ * to be taken.
3836
+ * - `id`: The identifier of the asset for the account to be created.
3837
+ *
3838
+ * Emits `Touched` event when successful.
2728
3839
  *
2729
3840
  * @param {number} id
2730
3841
  **/
@@ -2743,7 +3854,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2743
3854
  >;
2744
3855
 
2745
3856
  /**
2746
- * See [`Pallet::refund`].
3857
+ * Return the deposit (if any) of an asset account or a consumer reference (if any) of an
3858
+ * account.
3859
+ *
3860
+ * The origin must be Signed.
3861
+ *
3862
+ * - `id`: The identifier of the asset for which the caller would like the deposit
3863
+ * refunded.
3864
+ * - `allow_burn`: If `true` then assets may be destroyed in order to complete the refund.
3865
+ *
3866
+ * Emits `Refunded` event when successful.
2747
3867
  *
2748
3868
  * @param {number} id
2749
3869
  * @param {boolean} allowBurn
@@ -2766,7 +3886,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2766
3886
  >;
2767
3887
 
2768
3888
  /**
2769
- * See [`Pallet::set_min_balance`].
3889
+ * Sets the minimum balance of an asset.
3890
+ *
3891
+ * Only works if there aren't any accounts that are holding the asset or if
3892
+ * the new value of `min_balance` is less than the old one.
3893
+ *
3894
+ * Origin must be Signed and the sender has to be the Owner of the
3895
+ * asset `id`.
3896
+ *
3897
+ * - `id`: The identifier of the asset.
3898
+ * - `min_balance`: The new value of `min_balance`.
3899
+ *
3900
+ * Emits `AssetMinBalanceChanged` event when successful.
2770
3901
  *
2771
3902
  * @param {number} id
2772
3903
  * @param {bigint} minBalance
@@ -2789,7 +3920,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2789
3920
  >;
2790
3921
 
2791
3922
  /**
2792
- * See [`Pallet::touch_other`].
3923
+ * Create an asset account for `who`.
3924
+ *
3925
+ * A deposit will be taken from the signer account.
3926
+ *
3927
+ * - `origin`: Must be Signed by `Freezer` or `Admin` of the asset `id`; the signer account
3928
+ * must have sufficient funds for a deposit to be taken.
3929
+ * - `id`: The identifier of the asset for the account to be created.
3930
+ * - `who`: The account to be created.
3931
+ *
3932
+ * Emits `Touched` event when successful.
2793
3933
  *
2794
3934
  * @param {number} id
2795
3935
  * @param {MultiAddressLike} who
@@ -2812,7 +3952,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2812
3952
  >;
2813
3953
 
2814
3954
  /**
2815
- * See [`Pallet::refund_other`].
3955
+ * Return the deposit (if any) of a target asset account. Useful if you are the depositor.
3956
+ *
3957
+ * The origin must be Signed and either the account owner, depositor, or asset `Admin`. In
3958
+ * order to burn a non-zero balance of the asset, the caller must be the account and should
3959
+ * use `refund`.
3960
+ *
3961
+ * - `id`: The identifier of the asset for the account holding a deposit.
3962
+ * - `who`: The account to refund.
3963
+ *
3964
+ * Emits `Refunded` event when successful.
2816
3965
  *
2817
3966
  * @param {number} id
2818
3967
  * @param {MultiAddressLike} who
@@ -2835,7 +3984,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2835
3984
  >;
2836
3985
 
2837
3986
  /**
2838
- * See [`Pallet::block`].
3987
+ * Disallow further unprivileged transfers of an asset `id` to and from an account `who`.
3988
+ *
3989
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
3990
+ *
3991
+ * - `id`: The identifier of the account's asset.
3992
+ * - `who`: The account to be unblocked.
3993
+ *
3994
+ * Emits `Blocked`.
3995
+ *
3996
+ * Weight: `O(1)`
2839
3997
  *
2840
3998
  * @param {number} id
2841
3999
  * @param {MultiAddressLike} who
@@ -2867,7 +4025,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2867
4025
  **/
2868
4026
  uniques: {
2869
4027
  /**
2870
- * See [`Pallet::create`].
4028
+ * Issue a new collection of non-fungible items from a public origin.
4029
+ *
4030
+ * This new collection has no items initially and its owner is the origin.
4031
+ *
4032
+ * The origin must conform to the configured `CreateOrigin` and have sufficient funds free.
4033
+ *
4034
+ * `ItemDeposit` funds of sender are reserved.
4035
+ *
4036
+ * Parameters:
4037
+ * - `collection`: The identifier of the new collection. This must not be currently in use.
4038
+ * - `admin`: The admin of this collection. The admin is the initial address of each
4039
+ * member of the collection's admin team.
4040
+ *
4041
+ * Emits `Created` event when successful.
4042
+ *
4043
+ * Weight: `O(1)`
2871
4044
  *
2872
4045
  * @param {number} collection
2873
4046
  * @param {MultiAddressLike} admin
@@ -2890,7 +4063,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2890
4063
  >;
2891
4064
 
2892
4065
  /**
2893
- * See [`Pallet::force_create`].
4066
+ * Issue a new collection of non-fungible items from a privileged origin.
4067
+ *
4068
+ * This new collection has no items initially.
4069
+ *
4070
+ * The origin must conform to `ForceOrigin`.
4071
+ *
4072
+ * Unlike `create`, no funds are reserved.
4073
+ *
4074
+ * - `collection`: The identifier of the new item. This must not be currently in use.
4075
+ * - `owner`: The owner of this collection of items. The owner has full superuser
4076
+ * permissions
4077
+ * over this item, but may later change and configure the permissions using
4078
+ * `transfer_ownership` and `set_team`.
4079
+ *
4080
+ * Emits `ForceCreated` event when successful.
4081
+ *
4082
+ * Weight: `O(1)`
2894
4083
  *
2895
4084
  * @param {number} collection
2896
4085
  * @param {MultiAddressLike} owner
@@ -2915,7 +4104,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2915
4104
  >;
2916
4105
 
2917
4106
  /**
2918
- * See [`Pallet::destroy`].
4107
+ * Destroy a collection of fungible items.
4108
+ *
4109
+ * The origin must conform to `ForceOrigin` or must be `Signed` and the sender must be the
4110
+ * owner of the `collection`.
4111
+ *
4112
+ * - `collection`: The identifier of the collection to be destroyed.
4113
+ * - `witness`: Information on the items minted in the collection. This must be
4114
+ * correct.
4115
+ *
4116
+ * Emits `Destroyed` event when successful.
4117
+ *
4118
+ * Weight: `O(n + m)` where:
4119
+ * - `n = witness.items`
4120
+ * - `m = witness.item_metadatas`
4121
+ * - `a = witness.attributes`
2919
4122
  *
2920
4123
  * @param {number} collection
2921
4124
  * @param {PalletUniquesDestroyWitness} witness
@@ -2938,7 +4141,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2938
4141
  >;
2939
4142
 
2940
4143
  /**
2941
- * See [`Pallet::mint`].
4144
+ * Mint an item of a particular collection.
4145
+ *
4146
+ * The origin must be Signed and the sender must be the Issuer of the `collection`.
4147
+ *
4148
+ * - `collection`: The collection of the item to be minted.
4149
+ * - `item`: The item value of the item to be minted.
4150
+ * - `beneficiary`: The initial owner of the minted item.
4151
+ *
4152
+ * Emits `Issued` event when successful.
4153
+ *
4154
+ * Weight: `O(1)`
2942
4155
  *
2943
4156
  * @param {number} collection
2944
4157
  * @param {number} item
@@ -2963,7 +4176,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2963
4176
  >;
2964
4177
 
2965
4178
  /**
2966
- * See [`Pallet::burn`].
4179
+ * Destroy a single item.
4180
+ *
4181
+ * Origin must be Signed and the signing account must be either:
4182
+ * - the Admin of the `collection`;
4183
+ * - the Owner of the `item`;
4184
+ *
4185
+ * - `collection`: The collection of the item to be burned.
4186
+ * - `item`: The item of the item to be burned.
4187
+ * - `check_owner`: If `Some` then the operation will fail with `WrongOwner` unless the
4188
+ * item is owned by this value.
4189
+ *
4190
+ * Emits `Burned` with the actual amount burned.
4191
+ *
4192
+ * Weight: `O(1)`
4193
+ * Modes: `check_owner.is_some()`.
2967
4194
  *
2968
4195
  * @param {number} collection
2969
4196
  * @param {number} item
@@ -2988,7 +4215,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2988
4215
  >;
2989
4216
 
2990
4217
  /**
2991
- * See [`Pallet::transfer`].
4218
+ * Move an item from the sender account to another.
4219
+ *
4220
+ * This resets the approved account of the item.
4221
+ *
4222
+ * Origin must be Signed and the signing account must be either:
4223
+ * - the Admin of the `collection`;
4224
+ * - the Owner of the `item`;
4225
+ * - the approved delegate for the `item` (in this case, the approval is reset).
4226
+ *
4227
+ * Arguments:
4228
+ * - `collection`: The collection of the item to be transferred.
4229
+ * - `item`: The item of the item to be transferred.
4230
+ * - `dest`: The account to receive ownership of the item.
4231
+ *
4232
+ * Emits `Transferred`.
4233
+ *
4234
+ * Weight: `O(1)`
2992
4235
  *
2993
4236
  * @param {number} collection
2994
4237
  * @param {number} item
@@ -3013,7 +4256,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3013
4256
  >;
3014
4257
 
3015
4258
  /**
3016
- * See [`Pallet::redeposit`].
4259
+ * Reevaluate the deposits on some items.
4260
+ *
4261
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
4262
+ *
4263
+ * - `collection`: The collection to be frozen.
4264
+ * - `items`: The items of the collection whose deposits will be reevaluated.
4265
+ *
4266
+ * NOTE: This exists as a best-effort function. Any items which are unknown or
4267
+ * in the case that the owner account does not have reservable funds to pay for a
4268
+ * deposit increase are ignored. Generally the owner isn't going to call this on items
4269
+ * whose existing deposit is less than the refreshed deposit as it would only cost them,
4270
+ * so it's of little consequence.
4271
+ *
4272
+ * It will still return an error in the case that the collection is unknown of the signer
4273
+ * is not permitted to call it.
4274
+ *
4275
+ * Weight: `O(items.len())`
3017
4276
  *
3018
4277
  * @param {number} collection
3019
4278
  * @param {Array<number>} items
@@ -3036,7 +4295,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3036
4295
  >;
3037
4296
 
3038
4297
  /**
3039
- * See [`Pallet::freeze`].
4298
+ * Disallow further unprivileged transfer of an item.
4299
+ *
4300
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
4301
+ *
4302
+ * - `collection`: The collection of the item to be frozen.
4303
+ * - `item`: The item of the item to be frozen.
4304
+ *
4305
+ * Emits `Frozen`.
4306
+ *
4307
+ * Weight: `O(1)`
3040
4308
  *
3041
4309
  * @param {number} collection
3042
4310
  * @param {number} item
@@ -3059,7 +4327,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3059
4327
  >;
3060
4328
 
3061
4329
  /**
3062
- * See [`Pallet::thaw`].
4330
+ * Re-allow unprivileged transfer of an item.
4331
+ *
4332
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
4333
+ *
4334
+ * - `collection`: The collection of the item to be thawed.
4335
+ * - `item`: The item of the item to be thawed.
4336
+ *
4337
+ * Emits `Thawed`.
4338
+ *
4339
+ * Weight: `O(1)`
3063
4340
  *
3064
4341
  * @param {number} collection
3065
4342
  * @param {number} item
@@ -3082,7 +4359,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3082
4359
  >;
3083
4360
 
3084
4361
  /**
3085
- * See [`Pallet::freeze_collection`].
4362
+ * Disallow further unprivileged transfers for a whole collection.
4363
+ *
4364
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
4365
+ *
4366
+ * - `collection`: The collection to be frozen.
4367
+ *
4368
+ * Emits `CollectionFrozen`.
4369
+ *
4370
+ * Weight: `O(1)`
3086
4371
  *
3087
4372
  * @param {number} collection
3088
4373
  **/
@@ -3101,7 +4386,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3101
4386
  >;
3102
4387
 
3103
4388
  /**
3104
- * See [`Pallet::thaw_collection`].
4389
+ * Re-allow unprivileged transfers for a whole collection.
4390
+ *
4391
+ * Origin must be Signed and the sender should be the Admin of the `collection`.
4392
+ *
4393
+ * - `collection`: The collection to be thawed.
4394
+ *
4395
+ * Emits `CollectionThawed`.
4396
+ *
4397
+ * Weight: `O(1)`
3105
4398
  *
3106
4399
  * @param {number} collection
3107
4400
  **/
@@ -3120,7 +4413,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3120
4413
  >;
3121
4414
 
3122
4415
  /**
3123
- * See [`Pallet::transfer_ownership`].
4416
+ * Change the Owner of a collection.
4417
+ *
4418
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
4419
+ *
4420
+ * - `collection`: The collection whose owner should be changed.
4421
+ * - `owner`: The new Owner of this collection. They must have called
4422
+ * `set_accept_ownership` with `collection` in order for this operation to succeed.
4423
+ *
4424
+ * Emits `OwnerChanged`.
4425
+ *
4426
+ * Weight: `O(1)`
3124
4427
  *
3125
4428
  * @param {number} collection
3126
4429
  * @param {MultiAddressLike} newOwner
@@ -3143,7 +4446,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3143
4446
  >;
3144
4447
 
3145
4448
  /**
3146
- * See [`Pallet::set_team`].
4449
+ * Change the Issuer, Admin and Freezer of a collection.
4450
+ *
4451
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
4452
+ *
4453
+ * - `collection`: The collection whose team should be changed.
4454
+ * - `issuer`: The new Issuer of this collection.
4455
+ * - `admin`: The new Admin of this collection.
4456
+ * - `freezer`: The new Freezer of this collection.
4457
+ *
4458
+ * Emits `TeamChanged`.
4459
+ *
4460
+ * Weight: `O(1)`
3147
4461
  *
3148
4462
  * @param {number} collection
3149
4463
  * @param {MultiAddressLike} issuer
@@ -3175,7 +4489,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3175
4489
  >;
3176
4490
 
3177
4491
  /**
3178
- * See [`Pallet::approve_transfer`].
4492
+ * Approve an item to be transferred by a delegated third-party account.
4493
+ *
4494
+ * The origin must conform to `ForceOrigin` or must be `Signed` and the sender must be
4495
+ * either the owner of the `item` or the admin of the collection.
4496
+ *
4497
+ * - `collection`: The collection of the item to be approved for delegated transfer.
4498
+ * - `item`: The item of the item to be approved for delegated transfer.
4499
+ * - `delegate`: The account to delegate permission to transfer the item.
4500
+ *
4501
+ * Important NOTE: The `approved` account gets reset after each transfer.
4502
+ *
4503
+ * Emits `ApprovedTransfer` on success.
4504
+ *
4505
+ * Weight: `O(1)`
3179
4506
  *
3180
4507
  * @param {number} collection
3181
4508
  * @param {number} item
@@ -3200,7 +4527,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3200
4527
  >;
3201
4528
 
3202
4529
  /**
3203
- * See [`Pallet::cancel_approval`].
4530
+ * Cancel the prior approval for the transfer of an item by a delegate.
4531
+ *
4532
+ * Origin must be either:
4533
+ * - the `Force` origin;
4534
+ * - `Signed` with the signer being the Admin of the `collection`;
4535
+ * - `Signed` with the signer being the Owner of the `item`;
4536
+ *
4537
+ * Arguments:
4538
+ * - `collection`: The collection of the item of whose approval will be cancelled.
4539
+ * - `item`: The item of the item of whose approval will be cancelled.
4540
+ * - `maybe_check_delegate`: If `Some` will ensure that the given account is the one to
4541
+ * which permission of transfer is delegated.
4542
+ *
4543
+ * Emits `ApprovalCancelled` on success.
4544
+ *
4545
+ * Weight: `O(1)`
3204
4546
  *
3205
4547
  * @param {number} collection
3206
4548
  * @param {number} item
@@ -3225,7 +4567,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3225
4567
  >;
3226
4568
 
3227
4569
  /**
3228
- * See [`Pallet::force_item_status`].
4570
+ * Alter the attributes of a given item.
4571
+ *
4572
+ * Origin must be `ForceOrigin`.
4573
+ *
4574
+ * - `collection`: The identifier of the item.
4575
+ * - `owner`: The new Owner of this item.
4576
+ * - `issuer`: The new Issuer of this item.
4577
+ * - `admin`: The new Admin of this item.
4578
+ * - `freezer`: The new Freezer of this item.
4579
+ * - `free_holding`: Whether a deposit is taken for holding an item of this collection.
4580
+ * - `is_frozen`: Whether this collection is frozen except for permissioned/admin
4581
+ * instructions.
4582
+ *
4583
+ * Emits `ItemStatusChanged` with the identity of the item.
4584
+ *
4585
+ * Weight: `O(1)`
3229
4586
  *
3230
4587
  * @param {number} collection
3231
4588
  * @param {MultiAddressLike} owner
@@ -3266,7 +4623,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3266
4623
  >;
3267
4624
 
3268
4625
  /**
3269
- * See [`Pallet::set_attribute`].
4626
+ * Set an attribute for a collection or item.
4627
+ *
4628
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
4629
+ * `collection`.
4630
+ *
4631
+ * If the origin is Signed, then funds of signer are reserved according to the formula:
4632
+ * `MetadataDepositBase + DepositPerByte * (key.len + value.len)` taking into
4633
+ * account any already reserved funds.
4634
+ *
4635
+ * - `collection`: The identifier of the collection whose item's metadata to set.
4636
+ * - `maybe_item`: The identifier of the item whose metadata to set.
4637
+ * - `key`: The key of the attribute.
4638
+ * - `value`: The value to which to set the attribute.
4639
+ *
4640
+ * Emits `AttributeSet`.
4641
+ *
4642
+ * Weight: `O(1)`
3270
4643
  *
3271
4644
  * @param {number} collection
3272
4645
  * @param {number | undefined} maybeItem
@@ -3293,7 +4666,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3293
4666
  >;
3294
4667
 
3295
4668
  /**
3296
- * See [`Pallet::clear_attribute`].
4669
+ * Clear an attribute for a collection or item.
4670
+ *
4671
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
4672
+ * `collection`.
4673
+ *
4674
+ * Any deposit is freed for the collection's owner.
4675
+ *
4676
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
4677
+ * - `maybe_item`: The identifier of the item whose metadata to clear.
4678
+ * - `key`: The key of the attribute.
4679
+ *
4680
+ * Emits `AttributeCleared`.
4681
+ *
4682
+ * Weight: `O(1)`
3297
4683
  *
3298
4684
  * @param {number} collection
3299
4685
  * @param {number | undefined} maybeItem
@@ -3318,7 +4704,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3318
4704
  >;
3319
4705
 
3320
4706
  /**
3321
- * See [`Pallet::set_metadata`].
4707
+ * Set the metadata for an item.
4708
+ *
4709
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
4710
+ * `collection`.
4711
+ *
4712
+ * If the origin is Signed, then funds of signer are reserved according to the formula:
4713
+ * `MetadataDepositBase + DepositPerByte * data.len` taking into
4714
+ * account any already reserved funds.
4715
+ *
4716
+ * - `collection`: The identifier of the collection whose item's metadata to set.
4717
+ * - `item`: The identifier of the item whose metadata to set.
4718
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
4719
+ * - `is_frozen`: Whether the metadata should be frozen against further changes.
4720
+ *
4721
+ * Emits `MetadataSet`.
4722
+ *
4723
+ * Weight: `O(1)`
3322
4724
  *
3323
4725
  * @param {number} collection
3324
4726
  * @param {number} item
@@ -3345,7 +4747,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3345
4747
  >;
3346
4748
 
3347
4749
  /**
3348
- * See [`Pallet::clear_metadata`].
4750
+ * Clear the metadata for an item.
4751
+ *
4752
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
4753
+ * `item`.
4754
+ *
4755
+ * Any deposit is freed for the collection's owner.
4756
+ *
4757
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
4758
+ * - `item`: The identifier of the item whose metadata to clear.
4759
+ *
4760
+ * Emits `MetadataCleared`.
4761
+ *
4762
+ * Weight: `O(1)`
3349
4763
  *
3350
4764
  * @param {number} collection
3351
4765
  * @param {number} item
@@ -3368,7 +4782,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3368
4782
  >;
3369
4783
 
3370
4784
  /**
3371
- * See [`Pallet::set_collection_metadata`].
4785
+ * Set the metadata for a collection.
4786
+ *
4787
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
4788
+ * the `collection`.
4789
+ *
4790
+ * If the origin is `Signed`, then funds of signer are reserved according to the formula:
4791
+ * `MetadataDepositBase + DepositPerByte * data.len` taking into
4792
+ * account any already reserved funds.
4793
+ *
4794
+ * - `collection`: The identifier of the item whose metadata to update.
4795
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
4796
+ * - `is_frozen`: Whether the metadata should be frozen against further changes.
4797
+ *
4798
+ * Emits `CollectionMetadataSet`.
4799
+ *
4800
+ * Weight: `O(1)`
3372
4801
  *
3373
4802
  * @param {number} collection
3374
4803
  * @param {BytesLike} data
@@ -3393,7 +4822,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3393
4822
  >;
3394
4823
 
3395
4824
  /**
3396
- * See [`Pallet::clear_collection_metadata`].
4825
+ * Clear the metadata for a collection.
4826
+ *
4827
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
4828
+ * the `collection`.
4829
+ *
4830
+ * Any deposit is freed for the collection's owner.
4831
+ *
4832
+ * - `collection`: The identifier of the collection whose metadata to clear.
4833
+ *
4834
+ * Emits `CollectionMetadataCleared`.
4835
+ *
4836
+ * Weight: `O(1)`
3397
4837
  *
3398
4838
  * @param {number} collection
3399
4839
  **/
@@ -3412,7 +4852,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3412
4852
  >;
3413
4853
 
3414
4854
  /**
3415
- * See [`Pallet::set_accept_ownership`].
4855
+ * Set (or reset) the acceptance of ownership for a particular account.
4856
+ *
4857
+ * Origin must be `Signed` and if `maybe_collection` is `Some`, then the signer must have a
4858
+ * provider reference.
4859
+ *
4860
+ * - `maybe_collection`: The identifier of the collection whose ownership the signer is
4861
+ * willing to accept, or if `None`, an indication that the signer is willing to accept no
4862
+ * ownership transferal.
4863
+ *
4864
+ * Emits `OwnershipAcceptanceChanged`.
3416
4865
  *
3417
4866
  * @param {number | undefined} maybeCollection
3418
4867
  **/
@@ -3431,7 +4880,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3431
4880
  >;
3432
4881
 
3433
4882
  /**
3434
- * See [`Pallet::set_collection_max_supply`].
4883
+ * Set the maximum amount of items a collection could have.
4884
+ *
4885
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
4886
+ * the `collection`.
4887
+ *
4888
+ * Note: This function can only succeed once per collection.
4889
+ *
4890
+ * - `collection`: The identifier of the collection to change.
4891
+ * - `max_supply`: The maximum amount of items a collection could have.
4892
+ *
4893
+ * Emits `CollectionMaxSupplySet` event when successful.
3435
4894
  *
3436
4895
  * @param {number} collection
3437
4896
  * @param {number} maxSupply
@@ -3454,7 +4913,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3454
4913
  >;
3455
4914
 
3456
4915
  /**
3457
- * See [`Pallet::set_price`].
4916
+ * Set (or reset) the price for an item.
4917
+ *
4918
+ * Origin must be Signed and must be the owner of the asset `item`.
4919
+ *
4920
+ * - `collection`: The collection of the item.
4921
+ * - `item`: The item to set the price for.
4922
+ * - `price`: The price for the item. Pass `None`, to reset the price.
4923
+ * - `buyer`: Restricts the buy operation to a specific account.
4924
+ *
4925
+ * Emits `ItemPriceSet` on success if the price is not `None`.
4926
+ * Emits `ItemPriceRemoved` on success if the price is `None`.
3458
4927
  *
3459
4928
  * @param {number} collection
3460
4929
  * @param {number} item
@@ -3486,7 +4955,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3486
4955
  >;
3487
4956
 
3488
4957
  /**
3489
- * See [`Pallet::buy_item`].
4958
+ * Allows to buy an item if it's up for sale.
4959
+ *
4960
+ * Origin must be Signed and must not be the owner of the `item`.
4961
+ *
4962
+ * - `collection`: The collection of the item.
4963
+ * - `item`: The item the sender wants to buy.
4964
+ * - `bid_price`: The price the sender is willing to pay.
4965
+ *
4966
+ * Emits `ItemBought` on success.
3490
4967
  *
3491
4968
  * @param {number} collection
3492
4969
  * @param {number} item
@@ -3520,7 +4997,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3520
4997
  **/
3521
4998
  nfts: {
3522
4999
  /**
3523
- * See [`Pallet::create`].
5000
+ * Issue a new collection of non-fungible items from a public origin.
5001
+ *
5002
+ * This new collection has no items initially and its owner is the origin.
5003
+ *
5004
+ * The origin must be Signed and the sender must have sufficient funds free.
5005
+ *
5006
+ * `CollectionDeposit` funds of sender are reserved.
5007
+ *
5008
+ * Parameters:
5009
+ * - `admin`: The admin of this collection. The admin is the initial address of each
5010
+ * member of the collection's admin team.
5011
+ *
5012
+ * Emits `Created` event when successful.
5013
+ *
5014
+ * Weight: `O(1)`
3524
5015
  *
3525
5016
  * @param {MultiAddressLike} admin
3526
5017
  * @param {PalletNftsCollectionConfig} config
@@ -3543,7 +5034,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3543
5034
  >;
3544
5035
 
3545
5036
  /**
3546
- * See [`Pallet::force_create`].
5037
+ * Issue a new collection of non-fungible items from a privileged origin.
5038
+ *
5039
+ * This new collection has no items initially.
5040
+ *
5041
+ * The origin must conform to `ForceOrigin`.
5042
+ *
5043
+ * Unlike `create`, no funds are reserved.
5044
+ *
5045
+ * - `owner`: The owner of this collection of items. The owner has full superuser
5046
+ * permissions over this item, but may later change and configure the permissions using
5047
+ * `transfer_ownership` and `set_team`.
5048
+ *
5049
+ * Emits `ForceCreated` event when successful.
5050
+ *
5051
+ * Weight: `O(1)`
3547
5052
  *
3548
5053
  * @param {MultiAddressLike} owner
3549
5054
  * @param {PalletNftsCollectionConfig} config
@@ -3566,7 +5071,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3566
5071
  >;
3567
5072
 
3568
5073
  /**
3569
- * See [`Pallet::destroy`].
5074
+ * Destroy a collection of fungible items.
5075
+ *
5076
+ * The origin must conform to `ForceOrigin` or must be `Signed` and the sender must be the
5077
+ * owner of the `collection`.
5078
+ *
5079
+ * NOTE: The collection must have 0 items to be destroyed.
5080
+ *
5081
+ * - `collection`: The identifier of the collection to be destroyed.
5082
+ * - `witness`: Information on the items minted in the collection. This must be
5083
+ * correct.
5084
+ *
5085
+ * Emits `Destroyed` event when successful.
5086
+ *
5087
+ * Weight: `O(m + c + a)` where:
5088
+ * - `m = witness.item_metadatas`
5089
+ * - `c = witness.item_configs`
5090
+ * - `a = witness.attributes`
3570
5091
  *
3571
5092
  * @param {number} collection
3572
5093
  * @param {PalletNftsDestroyWitness} witness
@@ -3589,7 +5110,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3589
5110
  >;
3590
5111
 
3591
5112
  /**
3592
- * See [`Pallet::mint`].
5113
+ * Mint an item of a particular collection.
5114
+ *
5115
+ * The origin must be Signed and the sender must comply with the `mint_settings` rules.
5116
+ *
5117
+ * - `collection`: The collection of the item to be minted.
5118
+ * - `item`: An identifier of the new item.
5119
+ * - `mint_to`: Account into which the item will be minted.
5120
+ * - `witness_data`: When the mint type is `HolderOf(collection_id)`, then the owned
5121
+ * item_id from that collection needs to be provided within the witness data object. If
5122
+ * the mint price is set, then it should be additionally confirmed in the `witness_data`.
5123
+ *
5124
+ * Note: the deposit will be taken from the `origin` and not the `owner` of the `item`.
5125
+ *
5126
+ * Emits `Issued` event when successful.
5127
+ *
5128
+ * Weight: `O(1)`
3593
5129
  *
3594
5130
  * @param {number} collection
3595
5131
  * @param {number} item
@@ -3621,7 +5157,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3621
5157
  >;
3622
5158
 
3623
5159
  /**
3624
- * See [`Pallet::force_mint`].
5160
+ * Mint an item of a particular collection from a privileged origin.
5161
+ *
5162
+ * The origin must conform to `ForceOrigin` or must be `Signed` and the sender must be the
5163
+ * Issuer of the `collection`.
5164
+ *
5165
+ * - `collection`: The collection of the item to be minted.
5166
+ * - `item`: An identifier of the new item.
5167
+ * - `mint_to`: Account into which the item will be minted.
5168
+ * - `item_config`: A config of the new item.
5169
+ *
5170
+ * Emits `Issued` event when successful.
5171
+ *
5172
+ * Weight: `O(1)`
3625
5173
  *
3626
5174
  * @param {number} collection
3627
5175
  * @param {number} item
@@ -3648,7 +5196,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3648
5196
  >;
3649
5197
 
3650
5198
  /**
3651
- * See [`Pallet::burn`].
5199
+ * Destroy a single item.
5200
+ *
5201
+ * The origin must conform to `ForceOrigin` or must be Signed and the signing account must
5202
+ * be the owner of the `item`.
5203
+ *
5204
+ * - `collection`: The collection of the item to be burned.
5205
+ * - `item`: The item to be burned.
5206
+ *
5207
+ * Emits `Burned`.
5208
+ *
5209
+ * Weight: `O(1)`
3652
5210
  *
3653
5211
  * @param {number} collection
3654
5212
  * @param {number} item
@@ -3671,7 +5229,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3671
5229
  >;
3672
5230
 
3673
5231
  /**
3674
- * See [`Pallet::transfer`].
5232
+ * Move an item from the sender account to another.
5233
+ *
5234
+ * Origin must be Signed and the signing account must be either:
5235
+ * - the Owner of the `item`;
5236
+ * - the approved delegate for the `item` (in this case, the approval is reset).
5237
+ *
5238
+ * Arguments:
5239
+ * - `collection`: The collection of the item to be transferred.
5240
+ * - `item`: The item to be transferred.
5241
+ * - `dest`: The account to receive ownership of the item.
5242
+ *
5243
+ * Emits `Transferred`.
5244
+ *
5245
+ * Weight: `O(1)`
3675
5246
  *
3676
5247
  * @param {number} collection
3677
5248
  * @param {number} item
@@ -3696,7 +5267,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3696
5267
  >;
3697
5268
 
3698
5269
  /**
3699
- * See [`Pallet::redeposit`].
5270
+ * Re-evaluate the deposits on some items.
5271
+ *
5272
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5273
+ *
5274
+ * - `collection`: The collection of the items to be reevaluated.
5275
+ * - `items`: The items of the collection whose deposits will be reevaluated.
5276
+ *
5277
+ * NOTE: This exists as a best-effort function. Any items which are unknown or
5278
+ * in the case that the owner account does not have reservable funds to pay for a
5279
+ * deposit increase are ignored. Generally the owner isn't going to call this on items
5280
+ * whose existing deposit is less than the refreshed deposit as it would only cost them,
5281
+ * so it's of little consequence.
5282
+ *
5283
+ * It will still return an error in the case that the collection is unknown or the signer
5284
+ * is not permitted to call it.
5285
+ *
5286
+ * Weight: `O(items.len())`
3700
5287
  *
3701
5288
  * @param {number} collection
3702
5289
  * @param {Array<number>} items
@@ -3719,7 +5306,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3719
5306
  >;
3720
5307
 
3721
5308
  /**
3722
- * See [`Pallet::lock_item_transfer`].
5309
+ * Disallow further unprivileged transfer of an item.
5310
+ *
5311
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
5312
+ *
5313
+ * - `collection`: The collection of the item to be changed.
5314
+ * - `item`: The item to become non-transferable.
5315
+ *
5316
+ * Emits `ItemTransferLocked`.
5317
+ *
5318
+ * Weight: `O(1)`
3723
5319
  *
3724
5320
  * @param {number} collection
3725
5321
  * @param {number} item
@@ -3742,7 +5338,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3742
5338
  >;
3743
5339
 
3744
5340
  /**
3745
- * See [`Pallet::unlock_item_transfer`].
5341
+ * Re-allow unprivileged transfer of an item.
5342
+ *
5343
+ * Origin must be Signed and the sender should be the Freezer of the `collection`.
5344
+ *
5345
+ * - `collection`: The collection of the item to be changed.
5346
+ * - `item`: The item to become transferable.
5347
+ *
5348
+ * Emits `ItemTransferUnlocked`.
5349
+ *
5350
+ * Weight: `O(1)`
3746
5351
  *
3747
5352
  * @param {number} collection
3748
5353
  * @param {number} item
@@ -3765,7 +5370,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3765
5370
  >;
3766
5371
 
3767
5372
  /**
3768
- * See [`Pallet::lock_collection`].
5373
+ * Disallows specified settings for the whole collection.
5374
+ *
5375
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5376
+ *
5377
+ * - `collection`: The collection to be locked.
5378
+ * - `lock_settings`: The settings to be locked.
5379
+ *
5380
+ * Note: it's possible to only lock(set) the setting, but not to unset it.
5381
+ *
5382
+ * Emits `CollectionLocked`.
5383
+ *
5384
+ * Weight: `O(1)`
3769
5385
  *
3770
5386
  * @param {number} collection
3771
5387
  * @param {PalletNftsBitFlags} lockSettings
@@ -3788,7 +5404,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3788
5404
  >;
3789
5405
 
3790
5406
  /**
3791
- * See [`Pallet::transfer_ownership`].
5407
+ * Change the Owner of a collection.
5408
+ *
5409
+ * Origin must be Signed and the sender should be the Owner of the `collection`.
5410
+ *
5411
+ * - `collection`: The collection whose owner should be changed.
5412
+ * - `owner`: The new Owner of this collection. They must have called
5413
+ * `set_accept_ownership` with `collection` in order for this operation to succeed.
5414
+ *
5415
+ * Emits `OwnerChanged`.
5416
+ *
5417
+ * Weight: `O(1)`
3792
5418
  *
3793
5419
  * @param {number} collection
3794
5420
  * @param {MultiAddressLike} newOwner
@@ -3811,7 +5437,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3811
5437
  >;
3812
5438
 
3813
5439
  /**
3814
- * See [`Pallet::set_team`].
5440
+ * Change the Issuer, Admin and Freezer of a collection.
5441
+ *
5442
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5443
+ * `collection`.
5444
+ *
5445
+ * Note: by setting the role to `None` only the `ForceOrigin` will be able to change it
5446
+ * after to `Some(account)`.
5447
+ *
5448
+ * - `collection`: The collection whose team should be changed.
5449
+ * - `issuer`: The new Issuer of this collection.
5450
+ * - `admin`: The new Admin of this collection.
5451
+ * - `freezer`: The new Freezer of this collection.
5452
+ *
5453
+ * Emits `TeamChanged`.
5454
+ *
5455
+ * Weight: `O(1)`
3815
5456
  *
3816
5457
  * @param {number} collection
3817
5458
  * @param {MultiAddressLike | undefined} issuer
@@ -3843,7 +5484,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3843
5484
  >;
3844
5485
 
3845
5486
  /**
3846
- * See [`Pallet::force_collection_owner`].
5487
+ * Change the Owner of a collection.
5488
+ *
5489
+ * Origin must be `ForceOrigin`.
5490
+ *
5491
+ * - `collection`: The identifier of the collection.
5492
+ * - `owner`: The new Owner of this collection.
5493
+ *
5494
+ * Emits `OwnerChanged`.
5495
+ *
5496
+ * Weight: `O(1)`
3847
5497
  *
3848
5498
  * @param {number} collection
3849
5499
  * @param {MultiAddressLike} owner
@@ -3866,7 +5516,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3866
5516
  >;
3867
5517
 
3868
5518
  /**
3869
- * See [`Pallet::force_collection_config`].
5519
+ * Change the config of a collection.
5520
+ *
5521
+ * Origin must be `ForceOrigin`.
5522
+ *
5523
+ * - `collection`: The identifier of the collection.
5524
+ * - `config`: The new config of this collection.
5525
+ *
5526
+ * Emits `CollectionConfigChanged`.
5527
+ *
5528
+ * Weight: `O(1)`
3870
5529
  *
3871
5530
  * @param {number} collection
3872
5531
  * @param {PalletNftsCollectionConfig} config
@@ -3889,7 +5548,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3889
5548
  >;
3890
5549
 
3891
5550
  /**
3892
- * See [`Pallet::approve_transfer`].
5551
+ * Approve an item to be transferred by a delegated third-party account.
5552
+ *
5553
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5554
+ * `item`.
5555
+ *
5556
+ * - `collection`: The collection of the item to be approved for delegated transfer.
5557
+ * - `item`: The item to be approved for delegated transfer.
5558
+ * - `delegate`: The account to delegate permission to transfer the item.
5559
+ * - `maybe_deadline`: Optional deadline for the approval. Specified by providing the
5560
+ * number of blocks after which the approval will expire
5561
+ *
5562
+ * Emits `TransferApproved` on success.
5563
+ *
5564
+ * Weight: `O(1)`
3893
5565
  *
3894
5566
  * @param {number} collection
3895
5567
  * @param {number} item
@@ -3916,7 +5588,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3916
5588
  >;
3917
5589
 
3918
5590
  /**
3919
- * See [`Pallet::cancel_approval`].
5591
+ * Cancel one of the transfer approvals for a specific item.
5592
+ *
5593
+ * Origin must be either:
5594
+ * - the `Force` origin;
5595
+ * - `Signed` with the signer being the Owner of the `item`;
5596
+ *
5597
+ * Arguments:
5598
+ * - `collection`: The collection of the item of whose approval will be cancelled.
5599
+ * - `item`: The item of the collection of whose approval will be cancelled.
5600
+ * - `delegate`: The account that is going to loose their approval.
5601
+ *
5602
+ * Emits `ApprovalCancelled` on success.
5603
+ *
5604
+ * Weight: `O(1)`
3920
5605
  *
3921
5606
  * @param {number} collection
3922
5607
  * @param {number} item
@@ -3941,7 +5626,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3941
5626
  >;
3942
5627
 
3943
5628
  /**
3944
- * See [`Pallet::clear_all_transfer_approvals`].
5629
+ * Cancel all the approvals of a specific item.
5630
+ *
5631
+ * Origin must be either:
5632
+ * - the `Force` origin;
5633
+ * - `Signed` with the signer being the Owner of the `item`;
5634
+ *
5635
+ * Arguments:
5636
+ * - `collection`: The collection of the item of whose approvals will be cleared.
5637
+ * - `item`: The item of the collection of whose approvals will be cleared.
5638
+ *
5639
+ * Emits `AllApprovalsCancelled` on success.
5640
+ *
5641
+ * Weight: `O(1)`
3945
5642
  *
3946
5643
  * @param {number} collection
3947
5644
  * @param {number} item
@@ -3964,7 +5661,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3964
5661
  >;
3965
5662
 
3966
5663
  /**
3967
- * See [`Pallet::lock_item_properties`].
5664
+ * Disallows changing the metadata or attributes of the item.
5665
+ *
5666
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Admin
5667
+ * of the `collection`.
5668
+ *
5669
+ * - `collection`: The collection if the `item`.
5670
+ * - `item`: An item to be locked.
5671
+ * - `lock_metadata`: Specifies whether the metadata should be locked.
5672
+ * - `lock_attributes`: Specifies whether the attributes in the `CollectionOwner` namespace
5673
+ * should be locked.
5674
+ *
5675
+ * Note: `lock_attributes` affects the attributes in the `CollectionOwner` namespace only.
5676
+ * When the metadata or attributes are locked, it won't be possible the unlock them.
5677
+ *
5678
+ * Emits `ItemPropertiesLocked`.
5679
+ *
5680
+ * Weight: `O(1)`
3968
5681
  *
3969
5682
  * @param {number} collection
3970
5683
  * @param {number} item
@@ -3991,7 +5704,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3991
5704
  >;
3992
5705
 
3993
5706
  /**
3994
- * See [`Pallet::set_attribute`].
5707
+ * Set an attribute for a collection or item.
5708
+ *
5709
+ * Origin must be Signed and must conform to the namespace ruleset:
5710
+ * - `CollectionOwner` namespace could be modified by the `collection` Admin only;
5711
+ * - `ItemOwner` namespace could be modified by the `maybe_item` owner only. `maybe_item`
5712
+ * should be set in that case;
5713
+ * - `Account(AccountId)` namespace could be modified only when the `origin` was given a
5714
+ * permission to do so;
5715
+ *
5716
+ * The funds of `origin` are reserved according to the formula:
5717
+ * `AttributeDepositBase + DepositPerByte * (key.len + value.len)` taking into
5718
+ * account any already reserved funds.
5719
+ *
5720
+ * - `collection`: The identifier of the collection whose item's metadata to set.
5721
+ * - `maybe_item`: The identifier of the item whose metadata to set.
5722
+ * - `namespace`: Attribute's namespace.
5723
+ * - `key`: The key of the attribute.
5724
+ * - `value`: The value to which to set the attribute.
5725
+ *
5726
+ * Emits `AttributeSet`.
5727
+ *
5728
+ * Weight: `O(1)`
3995
5729
  *
3996
5730
  * @param {number} collection
3997
5731
  * @param {number | undefined} maybeItem
@@ -4026,7 +5760,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4026
5760
  >;
4027
5761
 
4028
5762
  /**
4029
- * See [`Pallet::force_set_attribute`].
5763
+ * Force-set an attribute for a collection or item.
5764
+ *
5765
+ * Origin must be `ForceOrigin`.
5766
+ *
5767
+ * If the attribute already exists and it was set by another account, the deposit
5768
+ * will be returned to the previous owner.
5769
+ *
5770
+ * - `set_as`: An optional owner of the attribute.
5771
+ * - `collection`: The identifier of the collection whose item's metadata to set.
5772
+ * - `maybe_item`: The identifier of the item whose metadata to set.
5773
+ * - `namespace`: Attribute's namespace.
5774
+ * - `key`: The key of the attribute.
5775
+ * - `value`: The value to which to set the attribute.
5776
+ *
5777
+ * Emits `AttributeSet`.
5778
+ *
5779
+ * Weight: `O(1)`
4030
5780
  *
4031
5781
  * @param {AccountId32Like | undefined} setAs
4032
5782
  * @param {number} collection
@@ -4064,7 +5814,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4064
5814
  >;
4065
5815
 
4066
5816
  /**
4067
- * See [`Pallet::clear_attribute`].
5817
+ * Clear an attribute for a collection or item.
5818
+ *
5819
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Owner of the
5820
+ * attribute.
5821
+ *
5822
+ * Any deposit is freed for the collection's owner.
5823
+ *
5824
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
5825
+ * - `maybe_item`: The identifier of the item whose metadata to clear.
5826
+ * - `namespace`: Attribute's namespace.
5827
+ * - `key`: The key of the attribute.
5828
+ *
5829
+ * Emits `AttributeCleared`.
5830
+ *
5831
+ * Weight: `O(1)`
4068
5832
  *
4069
5833
  * @param {number} collection
4070
5834
  * @param {number | undefined} maybeItem
@@ -4096,7 +5860,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4096
5860
  >;
4097
5861
 
4098
5862
  /**
4099
- * See [`Pallet::approve_item_attributes`].
5863
+ * Approve item's attributes to be changed by a delegated third-party account.
5864
+ *
5865
+ * Origin must be Signed and must be an owner of the `item`.
5866
+ *
5867
+ * - `collection`: A collection of the item.
5868
+ * - `item`: The item that holds attributes.
5869
+ * - `delegate`: The account to delegate permission to change attributes of the item.
5870
+ *
5871
+ * Emits `ItemAttributesApprovalAdded` on success.
4100
5872
  *
4101
5873
  * @param {number} collection
4102
5874
  * @param {number} item
@@ -4121,7 +5893,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4121
5893
  >;
4122
5894
 
4123
5895
  /**
4124
- * See [`Pallet::cancel_item_attributes_approval`].
5896
+ * Cancel the previously provided approval to change item's attributes.
5897
+ * All the previously set attributes by the `delegate` will be removed.
5898
+ *
5899
+ * Origin must be Signed and must be an owner of the `item`.
5900
+ *
5901
+ * - `collection`: Collection that the item is contained within.
5902
+ * - `item`: The item that holds attributes.
5903
+ * - `delegate`: The previously approved account to remove.
5904
+ *
5905
+ * Emits `ItemAttributesApprovalRemoved` on success.
4125
5906
  *
4126
5907
  * @param {number} collection
4127
5908
  * @param {number} item
@@ -4153,7 +5934,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4153
5934
  >;
4154
5935
 
4155
5936
  /**
4156
- * See [`Pallet::set_metadata`].
5937
+ * Set the metadata for an item.
5938
+ *
5939
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Admin of the
5940
+ * `collection`.
5941
+ *
5942
+ * If the origin is Signed, then funds of signer are reserved according to the formula:
5943
+ * `MetadataDepositBase + DepositPerByte * data.len` taking into
5944
+ * account any already reserved funds.
5945
+ *
5946
+ * - `collection`: The identifier of the collection whose item's metadata to set.
5947
+ * - `item`: The identifier of the item whose metadata to set.
5948
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
5949
+ *
5950
+ * Emits `ItemMetadataSet`.
5951
+ *
5952
+ * Weight: `O(1)`
4157
5953
  *
4158
5954
  * @param {number} collection
4159
5955
  * @param {number} item
@@ -4178,7 +5974,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4178
5974
  >;
4179
5975
 
4180
5976
  /**
4181
- * See [`Pallet::clear_metadata`].
5977
+ * Clear the metadata for an item.
5978
+ *
5979
+ * Origin must be either `ForceOrigin` or Signed and the sender should be the Admin of the
5980
+ * `collection`.
5981
+ *
5982
+ * Any deposit is freed for the collection's owner.
5983
+ *
5984
+ * - `collection`: The identifier of the collection whose item's metadata to clear.
5985
+ * - `item`: The identifier of the item whose metadata to clear.
5986
+ *
5987
+ * Emits `ItemMetadataCleared`.
5988
+ *
5989
+ * Weight: `O(1)`
4182
5990
  *
4183
5991
  * @param {number} collection
4184
5992
  * @param {number} item
@@ -4201,7 +6009,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4201
6009
  >;
4202
6010
 
4203
6011
  /**
4204
- * See [`Pallet::set_collection_metadata`].
6012
+ * Set the metadata for a collection.
6013
+ *
6014
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Admin of
6015
+ * the `collection`.
6016
+ *
6017
+ * If the origin is `Signed`, then funds of signer are reserved according to the formula:
6018
+ * `MetadataDepositBase + DepositPerByte * data.len` taking into
6019
+ * account any already reserved funds.
6020
+ *
6021
+ * - `collection`: The identifier of the item whose metadata to update.
6022
+ * - `data`: The general information of this item. Limited in length by `StringLimit`.
6023
+ *
6024
+ * Emits `CollectionMetadataSet`.
6025
+ *
6026
+ * Weight: `O(1)`
4205
6027
  *
4206
6028
  * @param {number} collection
4207
6029
  * @param {BytesLike} data
@@ -4224,7 +6046,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4224
6046
  >;
4225
6047
 
4226
6048
  /**
4227
- * See [`Pallet::clear_collection_metadata`].
6049
+ * Clear the metadata for a collection.
6050
+ *
6051
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Admin of
6052
+ * the `collection`.
6053
+ *
6054
+ * Any deposit is freed for the collection's owner.
6055
+ *
6056
+ * - `collection`: The identifier of the collection whose metadata to clear.
6057
+ *
6058
+ * Emits `CollectionMetadataCleared`.
6059
+ *
6060
+ * Weight: `O(1)`
4228
6061
  *
4229
6062
  * @param {number} collection
4230
6063
  **/
@@ -4243,7 +6076,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4243
6076
  >;
4244
6077
 
4245
6078
  /**
4246
- * See [`Pallet::set_accept_ownership`].
6079
+ * Set (or reset) the acceptance of ownership for a particular account.
6080
+ *
6081
+ * Origin must be `Signed` and if `maybe_collection` is `Some`, then the signer must have a
6082
+ * provider reference.
6083
+ *
6084
+ * - `maybe_collection`: The identifier of the collection whose ownership the signer is
6085
+ * willing to accept, or if `None`, an indication that the signer is willing to accept no
6086
+ * ownership transferal.
6087
+ *
6088
+ * Emits `OwnershipAcceptanceChanged`.
4247
6089
  *
4248
6090
  * @param {number | undefined} maybeCollection
4249
6091
  **/
@@ -4262,7 +6104,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4262
6104
  >;
4263
6105
 
4264
6106
  /**
4265
- * See [`Pallet::set_collection_max_supply`].
6107
+ * Set the maximum number of items a collection could have.
6108
+ *
6109
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Owner of
6110
+ * the `collection`.
6111
+ *
6112
+ * - `collection`: The identifier of the collection to change.
6113
+ * - `max_supply`: The maximum number of items a collection could have.
6114
+ *
6115
+ * Emits `CollectionMaxSupplySet` event when successful.
4266
6116
  *
4267
6117
  * @param {number} collection
4268
6118
  * @param {number} maxSupply
@@ -4285,7 +6135,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4285
6135
  >;
4286
6136
 
4287
6137
  /**
4288
- * See [`Pallet::update_mint_settings`].
6138
+ * Update mint settings.
6139
+ *
6140
+ * Origin must be either `ForceOrigin` or `Signed` and the sender should be the Issuer
6141
+ * of the `collection`.
6142
+ *
6143
+ * - `collection`: The identifier of the collection to change.
6144
+ * - `mint_settings`: The new mint settings.
6145
+ *
6146
+ * Emits `CollectionMintSettingsUpdated` event when successful.
4289
6147
  *
4290
6148
  * @param {number} collection
4291
6149
  * @param {PalletNftsMintSettings} mintSettings
@@ -4308,7 +6166,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4308
6166
  >;
4309
6167
 
4310
6168
  /**
4311
- * See [`Pallet::set_price`].
6169
+ * Set (or reset) the price for an item.
6170
+ *
6171
+ * Origin must be Signed and must be the owner of the `item`.
6172
+ *
6173
+ * - `collection`: The collection of the item.
6174
+ * - `item`: The item to set the price for.
6175
+ * - `price`: The price for the item. Pass `None`, to reset the price.
6176
+ * - `buyer`: Restricts the buy operation to a specific account.
6177
+ *
6178
+ * Emits `ItemPriceSet` on success if the price is not `None`.
6179
+ * Emits `ItemPriceRemoved` on success if the price is `None`.
4312
6180
  *
4313
6181
  * @param {number} collection
4314
6182
  * @param {number} item
@@ -4340,7 +6208,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4340
6208
  >;
4341
6209
 
4342
6210
  /**
4343
- * See [`Pallet::buy_item`].
6211
+ * Allows to buy an item if it's up for sale.
6212
+ *
6213
+ * Origin must be Signed and must not be the owner of the `item`.
6214
+ *
6215
+ * - `collection`: The collection of the item.
6216
+ * - `item`: The item the sender wants to buy.
6217
+ * - `bid_price`: The price the sender is willing to pay.
6218
+ *
6219
+ * Emits `ItemBought` on success.
4344
6220
  *
4345
6221
  * @param {number} collection
4346
6222
  * @param {number} item
@@ -4365,7 +6241,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4365
6241
  >;
4366
6242
 
4367
6243
  /**
4368
- * See [`Pallet::pay_tips`].
6244
+ * Allows to pay the tips.
6245
+ *
6246
+ * Origin must be Signed.
6247
+ *
6248
+ * - `tips`: Tips array.
6249
+ *
6250
+ * Emits `TipSent` on every tip transfer.
4369
6251
  *
4370
6252
  * @param {Array<PalletNftsItemTip>} tips
4371
6253
  **/
@@ -4384,7 +6266,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4384
6266
  >;
4385
6267
 
4386
6268
  /**
4387
- * See [`Pallet::create_swap`].
6269
+ * Register a new atomic swap, declaring an intention to send an `item` in exchange for
6270
+ * `desired_item` from origin to target on the current blockchain.
6271
+ * The target can execute the swap during the specified `duration` of blocks (if set).
6272
+ * Additionally, the price could be set for the desired `item`.
6273
+ *
6274
+ * Origin must be Signed and must be an owner of the `item`.
6275
+ *
6276
+ * - `collection`: The collection of the item.
6277
+ * - `item`: The item an owner wants to give.
6278
+ * - `desired_collection`: The collection of the desired item.
6279
+ * - `desired_item`: The desired item an owner wants to receive.
6280
+ * - `maybe_price`: The price an owner is willing to pay or receive for the desired `item`.
6281
+ * - `duration`: A deadline for the swap. Specified by providing the number of blocks
6282
+ * after which the swap will expire.
6283
+ *
6284
+ * Emits `SwapCreated` on success.
4388
6285
  *
4389
6286
  * @param {number} offeredCollection
4390
6287
  * @param {number} offeredItem
@@ -4422,7 +6319,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4422
6319
  >;
4423
6320
 
4424
6321
  /**
4425
- * See [`Pallet::cancel_swap`].
6322
+ * Cancel an atomic swap.
6323
+ *
6324
+ * Origin must be Signed.
6325
+ * Origin must be an owner of the `item` if the deadline hasn't expired.
6326
+ *
6327
+ * - `collection`: The collection of the item.
6328
+ * - `item`: The item an owner wants to give.
6329
+ *
6330
+ * Emits `SwapCancelled` on success.
4426
6331
  *
4427
6332
  * @param {number} offeredCollection
4428
6333
  * @param {number} offeredItem
@@ -4445,7 +6350,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4445
6350
  >;
4446
6351
 
4447
6352
  /**
4448
- * See [`Pallet::claim_swap`].
6353
+ * Claim an atomic swap.
6354
+ * This method executes a pending swap, that was created by a counterpart before.
6355
+ *
6356
+ * Origin must be Signed and must be an owner of the `item`.
6357
+ *
6358
+ * - `send_collection`: The collection of the item to be sent.
6359
+ * - `send_item`: The item to be sent.
6360
+ * - `receive_collection`: The collection of the item to be received.
6361
+ * - `receive_item`: The item to be received.
6362
+ * - `witness_price`: A price that was previously agreed on.
6363
+ *
6364
+ * Emits `SwapClaimed` on success.
4449
6365
  *
4450
6366
  * @param {number} sendCollection
4451
6367
  * @param {number} sendItem
@@ -4480,7 +6396,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4480
6396
  >;
4481
6397
 
4482
6398
  /**
4483
- * See [`Pallet::mint_pre_signed`].
6399
+ * Mint an item by providing the pre-signed approval.
6400
+ *
6401
+ * Origin must be Signed.
6402
+ *
6403
+ * - `mint_data`: The pre-signed approval that consists of the information about the item,
6404
+ * its metadata, attributes, who can mint it (`None` for anyone) and until what block
6405
+ * number.
6406
+ * - `signature`: The signature of the `data` object.
6407
+ * - `signer`: The `data` object's signer. Should be an Issuer of the collection.
6408
+ *
6409
+ * Emits `Issued` on success.
6410
+ * Emits `AttributeSet` if the attributes were provided.
6411
+ * Emits `ItemMetadataSet` if the metadata was not empty.
4484
6412
  *
4485
6413
  * @param {PalletNftsPreSignedMint} mintData
4486
6414
  * @param {SpRuntimeMultiSignature} signature
@@ -4505,7 +6433,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4505
6433
  >;
4506
6434
 
4507
6435
  /**
4508
- * See [`Pallet::set_attributes_pre_signed`].
6436
+ * Set attributes for an item by providing the pre-signed approval.
6437
+ *
6438
+ * Origin must be Signed and must be an owner of the `data.item`.
6439
+ *
6440
+ * - `data`: The pre-signed approval that consists of the information about the item,
6441
+ * attributes to update and until what block number.
6442
+ * - `signature`: The signature of the `data` object.
6443
+ * - `signer`: The `data` object's signer. Should be an Admin of the collection for the
6444
+ * `CollectionOwner` namespace.
6445
+ *
6446
+ * Emits `AttributeSet` for each provided attribute.
6447
+ * Emits `ItemAttributesApprovalAdded` if the approval wasn't set before.
6448
+ * Emits `PreSignedAttributesSet` on success.
4509
6449
  *
4510
6450
  * @param {PalletNftsPreSignedAttributes} data
4511
6451
  * @param {SpRuntimeMultiSignature} signature
@@ -4543,7 +6483,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4543
6483
  **/
4544
6484
  foreignAssets: {
4545
6485
  /**
4546
- * See [`Pallet::create`].
6486
+ * Issue a new class of fungible assets from a public origin.
6487
+ *
6488
+ * This new asset class has no assets initially and its owner is the origin.
6489
+ *
6490
+ * The origin must conform to the configured `CreateOrigin` and have sufficient funds free.
6491
+ *
6492
+ * Funds of sender are reserved by `AssetDeposit`.
6493
+ *
6494
+ * Parameters:
6495
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
6496
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
6497
+ * - `admin`: The admin of this class of assets. The admin is the initial address of each
6498
+ * member of the asset class's admin team.
6499
+ * - `min_balance`: The minimum balance of this new asset that any single account must
6500
+ * have. If an account's balance is reduced below this, then it collapses to zero.
6501
+ *
6502
+ * Emits `Created` event when successful.
6503
+ *
6504
+ * Weight: `O(1)`
4547
6505
  *
4548
6506
  * @param {StagingXcmV3MultilocationMultiLocation} id
4549
6507
  * @param {MultiAddressLike} admin
@@ -4568,7 +6526,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4568
6526
  >;
4569
6527
 
4570
6528
  /**
4571
- * See [`Pallet::force_create`].
6529
+ * Issue a new class of fungible assets from a privileged origin.
6530
+ *
6531
+ * This new asset class has no assets initially.
6532
+ *
6533
+ * The origin must conform to `ForceOrigin`.
6534
+ *
6535
+ * Unlike `create`, no funds are reserved.
6536
+ *
6537
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
6538
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
6539
+ * - `owner`: The owner of this class of assets. The owner has full superuser permissions
6540
+ * over this asset, but may later change and configure the permissions using
6541
+ * `transfer_ownership` and `set_team`.
6542
+ * - `min_balance`: The minimum balance of this new asset that any single account must
6543
+ * have. If an account's balance is reduced below this, then it collapses to zero.
6544
+ *
6545
+ * Emits `ForceCreated` event when successful.
6546
+ *
6547
+ * Weight: `O(1)`
4572
6548
  *
4573
6549
  * @param {StagingXcmV3MultilocationMultiLocation} id
4574
6550
  * @param {MultiAddressLike} owner
@@ -4600,7 +6576,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4600
6576
  >;
4601
6577
 
4602
6578
  /**
4603
- * See [`Pallet::start_destroy`].
6579
+ * Start the process of destroying a fungible asset class.
6580
+ *
6581
+ * `start_destroy` is the first in a series of extrinsics that should be called, to allow
6582
+ * destruction of an asset class.
6583
+ *
6584
+ * The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.
6585
+ *
6586
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6587
+ * asset.
6588
+ *
6589
+ * The asset class must be frozen before calling `start_destroy`.
4604
6590
  *
4605
6591
  * @param {StagingXcmV3MultilocationMultiLocation} id
4606
6592
  **/
@@ -4619,7 +6605,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4619
6605
  >;
4620
6606
 
4621
6607
  /**
4622
- * See [`Pallet::destroy_accounts`].
6608
+ * Destroy all accounts associated with a given asset.
6609
+ *
6610
+ * `destroy_accounts` should only be called after `start_destroy` has been called, and the
6611
+ * asset is in a `Destroying` state.
6612
+ *
6613
+ * Due to weight restrictions, this function may need to be called multiple times to fully
6614
+ * destroy all accounts. It will destroy `RemoveItemsLimit` accounts at a time.
6615
+ *
6616
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6617
+ * asset.
6618
+ *
6619
+ * Each call emits the `Event::DestroyedAccounts` event.
4623
6620
  *
4624
6621
  * @param {StagingXcmV3MultilocationMultiLocation} id
4625
6622
  **/
@@ -4638,7 +6635,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4638
6635
  >;
4639
6636
 
4640
6637
  /**
4641
- * See [`Pallet::destroy_approvals`].
6638
+ * Destroy all approvals associated with a given asset up to the max (T::RemoveItemsLimit).
6639
+ *
6640
+ * `destroy_approvals` should only be called after `start_destroy` has been called, and the
6641
+ * asset is in a `Destroying` state.
6642
+ *
6643
+ * Due to weight restrictions, this function may need to be called multiple times to fully
6644
+ * destroy all approvals. It will destroy `RemoveItemsLimit` approvals at a time.
6645
+ *
6646
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6647
+ * asset.
6648
+ *
6649
+ * Each call emits the `Event::DestroyedApprovals` event.
4642
6650
  *
4643
6651
  * @param {StagingXcmV3MultilocationMultiLocation} id
4644
6652
  **/
@@ -4657,7 +6665,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4657
6665
  >;
4658
6666
 
4659
6667
  /**
4660
- * See [`Pallet::finish_destroy`].
6668
+ * Complete destroying asset and unreserve currency.
6669
+ *
6670
+ * `finish_destroy` should only be called after `start_destroy` has been called, and the
6671
+ * asset is in a `Destroying` state. All accounts or approvals should be destroyed before
6672
+ * hand.
6673
+ *
6674
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6675
+ * asset.
6676
+ *
6677
+ * Each successful call emits the `Event::Destroyed` event.
4661
6678
  *
4662
6679
  * @param {StagingXcmV3MultilocationMultiLocation} id
4663
6680
  **/
@@ -4676,7 +6693,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4676
6693
  >;
4677
6694
 
4678
6695
  /**
4679
- * See [`Pallet::mint`].
6696
+ * Mint assets of a particular class.
6697
+ *
6698
+ * The origin must be Signed and the sender must be the Issuer of the asset `id`.
6699
+ *
6700
+ * - `id`: The identifier of the asset to have some amount minted.
6701
+ * - `beneficiary`: The account to be credited with the minted assets.
6702
+ * - `amount`: The amount of the asset to be minted.
6703
+ *
6704
+ * Emits `Issued` event when successful.
6705
+ *
6706
+ * Weight: `O(1)`
6707
+ * Modes: Pre-existing balance of `beneficiary`; Account pre-existence of `beneficiary`.
4680
6708
  *
4681
6709
  * @param {StagingXcmV3MultilocationMultiLocation} id
4682
6710
  * @param {MultiAddressLike} beneficiary
@@ -4701,7 +6729,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4701
6729
  >;
4702
6730
 
4703
6731
  /**
4704
- * See [`Pallet::burn`].
6732
+ * Reduce the balance of `who` by as much as possible up to `amount` assets of `id`.
6733
+ *
6734
+ * Origin must be Signed and the sender should be the Manager of the asset `id`.
6735
+ *
6736
+ * Bails with `NoAccount` if the `who` is already dead.
6737
+ *
6738
+ * - `id`: The identifier of the asset to have some amount burned.
6739
+ * - `who`: The account to be debited from.
6740
+ * - `amount`: The maximum amount by which `who`'s balance should be reduced.
6741
+ *
6742
+ * Emits `Burned` with the actual amount burned. If this takes the balance to below the
6743
+ * minimum for the asset, then the amount burned is increased to take it to zero.
6744
+ *
6745
+ * Weight: `O(1)`
6746
+ * Modes: Post-existence of `who`; Pre & post Zombie-status of `who`.
4705
6747
  *
4706
6748
  * @param {StagingXcmV3MultilocationMultiLocation} id
4707
6749
  * @param {MultiAddressLike} who
@@ -4726,7 +6768,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4726
6768
  >;
4727
6769
 
4728
6770
  /**
4729
- * See [`Pallet::transfer`].
6771
+ * Move some assets from the sender account to another.
6772
+ *
6773
+ * Origin must be Signed.
6774
+ *
6775
+ * - `id`: The identifier of the asset to have some amount transferred.
6776
+ * - `target`: The account to be credited.
6777
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
6778
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
6779
+ * the case that the transfer would otherwise take the sender balance above zero but below
6780
+ * the minimum balance. Must be greater than zero.
6781
+ *
6782
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6783
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6784
+ * to zero.
6785
+ *
6786
+ * Weight: `O(1)`
6787
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
6788
+ * `target`.
4730
6789
  *
4731
6790
  * @param {StagingXcmV3MultilocationMultiLocation} id
4732
6791
  * @param {MultiAddressLike} target
@@ -4751,7 +6810,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4751
6810
  >;
4752
6811
 
4753
6812
  /**
4754
- * See [`Pallet::transfer_keep_alive`].
6813
+ * Move some assets from the sender account to another, keeping the sender account alive.
6814
+ *
6815
+ * Origin must be Signed.
6816
+ *
6817
+ * - `id`: The identifier of the asset to have some amount transferred.
6818
+ * - `target`: The account to be credited.
6819
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
6820
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
6821
+ * the case that the transfer would otherwise take the sender balance above zero but below
6822
+ * the minimum balance. Must be greater than zero.
6823
+ *
6824
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6825
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6826
+ * to zero.
6827
+ *
6828
+ * Weight: `O(1)`
6829
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
6830
+ * `target`.
4755
6831
  *
4756
6832
  * @param {StagingXcmV3MultilocationMultiLocation} id
4757
6833
  * @param {MultiAddressLike} target
@@ -4776,7 +6852,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4776
6852
  >;
4777
6853
 
4778
6854
  /**
4779
- * See [`Pallet::force_transfer`].
6855
+ * Move some assets from one account to another.
6856
+ *
6857
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
6858
+ *
6859
+ * - `id`: The identifier of the asset to have some amount transferred.
6860
+ * - `source`: The account to be debited.
6861
+ * - `dest`: The account to be credited.
6862
+ * - `amount`: The amount by which the `source`'s balance of assets should be reduced and
6863
+ * `dest`'s balance increased. The amount actually transferred may be slightly greater in
6864
+ * the case that the transfer would otherwise take the `source` balance above zero but
6865
+ * below the minimum balance. Must be greater than zero.
6866
+ *
6867
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6868
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6869
+ * to zero.
6870
+ *
6871
+ * Weight: `O(1)`
6872
+ * Modes: Pre-existence of `dest`; Post-existence of `source`; Account pre-existence of
6873
+ * `dest`.
4780
6874
  *
4781
6875
  * @param {StagingXcmV3MultilocationMultiLocation} id
4782
6876
  * @param {MultiAddressLike} source
@@ -4808,7 +6902,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4808
6902
  >;
4809
6903
 
4810
6904
  /**
4811
- * See [`Pallet::freeze`].
6905
+ * Disallow further unprivileged transfers of an asset `id` from an account `who`. `who`
6906
+ * must already exist as an entry in `Account`s of the asset. If you want to freeze an
6907
+ * account that does not have an entry, use `touch_other` first.
6908
+ *
6909
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
6910
+ *
6911
+ * - `id`: The identifier of the asset to be frozen.
6912
+ * - `who`: The account to be frozen.
6913
+ *
6914
+ * Emits `Frozen`.
6915
+ *
6916
+ * Weight: `O(1)`
4812
6917
  *
4813
6918
  * @param {StagingXcmV3MultilocationMultiLocation} id
4814
6919
  * @param {MultiAddressLike} who
@@ -4831,7 +6936,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4831
6936
  >;
4832
6937
 
4833
6938
  /**
4834
- * See [`Pallet::thaw`].
6939
+ * Allow unprivileged transfers to and from an account again.
6940
+ *
6941
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
6942
+ *
6943
+ * - `id`: The identifier of the asset to be frozen.
6944
+ * - `who`: The account to be unfrozen.
6945
+ *
6946
+ * Emits `Thawed`.
6947
+ *
6948
+ * Weight: `O(1)`
4835
6949
  *
4836
6950
  * @param {StagingXcmV3MultilocationMultiLocation} id
4837
6951
  * @param {MultiAddressLike} who
@@ -4854,7 +6968,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4854
6968
  >;
4855
6969
 
4856
6970
  /**
4857
- * See [`Pallet::freeze_asset`].
6971
+ * Disallow further unprivileged transfers for the asset class.
6972
+ *
6973
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
6974
+ *
6975
+ * - `id`: The identifier of the asset to be frozen.
6976
+ *
6977
+ * Emits `Frozen`.
6978
+ *
6979
+ * Weight: `O(1)`
4858
6980
  *
4859
6981
  * @param {StagingXcmV3MultilocationMultiLocation} id
4860
6982
  **/
@@ -4873,7 +6995,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4873
6995
  >;
4874
6996
 
4875
6997
  /**
4876
- * See [`Pallet::thaw_asset`].
6998
+ * Allow unprivileged transfers for the asset again.
6999
+ *
7000
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
7001
+ *
7002
+ * - `id`: The identifier of the asset to be thawed.
7003
+ *
7004
+ * Emits `Thawed`.
7005
+ *
7006
+ * Weight: `O(1)`
4877
7007
  *
4878
7008
  * @param {StagingXcmV3MultilocationMultiLocation} id
4879
7009
  **/
@@ -4892,7 +7022,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4892
7022
  >;
4893
7023
 
4894
7024
  /**
4895
- * See [`Pallet::transfer_ownership`].
7025
+ * Change the Owner of an asset.
7026
+ *
7027
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
7028
+ *
7029
+ * - `id`: The identifier of the asset.
7030
+ * - `owner`: The new Owner of this asset.
7031
+ *
7032
+ * Emits `OwnerChanged`.
7033
+ *
7034
+ * Weight: `O(1)`
4896
7035
  *
4897
7036
  * @param {StagingXcmV3MultilocationMultiLocation} id
4898
7037
  * @param {MultiAddressLike} owner
@@ -4915,7 +7054,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4915
7054
  >;
4916
7055
 
4917
7056
  /**
4918
- * See [`Pallet::set_team`].
7057
+ * Change the Issuer, Admin and Freezer of an asset.
7058
+ *
7059
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
7060
+ *
7061
+ * - `id`: The identifier of the asset to be frozen.
7062
+ * - `issuer`: The new Issuer of this asset.
7063
+ * - `admin`: The new Admin of this asset.
7064
+ * - `freezer`: The new Freezer of this asset.
7065
+ *
7066
+ * Emits `TeamChanged`.
7067
+ *
7068
+ * Weight: `O(1)`
4919
7069
  *
4920
7070
  * @param {StagingXcmV3MultilocationMultiLocation} id
4921
7071
  * @param {MultiAddressLike} issuer
@@ -4947,7 +7097,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4947
7097
  >;
4948
7098
 
4949
7099
  /**
4950
- * See [`Pallet::set_metadata`].
7100
+ * Set the metadata for an asset.
7101
+ *
7102
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
7103
+ *
7104
+ * Funds of sender are reserved according to the formula:
7105
+ * `MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len)` taking into
7106
+ * account any already reserved funds.
7107
+ *
7108
+ * - `id`: The identifier of the asset to update.
7109
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
7110
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
7111
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
7112
+ *
7113
+ * Emits `MetadataSet`.
7114
+ *
7115
+ * Weight: `O(1)`
4951
7116
  *
4952
7117
  * @param {StagingXcmV3MultilocationMultiLocation} id
4953
7118
  * @param {BytesLike} name
@@ -4979,7 +7144,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4979
7144
  >;
4980
7145
 
4981
7146
  /**
4982
- * See [`Pallet::clear_metadata`].
7147
+ * Clear the metadata for an asset.
7148
+ *
7149
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
7150
+ *
7151
+ * Any deposit is freed for the asset owner.
7152
+ *
7153
+ * - `id`: The identifier of the asset to clear.
7154
+ *
7155
+ * Emits `MetadataCleared`.
7156
+ *
7157
+ * Weight: `O(1)`
4983
7158
  *
4984
7159
  * @param {StagingXcmV3MultilocationMultiLocation} id
4985
7160
  **/
@@ -4998,7 +7173,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4998
7173
  >;
4999
7174
 
5000
7175
  /**
5001
- * See [`Pallet::force_set_metadata`].
7176
+ * Force the metadata for an asset to some value.
7177
+ *
7178
+ * Origin must be ForceOrigin.
7179
+ *
7180
+ * Any deposit is left alone.
7181
+ *
7182
+ * - `id`: The identifier of the asset to update.
7183
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
7184
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
7185
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
7186
+ *
7187
+ * Emits `MetadataSet`.
7188
+ *
7189
+ * Weight: `O(N + S)` where N and S are the length of the name and symbol respectively.
5002
7190
  *
5003
7191
  * @param {StagingXcmV3MultilocationMultiLocation} id
5004
7192
  * @param {BytesLike} name
@@ -5033,7 +7221,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5033
7221
  >;
5034
7222
 
5035
7223
  /**
5036
- * See [`Pallet::force_clear_metadata`].
7224
+ * Clear the metadata for an asset.
7225
+ *
7226
+ * Origin must be ForceOrigin.
7227
+ *
7228
+ * Any deposit is returned.
7229
+ *
7230
+ * - `id`: The identifier of the asset to clear.
7231
+ *
7232
+ * Emits `MetadataCleared`.
7233
+ *
7234
+ * Weight: `O(1)`
5037
7235
  *
5038
7236
  * @param {StagingXcmV3MultilocationMultiLocation} id
5039
7237
  **/
@@ -5052,7 +7250,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5052
7250
  >;
5053
7251
 
5054
7252
  /**
5055
- * See [`Pallet::force_asset_status`].
7253
+ * Alter the attributes of a given asset.
7254
+ *
7255
+ * Origin must be `ForceOrigin`.
7256
+ *
7257
+ * - `id`: The identifier of the asset.
7258
+ * - `owner`: The new Owner of this asset.
7259
+ * - `issuer`: The new Issuer of this asset.
7260
+ * - `admin`: The new Admin of this asset.
7261
+ * - `freezer`: The new Freezer of this asset.
7262
+ * - `min_balance`: The minimum balance of this new asset that any single account must
7263
+ * have. If an account's balance is reduced below this, then it collapses to zero.
7264
+ * - `is_sufficient`: Whether a non-zero balance of this asset is deposit of sufficient
7265
+ * value to account for the state bloat associated with its balance storage. If set to
7266
+ * `true`, then non-zero balances may be stored without a `consumer` reference (and thus
7267
+ * an ED in the Balances pallet or whatever else is used to control user-account state
7268
+ * growth).
7269
+ * - `is_frozen`: Whether this asset class is frozen except for permissioned/admin
7270
+ * instructions.
7271
+ *
7272
+ * Emits `AssetStatusChanged` with the identity of the asset.
7273
+ *
7274
+ * Weight: `O(1)`
5056
7275
  *
5057
7276
  * @param {StagingXcmV3MultilocationMultiLocation} id
5058
7277
  * @param {MultiAddressLike} owner
@@ -5096,7 +7315,26 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5096
7315
  >;
5097
7316
 
5098
7317
  /**
5099
- * See [`Pallet::approve_transfer`].
7318
+ * Approve an amount of asset for transfer by a delegated third-party account.
7319
+ *
7320
+ * Origin must be Signed.
7321
+ *
7322
+ * Ensures that `ApprovalDeposit` worth of `Currency` is reserved from signing account
7323
+ * for the purpose of holding the approval. If some non-zero amount of assets is already
7324
+ * approved from signing account to `delegate`, then it is topped up or unreserved to
7325
+ * meet the right value.
7326
+ *
7327
+ * NOTE: The signing account does not need to own `amount` of assets at the point of
7328
+ * making this call.
7329
+ *
7330
+ * - `id`: The identifier of the asset.
7331
+ * - `delegate`: The account to delegate permission to transfer asset.
7332
+ * - `amount`: The amount of asset that may be transferred by `delegate`. If there is
7333
+ * already an approval in place, then this acts additively.
7334
+ *
7335
+ * Emits `ApprovedTransfer` on success.
7336
+ *
7337
+ * Weight: `O(1)`
5100
7338
  *
5101
7339
  * @param {StagingXcmV3MultilocationMultiLocation} id
5102
7340
  * @param {MultiAddressLike} delegate
@@ -5121,7 +7359,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5121
7359
  >;
5122
7360
 
5123
7361
  /**
5124
- * See [`Pallet::cancel_approval`].
7362
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
7363
+ *
7364
+ * Origin must be Signed and there must be an approval in place between signer and
7365
+ * `delegate`.
7366
+ *
7367
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
7368
+ *
7369
+ * - `id`: The identifier of the asset.
7370
+ * - `delegate`: The account delegated permission to transfer asset.
7371
+ *
7372
+ * Emits `ApprovalCancelled` on success.
7373
+ *
7374
+ * Weight: `O(1)`
5125
7375
  *
5126
7376
  * @param {StagingXcmV3MultilocationMultiLocation} id
5127
7377
  * @param {MultiAddressLike} delegate
@@ -5144,7 +7394,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5144
7394
  >;
5145
7395
 
5146
7396
  /**
5147
- * See [`Pallet::force_cancel_approval`].
7397
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
7398
+ *
7399
+ * Origin must be either ForceOrigin or Signed origin with the signer being the Admin
7400
+ * account of the asset `id`.
7401
+ *
7402
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
7403
+ *
7404
+ * - `id`: The identifier of the asset.
7405
+ * - `delegate`: The account delegated permission to transfer asset.
7406
+ *
7407
+ * Emits `ApprovalCancelled` on success.
7408
+ *
7409
+ * Weight: `O(1)`
5148
7410
  *
5149
7411
  * @param {StagingXcmV3MultilocationMultiLocation} id
5150
7412
  * @param {MultiAddressLike} owner
@@ -5169,7 +7431,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5169
7431
  >;
5170
7432
 
5171
7433
  /**
5172
- * See [`Pallet::transfer_approved`].
7434
+ * Transfer some asset balance from a previously delegated account to some third-party
7435
+ * account.
7436
+ *
7437
+ * Origin must be Signed and there must be an approval in place by the `owner` to the
7438
+ * signer.
7439
+ *
7440
+ * If the entire amount approved for transfer is transferred, then any deposit previously
7441
+ * reserved by `approve_transfer` is unreserved.
7442
+ *
7443
+ * - `id`: The identifier of the asset.
7444
+ * - `owner`: The account which previously approved for a transfer of at least `amount` and
7445
+ * from which the asset balance will be withdrawn.
7446
+ * - `destination`: The account to which the asset balance of `amount` will be transferred.
7447
+ * - `amount`: The amount of assets to transfer.
7448
+ *
7449
+ * Emits `TransferredApproved` on success.
7450
+ *
7451
+ * Weight: `O(1)`
5173
7452
  *
5174
7453
  * @param {StagingXcmV3MultilocationMultiLocation} id
5175
7454
  * @param {MultiAddressLike} owner
@@ -5201,7 +7480,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5201
7480
  >;
5202
7481
 
5203
7482
  /**
5204
- * See [`Pallet::touch`].
7483
+ * Create an asset account for non-provider assets.
7484
+ *
7485
+ * A deposit will be taken from the signer account.
7486
+ *
7487
+ * - `origin`: Must be Signed; the signer account must have sufficient funds for a deposit
7488
+ * to be taken.
7489
+ * - `id`: The identifier of the asset for the account to be created.
7490
+ *
7491
+ * Emits `Touched` event when successful.
5205
7492
  *
5206
7493
  * @param {StagingXcmV3MultilocationMultiLocation} id
5207
7494
  **/
@@ -5220,7 +7507,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5220
7507
  >;
5221
7508
 
5222
7509
  /**
5223
- * See [`Pallet::refund`].
7510
+ * Return the deposit (if any) of an asset account or a consumer reference (if any) of an
7511
+ * account.
7512
+ *
7513
+ * The origin must be Signed.
7514
+ *
7515
+ * - `id`: The identifier of the asset for which the caller would like the deposit
7516
+ * refunded.
7517
+ * - `allow_burn`: If `true` then assets may be destroyed in order to complete the refund.
7518
+ *
7519
+ * Emits `Refunded` event when successful.
5224
7520
  *
5225
7521
  * @param {StagingXcmV3MultilocationMultiLocation} id
5226
7522
  * @param {boolean} allowBurn
@@ -5243,7 +7539,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5243
7539
  >;
5244
7540
 
5245
7541
  /**
5246
- * See [`Pallet::set_min_balance`].
7542
+ * Sets the minimum balance of an asset.
7543
+ *
7544
+ * Only works if there aren't any accounts that are holding the asset or if
7545
+ * the new value of `min_balance` is less than the old one.
7546
+ *
7547
+ * Origin must be Signed and the sender has to be the Owner of the
7548
+ * asset `id`.
7549
+ *
7550
+ * - `id`: The identifier of the asset.
7551
+ * - `min_balance`: The new value of `min_balance`.
7552
+ *
7553
+ * Emits `AssetMinBalanceChanged` event when successful.
5247
7554
  *
5248
7555
  * @param {StagingXcmV3MultilocationMultiLocation} id
5249
7556
  * @param {bigint} minBalance
@@ -5266,7 +7573,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5266
7573
  >;
5267
7574
 
5268
7575
  /**
5269
- * See [`Pallet::touch_other`].
7576
+ * Create an asset account for `who`.
7577
+ *
7578
+ * A deposit will be taken from the signer account.
7579
+ *
7580
+ * - `origin`: Must be Signed by `Freezer` or `Admin` of the asset `id`; the signer account
7581
+ * must have sufficient funds for a deposit to be taken.
7582
+ * - `id`: The identifier of the asset for the account to be created.
7583
+ * - `who`: The account to be created.
7584
+ *
7585
+ * Emits `Touched` event when successful.
5270
7586
  *
5271
7587
  * @param {StagingXcmV3MultilocationMultiLocation} id
5272
7588
  * @param {MultiAddressLike} who
@@ -5289,7 +7605,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5289
7605
  >;
5290
7606
 
5291
7607
  /**
5292
- * See [`Pallet::refund_other`].
7608
+ * Return the deposit (if any) of a target asset account. Useful if you are the depositor.
7609
+ *
7610
+ * The origin must be Signed and either the account owner, depositor, or asset `Admin`. In
7611
+ * order to burn a non-zero balance of the asset, the caller must be the account and should
7612
+ * use `refund`.
7613
+ *
7614
+ * - `id`: The identifier of the asset for the account holding a deposit.
7615
+ * - `who`: The account to refund.
7616
+ *
7617
+ * Emits `Refunded` event when successful.
5293
7618
  *
5294
7619
  * @param {StagingXcmV3MultilocationMultiLocation} id
5295
7620
  * @param {MultiAddressLike} who
@@ -5312,7 +7637,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5312
7637
  >;
5313
7638
 
5314
7639
  /**
5315
- * See [`Pallet::block`].
7640
+ * Disallow further unprivileged transfers of an asset `id` to and from an account `who`.
7641
+ *
7642
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
7643
+ *
7644
+ * - `id`: The identifier of the account's asset.
7645
+ * - `who`: The account to be unblocked.
7646
+ *
7647
+ * Emits `Blocked`.
7648
+ *
7649
+ * Weight: `O(1)`
5316
7650
  *
5317
7651
  * @param {StagingXcmV3MultilocationMultiLocation} id
5318
7652
  * @param {MultiAddressLike} who
@@ -5344,7 +7678,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5344
7678
  **/
5345
7679
  poolAssets: {
5346
7680
  /**
5347
- * See [`Pallet::create`].
7681
+ * Issue a new class of fungible assets from a public origin.
7682
+ *
7683
+ * This new asset class has no assets initially and its owner is the origin.
7684
+ *
7685
+ * The origin must conform to the configured `CreateOrigin` and have sufficient funds free.
7686
+ *
7687
+ * Funds of sender are reserved by `AssetDeposit`.
7688
+ *
7689
+ * Parameters:
7690
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
7691
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
7692
+ * - `admin`: The admin of this class of assets. The admin is the initial address of each
7693
+ * member of the asset class's admin team.
7694
+ * - `min_balance`: The minimum balance of this new asset that any single account must
7695
+ * have. If an account's balance is reduced below this, then it collapses to zero.
7696
+ *
7697
+ * Emits `Created` event when successful.
7698
+ *
7699
+ * Weight: `O(1)`
5348
7700
  *
5349
7701
  * @param {number} id
5350
7702
  * @param {MultiAddressLike} admin
@@ -5369,7 +7721,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5369
7721
  >;
5370
7722
 
5371
7723
  /**
5372
- * See [`Pallet::force_create`].
7724
+ * Issue a new class of fungible assets from a privileged origin.
7725
+ *
7726
+ * This new asset class has no assets initially.
7727
+ *
7728
+ * The origin must conform to `ForceOrigin`.
7729
+ *
7730
+ * Unlike `create`, no funds are reserved.
7731
+ *
7732
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
7733
+ * an existing asset. If [`NextAssetId`] is set, then this must be equal to it.
7734
+ * - `owner`: The owner of this class of assets. The owner has full superuser permissions
7735
+ * over this asset, but may later change and configure the permissions using
7736
+ * `transfer_ownership` and `set_team`.
7737
+ * - `min_balance`: The minimum balance of this new asset that any single account must
7738
+ * have. If an account's balance is reduced below this, then it collapses to zero.
7739
+ *
7740
+ * Emits `ForceCreated` event when successful.
7741
+ *
7742
+ * Weight: `O(1)`
5373
7743
  *
5374
7744
  * @param {number} id
5375
7745
  * @param {MultiAddressLike} owner
@@ -5396,7 +7766,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5396
7766
  >;
5397
7767
 
5398
7768
  /**
5399
- * See [`Pallet::start_destroy`].
7769
+ * Start the process of destroying a fungible asset class.
7770
+ *
7771
+ * `start_destroy` is the first in a series of extrinsics that should be called, to allow
7772
+ * destruction of an asset class.
7773
+ *
7774
+ * The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.
7775
+ *
7776
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
7777
+ * asset.
7778
+ *
7779
+ * The asset class must be frozen before calling `start_destroy`.
5400
7780
  *
5401
7781
  * @param {number} id
5402
7782
  **/
@@ -5415,7 +7795,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5415
7795
  >;
5416
7796
 
5417
7797
  /**
5418
- * See [`Pallet::destroy_accounts`].
7798
+ * Destroy all accounts associated with a given asset.
7799
+ *
7800
+ * `destroy_accounts` should only be called after `start_destroy` has been called, and the
7801
+ * asset is in a `Destroying` state.
7802
+ *
7803
+ * Due to weight restrictions, this function may need to be called multiple times to fully
7804
+ * destroy all accounts. It will destroy `RemoveItemsLimit` accounts at a time.
7805
+ *
7806
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
7807
+ * asset.
7808
+ *
7809
+ * Each call emits the `Event::DestroyedAccounts` event.
5419
7810
  *
5420
7811
  * @param {number} id
5421
7812
  **/
@@ -5434,7 +7825,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5434
7825
  >;
5435
7826
 
5436
7827
  /**
5437
- * See [`Pallet::destroy_approvals`].
7828
+ * Destroy all approvals associated with a given asset up to the max (T::RemoveItemsLimit).
7829
+ *
7830
+ * `destroy_approvals` should only be called after `start_destroy` has been called, and the
7831
+ * asset is in a `Destroying` state.
7832
+ *
7833
+ * Due to weight restrictions, this function may need to be called multiple times to fully
7834
+ * destroy all approvals. It will destroy `RemoveItemsLimit` approvals at a time.
7835
+ *
7836
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
7837
+ * asset.
7838
+ *
7839
+ * Each call emits the `Event::DestroyedApprovals` event.
5438
7840
  *
5439
7841
  * @param {number} id
5440
7842
  **/
@@ -5453,7 +7855,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5453
7855
  >;
5454
7856
 
5455
7857
  /**
5456
- * See [`Pallet::finish_destroy`].
7858
+ * Complete destroying asset and unreserve currency.
7859
+ *
7860
+ * `finish_destroy` should only be called after `start_destroy` has been called, and the
7861
+ * asset is in a `Destroying` state. All accounts or approvals should be destroyed before
7862
+ * hand.
7863
+ *
7864
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
7865
+ * asset.
7866
+ *
7867
+ * Each successful call emits the `Event::Destroyed` event.
5457
7868
  *
5458
7869
  * @param {number} id
5459
7870
  **/
@@ -5472,7 +7883,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5472
7883
  >;
5473
7884
 
5474
7885
  /**
5475
- * See [`Pallet::mint`].
7886
+ * Mint assets of a particular class.
7887
+ *
7888
+ * The origin must be Signed and the sender must be the Issuer of the asset `id`.
7889
+ *
7890
+ * - `id`: The identifier of the asset to have some amount minted.
7891
+ * - `beneficiary`: The account to be credited with the minted assets.
7892
+ * - `amount`: The amount of the asset to be minted.
7893
+ *
7894
+ * Emits `Issued` event when successful.
7895
+ *
7896
+ * Weight: `O(1)`
7897
+ * Modes: Pre-existing balance of `beneficiary`; Account pre-existence of `beneficiary`.
5476
7898
  *
5477
7899
  * @param {number} id
5478
7900
  * @param {MultiAddressLike} beneficiary
@@ -5497,7 +7919,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5497
7919
  >;
5498
7920
 
5499
7921
  /**
5500
- * See [`Pallet::burn`].
7922
+ * Reduce the balance of `who` by as much as possible up to `amount` assets of `id`.
7923
+ *
7924
+ * Origin must be Signed and the sender should be the Manager of the asset `id`.
7925
+ *
7926
+ * Bails with `NoAccount` if the `who` is already dead.
7927
+ *
7928
+ * - `id`: The identifier of the asset to have some amount burned.
7929
+ * - `who`: The account to be debited from.
7930
+ * - `amount`: The maximum amount by which `who`'s balance should be reduced.
7931
+ *
7932
+ * Emits `Burned` with the actual amount burned. If this takes the balance to below the
7933
+ * minimum for the asset, then the amount burned is increased to take it to zero.
7934
+ *
7935
+ * Weight: `O(1)`
7936
+ * Modes: Post-existence of `who`; Pre & post Zombie-status of `who`.
5501
7937
  *
5502
7938
  * @param {number} id
5503
7939
  * @param {MultiAddressLike} who
@@ -5522,7 +7958,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5522
7958
  >;
5523
7959
 
5524
7960
  /**
5525
- * See [`Pallet::transfer`].
7961
+ * Move some assets from the sender account to another.
7962
+ *
7963
+ * Origin must be Signed.
7964
+ *
7965
+ * - `id`: The identifier of the asset to have some amount transferred.
7966
+ * - `target`: The account to be credited.
7967
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
7968
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
7969
+ * the case that the transfer would otherwise take the sender balance above zero but below
7970
+ * the minimum balance. Must be greater than zero.
7971
+ *
7972
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
7973
+ * to below the minimum for the asset, then the amount transferred is increased to take it
7974
+ * to zero.
7975
+ *
7976
+ * Weight: `O(1)`
7977
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
7978
+ * `target`.
5526
7979
  *
5527
7980
  * @param {number} id
5528
7981
  * @param {MultiAddressLike} target
@@ -5547,7 +8000,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5547
8000
  >;
5548
8001
 
5549
8002
  /**
5550
- * See [`Pallet::transfer_keep_alive`].
8003
+ * Move some assets from the sender account to another, keeping the sender account alive.
8004
+ *
8005
+ * Origin must be Signed.
8006
+ *
8007
+ * - `id`: The identifier of the asset to have some amount transferred.
8008
+ * - `target`: The account to be credited.
8009
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
8010
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
8011
+ * the case that the transfer would otherwise take the sender balance above zero but below
8012
+ * the minimum balance. Must be greater than zero.
8013
+ *
8014
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
8015
+ * to below the minimum for the asset, then the amount transferred is increased to take it
8016
+ * to zero.
8017
+ *
8018
+ * Weight: `O(1)`
8019
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
8020
+ * `target`.
5551
8021
  *
5552
8022
  * @param {number} id
5553
8023
  * @param {MultiAddressLike} target
@@ -5572,7 +8042,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5572
8042
  >;
5573
8043
 
5574
8044
  /**
5575
- * See [`Pallet::force_transfer`].
8045
+ * Move some assets from one account to another.
8046
+ *
8047
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
8048
+ *
8049
+ * - `id`: The identifier of the asset to have some amount transferred.
8050
+ * - `source`: The account to be debited.
8051
+ * - `dest`: The account to be credited.
8052
+ * - `amount`: The amount by which the `source`'s balance of assets should be reduced and
8053
+ * `dest`'s balance increased. The amount actually transferred may be slightly greater in
8054
+ * the case that the transfer would otherwise take the `source` balance above zero but
8055
+ * below the minimum balance. Must be greater than zero.
8056
+ *
8057
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
8058
+ * to below the minimum for the asset, then the amount transferred is increased to take it
8059
+ * to zero.
8060
+ *
8061
+ * Weight: `O(1)`
8062
+ * Modes: Pre-existence of `dest`; Post-existence of `source`; Account pre-existence of
8063
+ * `dest`.
5576
8064
  *
5577
8065
  * @param {number} id
5578
8066
  * @param {MultiAddressLike} source
@@ -5599,7 +8087,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5599
8087
  >;
5600
8088
 
5601
8089
  /**
5602
- * See [`Pallet::freeze`].
8090
+ * Disallow further unprivileged transfers of an asset `id` from an account `who`. `who`
8091
+ * must already exist as an entry in `Account`s of the asset. If you want to freeze an
8092
+ * account that does not have an entry, use `touch_other` first.
8093
+ *
8094
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
8095
+ *
8096
+ * - `id`: The identifier of the asset to be frozen.
8097
+ * - `who`: The account to be frozen.
8098
+ *
8099
+ * Emits `Frozen`.
8100
+ *
8101
+ * Weight: `O(1)`
5603
8102
  *
5604
8103
  * @param {number} id
5605
8104
  * @param {MultiAddressLike} who
@@ -5622,7 +8121,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5622
8121
  >;
5623
8122
 
5624
8123
  /**
5625
- * See [`Pallet::thaw`].
8124
+ * Allow unprivileged transfers to and from an account again.
8125
+ *
8126
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
8127
+ *
8128
+ * - `id`: The identifier of the asset to be frozen.
8129
+ * - `who`: The account to be unfrozen.
8130
+ *
8131
+ * Emits `Thawed`.
8132
+ *
8133
+ * Weight: `O(1)`
5626
8134
  *
5627
8135
  * @param {number} id
5628
8136
  * @param {MultiAddressLike} who
@@ -5645,7 +8153,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5645
8153
  >;
5646
8154
 
5647
8155
  /**
5648
- * See [`Pallet::freeze_asset`].
8156
+ * Disallow further unprivileged transfers for the asset class.
8157
+ *
8158
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
8159
+ *
8160
+ * - `id`: The identifier of the asset to be frozen.
8161
+ *
8162
+ * Emits `Frozen`.
8163
+ *
8164
+ * Weight: `O(1)`
5649
8165
  *
5650
8166
  * @param {number} id
5651
8167
  **/
@@ -5664,7 +8180,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5664
8180
  >;
5665
8181
 
5666
8182
  /**
5667
- * See [`Pallet::thaw_asset`].
8183
+ * Allow unprivileged transfers for the asset again.
8184
+ *
8185
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
8186
+ *
8187
+ * - `id`: The identifier of the asset to be thawed.
8188
+ *
8189
+ * Emits `Thawed`.
8190
+ *
8191
+ * Weight: `O(1)`
5668
8192
  *
5669
8193
  * @param {number} id
5670
8194
  **/
@@ -5683,7 +8207,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5683
8207
  >;
5684
8208
 
5685
8209
  /**
5686
- * See [`Pallet::transfer_ownership`].
8210
+ * Change the Owner of an asset.
8211
+ *
8212
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
8213
+ *
8214
+ * - `id`: The identifier of the asset.
8215
+ * - `owner`: The new Owner of this asset.
8216
+ *
8217
+ * Emits `OwnerChanged`.
8218
+ *
8219
+ * Weight: `O(1)`
5687
8220
  *
5688
8221
  * @param {number} id
5689
8222
  * @param {MultiAddressLike} owner
@@ -5706,7 +8239,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5706
8239
  >;
5707
8240
 
5708
8241
  /**
5709
- * See [`Pallet::set_team`].
8242
+ * Change the Issuer, Admin and Freezer of an asset.
8243
+ *
8244
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
8245
+ *
8246
+ * - `id`: The identifier of the asset to be frozen.
8247
+ * - `issuer`: The new Issuer of this asset.
8248
+ * - `admin`: The new Admin of this asset.
8249
+ * - `freezer`: The new Freezer of this asset.
8250
+ *
8251
+ * Emits `TeamChanged`.
8252
+ *
8253
+ * Weight: `O(1)`
5710
8254
  *
5711
8255
  * @param {number} id
5712
8256
  * @param {MultiAddressLike} issuer
@@ -5733,7 +8277,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5733
8277
  >;
5734
8278
 
5735
8279
  /**
5736
- * See [`Pallet::set_metadata`].
8280
+ * Set the metadata for an asset.
8281
+ *
8282
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
8283
+ *
8284
+ * Funds of sender are reserved according to the formula:
8285
+ * `MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len)` taking into
8286
+ * account any already reserved funds.
8287
+ *
8288
+ * - `id`: The identifier of the asset to update.
8289
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
8290
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
8291
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
8292
+ *
8293
+ * Emits `MetadataSet`.
8294
+ *
8295
+ * Weight: `O(1)`
5737
8296
  *
5738
8297
  * @param {number} id
5739
8298
  * @param {BytesLike} name
@@ -5760,7 +8319,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5760
8319
  >;
5761
8320
 
5762
8321
  /**
5763
- * See [`Pallet::clear_metadata`].
8322
+ * Clear the metadata for an asset.
8323
+ *
8324
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
8325
+ *
8326
+ * Any deposit is freed for the asset owner.
8327
+ *
8328
+ * - `id`: The identifier of the asset to clear.
8329
+ *
8330
+ * Emits `MetadataCleared`.
8331
+ *
8332
+ * Weight: `O(1)`
5764
8333
  *
5765
8334
  * @param {number} id
5766
8335
  **/
@@ -5779,7 +8348,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5779
8348
  >;
5780
8349
 
5781
8350
  /**
5782
- * See [`Pallet::force_set_metadata`].
8351
+ * Force the metadata for an asset to some value.
8352
+ *
8353
+ * Origin must be ForceOrigin.
8354
+ *
8355
+ * Any deposit is left alone.
8356
+ *
8357
+ * - `id`: The identifier of the asset to update.
8358
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
8359
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
8360
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
8361
+ *
8362
+ * Emits `MetadataSet`.
8363
+ *
8364
+ * Weight: `O(N + S)` where N and S are the length of the name and symbol respectively.
5783
8365
  *
5784
8366
  * @param {number} id
5785
8367
  * @param {BytesLike} name
@@ -5808,7 +8390,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5808
8390
  >;
5809
8391
 
5810
8392
  /**
5811
- * See [`Pallet::force_clear_metadata`].
8393
+ * Clear the metadata for an asset.
8394
+ *
8395
+ * Origin must be ForceOrigin.
8396
+ *
8397
+ * Any deposit is returned.
8398
+ *
8399
+ * - `id`: The identifier of the asset to clear.
8400
+ *
8401
+ * Emits `MetadataCleared`.
8402
+ *
8403
+ * Weight: `O(1)`
5812
8404
  *
5813
8405
  * @param {number} id
5814
8406
  **/
@@ -5827,7 +8419,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5827
8419
  >;
5828
8420
 
5829
8421
  /**
5830
- * See [`Pallet::force_asset_status`].
8422
+ * Alter the attributes of a given asset.
8423
+ *
8424
+ * Origin must be `ForceOrigin`.
8425
+ *
8426
+ * - `id`: The identifier of the asset.
8427
+ * - `owner`: The new Owner of this asset.
8428
+ * - `issuer`: The new Issuer of this asset.
8429
+ * - `admin`: The new Admin of this asset.
8430
+ * - `freezer`: The new Freezer of this asset.
8431
+ * - `min_balance`: The minimum balance of this new asset that any single account must
8432
+ * have. If an account's balance is reduced below this, then it collapses to zero.
8433
+ * - `is_sufficient`: Whether a non-zero balance of this asset is deposit of sufficient
8434
+ * value to account for the state bloat associated with its balance storage. If set to
8435
+ * `true`, then non-zero balances may be stored without a `consumer` reference (and thus
8436
+ * an ED in the Balances pallet or whatever else is used to control user-account state
8437
+ * growth).
8438
+ * - `is_frozen`: Whether this asset class is frozen except for permissioned/admin
8439
+ * instructions.
8440
+ *
8441
+ * Emits `AssetStatusChanged` with the identity of the asset.
8442
+ *
8443
+ * Weight: `O(1)`
5831
8444
  *
5832
8445
  * @param {number} id
5833
8446
  * @param {MultiAddressLike} owner
@@ -5871,7 +8484,26 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5871
8484
  >;
5872
8485
 
5873
8486
  /**
5874
- * See [`Pallet::approve_transfer`].
8487
+ * Approve an amount of asset for transfer by a delegated third-party account.
8488
+ *
8489
+ * Origin must be Signed.
8490
+ *
8491
+ * Ensures that `ApprovalDeposit` worth of `Currency` is reserved from signing account
8492
+ * for the purpose of holding the approval. If some non-zero amount of assets is already
8493
+ * approved from signing account to `delegate`, then it is topped up or unreserved to
8494
+ * meet the right value.
8495
+ *
8496
+ * NOTE: The signing account does not need to own `amount` of assets at the point of
8497
+ * making this call.
8498
+ *
8499
+ * - `id`: The identifier of the asset.
8500
+ * - `delegate`: The account to delegate permission to transfer asset.
8501
+ * - `amount`: The amount of asset that may be transferred by `delegate`. If there is
8502
+ * already an approval in place, then this acts additively.
8503
+ *
8504
+ * Emits `ApprovedTransfer` on success.
8505
+ *
8506
+ * Weight: `O(1)`
5875
8507
  *
5876
8508
  * @param {number} id
5877
8509
  * @param {MultiAddressLike} delegate
@@ -5896,7 +8528,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5896
8528
  >;
5897
8529
 
5898
8530
  /**
5899
- * See [`Pallet::cancel_approval`].
8531
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
8532
+ *
8533
+ * Origin must be Signed and there must be an approval in place between signer and
8534
+ * `delegate`.
8535
+ *
8536
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
8537
+ *
8538
+ * - `id`: The identifier of the asset.
8539
+ * - `delegate`: The account delegated permission to transfer asset.
8540
+ *
8541
+ * Emits `ApprovalCancelled` on success.
8542
+ *
8543
+ * Weight: `O(1)`
5900
8544
  *
5901
8545
  * @param {number} id
5902
8546
  * @param {MultiAddressLike} delegate
@@ -5919,7 +8563,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5919
8563
  >;
5920
8564
 
5921
8565
  /**
5922
- * See [`Pallet::force_cancel_approval`].
8566
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
8567
+ *
8568
+ * Origin must be either ForceOrigin or Signed origin with the signer being the Admin
8569
+ * account of the asset `id`.
8570
+ *
8571
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
8572
+ *
8573
+ * - `id`: The identifier of the asset.
8574
+ * - `delegate`: The account delegated permission to transfer asset.
8575
+ *
8576
+ * Emits `ApprovalCancelled` on success.
8577
+ *
8578
+ * Weight: `O(1)`
5923
8579
  *
5924
8580
  * @param {number} id
5925
8581
  * @param {MultiAddressLike} owner
@@ -5944,7 +8600,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5944
8600
  >;
5945
8601
 
5946
8602
  /**
5947
- * See [`Pallet::transfer_approved`].
8603
+ * Transfer some asset balance from a previously delegated account to some third-party
8604
+ * account.
8605
+ *
8606
+ * Origin must be Signed and there must be an approval in place by the `owner` to the
8607
+ * signer.
8608
+ *
8609
+ * If the entire amount approved for transfer is transferred, then any deposit previously
8610
+ * reserved by `approve_transfer` is unreserved.
8611
+ *
8612
+ * - `id`: The identifier of the asset.
8613
+ * - `owner`: The account which previously approved for a transfer of at least `amount` and
8614
+ * from which the asset balance will be withdrawn.
8615
+ * - `destination`: The account to which the asset balance of `amount` will be transferred.
8616
+ * - `amount`: The amount of assets to transfer.
8617
+ *
8618
+ * Emits `TransferredApproved` on success.
8619
+ *
8620
+ * Weight: `O(1)`
5948
8621
  *
5949
8622
  * @param {number} id
5950
8623
  * @param {MultiAddressLike} owner
@@ -5971,7 +8644,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5971
8644
  >;
5972
8645
 
5973
8646
  /**
5974
- * See [`Pallet::touch`].
8647
+ * Create an asset account for non-provider assets.
8648
+ *
8649
+ * A deposit will be taken from the signer account.
8650
+ *
8651
+ * - `origin`: Must be Signed; the signer account must have sufficient funds for a deposit
8652
+ * to be taken.
8653
+ * - `id`: The identifier of the asset for the account to be created.
8654
+ *
8655
+ * Emits `Touched` event when successful.
5975
8656
  *
5976
8657
  * @param {number} id
5977
8658
  **/
@@ -5990,7 +8671,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5990
8671
  >;
5991
8672
 
5992
8673
  /**
5993
- * See [`Pallet::refund`].
8674
+ * Return the deposit (if any) of an asset account or a consumer reference (if any) of an
8675
+ * account.
8676
+ *
8677
+ * The origin must be Signed.
8678
+ *
8679
+ * - `id`: The identifier of the asset for which the caller would like the deposit
8680
+ * refunded.
8681
+ * - `allow_burn`: If `true` then assets may be destroyed in order to complete the refund.
8682
+ *
8683
+ * Emits `Refunded` event when successful.
5994
8684
  *
5995
8685
  * @param {number} id
5996
8686
  * @param {boolean} allowBurn
@@ -6013,7 +8703,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6013
8703
  >;
6014
8704
 
6015
8705
  /**
6016
- * See [`Pallet::set_min_balance`].
8706
+ * Sets the minimum balance of an asset.
8707
+ *
8708
+ * Only works if there aren't any accounts that are holding the asset or if
8709
+ * the new value of `min_balance` is less than the old one.
8710
+ *
8711
+ * Origin must be Signed and the sender has to be the Owner of the
8712
+ * asset `id`.
8713
+ *
8714
+ * - `id`: The identifier of the asset.
8715
+ * - `min_balance`: The new value of `min_balance`.
8716
+ *
8717
+ * Emits `AssetMinBalanceChanged` event when successful.
6017
8718
  *
6018
8719
  * @param {number} id
6019
8720
  * @param {bigint} minBalance
@@ -6036,7 +8737,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6036
8737
  >;
6037
8738
 
6038
8739
  /**
6039
- * See [`Pallet::touch_other`].
8740
+ * Create an asset account for `who`.
8741
+ *
8742
+ * A deposit will be taken from the signer account.
8743
+ *
8744
+ * - `origin`: Must be Signed by `Freezer` or `Admin` of the asset `id`; the signer account
8745
+ * must have sufficient funds for a deposit to be taken.
8746
+ * - `id`: The identifier of the asset for the account to be created.
8747
+ * - `who`: The account to be created.
8748
+ *
8749
+ * Emits `Touched` event when successful.
6040
8750
  *
6041
8751
  * @param {number} id
6042
8752
  * @param {MultiAddressLike} who
@@ -6059,7 +8769,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6059
8769
  >;
6060
8770
 
6061
8771
  /**
6062
- * See [`Pallet::refund_other`].
8772
+ * Return the deposit (if any) of a target asset account. Useful if you are the depositor.
8773
+ *
8774
+ * The origin must be Signed and either the account owner, depositor, or asset `Admin`. In
8775
+ * order to burn a non-zero balance of the asset, the caller must be the account and should
8776
+ * use `refund`.
8777
+ *
8778
+ * - `id`: The identifier of the asset for the account holding a deposit.
8779
+ * - `who`: The account to refund.
8780
+ *
8781
+ * Emits `Refunded` event when successful.
6063
8782
  *
6064
8783
  * @param {number} id
6065
8784
  * @param {MultiAddressLike} who
@@ -6082,7 +8801,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6082
8801
  >;
6083
8802
 
6084
8803
  /**
6085
- * See [`Pallet::block`].
8804
+ * Disallow further unprivileged transfers of an asset `id` to and from an account `who`.
8805
+ *
8806
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
8807
+ *
8808
+ * - `id`: The identifier of the account's asset.
8809
+ * - `who`: The account to be unblocked.
8810
+ *
8811
+ * Emits `Blocked`.
8812
+ *
8813
+ * Weight: `O(1)`
6086
8814
  *
6087
8815
  * @param {number} id
6088
8816
  * @param {MultiAddressLike} who
@@ -6114,7 +8842,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6114
8842
  **/
6115
8843
  assetConversion: {
6116
8844
  /**
6117
- * See [`Pallet::create_pool`].
8845
+ * Creates an empty liquidity pool and an associated new `lp_token` asset
8846
+ * (the id of which is returned in the `Event::PoolCreated` event).
8847
+ *
8848
+ * Once a pool is created, someone may [`Pallet::add_liquidity`] to it.
6118
8849
  *
6119
8850
  * @param {StagingXcmV3MultilocationMultiLocation} asset1
6120
8851
  * @param {StagingXcmV3MultilocationMultiLocation} asset2
@@ -6137,7 +8868,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6137
8868
  >;
6138
8869
 
6139
8870
  /**
6140
- * See [`Pallet::add_liquidity`].
8871
+ * Provide liquidity into the pool of `asset1` and `asset2`.
8872
+ * NOTE: an optimal amount of asset1 and asset2 will be calculated and
8873
+ * might be different than the provided `amount1_desired`/`amount2_desired`
8874
+ * thus you should provide the min amount you're happy to provide.
8875
+ * Params `amount1_min`/`amount2_min` represent that.
8876
+ * `mint_to` will be sent the liquidity tokens that represent this share of the pool.
8877
+ *
8878
+ * NOTE: when encountering an incorrect exchange rate and non-withdrawable pool liquidity,
8879
+ * batch an atomic call with [`Pallet::add_liquidity`] and
8880
+ * [`Pallet::swap_exact_tokens_for_tokens`] or [`Pallet::swap_tokens_for_exact_tokens`]
8881
+ * calls to render the liquidity withdrawable and rectify the exchange rate.
8882
+ *
8883
+ * Once liquidity is added, someone may successfully call
8884
+ * [`Pallet::swap_exact_tokens_for_tokens`] successfully.
6141
8885
  *
6142
8886
  * @param {StagingXcmV3MultilocationMultiLocation} asset1
6143
8887
  * @param {StagingXcmV3MultilocationMultiLocation} asset2
@@ -6178,7 +8922,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6178
8922
  >;
6179
8923
 
6180
8924
  /**
6181
- * See [`Pallet::remove_liquidity`].
8925
+ * Allows you to remove liquidity by providing the `lp_token_burn` tokens that will be
8926
+ * burned in the process. With the usage of `amount1_min_receive`/`amount2_min_receive`
8927
+ * it's possible to control the min amount of returned tokens you're happy with.
6182
8928
  *
6183
8929
  * @param {StagingXcmV3MultilocationMultiLocation} asset1
6184
8930
  * @param {StagingXcmV3MultilocationMultiLocation} asset2
@@ -6216,7 +8962,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6216
8962
  >;
6217
8963
 
6218
8964
  /**
6219
- * See [`Pallet::swap_exact_tokens_for_tokens`].
8965
+ * Swap the exact amount of `asset1` into `asset2`.
8966
+ * `amount_out_min` param allows you to specify the min amount of the `asset2`
8967
+ * you're happy to receive.
8968
+ *
8969
+ * [`AssetConversionApi::quote_price_exact_tokens_for_tokens`] runtime call can be called
8970
+ * for a quote.
6220
8971
  *
6221
8972
  * @param {Array<StagingXcmV3MultilocationMultiLocation>} path
6222
8973
  * @param {bigint} amountIn
@@ -6251,7 +9002,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6251
9002
  >;
6252
9003
 
6253
9004
  /**
6254
- * See [`Pallet::swap_tokens_for_exact_tokens`].
9005
+ * Swap any amount of `asset1` to get the exact amount of `asset2`.
9006
+ * `amount_in_max` param allows to specify the max amount of the `asset1`
9007
+ * you're happy to provide.
9008
+ *
9009
+ * [`AssetConversionApi::quote_price_tokens_for_exact_tokens`] runtime call can be called
9010
+ * for a quote.
6255
9011
  *
6256
9012
  * @param {Array<StagingXcmV3MultilocationMultiLocation>} path
6257
9013
  * @param {bigint} amountOut
@@ -6285,6 +9041,39 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6285
9041
  >
6286
9042
  >;
6287
9043
 
9044
+ /**
9045
+ * Touch an existing pool to fulfill prerequisites before providing liquidity, such as
9046
+ * ensuring that the pool's accounts are in place. It is typically useful when a pool
9047
+ * creator removes the pool's accounts and does not provide a liquidity. This action may
9048
+ * involve holding assets from the caller as a deposit for creating the pool's accounts.
9049
+ *
9050
+ * The origin must be Signed.
9051
+ *
9052
+ * - `asset1`: The asset ID of an existing pool with a pair (asset1, asset2).
9053
+ * - `asset2`: The asset ID of an existing pool with a pair (asset1, asset2).
9054
+ *
9055
+ * Emits `Touched` event when successful.
9056
+ *
9057
+ * @param {StagingXcmV3MultilocationMultiLocation} asset1
9058
+ * @param {StagingXcmV3MultilocationMultiLocation} asset2
9059
+ **/
9060
+ touch: GenericTxCall<
9061
+ Rv,
9062
+ (
9063
+ asset1: StagingXcmV3MultilocationMultiLocation,
9064
+ asset2: StagingXcmV3MultilocationMultiLocation,
9065
+ ) => ChainSubmittableExtrinsic<
9066
+ Rv,
9067
+ {
9068
+ pallet: 'AssetConversion';
9069
+ palletCall: {
9070
+ name: 'Touch';
9071
+ params: { asset1: StagingXcmV3MultilocationMultiLocation; asset2: StagingXcmV3MultilocationMultiLocation };
9072
+ };
9073
+ }
9074
+ >
9075
+ >;
9076
+
6288
9077
  /**
6289
9078
  * Generic pallet tx call
6290
9079
  **/