@moonbeam-network/xcm-builder 4.2.0 → 4.2.2

package/build/index.d.ts

@@ -81,11 +81,51 @@ declare class ContractConfig extends BaseConfig {
 }
 
 type ContractConfigBuilder = ConfigBuilder<ContractConfig>;
+type DestinationMultilocation = [
+    /**
+     * 1 - if transaction is going through or to a relay chain
+     */
+    1,
+    ([
+        /**
+         * example '0x00000007DC'
+         * 7DC - parachain id in hex
+         * can be found here:
+         *   - https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-rpc.polkadot.io#/parachains
+         *   - https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.polkadot.io#/parachains
+         */
+        string,
+        /**
+         * example '0x01%account%00',
+         * enum = 01 (AccountId32)
+         * networkId = 00 (any)
+         */
+        string
+    ] | [
+        /**
+         * example '0x01%account%00',
+         * enum = 01 (AccountId32)
+         * networkId = 00 (any)
+         */
+        string
+    ]
+    /**
+     * example 'Here',
+     */
+     | [])
+];
+type AssetAddressFormat = (string | bigint | undefined)[];
+declare enum TransferType {
+    Teleport = 0,
+    LocalReserve = 1,
+    DestinationReserve = 2
+}
 
 declare function XcmPrecompile(): {
     transferAssetsToPara20: (shouldTransferAssetPrecedeFeeAsset?: boolean) => ContractConfigBuilder;
     transferAssetsToPara32: (shouldTransferAssetPrecedeFeeAsset?: boolean) => ContractConfigBuilder;
     transferAssetsToRelay: () => ContractConfigBuilder;
+    transferAssetsUsingTypeAndThenAddress: (shouldTransferAssetPrecedeFeeAsset?: boolean) => ContractConfigBuilder;
 };
 
 declare function Xtokens(): {
@@ -379,7 +419,8 @@ declare function polkadotXcm$1(): {
         X2AndFeeHere: () => ExtrinsicConfigBuilder;
     };
     transferAssetsUsingTypeAndThen: () => {
-        here: () => ExtrinsicConfigBuilder;
+        here: (parents?: number) => ExtrinsicConfigBuilder;
+        X2: (parents?: number) => ExtrinsicConfigBuilder;
         globalConsensusEthereum: () => ExtrinsicConfigBuilder;
     };
     transferAssetsToEcosystem: () => {
@@ -711,4 +752,4 @@ declare function MrlBuilder(): {
 
 declare const BATCH_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000000808";
 
-export { AssetMinBuilder, type AssetMinConfigBuilder, type AssetMinConfigBuilderParams, BATCH_CONTRACT_ABI, BATCH_CONTRACT_ADDRESS, BalanceBuilder, type BalanceBuilderParams, type BalanceConfigBuilder, type BuilderParams, type ConfigBuilder, ContractBuilder, ContractConfig, type ContractConfigBuilder, type ContractConfigConstructorParams, ERC20_ABI, type EquilibriumSystemBalanceData, type EventMonitoringConfig, type EvmFunctionArgs, EvmQueryConfig, type EvmQueryConfigParams, type EvmQueryFunctions, ExtrinsicBuilder, ExtrinsicConfig, type ExtrinsicConfigBuilder, type ExtrinsicConfigConstructorParams, FeeBuilder, type FeeConfigBuilder, type FeeConfigBuilderParams, type GetVersionedAssetId, MonitoringBuilder, type MonitoringBuilderConfig, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlExecuteBuilderParams, type MrlExecuteConfigBuilder, type PalletBalancesAccountDataOld, type Parents, Protocols, type QueryConfigConstructorParams, SubstrateCallConfig, type SubstrateCallConfigConstructorParams, SubstrateQueryConfig, type TokensPalletAccountData, type Transact, WormholeConfig, type WormholeConfigConstructorParams, type WormholeFunctionArgs, type WormholeTransferFunctions, type XcmPaymentFeeProps, XcmVersion, calculateSystemAccountBalance, evm, substrate, wormhole, wormholeFactory };
+export { type AssetAddressFormat, AssetMinBuilder, type AssetMinConfigBuilder, type AssetMinConfigBuilderParams, BATCH_CONTRACT_ABI, BATCH_CONTRACT_ADDRESS, BalanceBuilder, type BalanceBuilderParams, type BalanceConfigBuilder, type BuilderParams, type ConfigBuilder, ContractBuilder, ContractConfig, type ContractConfigBuilder, type ContractConfigConstructorParams, type DestinationMultilocation, ERC20_ABI, type EquilibriumSystemBalanceData, type EventMonitoringConfig, type EvmFunctionArgs, EvmQueryConfig, type EvmQueryConfigParams, type EvmQueryFunctions, ExtrinsicBuilder, ExtrinsicConfig, type ExtrinsicConfigBuilder, type ExtrinsicConfigConstructorParams, FeeBuilder, type FeeConfigBuilder, type FeeConfigBuilderParams, type GetVersionedAssetId, MonitoringBuilder, type MonitoringBuilderConfig, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlExecuteBuilderParams, type MrlExecuteConfigBuilder, type PalletBalancesAccountDataOld, type Parents, Protocols, type QueryConfigConstructorParams, SubstrateCallConfig, type SubstrateCallConfigConstructorParams, SubstrateQueryConfig, type TokensPalletAccountData, type Transact, TransferType, WormholeConfig, type WormholeConfigConstructorParams, type WormholeFunctionArgs, type WormholeTransferFunctions, type XcmPaymentFeeProps, XcmVersion, calculateSystemAccountBalance, evm, substrate, wormhole, wormholeFactory };

package/build/index.mjs

@@ -228,8 +228,8 @@ var ContractConfig = class _ContractConfig extends BaseConfig {
 };
 
 // src/contract/contracts/XcmPrecompile/XcmPrecompile.ts
-import { u8aToHex as u8aToHex2 } from "@polkadot/util";
-import { decodeAddress as decodeAddress2 } from "@polkadot/util-crypto";
+import { u8aToHex as u8aToHex3 } from "@polkadot/util";
+import { decodeAddress as decodeAddress3 } from "@polkadot/util-crypto";
 
 // src/types/evm/EvmQueryConfig.ts
 var EvmQueryConfig = class _EvmQueryConfig {
@@ -271,6 +271,53 @@ var SubstrateCallConfig = class _SubstrateCallConfig {
   }
 };
 
+// src/contract/ContractBuilder.interfaces.ts
+var TransferType = /* @__PURE__ */ ((TransferType2) => {
+  TransferType2[TransferType2["Teleport"] = 0] = "Teleport";
+  TransferType2[TransferType2["LocalReserve"] = 1] = "LocalReserve";
+  TransferType2[TransferType2["DestinationReserve"] = 2] = "DestinationReserve";
+  return TransferType2;
+})(TransferType || {});
+
+// src/contract/ContractBuilder.utils.ts
+import { EvmParachain } from "@moonbeam-network/xcm-types";
+import { u8aToHex as u8aToHex2 } from "@polkadot/util";
+import { decodeAddress as decodeAddress2 } from "@polkadot/util-crypto";
+function getPrecompileDestinationInterior(destination, address) {
+  if (!address) {
+    return [`0x0000000${destination.parachainId.toString(16)}`];
+  }
+  const accountType = EvmParachain.is(destination) ? "03" : "01";
+  const acc = `0x${accountType}${u8aToHex2(
+    decodeAddress2(address),
+    -1,
+    false
+  )}00`;
+  return destination.parachainId ? [`0x0000000${destination.parachainId.toString(16)}`, acc] : [acc];
+}
+function getDestinationMultilocation(address, destination) {
+  const interior = getPrecompileDestinationInterior(destination, address);
+  return [1, interior];
+}
+function getDestinationParachainMultilocation(destination) {
+  if (destination.isRelay) {
+    return [1, []];
+  }
+  return [1, [`0x00${destination.parachainId.toString(16).padStart(8, "0")}`]];
+}
+function encodeXcmMessageToBytes(xcmMessage, api) {
+  if (!api) {
+    throw new Error("API is required to encode XCM message");
+  }
+  try {
+    const versionedXcm = api.createType("XcmVersionedXcm", xcmMessage);
+    return versionedXcm.toHex();
+  } catch (error) {
+    console.error("Failed to encode XCM message:", error);
+    throw error;
+  }
+}
+
 // src/contract/contracts/XcmPrecompile/XcmPrecompileAbi.ts
 var XCM_ABI = [
   {
@@ -784,7 +831,7 @@ function XcmPrecompile() {
           abi: XCM_ABI,
           args: [
             destination.parachainId,
-            u8aToHex2(decodeAddress2(destinationAddress)),
+            u8aToHex3(decodeAddress3(destinationAddress)),
             assets3,
             0
           ],
@@ -799,7 +846,7 @@ function XcmPrecompile() {
           address: XCM_PRECOMPILE_ADDRESS,
           abi: XCM_ABI,
           args: [
-            u8aToHex2(decodeAddress2(destinationAddress)),
+            u8aToHex3(decodeAddress3(destinationAddress)),
             [[asset.address, asset.amount]],
             0
           ],
@@ -807,6 +854,47 @@ function XcmPrecompile() {
           module: "Xcm"
         });
       }
+    }),
+    transferAssetsUsingTypeAndThenAddress: (shouldTransferAssetPrecedeFeeAsset = false) => ({
+      build: ({
+        destinationAddress,
+        asset,
+        fee,
+        destination,
+        destinationApi,
+        sourceApi
+      }) => {
+        const assets3 = getAssets(
+          asset,
+          fee,
+          shouldTransferAssetPrecedeFeeAsset
+        );
+        const destLocation = getDestinationParachainMultilocation(destination);
+        const xcmMessage = buildXcmMessage(
+          assets3,
+          destinationAddress,
+          sourceApi
+        );
+        const customXcmOnDest = encodeXcmMessageToBytes(
+          xcmMessage,
+          destinationApi
+        );
+        const feeIndex = shouldTransferAssetPrecedeFeeAsset ? 1 : 0;
+        return new ContractConfig({
+          address: XCM_PRECOMPILE_ADDRESS,
+          abi: XCM_ABI,
+          args: [
+            destLocation,
+            assets3,
+            2 /* DestinationReserve */,
+            feeIndex,
+            2 /* DestinationReserve */,
+            customXcmOnDest
+          ],
+          func: "transferAssetsUsingTypeAndThenAddress",
+          module: "Xcm"
+        });
+      }
     })
   };
 }
@@ -822,29 +910,38 @@ function getAssets(asset, feeAsset, shouldTransferAssetPrecedeFeeAsset) {
     [asset.address, asset.amount]
   ];
 }
+function buildXcmMessage(assets3, destinationAddress, sourceApi) {
+  const xcmVersion = getExtrinsicArgumentVersion(
+    sourceApi?.tx.polkadotXcm?.send || sourceApi?.tx.xcmPallet?.send
+  );
+  const instruction = {
+    DepositAsset: {
+      assets: { Wild: { AllCounted: assets3.length } },
+      beneficiary: {
+        parents: 0,
+        interior: {
+          X1: [
+            {
+              AccountId32: {
+                id: u8aToHex3(decodeAddress3(destinationAddress)),
+                network: null
+              }
+            }
+          ]
+        }
+      }
+    }
+  };
+  return {
+    [xcmVersion]: [instruction]
+  };
+}
 
 // src/contract/contracts/Xtokens/Xtokens.ts
 import { formatAssetIdToERC20 } from "@moonbeam-network/xcm-utils";
 import { u8aToHex as u8aToHex4 } from "@polkadot/util";
 import { decodeAddress as decodeAddress4, evmToAddress } from "@polkadot/util-crypto";
 
-// src/builder.utils.ts
-import { EvmParachain } from "@moonbeam-network/xcm-types";
-import { u8aToHex as u8aToHex3 } from "@polkadot/util";
-import { decodeAddress as decodeAddress3 } from "@polkadot/util-crypto";
-function getPrecompileDestinationInterior(destination, address) {
-  if (!address) {
-    return [`0x0000000${destination.parachainId.toString(16)}`];
-  }
-  const accountType = EvmParachain.is(destination) ? "03" : "01";
-  const acc = `0x${accountType}${u8aToHex3(
-    decodeAddress3(address),
-    -1,
-    false
-  )}00`;
-  return destination.parachainId ? [`0x0000000${destination.parachainId.toString(16)}`, acc] : [acc];
-}
-
 // src/contract/contracts/Xtokens/XtokensABI.ts
 var XTOKENS_ABI = [
   {
@@ -1021,10 +1118,6 @@ function getDestinationMultilocationForPrecompileDestination(address, destinatio
     destination.parachainId ? [`0x0000000${destination.parachainId.toString(16)}`, acc] : [acc]
   ];
 }
-function getDestinationMultilocation(address, destination) {
-  const interior = getPrecompileDestinationInterior(destination, address);
-  return [1, interior];
-}
 
 // src/contract/ContractBuilder.ts
 function ContractBuilder() {
@@ -2048,7 +2141,7 @@ function polkadotXcm() {
     transferAssetsUsingTypeAndThen: () => {
       const func = "transferAssetsUsingTypeAndThen";
       return {
-        here: () => ({
+        here: (parents = 0) => ({
           build: (params) => new ExtrinsicConfig({
             module: pallet2,
             func,
@@ -2071,7 +2164,7 @@ function polkadotXcm() {
                   [version]: [
                     {
                       id: {
-                        parents: 0,
+                        parents,
                         interior: "Here"
                       },
                       fun: {
@@ -2083,7 +2176,7 @@ function polkadotXcm() {
                 "LocalReserve",
                 {
                   [version]: {
-                    parents: 0,
+                    parents,
                     interior: "Here"
                   }
                 },
@@ -2112,6 +2205,92 @@ function polkadotXcm() {
             }
           })
         }),
+        X2: (parents = 0) => ({
+          build: (params) => new ExtrinsicConfig({
+            module: pallet2,
+            func,
+            getArgs: (extrinsicFunction) => {
+              const version = getExtrinsicArgumentVersion(extrinsicFunction);
+              const isSameAsset = params.asset.isSame(params.fee);
+              const shouldFeeAssetPrecede = shouldFeeAssetPrecedeAsset(params);
+              const asset = {
+                parents: 0,
+                interior: {
+                  X2: [
+                    {
+                      PalletInstance: params.asset.getAssetPalletInstance()
+                    },
+                    {
+                      GeneralIndex: params.asset.getAssetId()
+                    }
+                  ]
+                }
+              };
+              const assetWithAmount = {
+                id: asset,
+                fun: { Fungible: params.asset.amount }
+              };
+              const feeAsset = {
+                parents,
+                interior: "Here"
+              };
+              const feeAssetWithAmount = {
+                id: feeAsset,
+                fun: { Fungible: params.fee.amount }
+              };
+              const assets3 = isSameAsset ? [assetWithAmount] : shouldFeeAssetPrecede ? [feeAssetWithAmount, assetWithAmount] : [assetWithAmount, feeAssetWithAmount];
+              return [
+                // dest
+                {
+                  [version]: {
+                    parents: 1,
+                    interior: {
+                      X1: [
+                        {
+                          Parachain: params.destination.parachainId
+                        }
+                      ]
+                    }
+                  }
+                },
+                // assets
+                {
+                  [version]: assets3
+                },
+                // assetsTransferType
+                "LocalReserve",
+                // remoteFeesId
+                {
+                  [version]: isSameAsset ? asset : feeAsset
+                },
+                // feesTransferType
+                "LocalReserve",
+                // customXcmOnDest
+                {
+                  [version]: [
+                    {
+                      DepositAsset: {
+                        assets: {
+                          Wild: { AllCounted: isSameAsset ? 1 : 2 }
+                        },
+                        beneficiary: {
+                          parents: 0,
+                          interior: {
+                            X1: [
+                              getExtrinsicAccount(params.destinationAddress)
+                            ]
+                          }
+                        }
+                      }
+                    }
+                  ]
+                },
+                // weightLimit
+                "Unlimited"
+              ];
+            }
+          })
+        }),
         // TODO we could pass a parameter globalConsensus in the chain asset if we need a different one
         globalConsensusEthereum: () => ({
           build: (params) => new ExtrinsicConfig({
@@ -6143,6 +6322,7 @@ export {
   Protocols,
   SubstrateCallConfig,
   SubstrateQueryConfig,
+  TransferType,
   WormholeConfig,
   XcmVersion,
   calculateSystemAccountBalance,