@dedot/chaintypes 0.264.0 → 0.266.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/kusama/tx.d.ts CHANGED
@@ -69,7 +69,7 @@ import type {
69
69
  PolkadotPrimitivesV9AsyncBackingAsyncBackingParams,
70
70
  PolkadotPrimitivesV9ExecutorParams,
71
71
  PolkadotPrimitivesV9ApprovalVotingParams,
72
- PolkadotPrimitivesV9SchedulerParams,
72
+ PolkadotPrimitivesVstagingSchedulerParams,
73
73
  PolkadotPrimitivesV9InherentData,
74
74
  PolkadotParachainPrimitivesPrimitivesId,
75
75
  PolkadotParachainPrimitivesPrimitivesValidationCode,
@@ -81,7 +81,7 @@ import type {
81
81
  PolkadotPrimitivesV9SlashingDisputeProof,
82
82
  SpRuntimeMultiSigner,
83
83
  PalletBrokerCoretimeInterfaceCoreAssignment,
84
- PolkadotRuntimeParachainsAssignerCoretimePartsOf57600,
84
+ PolkadotRuntimeParachainsSchedulerAssignerCoretimePartsOf57600,
85
85
  XcmVersionedXcm,
86
86
  XcmVersionedAssets,
87
87
  StagingXcmV5Location,
@@ -92,11 +92,6 @@ import type {
92
92
  SpConsensusBeefyDoubleVotingProof,
93
93
  SpConsensusBeefyForkVotingProof,
94
94
  SpConsensusBeefyFutureBlockVotingProof,
95
- PalletRcMigratorMigrationStage,
96
- StagingXcmV5Response,
97
- PalletRcMigratorQueuePriority,
98
- PalletRcMigratorManagerMultisigVote,
99
- PalletRcMigratorMigrationSettings,
100
95
  } from './types.js';
101
96
 
102
97
  export type ChainSubmittableExtrinsic<
@@ -1710,7 +1705,7 @@ export interface ChainTx<
1710
1705
  *
1711
1706
  * If a validator has more than [`Config::MaxExposurePageSize`] nominators backing
1712
1707
  * them, then the list of nominators is paged, with each page being capped at
1713
- * [`Config::MaxExposurePageSize`.] If a validator has more than one page of nominators,
1708
+ * [`Config::MaxExposurePageSize`]. If a validator has more than one page of nominators,
1714
1709
  * the call needs to be made for each page separately in order for all the nominators
1715
1710
  * backing a validator to receive the reward. The nominators are not sorted across pages
1716
1711
  * and so it should not be assumed the highest staker would be on the topmost page and vice
@@ -1904,14 +1899,16 @@ export interface ChainTx<
1904
1899
  session: {
1905
1900
  /**
1906
1901
  * Sets the session key(s) of the function caller to `keys`.
1902
+ *
1907
1903
  * Allows an account to set its session key prior to becoming a validator.
1908
1904
  * This doesn't take effect until the next session.
1909
1905
  *
1910
- * The dispatch origin of this function must be signed.
1911
- *
1912
- * ## Complexity
1913
- * - `O(1)`. Actual cost depends on the number of length of `T::Keys::key_ids()` which is
1914
- * fixed.
1906
+ * - `origin`: The dispatch origin of this function must be signed.
1907
+ * - `keys`: The new session keys to set. These are the public keys of all sessions keys
1908
+ * setup in the runtime.
1909
+ * - `proof`: The proof that `origin` has access to the private keys of `keys`. See
1910
+ * [`impl_opaque_keys`](sp_runtime::impl_opaque_keys) for more information about the
1911
+ * proof format.
1915
1912
  *
1916
1913
  * @param {StagingKusamaRuntimeSessionKeys} keys
1917
1914
  * @param {BytesLike} proof
@@ -1942,10 +1939,6 @@ export interface ChainTx<
1942
1939
  * means being a controller account) or directly convertible into a validator ID (which
1943
1940
  * usually means being a stash account).
1944
1941
  *
1945
- * ## Complexity
1946
- * - `O(1)` in number of key types. Actual cost depends on the number of length of
1947
- * `T::Keys::key_ids()` which is fixed.
1948
- *
1949
1942
  **/
1950
1943
  purgeKeys: GenericTxCall<
1951
1944
  () => ChainSubmittableExtrinsic<
@@ -4933,7 +4926,10 @@ export interface ChainTx<
4933
4926
  >;
4934
4927
 
4935
4928
  /**
4936
- * Cancel an anonymously scheduled task.
4929
+ * Cancel a scheduled task (named or anonymous), by providing the block it is scheduled for
4930
+ * execution in, as well as the index of the task in that block's agenda.
4931
+ *
4932
+ * In the case of a named task, it will remove it from the lookup table as well.
4937
4933
  *
4938
4934
  * @param {number} when
4939
4935
  * @param {number} index
@@ -5085,6 +5081,8 @@ export interface ChainTx<
5085
5081
  * original task's configuration, but will have a lower value for `remaining` than the
5086
5082
  * original `total_retries`.
5087
5083
  *
5084
+ * This call **cannot** be used to set a retry configuration for a named task.
5085
+ *
5088
5086
  * @param {[number, number]} task
5089
5087
  * @param {number} retries
5090
5088
  * @param {number} period
@@ -5120,6 +5118,8 @@ export interface ChainTx<
5120
5118
  * original task's configuration, but will have a lower value for `remaining` than the
5121
5119
  * original `total_retries`.
5122
5120
  *
5121
+ * This is the only way to set a retry configuration for a named task.
5122
+ *
5123
5123
  * @param {FixedBytes<32>} id
5124
5124
  * @param {number} retries
5125
5125
  * @param {number} period
@@ -5603,7 +5603,9 @@ export interface ChainTx<
5603
5603
  * Register approval for a dispatch to be made from a deterministic composite account if
5604
5604
  * approved by a total of `threshold - 1` of `other_signatories`.
5605
5605
  *
5606
- * If there are enough, then dispatch the call.
5606
+ * **If the approval threshold is met (including the sender's approval), this will
5607
+ * immediately execute the call.** This is the only way to execute a multisig call -
5608
+ * `approve_as_multi` will never trigger execution.
5607
5609
  *
5608
5610
  * Payment: `DepositBase` will be reserved if this is the first approval, plus
5609
5611
  * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
@@ -5619,8 +5621,9 @@ export interface ChainTx<
5619
5621
  * transaction index) of the first approval transaction.
5620
5622
  * - `call`: The call to be executed.
5621
5623
  *
5622
- * NOTE: Unless this is the final approval, you will generally want to use
5623
- * `approve_as_multi` instead, since it only requires a hash of the call.
5624
+ * NOTE: For intermediate approvals (not the final approval), you should generally use
5625
+ * `approve_as_multi` instead, since it only requires a hash of the call and is more
5626
+ * efficient.
5624
5627
  *
5625
5628
  * Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise
5626
5629
  * on success, result is `Ok` and the result from the interior call, if it was executed,
@@ -5675,6 +5678,13 @@ export interface ChainTx<
5675
5678
  * Register approval for a dispatch to be made from a deterministic composite account if
5676
5679
  * approved by a total of `threshold - 1` of `other_signatories`.
5677
5680
  *
5681
+ * **This function will NEVER execute the call, even if the approval threshold is
5682
+ * reached.** It only registers approval. To actually execute the call, `as_multi` must
5683
+ * be called with the full call data by any of the signatories.
5684
+ *
5685
+ * This function is more efficient than `as_multi` for intermediate approvals since it
5686
+ * only requires the call hash, not the full call data.
5687
+ *
5678
5688
  * Payment: `DepositBase` will be reserved if this is the first approval, plus
5679
5689
  * `threshold` times `DepositFactor`. It is returned once this dispatch happens or
5680
5690
  * is cancelled.
@@ -5689,7 +5699,8 @@ export interface ChainTx<
5689
5699
  * transaction index) of the first approval transaction.
5690
5700
  * - `call_hash`: The hash of the call to be executed.
5691
5701
  *
5692
- * NOTE: If this is the final approval, you will want to use `as_multi` instead.
5702
+ * NOTE: To execute the call after approvals are gathered, any signatory must call
5703
+ * `as_multi` with the full call data. This function cannot execute the call.
5693
5704
  *
5694
5705
  * ## Complexity
5695
5706
  * - `O(S)`.
@@ -8671,15 +8682,33 @@ export interface ChainTx<
8671
8682
  /**
8672
8683
  * Set scheduler-params.
8673
8684
  *
8674
- * @param {PolkadotPrimitivesV9SchedulerParams} new_
8685
+ * @param {PolkadotPrimitivesVstagingSchedulerParams} new_
8675
8686
  **/
8676
8687
  setSchedulerParams: GenericTxCall<
8677
- (new_: PolkadotPrimitivesV9SchedulerParams) => ChainSubmittableExtrinsic<
8688
+ (new_: PolkadotPrimitivesVstagingSchedulerParams) => ChainSubmittableExtrinsic<
8678
8689
  {
8679
8690
  pallet: 'Configuration';
8680
8691
  palletCall: {
8681
8692
  name: 'SetSchedulerParams';
8682
- params: { new: PolkadotPrimitivesV9SchedulerParams };
8693
+ params: { new: PolkadotPrimitivesVstagingSchedulerParams };
8694
+ };
8695
+ },
8696
+ ChainKnownTypes
8697
+ >
8698
+ >;
8699
+
8700
+ /**
8701
+ * Set the maximum relay parent session age.
8702
+ *
8703
+ * @param {number} new_
8704
+ **/
8705
+ setMaxRelayParentSessionAge: GenericTxCall<
8706
+ (new_: number) => ChainSubmittableExtrinsic<
8707
+ {
8708
+ pallet: 'Configuration';
8709
+ palletCall: {
8710
+ name: 'SetMaxRelayParentSessionAge';
8711
+ params: { new: number };
8683
8712
  };
8684
8713
  },
8685
8714
  ChainKnownTypes
@@ -10410,7 +10439,7 @@ export interface ChainTx<
10410
10439
  *
10411
10440
  * @param {number} core
10412
10441
  * @param {number} begin
10413
- * @param {Array<[PalletBrokerCoretimeInterfaceCoreAssignment, PolkadotRuntimeParachainsAssignerCoretimePartsOf57600]>} assignment
10442
+ * @param {Array<[PalletBrokerCoretimeInterfaceCoreAssignment, PolkadotRuntimeParachainsSchedulerAssignerCoretimePartsOf57600]>} assignment
10414
10443
  * @param {number | undefined} endHint
10415
10444
  **/
10416
10445
  assignCore: GenericTxCall<
@@ -10418,7 +10447,7 @@ export interface ChainTx<
10418
10447
  core: number,
10419
10448
  begin: number,
10420
10449
  assignment: Array<
10421
- [PalletBrokerCoretimeInterfaceCoreAssignment, PolkadotRuntimeParachainsAssignerCoretimePartsOf57600]
10450
+ [PalletBrokerCoretimeInterfaceCoreAssignment, PolkadotRuntimeParachainsSchedulerAssignerCoretimePartsOf57600]
10422
10451
  >,
10423
10452
  endHint: number | undefined,
10424
10453
  ) => ChainSubmittableExtrinsic<
@@ -10430,7 +10459,10 @@ export interface ChainTx<
10430
10459
  core: number;
10431
10460
  begin: number;
10432
10461
  assignment: Array<
10433
- [PalletBrokerCoretimeInterfaceCoreAssignment, PolkadotRuntimeParachainsAssignerCoretimePartsOf57600]
10462
+ [
10463
+ PalletBrokerCoretimeInterfaceCoreAssignment,
10464
+ PolkadotRuntimeParachainsSchedulerAssignerCoretimePartsOf57600,
10465
+ ]
10434
10466
  >;
10435
10467
  endHint: number | undefined;
10436
10468
  };
@@ -11438,353 +11470,6 @@ export interface ChainTx<
11438
11470
  >
11439
11471
  >;
11440
11472
 
11441
- /**
11442
- * Generic pallet tx call
11443
- **/
11444
- [callName: string]: GenericTxCall<TxCall<ChainKnownTypes>>;
11445
- };
11446
- /**
11447
- * Pallet `RcMigrator`'s transaction calls
11448
- **/
11449
- rcMigrator: {
11450
- /**
11451
- * Set the migration stage.
11452
- *
11453
- * This call is intended for emergency use only and is guarded by the
11454
- * [`Config::AdminOrigin`].
11455
- *
11456
- * @param {PalletRcMigratorMigrationStage} stage
11457
- **/
11458
- forceSetStage: GenericTxCall<
11459
- (stage: PalletRcMigratorMigrationStage) => ChainSubmittableExtrinsic<
11460
- {
11461
- pallet: 'RcMigrator';
11462
- palletCall: {
11463
- name: 'ForceSetStage';
11464
- params: { stage: PalletRcMigratorMigrationStage };
11465
- };
11466
- },
11467
- ChainKnownTypes
11468
- >
11469
- >;
11470
-
11471
- /**
11472
- * Schedule the migration to start at a given moment.
11473
- *
11474
- * ### Parameters:
11475
- * - `start`: The block number at which the migration will start. `DispatchTime` calculated
11476
- * at the moment of the extrinsic execution.
11477
- * - `warm_up`: Duration or timepoint that will be used to prepare for the migration. Calls
11478
- * are filtered during this period. It is intended to give enough time for UMP and DMP
11479
- * queues to empty. `DispatchTime` calculated at the moment of the transition to the
11480
- * warm-up stage.
11481
- * - `cool_off`: The block number at which the post migration cool-off period will end. The
11482
- * `DispatchTime` calculated at the moment of the transition to the cool-off stage.
11483
- * - `unsafe_ignore_staking_lock_check`: ONLY FOR TESTING. Ignore the check whether the
11484
- * scheduled time point is far enough in the future.
11485
- *
11486
- * Note: If the staking election for next era is already complete, and the next
11487
- * validator set is queued in `pallet-session`, we want to avoid starting the data
11488
- * migration at this point as it can lead to some missed validator rewards. To address
11489
- * this, we stop staking election at the start of migration and must wait atleast 1
11490
- * session (set via warm_up) before starting the data migration.
11491
- *
11492
- * Read [`MigrationStage::Scheduled`] documentation for more details.
11493
- *
11494
- * @param {FrameSupportScheduleDispatchTime} start
11495
- * @param {FrameSupportScheduleDispatchTime} warmUp
11496
- * @param {FrameSupportScheduleDispatchTime} coolOff
11497
- * @param {boolean} unsafeIgnoreStakingLockCheck
11498
- **/
11499
- scheduleMigration: GenericTxCall<
11500
- (
11501
- start: FrameSupportScheduleDispatchTime,
11502
- warmUp: FrameSupportScheduleDispatchTime,
11503
- coolOff: FrameSupportScheduleDispatchTime,
11504
- unsafeIgnoreStakingLockCheck: boolean,
11505
- ) => ChainSubmittableExtrinsic<
11506
- {
11507
- pallet: 'RcMigrator';
11508
- palletCall: {
11509
- name: 'ScheduleMigration';
11510
- params: {
11511
- start: FrameSupportScheduleDispatchTime;
11512
- warmUp: FrameSupportScheduleDispatchTime;
11513
- coolOff: FrameSupportScheduleDispatchTime;
11514
- unsafeIgnoreStakingLockCheck: boolean;
11515
- };
11516
- };
11517
- },
11518
- ChainKnownTypes
11519
- >
11520
- >;
11521
-
11522
- /**
11523
- * Start the data migration.
11524
- *
11525
- * This is typically called by the Asset Hub to indicate it's readiness to receive the
11526
- * migration data.
11527
- *
11528
- **/
11529
- startDataMigration: GenericTxCall<
11530
- () => ChainSubmittableExtrinsic<
11531
- {
11532
- pallet: 'RcMigrator';
11533
- palletCall: {
11534
- name: 'StartDataMigration';
11535
- };
11536
- },
11537
- ChainKnownTypes
11538
- >
11539
- >;
11540
-
11541
- /**
11542
- * Receive a query response from the Asset Hub for a previously sent xcm message.
11543
- *
11544
- * @param {bigint} queryId
11545
- * @param {StagingXcmV5Response} response
11546
- **/
11547
- receiveQueryResponse: GenericTxCall<
11548
- (
11549
- queryId: bigint,
11550
- response: StagingXcmV5Response,
11551
- ) => ChainSubmittableExtrinsic<
11552
- {
11553
- pallet: 'RcMigrator';
11554
- palletCall: {
11555
- name: 'ReceiveQueryResponse';
11556
- params: { queryId: bigint; response: StagingXcmV5Response };
11557
- };
11558
- },
11559
- ChainKnownTypes
11560
- >
11561
- >;
11562
-
11563
- /**
11564
- * Resend a previously sent and unconfirmed XCM message.
11565
- *
11566
- * @param {bigint} queryId
11567
- **/
11568
- resendXcm: GenericTxCall<
11569
- (queryId: bigint) => ChainSubmittableExtrinsic<
11570
- {
11571
- pallet: 'RcMigrator';
11572
- palletCall: {
11573
- name: 'ResendXcm';
11574
- params: { queryId: bigint };
11575
- };
11576
- },
11577
- ChainKnownTypes
11578
- >
11579
- >;
11580
-
11581
- /**
11582
- * Set the unprocessed message buffer size.
11583
- *
11584
- * `None` means to use the configuration value.
11585
- *
11586
- * @param {number | undefined} new_
11587
- **/
11588
- setUnprocessedMsgBuffer: GenericTxCall<
11589
- (new_: number | undefined) => ChainSubmittableExtrinsic<
11590
- {
11591
- pallet: 'RcMigrator';
11592
- palletCall: {
11593
- name: 'SetUnprocessedMsgBuffer';
11594
- params: { new: number | undefined };
11595
- };
11596
- },
11597
- ChainKnownTypes
11598
- >
11599
- >;
11600
-
11601
- /**
11602
- * Set the AH UMP queue priority configuration.
11603
- *
11604
- * Can only be called by the `AdminOrigin`.
11605
- *
11606
- * @param {PalletRcMigratorQueuePriority} new_
11607
- **/
11608
- setAhUmpQueuePriority: GenericTxCall<
11609
- (new_: PalletRcMigratorQueuePriority) => ChainSubmittableExtrinsic<
11610
- {
11611
- pallet: 'RcMigrator';
11612
- palletCall: {
11613
- name: 'SetAhUmpQueuePriority';
11614
- params: { new: PalletRcMigratorQueuePriority };
11615
- };
11616
- },
11617
- ChainKnownTypes
11618
- >
11619
- >;
11620
-
11621
- /**
11622
- * Set the manager account id.
11623
- *
11624
- * The manager has the similar to [`Config::AdminOrigin`] privileges except that it
11625
- * can not set the manager account id via `set_manager` call.
11626
- *
11627
- * @param {AccountId32Like | undefined} new_
11628
- **/
11629
- setManager: GenericTxCall<
11630
- (new_: AccountId32Like | undefined) => ChainSubmittableExtrinsic<
11631
- {
11632
- pallet: 'RcMigrator';
11633
- palletCall: {
11634
- name: 'SetManager';
11635
- params: { new: AccountId32Like | undefined };
11636
- };
11637
- },
11638
- ChainKnownTypes
11639
- >
11640
- >;
11641
-
11642
- /**
11643
- * XCM send call identical to the [`pallet_xcm::Pallet::send`] call but with the
11644
- * [Config::SendXcm] router which will be able to send messages to the Asset Hub during
11645
- * the migration.
11646
- *
11647
- * @param {XcmVersionedLocation} dest
11648
- * @param {XcmVersionedXcm} message
11649
- **/
11650
- sendXcmMessage: GenericTxCall<
11651
- (
11652
- dest: XcmVersionedLocation,
11653
- message: XcmVersionedXcm,
11654
- ) => ChainSubmittableExtrinsic<
11655
- {
11656
- pallet: 'RcMigrator';
11657
- palletCall: {
11658
- name: 'SendXcmMessage';
11659
- params: { dest: XcmVersionedLocation; message: XcmVersionedXcm };
11660
- };
11661
- },
11662
- ChainKnownTypes
11663
- >
11664
- >;
11665
-
11666
- /**
11667
- * Set the accounts to be preserved on Relay Chain during the migration.
11668
- *
11669
- * The accounts must have no consumers references.
11670
- *
11671
- * @param {Array<AccountId32Like>} accounts
11672
- **/
11673
- preserveAccounts: GenericTxCall<
11674
- (accounts: Array<AccountId32Like>) => ChainSubmittableExtrinsic<
11675
- {
11676
- pallet: 'RcMigrator';
11677
- palletCall: {
11678
- name: 'PreserveAccounts';
11679
- params: { accounts: Array<AccountId32Like> };
11680
- };
11681
- },
11682
- ChainKnownTypes
11683
- >
11684
- >;
11685
-
11686
- /**
11687
- * Set the canceller account id.
11688
- *
11689
- * The canceller can only stop scheduled migration.
11690
- *
11691
- * @param {AccountId32Like | undefined} new_
11692
- **/
11693
- setCanceller: GenericTxCall<
11694
- (new_: AccountId32Like | undefined) => ChainSubmittableExtrinsic<
11695
- {
11696
- pallet: 'RcMigrator';
11697
- palletCall: {
11698
- name: 'SetCanceller';
11699
- params: { new: AccountId32Like | undefined };
11700
- };
11701
- },
11702
- ChainKnownTypes
11703
- >
11704
- >;
11705
-
11706
- /**
11707
- * Pause the migration.
11708
- *
11709
- **/
11710
- pauseMigration: GenericTxCall<
11711
- () => ChainSubmittableExtrinsic<
11712
- {
11713
- pallet: 'RcMigrator';
11714
- palletCall: {
11715
- name: 'PauseMigration';
11716
- };
11717
- },
11718
- ChainKnownTypes
11719
- >
11720
- >;
11721
-
11722
- /**
11723
- * Cancel the migration.
11724
- *
11725
- * Migration can only be cancelled if it is in the [`MigrationStage::Scheduled`] state.
11726
- *
11727
- **/
11728
- cancelMigration: GenericTxCall<
11729
- () => ChainSubmittableExtrinsic<
11730
- {
11731
- pallet: 'RcMigrator';
11732
- palletCall: {
11733
- name: 'CancelMigration';
11734
- };
11735
- },
11736
- ChainKnownTypes
11737
- >
11738
- >;
11739
-
11740
- /**
11741
- * Vote on behalf of any of the members in `MultisigMembers`.
11742
- *
11743
- * Unsigned extrinsic, requiring the `payload` to be signed.
11744
- *
11745
- * Upon each call, a new entry is created in `ManagerMultisigs` map the `payload.call` to
11746
- * be dispatched. Once `MultisigThreshold` is reached, the entire map is deleted, and we
11747
- * move on to the next round.
11748
- *
11749
- * The round system ensures that signatures from older round cannot be reused.
11750
- *
11751
- * @param {PalletRcMigratorManagerMultisigVote} payload
11752
- * @param {SpRuntimeMultiSignature} sig
11753
- **/
11754
- voteManagerMultisig: GenericTxCall<
11755
- (
11756
- payload: PalletRcMigratorManagerMultisigVote,
11757
- sig: SpRuntimeMultiSignature,
11758
- ) => ChainSubmittableExtrinsic<
11759
- {
11760
- pallet: 'RcMigrator';
11761
- palletCall: {
11762
- name: 'VoteManagerMultisig';
11763
- params: { payload: PalletRcMigratorManagerMultisigVote; sig: SpRuntimeMultiSignature };
11764
- };
11765
- },
11766
- ChainKnownTypes
11767
- >
11768
- >;
11769
-
11770
- /**
11771
- * Set the migration settings. Can only be done by admin or manager.
11772
- *
11773
- * @param {PalletRcMigratorMigrationSettings | undefined} settings
11774
- **/
11775
- setSettings: GenericTxCall<
11776
- (settings: PalletRcMigratorMigrationSettings | undefined) => ChainSubmittableExtrinsic<
11777
- {
11778
- pallet: 'RcMigrator';
11779
- palletCall: {
11780
- name: 'SetSettings';
11781
- params: { settings: PalletRcMigratorMigrationSettings | undefined };
11782
- };
11783
- },
11784
- ChainKnownTypes
11785
- >
11786
- >;
11787
-
11788
11473
  /**
11789
11474
  * Generic pallet tx call
11790
11475
  **/