@dedot/chaintypes 0.12.0 → 0.14.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.
package/moonbeam/tx.d.ts CHANGED
@@ -47,6 +47,8 @@ import type {
47
47
  XcmVersionedAssets,
48
48
  StagingXcmV4Location,
49
49
  XcmV3WeightLimit,
50
+ StagingXcmExecutorAssetTransferTransferType,
51
+ XcmVersionedAssetId,
50
52
  MoonbeamRuntimeXcmConfigAssetType,
51
53
  MoonbeamRuntimeAssetConfigAssetRegistrarMetadata,
52
54
  MoonbeamRuntimeXcmConfigCurrencyId,
@@ -76,7 +78,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
76
78
  **/
77
79
  system: {
78
80
  /**
79
- * See [`Pallet::remark`].
81
+ * Make some on-chain remark.
82
+ *
83
+ * Can be executed by every `origin`.
80
84
  *
81
85
  * @param {BytesLike} remark
82
86
  **/
@@ -95,7 +99,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
95
99
  >;
96
100
 
97
101
  /**
98
- * See [`Pallet::set_heap_pages`].
102
+ * Set the number of pages in the WebAssembly environment's heap.
99
103
  *
100
104
  * @param {bigint} pages
101
105
  **/
@@ -114,7 +118,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
114
118
  >;
115
119
 
116
120
  /**
117
- * See [`Pallet::set_code`].
121
+ * Set the new runtime code.
118
122
  *
119
123
  * @param {BytesLike} code
120
124
  **/
@@ -133,7 +137,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
133
137
  >;
134
138
 
135
139
  /**
136
- * See [`Pallet::set_code_without_checks`].
140
+ * Set the new runtime code without doing any checks of the given `code`.
141
+ *
142
+ * Note that runtime upgrades will not run if this is called with a not-increasing spec
143
+ * version!
137
144
  *
138
145
  * @param {BytesLike} code
139
146
  **/
@@ -152,7 +159,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
152
159
  >;
153
160
 
154
161
  /**
155
- * See [`Pallet::set_storage`].
162
+ * Set some items of storage.
156
163
  *
157
164
  * @param {Array<[BytesLike, BytesLike]>} items
158
165
  **/
@@ -171,7 +178,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
171
178
  >;
172
179
 
173
180
  /**
174
- * See [`Pallet::kill_storage`].
181
+ * Kill some items from storage.
175
182
  *
176
183
  * @param {Array<BytesLike>} keys
177
184
  **/
@@ -190,7 +197,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
190
197
  >;
191
198
 
192
199
  /**
193
- * See [`Pallet::kill_prefix`].
200
+ * Kill all storage items with a key that starts with the given prefix.
201
+ *
202
+ * **NOTE:** We rely on the Root origin to provide us the number of subkeys under
203
+ * the prefix we are removing to accurately calculate the weight of this function.
194
204
  *
195
205
  * @param {BytesLike} prefix
196
206
  * @param {number} subkeys
@@ -213,7 +223,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
213
223
  >;
214
224
 
215
225
  /**
216
- * See [`Pallet::remark_with_event`].
226
+ * Make some on-chain remark and emit event.
217
227
  *
218
228
  * @param {BytesLike} remark
219
229
  **/
@@ -232,7 +242,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
232
242
  >;
233
243
 
234
244
  /**
235
- * See [`Pallet::authorize_upgrade`].
245
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
246
+ * later.
247
+ *
248
+ * This call requires Root origin.
236
249
  *
237
250
  * @param {H256} codeHash
238
251
  **/
@@ -251,7 +264,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
251
264
  >;
252
265
 
253
266
  /**
254
- * See [`Pallet::authorize_upgrade_without_checks`].
267
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
268
+ * later.
269
+ *
270
+ * WARNING: This authorizes an upgrade that will take place without any safety checks, for
271
+ * example that the spec name remains the same and that the version number increases. Not
272
+ * recommended for normal use. Use `authorize_upgrade` instead.
273
+ *
274
+ * This call requires Root origin.
255
275
  *
256
276
  * @param {H256} codeHash
257
277
  **/
@@ -270,7 +290,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
270
290
  >;
271
291
 
272
292
  /**
273
- * See [`Pallet::apply_authorized_upgrade`].
293
+ * Provide the preimage (runtime binary) `code` for an upgrade that has been authorized.
294
+ *
295
+ * If the authorization required a version check, this call will ensure the spec name
296
+ * remains unchanged and that the spec version has increased.
297
+ *
298
+ * Depending on the runtime's `OnSetCode` configuration, this function may directly apply
299
+ * the new `code` in the same block or attempt to schedule the upgrade.
300
+ *
301
+ * All origins are allowed.
274
302
  *
275
303
  * @param {BytesLike} code
276
304
  **/
@@ -298,7 +326,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
298
326
  **/
299
327
  parachainSystem: {
300
328
  /**
301
- * See [`Pallet::set_validation_data`].
329
+ * Set the current validation data.
330
+ *
331
+ * This should be invoked exactly once per block. It will panic at the finalization
332
+ * phase if the call was not invoked.
333
+ *
334
+ * The dispatch origin for this call must be `Inherent`
335
+ *
336
+ * As a side effect, this function upgrades the current validation function
337
+ * if the appropriate time has come.
302
338
  *
303
339
  * @param {CumulusPrimitivesParachainInherentParachainInherentData} data
304
340
  **/
@@ -317,7 +353,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
317
353
  >;
318
354
 
319
355
  /**
320
- * See [`Pallet::sudo_send_upward_message`].
321
356
  *
322
357
  * @param {BytesLike} message
323
358
  **/
@@ -336,7 +371,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
336
371
  >;
337
372
 
338
373
  /**
339
- * See [`Pallet::authorize_upgrade`].
374
+ * Authorize an upgrade to a given `code_hash` for the runtime. The runtime can be supplied
375
+ * later.
376
+ *
377
+ * The `check_version` parameter sets a boolean flag for whether or not the runtime's spec
378
+ * version and name should be verified on upgrade. Since the authorization only has a hash,
379
+ * it cannot actually perform the verification.
380
+ *
381
+ * This call requires Root origin.
340
382
  *
341
383
  * @param {H256} codeHash
342
384
  * @param {boolean} checkVersion
@@ -359,7 +401,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
359
401
  >;
360
402
 
361
403
  /**
362
- * See [`Pallet::enact_authorized_upgrade`].
404
+ * Provide the preimage (runtime binary) `code` for an upgrade that has been authorized.
405
+ *
406
+ * If the authorization required a version check, this call will ensure the spec name
407
+ * remains unchanged and that the spec version has increased.
408
+ *
409
+ * Note that this function will not apply the new `code`, but only attempt to schedule the
410
+ * upgrade with the Relay Chain.
411
+ *
412
+ * All origins are allowed.
363
413
  *
364
414
  * @param {BytesLike} code
365
415
  **/
@@ -387,7 +437,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
387
437
  **/
388
438
  timestamp: {
389
439
  /**
390
- * See [`Pallet::set`].
440
+ * Set the current time.
441
+ *
442
+ * This call should be invoked exactly once per block. It will panic at the finalization
443
+ * phase, if this call hasn't been invoked by that time.
444
+ *
445
+ * The timestamp should be greater than the previous one by the amount specified by
446
+ * [`Config::MinimumPeriod`].
447
+ *
448
+ * The dispatch origin for this call must be _None_.
449
+ *
450
+ * This dispatch class is _Mandatory_ to ensure it gets executed in the block. Be aware
451
+ * that changing the complexity of this call could result exhausting the resources in a
452
+ * block to execute any other calls.
453
+ *
454
+ * ## Complexity
455
+ * - `O(1)` (Note that implementations of `OnTimestampSet` must also be `O(1)`)
456
+ * - 1 storage read and 1 storage mutation (codec `O(1)` because of `DidUpdate::take` in
457
+ * `on_finalize`)
458
+ * - 1 event handler `on_timestamp_set`. Must be `O(1)`.
391
459
  *
392
460
  * @param {bigint} now
393
461
  **/
@@ -415,7 +483,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
415
483
  **/
416
484
  rootTesting: {
417
485
  /**
418
- * See `Pallet::fill_block`.
486
+ * A dispatch that will fill the block weight up to the given ratio.
419
487
  *
420
488
  * @param {Perbill} ratio
421
489
  **/
@@ -434,7 +502,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
434
502
  >;
435
503
 
436
504
  /**
437
- * See `Pallet::trigger_defensive`.
438
505
  *
439
506
  **/
440
507
  triggerDefensive: GenericTxCall<
@@ -460,7 +527,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
460
527
  **/
461
528
  balances: {
462
529
  /**
463
- * See [`Pallet::transfer_allow_death`].
530
+ * Transfer some liquid free balance to another account.
531
+ *
532
+ * `transfer_allow_death` will set the `FreeBalance` of the sender and receiver.
533
+ * If the sender's account is below the existential deposit as a result
534
+ * of the transfer, the account will be reaped.
535
+ *
536
+ * The dispatch origin for this call must be `Signed` by the transactor.
464
537
  *
465
538
  * @param {AccountId20Like} dest
466
539
  * @param {bigint} value
@@ -483,7 +556,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
483
556
  >;
484
557
 
485
558
  /**
486
- * See [`Pallet::force_transfer`].
559
+ * Exactly as `transfer_allow_death`, except the origin must be root and the source account
560
+ * may be specified.
487
561
  *
488
562
  * @param {AccountId20Like} source
489
563
  * @param {AccountId20Like} dest
@@ -508,7 +582,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
508
582
  >;
509
583
 
510
584
  /**
511
- * See [`Pallet::transfer_keep_alive`].
585
+ * Same as the [`transfer_allow_death`] call, but with a check that the transfer will not
586
+ * kill the origin account.
587
+ *
588
+ * 99% of the time you want [`transfer_allow_death`] instead.
589
+ *
590
+ * [`transfer_allow_death`]: struct.Pallet.html#method.transfer
512
591
  *
513
592
  * @param {AccountId20Like} dest
514
593
  * @param {bigint} value
@@ -531,7 +610,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
531
610
  >;
532
611
 
533
612
  /**
534
- * See [`Pallet::transfer_all`].
613
+ * Transfer the entire transferable balance from the caller account.
614
+ *
615
+ * NOTE: This function only attempts to transfer _transferable_ balances. This means that
616
+ * any locked, reserved, or existential deposits (when `keep_alive` is `true`), will not be
617
+ * transferred by this function. To ensure that this function results in a killed account,
618
+ * you might need to prepare the account by removing any reference counters, storage
619
+ * deposits, etc...
620
+ *
621
+ * The dispatch origin of this call must be Signed.
622
+ *
623
+ * - `dest`: The recipient of the transfer.
624
+ * - `keep_alive`: A boolean to determine if the `transfer_all` operation should send all
625
+ * of the funds the account has, causing the sender account to be killed (false), or
626
+ * transfer everything except at least the existential deposit, which will guarantee to
627
+ * keep the sender account alive (true).
535
628
  *
536
629
  * @param {AccountId20Like} dest
537
630
  * @param {boolean} keepAlive
@@ -554,7 +647,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
554
647
  >;
555
648
 
556
649
  /**
557
- * See [`Pallet::force_unreserve`].
650
+ * Unreserve some balance from a user by force.
651
+ *
652
+ * Can only be called by ROOT.
558
653
  *
559
654
  * @param {AccountId20Like} who
560
655
  * @param {bigint} amount
@@ -577,7 +672,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
577
672
  >;
578
673
 
579
674
  /**
580
- * See [`Pallet::upgrade_accounts`].
675
+ * Upgrade a specified account.
676
+ *
677
+ * - `origin`: Must be `Signed`.
678
+ * - `who`: The account to be upgraded.
679
+ *
680
+ * This will waive the transaction fee if at least all but 10% of the accounts needed to
681
+ * be upgraded. (We let some not have to be upgraded just in order to allow for the
682
+ * possibility of churn).
581
683
  *
582
684
  * @param {Array<AccountId20Like>} who
583
685
  **/
@@ -596,7 +698,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
596
698
  >;
597
699
 
598
700
  /**
599
- * See [`Pallet::force_set_balance`].
701
+ * Set the regular balance of a given account.
702
+ *
703
+ * The dispatch origin for this call is `root`.
600
704
  *
601
705
  * @param {AccountId20Like} who
602
706
  * @param {bigint} newFree
@@ -619,7 +723,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
619
723
  >;
620
724
 
621
725
  /**
622
- * See [`Pallet::force_adjust_total_issuance`].
726
+ * Adjust the total issuance in a saturating way.
727
+ *
728
+ * Can only be called by root and always needs a positive `delta`.
729
+ *
730
+ * # Example
623
731
  *
624
732
  * @param {PalletBalancesAdjustmentDirection} direction
625
733
  * @param {bigint} delta
@@ -651,7 +759,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
651
759
  **/
652
760
  parachainStaking: {
653
761
  /**
654
- * See [`Pallet::set_staking_expectations`].
762
+ * Set the expectations for total staked. These expectations determine the issuance for
763
+ * the round according to logic in `fn compute_issuance`
655
764
  *
656
765
  * @param {{min: bigint, ideal: bigint, max: bigint}} expectations
657
766
  **/
@@ -670,7 +779,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
670
779
  >;
671
780
 
672
781
  /**
673
- * See [`Pallet::set_inflation`].
782
+ * Set the annual inflation rate to derive per-round inflation
674
783
  *
675
784
  * @param {{min: Perbill, ideal: Perbill, max: Perbill}} schedule
676
785
  **/
@@ -689,7 +798,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
689
798
  >;
690
799
 
691
800
  /**
692
- * See [`Pallet::set_parachain_bond_account`].
801
+ * Set the account that will hold funds set aside for parachain bond
693
802
  *
694
803
  * @param {AccountId20Like} new_
695
804
  **/
@@ -708,7 +817,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
708
817
  >;
709
818
 
710
819
  /**
711
- * See [`Pallet::set_parachain_bond_reserve_percent`].
820
+ * Set the percent of inflation set aside for parachain bond
712
821
  *
713
822
  * @param {Percent} new_
714
823
  **/
@@ -727,7 +836,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
727
836
  >;
728
837
 
729
838
  /**
730
- * See [`Pallet::set_total_selected`].
839
+ * Set the total number of collator candidates selected per round
840
+ * - changes are not applied until the start of the next round
731
841
  *
732
842
  * @param {number} new_
733
843
  **/
@@ -746,7 +856,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
746
856
  >;
747
857
 
748
858
  /**
749
- * See [`Pallet::set_collator_commission`].
859
+ * Set the commission for all collators
750
860
  *
751
861
  * @param {Perbill} new_
752
862
  **/
@@ -765,7 +875,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
765
875
  >;
766
876
 
767
877
  /**
768
- * See [`Pallet::set_blocks_per_round`].
878
+ * Set blocks per round
879
+ * - if called with `new` less than length of current round, will transition immediately
880
+ * in the next block
881
+ * - also updates per-round inflation config
769
882
  *
770
883
  * @param {number} new_
771
884
  **/
@@ -784,7 +897,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
784
897
  >;
785
898
 
786
899
  /**
787
- * See [`Pallet::join_candidates`].
900
+ * Join the set of collator candidates
788
901
  *
789
902
  * @param {bigint} bond
790
903
  * @param {number} candidateCount
@@ -807,7 +920,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
807
920
  >;
808
921
 
809
922
  /**
810
- * See [`Pallet::schedule_leave_candidates`].
923
+ * Request to leave the set of candidates. If successful, the account is immediately
924
+ * removed from the candidate pool to prevent selection as a collator.
811
925
  *
812
926
  * @param {number} candidateCount
813
927
  **/
@@ -826,7 +940,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
826
940
  >;
827
941
 
828
942
  /**
829
- * See [`Pallet::execute_leave_candidates`].
943
+ * Execute leave candidates request
830
944
  *
831
945
  * @param {AccountId20Like} candidate
832
946
  * @param {number} candidateDelegationCount
@@ -849,7 +963,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
849
963
  >;
850
964
 
851
965
  /**
852
- * See [`Pallet::cancel_leave_candidates`].
966
+ * Cancel open request to leave candidates
967
+ * - only callable by collator account
968
+ * - result upon successful call is the candidate is active in the candidate pool
853
969
  *
854
970
  * @param {number} candidateCount
855
971
  **/
@@ -868,7 +984,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
868
984
  >;
869
985
 
870
986
  /**
871
- * See [`Pallet::go_offline`].
987
+ * Temporarily leave the set of collator candidates without unbonding
872
988
  *
873
989
  **/
874
990
  goOffline: GenericTxCall<
@@ -885,7 +1001,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
885
1001
  >;
886
1002
 
887
1003
  /**
888
- * See [`Pallet::go_online`].
1004
+ * Rejoin the set of collator candidates if previously had called `go_offline`
889
1005
  *
890
1006
  **/
891
1007
  goOnline: GenericTxCall<
@@ -902,7 +1018,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
902
1018
  >;
903
1019
 
904
1020
  /**
905
- * See [`Pallet::candidate_bond_more`].
1021
+ * Increase collator candidate self bond by `more`
906
1022
  *
907
1023
  * @param {bigint} more
908
1024
  **/
@@ -921,7 +1037,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
921
1037
  >;
922
1038
 
923
1039
  /**
924
- * See [`Pallet::schedule_candidate_bond_less`].
1040
+ * Request by collator candidate to decrease self bond by `less`
925
1041
  *
926
1042
  * @param {bigint} less
927
1043
  **/
@@ -940,7 +1056,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
940
1056
  >;
941
1057
 
942
1058
  /**
943
- * See [`Pallet::execute_candidate_bond_less`].
1059
+ * Execute pending request to adjust the collator candidate self bond
944
1060
  *
945
1061
  * @param {AccountId20Like} candidate
946
1062
  **/
@@ -959,7 +1075,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
959
1075
  >;
960
1076
 
961
1077
  /**
962
- * See [`Pallet::cancel_candidate_bond_less`].
1078
+ * Cancel pending request to adjust the collator candidate self bond
963
1079
  *
964
1080
  **/
965
1081
  cancelCandidateBondLess: GenericTxCall<
@@ -976,7 +1092,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
976
1092
  >;
977
1093
 
978
1094
  /**
979
- * See [`Pallet::delegate`].
1095
+ * DEPRECATED use delegateWithAutoCompound
1096
+ * If caller is not a delegator and not a collator, then join the set of delegators
1097
+ * If caller is a delegator, then makes delegation to change their delegation state
980
1098
  *
981
1099
  * @param {AccountId20Like} candidate
982
1100
  * @param {bigint} amount
@@ -1008,7 +1126,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1008
1126
  >;
1009
1127
 
1010
1128
  /**
1011
- * See [`Pallet::delegate_with_auto_compound`].
1129
+ * If caller is not a delegator and not a collator, then join the set of delegators
1130
+ * If caller is a delegator, then makes delegation to change their delegation state
1131
+ * Sets the auto-compound config for the delegation
1012
1132
  *
1013
1133
  * @param {AccountId20Like} candidate
1014
1134
  * @param {bigint} amount
@@ -1046,7 +1166,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1046
1166
  >;
1047
1167
 
1048
1168
  /**
1049
- * See [`Pallet::removed_call_19`].
1169
+ * REMOVED, was schedule_leave_delegators
1050
1170
  *
1051
1171
  **/
1052
1172
  removedCall19: GenericTxCall<
@@ -1063,7 +1183,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1063
1183
  >;
1064
1184
 
1065
1185
  /**
1066
- * See [`Pallet::removed_call_20`].
1186
+ * REMOVED, was execute_leave_delegators
1067
1187
  *
1068
1188
  **/
1069
1189
  removedCall20: GenericTxCall<
@@ -1080,7 +1200,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1080
1200
  >;
1081
1201
 
1082
1202
  /**
1083
- * See [`Pallet::removed_call_21`].
1203
+ * REMOVED, was cancel_leave_delegators
1084
1204
  *
1085
1205
  **/
1086
1206
  removedCall21: GenericTxCall<
@@ -1097,7 +1217,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1097
1217
  >;
1098
1218
 
1099
1219
  /**
1100
- * See [`Pallet::schedule_revoke_delegation`].
1220
+ * Request to revoke an existing delegation. If successful, the delegation is scheduled
1221
+ * to be allowed to be revoked via the `execute_delegation_request` extrinsic.
1222
+ * The delegation receives no rewards for the rounds while a revoke is pending.
1223
+ * A revoke may not be performed if any other scheduled request is pending.
1101
1224
  *
1102
1225
  * @param {AccountId20Like} collator
1103
1226
  **/
@@ -1116,7 +1239,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1116
1239
  >;
1117
1240
 
1118
1241
  /**
1119
- * See [`Pallet::delegator_bond_more`].
1242
+ * Bond more for delegators wrt a specific collator candidate.
1120
1243
  *
1121
1244
  * @param {AccountId20Like} candidate
1122
1245
  * @param {bigint} more
@@ -1139,7 +1262,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1139
1262
  >;
1140
1263
 
1141
1264
  /**
1142
- * See [`Pallet::schedule_delegator_bond_less`].
1265
+ * Request bond less for delegators wrt a specific collator candidate. The delegation's
1266
+ * rewards for rounds while the request is pending use the reduced bonded amount.
1267
+ * A bond less may not be performed if any other scheduled request is pending.
1143
1268
  *
1144
1269
  * @param {AccountId20Like} candidate
1145
1270
  * @param {bigint} less
@@ -1162,7 +1287,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1162
1287
  >;
1163
1288
 
1164
1289
  /**
1165
- * See [`Pallet::execute_delegation_request`].
1290
+ * Execute pending request to change an existing delegation
1166
1291
  *
1167
1292
  * @param {AccountId20Like} delegator
1168
1293
  * @param {AccountId20Like} candidate
@@ -1185,7 +1310,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1185
1310
  >;
1186
1311
 
1187
1312
  /**
1188
- * See [`Pallet::cancel_delegation_request`].
1313
+ * Cancel request to change an existing delegation.
1189
1314
  *
1190
1315
  * @param {AccountId20Like} candidate
1191
1316
  **/
@@ -1204,7 +1329,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1204
1329
  >;
1205
1330
 
1206
1331
  /**
1207
- * See [`Pallet::set_auto_compound`].
1332
+ * Sets the auto-compounding reward percentage for a delegation.
1208
1333
  *
1209
1334
  * @param {AccountId20Like} candidate
1210
1335
  * @param {Percent} value
@@ -1236,7 +1361,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1236
1361
  >;
1237
1362
 
1238
1363
  /**
1239
- * See [`Pallet::hotfix_remove_delegation_requests_exited_candidates`].
1364
+ * Hotfix to remove existing empty entries for candidates that have left.
1240
1365
  *
1241
1366
  * @param {Array<AccountId20Like>} candidates
1242
1367
  **/
@@ -1255,7 +1380,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1255
1380
  >;
1256
1381
 
1257
1382
  /**
1258
- * See [`Pallet::notify_inactive_collator`].
1383
+ * Notify a collator is inactive during MaxOfflineRounds
1259
1384
  *
1260
1385
  * @param {AccountId20Like} collator
1261
1386
  **/
@@ -1274,7 +1399,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1274
1399
  >;
1275
1400
 
1276
1401
  /**
1277
- * See [`Pallet::enable_marking_offline`].
1402
+ * Enable/Disable marking offline feature
1278
1403
  *
1279
1404
  * @param {boolean} value
1280
1405
  **/
@@ -1293,7 +1418,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1293
1418
  >;
1294
1419
 
1295
1420
  /**
1296
- * See [`Pallet::force_join_candidates`].
1421
+ * Force join the set of collator candidates.
1422
+ * It will skip the minimum required bond check.
1297
1423
  *
1298
1424
  * @param {AccountId20Like} account
1299
1425
  * @param {bigint} bond
@@ -1327,7 +1453,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1327
1453
  **/
1328
1454
  authorInherent: {
1329
1455
  /**
1330
- * See [`Pallet::kick_off_authorship_validation`].
1456
+ * This inherent is a workaround to run code after the "real" inherents have executed,
1457
+ * but before transactions are executed.
1331
1458
  *
1332
1459
  **/
1333
1460
  kickOffAuthorshipValidation: GenericTxCall<
@@ -1351,7 +1478,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1351
1478
  **/
1352
1479
  authorFilter: {
1353
1480
  /**
1354
- * See [`Pallet::set_eligible`].
1481
+ * Update the eligible count. Intended to be called by governance.
1355
1482
  *
1356
1483
  * @param {PalletAuthorSlotFilterNumNonZeroU32} new_
1357
1484
  **/
@@ -1379,7 +1506,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1379
1506
  **/
1380
1507
  authorMapping: {
1381
1508
  /**
1382
- * See [`Pallet::add_association`].
1509
+ * Register your NimbusId onchain so blocks you author are associated with your account.
1510
+ *
1511
+ * Users who have been (or will soon be) elected active collators in staking,
1512
+ * should submit this extrinsic to have their blocks accepted and earn rewards.
1383
1513
  *
1384
1514
  * @param {NimbusPrimitivesNimbusCryptoPublic} nimbusId
1385
1515
  **/
@@ -1398,7 +1528,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1398
1528
  >;
1399
1529
 
1400
1530
  /**
1401
- * See [`Pallet::update_association`].
1531
+ * Change your Mapping.
1532
+ *
1533
+ * This is useful for normal key rotation or for when switching from one physical collator
1534
+ * machine to another. No new security deposit is required.
1535
+ * This sets keys to new_nimbus_id.into() by default.
1402
1536
  *
1403
1537
  * @param {NimbusPrimitivesNimbusCryptoPublic} oldNimbusId
1404
1538
  * @param {NimbusPrimitivesNimbusCryptoPublic} newNimbusId
@@ -1424,7 +1558,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1424
1558
  >;
1425
1559
 
1426
1560
  /**
1427
- * See [`Pallet::clear_association`].
1561
+ * Clear your Mapping.
1562
+ *
1563
+ * This is useful when you are no longer an author and would like to re-claim your security
1564
+ * deposit.
1428
1565
  *
1429
1566
  * @param {NimbusPrimitivesNimbusCryptoPublic} nimbusId
1430
1567
  **/
@@ -1443,7 +1580,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1443
1580
  >;
1444
1581
 
1445
1582
  /**
1446
- * See [`Pallet::remove_keys`].
1583
+ * Remove your Mapping.
1584
+ *
1585
+ * This is useful when you are no longer an author and would like to re-claim your security
1586
+ * deposit.
1447
1587
  *
1448
1588
  **/
1449
1589
  removeKeys: GenericTxCall<
@@ -1460,7 +1600,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1460
1600
  >;
1461
1601
 
1462
1602
  /**
1463
- * See [`Pallet::set_keys`].
1603
+ * Set association and session keys at once.
1604
+ *
1605
+ * This is useful for key rotation to update Nimbus and VRF keys in one call.
1606
+ * No new security deposit is required. Will replace `update_association` which is kept
1607
+ * now for backwards compatibility reasons.
1464
1608
  *
1465
1609
  * @param {BytesLike} keys
1466
1610
  **/
@@ -1488,7 +1632,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1488
1632
  **/
1489
1633
  moonbeamOrbiters: {
1490
1634
  /**
1491
- * See [`Pallet::collator_add_orbiter`].
1635
+ * Add an orbiter in a collator pool
1492
1636
  *
1493
1637
  * @param {AccountId20Like} orbiter
1494
1638
  **/
@@ -1507,7 +1651,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1507
1651
  >;
1508
1652
 
1509
1653
  /**
1510
- * See [`Pallet::collator_remove_orbiter`].
1654
+ * Remove an orbiter from the caller collator pool
1511
1655
  *
1512
1656
  * @param {AccountId20Like} orbiter
1513
1657
  **/
@@ -1526,7 +1670,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1526
1670
  >;
1527
1671
 
1528
1672
  /**
1529
- * See [`Pallet::orbiter_leave_collator_pool`].
1673
+ * Remove the caller from the specified collator pool
1530
1674
  *
1531
1675
  * @param {AccountId20Like} collator
1532
1676
  **/
@@ -1545,7 +1689,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1545
1689
  >;
1546
1690
 
1547
1691
  /**
1548
- * See [`Pallet::orbiter_register`].
1692
+ * Registering as an orbiter
1549
1693
  *
1550
1694
  **/
1551
1695
  orbiterRegister: GenericTxCall<
@@ -1562,7 +1706,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1562
1706
  >;
1563
1707
 
1564
1708
  /**
1565
- * See [`Pallet::orbiter_unregister`].
1709
+ * Deregistering from orbiters
1566
1710
  *
1567
1711
  * @param {number} collatorsPoolCount
1568
1712
  **/
@@ -1581,7 +1725,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1581
1725
  >;
1582
1726
 
1583
1727
  /**
1584
- * See [`Pallet::add_collator`].
1728
+ * Add a collator to orbiters program.
1585
1729
  *
1586
1730
  * @param {AccountId20Like} collator
1587
1731
  **/
@@ -1600,7 +1744,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1600
1744
  >;
1601
1745
 
1602
1746
  /**
1603
- * See [`Pallet::remove_collator`].
1747
+ * Remove a collator from orbiters program.
1604
1748
  *
1605
1749
  * @param {AccountId20Like} collator
1606
1750
  **/
@@ -1628,7 +1772,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1628
1772
  **/
1629
1773
  utility: {
1630
1774
  /**
1631
- * See [`Pallet::batch`].
1775
+ * Send a batch of dispatch calls.
1776
+ *
1777
+ * May be called from any origin except `None`.
1778
+ *
1779
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
1780
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
1781
+ *
1782
+ * If origin is root then the calls are dispatched without checking origin filter. (This
1783
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
1784
+ *
1785
+ * ## Complexity
1786
+ * - O(C) where C is the number of calls to be batched.
1787
+ *
1788
+ * This will return `Ok` in all circumstances. To determine the success of the batch, an
1789
+ * event is deposited. If a call failed and the batch was interrupted, then the
1790
+ * `BatchInterrupted` event is deposited, along with the number of successful calls made
1791
+ * and the error of the failed call. If all were successful, then the `BatchCompleted`
1792
+ * event is deposited.
1632
1793
  *
1633
1794
  * @param {Array<MoonbeamRuntimeRuntimeCallLike>} calls
1634
1795
  **/
@@ -1647,7 +1808,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1647
1808
  >;
1648
1809
 
1649
1810
  /**
1650
- * See [`Pallet::as_derivative`].
1811
+ * Send a call through an indexed pseudonym of the sender.
1812
+ *
1813
+ * Filter from origin are passed along. The call will be dispatched with an origin which
1814
+ * use the same filter as the origin of this call.
1815
+ *
1816
+ * NOTE: If you need to ensure that any account-based filtering is not honored (i.e.
1817
+ * because you expect `proxy` to have been used prior in the call stack and you do not want
1818
+ * the call restrictions to apply to any sub-accounts), then use `as_multi_threshold_1`
1819
+ * in the Multisig pallet instead.
1820
+ *
1821
+ * NOTE: Prior to version *12, this was called `as_limited_sub`.
1822
+ *
1823
+ * The dispatch origin for this call must be _Signed_.
1651
1824
  *
1652
1825
  * @param {number} index
1653
1826
  * @param {MoonbeamRuntimeRuntimeCallLike} call
@@ -1670,7 +1843,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1670
1843
  >;
1671
1844
 
1672
1845
  /**
1673
- * See [`Pallet::batch_all`].
1846
+ * Send a batch of dispatch calls and atomically execute them.
1847
+ * The whole transaction will rollback and fail if any of the calls failed.
1848
+ *
1849
+ * May be called from any origin except `None`.
1850
+ *
1851
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
1852
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
1853
+ *
1854
+ * If origin is root then the calls are dispatched without checking origin filter. (This
1855
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
1856
+ *
1857
+ * ## Complexity
1858
+ * - O(C) where C is the number of calls to be batched.
1674
1859
  *
1675
1860
  * @param {Array<MoonbeamRuntimeRuntimeCallLike>} calls
1676
1861
  **/
@@ -1689,7 +1874,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1689
1874
  >;
1690
1875
 
1691
1876
  /**
1692
- * See [`Pallet::dispatch_as`].
1877
+ * Dispatches a function call with a provided origin.
1878
+ *
1879
+ * The dispatch origin for this call must be _Root_.
1880
+ *
1881
+ * ## Complexity
1882
+ * - O(1).
1693
1883
  *
1694
1884
  * @param {MoonbeamRuntimeOriginCaller} asOrigin
1695
1885
  * @param {MoonbeamRuntimeRuntimeCallLike} call
@@ -1712,7 +1902,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1712
1902
  >;
1713
1903
 
1714
1904
  /**
1715
- * See [`Pallet::force_batch`].
1905
+ * Send a batch of dispatch calls.
1906
+ * Unlike `batch`, it allows errors and won't interrupt.
1907
+ *
1908
+ * May be called from any origin except `None`.
1909
+ *
1910
+ * - `calls`: The calls to be dispatched from the same origin. The number of call must not
1911
+ * exceed the constant: `batched_calls_limit` (available in constant metadata).
1912
+ *
1913
+ * If origin is root then the calls are dispatch without checking origin filter. (This
1914
+ * includes bypassing `frame_system::Config::BaseCallFilter`).
1915
+ *
1916
+ * ## Complexity
1917
+ * - O(C) where C is the number of calls to be batched.
1716
1918
  *
1717
1919
  * @param {Array<MoonbeamRuntimeRuntimeCallLike>} calls
1718
1920
  **/
@@ -1731,7 +1933,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1731
1933
  >;
1732
1934
 
1733
1935
  /**
1734
- * See [`Pallet::with_weight`].
1936
+ * Dispatch a function call with a specified weight.
1937
+ *
1938
+ * This function does not check the weight of the call, and instead allows the
1939
+ * Root origin to specify the weight of the call.
1940
+ *
1941
+ * The dispatch origin for this call must be _Root_.
1735
1942
  *
1736
1943
  * @param {MoonbeamRuntimeRuntimeCallLike} call
1737
1944
  * @param {SpWeightsWeightV2Weight} weight
@@ -1763,7 +1970,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1763
1970
  **/
1764
1971
  proxy: {
1765
1972
  /**
1766
- * See [`Pallet::proxy`].
1973
+ * Dispatch the given `call` from an account that the sender is authorised for through
1974
+ * `add_proxy`.
1975
+ *
1976
+ * The dispatch origin for this call must be _Signed_.
1977
+ *
1978
+ * Parameters:
1979
+ * - `real`: The account that the proxy will make a call on behalf of.
1980
+ * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
1981
+ * - `call`: The call to be made by the `real` account.
1767
1982
  *
1768
1983
  * @param {AccountId20Like} real
1769
1984
  * @param {MoonbeamRuntimeProxyType | undefined} forceProxyType
@@ -1792,7 +2007,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1792
2007
  >;
1793
2008
 
1794
2009
  /**
1795
- * See [`Pallet::add_proxy`].
2010
+ * Register a proxy account for the sender that is able to make calls on its behalf.
2011
+ *
2012
+ * The dispatch origin for this call must be _Signed_.
2013
+ *
2014
+ * Parameters:
2015
+ * - `proxy`: The account that the `caller` would like to make a proxy.
2016
+ * - `proxy_type`: The permissions allowed for this proxy account.
2017
+ * - `delay`: The announcement period required of the initial proxy. Will generally be
2018
+ * zero.
1796
2019
  *
1797
2020
  * @param {AccountId20Like} delegate
1798
2021
  * @param {MoonbeamRuntimeProxyType} proxyType
@@ -1817,7 +2040,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1817
2040
  >;
1818
2041
 
1819
2042
  /**
1820
- * See [`Pallet::remove_proxy`].
2043
+ * Unregister a proxy account for the sender.
2044
+ *
2045
+ * The dispatch origin for this call must be _Signed_.
2046
+ *
2047
+ * Parameters:
2048
+ * - `proxy`: The account that the `caller` would like to remove as a proxy.
2049
+ * - `proxy_type`: The permissions currently enabled for the removed proxy account.
1821
2050
  *
1822
2051
  * @param {AccountId20Like} delegate
1823
2052
  * @param {MoonbeamRuntimeProxyType} proxyType
@@ -1842,7 +2071,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1842
2071
  >;
1843
2072
 
1844
2073
  /**
1845
- * See [`Pallet::remove_proxies`].
2074
+ * Unregister all proxy accounts for the sender.
2075
+ *
2076
+ * The dispatch origin for this call must be _Signed_.
2077
+ *
2078
+ * WARNING: This may be called on accounts created by `pure`, however if done, then
2079
+ * the unreserved fees will be inaccessible. **All access to this account will be lost.**
1846
2080
  *
1847
2081
  **/
1848
2082
  removeProxies: GenericTxCall<
@@ -1859,7 +2093,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1859
2093
  >;
1860
2094
 
1861
2095
  /**
1862
- * See [`Pallet::create_pure`].
2096
+ * Spawn a fresh new account that is guaranteed to be otherwise inaccessible, and
2097
+ * initialize it with a proxy of `proxy_type` for `origin` sender.
2098
+ *
2099
+ * Requires a `Signed` origin.
2100
+ *
2101
+ * - `proxy_type`: The type of the proxy that the sender will be registered as over the
2102
+ * new account. This will almost always be the most permissive `ProxyType` possible to
2103
+ * allow for maximum flexibility.
2104
+ * - `index`: A disambiguation index, in case this is called multiple times in the same
2105
+ * transaction (e.g. with `utility::batch`). Unless you're using `batch` you probably just
2106
+ * want to use `0`.
2107
+ * - `delay`: The announcement period required of the initial proxy. Will generally be
2108
+ * zero.
2109
+ *
2110
+ * Fails with `Duplicate` if this has already been called in this transaction, from the
2111
+ * same sender, with the same parameters.
2112
+ *
2113
+ * Fails if there are insufficient funds to pay for deposit.
1863
2114
  *
1864
2115
  * @param {MoonbeamRuntimeProxyType} proxyType
1865
2116
  * @param {number} delay
@@ -1884,7 +2135,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1884
2135
  >;
1885
2136
 
1886
2137
  /**
1887
- * See [`Pallet::kill_pure`].
2138
+ * Removes a previously spawned pure proxy.
2139
+ *
2140
+ * WARNING: **All access to this account will be lost.** Any funds held in it will be
2141
+ * inaccessible.
2142
+ *
2143
+ * Requires a `Signed` origin, and the sender account must have been created by a call to
2144
+ * `pure` with corresponding parameters.
2145
+ *
2146
+ * - `spawner`: The account that originally called `pure` to create this account.
2147
+ * - `index`: The disambiguation index originally passed to `pure`. Probably `0`.
2148
+ * - `proxy_type`: The proxy type originally passed to `pure`.
2149
+ * - `height`: The height of the chain when the call to `pure` was processed.
2150
+ * - `ext_index`: The extrinsic index in which the call to `pure` was processed.
2151
+ *
2152
+ * Fails with `NoPermission` in case the caller is not a previously created pure
2153
+ * account whose `pure` call has corresponding parameters.
1888
2154
  *
1889
2155
  * @param {AccountId20Like} spawner
1890
2156
  * @param {MoonbeamRuntimeProxyType} proxyType
@@ -1919,7 +2185,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1919
2185
  >;
1920
2186
 
1921
2187
  /**
1922
- * See [`Pallet::announce`].
2188
+ * Publish the hash of a proxy-call that will be made in the future.
2189
+ *
2190
+ * This must be called some number of blocks before the corresponding `proxy` is attempted
2191
+ * if the delay associated with the proxy relationship is greater than zero.
2192
+ *
2193
+ * No more than `MaxPending` announcements may be made at any one time.
2194
+ *
2195
+ * This will take a deposit of `AnnouncementDepositFactor` as well as
2196
+ * `AnnouncementDepositBase` if there are no other pending announcements.
2197
+ *
2198
+ * The dispatch origin for this call must be _Signed_ and a proxy of `real`.
2199
+ *
2200
+ * Parameters:
2201
+ * - `real`: The account that the proxy will make a call on behalf of.
2202
+ * - `call_hash`: The hash of the call to be made by the `real` account.
1923
2203
  *
1924
2204
  * @param {AccountId20Like} real
1925
2205
  * @param {H256} callHash
@@ -1942,7 +2222,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1942
2222
  >;
1943
2223
 
1944
2224
  /**
1945
- * See [`Pallet::remove_announcement`].
2225
+ * Remove a given announcement.
2226
+ *
2227
+ * May be called by a proxy account to remove a call they previously announced and return
2228
+ * the deposit.
2229
+ *
2230
+ * The dispatch origin for this call must be _Signed_.
2231
+ *
2232
+ * Parameters:
2233
+ * - `real`: The account that the proxy will make a call on behalf of.
2234
+ * - `call_hash`: The hash of the call to be made by the `real` account.
1946
2235
  *
1947
2236
  * @param {AccountId20Like} real
1948
2237
  * @param {H256} callHash
@@ -1965,7 +2254,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1965
2254
  >;
1966
2255
 
1967
2256
  /**
1968
- * See [`Pallet::reject_announcement`].
2257
+ * Remove the given announcement of a delegate.
2258
+ *
2259
+ * May be called by a target (proxied) account to remove a call that one of their delegates
2260
+ * (`delegate`) has announced they want to execute. The deposit is returned.
2261
+ *
2262
+ * The dispatch origin for this call must be _Signed_.
2263
+ *
2264
+ * Parameters:
2265
+ * - `delegate`: The account that previously announced the call.
2266
+ * - `call_hash`: The hash of the call to be made.
1969
2267
  *
1970
2268
  * @param {AccountId20Like} delegate
1971
2269
  * @param {H256} callHash
@@ -1988,7 +2286,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1988
2286
  >;
1989
2287
 
1990
2288
  /**
1991
- * See [`Pallet::proxy_announced`].
2289
+ * Dispatch the given `call` from an account that the sender is authorized for through
2290
+ * `add_proxy`.
2291
+ *
2292
+ * Removes any corresponding announcement(s).
2293
+ *
2294
+ * The dispatch origin for this call must be _Signed_.
2295
+ *
2296
+ * Parameters:
2297
+ * - `real`: The account that the proxy will make a call on behalf of.
2298
+ * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
2299
+ * - `call`: The call to be made by the `real` account.
1992
2300
  *
1993
2301
  * @param {AccountId20Like} delegate
1994
2302
  * @param {AccountId20Like} real
@@ -2029,7 +2337,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2029
2337
  **/
2030
2338
  maintenanceMode: {
2031
2339
  /**
2032
- * See [`Pallet::enter_maintenance_mode`].
2340
+ * Place the chain in maintenance mode
2341
+ *
2342
+ * Weight cost is:
2343
+ * * One DB read to ensure we're not already in maintenance mode
2344
+ * * Three DB writes - 1 for the mode, 1 for suspending xcm execution, 1 for the event
2033
2345
  *
2034
2346
  **/
2035
2347
  enterMaintenanceMode: GenericTxCall<
@@ -2044,7 +2356,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2044
2356
  >;
2045
2357
 
2046
2358
  /**
2047
- * See [`Pallet::resume_normal_operation`].
2359
+ * Return the chain to normal operating mode
2360
+ *
2361
+ * Weight cost is:
2362
+ * * One DB read to ensure we're in maintenance mode
2363
+ * * Three DB writes - 1 for the mode, 1 for resuming xcm execution, 1 for the event
2048
2364
  *
2049
2365
  **/
2050
2366
  resumeNormalOperation: GenericTxCall<
@@ -2068,7 +2384,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2068
2384
  **/
2069
2385
  identity: {
2070
2386
  /**
2071
- * See [`Pallet::add_registrar`].
2387
+ * Add a registrar to the system.
2388
+ *
2389
+ * The dispatch origin for this call must be `T::RegistrarOrigin`.
2390
+ *
2391
+ * - `account`: the account of the registrar.
2392
+ *
2393
+ * Emits `RegistrarAdded` if successful.
2072
2394
  *
2073
2395
  * @param {AccountId20Like} account
2074
2396
  **/
@@ -2087,7 +2409,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2087
2409
  >;
2088
2410
 
2089
2411
  /**
2090
- * See [`Pallet::set_identity`].
2412
+ * Set an account's identity information and reserve the appropriate deposit.
2413
+ *
2414
+ * If the account already has identity information, the deposit is taken as part payment
2415
+ * for the new deposit.
2416
+ *
2417
+ * The dispatch origin for this call must be _Signed_.
2418
+ *
2419
+ * - `info`: The identity information.
2420
+ *
2421
+ * Emits `IdentitySet` if successful.
2091
2422
  *
2092
2423
  * @param {PalletIdentityLegacyIdentityInfo} info
2093
2424
  **/
@@ -2106,7 +2437,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2106
2437
  >;
2107
2438
 
2108
2439
  /**
2109
- * See [`Pallet::set_subs`].
2440
+ * Set the sub-accounts of the sender.
2441
+ *
2442
+ * Payment: Any aggregate balance reserved by previous `set_subs` calls will be returned
2443
+ * and an amount `SubAccountDeposit` will be reserved for each item in `subs`.
2444
+ *
2445
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2446
+ * identity.
2447
+ *
2448
+ * - `subs`: The identity's (new) sub-accounts.
2110
2449
  *
2111
2450
  * @param {Array<[AccountId20Like, Data]>} subs
2112
2451
  **/
@@ -2125,7 +2464,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2125
2464
  >;
2126
2465
 
2127
2466
  /**
2128
- * See [`Pallet::clear_identity`].
2467
+ * Clear an account's identity info and all sub-accounts and return all deposits.
2468
+ *
2469
+ * Payment: All reserved balances on the account are returned.
2470
+ *
2471
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2472
+ * identity.
2473
+ *
2474
+ * Emits `IdentityCleared` if successful.
2129
2475
  *
2130
2476
  **/
2131
2477
  clearIdentity: GenericTxCall<
@@ -2142,7 +2488,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2142
2488
  >;
2143
2489
 
2144
2490
  /**
2145
- * See [`Pallet::request_judgement`].
2491
+ * Request a judgement from a registrar.
2492
+ *
2493
+ * Payment: At most `max_fee` will be reserved for payment to the registrar if judgement
2494
+ * given.
2495
+ *
2496
+ * The dispatch origin for this call must be _Signed_ and the sender must have a
2497
+ * registered identity.
2498
+ *
2499
+ * - `reg_index`: The index of the registrar whose judgement is requested.
2500
+ * - `max_fee`: The maximum fee that may be paid. This should just be auto-populated as:
2501
+ *
2502
+ * ```nocompile
2503
+ * Self::registrars().get(reg_index).unwrap().fee
2504
+ * ```
2505
+ *
2506
+ * Emits `JudgementRequested` if successful.
2146
2507
  *
2147
2508
  * @param {number} regIndex
2148
2509
  * @param {bigint} maxFee
@@ -2165,7 +2526,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2165
2526
  >;
2166
2527
 
2167
2528
  /**
2168
- * See [`Pallet::cancel_request`].
2529
+ * Cancel a previous request.
2530
+ *
2531
+ * Payment: A previously reserved deposit is returned on success.
2532
+ *
2533
+ * The dispatch origin for this call must be _Signed_ and the sender must have a
2534
+ * registered identity.
2535
+ *
2536
+ * - `reg_index`: The index of the registrar whose judgement is no longer requested.
2537
+ *
2538
+ * Emits `JudgementUnrequested` if successful.
2169
2539
  *
2170
2540
  * @param {number} regIndex
2171
2541
  **/
@@ -2184,7 +2554,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2184
2554
  >;
2185
2555
 
2186
2556
  /**
2187
- * See [`Pallet::set_fee`].
2557
+ * Set the fee required for a judgement to be requested from a registrar.
2558
+ *
2559
+ * The dispatch origin for this call must be _Signed_ and the sender must be the account
2560
+ * of the registrar whose index is `index`.
2561
+ *
2562
+ * - `index`: the index of the registrar whose fee is to be set.
2563
+ * - `fee`: the new fee.
2188
2564
  *
2189
2565
  * @param {number} index
2190
2566
  * @param {bigint} fee
@@ -2207,7 +2583,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2207
2583
  >;
2208
2584
 
2209
2585
  /**
2210
- * See [`Pallet::set_account_id`].
2586
+ * Change the account associated with a registrar.
2587
+ *
2588
+ * The dispatch origin for this call must be _Signed_ and the sender must be the account
2589
+ * of the registrar whose index is `index`.
2590
+ *
2591
+ * - `index`: the index of the registrar whose fee is to be set.
2592
+ * - `new`: the new account ID.
2211
2593
  *
2212
2594
  * @param {number} index
2213
2595
  * @param {AccountId20Like} new_
@@ -2230,7 +2612,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2230
2612
  >;
2231
2613
 
2232
2614
  /**
2233
- * See [`Pallet::set_fields`].
2615
+ * Set the field information for a registrar.
2616
+ *
2617
+ * The dispatch origin for this call must be _Signed_ and the sender must be the account
2618
+ * of the registrar whose index is `index`.
2619
+ *
2620
+ * - `index`: the index of the registrar whose fee is to be set.
2621
+ * - `fields`: the fields that the registrar concerns themselves with.
2234
2622
  *
2235
2623
  * @param {number} index
2236
2624
  * @param {bigint} fields
@@ -2253,7 +2641,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2253
2641
  >;
2254
2642
 
2255
2643
  /**
2256
- * See [`Pallet::provide_judgement`].
2644
+ * Provide a judgement for an account's identity.
2645
+ *
2646
+ * The dispatch origin for this call must be _Signed_ and the sender must be the account
2647
+ * of the registrar whose index is `reg_index`.
2648
+ *
2649
+ * - `reg_index`: the index of the registrar whose judgement is being made.
2650
+ * - `target`: the account whose identity the judgement is upon. This must be an account
2651
+ * with a registered identity.
2652
+ * - `judgement`: the judgement of the registrar of index `reg_index` about `target`.
2653
+ * - `identity`: The hash of the [`IdentityInformationProvider`] for that the judgement is
2654
+ * provided.
2655
+ *
2656
+ * Note: Judgements do not apply to a username.
2657
+ *
2658
+ * Emits `JudgementGiven` if successful.
2257
2659
  *
2258
2660
  * @param {number} regIndex
2259
2661
  * @param {AccountId20Like} target
@@ -2280,7 +2682,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2280
2682
  >;
2281
2683
 
2282
2684
  /**
2283
- * See [`Pallet::kill_identity`].
2685
+ * Remove an account's identity and sub-account information and slash the deposits.
2686
+ *
2687
+ * Payment: Reserved balances from `set_subs` and `set_identity` are slashed and handled by
2688
+ * `Slash`. Verification request deposits are not returned; they should be cancelled
2689
+ * manually using `cancel_request`.
2690
+ *
2691
+ * The dispatch origin for this call must match `T::ForceOrigin`.
2692
+ *
2693
+ * - `target`: the account whose identity the judgement is upon. This must be an account
2694
+ * with a registered identity.
2695
+ *
2696
+ * Emits `IdentityKilled` if successful.
2284
2697
  *
2285
2698
  * @param {AccountId20Like} target
2286
2699
  **/
@@ -2299,7 +2712,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2299
2712
  >;
2300
2713
 
2301
2714
  /**
2302
- * See [`Pallet::add_sub`].
2715
+ * Add the given account to the sender's subs.
2716
+ *
2717
+ * Payment: Balance reserved by a previous `set_subs` call for one sub will be repatriated
2718
+ * to the sender.
2719
+ *
2720
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2721
+ * sub identity of `sub`.
2303
2722
  *
2304
2723
  * @param {AccountId20Like} sub
2305
2724
  * @param {Data} data
@@ -2322,7 +2741,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2322
2741
  >;
2323
2742
 
2324
2743
  /**
2325
- * See [`Pallet::rename_sub`].
2744
+ * Alter the associated name of the given sub-account.
2745
+ *
2746
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2747
+ * sub identity of `sub`.
2326
2748
  *
2327
2749
  * @param {AccountId20Like} sub
2328
2750
  * @param {Data} data
@@ -2345,7 +2767,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2345
2767
  >;
2346
2768
 
2347
2769
  /**
2348
- * See [`Pallet::remove_sub`].
2770
+ * Remove the given account from the sender's subs.
2771
+ *
2772
+ * Payment: Balance reserved by a previous `set_subs` call for one sub will be repatriated
2773
+ * to the sender.
2774
+ *
2775
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2776
+ * sub identity of `sub`.
2349
2777
  *
2350
2778
  * @param {AccountId20Like} sub
2351
2779
  **/
@@ -2364,7 +2792,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2364
2792
  >;
2365
2793
 
2366
2794
  /**
2367
- * See [`Pallet::quit_sub`].
2795
+ * Remove the sender as a sub-account.
2796
+ *
2797
+ * Payment: Balance reserved by a previous `set_subs` call for one sub will be repatriated
2798
+ * to the sender (*not* the original depositor).
2799
+ *
2800
+ * The dispatch origin for this call must be _Signed_ and the sender must have a registered
2801
+ * super-identity.
2802
+ *
2803
+ * NOTE: This should not normally be used, but is provided in the case that the non-
2804
+ * controller of an account is maliciously registered as a sub-account.
2368
2805
  *
2369
2806
  **/
2370
2807
  quitSub: GenericTxCall<
@@ -2381,7 +2818,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2381
2818
  >;
2382
2819
 
2383
2820
  /**
2384
- * See [`Pallet::add_username_authority`].
2821
+ * Add an `AccountId` with permission to grant usernames with a given `suffix` appended.
2822
+ *
2823
+ * The authority can grant up to `allocation` usernames. To top up their allocation, they
2824
+ * should just issue (or request via governance) a new `add_username_authority` call.
2385
2825
  *
2386
2826
  * @param {AccountId20Like} authority
2387
2827
  * @param {BytesLike} suffix
@@ -2406,7 +2846,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2406
2846
  >;
2407
2847
 
2408
2848
  /**
2409
- * See [`Pallet::remove_username_authority`].
2849
+ * Remove `authority` from the username authorities.
2410
2850
  *
2411
2851
  * @param {AccountId20Like} authority
2412
2852
  **/
@@ -2425,7 +2865,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2425
2865
  >;
2426
2866
 
2427
2867
  /**
2428
- * See [`Pallet::set_username_for`].
2868
+ * Set the username for `who`. Must be called by a username authority.
2869
+ *
2870
+ * The authority must have an `allocation`. Users can either pre-sign their usernames or
2871
+ * accept them later.
2872
+ *
2873
+ * Usernames must:
2874
+ * - Only contain lowercase ASCII characters or digits.
2875
+ * - When combined with the suffix of the issuing authority be _less than_ the
2876
+ * `MaxUsernameLength`.
2429
2877
  *
2430
2878
  * @param {AccountId20Like} who
2431
2879
  * @param {BytesLike} username
@@ -2450,7 +2898,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2450
2898
  >;
2451
2899
 
2452
2900
  /**
2453
- * See [`Pallet::accept_username`].
2901
+ * Accept a given username that an `authority` granted. The call must include the full
2902
+ * username, as in `username.suffix`.
2454
2903
  *
2455
2904
  * @param {BytesLike} username
2456
2905
  **/
@@ -2469,7 +2918,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2469
2918
  >;
2470
2919
 
2471
2920
  /**
2472
- * See [`Pallet::remove_expired_approval`].
2921
+ * Remove an expired username approval. The username was approved by an authority but never
2922
+ * accepted by the user and must now be beyond its expiration. The call must include the
2923
+ * full username, as in `username.suffix`.
2473
2924
  *
2474
2925
  * @param {BytesLike} username
2475
2926
  **/
@@ -2488,7 +2939,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2488
2939
  >;
2489
2940
 
2490
2941
  /**
2491
- * See [`Pallet::set_primary_username`].
2942
+ * Set a given username as the primary. The username should include the suffix.
2492
2943
  *
2493
2944
  * @param {BytesLike} username
2494
2945
  **/
@@ -2507,7 +2958,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2507
2958
  >;
2508
2959
 
2509
2960
  /**
2510
- * See [`Pallet::remove_dangling_username`].
2961
+ * Remove a username that corresponds to an account with no identity. Exists when a user
2962
+ * gets a username but then calls `clear_identity`.
2511
2963
  *
2512
2964
  * @param {BytesLike} username
2513
2965
  **/
@@ -2535,7 +2987,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2535
2987
  **/
2536
2988
  multisig: {
2537
2989
  /**
2538
- * See [`Pallet::as_multi_threshold_1`].
2990
+ * Immediately dispatch a multi-signature call using a single approval from the caller.
2991
+ *
2992
+ * The dispatch origin for this call must be _Signed_.
2993
+ *
2994
+ * - `other_signatories`: The accounts (other than the sender) who are part of the
2995
+ * multi-signature, but do not participate in the approval process.
2996
+ * - `call`: The call to be executed.
2997
+ *
2998
+ * Result is equivalent to the dispatched result.
2999
+ *
3000
+ * ## Complexity
3001
+ * O(Z + C) where Z is the length of the call and C its execution weight.
2539
3002
  *
2540
3003
  * @param {Array<AccountId20Like>} otherSignatories
2541
3004
  * @param {MoonbeamRuntimeRuntimeCallLike} call
@@ -2558,7 +3021,45 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2558
3021
  >;
2559
3022
 
2560
3023
  /**
2561
- * See [`Pallet::as_multi`].
3024
+ * Register approval for a dispatch to be made from a deterministic composite account if
3025
+ * approved by a total of `threshold - 1` of `other_signatories`.
3026
+ *
3027
+ * If there are enough, then dispatch the call.
3028
+ *
3029
+ * Payment: `DepositBase` will be reserved if this is the first approval, plus
3030
+ * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
3031
+ * is cancelled.
3032
+ *
3033
+ * The dispatch origin for this call must be _Signed_.
3034
+ *
3035
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
3036
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
3037
+ * dispatch. May not be empty.
3038
+ * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
3039
+ * not the first approval, then it must be `Some`, with the timepoint (block number and
3040
+ * transaction index) of the first approval transaction.
3041
+ * - `call`: The call to be executed.
3042
+ *
3043
+ * NOTE: Unless this is the final approval, you will generally want to use
3044
+ * `approve_as_multi` instead, since it only requires a hash of the call.
3045
+ *
3046
+ * Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise
3047
+ * on success, result is `Ok` and the result from the interior call, if it was executed,
3048
+ * may be found in the deposited `MultisigExecuted` event.
3049
+ *
3050
+ * ## Complexity
3051
+ * - `O(S + Z + Call)`.
3052
+ * - Up to one balance-reserve or unreserve operation.
3053
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
3054
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
3055
+ * - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len.
3056
+ * - One encode & hash, both of complexity `O(S)`.
3057
+ * - Up to one binary search and insert (`O(logS + S)`).
3058
+ * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
3059
+ * - One event.
3060
+ * - The weight of the `call`.
3061
+ * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
3062
+ * taken for its lifetime of `DepositBase + threshold * DepositFactor`.
2562
3063
  *
2563
3064
  * @param {number} threshold
2564
3065
  * @param {Array<AccountId20Like>} otherSignatories
@@ -2593,7 +3094,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2593
3094
  >;
2594
3095
 
2595
3096
  /**
2596
- * See [`Pallet::approve_as_multi`].
3097
+ * Register approval for a dispatch to be made from a deterministic composite account if
3098
+ * approved by a total of `threshold - 1` of `other_signatories`.
3099
+ *
3100
+ * Payment: `DepositBase` will be reserved if this is the first approval, plus
3101
+ * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
3102
+ * is cancelled.
3103
+ *
3104
+ * The dispatch origin for this call must be _Signed_.
3105
+ *
3106
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
3107
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
3108
+ * dispatch. May not be empty.
3109
+ * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
3110
+ * not the first approval, then it must be `Some`, with the timepoint (block number and
3111
+ * transaction index) of the first approval transaction.
3112
+ * - `call_hash`: The hash of the call to be executed.
3113
+ *
3114
+ * NOTE: If this is the final approval, you will want to use `as_multi` instead.
3115
+ *
3116
+ * ## Complexity
3117
+ * - `O(S)`.
3118
+ * - Up to one balance-reserve or unreserve operation.
3119
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
3120
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
3121
+ * - One encode & hash, both of complexity `O(S)`.
3122
+ * - Up to one binary search and insert (`O(logS + S)`).
3123
+ * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
3124
+ * - One event.
3125
+ * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
3126
+ * taken for its lifetime of `DepositBase + threshold * DepositFactor`.
2597
3127
  *
2598
3128
  * @param {number} threshold
2599
3129
  * @param {Array<AccountId20Like>} otherSignatories
@@ -2628,7 +3158,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2628
3158
  >;
2629
3159
 
2630
3160
  /**
2631
- * See [`Pallet::cancel_as_multi`].
3161
+ * Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously
3162
+ * for this operation will be unreserved on success.
3163
+ *
3164
+ * The dispatch origin for this call must be _Signed_.
3165
+ *
3166
+ * - `threshold`: The total number of approvals for this dispatch before it is executed.
3167
+ * - `other_signatories`: The accounts (other than the sender) who can approve this
3168
+ * dispatch. May not be empty.
3169
+ * - `timepoint`: The timepoint (block number and transaction index) of the first approval
3170
+ * transaction for this dispatch.
3171
+ * - `call_hash`: The hash of the call to be executed.
3172
+ *
3173
+ * ## Complexity
3174
+ * - `O(S)`.
3175
+ * - Up to one balance-reserve or unreserve operation.
3176
+ * - One passthrough operation, one insert, both `O(S)` where `S` is the number of
3177
+ * signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
3178
+ * - One encode & hash, both of complexity `O(S)`.
3179
+ * - One event.
3180
+ * - I/O: 1 read `O(S)`, one remove.
3181
+ * - Storage: removes one item.
2632
3182
  *
2633
3183
  * @param {number} threshold
2634
3184
  * @param {Array<AccountId20Like>} otherSignatories
@@ -2669,7 +3219,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2669
3219
  **/
2670
3220
  moonbeamLazyMigrations: {
2671
3221
  /**
2672
- * See [`Pallet::clear_suicided_storage`].
2673
3222
  *
2674
3223
  * @param {Array<H160>} addresses
2675
3224
  * @param {number} limit
@@ -2701,7 +3250,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2701
3250
  **/
2702
3251
  evm: {
2703
3252
  /**
2704
- * See [`Pallet::withdraw`].
3253
+ * Withdraw balance from EVM into currency/balances pallet.
2705
3254
  *
2706
3255
  * @param {H160} address
2707
3256
  * @param {bigint} value
@@ -2724,7 +3273,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2724
3273
  >;
2725
3274
 
2726
3275
  /**
2727
- * See [`Pallet::call`].
3276
+ * Issue an EVM call operation. This is similar to a message call transaction in Ethereum.
2728
3277
  *
2729
3278
  * @param {H160} source
2730
3279
  * @param {H160} target
@@ -2771,7 +3320,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2771
3320
  >;
2772
3321
 
2773
3322
  /**
2774
- * See [`Pallet::create`].
3323
+ * Issue an EVM create operation. This is similar to a contract creation transaction in
3324
+ * Ethereum.
2775
3325
  *
2776
3326
  * @param {H160} source
2777
3327
  * @param {BytesLike} init
@@ -2815,7 +3365,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2815
3365
  >;
2816
3366
 
2817
3367
  /**
2818
- * See [`Pallet::create2`].
3368
+ * Issue an EVM create2 operation.
2819
3369
  *
2820
3370
  * @param {H160} source
2821
3371
  * @param {BytesLike} init
@@ -2871,7 +3421,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2871
3421
  **/
2872
3422
  ethereum: {
2873
3423
  /**
2874
- * See [`Pallet::transact`].
3424
+ * Transact an Ethereum transaction.
2875
3425
  *
2876
3426
  * @param {EthereumTransactionTransactionV2} transaction
2877
3427
  **/
@@ -2899,7 +3449,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2899
3449
  **/
2900
3450
  scheduler: {
2901
3451
  /**
2902
- * See [`Pallet::schedule`].
3452
+ * Anonymously schedule a task.
2903
3453
  *
2904
3454
  * @param {number} when
2905
3455
  * @param {[number, number] | undefined} maybePeriodic
@@ -2931,7 +3481,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2931
3481
  >;
2932
3482
 
2933
3483
  /**
2934
- * See [`Pallet::cancel`].
3484
+ * Cancel an anonymously scheduled task.
2935
3485
  *
2936
3486
  * @param {number} when
2937
3487
  * @param {number} index
@@ -2954,7 +3504,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2954
3504
  >;
2955
3505
 
2956
3506
  /**
2957
- * See [`Pallet::schedule_named`].
3507
+ * Schedule a named task.
2958
3508
  *
2959
3509
  * @param {FixedBytes<32>} id
2960
3510
  * @param {number} when
@@ -2989,7 +3539,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2989
3539
  >;
2990
3540
 
2991
3541
  /**
2992
- * See [`Pallet::cancel_named`].
3542
+ * Cancel a named scheduled task.
2993
3543
  *
2994
3544
  * @param {FixedBytes<32>} id
2995
3545
  **/
@@ -3008,7 +3558,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3008
3558
  >;
3009
3559
 
3010
3560
  /**
3011
- * See [`Pallet::schedule_after`].
3561
+ * Anonymously schedule a task after a delay.
3012
3562
  *
3013
3563
  * @param {number} after
3014
3564
  * @param {[number, number] | undefined} maybePeriodic
@@ -3040,7 +3590,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3040
3590
  >;
3041
3591
 
3042
3592
  /**
3043
- * See [`Pallet::schedule_named_after`].
3593
+ * Schedule a named task after a delay.
3044
3594
  *
3045
3595
  * @param {FixedBytes<32>} id
3046
3596
  * @param {number} after
@@ -3074,6 +3624,116 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3074
3624
  >
3075
3625
  >;
3076
3626
 
3627
+ /**
3628
+ * Set a retry configuration for a task so that, in case its scheduled run fails, it will
3629
+ * be retried after `period` blocks, for a total amount of `retries` retries or until it
3630
+ * succeeds.
3631
+ *
3632
+ * Tasks which need to be scheduled for a retry are still subject to weight metering and
3633
+ * agenda space, same as a regular task. If a periodic task fails, it will be scheduled
3634
+ * normally while the task is retrying.
3635
+ *
3636
+ * Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic
3637
+ * clones of the original task. Their retry configuration will be derived from the
3638
+ * original task's configuration, but will have a lower value for `remaining` than the
3639
+ * original `total_retries`.
3640
+ *
3641
+ * @param {[number, number]} task
3642
+ * @param {number} retries
3643
+ * @param {number} period
3644
+ **/
3645
+ setRetry: GenericTxCall<
3646
+ Rv,
3647
+ (
3648
+ task: [number, number],
3649
+ retries: number,
3650
+ period: number,
3651
+ ) => ChainSubmittableExtrinsic<
3652
+ Rv,
3653
+ {
3654
+ pallet: 'Scheduler';
3655
+ palletCall: {
3656
+ name: 'SetRetry';
3657
+ params: { task: [number, number]; retries: number; period: number };
3658
+ };
3659
+ }
3660
+ >
3661
+ >;
3662
+
3663
+ /**
3664
+ * Set a retry configuration for a named task so that, in case its scheduled run fails, it
3665
+ * will be retried after `period` blocks, for a total amount of `retries` retries or until
3666
+ * it succeeds.
3667
+ *
3668
+ * Tasks which need to be scheduled for a retry are still subject to weight metering and
3669
+ * agenda space, same as a regular task. If a periodic task fails, it will be scheduled
3670
+ * normally while the task is retrying.
3671
+ *
3672
+ * Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic
3673
+ * clones of the original task. Their retry configuration will be derived from the
3674
+ * original task's configuration, but will have a lower value for `remaining` than the
3675
+ * original `total_retries`.
3676
+ *
3677
+ * @param {FixedBytes<32>} id
3678
+ * @param {number} retries
3679
+ * @param {number} period
3680
+ **/
3681
+ setRetryNamed: GenericTxCall<
3682
+ Rv,
3683
+ (
3684
+ id: FixedBytes<32>,
3685
+ retries: number,
3686
+ period: number,
3687
+ ) => ChainSubmittableExtrinsic<
3688
+ Rv,
3689
+ {
3690
+ pallet: 'Scheduler';
3691
+ palletCall: {
3692
+ name: 'SetRetryNamed';
3693
+ params: { id: FixedBytes<32>; retries: number; period: number };
3694
+ };
3695
+ }
3696
+ >
3697
+ >;
3698
+
3699
+ /**
3700
+ * Removes the retry configuration of a task.
3701
+ *
3702
+ * @param {[number, number]} task
3703
+ **/
3704
+ cancelRetry: GenericTxCall<
3705
+ Rv,
3706
+ (task: [number, number]) => ChainSubmittableExtrinsic<
3707
+ Rv,
3708
+ {
3709
+ pallet: 'Scheduler';
3710
+ palletCall: {
3711
+ name: 'CancelRetry';
3712
+ params: { task: [number, number] };
3713
+ };
3714
+ }
3715
+ >
3716
+ >;
3717
+
3718
+ /**
3719
+ * Cancel the retry configuration of a named task.
3720
+ *
3721
+ * @param {FixedBytes<32>} id
3722
+ **/
3723
+ cancelRetryNamed: GenericTxCall<
3724
+ Rv,
3725
+ (id: FixedBytes<32>) => ChainSubmittableExtrinsic<
3726
+ Rv,
3727
+ {
3728
+ pallet: 'Scheduler';
3729
+ palletCall: {
3730
+ name: 'CancelRetryNamed';
3731
+ params: { id: FixedBytes<32> };
3732
+ };
3733
+ }
3734
+ >
3735
+ >;
3736
+
3077
3737
  /**
3078
3738
  * Generic pallet tx call
3079
3739
  **/
@@ -3084,7 +3744,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3084
3744
  **/
3085
3745
  preimage: {
3086
3746
  /**
3087
- * See [`Pallet::note_preimage`].
3747
+ * Register a preimage on-chain.
3748
+ *
3749
+ * If the preimage was previously requested, no fees or deposits are taken for providing
3750
+ * the preimage. Otherwise, a deposit is taken proportional to the size of the preimage.
3088
3751
  *
3089
3752
  * @param {BytesLike} bytes
3090
3753
  **/
@@ -3103,7 +3766,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3103
3766
  >;
3104
3767
 
3105
3768
  /**
3106
- * See [`Pallet::unnote_preimage`].
3769
+ * Clear an unrequested preimage from the runtime storage.
3770
+ *
3771
+ * If `len` is provided, then it will be a much cheaper operation.
3772
+ *
3773
+ * - `hash`: The hash of the preimage to be removed from the store.
3774
+ * - `len`: The length of the preimage of `hash`.
3107
3775
  *
3108
3776
  * @param {H256} hash
3109
3777
  **/
@@ -3122,7 +3790,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3122
3790
  >;
3123
3791
 
3124
3792
  /**
3125
- * See [`Pallet::request_preimage`].
3793
+ * Request a preimage be uploaded to the chain without paying any fees or deposits.
3794
+ *
3795
+ * If the preimage requests has already been provided on-chain, we unreserve any deposit
3796
+ * a user may have paid, and take the control of the preimage out of their hands.
3126
3797
  *
3127
3798
  * @param {H256} hash
3128
3799
  **/
@@ -3141,7 +3812,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3141
3812
  >;
3142
3813
 
3143
3814
  /**
3144
- * See [`Pallet::unrequest_preimage`].
3815
+ * Clear a previously made request for a preimage.
3816
+ *
3817
+ * NOTE: THIS MUST NOT BE CALLED ON `hash` MORE TIMES THAN `request_preimage`.
3145
3818
  *
3146
3819
  * @param {H256} hash
3147
3820
  **/
@@ -3160,7 +3833,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3160
3833
  >;
3161
3834
 
3162
3835
  /**
3163
- * See [`Pallet::ensure_updated`].
3836
+ * Ensure that the a bulk of pre-images is upgraded.
3837
+ *
3838
+ * The caller pays no fee if at least 90% of pre-images were successfully updated.
3164
3839
  *
3165
3840
  * @param {Array<H256>} hashes
3166
3841
  **/
@@ -3188,7 +3863,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3188
3863
  **/
3189
3864
  convictionVoting: {
3190
3865
  /**
3191
- * See [`Pallet::vote`].
3866
+ * Vote in a poll. If `vote.is_aye()`, the vote is to enact the proposal;
3867
+ * otherwise it is a vote to keep the status quo.
3868
+ *
3869
+ * The dispatch origin of this call must be _Signed_.
3870
+ *
3871
+ * - `poll_index`: The index of the poll to vote for.
3872
+ * - `vote`: The vote configuration.
3873
+ *
3874
+ * Weight: `O(R)` where R is the number of polls the voter has voted on.
3192
3875
  *
3193
3876
  * @param {number} pollIndex
3194
3877
  * @param {PalletConvictionVotingVoteAccountVote} vote
@@ -3211,7 +3894,29 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3211
3894
  >;
3212
3895
 
3213
3896
  /**
3214
- * See [`Pallet::delegate`].
3897
+ * Delegate the voting power (with some given conviction) of the sending account for a
3898
+ * particular class of polls.
3899
+ *
3900
+ * The balance delegated is locked for as long as it's delegated, and thereafter for the
3901
+ * time appropriate for the conviction's lock period.
3902
+ *
3903
+ * The dispatch origin of this call must be _Signed_, and the signing account must either:
3904
+ * - be delegating already; or
3905
+ * - have no voting activity (if there is, then it will need to be removed through
3906
+ * `remove_vote`).
3907
+ *
3908
+ * - `to`: The account whose voting the `target` account's voting power will follow.
3909
+ * - `class`: The class of polls to delegate. To delegate multiple classes, multiple calls
3910
+ * to this function are required.
3911
+ * - `conviction`: The conviction that will be attached to the delegated votes. When the
3912
+ * account is undelegated, the funds will be locked for the corresponding period.
3913
+ * - `balance`: The amount of the account's balance to be used in delegating. This must not
3914
+ * be more than the account's current balance.
3915
+ *
3916
+ * Emits `Delegated`.
3917
+ *
3918
+ * Weight: `O(R)` where R is the number of polls the voter delegating to has
3919
+ * voted on. Weight is initially charged as if maximum votes, but is refunded later.
3215
3920
  *
3216
3921
  * @param {number} class_
3217
3922
  * @param {AccountId20Like} to
@@ -3243,7 +3948,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3243
3948
  >;
3244
3949
 
3245
3950
  /**
3246
- * See [`Pallet::undelegate`].
3951
+ * Undelegate the voting power of the sending account for a particular class of polls.
3952
+ *
3953
+ * Tokens may be unlocked following once an amount of time consistent with the lock period
3954
+ * of the conviction with which the delegation was issued has passed.
3955
+ *
3956
+ * The dispatch origin of this call must be _Signed_ and the signing account must be
3957
+ * currently delegating.
3958
+ *
3959
+ * - `class`: The class of polls to remove the delegation from.
3960
+ *
3961
+ * Emits `Undelegated`.
3962
+ *
3963
+ * Weight: `O(R)` where R is the number of polls the voter delegating to has
3964
+ * voted on. Weight is initially charged as if maximum votes, but is refunded later.
3247
3965
  *
3248
3966
  * @param {number} class_
3249
3967
  **/
@@ -3262,7 +3980,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3262
3980
  >;
3263
3981
 
3264
3982
  /**
3265
- * See [`Pallet::unlock`].
3983
+ * Remove the lock caused by prior voting/delegating which has expired within a particular
3984
+ * class.
3985
+ *
3986
+ * The dispatch origin of this call must be _Signed_.
3987
+ *
3988
+ * - `class`: The class of polls to unlock.
3989
+ * - `target`: The account to remove the lock on.
3990
+ *
3991
+ * Weight: `O(R)` with R number of vote of target.
3266
3992
  *
3267
3993
  * @param {number} class_
3268
3994
  * @param {AccountId20Like} target
@@ -3285,7 +4011,35 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3285
4011
  >;
3286
4012
 
3287
4013
  /**
3288
- * See [`Pallet::remove_vote`].
4014
+ * Remove a vote for a poll.
4015
+ *
4016
+ * If:
4017
+ * - the poll was cancelled, or
4018
+ * - the poll is ongoing, or
4019
+ * - the poll has ended such that
4020
+ * - the vote of the account was in opposition to the result; or
4021
+ * - there was no conviction to the account's vote; or
4022
+ * - the account made a split vote
4023
+ * ...then the vote is removed cleanly and a following call to `unlock` may result in more
4024
+ * funds being available.
4025
+ *
4026
+ * If, however, the poll has ended and:
4027
+ * - it finished corresponding to the vote of the account, and
4028
+ * - the account made a standard vote with conviction, and
4029
+ * - the lock period of the conviction is not over
4030
+ * ...then the lock will be aggregated into the overall account's lock, which may involve
4031
+ * *overlocking* (where the two locks are combined into a single lock that is the maximum
4032
+ * of both the amount locked and the time is it locked for).
4033
+ *
4034
+ * The dispatch origin of this call must be _Signed_, and the signer must have a vote
4035
+ * registered for poll `index`.
4036
+ *
4037
+ * - `index`: The index of poll of the vote to be removed.
4038
+ * - `class`: Optional parameter, if given it indicates the class of the poll. For polls
4039
+ * which have finished or are cancelled, this must be `Some`.
4040
+ *
4041
+ * Weight: `O(R + log R)` where R is the number of polls that `target` has voted on.
4042
+ * Weight is calculated for the maximum number of vote.
3289
4043
  *
3290
4044
  * @param {number | undefined} class_
3291
4045
  * @param {number} index
@@ -3308,7 +4062,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3308
4062
  >;
3309
4063
 
3310
4064
  /**
3311
- * See [`Pallet::remove_other_vote`].
4065
+ * Remove a vote for a poll.
4066
+ *
4067
+ * If the `target` is equal to the signer, then this function is exactly equivalent to
4068
+ * `remove_vote`. If not equal to the signer, then the vote must have expired,
4069
+ * either because the poll was cancelled, because the voter lost the poll or
4070
+ * because the conviction period is over.
4071
+ *
4072
+ * The dispatch origin of this call must be _Signed_.
4073
+ *
4074
+ * - `target`: The account of the vote to be removed; this account must have voted for poll
4075
+ * `index`.
4076
+ * - `index`: The index of poll of the vote to be removed.
4077
+ * - `class`: The class of the poll.
4078
+ *
4079
+ * Weight: `O(R + log R)` where R is the number of polls that `target` has voted on.
4080
+ * Weight is calculated for the maximum number of vote.
3312
4081
  *
3313
4082
  * @param {AccountId20Like} target
3314
4083
  * @param {number} class_
@@ -3342,9 +4111,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3342
4111
  **/
3343
4112
  referenda: {
3344
4113
  /**
3345
- * See [`Pallet::submit`].
4114
+ * Propose a referendum on a privileged action.
3346
4115
  *
3347
- * @param {MoonbeamRuntimeOriginCaller} proposalOrigin
4116
+ * - `origin`: must be `SubmitOrigin` and the account must have `SubmissionDeposit` funds
4117
+ * available.
4118
+ * - `proposal_origin`: The origin from which the proposal should be executed.
4119
+ * - `proposal`: The proposal.
4120
+ * - `enactment_moment`: The moment that the proposal should be enacted.
4121
+ *
4122
+ * Emits `Submitted`.
4123
+ *
4124
+ * @param {MoonbeamRuntimeOriginCaller} proposalOrigin
3348
4125
  * @param {FrameSupportPreimagesBounded} proposal
3349
4126
  * @param {FrameSupportScheduleDispatchTime} enactmentMoment
3350
4127
  **/
@@ -3371,7 +4148,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3371
4148
  >;
3372
4149
 
3373
4150
  /**
3374
- * See [`Pallet::place_decision_deposit`].
4151
+ * Post the Decision Deposit for a referendum.
4152
+ *
4153
+ * - `origin`: must be `Signed` and the account must have funds available for the
4154
+ * referendum's track's Decision Deposit.
4155
+ * - `index`: The index of the submitted referendum whose Decision Deposit is yet to be
4156
+ * posted.
4157
+ *
4158
+ * Emits `DecisionDepositPlaced`.
3375
4159
  *
3376
4160
  * @param {number} index
3377
4161
  **/
@@ -3390,7 +4174,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3390
4174
  >;
3391
4175
 
3392
4176
  /**
3393
- * See [`Pallet::refund_decision_deposit`].
4177
+ * Refund the Decision Deposit for a closed referendum back to the depositor.
4178
+ *
4179
+ * - `origin`: must be `Signed` or `Root`.
4180
+ * - `index`: The index of a closed referendum whose Decision Deposit has not yet been
4181
+ * refunded.
4182
+ *
4183
+ * Emits `DecisionDepositRefunded`.
3394
4184
  *
3395
4185
  * @param {number} index
3396
4186
  **/
@@ -3409,7 +4199,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3409
4199
  >;
3410
4200
 
3411
4201
  /**
3412
- * See [`Pallet::cancel`].
4202
+ * Cancel an ongoing referendum.
4203
+ *
4204
+ * - `origin`: must be the `CancelOrigin`.
4205
+ * - `index`: The index of the referendum to be cancelled.
4206
+ *
4207
+ * Emits `Cancelled`.
3413
4208
  *
3414
4209
  * @param {number} index
3415
4210
  **/
@@ -3428,7 +4223,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3428
4223
  >;
3429
4224
 
3430
4225
  /**
3431
- * See [`Pallet::kill`].
4226
+ * Cancel an ongoing referendum and slash the deposits.
4227
+ *
4228
+ * - `origin`: must be the `KillOrigin`.
4229
+ * - `index`: The index of the referendum to be cancelled.
4230
+ *
4231
+ * Emits `Killed` and `DepositSlashed`.
3432
4232
  *
3433
4233
  * @param {number} index
3434
4234
  **/
@@ -3447,7 +4247,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3447
4247
  >;
3448
4248
 
3449
4249
  /**
3450
- * See [`Pallet::nudge_referendum`].
4250
+ * Advance a referendum onto its next logical state. Only used internally.
4251
+ *
4252
+ * - `origin`: must be `Root`.
4253
+ * - `index`: the referendum to be advanced.
3451
4254
  *
3452
4255
  * @param {number} index
3453
4256
  **/
@@ -3466,7 +4269,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3466
4269
  >;
3467
4270
 
3468
4271
  /**
3469
- * See [`Pallet::one_fewer_deciding`].
4272
+ * Advance a track onto its next logical state. Only used internally.
4273
+ *
4274
+ * - `origin`: must be `Root`.
4275
+ * - `track`: the track to be advanced.
4276
+ *
4277
+ * Action item for when there is now one fewer referendum in the deciding phase and the
4278
+ * `DecidingCount` is not yet updated. This means that we should either:
4279
+ * - begin deciding another referendum (and leave `DecidingCount` alone); or
4280
+ * - decrement `DecidingCount`.
3470
4281
  *
3471
4282
  * @param {number} track
3472
4283
  **/
@@ -3485,7 +4296,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3485
4296
  >;
3486
4297
 
3487
4298
  /**
3488
- * See [`Pallet::refund_submission_deposit`].
4299
+ * Refund the Submission Deposit for a closed referendum back to the depositor.
4300
+ *
4301
+ * - `origin`: must be `Signed` or `Root`.
4302
+ * - `index`: The index of a closed referendum whose Submission Deposit has not yet been
4303
+ * refunded.
4304
+ *
4305
+ * Emits `SubmissionDepositRefunded`.
3489
4306
  *
3490
4307
  * @param {number} index
3491
4308
  **/
@@ -3504,7 +4321,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3504
4321
  >;
3505
4322
 
3506
4323
  /**
3507
- * See [`Pallet::set_metadata`].
4324
+ * Set or clear metadata of a referendum.
4325
+ *
4326
+ * Parameters:
4327
+ * - `origin`: Must be `Signed` by a creator of a referendum or by anyone to clear a
4328
+ * metadata of a finished referendum.
4329
+ * - `index`: The index of a referendum to set or clear metadata for.
4330
+ * - `maybe_hash`: The hash of an on-chain stored preimage. `None` to clear a metadata.
3508
4331
  *
3509
4332
  * @param {number} index
3510
4333
  * @param {H256 | undefined} maybeHash
@@ -3536,7 +4359,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3536
4359
  **/
3537
4360
  whitelist: {
3538
4361
  /**
3539
- * See [`Pallet::whitelist_call`].
3540
4362
  *
3541
4363
  * @param {H256} callHash
3542
4364
  **/
@@ -3555,7 +4377,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3555
4377
  >;
3556
4378
 
3557
4379
  /**
3558
- * See [`Pallet::remove_whitelisted_call`].
3559
4380
  *
3560
4381
  * @param {H256} callHash
3561
4382
  **/
@@ -3574,7 +4395,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3574
4395
  >;
3575
4396
 
3576
4397
  /**
3577
- * See [`Pallet::dispatch_whitelisted_call`].
3578
4398
  *
3579
4399
  * @param {H256} callHash
3580
4400
  * @param {number} callEncodedLen
@@ -3599,7 +4419,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3599
4419
  >;
3600
4420
 
3601
4421
  /**
3602
- * See [`Pallet::dispatch_whitelisted_call_with_preimage`].
3603
4422
  *
3604
4423
  * @param {MoonbeamRuntimeRuntimeCallLike} call
3605
4424
  **/
@@ -3627,7 +4446,30 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3627
4446
  **/
3628
4447
  treasuryCouncilCollective: {
3629
4448
  /**
3630
- * See [`Pallet::set_members`].
4449
+ * Set the collective's membership.
4450
+ *
4451
+ * - `new_members`: The new member list. Be nice to the chain and provide it sorted.
4452
+ * - `prime`: The prime member whose vote sets the default.
4453
+ * - `old_count`: The upper bound for the previous number of members in storage. Used for
4454
+ * weight estimation.
4455
+ *
4456
+ * The dispatch of this call must be `SetMembersOrigin`.
4457
+ *
4458
+ * NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
4459
+ * the weight estimations rely on it to estimate dispatchable weight.
4460
+ *
4461
+ * # WARNING:
4462
+ *
4463
+ * The `pallet-collective` can also be managed by logic outside of the pallet through the
4464
+ * implementation of the trait [`ChangeMembers`].
4465
+ * Any call to `set_members` must be careful that the member set doesn't get out of sync
4466
+ * with other logic managing the member set.
4467
+ *
4468
+ * ## Complexity:
4469
+ * - `O(MP + N)` where:
4470
+ * - `M` old-members-count (code- and governance-bounded)
4471
+ * - `N` new-members-count (code- and governance-bounded)
4472
+ * - `P` proposals-count (code-bounded)
3631
4473
  *
3632
4474
  * @param {Array<AccountId20Like>} newMembers
3633
4475
  * @param {AccountId20Like | undefined} prime
@@ -3652,7 +4494,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3652
4494
  >;
3653
4495
 
3654
4496
  /**
3655
- * See [`Pallet::execute`].
4497
+ * Dispatch a proposal from a member using the `Member` origin.
4498
+ *
4499
+ * Origin must be a member of the collective.
4500
+ *
4501
+ * ## Complexity:
4502
+ * - `O(B + M + P)` where:
4503
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4504
+ * - `M` members-count (code-bounded)
4505
+ * - `P` complexity of dispatching `proposal`
3656
4506
  *
3657
4507
  * @param {MoonbeamRuntimeRuntimeCallLike} proposal
3658
4508
  * @param {number} lengthBound
@@ -3675,7 +4525,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3675
4525
  >;
3676
4526
 
3677
4527
  /**
3678
- * See [`Pallet::propose`].
4528
+ * Add a new proposal to either be voted on or executed directly.
4529
+ *
4530
+ * Requires the sender to be member.
4531
+ *
4532
+ * `threshold` determines whether `proposal` is executed directly (`threshold < 2`)
4533
+ * or put up for voting.
4534
+ *
4535
+ * ## Complexity
4536
+ * - `O(B + M + P1)` or `O(B + M + P2)` where:
4537
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4538
+ * - `M` is members-count (code- and governance-bounded)
4539
+ * - branching is influenced by `threshold` where:
4540
+ * - `P1` is proposal execution complexity (`threshold < 2`)
4541
+ * - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
3679
4542
  *
3680
4543
  * @param {number} threshold
3681
4544
  * @param {MoonbeamRuntimeRuntimeCallLike} proposal
@@ -3700,7 +4563,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3700
4563
  >;
3701
4564
 
3702
4565
  /**
3703
- * See [`Pallet::vote`].
4566
+ * Add an aye or nay vote for the sender to the given proposal.
4567
+ *
4568
+ * Requires the sender to be a member.
4569
+ *
4570
+ * Transaction fees will be waived if the member is voting on any particular proposal
4571
+ * for the first time and the call is successful. Subsequent vote changes will charge a
4572
+ * fee.
4573
+ * ## Complexity
4574
+ * - `O(M)` where `M` is members-count (code- and governance-bounded)
3704
4575
  *
3705
4576
  * @param {H256} proposal
3706
4577
  * @param {number} index
@@ -3725,7 +4596,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3725
4596
  >;
3726
4597
 
3727
4598
  /**
3728
- * See [`Pallet::disapprove_proposal`].
4599
+ * Disapprove a proposal, close, and remove it from the system, regardless of its current
4600
+ * state.
4601
+ *
4602
+ * Must be called by the Root origin.
4603
+ *
4604
+ * Parameters:
4605
+ * * `proposal_hash`: The hash of the proposal that should be disapproved.
4606
+ *
4607
+ * ## Complexity
4608
+ * O(P) where P is the number of max proposals
3729
4609
  *
3730
4610
  * @param {H256} proposalHash
3731
4611
  **/
@@ -3744,7 +4624,30 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3744
4624
  >;
3745
4625
 
3746
4626
  /**
3747
- * See [`Pallet::close`].
4627
+ * Close a vote that is either approved, disapproved or whose voting period has ended.
4628
+ *
4629
+ * May be called by any signed account in order to finish voting and close the proposal.
4630
+ *
4631
+ * If called before the end of the voting period it will only close the vote if it is
4632
+ * has enough votes to be approved or disapproved.
4633
+ *
4634
+ * If called after the end of the voting period abstentions are counted as rejections
4635
+ * unless there is a prime member set and the prime member cast an approval.
4636
+ *
4637
+ * If the close operation completes successfully with disapproval, the transaction fee will
4638
+ * be waived. Otherwise execution of the approved operation will be charged to the caller.
4639
+ *
4640
+ * + `proposal_weight_bound`: The maximum amount of weight consumed by executing the closed
4641
+ * proposal.
4642
+ * + `length_bound`: The upper bound for the length of the proposal in storage. Checked via
4643
+ * `storage::read` so it is `size_of::<u32>() == 4` larger than the pure length.
4644
+ *
4645
+ * ## Complexity
4646
+ * - `O(B + M + P1 + P2)` where:
4647
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4648
+ * - `M` is members-count (code- and governance-bounded)
4649
+ * - `P1` is the complexity of `proposal` preimage.
4650
+ * - `P2` is proposal-count (code-bounded)
3748
4651
  *
3749
4652
  * @param {H256} proposalHash
3750
4653
  * @param {number} index
@@ -3785,7 +4688,30 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3785
4688
  **/
3786
4689
  openTechCommitteeCollective: {
3787
4690
  /**
3788
- * See [`Pallet::set_members`].
4691
+ * Set the collective's membership.
4692
+ *
4693
+ * - `new_members`: The new member list. Be nice to the chain and provide it sorted.
4694
+ * - `prime`: The prime member whose vote sets the default.
4695
+ * - `old_count`: The upper bound for the previous number of members in storage. Used for
4696
+ * weight estimation.
4697
+ *
4698
+ * The dispatch of this call must be `SetMembersOrigin`.
4699
+ *
4700
+ * NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
4701
+ * the weight estimations rely on it to estimate dispatchable weight.
4702
+ *
4703
+ * # WARNING:
4704
+ *
4705
+ * The `pallet-collective` can also be managed by logic outside of the pallet through the
4706
+ * implementation of the trait [`ChangeMembers`].
4707
+ * Any call to `set_members` must be careful that the member set doesn't get out of sync
4708
+ * with other logic managing the member set.
4709
+ *
4710
+ * ## Complexity:
4711
+ * - `O(MP + N)` where:
4712
+ * - `M` old-members-count (code- and governance-bounded)
4713
+ * - `N` new-members-count (code- and governance-bounded)
4714
+ * - `P` proposals-count (code-bounded)
3789
4715
  *
3790
4716
  * @param {Array<AccountId20Like>} newMembers
3791
4717
  * @param {AccountId20Like | undefined} prime
@@ -3810,7 +4736,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3810
4736
  >;
3811
4737
 
3812
4738
  /**
3813
- * See [`Pallet::execute`].
4739
+ * Dispatch a proposal from a member using the `Member` origin.
4740
+ *
4741
+ * Origin must be a member of the collective.
4742
+ *
4743
+ * ## Complexity:
4744
+ * - `O(B + M + P)` where:
4745
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4746
+ * - `M` members-count (code-bounded)
4747
+ * - `P` complexity of dispatching `proposal`
3814
4748
  *
3815
4749
  * @param {MoonbeamRuntimeRuntimeCallLike} proposal
3816
4750
  * @param {number} lengthBound
@@ -3833,7 +4767,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3833
4767
  >;
3834
4768
 
3835
4769
  /**
3836
- * See [`Pallet::propose`].
4770
+ * Add a new proposal to either be voted on or executed directly.
4771
+ *
4772
+ * Requires the sender to be member.
4773
+ *
4774
+ * `threshold` determines whether `proposal` is executed directly (`threshold < 2`)
4775
+ * or put up for voting.
4776
+ *
4777
+ * ## Complexity
4778
+ * - `O(B + M + P1)` or `O(B + M + P2)` where:
4779
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4780
+ * - `M` is members-count (code- and governance-bounded)
4781
+ * - branching is influenced by `threshold` where:
4782
+ * - `P1` is proposal execution complexity (`threshold < 2`)
4783
+ * - `P2` is proposals-count (code-bounded) (`threshold >= 2`)
3837
4784
  *
3838
4785
  * @param {number} threshold
3839
4786
  * @param {MoonbeamRuntimeRuntimeCallLike} proposal
@@ -3858,7 +4805,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3858
4805
  >;
3859
4806
 
3860
4807
  /**
3861
- * See [`Pallet::vote`].
4808
+ * Add an aye or nay vote for the sender to the given proposal.
4809
+ *
4810
+ * Requires the sender to be a member.
4811
+ *
4812
+ * Transaction fees will be waived if the member is voting on any particular proposal
4813
+ * for the first time and the call is successful. Subsequent vote changes will charge a
4814
+ * fee.
4815
+ * ## Complexity
4816
+ * - `O(M)` where `M` is members-count (code- and governance-bounded)
3862
4817
  *
3863
4818
  * @param {H256} proposal
3864
4819
  * @param {number} index
@@ -3883,7 +4838,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3883
4838
  >;
3884
4839
 
3885
4840
  /**
3886
- * See [`Pallet::disapprove_proposal`].
4841
+ * Disapprove a proposal, close, and remove it from the system, regardless of its current
4842
+ * state.
4843
+ *
4844
+ * Must be called by the Root origin.
4845
+ *
4846
+ * Parameters:
4847
+ * * `proposal_hash`: The hash of the proposal that should be disapproved.
4848
+ *
4849
+ * ## Complexity
4850
+ * O(P) where P is the number of max proposals
3887
4851
  *
3888
4852
  * @param {H256} proposalHash
3889
4853
  **/
@@ -3902,7 +4866,30 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3902
4866
  >;
3903
4867
 
3904
4868
  /**
3905
- * See [`Pallet::close`].
4869
+ * Close a vote that is either approved, disapproved or whose voting period has ended.
4870
+ *
4871
+ * May be called by any signed account in order to finish voting and close the proposal.
4872
+ *
4873
+ * If called before the end of the voting period it will only close the vote if it is
4874
+ * has enough votes to be approved or disapproved.
4875
+ *
4876
+ * If called after the end of the voting period abstentions are counted as rejections
4877
+ * unless there is a prime member set and the prime member cast an approval.
4878
+ *
4879
+ * If the close operation completes successfully with disapproval, the transaction fee will
4880
+ * be waived. Otherwise execution of the approved operation will be charged to the caller.
4881
+ *
4882
+ * + `proposal_weight_bound`: The maximum amount of weight consumed by executing the closed
4883
+ * proposal.
4884
+ * + `length_bound`: The upper bound for the length of the proposal in storage. Checked via
4885
+ * `storage::read` so it is `size_of::<u32>() == 4` larger than the pure length.
4886
+ *
4887
+ * ## Complexity
4888
+ * - `O(B + M + P1 + P2)` where:
4889
+ * - `B` is `proposal` size in bytes (length-fee-bounded)
4890
+ * - `M` is members-count (code- and governance-bounded)
4891
+ * - `P1` is the complexity of `proposal` preimage.
4892
+ * - `P2` is proposal-count (code-bounded)
3906
4893
  *
3907
4894
  * @param {H256} proposalHash
3908
4895
  * @param {number} index
@@ -3943,7 +4930,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3943
4930
  **/
3944
4931
  treasury: {
3945
4932
  /**
3946
- * See [`Pallet::propose_spend`].
4933
+ * Put forward a suggestion for spending.
4934
+ *
4935
+ * ## Dispatch Origin
4936
+ *
4937
+ * Must be signed.
4938
+ *
4939
+ * ## Details
4940
+ * A deposit proportional to the value is reserved and slashed if the proposal is rejected.
4941
+ * It is returned once the proposal is awarded.
4942
+ *
4943
+ * ### Complexity
4944
+ * - O(1)
4945
+ *
4946
+ * ## Events
4947
+ *
4948
+ * Emits [`Event::Proposed`] if successful.
3947
4949
  *
3948
4950
  * @param {bigint} value
3949
4951
  * @param {AccountId20Like} beneficiary
@@ -3966,7 +4968,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3966
4968
  >;
3967
4969
 
3968
4970
  /**
3969
- * See [`Pallet::reject_proposal`].
4971
+ * Reject a proposed spend.
4972
+ *
4973
+ * ## Dispatch Origin
4974
+ *
4975
+ * Must be [`Config::RejectOrigin`].
4976
+ *
4977
+ * ## Details
4978
+ * The original deposit will be slashed.
4979
+ *
4980
+ * ### Complexity
4981
+ * - O(1)
4982
+ *
4983
+ * ## Events
4984
+ *
4985
+ * Emits [`Event::Rejected`] if successful.
3970
4986
  *
3971
4987
  * @param {number} proposalId
3972
4988
  **/
@@ -3985,7 +5001,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3985
5001
  >;
3986
5002
 
3987
5003
  /**
3988
- * See [`Pallet::approve_proposal`].
5004
+ * Approve a proposal.
5005
+ *
5006
+ * ## Dispatch Origin
5007
+ *
5008
+ * Must be [`Config::ApproveOrigin`].
5009
+ *
5010
+ * ## Details
5011
+ *
5012
+ * At a later time, the proposal will be allocated to the beneficiary and the original
5013
+ * deposit will be returned.
5014
+ *
5015
+ * ### Complexity
5016
+ * - O(1).
5017
+ *
5018
+ * ## Events
5019
+ *
5020
+ * No events are emitted from this dispatch.
3989
5021
  *
3990
5022
  * @param {number} proposalId
3991
5023
  **/
@@ -4004,7 +5036,23 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4004
5036
  >;
4005
5037
 
4006
5038
  /**
4007
- * See [`Pallet::spend_local`].
5039
+ * Propose and approve a spend of treasury funds.
5040
+ *
5041
+ * ## Dispatch Origin
5042
+ *
5043
+ * Must be [`Config::SpendOrigin`] with the `Success` value being at least `amount`.
5044
+ *
5045
+ * ### Details
5046
+ * NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the
5047
+ * beneficiary.
5048
+ *
5049
+ * ### Parameters
5050
+ * - `amount`: The amount to be transferred from the treasury to the `beneficiary`.
5051
+ * - `beneficiary`: The destination account for the transfer.
5052
+ *
5053
+ * ## Events
5054
+ *
5055
+ * Emits [`Event::SpendApproved`] if successful.
4008
5056
  *
4009
5057
  * @param {bigint} amount
4010
5058
  * @param {AccountId20Like} beneficiary
@@ -4027,7 +5075,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4027
5075
  >;
4028
5076
 
4029
5077
  /**
4030
- * See [`Pallet::remove_approval`].
5078
+ * Force a previously approved proposal to be removed from the approval queue.
5079
+ *
5080
+ * ## Dispatch Origin
5081
+ *
5082
+ * Must be [`Config::RejectOrigin`].
5083
+ *
5084
+ * ## Details
5085
+ *
5086
+ * The original deposit will no longer be returned.
5087
+ *
5088
+ * ### Parameters
5089
+ * - `proposal_id`: The index of a proposal
5090
+ *
5091
+ * ### Complexity
5092
+ * - O(A) where `A` is the number of approvals
5093
+ *
5094
+ * ### Errors
5095
+ * - [`Error::ProposalNotApproved`]: The `proposal_id` supplied was not found in the
5096
+ * approval queue, i.e., the proposal has not been approved. This could also mean the
5097
+ * proposal does not exist altogether, thus there is no way it would have been approved
5098
+ * in the first place.
4031
5099
  *
4032
5100
  * @param {number} proposalId
4033
5101
  **/
@@ -4046,7 +5114,32 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4046
5114
  >;
4047
5115
 
4048
5116
  /**
4049
- * See [`Pallet::spend`].
5117
+ * Propose and approve a spend of treasury funds.
5118
+ *
5119
+ * ## Dispatch Origin
5120
+ *
5121
+ * Must be [`Config::SpendOrigin`] with the `Success` value being at least
5122
+ * `amount` of `asset_kind` in the native asset. The amount of `asset_kind` is converted
5123
+ * for assertion using the [`Config::BalanceConverter`].
5124
+ *
5125
+ * ## Details
5126
+ *
5127
+ * Create an approved spend for transferring a specific `amount` of `asset_kind` to a
5128
+ * designated beneficiary. The spend must be claimed using the `payout` dispatchable within
5129
+ * the [`Config::PayoutPeriod`].
5130
+ *
5131
+ * ### Parameters
5132
+ * - `asset_kind`: An indicator of the specific asset class to be spent.
5133
+ * - `amount`: The amount to be transferred from the treasury to the `beneficiary`.
5134
+ * - `beneficiary`: The beneficiary of the spend.
5135
+ * - `valid_from`: The block number from which the spend can be claimed. It can refer to
5136
+ * the past if the resulting spend has not yet expired according to the
5137
+ * [`Config::PayoutPeriod`]. If `None`, the spend can be claimed immediately after
5138
+ * approval.
5139
+ *
5140
+ * ## Events
5141
+ *
5142
+ * Emits [`Event::AssetSpendApproved`] if successful.
4050
5143
  *
4051
5144
  * @param {[]} assetKind
4052
5145
  * @param {bigint} amount
@@ -4073,7 +5166,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4073
5166
  >;
4074
5167
 
4075
5168
  /**
4076
- * See [`Pallet::payout`].
5169
+ * Claim a spend.
5170
+ *
5171
+ * ## Dispatch Origin
5172
+ *
5173
+ * Must be signed.
5174
+ *
5175
+ * ## Details
5176
+ *
5177
+ * Spends must be claimed within some temporal bounds. A spend may be claimed within one
5178
+ * [`Config::PayoutPeriod`] from the `valid_from` block.
5179
+ * In case of a payout failure, the spend status must be updated with the `check_status`
5180
+ * dispatchable before retrying with the current function.
5181
+ *
5182
+ * ### Parameters
5183
+ * - `index`: The spend index.
5184
+ *
5185
+ * ## Events
5186
+ *
5187
+ * Emits [`Event::Paid`] if successful.
4077
5188
  *
4078
5189
  * @param {number} index
4079
5190
  **/
@@ -4092,7 +5203,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4092
5203
  >;
4093
5204
 
4094
5205
  /**
4095
- * See [`Pallet::check_status`].
5206
+ * Check the status of the spend and remove it from the storage if processed.
5207
+ *
5208
+ * ## Dispatch Origin
5209
+ *
5210
+ * Must be signed.
5211
+ *
5212
+ * ## Details
5213
+ *
5214
+ * The status check is a prerequisite for retrying a failed payout.
5215
+ * If a spend has either succeeded or expired, it is removed from the storage by this
5216
+ * function. In such instances, transaction fees are refunded.
5217
+ *
5218
+ * ### Parameters
5219
+ * - `index`: The spend index.
5220
+ *
5221
+ * ## Events
5222
+ *
5223
+ * Emits [`Event::PaymentFailed`] if the spend payout has failed.
5224
+ * Emits [`Event::SpendProcessed`] if the spend payout has succeed.
4096
5225
  *
4097
5226
  * @param {number} index
4098
5227
  **/
@@ -4111,7 +5240,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4111
5240
  >;
4112
5241
 
4113
5242
  /**
4114
- * See [`Pallet::void_spend`].
5243
+ * Void previously approved spend.
5244
+ *
5245
+ * ## Dispatch Origin
5246
+ *
5247
+ * Must be [`Config::RejectOrigin`].
5248
+ *
5249
+ * ## Details
5250
+ *
5251
+ * A spend void is only possible if the payout has not been attempted yet.
5252
+ *
5253
+ * ### Parameters
5254
+ * - `index`: The spend index.
5255
+ *
5256
+ * ## Events
5257
+ *
5258
+ * Emits [`Event::AssetSpendVoided`] if successful.
4115
5259
  *
4116
5260
  * @param {number} index
4117
5261
  **/
@@ -4139,7 +5283,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4139
5283
  **/
4140
5284
  crowdloanRewards: {
4141
5285
  /**
4142
- * See [`Pallet::associate_native_identity`].
5286
+ * Associate a native rewards_destination identity with a crowdloan contribution.
5287
+ *
5288
+ * The caller needs to provide the unassociated relay account and a proof to succeed
5289
+ * with the association
5290
+ * The proof is nothing but a signature over the reward_address using the relay keys
4143
5291
  *
4144
5292
  * @param {AccountId20Like} rewardAccount
4145
5293
  * @param {FixedBytes<32>} relayAccount
@@ -4164,7 +5312,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4164
5312
  >;
4165
5313
 
4166
5314
  /**
4167
- * See [`Pallet::change_association_with_relay_keys`].
5315
+ * Change reward account by submitting proofs from relay accounts
5316
+ *
5317
+ * The number of valid proofs needs to be bigger than 'RewardAddressRelayVoteThreshold'
5318
+ * The account to be changed needs to be submitted as 'previous_account'
5319
+ * Origin must be RewardAddressChangeOrigin
4168
5320
  *
4169
5321
  * @param {AccountId20Like} rewardAccount
4170
5322
  * @param {AccountId20Like} previousAccount
@@ -4193,7 +5345,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4193
5345
  >;
4194
5346
 
4195
5347
  /**
4196
- * See [`Pallet::claim`].
5348
+ * Collect whatever portion of your reward are currently vested.
4197
5349
  *
4198
5350
  **/
4199
5351
  claim: GenericTxCall<
@@ -4210,7 +5362,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4210
5362
  >;
4211
5363
 
4212
5364
  /**
4213
- * See [`Pallet::update_reward_address`].
5365
+ * Update reward address, proving that the caller owns the current native key
4214
5366
  *
4215
5367
  * @param {AccountId20Like} newRewardAccount
4216
5368
  **/
@@ -4229,7 +5381,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4229
5381
  >;
4230
5382
 
4231
5383
  /**
4232
- * See [`Pallet::complete_initialization`].
5384
+ * This extrinsic completes the initialization if some checks are fullfiled. These checks are:
5385
+ * -The reward contribution money matches the crowdloan pot
5386
+ * -The end vesting block is higher than the init vesting block
5387
+ * -The initialization has not complete yet
4233
5388
  *
4234
5389
  * @param {number} leaseEndingBlock
4235
5390
  **/
@@ -4248,7 +5403,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4248
5403
  >;
4249
5404
 
4250
5405
  /**
4251
- * See [`Pallet::initialize_reward_vec`].
5406
+ * Initialize the reward distribution storage. It shortcuts whenever an error is found
5407
+ * This does not enforce any checks other than making sure we dont go over funds
5408
+ * complete_initialization should perform any additional
4252
5409
  *
4253
5410
  * @param {Array<[FixedBytes<32>, AccountId20Like | undefined, bigint]>} rewards
4254
5411
  **/
@@ -4285,7 +5442,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4285
5442
  **/
4286
5443
  polkadotXcm: {
4287
5444
  /**
4288
- * See [`Pallet::send`].
4289
5445
  *
4290
5446
  * @param {XcmVersionedLocation} dest
4291
5447
  * @param {XcmVersionedXcm} message
@@ -4308,7 +5464,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4308
5464
  >;
4309
5465
 
4310
5466
  /**
4311
- * See [`Pallet::teleport_assets`].
5467
+ * Teleport some assets from the local chain to some destination chain.
5468
+ *
5469
+ * **This function is deprecated: Use `limited_teleport_assets` instead.**
5470
+ *
5471
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
5472
+ * index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
5473
+ * with all fees taken as needed from the asset.
5474
+ *
5475
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5476
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
5477
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
5478
+ * relay to parachain.
5479
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
5480
+ * generally be an `AccountId32` value.
5481
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5482
+ * fee on the `dest` chain.
5483
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
5484
+ * fees.
4312
5485
  *
4313
5486
  * @param {XcmVersionedLocation} dest
4314
5487
  * @param {XcmVersionedLocation} beneficiary
@@ -4340,7 +5513,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4340
5513
  >;
4341
5514
 
4342
5515
  /**
4343
- * See [`Pallet::reserve_transfer_assets`].
5516
+ * Transfer some assets from the local chain to the destination chain through their local,
5517
+ * destination or remote reserve.
5518
+ *
5519
+ * `assets` must have same reserve location and may not be teleportable to `dest`.
5520
+ * - `assets` have local reserve: transfer assets to sovereign account of destination
5521
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
5522
+ * assets to `beneficiary`.
5523
+ * - `assets` have destination reserve: burn local assets and forward a notification to
5524
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
5525
+ * deposit them to `beneficiary`.
5526
+ * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
5527
+ * reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
5528
+ * to mint and deposit reserve-based assets to `beneficiary`.
5529
+ *
5530
+ * **This function is deprecated: Use `limited_reserve_transfer_assets` instead.**
5531
+ *
5532
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
5533
+ * index `fee_asset_item`. The weight limit for fees is not provided and thus is unlimited,
5534
+ * with all fees taken as needed from the asset.
5535
+ *
5536
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5537
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
5538
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
5539
+ * relay to parachain.
5540
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
5541
+ * generally be an `AccountId32` value.
5542
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5543
+ * fee on the `dest` (and possibly reserve) chains.
5544
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
5545
+ * fees.
4344
5546
  *
4345
5547
  * @param {XcmVersionedLocation} dest
4346
5548
  * @param {XcmVersionedLocation} beneficiary
@@ -4372,7 +5574,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4372
5574
  >;
4373
5575
 
4374
5576
  /**
4375
- * See [`Pallet::execute`].
5577
+ * Execute an XCM message from a local, signed, origin.
5578
+ *
5579
+ * An event is deposited indicating whether `msg` could be executed completely or only
5580
+ * partially.
5581
+ *
5582
+ * No more than `max_weight` will be used in its attempted execution. If this is less than
5583
+ * the maximum amount of weight that the message could take to be executed, then no
5584
+ * execution attempt will be made.
4376
5585
  *
4377
5586
  * @param {XcmVersionedXcm} message
4378
5587
  * @param {SpWeightsWeightV2Weight} maxWeight
@@ -4395,7 +5604,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4395
5604
  >;
4396
5605
 
4397
5606
  /**
4398
- * See [`Pallet::force_xcm_version`].
5607
+ * Extoll that a particular destination can be communicated with through a particular
5608
+ * version of XCM.
5609
+ *
5610
+ * - `origin`: Must be an origin specified by AdminOrigin.
5611
+ * - `location`: The destination that is being described.
5612
+ * - `xcm_version`: The latest version of XCM that `location` supports.
4399
5613
  *
4400
5614
  * @param {StagingXcmV4Location} location
4401
5615
  * @param {number} version
@@ -4418,7 +5632,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4418
5632
  >;
4419
5633
 
4420
5634
  /**
4421
- * See [`Pallet::force_default_xcm_version`].
5635
+ * Set a safe XCM version (the version that XCM should be encoded with if the most recent
5636
+ * version a destination can accept is unknown).
5637
+ *
5638
+ * - `origin`: Must be an origin specified by AdminOrigin.
5639
+ * - `maybe_xcm_version`: The default XCM encoding version, or `None` to disable.
4422
5640
  *
4423
5641
  * @param {number | undefined} maybeXcmVersion
4424
5642
  **/
@@ -4437,7 +5655,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4437
5655
  >;
4438
5656
 
4439
5657
  /**
4440
- * See [`Pallet::force_subscribe_version_notify`].
5658
+ * Ask a location to notify us regarding their XCM version and any changes to it.
5659
+ *
5660
+ * - `origin`: Must be an origin specified by AdminOrigin.
5661
+ * - `location`: The location to which we should subscribe for XCM version notifications.
4441
5662
  *
4442
5663
  * @param {XcmVersionedLocation} location
4443
5664
  **/
@@ -4456,7 +5677,12 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4456
5677
  >;
4457
5678
 
4458
5679
  /**
4459
- * See [`Pallet::force_unsubscribe_version_notify`].
5680
+ * Require that a particular destination should no longer notify us regarding any XCM
5681
+ * version changes.
5682
+ *
5683
+ * - `origin`: Must be an origin specified by AdminOrigin.
5684
+ * - `location`: The location to which we are currently subscribed for XCM version
5685
+ * notifications which we no longer desire.
4460
5686
  *
4461
5687
  * @param {XcmVersionedLocation} location
4462
5688
  **/
@@ -4475,7 +5701,36 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4475
5701
  >;
4476
5702
 
4477
5703
  /**
4478
- * See [`Pallet::limited_reserve_transfer_assets`].
5704
+ * Transfer some assets from the local chain to the destination chain through their local,
5705
+ * destination or remote reserve.
5706
+ *
5707
+ * `assets` must have same reserve location and may not be teleportable to `dest`.
5708
+ * - `assets` have local reserve: transfer assets to sovereign account of destination
5709
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
5710
+ * assets to `beneficiary`.
5711
+ * - `assets` have destination reserve: burn local assets and forward a notification to
5712
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
5713
+ * deposit them to `beneficiary`.
5714
+ * - `assets` have remote reserve: burn local assets, forward XCM to reserve chain to move
5715
+ * reserves from this chain's SA to `dest` chain's SA, and forward another XCM to `dest`
5716
+ * to mint and deposit reserve-based assets to `beneficiary`.
5717
+ *
5718
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
5719
+ * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
5720
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
5721
+ * at risk.
5722
+ *
5723
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5724
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
5725
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
5726
+ * relay to parachain.
5727
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
5728
+ * generally be an `AccountId32` value.
5729
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5730
+ * fee on the `dest` (and possibly reserve) chains.
5731
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
5732
+ * fees.
5733
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
4479
5734
  *
4480
5735
  * @param {XcmVersionedLocation} dest
4481
5736
  * @param {XcmVersionedLocation} beneficiary
@@ -4510,7 +5765,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4510
5765
  >;
4511
5766
 
4512
5767
  /**
4513
- * See [`Pallet::limited_teleport_assets`].
5768
+ * Teleport some assets from the local chain to some destination chain.
5769
+ *
5770
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
5771
+ * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
5772
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
5773
+ * at risk.
5774
+ *
5775
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5776
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
5777
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
5778
+ * relay to parachain.
5779
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
5780
+ * generally be an `AccountId32` value.
5781
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5782
+ * fee on the `dest` chain.
5783
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
5784
+ * fees.
5785
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
4514
5786
  *
4515
5787
  * @param {XcmVersionedLocation} dest
4516
5788
  * @param {XcmVersionedLocation} beneficiary
@@ -4545,7 +5817,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4545
5817
  >;
4546
5818
 
4547
5819
  /**
4548
- * See [`Pallet::force_suspension`].
5820
+ * Set or unset the global suspension state of the XCM executor.
5821
+ *
5822
+ * - `origin`: Must be an origin specified by AdminOrigin.
5823
+ * - `suspended`: `true` to suspend, `false` to resume.
4549
5824
  *
4550
5825
  * @param {boolean} suspended
4551
5826
  **/
@@ -4564,7 +5839,39 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4564
5839
  >;
4565
5840
 
4566
5841
  /**
4567
- * See [`Pallet::transfer_assets`].
5842
+ * Transfer some assets from the local chain to the destination chain through their local,
5843
+ * destination or remote reserve, or through teleports.
5844
+ *
5845
+ * Fee payment on the destination side is made from the asset in the `assets` vector of
5846
+ * index `fee_asset_item` (hence referred to as `fees`), up to enough to pay for
5847
+ * `weight_limit` of weight. If more weight is needed than `weight_limit`, then the
5848
+ * operation will fail and the sent assets may be at risk.
5849
+ *
5850
+ * `assets` (excluding `fees`) must have same reserve location or otherwise be teleportable
5851
+ * to `dest`, no limitations imposed on `fees`.
5852
+ * - for local reserve: transfer assets to sovereign account of destination chain and
5853
+ * forward a notification XCM to `dest` to mint and deposit reserve-based assets to
5854
+ * `beneficiary`.
5855
+ * - for destination reserve: burn local assets and forward a notification to `dest` chain
5856
+ * to withdraw the reserve assets from this chain's sovereign account and deposit them
5857
+ * to `beneficiary`.
5858
+ * - for remote reserve: burn local assets, forward XCM to reserve chain to move reserves
5859
+ * from this chain's SA to `dest` chain's SA, and forward another XCM to `dest` to mint
5860
+ * and deposit reserve-based assets to `beneficiary`.
5861
+ * - for teleports: burn local assets and forward XCM to `dest` chain to mint/teleport
5862
+ * assets and deposit them to `beneficiary`.
5863
+ *
5864
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5865
+ * - `dest`: Destination context for the assets. Will typically be `X2(Parent,
5866
+ * Parachain(..))` to send from parachain to parachain, or `X1(Parachain(..))` to send
5867
+ * from relay to parachain.
5868
+ * - `beneficiary`: A beneficiary location for the assets in the context of `dest`. Will
5869
+ * generally be an `AccountId32` value.
5870
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5871
+ * fee on the `dest` (and possibly reserve) chains.
5872
+ * - `fee_asset_item`: The index into `assets` of the item which should be used to pay
5873
+ * fees.
5874
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
4568
5875
  *
4569
5876
  * @param {XcmVersionedLocation} dest
4570
5877
  * @param {XcmVersionedLocation} beneficiary
@@ -4598,6 +5905,122 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4598
5905
  >
4599
5906
  >;
4600
5907
 
5908
+ /**
5909
+ * Claims assets trapped on this pallet because of leftover assets during XCM execution.
5910
+ *
5911
+ * - `origin`: Anyone can call this extrinsic.
5912
+ * - `assets`: The exact assets that were trapped. Use the version to specify what version
5913
+ * was the latest when they were trapped.
5914
+ * - `beneficiary`: The location/account where the claimed assets will be deposited.
5915
+ *
5916
+ * @param {XcmVersionedAssets} assets
5917
+ * @param {XcmVersionedLocation} beneficiary
5918
+ **/
5919
+ claimAssets: GenericTxCall<
5920
+ Rv,
5921
+ (
5922
+ assets: XcmVersionedAssets,
5923
+ beneficiary: XcmVersionedLocation,
5924
+ ) => ChainSubmittableExtrinsic<
5925
+ Rv,
5926
+ {
5927
+ pallet: 'PolkadotXcm';
5928
+ palletCall: {
5929
+ name: 'ClaimAssets';
5930
+ params: { assets: XcmVersionedAssets; beneficiary: XcmVersionedLocation };
5931
+ };
5932
+ }
5933
+ >
5934
+ >;
5935
+
5936
+ /**
5937
+ * Transfer assets from the local chain to the destination chain using explicit transfer
5938
+ * types for assets and fees.
5939
+ *
5940
+ * `assets` must have same reserve location or may be teleportable to `dest`. Caller must
5941
+ * provide the `assets_transfer_type` to be used for `assets`:
5942
+ * - `TransferType::LocalReserve`: transfer assets to sovereign account of destination
5943
+ * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
5944
+ * assets to `beneficiary`.
5945
+ * - `TransferType::DestinationReserve`: burn local assets and forward a notification to
5946
+ * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
5947
+ * deposit them to `beneficiary`.
5948
+ * - `TransferType::RemoteReserve(reserve)`: burn local assets, forward XCM to `reserve`
5949
+ * chain to move reserves from this chain's SA to `dest` chain's SA, and forward another
5950
+ * XCM to `dest` to mint and deposit reserve-based assets to `beneficiary`. Typically
5951
+ * the remote `reserve` is Asset Hub.
5952
+ * - `TransferType::Teleport`: burn local assets and forward XCM to `dest` chain to
5953
+ * mint/teleport assets and deposit them to `beneficiary`.
5954
+ *
5955
+ * On the destination chain, as well as any intermediary hops, `BuyExecution` is used to
5956
+ * buy execution using transferred `assets` identified by `remote_fees_id`.
5957
+ * Make sure enough of the specified `remote_fees_id` asset is included in the given list
5958
+ * of `assets`. `remote_fees_id` should be enough to pay for `weight_limit`. If more weight
5959
+ * is needed than `weight_limit`, then the operation will fail and the sent assets may be
5960
+ * at risk.
5961
+ *
5962
+ * `remote_fees_id` may use different transfer type than rest of `assets` and can be
5963
+ * specified through `fees_transfer_type`.
5964
+ *
5965
+ * The caller needs to specify what should happen to the transferred assets once they reach
5966
+ * the `dest` chain. This is done through the `custom_xcm_on_dest` parameter, which
5967
+ * contains the instructions to execute on `dest` as a final step.
5968
+ * This is usually as simple as:
5969
+ * `Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }])`,
5970
+ * but could be something more exotic like sending the `assets` even further.
5971
+ *
5972
+ * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
5973
+ * - `dest`: Destination context for the assets. Will typically be `[Parent,
5974
+ * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
5975
+ * relay to parachain, or `(parents: 2, (GlobalConsensus(..), ..))` to send from
5976
+ * parachain across a bridge to another ecosystem destination.
5977
+ * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
5978
+ * fee on the `dest` (and possibly reserve) chains.
5979
+ * - `assets_transfer_type`: The XCM `TransferType` used to transfer the `assets`.
5980
+ * - `remote_fees_id`: One of the included `assets` to be be used to pay fees.
5981
+ * - `fees_transfer_type`: The XCM `TransferType` used to transfer the `fees` assets.
5982
+ * - `custom_xcm_on_dest`: The XCM to be executed on `dest` chain as the last step of the
5983
+ * transfer, which also determines what happens to the assets on the destination chain.
5984
+ * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
5985
+ *
5986
+ * @param {XcmVersionedLocation} dest
5987
+ * @param {XcmVersionedAssets} assets
5988
+ * @param {StagingXcmExecutorAssetTransferTransferType} assetsTransferType
5989
+ * @param {XcmVersionedAssetId} remoteFeesId
5990
+ * @param {StagingXcmExecutorAssetTransferTransferType} feesTransferType
5991
+ * @param {XcmVersionedXcm} customXcmOnDest
5992
+ * @param {XcmV3WeightLimit} weightLimit
5993
+ **/
5994
+ transferAssetsUsingTypeAndThen: GenericTxCall<
5995
+ Rv,
5996
+ (
5997
+ dest: XcmVersionedLocation,
5998
+ assets: XcmVersionedAssets,
5999
+ assetsTransferType: StagingXcmExecutorAssetTransferTransferType,
6000
+ remoteFeesId: XcmVersionedAssetId,
6001
+ feesTransferType: StagingXcmExecutorAssetTransferTransferType,
6002
+ customXcmOnDest: XcmVersionedXcm,
6003
+ weightLimit: XcmV3WeightLimit,
6004
+ ) => ChainSubmittableExtrinsic<
6005
+ Rv,
6006
+ {
6007
+ pallet: 'PolkadotXcm';
6008
+ palletCall: {
6009
+ name: 'TransferAssetsUsingTypeAndThen';
6010
+ params: {
6011
+ dest: XcmVersionedLocation;
6012
+ assets: XcmVersionedAssets;
6013
+ assetsTransferType: StagingXcmExecutorAssetTransferTransferType;
6014
+ remoteFeesId: XcmVersionedAssetId;
6015
+ feesTransferType: StagingXcmExecutorAssetTransferTransferType;
6016
+ customXcmOnDest: XcmVersionedXcm;
6017
+ weightLimit: XcmV3WeightLimit;
6018
+ };
6019
+ };
6020
+ }
6021
+ >
6022
+ >;
6023
+
4601
6024
  /**
4602
6025
  * Generic pallet tx call
4603
6026
  **/
@@ -4608,7 +6031,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4608
6031
  **/
4609
6032
  assets: {
4610
6033
  /**
4611
- * See [`Pallet::create`].
6034
+ * Issue a new class of fungible assets from a public origin.
6035
+ *
6036
+ * This new asset class has no assets initially and its owner is the origin.
6037
+ *
6038
+ * The origin must conform to the configured `CreateOrigin` and have sufficient funds free.
6039
+ *
6040
+ * Funds of sender are reserved by `AssetDeposit`.
6041
+ *
6042
+ * Parameters:
6043
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
6044
+ * an existing asset.
6045
+ * - `admin`: The admin of this class of assets. The admin is the initial address of each
6046
+ * member of the asset class's admin team.
6047
+ * - `min_balance`: The minimum balance of this new asset that any single account must
6048
+ * have. If an account's balance is reduced below this, then it collapses to zero.
6049
+ *
6050
+ * Emits `Created` event when successful.
6051
+ *
6052
+ * Weight: `O(1)`
4612
6053
  *
4613
6054
  * @param {bigint} id
4614
6055
  * @param {AccountId20Like} admin
@@ -4633,7 +6074,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4633
6074
  >;
4634
6075
 
4635
6076
  /**
4636
- * See [`Pallet::force_create`].
6077
+ * Issue a new class of fungible assets from a privileged origin.
6078
+ *
6079
+ * This new asset class has no assets initially.
6080
+ *
6081
+ * The origin must conform to `ForceOrigin`.
6082
+ *
6083
+ * Unlike `create`, no funds are reserved.
6084
+ *
6085
+ * - `id`: The identifier of the new asset. This must not be currently in use to identify
6086
+ * an existing asset.
6087
+ * - `owner`: The owner of this class of assets. The owner has full superuser permissions
6088
+ * over this asset, but may later change and configure the permissions using
6089
+ * `transfer_ownership` and `set_team`.
6090
+ * - `min_balance`: The minimum balance of this new asset that any single account must
6091
+ * have. If an account's balance is reduced below this, then it collapses to zero.
6092
+ *
6093
+ * Emits `ForceCreated` event when successful.
6094
+ *
6095
+ * Weight: `O(1)`
4637
6096
  *
4638
6097
  * @param {bigint} id
4639
6098
  * @param {AccountId20Like} owner
@@ -4660,7 +6119,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4660
6119
  >;
4661
6120
 
4662
6121
  /**
4663
- * See [`Pallet::start_destroy`].
6122
+ * Start the process of destroying a fungible asset class.
6123
+ *
6124
+ * `start_destroy` is the first in a series of extrinsics that should be called, to allow
6125
+ * destruction of an asset class.
6126
+ *
6127
+ * The origin must conform to `ForceOrigin` or must be `Signed` by the asset's `owner`.
6128
+ *
6129
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6130
+ * asset.
6131
+ *
6132
+ * The asset class must be frozen before calling `start_destroy`.
4664
6133
  *
4665
6134
  * @param {bigint} id
4666
6135
  **/
@@ -4679,7 +6148,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4679
6148
  >;
4680
6149
 
4681
6150
  /**
4682
- * See [`Pallet::destroy_accounts`].
6151
+ * Destroy all accounts associated with a given asset.
6152
+ *
6153
+ * `destroy_accounts` should only be called after `start_destroy` has been called, and the
6154
+ * asset is in a `Destroying` state.
6155
+ *
6156
+ * Due to weight restrictions, this function may need to be called multiple times to fully
6157
+ * destroy all accounts. It will destroy `RemoveItemsLimit` accounts at a time.
6158
+ *
6159
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6160
+ * asset.
6161
+ *
6162
+ * Each call emits the `Event::DestroyedAccounts` event.
4683
6163
  *
4684
6164
  * @param {bigint} id
4685
6165
  **/
@@ -4698,7 +6178,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4698
6178
  >;
4699
6179
 
4700
6180
  /**
4701
- * See [`Pallet::destroy_approvals`].
6181
+ * Destroy all approvals associated with a given asset up to the max (T::RemoveItemsLimit).
6182
+ *
6183
+ * `destroy_approvals` should only be called after `start_destroy` has been called, and the
6184
+ * asset is in a `Destroying` state.
6185
+ *
6186
+ * Due to weight restrictions, this function may need to be called multiple times to fully
6187
+ * destroy all approvals. It will destroy `RemoveItemsLimit` approvals at a time.
6188
+ *
6189
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6190
+ * asset.
6191
+ *
6192
+ * Each call emits the `Event::DestroyedApprovals` event.
4702
6193
  *
4703
6194
  * @param {bigint} id
4704
6195
  **/
@@ -4717,7 +6208,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4717
6208
  >;
4718
6209
 
4719
6210
  /**
4720
- * See [`Pallet::finish_destroy`].
6211
+ * Complete destroying asset and unreserve currency.
6212
+ *
6213
+ * `finish_destroy` should only be called after `start_destroy` has been called, and the
6214
+ * asset is in a `Destroying` state. All accounts or approvals should be destroyed before
6215
+ * hand.
6216
+ *
6217
+ * - `id`: The identifier of the asset to be destroyed. This must identify an existing
6218
+ * asset.
6219
+ *
6220
+ * Each successful call emits the `Event::Destroyed` event.
4721
6221
  *
4722
6222
  * @param {bigint} id
4723
6223
  **/
@@ -4736,7 +6236,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4736
6236
  >;
4737
6237
 
4738
6238
  /**
4739
- * See [`Pallet::mint`].
6239
+ * Mint assets of a particular class.
6240
+ *
6241
+ * The origin must be Signed and the sender must be the Issuer of the asset `id`.
6242
+ *
6243
+ * - `id`: The identifier of the asset to have some amount minted.
6244
+ * - `beneficiary`: The account to be credited with the minted assets.
6245
+ * - `amount`: The amount of the asset to be minted.
6246
+ *
6247
+ * Emits `Issued` event when successful.
6248
+ *
6249
+ * Weight: `O(1)`
6250
+ * Modes: Pre-existing balance of `beneficiary`; Account pre-existence of `beneficiary`.
4740
6251
  *
4741
6252
  * @param {bigint} id
4742
6253
  * @param {AccountId20Like} beneficiary
@@ -4761,7 +6272,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4761
6272
  >;
4762
6273
 
4763
6274
  /**
4764
- * See [`Pallet::burn`].
6275
+ * Reduce the balance of `who` by as much as possible up to `amount` assets of `id`.
6276
+ *
6277
+ * Origin must be Signed and the sender should be the Manager of the asset `id`.
6278
+ *
6279
+ * Bails with `NoAccount` if the `who` is already dead.
6280
+ *
6281
+ * - `id`: The identifier of the asset to have some amount burned.
6282
+ * - `who`: The account to be debited from.
6283
+ * - `amount`: The maximum amount by which `who`'s balance should be reduced.
6284
+ *
6285
+ * Emits `Burned` with the actual amount burned. If this takes the balance to below the
6286
+ * minimum for the asset, then the amount burned is increased to take it to zero.
6287
+ *
6288
+ * Weight: `O(1)`
6289
+ * Modes: Post-existence of `who`; Pre & post Zombie-status of `who`.
4765
6290
  *
4766
6291
  * @param {bigint} id
4767
6292
  * @param {AccountId20Like} who
@@ -4786,7 +6311,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4786
6311
  >;
4787
6312
 
4788
6313
  /**
4789
- * See [`Pallet::transfer`].
6314
+ * Move some assets from the sender account to another.
6315
+ *
6316
+ * Origin must be Signed.
6317
+ *
6318
+ * - `id`: The identifier of the asset to have some amount transferred.
6319
+ * - `target`: The account to be credited.
6320
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
6321
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
6322
+ * the case that the transfer would otherwise take the sender balance above zero but below
6323
+ * the minimum balance. Must be greater than zero.
6324
+ *
6325
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6326
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6327
+ * to zero.
6328
+ *
6329
+ * Weight: `O(1)`
6330
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
6331
+ * `target`.
4790
6332
  *
4791
6333
  * @param {bigint} id
4792
6334
  * @param {AccountId20Like} target
@@ -4811,7 +6353,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4811
6353
  >;
4812
6354
 
4813
6355
  /**
4814
- * See [`Pallet::transfer_keep_alive`].
6356
+ * Move some assets from the sender account to another, keeping the sender account alive.
6357
+ *
6358
+ * Origin must be Signed.
6359
+ *
6360
+ * - `id`: The identifier of the asset to have some amount transferred.
6361
+ * - `target`: The account to be credited.
6362
+ * - `amount`: The amount by which the sender's balance of assets should be reduced and
6363
+ * `target`'s balance increased. The amount actually transferred may be slightly greater in
6364
+ * the case that the transfer would otherwise take the sender balance above zero but below
6365
+ * the minimum balance. Must be greater than zero.
6366
+ *
6367
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6368
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6369
+ * to zero.
6370
+ *
6371
+ * Weight: `O(1)`
6372
+ * Modes: Pre-existence of `target`; Post-existence of sender; Account pre-existence of
6373
+ * `target`.
4815
6374
  *
4816
6375
  * @param {bigint} id
4817
6376
  * @param {AccountId20Like} target
@@ -4836,7 +6395,25 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4836
6395
  >;
4837
6396
 
4838
6397
  /**
4839
- * See [`Pallet::force_transfer`].
6398
+ * Move some assets from one account to another.
6399
+ *
6400
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
6401
+ *
6402
+ * - `id`: The identifier of the asset to have some amount transferred.
6403
+ * - `source`: The account to be debited.
6404
+ * - `dest`: The account to be credited.
6405
+ * - `amount`: The amount by which the `source`'s balance of assets should be reduced and
6406
+ * `dest`'s balance increased. The amount actually transferred may be slightly greater in
6407
+ * the case that the transfer would otherwise take the `source` balance above zero but
6408
+ * below the minimum balance. Must be greater than zero.
6409
+ *
6410
+ * Emits `Transferred` with the actual amount transferred. If this takes the source balance
6411
+ * to below the minimum for the asset, then the amount transferred is increased to take it
6412
+ * to zero.
6413
+ *
6414
+ * Weight: `O(1)`
6415
+ * Modes: Pre-existence of `dest`; Post-existence of `source`; Account pre-existence of
6416
+ * `dest`.
4840
6417
  *
4841
6418
  * @param {bigint} id
4842
6419
  * @param {AccountId20Like} source
@@ -4863,7 +6440,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4863
6440
  >;
4864
6441
 
4865
6442
  /**
4866
- * See [`Pallet::freeze`].
6443
+ * Disallow further unprivileged transfers of an asset `id` from an account `who`. `who`
6444
+ * must already exist as an entry in `Account`s of the asset. If you want to freeze an
6445
+ * account that does not have an entry, use `touch_other` first.
6446
+ *
6447
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
6448
+ *
6449
+ * - `id`: The identifier of the asset to be frozen.
6450
+ * - `who`: The account to be frozen.
6451
+ *
6452
+ * Emits `Frozen`.
6453
+ *
6454
+ * Weight: `O(1)`
4867
6455
  *
4868
6456
  * @param {bigint} id
4869
6457
  * @param {AccountId20Like} who
@@ -4886,7 +6474,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4886
6474
  >;
4887
6475
 
4888
6476
  /**
4889
- * See [`Pallet::thaw`].
6477
+ * Allow unprivileged transfers to and from an account again.
6478
+ *
6479
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
6480
+ *
6481
+ * - `id`: The identifier of the asset to be frozen.
6482
+ * - `who`: The account to be unfrozen.
6483
+ *
6484
+ * Emits `Thawed`.
6485
+ *
6486
+ * Weight: `O(1)`
4890
6487
  *
4891
6488
  * @param {bigint} id
4892
6489
  * @param {AccountId20Like} who
@@ -4909,7 +6506,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4909
6506
  >;
4910
6507
 
4911
6508
  /**
4912
- * See [`Pallet::freeze_asset`].
6509
+ * Disallow further unprivileged transfers for the asset class.
6510
+ *
6511
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
6512
+ *
6513
+ * - `id`: The identifier of the asset to be frozen.
6514
+ *
6515
+ * Emits `Frozen`.
6516
+ *
6517
+ * Weight: `O(1)`
4913
6518
  *
4914
6519
  * @param {bigint} id
4915
6520
  **/
@@ -4928,7 +6533,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4928
6533
  >;
4929
6534
 
4930
6535
  /**
4931
- * See [`Pallet::thaw_asset`].
6536
+ * Allow unprivileged transfers for the asset again.
6537
+ *
6538
+ * Origin must be Signed and the sender should be the Admin of the asset `id`.
6539
+ *
6540
+ * - `id`: The identifier of the asset to be thawed.
6541
+ *
6542
+ * Emits `Thawed`.
6543
+ *
6544
+ * Weight: `O(1)`
4932
6545
  *
4933
6546
  * @param {bigint} id
4934
6547
  **/
@@ -4947,7 +6560,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4947
6560
  >;
4948
6561
 
4949
6562
  /**
4950
- * See [`Pallet::transfer_ownership`].
6563
+ * Change the Owner of an asset.
6564
+ *
6565
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
6566
+ *
6567
+ * - `id`: The identifier of the asset.
6568
+ * - `owner`: The new Owner of this asset.
6569
+ *
6570
+ * Emits `OwnerChanged`.
6571
+ *
6572
+ * Weight: `O(1)`
4951
6573
  *
4952
6574
  * @param {bigint} id
4953
6575
  * @param {AccountId20Like} owner
@@ -4970,7 +6592,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4970
6592
  >;
4971
6593
 
4972
6594
  /**
4973
- * See [`Pallet::set_team`].
6595
+ * Change the Issuer, Admin and Freezer of an asset.
6596
+ *
6597
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
6598
+ *
6599
+ * - `id`: The identifier of the asset to be frozen.
6600
+ * - `issuer`: The new Issuer of this asset.
6601
+ * - `admin`: The new Admin of this asset.
6602
+ * - `freezer`: The new Freezer of this asset.
6603
+ *
6604
+ * Emits `TeamChanged`.
6605
+ *
6606
+ * Weight: `O(1)`
4974
6607
  *
4975
6608
  * @param {bigint} id
4976
6609
  * @param {AccountId20Like} issuer
@@ -4997,7 +6630,22 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
4997
6630
  >;
4998
6631
 
4999
6632
  /**
5000
- * See [`Pallet::set_metadata`].
6633
+ * Set the metadata for an asset.
6634
+ *
6635
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
6636
+ *
6637
+ * Funds of sender are reserved according to the formula:
6638
+ * `MetadataDepositBase + MetadataDepositPerByte * (name.len + symbol.len)` taking into
6639
+ * account any already reserved funds.
6640
+ *
6641
+ * - `id`: The identifier of the asset to update.
6642
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
6643
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
6644
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
6645
+ *
6646
+ * Emits `MetadataSet`.
6647
+ *
6648
+ * Weight: `O(1)`
5001
6649
  *
5002
6650
  * @param {bigint} id
5003
6651
  * @param {BytesLike} name
@@ -5024,7 +6672,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5024
6672
  >;
5025
6673
 
5026
6674
  /**
5027
- * See [`Pallet::clear_metadata`].
6675
+ * Clear the metadata for an asset.
6676
+ *
6677
+ * Origin must be Signed and the sender should be the Owner of the asset `id`.
6678
+ *
6679
+ * Any deposit is freed for the asset owner.
6680
+ *
6681
+ * - `id`: The identifier of the asset to clear.
6682
+ *
6683
+ * Emits `MetadataCleared`.
6684
+ *
6685
+ * Weight: `O(1)`
5028
6686
  *
5029
6687
  * @param {bigint} id
5030
6688
  **/
@@ -5043,7 +6701,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5043
6701
  >;
5044
6702
 
5045
6703
  /**
5046
- * See [`Pallet::force_set_metadata`].
6704
+ * Force the metadata for an asset to some value.
6705
+ *
6706
+ * Origin must be ForceOrigin.
6707
+ *
6708
+ * Any deposit is left alone.
6709
+ *
6710
+ * - `id`: The identifier of the asset to update.
6711
+ * - `name`: The user friendly name of this asset. Limited in length by `StringLimit`.
6712
+ * - `symbol`: The exchange symbol for this asset. Limited in length by `StringLimit`.
6713
+ * - `decimals`: The number of decimals this asset uses to represent one unit.
6714
+ *
6715
+ * Emits `MetadataSet`.
6716
+ *
6717
+ * Weight: `O(N + S)` where N and S are the length of the name and symbol respectively.
5047
6718
  *
5048
6719
  * @param {bigint} id
5049
6720
  * @param {BytesLike} name
@@ -5072,7 +6743,17 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5072
6743
  >;
5073
6744
 
5074
6745
  /**
5075
- * See [`Pallet::force_clear_metadata`].
6746
+ * Clear the metadata for an asset.
6747
+ *
6748
+ * Origin must be ForceOrigin.
6749
+ *
6750
+ * Any deposit is returned.
6751
+ *
6752
+ * - `id`: The identifier of the asset to clear.
6753
+ *
6754
+ * Emits `MetadataCleared`.
6755
+ *
6756
+ * Weight: `O(1)`
5076
6757
  *
5077
6758
  * @param {bigint} id
5078
6759
  **/
@@ -5091,7 +6772,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5091
6772
  >;
5092
6773
 
5093
6774
  /**
5094
- * See [`Pallet::force_asset_status`].
6775
+ * Alter the attributes of a given asset.
6776
+ *
6777
+ * Origin must be `ForceOrigin`.
6778
+ *
6779
+ * - `id`: The identifier of the asset.
6780
+ * - `owner`: The new Owner of this asset.
6781
+ * - `issuer`: The new Issuer of this asset.
6782
+ * - `admin`: The new Admin of this asset.
6783
+ * - `freezer`: The new Freezer of this asset.
6784
+ * - `min_balance`: The minimum balance of this new asset that any single account must
6785
+ * have. If an account's balance is reduced below this, then it collapses to zero.
6786
+ * - `is_sufficient`: Whether a non-zero balance of this asset is deposit of sufficient
6787
+ * value to account for the state bloat associated with its balance storage. If set to
6788
+ * `true`, then non-zero balances may be stored without a `consumer` reference (and thus
6789
+ * an ED in the Balances pallet or whatever else is used to control user-account state
6790
+ * growth).
6791
+ * - `is_frozen`: Whether this asset class is frozen except for permissioned/admin
6792
+ * instructions.
6793
+ *
6794
+ * Emits `AssetStatusChanged` with the identity of the asset.
6795
+ *
6796
+ * Weight: `O(1)`
5095
6797
  *
5096
6798
  * @param {bigint} id
5097
6799
  * @param {AccountId20Like} owner
@@ -5135,7 +6837,26 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5135
6837
  >;
5136
6838
 
5137
6839
  /**
5138
- * See [`Pallet::approve_transfer`].
6840
+ * Approve an amount of asset for transfer by a delegated third-party account.
6841
+ *
6842
+ * Origin must be Signed.
6843
+ *
6844
+ * Ensures that `ApprovalDeposit` worth of `Currency` is reserved from signing account
6845
+ * for the purpose of holding the approval. If some non-zero amount of assets is already
6846
+ * approved from signing account to `delegate`, then it is topped up or unreserved to
6847
+ * meet the right value.
6848
+ *
6849
+ * NOTE: The signing account does not need to own `amount` of assets at the point of
6850
+ * making this call.
6851
+ *
6852
+ * - `id`: The identifier of the asset.
6853
+ * - `delegate`: The account to delegate permission to transfer asset.
6854
+ * - `amount`: The amount of asset that may be transferred by `delegate`. If there is
6855
+ * already an approval in place, then this acts additively.
6856
+ *
6857
+ * Emits `ApprovedTransfer` on success.
6858
+ *
6859
+ * Weight: `O(1)`
5139
6860
  *
5140
6861
  * @param {bigint} id
5141
6862
  * @param {AccountId20Like} delegate
@@ -5160,7 +6881,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5160
6881
  >;
5161
6882
 
5162
6883
  /**
5163
- * See [`Pallet::cancel_approval`].
6884
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
6885
+ *
6886
+ * Origin must be Signed and there must be an approval in place between signer and
6887
+ * `delegate`.
6888
+ *
6889
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
6890
+ *
6891
+ * - `id`: The identifier of the asset.
6892
+ * - `delegate`: The account delegated permission to transfer asset.
6893
+ *
6894
+ * Emits `ApprovalCancelled` on success.
6895
+ *
6896
+ * Weight: `O(1)`
5164
6897
  *
5165
6898
  * @param {bigint} id
5166
6899
  * @param {AccountId20Like} delegate
@@ -5183,7 +6916,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5183
6916
  >;
5184
6917
 
5185
6918
  /**
5186
- * See [`Pallet::force_cancel_approval`].
6919
+ * Cancel all of some asset approved for delegated transfer by a third-party account.
6920
+ *
6921
+ * Origin must be either ForceOrigin or Signed origin with the signer being the Admin
6922
+ * account of the asset `id`.
6923
+ *
6924
+ * Unreserves any deposit previously reserved by `approve_transfer` for the approval.
6925
+ *
6926
+ * - `id`: The identifier of the asset.
6927
+ * - `delegate`: The account delegated permission to transfer asset.
6928
+ *
6929
+ * Emits `ApprovalCancelled` on success.
6930
+ *
6931
+ * Weight: `O(1)`
5187
6932
  *
5188
6933
  * @param {bigint} id
5189
6934
  * @param {AccountId20Like} owner
@@ -5208,7 +6953,24 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5208
6953
  >;
5209
6954
 
5210
6955
  /**
5211
- * See [`Pallet::transfer_approved`].
6956
+ * Transfer some asset balance from a previously delegated account to some third-party
6957
+ * account.
6958
+ *
6959
+ * Origin must be Signed and there must be an approval in place by the `owner` to the
6960
+ * signer.
6961
+ *
6962
+ * If the entire amount approved for transfer is transferred, then any deposit previously
6963
+ * reserved by `approve_transfer` is unreserved.
6964
+ *
6965
+ * - `id`: The identifier of the asset.
6966
+ * - `owner`: The account which previously approved for a transfer of at least `amount` and
6967
+ * from which the asset balance will be withdrawn.
6968
+ * - `destination`: The account to which the asset balance of `amount` will be transferred.
6969
+ * - `amount`: The amount of assets to transfer.
6970
+ *
6971
+ * Emits `TransferredApproved` on success.
6972
+ *
6973
+ * Weight: `O(1)`
5212
6974
  *
5213
6975
  * @param {bigint} id
5214
6976
  * @param {AccountId20Like} owner
@@ -5235,7 +6997,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5235
6997
  >;
5236
6998
 
5237
6999
  /**
5238
- * See [`Pallet::touch`].
7000
+ * Create an asset account for non-provider assets.
7001
+ *
7002
+ * A deposit will be taken from the signer account.
7003
+ *
7004
+ * - `origin`: Must be Signed; the signer account must have sufficient funds for a deposit
7005
+ * to be taken.
7006
+ * - `id`: The identifier of the asset for the account to be created.
7007
+ *
7008
+ * Emits `Touched` event when successful.
5239
7009
  *
5240
7010
  * @param {bigint} id
5241
7011
  **/
@@ -5254,7 +7024,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5254
7024
  >;
5255
7025
 
5256
7026
  /**
5257
- * See [`Pallet::refund`].
7027
+ * Return the deposit (if any) of an asset account or a consumer reference (if any) of an
7028
+ * account.
7029
+ *
7030
+ * The origin must be Signed.
7031
+ *
7032
+ * - `id`: The identifier of the asset for which the caller would like the deposit
7033
+ * refunded.
7034
+ * - `allow_burn`: If `true` then assets may be destroyed in order to complete the refund.
7035
+ *
7036
+ * Emits `Refunded` event when successful.
5258
7037
  *
5259
7038
  * @param {bigint} id
5260
7039
  * @param {boolean} allowBurn
@@ -5277,7 +7056,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5277
7056
  >;
5278
7057
 
5279
7058
  /**
5280
- * See [`Pallet::set_min_balance`].
7059
+ * Sets the minimum balance of an asset.
7060
+ *
7061
+ * Only works if there aren't any accounts that are holding the asset or if
7062
+ * the new value of `min_balance` is less than the old one.
7063
+ *
7064
+ * Origin must be Signed and the sender has to be the Owner of the
7065
+ * asset `id`.
7066
+ *
7067
+ * - `id`: The identifier of the asset.
7068
+ * - `min_balance`: The new value of `min_balance`.
7069
+ *
7070
+ * Emits `AssetMinBalanceChanged` event when successful.
5281
7071
  *
5282
7072
  * @param {bigint} id
5283
7073
  * @param {bigint} minBalance
@@ -5300,7 +7090,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5300
7090
  >;
5301
7091
 
5302
7092
  /**
5303
- * See [`Pallet::touch_other`].
7093
+ * Create an asset account for `who`.
7094
+ *
7095
+ * A deposit will be taken from the signer account.
7096
+ *
7097
+ * - `origin`: Must be Signed by `Freezer` or `Admin` of the asset `id`; the signer account
7098
+ * must have sufficient funds for a deposit to be taken.
7099
+ * - `id`: The identifier of the asset for the account to be created.
7100
+ * - `who`: The account to be created.
7101
+ *
7102
+ * Emits `Touched` event when successful.
5304
7103
  *
5305
7104
  * @param {bigint} id
5306
7105
  * @param {AccountId20Like} who
@@ -5323,7 +7122,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5323
7122
  >;
5324
7123
 
5325
7124
  /**
5326
- * See [`Pallet::refund_other`].
7125
+ * Return the deposit (if any) of a target asset account. Useful if you are the depositor.
7126
+ *
7127
+ * The origin must be Signed and either the account owner, depositor, or asset `Admin`. In
7128
+ * order to burn a non-zero balance of the asset, the caller must be the account and should
7129
+ * use `refund`.
7130
+ *
7131
+ * - `id`: The identifier of the asset for the account holding a deposit.
7132
+ * - `who`: The account to refund.
7133
+ *
7134
+ * Emits `Refunded` event when successful.
5327
7135
  *
5328
7136
  * @param {bigint} id
5329
7137
  * @param {AccountId20Like} who
@@ -5346,7 +7154,16 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5346
7154
  >;
5347
7155
 
5348
7156
  /**
5349
- * See [`Pallet::block`].
7157
+ * Disallow further unprivileged transfers of an asset `id` to and from an account `who`.
7158
+ *
7159
+ * Origin must be Signed and the sender should be the Freezer of the asset `id`.
7160
+ *
7161
+ * - `id`: The identifier of the account's asset.
7162
+ * - `who`: The account to be unblocked.
7163
+ *
7164
+ * Emits `Blocked`.
7165
+ *
7166
+ * Weight: `O(1)`
5350
7167
  *
5351
7168
  * @param {bigint} id
5352
7169
  * @param {AccountId20Like} who
@@ -5378,7 +7195,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5378
7195
  **/
5379
7196
  assetManager: {
5380
7197
  /**
5381
- * See [`Pallet::register_foreign_asset`].
7198
+ * Register new asset with the asset manager
5382
7199
  *
5383
7200
  * @param {MoonbeamRuntimeXcmConfigAssetType} asset
5384
7201
  * @param {MoonbeamRuntimeAssetConfigAssetRegistrarMetadata} metadata
@@ -5410,7 +7227,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5410
7227
  >;
5411
7228
 
5412
7229
  /**
5413
- * See [`Pallet::set_asset_units_per_second`].
7230
+ * Change the amount of units we are charging per execution second
7231
+ * for a given ForeignAssetType
5414
7232
  *
5415
7233
  * @param {MoonbeamRuntimeXcmConfigAssetType} assetType
5416
7234
  * @param {bigint} unitsPerSecond
@@ -5439,7 +7257,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5439
7257
  >;
5440
7258
 
5441
7259
  /**
5442
- * See [`Pallet::change_existing_asset_type`].
7260
+ * Change the xcm type mapping for a given assetId
7261
+ * We also change this if the previous units per second where pointing at the old
7262
+ * assetType
5443
7263
  *
5444
7264
  * @param {bigint} assetId
5445
7265
  * @param {MoonbeamRuntimeXcmConfigAssetType} newAssetType
@@ -5464,7 +7284,6 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5464
7284
  >;
5465
7285
 
5466
7286
  /**
5467
- * See [`Pallet::remove_supported_asset`].
5468
7287
  *
5469
7288
  * @param {MoonbeamRuntimeXcmConfigAssetType} assetType
5470
7289
  * @param {number} numAssetsWeightHint
@@ -5487,7 +7306,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5487
7306
  >;
5488
7307
 
5489
7308
  /**
5490
- * See [`Pallet::remove_existing_asset_type`].
7309
+ * Remove a given assetId -> assetType association
5491
7310
  *
5492
7311
  * @param {bigint} assetId
5493
7312
  * @param {number} numAssetsWeightHint
@@ -5510,7 +7329,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5510
7329
  >;
5511
7330
 
5512
7331
  /**
5513
- * See [`Pallet::destroy_foreign_asset`].
7332
+ * Destroy a given foreign assetId
7333
+ * The weight in this case is the one returned by the trait
7334
+ * plus the db writes and reads from removing all the associated
7335
+ * data
5514
7336
  *
5515
7337
  * @param {bigint} assetId
5516
7338
  * @param {number} numAssetsWeightHint
@@ -5542,7 +7364,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5542
7364
  **/
5543
7365
  xTokens: {
5544
7366
  /**
5545
- * See [`Pallet::transfer`].
7367
+ * Transfer native currencies.
7368
+ *
7369
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7370
+ * chain, and it would be charged from the transferred assets. If set
7371
+ * below requirements, the execution may fail and assets wouldn't be
7372
+ * received.
7373
+ *
7374
+ * It's a no-op if any error on local XCM execution or message sending.
7375
+ * Note sending assets out per se doesn't guarantee they would be
7376
+ * received. Receiving depends on if the XCM message could be delivered
7377
+ * by the network, and if the receiving chain would handle
7378
+ * messages correctly.
5546
7379
  *
5547
7380
  * @param {MoonbeamRuntimeXcmConfigCurrencyId} currencyId
5548
7381
  * @param {bigint} amount
@@ -5574,7 +7407,18 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5574
7407
  >;
5575
7408
 
5576
7409
  /**
5577
- * See [`Pallet::transfer_multiasset`].
7410
+ * Transfer `Asset`.
7411
+ *
7412
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7413
+ * chain, and it would be charged from the transferred assets. If set
7414
+ * below requirements, the execution may fail and assets wouldn't be
7415
+ * received.
7416
+ *
7417
+ * It's a no-op if any error on local XCM execution or message sending.
7418
+ * Note sending assets out per se doesn't guarantee they would be
7419
+ * received. Receiving depends on if the XCM message could be delivered
7420
+ * by the network, and if the receiving chain would handle
7421
+ * messages correctly.
5578
7422
  *
5579
7423
  * @param {XcmVersionedAsset} asset
5580
7424
  * @param {XcmVersionedLocation} dest
@@ -5599,7 +7443,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5599
7443
  >;
5600
7444
 
5601
7445
  /**
5602
- * See [`Pallet::transfer_with_fee`].
7446
+ * Transfer native currencies specifying the fee and amount as
7447
+ * separate.
7448
+ *
7449
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7450
+ * chain, and it would be charged from the transferred assets. If set
7451
+ * below requirements, the execution may fail and assets wouldn't be
7452
+ * received.
7453
+ *
7454
+ * `fee` is the amount to be spent to pay for execution in destination
7455
+ * chain. Both fee and amount will be subtracted form the callers
7456
+ * balance.
7457
+ *
7458
+ * If `fee` is not high enough to cover for the execution costs in the
7459
+ * destination chain, then the assets will be trapped in the
7460
+ * destination chain
7461
+ *
7462
+ * It's a no-op if any error on local XCM execution or message sending.
7463
+ * Note sending assets out per se doesn't guarantee they would be
7464
+ * received. Receiving depends on if the XCM message could be delivered
7465
+ * by the network, and if the receiving chain would handle
7466
+ * messages correctly.
5603
7467
  *
5604
7468
  * @param {MoonbeamRuntimeXcmConfigCurrencyId} currencyId
5605
7469
  * @param {bigint} amount
@@ -5634,7 +7498,27 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5634
7498
  >;
5635
7499
 
5636
7500
  /**
5637
- * See [`Pallet::transfer_multiasset_with_fee`].
7501
+ * Transfer `Asset` specifying the fee and amount as separate.
7502
+ *
7503
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7504
+ * chain, and it would be charged from the transferred assets. If set
7505
+ * below requirements, the execution may fail and assets wouldn't be
7506
+ * received.
7507
+ *
7508
+ * `fee` is the Asset to be spent to pay for execution in
7509
+ * destination chain. Both fee and amount will be subtracted form the
7510
+ * callers balance For now we only accept fee and asset having the same
7511
+ * `Location` id.
7512
+ *
7513
+ * If `fee` is not high enough to cover for the execution costs in the
7514
+ * destination chain, then the assets will be trapped in the
7515
+ * destination chain
7516
+ *
7517
+ * It's a no-op if any error on local XCM execution or message sending.
7518
+ * Note sending assets out per se doesn't guarantee they would be
7519
+ * received. Receiving depends on if the XCM message could be delivered
7520
+ * by the network, and if the receiving chain would handle
7521
+ * messages correctly.
5638
7522
  *
5639
7523
  * @param {XcmVersionedAsset} asset
5640
7524
  * @param {XcmVersionedAsset} fee
@@ -5666,7 +7550,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5666
7550
  >;
5667
7551
 
5668
7552
  /**
5669
- * See [`Pallet::transfer_multicurrencies`].
7553
+ * Transfer several currencies specifying the item to be used as fee
7554
+ *
7555
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7556
+ * chain, and it would be charged from the transferred assets. If set
7557
+ * below requirements, the execution may fail and assets wouldn't be
7558
+ * received.
7559
+ *
7560
+ * `fee_item` is index of the currencies tuple that we want to use for
7561
+ * payment
7562
+ *
7563
+ * It's a no-op if any error on local XCM execution or message sending.
7564
+ * Note sending assets out per se doesn't guarantee they would be
7565
+ * received. Receiving depends on if the XCM message could be delivered
7566
+ * by the network, and if the receiving chain would handle
7567
+ * messages correctly.
5670
7568
  *
5671
7569
  * @param {Array<[MoonbeamRuntimeXcmConfigCurrencyId, bigint]>} currencies
5672
7570
  * @param {number} feeItem
@@ -5698,7 +7596,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5698
7596
  >;
5699
7597
 
5700
7598
  /**
5701
- * See [`Pallet::transfer_multiassets`].
7599
+ * Transfer several `Asset` specifying the item to be used as fee
7600
+ *
7601
+ * `dest_weight_limit` is the weight for XCM execution on the dest
7602
+ * chain, and it would be charged from the transferred assets. If set
7603
+ * below requirements, the execution may fail and assets wouldn't be
7604
+ * received.
7605
+ *
7606
+ * `fee_item` is index of the Assets that we want to use for
7607
+ * payment
7608
+ *
7609
+ * It's a no-op if any error on local XCM execution or message sending.
7610
+ * Note sending assets out per se doesn't guarantee they would be
7611
+ * received. Receiving depends on if the XCM message could be delivered
7612
+ * by the network, and if the receiving chain would handle
7613
+ * messages correctly.
5702
7614
  *
5703
7615
  * @param {XcmVersionedAssets} assets
5704
7616
  * @param {number} feeItem
@@ -5739,7 +7651,14 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5739
7651
  **/
5740
7652
  xcmTransactor: {
5741
7653
  /**
5742
- * See [`Pallet::register`].
7654
+ * Register a derivative index for an account id. Dispatchable by
7655
+ * DerivativeAddressRegistrationOrigin
7656
+ *
7657
+ * We do not store the derivative address, but only the index. We do not need to store
7658
+ * the derivative address to issue calls, only the index is enough
7659
+ *
7660
+ * For now an index is registered for all possible destinations and not per-destination.
7661
+ * We can change this in the future although it would just make things more complicated
5743
7662
  *
5744
7663
  * @param {AccountId20Like} who
5745
7664
  * @param {number} index
@@ -5762,7 +7681,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5762
7681
  >;
5763
7682
 
5764
7683
  /**
5765
- * See [`Pallet::deregister`].
7684
+ * De-Register a derivative index. This prevents an account to use a derivative address
7685
+ * (represented by an index) from our of our sovereign accounts anymore
5766
7686
  *
5767
7687
  * @param {number} index
5768
7688
  **/
@@ -5781,7 +7701,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5781
7701
  >;
5782
7702
 
5783
7703
  /**
5784
- * See [`Pallet::transact_through_derivative`].
7704
+ * Transact the inner call through a derivative account in a destination chain,
7705
+ * using 'fee_location' to pay for the fees. This fee_location is given as a multilocation
7706
+ *
7707
+ * The caller needs to have the index registered in this pallet. The fee multiasset needs
7708
+ * to be a reserve asset for the destination transactor::multilocation.
5785
7709
  *
5786
7710
  * @param {MoonbeamRuntimeXcmConfigTransactors} dest
5787
7711
  * @param {number} index
@@ -5819,7 +7743,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5819
7743
  >;
5820
7744
 
5821
7745
  /**
5822
- * See [`Pallet::transact_through_sovereign`].
7746
+ * Transact the call through the sovereign account in a destination chain,
7747
+ * 'fee_payer' pays for the fee
7748
+ *
7749
+ * SovereignAccountDispatcherOrigin callable only
5823
7750
  *
5824
7751
  * @param {XcmVersionedLocation} dest
5825
7752
  * @param {AccountId20Like | undefined} feePayer
@@ -5860,7 +7787,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5860
7787
  >;
5861
7788
 
5862
7789
  /**
5863
- * See [`Pallet::set_transact_info`].
7790
+ * Change the transact info of a location
5864
7791
  *
5865
7792
  * @param {XcmVersionedLocation} location
5866
7793
  * @param {SpWeightsWeightV2Weight} transactExtraWeight
@@ -5892,7 +7819,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5892
7819
  >;
5893
7820
 
5894
7821
  /**
5895
- * See [`Pallet::remove_transact_info`].
7822
+ * Remove the transact info of a location
5896
7823
  *
5897
7824
  * @param {XcmVersionedLocation} location
5898
7825
  **/
@@ -5911,7 +7838,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5911
7838
  >;
5912
7839
 
5913
7840
  /**
5914
- * See [`Pallet::transact_through_signed`].
7841
+ * Transact the call through the a signed origin in this chain
7842
+ * that should be converted to a transaction dispatch account in the destination chain
7843
+ * by any method implemented in the destination chains runtime
7844
+ *
7845
+ * This time we are giving the currency as a currencyId instead of multilocation
5915
7846
  *
5916
7847
  * @param {XcmVersionedLocation} dest
5917
7848
  * @param {PalletXcmTransactorCurrencyPayment} fee
@@ -5946,7 +7877,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5946
7877
  >;
5947
7878
 
5948
7879
  /**
5949
- * See [`Pallet::set_fee_per_second`].
7880
+ * Set the fee per second of an asset on its reserve chain
5950
7881
  *
5951
7882
  * @param {XcmVersionedLocation} assetLocation
5952
7883
  * @param {bigint} feePerSecond
@@ -5969,7 +7900,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5969
7900
  >;
5970
7901
 
5971
7902
  /**
5972
- * See [`Pallet::remove_fee_per_second`].
7903
+ * Remove the fee per second of an asset on its reserve chain
5973
7904
  *
5974
7905
  * @param {XcmVersionedLocation} assetLocation
5975
7906
  **/
@@ -5988,7 +7919,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
5988
7919
  >;
5989
7920
 
5990
7921
  /**
5991
- * See [`Pallet::hrmp_manage`].
7922
+ * Manage HRMP operations
5992
7923
  *
5993
7924
  * @param {PalletXcmTransactorHrmpOperation} action
5994
7925
  * @param {PalletXcmTransactorCurrencyPayment} fee
@@ -6026,7 +7957,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6026
7957
  **/
6027
7958
  ethereumXcm: {
6028
7959
  /**
6029
- * See `Pallet::transact`.
7960
+ * Xcm Transact an Ethereum transaction.
7961
+ * Weight: Gas limit plus the db read involving the suspension check
6030
7962
  *
6031
7963
  * @param {XcmPrimitivesEthereumXcmEthereumXcmTransaction} xcmTransaction
6032
7964
  **/
@@ -6045,7 +7977,8 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6045
7977
  >;
6046
7978
 
6047
7979
  /**
6048
- * See `Pallet::transact_through_proxy`.
7980
+ * Xcm Transact an Ethereum transaction through proxy.
7981
+ * Weight: Gas limit plus the db reads involving the suspension and proxy checks
6049
7982
  *
6050
7983
  * @param {H160} transactAs
6051
7984
  * @param {XcmPrimitivesEthereumXcmEthereumXcmTransaction} xcmTransaction
@@ -6068,7 +8001,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6068
8001
  >;
6069
8002
 
6070
8003
  /**
6071
- * See `Pallet::suspend_ethereum_xcm_execution`.
8004
+ * Suspends all Ethereum executions from XCM.
8005
+ *
8006
+ * - `origin`: Must pass `ControllerOrigin`.
6072
8007
  *
6073
8008
  **/
6074
8009
  suspendEthereumXcmExecution: GenericTxCall<
@@ -6085,7 +8020,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6085
8020
  >;
6086
8021
 
6087
8022
  /**
6088
- * See `Pallet::resume_ethereum_xcm_execution`.
8023
+ * Resumes all Ethereum executions from XCM.
8024
+ *
8025
+ * - `origin`: Must pass `ControllerOrigin`.
6089
8026
  *
6090
8027
  **/
6091
8028
  resumeEthereumXcmExecution: GenericTxCall<
@@ -6101,6 +8038,37 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6101
8038
  >
6102
8039
  >;
6103
8040
 
8041
+ /**
8042
+ * Xcm Transact an Ethereum transaction, but allow to force the caller and create address.
8043
+ * This call should be restricted (callable only by the runtime or governance).
8044
+ * Weight: Gas limit plus the db reads involving the suspension and proxy checks
8045
+ *
8046
+ * @param {H160} transactAs
8047
+ * @param {XcmPrimitivesEthereumXcmEthereumXcmTransaction} xcmTransaction
8048
+ * @param {H160 | undefined} forceCreateAddress
8049
+ **/
8050
+ forceTransactAs: GenericTxCall<
8051
+ Rv,
8052
+ (
8053
+ transactAs: H160,
8054
+ xcmTransaction: XcmPrimitivesEthereumXcmEthereumXcmTransaction,
8055
+ forceCreateAddress: H160 | undefined,
8056
+ ) => ChainSubmittableExtrinsic<
8057
+ Rv,
8058
+ {
8059
+ pallet: 'EthereumXcm';
8060
+ palletCall: {
8061
+ name: 'ForceTransactAs';
8062
+ params: {
8063
+ transactAs: H160;
8064
+ xcmTransaction: XcmPrimitivesEthereumXcmEthereumXcmTransaction;
8065
+ forceCreateAddress: H160 | undefined;
8066
+ };
8067
+ };
8068
+ }
8069
+ >
8070
+ >;
8071
+
6104
8072
  /**
6105
8073
  * Generic pallet tx call
6106
8074
  **/
@@ -6111,7 +8079,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6111
8079
  **/
6112
8080
  messageQueue: {
6113
8081
  /**
6114
- * See [`Pallet::reap_page`].
8082
+ * Remove a page which has no more messages remaining to be processed or is stale.
6115
8083
  *
6116
8084
  * @param {CumulusPrimitivesCoreAggregateMessageOrigin} messageOrigin
6117
8085
  * @param {number} pageIndex
@@ -6134,7 +8102,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6134
8102
  >;
6135
8103
 
6136
8104
  /**
6137
- * See [`Pallet::execute_overweight`].
8105
+ * Execute an overweight message.
8106
+ *
8107
+ * Temporary processing errors will be propagated whereas permanent errors are treated
8108
+ * as success condition.
8109
+ *
8110
+ * - `origin`: Must be `Signed`.
8111
+ * - `message_origin`: The origin from which the message to be executed arrived.
8112
+ * - `page`: The page in the queue in which the message to be executed is sitting.
8113
+ * - `index`: The index into the queue of the message to be executed.
8114
+ * - `weight_limit`: The maximum amount of weight allowed to be consumed in the execution
8115
+ * of the message.
8116
+ *
8117
+ * Benchmark complexity considerations: O(index + weight_limit).
6138
8118
  *
6139
8119
  * @param {CumulusPrimitivesCoreAggregateMessageOrigin} messageOrigin
6140
8120
  * @param {number} page
@@ -6175,7 +8155,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
6175
8155
  **/
6176
8156
  randomness: {
6177
8157
  /**
6178
- * See [`Pallet::set_babe_randomness_results`].
8158
+ * Populates `RandomnessResults` due this epoch with BABE epoch randomness
6179
8159
  *
6180
8160
  **/
6181
8161
  setBabeRandomnessResults: GenericTxCall<