@dedot/chaintypes 0.12.0 → 0.14.0

package/astar/tx.d.ts

@@ -45,6 +45,8 @@ import type {
   XcmVersionedAssets,
   StagingXcmV4Location,
   XcmV3WeightLimit,
+  StagingXcmExecutorAssetTransferTransferType,
+  XcmVersionedAssetId,
   XcmVersionedAsset,
   CumulusPrimitivesCoreAggregateMessageOrigin,
   EthereumTransactionTransactionV2,
@@ -2033,7 +2035,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      *
      * This will waive the transaction fee if at least all but 10% of the accounts needed to
      * be upgraded. (We let some not have to be upgraded just in order to allow for the
-     * possibililty of churn).
+     * possibility of churn).
      *
      * @param {Array<AccountId32Like>} who
      **/
@@ -4392,6 +4394,26 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
       >
     >;
 
+    /**
+     * Set slash destination.
+     * Use `Some` to deposit slashed balance into destination or `None` to burn it.
+     *
+     * @param {AccountId32Like | undefined} destination
+     **/
+    setSlashDestination: GenericTxCall<
+      Rv,
+      (destination: AccountId32Like | undefined) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'CollatorSelection';
+          palletCall: {
+            name: 'SetSlashDestination';
+            params: { destination: AccountId32Like | undefined };
+          };
+        }
+      >
+    >;
+
     /**
      * Generic pallet tx call
      **/
@@ -4863,7 +4885,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      *
      * Fee payment on the destination side is made from the asset in the `assets` vector of
      * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
-     * is needed than `weight_limit`, then the operation will fail and the assets send may be
+     * is needed than `weight_limit`, then the operation will fail and the sent assets may be
      * at risk.
      *
      * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@@ -4915,7 +4937,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      *
      * Fee payment on the destination side is made from the asset in the `assets` vector of
      * index `fee_asset_item`, up to enough to pay for `weight_limit` of weight. If more weight
-     * is needed than `weight_limit`, then the operation will fail and the assets send may be
+     * is needed than `weight_limit`, then the operation will fail and the sent assets may be
      * at risk.
      *
      * - `origin`: Must be capable of withdrawing the `assets` and executing XCM.
@@ -4991,7 +5013,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * Fee payment on the destination side is made from the asset in the `assets` vector of
      * index `fee_asset_item` (hence referred to as `fees`), up to enough to pay for
      * `weight_limit` of weight. If more weight is needed than `weight_limit`, then the
-     * operation will fail and the assets sent may be at risk.
+     * operation will fail and the sent assets may be at risk.
      *
      * `assets` (excluding `fees`) must have same reserve location or otherwise be teleportable
      * to `dest`, no limitations imposed on `fees`.
@@ -5080,23 +5102,102 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
     >;
 
     /**
-     * Generic pallet tx call
+     * Transfer assets from the local chain to the destination chain using explicit transfer
+     * types for assets and fees.
+     *
+     * `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.
+     *
+     * `remote_fees_id` may use different transfer type than rest of `assets` and can be
+     * specified through `fees_transfer_type`.
+     *
+     * 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.
+     *
+     * - `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 {XcmVersionedAssets} assets
+     * @param {StagingXcmExecutorAssetTransferTransferType} assetsTransferType
+     * @param {XcmVersionedAssetId} remoteFeesId
+     * @param {StagingXcmExecutorAssetTransferTransferType} feesTransferType
+     * @param {XcmVersionedXcm} customXcmOnDest
+     * @param {XcmV3WeightLimit} weightLimit
      **/
-    [callName: string]: GenericTxCall<Rv, TxCall<Rv>>;
-  };
-  /**
-   * Pallet `CumulusXcm`'s transaction calls
-   **/
-  cumulusXcm: {
+    transferAssetsUsingTypeAndThen: GenericTxCall<
+      Rv,
+      (
+        dest: XcmVersionedLocation,
+        assets: XcmVersionedAssets,
+        assetsTransferType: StagingXcmExecutorAssetTransferTransferType,
+        remoteFeesId: XcmVersionedAssetId,
+        feesTransferType: StagingXcmExecutorAssetTransferTransferType,
+        customXcmOnDest: XcmVersionedXcm,
+        weightLimit: XcmV3WeightLimit,
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'PolkadotXcm';
+          palletCall: {
+            name: 'TransferAssetsUsingTypeAndThen';
+            params: {
+              dest: XcmVersionedLocation;
+              assets: XcmVersionedAssets;
+              assetsTransferType: StagingXcmExecutorAssetTransferTransferType;
+              remoteFeesId: XcmVersionedAssetId;
+              feesTransferType: StagingXcmExecutorAssetTransferTransferType;
+              customXcmOnDest: XcmVersionedXcm;
+              weightLimit: XcmV3WeightLimit;
+            };
+          };
+        }
+      >
+    >;
+
     /**
      * Generic pallet tx call
      **/
     [callName: string]: GenericTxCall<Rv, TxCall<Rv>>;
   };
   /**
-   * Pallet `DmpQueue`'s transaction calls
+   * Pallet `CumulusXcm`'s transaction calls
    **/
-  dmpQueue: {
+  cumulusXcm: {
     /**
      * Generic pallet tx call
      **/