@dedot/chaintypes 0.20.0 → 0.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/chaintypes",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Types for substrate-based chains",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "main": "",
@@ -19,7 +19,7 @@
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "08edfc8f5624dced4ce095ed378978fa85d09532",
+  "gitHead": "c227d70a1c89b5e516373bbb14c9e92ec2c881e1",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/polkadot-asset-hub/consts.d.ts

@@ -6,6 +6,7 @@ import type {
   FrameSystemLimitsBlockWeights,
   FrameSystemLimitsBlockLength,
   SpWeightsRuntimeDbWeight,
+  PolkadotParachainPrimitivesPrimitivesId,
   SpWeightsWeightV2Weight,
   PalletNftsBitFlagsPalletFeature,
   StagingXcmV3MultilocationMultiLocation,
@@ -38,7 +39,7 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
     dbWeight: SpWeightsRuntimeDbWeight;
 
     /**
-     * Get the chain's current version.
+     * Get the chain's in-code version.
      **/
     version: RuntimeVersion;
 
@@ -60,6 +61,11 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
    * Pallet `ParachainSystem`'s constants
    **/
   parachainSystem: {
+    /**
+     * Returns the parachain ID we are running with.
+     **/
+    selfParaId: PolkadotParachainPrimitivesPrimitivesId;
+
     /**
      * Generic pallet constant
      **/
@@ -112,11 +118,15 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
     /**
      * The maximum number of locks that should exist on an account.
      * Not strictly enforced, but used for weight estimation.
+     *
+     * Use of locks is deprecated in favour of freezes. See `https://github.com/paritytech/substrate/pull/12951/`
      **/
     maxLocks: number;
 
     /**
      * The maximum number of named reserves that can exist on an account.
+     *
+     * Use of reserves is deprecated in favour of holds. See `https://github.com/paritytech/substrate/pull/12951/`
      **/
     maxReserves: number;
 
@@ -219,6 +229,14 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
    * Pallet `Aura`'s constants
    **/
   aura: {
+    /**
+     * The slot duration Aura should run with, expressed in milliseconds.
+     * The effective value of this type should not change while the chain is running.
+     *
+     * For backwards compatibility either use [`MinimumPeriodTimesTwo`] or a const.
+     **/
+    slotDuration: bigint;
+
     /**
      * Generic pallet constant
      **/
@@ -246,6 +264,27 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
      **/
     maxInboundSuspended: number;
 
+    /**
+     * Maximal number of outbound XCMP channels that can have messages queued at the same time.
+     *
+     * If this is reached, then no further messages can be sent to channels that do not yet
+     * have a message queued. This should be set to the expected maximum of outbound channels
+     * which is determined by [`Self::ChannelInfo`]. It is important to set this large enough,
+     * since otherwise the congestion control protocol will not work as intended and messages
+     * may be dropped. This value increases the PoV and should therefore not be picked too
+     * high. Governance needs to pay attention to not open more channels than this value.
+     **/
+    maxActiveOutboundChannels: number;
+
+    /**
+     * The maximal page size for HRMP message pages.
+     *
+     * A lower limit can be set dynamically, but this is the hard-limit for the PoV worst case
+     * benchmarking. The limit for the size of a message is slightly below this, since some
+     * overhead is incurred for encoding the format.
+     **/
+    maxPageSize: number;
+
     /**
      * Generic pallet constant
      **/
@@ -300,13 +339,23 @@ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<R
 
     /**
      * The amount of weight (if any) which should be provided to the message queue for
-     * servicing enqueued items.
+     * servicing enqueued items `on_initialize`.
      *
      * This may be legitimately `None` in the case that you will call
-     * `ServiceQueues::service_queues` manually.
+     * `ServiceQueues::service_queues` manually or set [`Self::IdleMaxServiceWeight`] to have
+     * it run in `on_idle`.
      **/
     serviceWeight: SpWeightsWeightV2Weight | undefined;
 
+    /**
+     * The maximum amount of weight (if any) to be used from remaining weight `on_idle` which
+     * should be provided to the message queue for servicing enqueued items `on_idle`.
+     * Useful for parachains to process messages at the same block they are received.
+     *
+     * If `None`, it will not call `ServiceQueues::service_queues` in `on_idle`.
+     **/
+    idleMaxServiceWeight: SpWeightsWeightV2Weight | undefined;
+
     /**
      * Generic pallet constant
      **/

package/polkadot-asset-hub/errors.d.ts

@@ -41,6 +41,11 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     CallFiltered: GenericPalletError<Rv>;
 
+    /**
+     * A multi-block migration is ongoing and prevents the current code from being replaced.
+     **/
+    MultiBlockMigrationsOngoing: GenericPalletError<Rv>;
+
     /**
      * No upgrade authorized.
      **/
@@ -357,6 +362,16 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     AlreadyResumed: GenericPalletError<Rv>;
 
+    /**
+     * There are too many active outbound channels.
+     **/
+    TooManyActiveOutboundChannels: GenericPalletError<Rv>;
+
+    /**
+     * The message is too big.
+     **/
+    TooBig: GenericPalletError<Rv>;
+
     /**
      * Generic pallet error
      **/
@@ -469,11 +484,6 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     InUse: GenericPalletError<Rv>;
 
-    /**
-     * Invalid non-concrete asset.
-     **/
-    InvalidAssetNotConcrete: GenericPalletError<Rv>;
-
     /**
      * Invalid asset, reserve chain could not be determined for it.
      **/
@@ -808,6 +818,11 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     CallbackFailed: GenericPalletError<Rv>;
 
+    /**
+     * The asset ID must be equal to the [`NextAssetId`].
+     **/
+    BadAssetId: GenericPalletError<Rv>;
+
     /**
      * Generic pallet error
      **/
@@ -1253,6 +1268,11 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     CallbackFailed: GenericPalletError<Rv>;
 
+    /**
+     * The asset ID must be equal to the [`NextAssetId`].
+     **/
+    BadAssetId: GenericPalletError<Rv>;
+
     /**
      * Generic pallet error
      **/
@@ -1365,6 +1385,11 @@ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<R
      **/
     CallbackFailed: GenericPalletError<Rv>;
 
+    /**
+     * The asset ID must be equal to the [`NextAssetId`].
+     **/
+    BadAssetId: GenericPalletError<Rv>;
+
     /**
      * Generic pallet error
      **/

package/polkadot-asset-hub/events.d.ts

@@ -1188,6 +1188,16 @@ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<R
      **/
     Blocked: GenericPalletEvent<Rv, 'Assets', 'Blocked', { assetId: number; who: AccountId32 }>;
 
+    /**
+     * Some assets were deposited (e.g. for transaction fees).
+     **/
+    Deposited: GenericPalletEvent<Rv, 'Assets', 'Deposited', { assetId: number; who: AccountId32; amount: bigint }>;
+
+    /**
+     * Some assets were withdrawn from the account (e.g. for transaction fees).
+     **/
+    Withdrawn: GenericPalletEvent<Rv, 'Assets', 'Withdrawn', { assetId: number; who: AccountId32; amount: bigint }>;
+
     /**
      * Generic pallet event
      **/
@@ -2022,6 +2032,26 @@ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<R
       { assetId: StagingXcmV3MultilocationMultiLocation; who: AccountId32 }
     >;
 
+    /**
+     * Some assets were deposited (e.g. for transaction fees).
+     **/
+    Deposited: GenericPalletEvent<
+      Rv,
+      'ForeignAssets',
+      'Deposited',
+      { assetId: StagingXcmV3MultilocationMultiLocation; who: AccountId32; amount: bigint }
+    >;
+
+    /**
+     * Some assets were withdrawn from the account (e.g. for transaction fees).
+     **/
+    Withdrawn: GenericPalletEvent<
+      Rv,
+      'ForeignAssets',
+      'Withdrawn',
+      { assetId: StagingXcmV3MultilocationMultiLocation; who: AccountId32; amount: bigint }
+    >;
+
     /**
      * Generic pallet event
      **/
@@ -2207,6 +2237,16 @@ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<R
      **/
     Blocked: GenericPalletEvent<Rv, 'PoolAssets', 'Blocked', { assetId: number; who: AccountId32 }>;
 
+    /**
+     * Some assets were deposited (e.g. for transaction fees).
+     **/
+    Deposited: GenericPalletEvent<Rv, 'PoolAssets', 'Deposited', { assetId: number; who: AccountId32; amount: bigint }>;
+
+    /**
+     * Some assets were withdrawn from the account (e.g. for transaction fees).
+     **/
+    Withdrawn: GenericPalletEvent<Rv, 'PoolAssets', 'Withdrawn', { assetId: number; who: AccountId32; amount: bigint }>;
+
     /**
      * Generic pallet event
      **/
@@ -2217,7 +2257,7 @@ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<R
    **/
   assetConversion: {
     /**
-     * A successful call of the `CretaPool` extrinsic will create this event.
+     * A successful call of the `CreatePool` extrinsic will create this event.
      **/
     PoolCreated: GenericPalletEvent<
       Rv,
@@ -2406,6 +2446,26 @@ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<R
       }
     >;
 
+    /**
+     * Pool has been touched in order to fulfill operational requirements.
+     **/
+    Touched: GenericPalletEvent<
+      Rv,
+      'AssetConversion',
+      'Touched',
+      {
+        /**
+         * The ID of the pool.
+         **/
+        poolId: [StagingXcmV3MultilocationMultiLocation, StagingXcmV3MultilocationMultiLocation];
+
+        /**
+         * The account initiating the touch.
+         **/
+        who: AccountId32;
+      }
+    >;
+
     /**
      * Generic pallet event
      **/

package/polkadot-asset-hub/index.d.ts

@@ -23,7 +23,7 @@ export interface VersionedPolkadotAssetHubApi<Rv extends RpcVersion> extends Gen
 
 /**
  * @name: PolkadotAssetHubApi
- * @specVersion: 1002006
+ * @specVersion: 1003000
  **/
 export interface PolkadotAssetHubApi {
   legacy: VersionedPolkadotAssetHubApi<RpcLegacy>;

package/polkadot-asset-hub/query.d.ts

@@ -20,12 +20,12 @@ import type {
   FrameSystemCodeUpgradeAuthorization,
   CumulusPalletParachainSystemUnincludedSegmentAncestor,
   CumulusPalletParachainSystemUnincludedSegmentSegmentTracker,
-  PolkadotPrimitivesV6PersistedValidationData,
-  PolkadotPrimitivesV6UpgradeRestriction,
-  PolkadotPrimitivesV6UpgradeGoAhead,
+  PolkadotPrimitivesV7PersistedValidationData,
+  PolkadotPrimitivesV7UpgradeRestriction,
+  PolkadotPrimitivesV7UpgradeGoAhead,
   SpTrieStorageProof,
   CumulusPalletParachainSystemRelayStateSnapshotMessagingStateSnapshot,
-  PolkadotPrimitivesV6AbridgedHostConfiguration,
+  PolkadotPrimitivesV7AbridgedHostConfiguration,
   CumulusPrimitivesParachainInherentMessageQueueChain,
   PolkadotParachainPrimitivesPrimitivesId,
   PolkadotCorePrimitivesOutboundHrmpMessage,
@@ -33,8 +33,8 @@ import type {
   PalletBalancesAccountData,
   PalletBalancesBalanceLock,
   PalletBalancesReserveData,
-  PalletBalancesIdAmount,
-  PalletBalancesIdAmount002,
+  FrameSupportTokensMiscIdAmount,
+  FrameSupportTokensMiscIdAmount002,
   PalletTransactionPaymentReleases,
   PalletVestingVestingInfo,
   PalletVestingReleases,
@@ -50,6 +50,7 @@ import type {
   PalletXcmVersionMigrationStage,
   PalletXcmRemoteLockedFungibleRecord,
   XcmVersionedAssetId,
+  StagingXcmV4Xcm,
   BpXcmBridgeHubRouterBridgeState,
   PalletMessageQueueBookState,
   CumulusPrimitivesCoreAggregateMessageOrigin,
@@ -99,6 +100,13 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      **/
     extrinsicCount: GenericStorageQuery<Rv, () => number | undefined>;
 
+    /**
+     * Whether all inherents have been applied.
+     *
+     * @param {Callback<boolean> =} callback
+     **/
+    inherentsApplied: GenericStorageQuery<Rv, () => boolean>;
+
     /**
      * The current weight for the block.
      *
@@ -284,9 +292,9 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      * This value is expected to be set only once per block and it's never stored
      * in the trie.
      *
-     * @param {Callback<PolkadotPrimitivesV6PersistedValidationData | undefined> =} callback
+     * @param {Callback<PolkadotPrimitivesV7PersistedValidationData | undefined> =} callback
      **/
-    validationData: GenericStorageQuery<Rv, () => PolkadotPrimitivesV6PersistedValidationData | undefined>;
+    validationData: GenericStorageQuery<Rv, () => PolkadotPrimitivesV7PersistedValidationData | undefined>;
 
     /**
      * Were the validation data set to notify the relay chain?
@@ -313,9 +321,9 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      * relay-chain. This value is ephemeral which means it doesn't hit the storage. This value is
      * set after the inherent.
      *
-     * @param {Callback<PolkadotPrimitivesV6UpgradeRestriction | undefined> =} callback
+     * @param {Callback<PolkadotPrimitivesV7UpgradeRestriction | undefined> =} callback
      **/
-    upgradeRestrictionSignal: GenericStorageQuery<Rv, () => PolkadotPrimitivesV6UpgradeRestriction | undefined>;
+    upgradeRestrictionSignal: GenericStorageQuery<Rv, () => PolkadotPrimitivesV7UpgradeRestriction | undefined>;
 
     /**
      * Optional upgrade go-ahead signal from the relay-chain.
@@ -324,9 +332,9 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      * relay-chain. This value is ephemeral which means it doesn't hit the storage. This value is
      * set after the inherent.
      *
-     * @param {Callback<PolkadotPrimitivesV6UpgradeGoAhead | undefined> =} callback
+     * @param {Callback<PolkadotPrimitivesV7UpgradeGoAhead | undefined> =} callback
      **/
-    upgradeGoAhead: GenericStorageQuery<Rv, () => PolkadotPrimitivesV6UpgradeGoAhead | undefined>;
+    upgradeGoAhead: GenericStorageQuery<Rv, () => PolkadotPrimitivesV7UpgradeGoAhead | undefined>;
 
     /**
      * The state proof for the last relay parent block.
@@ -364,9 +372,9 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      *
      * This data is also absent from the genesis.
      *
-     * @param {Callback<PolkadotPrimitivesV6AbridgedHostConfiguration | undefined> =} callback
+     * @param {Callback<PolkadotPrimitivesV7AbridgedHostConfiguration | undefined> =} callback
      **/
-    hostConfiguration: GenericStorageQuery<Rv, () => PolkadotPrimitivesV6AbridgedHostConfiguration | undefined>;
+    hostConfiguration: GenericStorageQuery<Rv, () => PolkadotPrimitivesV7AbridgedHostConfiguration | undefined>;
 
     /**
      * The last downward message queue chain head we have observed.
@@ -573,6 +581,8 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      * Any liquidity locks on some account balances.
      * NOTE: Should only be accessed when setting, changing and freeing a lock.
      *
+     * Use of locks is deprecated in favour of freezes. See `https://github.com/paritytech/substrate/pull/12951/`
+     *
      * @param {AccountId32Like} arg
      * @param {Callback<Array<PalletBalancesBalanceLock>> =} callback
      **/
@@ -581,6 +591,8 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
     /**
      * Named reserves on some account balances.
      *
+     * Use of reserves is deprecated in favour of holds. See `https://github.com/paritytech/substrate/pull/12951/`
+     *
      * @param {AccountId32Like} arg
      * @param {Callback<Array<PalletBalancesReserveData>> =} callback
      **/
@@ -590,17 +602,17 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      * Holds on account balances.
      *
      * @param {AccountId32Like} arg
-     * @param {Callback<Array<PalletBalancesIdAmount>> =} callback
+     * @param {Callback<Array<FrameSupportTokensMiscIdAmount>> =} callback
      **/
-    holds: GenericStorageQuery<Rv, (arg: AccountId32Like) => Array<PalletBalancesIdAmount>, AccountId32>;
+    holds: GenericStorageQuery<Rv, (arg: AccountId32Like) => Array<FrameSupportTokensMiscIdAmount>, AccountId32>;
 
     /**
      * Freeze locks on account balances.
      *
      * @param {AccountId32Like} arg
-     * @param {Callback<Array<PalletBalancesIdAmount002>> =} callback
+     * @param {Callback<Array<FrameSupportTokensMiscIdAmount002>> =} callback
      **/
-    freezes: GenericStorageQuery<Rv, (arg: AccountId32Like) => Array<PalletBalancesIdAmount002>, AccountId32>;
+    freezes: GenericStorageQuery<Rv, (arg: AccountId32Like) => Array<FrameSupportTokensMiscIdAmount002>, AccountId32>;
 
     /**
      * Generic pallet storage query
@@ -1062,6 +1074,31 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      **/
     xcmExecutionSuspended: GenericStorageQuery<Rv, () => boolean>;
 
+    /**
+     * Whether or not incoming XCMs (both executed locally and received) should be recorded.
+     * Only one XCM program will be recorded at a time.
+     * This is meant to be used in runtime APIs, and it's advised it stays false
+     * for all other use cases, so as to not degrade regular performance.
+     *
+     * Only relevant if this pallet is being used as the [`xcm_executor::traits::RecordXcm`]
+     * implementation in the XCM executor configuration.
+     *
+     * @param {Callback<boolean> =} callback
+     **/
+    shouldRecordXcm: GenericStorageQuery<Rv, () => boolean>;
+
+    /**
+     * If [`ShouldRecordXcm`] is set to true, then the last XCM program executed locally
+     * will be stored here.
+     * Runtime APIs can fetch the XCM that was executed by accessing this value.
+     *
+     * Only relevant if this pallet is being used as the [`xcm_executor::traits::RecordXcm`]
+     * implementation in the XCM executor configuration.
+     *
+     * @param {Callback<StagingXcmV4Xcm | undefined> =} callback
+     **/
+    recordedXcm: GenericStorageQuery<Rv, () => StagingXcmV4Xcm | undefined>;
+
     /**
      * Generic pallet storage query
      **/
@@ -1230,6 +1267,21 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      **/
     metadata: GenericStorageQuery<Rv, (arg: number) => PalletAssetsAssetMetadata, number>;
 
+    /**
+     * The asset ID enforced for the next asset creation, if any present. Otherwise, this storage
+     * item has no effect.
+     *
+     * This can be useful for setting up constraints for IDs of the new assets. For example, by
+     * providing an initial [`NextAssetId`] and using the [`crate::AutoIncAssetId`] callback, an
+     * auto-increment model can be applied to all new asset IDs.
+     *
+     * The initial next asset ID can be set using the [`GenesisConfig`] or the
+     * [SetNextAssetId](`migration::next_asset_id::SetNextAssetId`) migration.
+     *
+     * @param {Callback<number | undefined> =} callback
+     **/
+    nextAssetId: GenericStorageQuery<Rv, () => number | undefined>;
+
     /**
      * Generic pallet storage query
      **/
@@ -1564,6 +1616,21 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
       StagingXcmV3MultilocationMultiLocation
     >;
 
+    /**
+     * The asset ID enforced for the next asset creation, if any present. Otherwise, this storage
+     * item has no effect.
+     *
+     * This can be useful for setting up constraints for IDs of the new assets. For example, by
+     * providing an initial [`NextAssetId`] and using the [`crate::AutoIncAssetId`] callback, an
+     * auto-increment model can be applied to all new asset IDs.
+     *
+     * The initial next asset ID can be set using the [`GenesisConfig`] or the
+     * [SetNextAssetId](`migration::next_asset_id::SetNextAssetId`) migration.
+     *
+     * @param {Callback<StagingXcmV3MultilocationMultiLocation | undefined> =} callback
+     **/
+    nextAssetId: GenericStorageQuery<Rv, () => StagingXcmV3MultilocationMultiLocation | undefined>;
+
     /**
      * Generic pallet storage query
      **/
@@ -1615,6 +1682,21 @@ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage
      **/
     metadata: GenericStorageQuery<Rv, (arg: number) => PalletAssetsAssetMetadata, number>;
 
+    /**
+     * The asset ID enforced for the next asset creation, if any present. Otherwise, this storage
+     * item has no effect.
+     *
+     * This can be useful for setting up constraints for IDs of the new assets. For example, by
+     * providing an initial [`NextAssetId`] and using the [`crate::AutoIncAssetId`] callback, an
+     * auto-increment model can be applied to all new asset IDs.
+     *
+     * The initial next asset ID can be set using the [`GenesisConfig`] or the
+     * [SetNextAssetId](`migration::next_asset_id::SetNextAssetId`) migration.
+     *
+     * @param {Callback<number | undefined> =} callback
+     **/
+    nextAssetId: GenericStorageQuery<Rv, () => number | undefined>;
+
     /**
      * Generic pallet storage query
      **/