@dedot/chaintypes 0.0.1-alpha.65 → 0.0.1-alpha.67

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/chaintypes",
-  "version": "0.0.1-alpha.65",
+  "version": "0.0.1-alpha.67",
   "description": "Types for substrate-based chains",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "main": "",
@@ -20,7 +20,7 @@
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "45e1276d22ec35a4a4ec3a4e4029f98ad7530c52",
+  "gitHead": "d4d37014615c2e4ceab107c709d3b1e062c40313",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/rococo/consts.d.ts

@@ -164,6 +164,15 @@ export interface ChainConsts extends GenericChainConsts {
      **/
     [name: string]: any;
   };
+  /**
+   * Pallet `Parameters`'s constants
+   **/
+  parameters: {
+    /**
+     * Generic pallet constant
+     **/
+    [name: string]: any;
+  };
   /**
    * Pallet `TransactionPayment`'s constants
    **/

package/rococo/errors.d.ts

@@ -2564,11 +2564,6 @@ export interface ChainErrors extends GenericChainErrors {
      **/
     InUse: GenericPalletError;
 
-    /**
-     * Invalid non-concrete asset.
-     **/
-    InvalidAssetNotConcrete: GenericPalletError;
-
     /**
      * Invalid asset, reserve chain could not be determined for it.
      **/
@@ -2589,17 +2584,6 @@ export interface ChainErrors extends GenericChainErrors {
      **/
     LocalExecutionIncomplete: GenericPalletError;
 
-    /**
-     * Could not decode XCM.
-     **/
-    UnableToDecode: GenericPalletError;
-
-    /**
-     * XCM encoded length is too large.
-     * Returned when an XCM encoded length is larger than `MaxXcmEncodedSize`.
-     **/
-    XcmTooLarge: GenericPalletError;
-
     /**
      * Generic pallet error
      **/

package/rococo/events.d.ts

@@ -15,6 +15,8 @@ import type {
 } from '@dedot/codecs';
 import type {
   FrameSupportTokensMiscBalanceStatus,
+  RococoRuntimeRuntimeParametersKey,
+  RococoRuntimeRuntimeParametersValue,
   SpConsensusGrandpaAppPublic,
   PolkadotRuntimeCommonImplsVersionedLocatableAsset,
   XcmVersionedLocation,
@@ -249,6 +251,41 @@ export interface ChainEvents extends GenericChainEvents {
      **/
     [prop: string]: GenericPalletEvent;
   };
+  /**
+   * Pallet `Parameters`'s events
+   **/
+  parameters: {
+    /**
+     * A Parameter was set.
+     *
+     * Is also emitted when the value was not changed.
+     **/
+    Updated: GenericPalletEvent<
+      'Parameters',
+      'Updated',
+      {
+        /**
+         * The key that was updated.
+         **/
+        key: RococoRuntimeRuntimeParametersKey;
+
+        /**
+         * The old value before this call.
+         **/
+        oldValue?: RococoRuntimeRuntimeParametersValue | undefined;
+
+        /**
+         * The new value after this call.
+         **/
+        newValue?: RococoRuntimeRuntimeParametersValue | undefined;
+      }
+    >;
+
+    /**
+     * Generic pallet event
+     **/
+    [prop: string]: GenericPalletEvent;
+  };
   /**
    * Pallet `TransactionPayment`'s events
    **/
@@ -2258,7 +2295,7 @@ export interface ChainEvents extends GenericChainEvents {
     >;
 
     /**
-     * An HRMP channel was opened between two system chains.
+     * An HRMP channel was opened with a system chain.
      **/
     HrmpSystemChannelOpened: GenericPalletEvent<
       'Hrmp',

package/rococo/query.d.ts

@@ -32,6 +32,8 @@ import type {
   PalletBalancesReserveData,
   PalletBalancesIdAmount,
   PalletBalancesIdAmount002,
+  RococoRuntimeRuntimeParametersValue,
+  RococoRuntimeRuntimeParametersKey,
   PalletTransactionPaymentReleases,
   SpStakingOffenceOffenceDetails,
   RococoRuntimeSessionKeys,
@@ -588,6 +590,25 @@ export interface ChainStorage extends GenericChainStorage {
      **/
     [storage: string]: GenericStorageQuery;
   };
+  /**
+   * Pallet `Parameters`'s storage queries
+   **/
+  parameters: {
+    /**
+     * Stored parameters.
+     *
+     * @param {RococoRuntimeRuntimeParametersKey} arg
+     * @param {Callback<RococoRuntimeRuntimeParametersValue | undefined> =} callback
+     **/
+    parameters: GenericStorageQuery<
+      (arg: RococoRuntimeRuntimeParametersKey) => RococoRuntimeRuntimeParametersValue | undefined
+    >;
+
+    /**
+     * Generic pallet storage query
+     **/
+    [storage: string]: GenericStorageQuery;
+  };
   /**
    * Pallet `TransactionPayment`'s storage queries
    **/

package/rococo/runtime.d.ts

@@ -667,6 +667,16 @@ export interface RuntimeApis extends GenericRuntimeApis {
       () => Promise<Array<[PolkadotPrimitivesV7CoreIndex, Array<PolkadotParachainPrimitivesPrimitivesId>]>>
     >;
 
+    /**
+     * Elastic scaling support
+     *
+     * @callname: ParachainHost_candidates_pending_availability
+     * @param {PolkadotParachainPrimitivesPrimitivesId} para_id
+     **/
+    candidatesPendingAvailability: GenericRuntimeApiMethod<
+      (paraId: PolkadotParachainPrimitivesPrimitivesId) => Promise<Array<PolkadotPrimitivesV7CommittedCandidateReceipt>>
+    >;
+
     /**
      * Generic runtime api call
      **/
@@ -1113,28 +1123,51 @@ export interface RuntimeApis extends GenericRuntimeApis {
    **/
   genesisBuilder: {
     /**
-     * Creates the default `RuntimeGenesisConfig` and returns it as a JSON blob.
+     * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the
+     * storage.
+     *
+     * In the case of a FRAME-based runtime, this function deserializes the full `RuntimeGenesisConfig` from the given JSON blob and
+     * puts it into the storage. If the provided JSON blob is incorrect or incomplete or the
+     * deserialization fails, an error is returned.
      *
-     * This function instantiates the default `RuntimeGenesisConfig` struct for the runtime and serializes it into a JSON
-     * blob. It returns a `Vec<u8>` containing the JSON representation of the default `RuntimeGenesisConfig`.
+     * Please note that provided JSON blob must contain all `RuntimeGenesisConfig` fields, no
+     * defaults will be used.
      *
-     * @callname: GenesisBuilder_create_default_config
+     * @callname: GenesisBuilder_build_state
+     * @param {BytesLike} json
      **/
-    createDefaultConfig: GenericRuntimeApiMethod<() => Promise<Bytes>>;
+    buildState: GenericRuntimeApiMethod<(json: BytesLike) => Promise<Result<[], string>>>;
 
     /**
-     * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the storage.
+     * Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by
+     * `id`.
      *
-     * This function deserializes the full `RuntimeGenesisConfig` from the given JSON blob and puts it into the storage.
-     * If the provided JSON blob is incorrect or incomplete or the deserialization fails, an error is returned.
-     * It is recommended to log any errors encountered during the process.
+     * If `id` is `None` the function returns JSON blob representation of the default
+     * `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default
+     * `RuntimeGenesisConfig`.
      *
-     * Please note that provided json blob must contain all `RuntimeGenesisConfig` fields, no defaults will be used.
+     * Otherwise function returns a JSON representation of the built-in, named
+     * `RuntimeGenesisConfig` preset identified by `id`, or `None` if such preset does not
+     * exists. Returned `Vec<u8>` contains bytes of JSON blob (patch) which comprises a list of
+     * (potentially nested) key-value pairs that are intended for customizing the default
+     * runtime genesis config. The patch shall be merged (rfc7386) with the JSON representation
+     * of the default `RuntimeGenesisConfig` to create a comprehensive genesis config that can
+     * be used in `build_state` method.
      *
-     * @callname: GenesisBuilder_build_config
-     * @param {BytesLike} json
+     * @callname: GenesisBuilder_get_preset
+     * @param {string | undefined} id
+     **/
+    getPreset: GenericRuntimeApiMethod<(id?: string | undefined) => Promise<Bytes | undefined>>;
+
+    /**
+     * Returns a list of identifiers for available builtin `RuntimeGenesisConfig` presets.
+     *
+     * The presets from the list can be queried with [`GenesisBuilder::get_preset`] method. If
+     * no named presets are provided by the runtime the list is empty.
+     *
+     * @callname: GenesisBuilder_preset_names
      **/
-    buildConfig: GenericRuntimeApiMethod<(json: BytesLike) => Promise<Result<[], string>>>;
+    presetNames: GenericRuntimeApiMethod<() => Promise<Array<string>>>;
 
     /**
      * Generic runtime api call

package/rococo/tx.d.ts

@@ -28,6 +28,7 @@ import type {
   SpSessionMembershipProof,
   SpConsensusBabeDigestsNextConfigDescriptor,
   PalletBalancesAdjustmentDirection,
+  RococoRuntimeRuntimeParameters,
   RococoRuntimeSessionKeys,
   SpConsensusGrandpaEquivocationProof,
   PolkadotRuntimeCommonImplsVersionedLocatableAsset,
@@ -66,6 +67,8 @@ import type {
   XcmVersionedAssets,
   StagingXcmV4Location,
   XcmV3WeightLimit,
+  StagingXcmExecutorAssetTransferTransferType,
+  XcmVersionedAssetId,
   SpConsensusBeefyEquivocationProof,
   PolkadotRuntimeParachainsParasParaGenesisArgs,
   PolkadotRuntimeCommonAssignedSlotsSlotLeasePeriodStart,
@@ -756,6 +759,33 @@ export interface ChainTx extends GenericChainTx<TxCall> {
      **/
     [callName: string]: GenericTxCall<TxCall>;
   };
+  /**
+   * Pallet `Parameters`'s transaction calls
+   **/
+  parameters: {
+    /**
+     * Set the value of a parameter.
+     *
+     * The dispatch origin of this call must be `AdminOrigin` for the given `key`. Values be
+     * deleted by setting them to `None`.
+     *
+     * @param {RococoRuntimeRuntimeParameters} keyValue
+     **/
+    setParameter: GenericTxCall<
+      (keyValue: RococoRuntimeRuntimeParameters) => ChainSubmittableExtrinsic<{
+        pallet: 'Parameters';
+        palletCall: {
+          name: 'SetParameter';
+          params: { keyValue: RococoRuntimeRuntimeParameters };
+        };
+      }>
+    >;
+
+    /**
+     * Generic pallet tx call
+     **/
+    [callName: string]: GenericTxCall<TxCall>;
+  };
   /**
    * Pallet `Session`'s transaction calls
    **/
@@ -7025,6 +7055,27 @@ export interface ChainTx extends GenericChainTx<TxCall> {
       }>
     >;
 
+    /**
+     * Establish a bidirectional HRMP channel between a parachain and a system chain.
+     *
+     * Arguments:
+     *
+     * - `target_system_chain`: A system chain, `ParaId`.
+     *
+     * The origin needs to be the parachain origin.
+     *
+     * @param {PolkadotParachainPrimitivesPrimitivesId} targetSystemChain
+     **/
+    establishChannelWithSystem: GenericTxCall<
+      (targetSystemChain: PolkadotParachainPrimitivesPrimitivesId) => ChainSubmittableExtrinsic<{
+        pallet: 'Hrmp';
+        palletCall: {
+          name: 'EstablishChannelWithSystem';
+          params: { targetSystemChain: PolkadotParachainPrimitivesPrimitivesId };
+        };
+      }>
+    >;
+
     /**
      * Generic pallet tx call
      **/
@@ -7426,7 +7477,7 @@ export interface ChainTx extends GenericChainTx<TxCall> {
      * validators have reported on the validity of the code, the code will either be enacted
      * or the upgrade will be rejected. If the code will be enacted, the current code of the
      * parachain will be overwritten directly. This means that any PoV will be checked by this
-     * new code. The parachain itself will not be informed explictely that the validation code
+     * new code. The parachain itself will not be informed explicitly that the validation code
      * has changed.
      *
      * Can be called by Root, the parachain, or the parachain manager if the parachain is
@@ -7960,7 +8011,6 @@ export interface ChainTx extends GenericChainTx<TxCall> {
    **/
   xcmPallet: {
     /**
-     * WARNING: DEPRECATED. `send` will be removed after June 2024. Use `send_blob` instead.
      *
      * @param {XcmVersionedLocation} dest
      * @param {XcmVersionedXcm} message
@@ -8090,9 +8140,6 @@ export interface ChainTx extends GenericChainTx<TxCall> {
      * the maximum amount of weight that the message could take to be executed, then no
      * execution attempt will be made.
      *
-     * WARNING: DEPRECATED. `execute` will be removed after June 2024. Use `execute_blob`
-     * instead.
-     *
      * @param {XcmVersionedXcm} message
      * @param {SpWeightsWeightV2Weight} maxWeight
      **/
@@ -8404,53 +8451,85 @@ export interface ChainTx extends GenericChainTx<TxCall> {
     >;
 
     /**
-     * Execute an XCM from a local, signed, origin.
-     *
-     * An event is deposited indicating whether the message could be executed completely
-     * or only partially.
-     *
-     * No more than `max_weight` will be used in its attempted execution. If this is less than
-     * the maximum amount of weight that the message could take to be executed, then no
-     * execution attempt will be made.
+     * Transfer assets from the local chain to the destination chain using explicit transfer
+     * types for assets and fees.
      *
-     * The message is passed in encoded. It needs to be decodable as a [`VersionedXcm`].
+     * `assets` must have same reserve location or may be teleportable to `dest`. Caller must
+     * provide the `assets_transfer_type` to be used for `assets`:
+     * - `TransferType::LocalReserve`: transfer assets to sovereign account of destination
+     * chain and forward a notification XCM to `dest` to mint and deposit reserve-based
+     * assets to `beneficiary`.
+     * - `TransferType::DestinationReserve`: burn local assets and forward a notification to
+     * `dest` chain to withdraw the reserve assets from this chain's sovereign account and
+     * deposit them to `beneficiary`.
+     * - `TransferType::RemoteReserve(reserve)`: burn local assets, forward XCM to `reserve`
+     * chain to move reserves from this chain's SA to `dest` chain's SA, and forward another
+     * XCM to `dest` to mint and deposit reserve-based assets to `beneficiary`. Typically
+     * the remote `reserve` is Asset Hub.
+     * - `TransferType::Teleport`: burn local assets and forward XCM to `dest` chain to
+     * mint/teleport assets and deposit them to `beneficiary`.
+     *
+     * On the destination chain, as well as any intermediary hops, `BuyExecution` is used to
+     * buy execution using transferred `assets` identified by `remote_fees_id`.
+     * Make sure enough of the specified `remote_fees_id` asset is included in the given list
+     * of `assets`. `remote_fees_id` should be enough to pay for `weight_limit`. If more weight
+     * is needed than `weight_limit`, then the operation will fail and the sent assets may be
+     * at risk.
      *
-     * @param {BytesLike} encodedMessage
-     * @param {SpWeightsWeightV2Weight} maxWeight
-     **/
-    executeBlob: GenericTxCall<
-      (
-        encodedMessage: BytesLike,
-        maxWeight: SpWeightsWeightV2Weight,
-      ) => ChainSubmittableExtrinsic<{
-        pallet: 'XcmPallet';
-        palletCall: {
-          name: 'ExecuteBlob';
-          params: { encodedMessage: BytesLike; maxWeight: SpWeightsWeightV2Weight };
-        };
-      }>
-    >;
-
-    /**
-     * Send an XCM from a local, signed, origin.
+     * `remote_fees_id` may use different transfer type than rest of `assets` and can be
+     * specified through `fees_transfer_type`.
      *
-     * The destination, `dest`, will receive this message with a `DescendOrigin` instruction
-     * that makes the origin of the message be the origin on this system.
+     * The caller needs to specify what should happen to the transferred assets once they reach
+     * the `dest` chain. This is done through the `custom_xcm_on_dest` parameter, which
+     * contains the instructions to execute on `dest` as a final step.
+     * This is usually as simple as:
+     * `Xcm(vec![DepositAsset { assets: Wild(AllCounted(assets.len())), beneficiary }])`,
+     * but could be something more exotic like sending the `assets` even further.
      *
-     * The message is passed in encoded. It needs to be decodable as a [`VersionedXcm`].
+     * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
+     * - `dest`: Destination context for the assets. Will typically be `[Parent,
+     * Parachain(..)]` to send from parachain to parachain, or `[Parachain(..)]` to send from
+     * relay to parachain, or `(parents: 2, (GlobalConsensus(..), ..))` to send from
+     * parachain across a bridge to another ecosystem destination.
+     * - `assets`: The assets to be withdrawn. This should include the assets used to pay the
+     * fee on the `dest` (and possibly reserve) chains.
+     * - `assets_transfer_type`: The XCM `TransferType` used to transfer the `assets`.
+     * - `remote_fees_id`: One of the included `assets` to be be used to pay fees.
+     * - `fees_transfer_type`: The XCM `TransferType` used to transfer the `fees` assets.
+     * - `custom_xcm_on_dest`: The XCM to be executed on `dest` chain as the last step of the
+     * transfer, which also determines what happens to the assets on the destination chain.
+     * - `weight_limit`: The remote-side weight limit, if any, for the XCM fee purchase.
      *
      * @param {XcmVersionedLocation} dest
-     * @param {BytesLike} encodedMessage
+     * @param {XcmVersionedAssets} assets
+     * @param {StagingXcmExecutorAssetTransferTransferType} assetsTransferType
+     * @param {XcmVersionedAssetId} remoteFeesId
+     * @param {StagingXcmExecutorAssetTransferTransferType} feesTransferType
+     * @param {XcmVersionedXcm} customXcmOnDest
+     * @param {XcmV3WeightLimit} weightLimit
      **/
-    sendBlob: GenericTxCall<
+    transferAssetsUsingTypeAndThen: GenericTxCall<
       (
         dest: XcmVersionedLocation,
-        encodedMessage: BytesLike,
+        assets: XcmVersionedAssets,
+        assetsTransferType: StagingXcmExecutorAssetTransferTransferType,
+        remoteFeesId: XcmVersionedAssetId,
+        feesTransferType: StagingXcmExecutorAssetTransferTransferType,
+        customXcmOnDest: XcmVersionedXcm,
+        weightLimit: XcmV3WeightLimit,
       ) => ChainSubmittableExtrinsic<{
         pallet: 'XcmPallet';
         palletCall: {
-          name: 'SendBlob';
-          params: { dest: XcmVersionedLocation; encodedMessage: BytesLike };
+          name: 'TransferAssetsUsingTypeAndThen';
+          params: {
+            dest: XcmVersionedLocation;
+            assets: XcmVersionedAssets;
+            assetsTransferType: StagingXcmExecutorAssetTransferTransferType;
+            remoteFeesId: XcmVersionedAssetId;
+            feesTransferType: StagingXcmExecutorAssetTransferTransferType;
+            customXcmOnDest: XcmVersionedXcm;
+            weightLimit: XcmV3WeightLimit;
+          };
         };
       }>
     >;