@dedot/chaintypes 0.119.0 → 0.120.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.
@@ -31,6 +31,7 @@ import type {
31
31
  PolkadotParachainPrimitivesPrimitivesId,
32
32
  PolkadotCorePrimitivesOutboundHrmpMessage,
33
33
  SpWeightsWeightV2Weight,
34
+ PalletMigrationsMigrationCursor,
34
35
  PalletBalancesAccountData,
35
36
  PalletBalancesBalanceLock,
36
37
  PalletBalancesReserveData,
@@ -49,7 +50,7 @@ import type {
49
50
  PalletXcmVersionMigrationStage,
50
51
  PalletXcmRemoteLockedFungibleRecord,
51
52
  XcmVersionedAssetId,
52
- StagingXcmV4Xcm,
53
+ StagingXcmV5Xcm,
53
54
  PalletMessageQueueBookState,
54
55
  CumulusPrimitivesCoreAggregateMessageOrigin,
55
56
  PalletMessageQueuePage,
@@ -59,6 +60,8 @@ import type {
59
60
  PalletIdentityRegistration,
60
61
  PalletIdentityRegistrarInfo,
61
62
  PalletIdentityAuthorityProperties,
63
+ PalletIdentityUsernameInformation,
64
+ PalletIdentityProvider,
62
65
  } from './types.js';
63
66
 
64
67
  export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage<Rv> {
@@ -509,6 +512,35 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
509
512
  **/
510
513
  [storage: string]: GenericStorageQuery<Rv>;
511
514
  };
515
+ /**
516
+ * Pallet `MultiBlockMigrations`'s storage queries
517
+ **/
518
+ multiBlockMigrations: {
519
+ /**
520
+ * The currently active migration to run and its cursor.
521
+ *
522
+ * `None` indicates that no migration is running.
523
+ *
524
+ * @param {Callback<PalletMigrationsMigrationCursor | undefined> =} callback
525
+ **/
526
+ cursor: GenericStorageQuery<Rv, () => PalletMigrationsMigrationCursor | undefined>;
527
+
528
+ /**
529
+ * Set of all successfully executed migrations.
530
+ *
531
+ * This is used as blacklist, to not re-execute migrations that have not been removed from the
532
+ * codebase yet. Governance can regularly clear this out via `clear_historic`.
533
+ *
534
+ * @param {BytesLike} arg
535
+ * @param {Callback<[] | undefined> =} callback
536
+ **/
537
+ historic: GenericStorageQuery<Rv, (arg: BytesLike) => [] | undefined, Bytes>;
538
+
539
+ /**
540
+ * Generic pallet storage query
541
+ **/
542
+ [storage: string]: GenericStorageQuery<Rv>;
543
+ };
512
544
  /**
513
545
  * Pallet `Balances`'s storage queries
514
546
  **/
@@ -1042,9 +1074,9 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
1042
1074
  * Only relevant if this pallet is being used as the [`xcm_executor::traits::RecordXcm`]
1043
1075
  * implementation in the XCM executor configuration.
1044
1076
  *
1045
- * @param {Callback<StagingXcmV4Xcm | undefined> =} callback
1077
+ * @param {Callback<StagingXcmV5Xcm | undefined> =} callback
1046
1078
  **/
1047
- recordedXcm: GenericStorageQuery<Rv, () => StagingXcmV4Xcm | undefined>;
1079
+ recordedXcm: GenericStorageQuery<Rv, () => StagingXcmV5Xcm | undefined>;
1048
1080
 
1049
1081
  /**
1050
1082
  * Generic pallet storage query
@@ -1157,13 +1189,17 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
1157
1189
  * TWOX-NOTE: OK ― `AccountId` is a secure hash.
1158
1190
  *
1159
1191
  * @param {AccountId32Like} arg
1160
- * @param {Callback<[PalletIdentityRegistration, Bytes | undefined] | undefined> =} callback
1192
+ * @param {Callback<PalletIdentityRegistration | undefined> =} callback
1161
1193
  **/
1162
- identityOf: GenericStorageQuery<
1163
- Rv,
1164
- (arg: AccountId32Like) => [PalletIdentityRegistration, Bytes | undefined] | undefined,
1165
- AccountId32
1166
- >;
1194
+ identityOf: GenericStorageQuery<Rv, (arg: AccountId32Like) => PalletIdentityRegistration | undefined, AccountId32>;
1195
+
1196
+ /**
1197
+ * Identifies the primary username of an account.
1198
+ *
1199
+ * @param {AccountId32Like} arg
1200
+ * @param {Callback<Bytes | undefined> =} callback
1201
+ **/
1202
+ usernameOf: GenericStorageQuery<Rv, (arg: AccountId32Like) => Bytes | undefined, AccountId32>;
1167
1203
 
1168
1204
  /**
1169
1205
  * The super-identity of an alternative "sub" identity together with its name, within that
@@ -1199,39 +1235,51 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
1199
1235
  /**
1200
1236
  * A map of the accounts who are authorized to grant usernames.
1201
1237
  *
1202
- * @param {AccountId32Like} arg
1238
+ * @param {BytesLike} arg
1203
1239
  * @param {Callback<PalletIdentityAuthorityProperties | undefined> =} callback
1204
1240
  **/
1205
- usernameAuthorities: GenericStorageQuery<
1206
- Rv,
1207
- (arg: AccountId32Like) => PalletIdentityAuthorityProperties | undefined,
1208
- AccountId32
1209
- >;
1241
+ authorityOf: GenericStorageQuery<Rv, (arg: BytesLike) => PalletIdentityAuthorityProperties | undefined, Bytes>;
1210
1242
 
1211
1243
  /**
1212
- * Reverse lookup from `username` to the `AccountId` that has registered it. The value should
1213
- * be a key in the `IdentityOf` map, but it may not if the user has cleared their identity.
1244
+ * Reverse lookup from `username` to the `AccountId` that has registered it and the provider of
1245
+ * the username. The `owner` value should be a key in the `UsernameOf` map, but it may not if
1246
+ * the user has cleared their username or it has been removed.
1214
1247
  *
1215
- * Multiple usernames may map to the same `AccountId`, but `IdentityOf` will only map to one
1248
+ * Multiple usernames may map to the same `AccountId`, but `UsernameOf` will only map to one
1216
1249
  * primary username.
1217
1250
  *
1218
1251
  * @param {BytesLike} arg
1219
- * @param {Callback<AccountId32 | undefined> =} callback
1252
+ * @param {Callback<PalletIdentityUsernameInformation | undefined> =} callback
1220
1253
  **/
1221
- accountOfUsername: GenericStorageQuery<Rv, (arg: BytesLike) => AccountId32 | undefined, Bytes>;
1254
+ usernameInfoOf: GenericStorageQuery<Rv, (arg: BytesLike) => PalletIdentityUsernameInformation | undefined, Bytes>;
1222
1255
 
1223
1256
  /**
1224
1257
  * Usernames that an authority has granted, but that the account controller has not confirmed
1225
1258
  * that they want it. Used primarily in cases where the `AccountId` cannot provide a signature
1226
1259
  * because they are a pure proxy, multisig, etc. In order to confirm it, they should call
1227
- * [`Call::accept_username`].
1260
+ * [accept_username](`Call::accept_username`).
1228
1261
  *
1229
1262
  * First tuple item is the account and second is the acceptance deadline.
1230
1263
  *
1231
1264
  * @param {BytesLike} arg
1232
- * @param {Callback<[AccountId32, number] | undefined> =} callback
1265
+ * @param {Callback<[AccountId32, number, PalletIdentityProvider] | undefined> =} callback
1266
+ **/
1267
+ pendingUsernames: GenericStorageQuery<
1268
+ Rv,
1269
+ (arg: BytesLike) => [AccountId32, number, PalletIdentityProvider] | undefined,
1270
+ Bytes
1271
+ >;
1272
+
1273
+ /**
1274
+ * Usernames for which the authority that granted them has started the removal process by
1275
+ * unbinding them. Each unbinding username maps to its grace period expiry, which is the first
1276
+ * block in which the username could be deleted through a
1277
+ * [remove_username](`Call::remove_username`) call.
1278
+ *
1279
+ * @param {BytesLike} arg
1280
+ * @param {Callback<number | undefined> =} callback
1233
1281
  **/
1234
- pendingUsernames: GenericStorageQuery<Rv, (arg: BytesLike) => [AccountId32, number] | undefined, Bytes>;
1282
+ unbindingUsernames: GenericStorageQuery<Rv, (arg: BytesLike) => number | undefined, Bytes>;
1235
1283
 
1236
1284
  /**
1237
1285
  * Generic pallet storage query
@@ -587,9 +587,10 @@ export interface RuntimeApis<Rv extends RpcVersion> extends GenericRuntimeApis<R
587
587
  * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the
588
588
  * storage.
589
589
  *
590
- * In the case of a FRAME-based runtime, this function deserializes the full `RuntimeGenesisConfig` from the given JSON blob and
591
- * puts it into the storage. If the provided JSON blob is incorrect or incomplete or the
592
- * deserialization fails, an error is returned.
590
+ * In the case of a FRAME-based runtime, this function deserializes the full
591
+ * `RuntimeGenesisConfig` from the given JSON blob and puts it into the storage. If the
592
+ * provided JSON blob is incorrect or incomplete or the deserialization fails, an error
593
+ * is returned.
593
594
  *
594
595
  * Please note that provided JSON blob must contain all `RuntimeGenesisConfig` fields, no
595
596
  * defaults will be used.
@@ -603,7 +604,7 @@ export interface RuntimeApis<Rv extends RpcVersion> extends GenericRuntimeApis<R
603
604
  * Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by
604
605
  * `id`.
605
606
  *
606
- * If `id` is `None` the function returns JSON blob representation of the default
607
+ * If `id` is `None` the function should return JSON blob representation of the default
607
608
  * `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default
608
609
  * `RuntimeGenesisConfig`.
609
610
  *
@@ -16,13 +16,15 @@ import type {
16
16
  SpRuntimeMultiSignature,
17
17
  FrameSystemEventRecord,
18
18
  CumulusPrimitivesParachainInherentParachainInherentData,
19
+ PalletMigrationsMigrationCursor,
20
+ PalletMigrationsHistoricCleanupSelector,
19
21
  PalletBalancesAdjustmentDirection,
20
22
  PeoplePaseoRuntimeSessionKeys,
21
23
  XcmVersionedLocation,
22
24
  XcmVersionedXcm,
23
25
  XcmVersionedAssets,
24
26
  SpWeightsWeightV2Weight,
25
- StagingXcmV4Location,
27
+ StagingXcmV5Location,
26
28
  XcmV3WeightLimit,
27
29
  StagingXcmExecutorAssetTransferTransferType,
28
30
  XcmVersionedAssetId,
@@ -402,6 +404,111 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
402
404
  **/
403
405
  [callName: string]: GenericTxCall<Rv, TxCall<Rv>>;
404
406
  };
407
+ /**
408
+ * Pallet `MultiBlockMigrations`'s transaction calls
409
+ **/
410
+ multiBlockMigrations: {
411
+ /**
412
+ * Allows root to set a cursor to forcefully start, stop or forward the migration process.
413
+ *
414
+ * Should normally not be needed and is only in place as emergency measure. Note that
415
+ * restarting the migration process in this manner will not call the
416
+ * [`MigrationStatusHandler::started`] hook or emit an `UpgradeStarted` event.
417
+ *
418
+ * @param {PalletMigrationsMigrationCursor | undefined} cursor
419
+ **/
420
+ forceSetCursor: GenericTxCall<
421
+ Rv,
422
+ (cursor: PalletMigrationsMigrationCursor | undefined) => ChainSubmittableExtrinsic<
423
+ Rv,
424
+ {
425
+ pallet: 'MultiBlockMigrations';
426
+ palletCall: {
427
+ name: 'ForceSetCursor';
428
+ params: { cursor: PalletMigrationsMigrationCursor | undefined };
429
+ };
430
+ }
431
+ >
432
+ >;
433
+
434
+ /**
435
+ * Allows root to set an active cursor to forcefully start/forward the migration process.
436
+ *
437
+ * This is an edge-case version of [`Self::force_set_cursor`] that allows to set the
438
+ * `started_at` value to the next block number. Otherwise this would not be possible, since
439
+ * `force_set_cursor` takes an absolute block number. Setting `started_at` to `None`
440
+ * indicates that the current block number plus one should be used.
441
+ *
442
+ * @param {number} index
443
+ * @param {BytesLike | undefined} innerCursor
444
+ * @param {number | undefined} startedAt
445
+ **/
446
+ forceSetActiveCursor: GenericTxCall<
447
+ Rv,
448
+ (
449
+ index: number,
450
+ innerCursor: BytesLike | undefined,
451
+ startedAt: number | undefined,
452
+ ) => ChainSubmittableExtrinsic<
453
+ Rv,
454
+ {
455
+ pallet: 'MultiBlockMigrations';
456
+ palletCall: {
457
+ name: 'ForceSetActiveCursor';
458
+ params: { index: number; innerCursor: BytesLike | undefined; startedAt: number | undefined };
459
+ };
460
+ }
461
+ >
462
+ >;
463
+
464
+ /**
465
+ * Forces the onboarding of the migrations.
466
+ *
467
+ * This process happens automatically on a runtime upgrade. It is in place as an emergency
468
+ * measurement. The cursor needs to be `None` for this to succeed.
469
+ *
470
+ **/
471
+ forceOnboardMbms: GenericTxCall<
472
+ Rv,
473
+ () => ChainSubmittableExtrinsic<
474
+ Rv,
475
+ {
476
+ pallet: 'MultiBlockMigrations';
477
+ palletCall: {
478
+ name: 'ForceOnboardMbms';
479
+ };
480
+ }
481
+ >
482
+ >;
483
+
484
+ /**
485
+ * Clears the `Historic` set.
486
+ *
487
+ * `map_cursor` must be set to the last value that was returned by the
488
+ * `HistoricCleared` event. The first time `None` can be used. `limit` must be chosen in a
489
+ * way that will result in a sensible weight.
490
+ *
491
+ * @param {PalletMigrationsHistoricCleanupSelector} selector
492
+ **/
493
+ clearHistoric: GenericTxCall<
494
+ Rv,
495
+ (selector: PalletMigrationsHistoricCleanupSelector) => ChainSubmittableExtrinsic<
496
+ Rv,
497
+ {
498
+ pallet: 'MultiBlockMigrations';
499
+ palletCall: {
500
+ name: 'ClearHistoric';
501
+ params: { selector: PalletMigrationsHistoricCleanupSelector };
502
+ };
503
+ }
504
+ >
505
+ >;
506
+
507
+ /**
508
+ * Generic pallet tx call
509
+ **/
510
+ [callName: string]: GenericTxCall<Rv, TxCall<Rv>>;
511
+ };
405
512
  /**
406
513
  * Pallet `Balances`'s transaction calls
407
514
  **/
@@ -1250,13 +1357,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1250
1357
  * - `location`: The destination that is being described.
1251
1358
  * - `xcm_version`: The latest version of XCM that `location` supports.
1252
1359
  *
1253
- * @param {StagingXcmV4Location} location
1360
+ * @param {StagingXcmV5Location} location
1254
1361
  * @param {number} version
1255
1362
  **/
1256
1363
  forceXcmVersion: GenericTxCall<
1257
1364
  Rv,
1258
1365
  (
1259
- location: StagingXcmV4Location,
1366
+ location: StagingXcmV5Location,
1260
1367
  version: number,
1261
1368
  ) => ChainSubmittableExtrinsic<
1262
1369
  Rv,
@@ -1264,7 +1371,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
1264
1371
  pallet: 'PolkadotXcm';
1265
1372
  palletCall: {
1266
1373
  name: 'ForceXcmVersion';
1267
- params: { location: StagingXcmV4Location; version: number };
1374
+ params: { location: StagingXcmV5Location; version: number };
1268
1375
  };
1269
1376
  }
1270
1377
  >
@@ -2988,8 +3095,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
2988
3095
  /**
2989
3096
  * Add an `AccountId` with permission to grant usernames with a given `suffix` appended.
2990
3097
  *
2991
- * The authority can grant up to `allocation` usernames. To top up their allocation, they
2992
- * should just issue (or request via governance) a new `add_username_authority` call.
3098
+ * The authority can grant up to `allocation` usernames. To top up the allocation or
3099
+ * change the account used to grant usernames, this call can be used with the updated
3100
+ * parameters to overwrite the existing configuration.
2993
3101
  *
2994
3102
  * @param {MultiAddressLike} authority
2995
3103
  * @param {BytesLike} suffix
@@ -3016,17 +3124,21 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3016
3124
  /**
3017
3125
  * Remove `authority` from the username authorities.
3018
3126
  *
3127
+ * @param {BytesLike} suffix
3019
3128
  * @param {MultiAddressLike} authority
3020
3129
  **/
3021
3130
  removeUsernameAuthority: GenericTxCall<
3022
3131
  Rv,
3023
- (authority: MultiAddressLike) => ChainSubmittableExtrinsic<
3132
+ (
3133
+ suffix: BytesLike,
3134
+ authority: MultiAddressLike,
3135
+ ) => ChainSubmittableExtrinsic<
3024
3136
  Rv,
3025
3137
  {
3026
3138
  pallet: 'Identity';
3027
3139
  palletCall: {
3028
3140
  name: 'RemoveUsernameAuthority';
3029
- params: { authority: MultiAddressLike };
3141
+ params: { suffix: BytesLike; authority: MultiAddressLike };
3030
3142
  };
3031
3143
  }
3032
3144
  >
@@ -3035,7 +3147,11 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3035
3147
  /**
3036
3148
  * Set the username for `who`. Must be called by a username authority.
3037
3149
  *
3038
- * The authority must have an `allocation`. Users can either pre-sign their usernames or
3150
+ * If `use_allocation` is set, the authority must have a username allocation available to
3151
+ * spend. Otherwise, the authority will need to put up a deposit for registering the
3152
+ * username.
3153
+ *
3154
+ * Users can either pre-sign their usernames or
3039
3155
  * accept them later.
3040
3156
  *
3041
3157
  * Usernames must:
@@ -3046,6 +3162,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3046
3162
  * @param {MultiAddressLike} who
3047
3163
  * @param {BytesLike} username
3048
3164
  * @param {SpRuntimeMultiSignature | undefined} signature
3165
+ * @param {boolean} useAllocation
3049
3166
  **/
3050
3167
  setUsernameFor: GenericTxCall<
3051
3168
  Rv,
@@ -3053,13 +3170,19 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3053
3170
  who: MultiAddressLike,
3054
3171
  username: BytesLike,
3055
3172
  signature: SpRuntimeMultiSignature | undefined,
3173
+ useAllocation: boolean,
3056
3174
  ) => ChainSubmittableExtrinsic<
3057
3175
  Rv,
3058
3176
  {
3059
3177
  pallet: 'Identity';
3060
3178
  palletCall: {
3061
3179
  name: 'SetUsernameFor';
3062
- params: { who: MultiAddressLike; username: BytesLike; signature: SpRuntimeMultiSignature | undefined };
3180
+ params: {
3181
+ who: MultiAddressLike;
3182
+ username: BytesLike;
3183
+ signature: SpRuntimeMultiSignature | undefined;
3184
+ useAllocation: boolean;
3185
+ };
3063
3186
  };
3064
3187
  }
3065
3188
  >
@@ -3126,19 +3249,60 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
3126
3249
  >;
3127
3250
 
3128
3251
  /**
3129
- * Remove a username that corresponds to an account with no identity. Exists when a user
3130
- * gets a username but then calls `clear_identity`.
3252
+ * Start the process of removing a username by placing it in the unbinding usernames map.
3253
+ * Once the grace period has passed, the username can be deleted by calling
3254
+ * [remove_username](crate::Call::remove_username).
3255
+ *
3256
+ * @param {BytesLike} username
3257
+ **/
3258
+ unbindUsername: GenericTxCall<
3259
+ Rv,
3260
+ (username: BytesLike) => ChainSubmittableExtrinsic<
3261
+ Rv,
3262
+ {
3263
+ pallet: 'Identity';
3264
+ palletCall: {
3265
+ name: 'UnbindUsername';
3266
+ params: { username: BytesLike };
3267
+ };
3268
+ }
3269
+ >
3270
+ >;
3271
+
3272
+ /**
3273
+ * Permanently delete a username which has been unbinding for longer than the grace period.
3274
+ * Caller is refunded the fee if the username expired and the removal was successful.
3275
+ *
3276
+ * @param {BytesLike} username
3277
+ **/
3278
+ removeUsername: GenericTxCall<
3279
+ Rv,
3280
+ (username: BytesLike) => ChainSubmittableExtrinsic<
3281
+ Rv,
3282
+ {
3283
+ pallet: 'Identity';
3284
+ palletCall: {
3285
+ name: 'RemoveUsername';
3286
+ params: { username: BytesLike };
3287
+ };
3288
+ }
3289
+ >
3290
+ >;
3291
+
3292
+ /**
3293
+ * Call with [ForceOrigin](crate::Config::ForceOrigin) privileges which deletes a username
3294
+ * and slashes any deposit associated with it.
3131
3295
  *
3132
3296
  * @param {BytesLike} username
3133
3297
  **/
3134
- removeDanglingUsername: GenericTxCall<
3298
+ killUsername: GenericTxCall<
3135
3299
  Rv,
3136
3300
  (username: BytesLike) => ChainSubmittableExtrinsic<
3137
3301
  Rv,
3138
3302
  {
3139
3303
  pallet: 'Identity';
3140
3304
  palletCall: {
3141
- name: 'RemoveDanglingUsername';
3305
+ name: 'KillUsername';
3142
3306
  params: { username: BytesLike };
3143
3307
  };
3144
3308
  }