@moonbeam-network/xcm-builder 1.0.0-dev.290 → 1.0.0-dev.291

package/README.md

@@ -1,20 +1,46 @@
-The Builder package contains the builders for the queries, extrinsics, functions, and contract calls used in the Moonbeam XCM SDK and MRL SDK.
+# @moonbeam-network/xcm-builder
 
-# Documentation for the Moonbeam XCM SDK
+Builders for low-level transaction components used in the Moonbeam XCM SDK and MRL SDK.
 
-## v3 (current)
+## Package Information
 
-### Usage
+**NPM Package:** [https://www.npmjs.com/package/@moonbeam-network/xcm-builder](https://www.npmjs.com/package/@moonbeam-network/xcm-builder)
+
+**Package Level:** Level 3  
+**Depends on:** `@moonbeam-network/xcm-utils`, `@moonbeam-network/xcm-types`
+
+## Features
+
+This package provides builders for:
+
+- **Extrinsics** - Construction of blockchain transactions
+- **Contract calls** - Smart contract interaction helpers
+- **Balance retrieval** - Query account balances
+- **Fee calculation** - Estimate transaction costs
+- **Other low-level transaction helpers** - Various utilities for transaction construction
+
+## Documentation
+
+### v4 (current)
+
+#### Usage
 
 - [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/xcm)
 - [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/mrl)
 
-### References
+#### References
 
 - [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/xcm)
 - [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/mrl)
 
-## v2 (previous)
+### v3 (previous)
+
+#### Usage
+
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/mrl)
+
+#### References
 
-- [usage](https://moonbeam-foundation.github.io/xcm-sdk/v2/example-usage)
-- [references](https://moonbeam-foundation.github.io/xcm-sdk/v2/reference/interfaces)
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/mrl)

package/build/index.d.ts

@@ -1733,7 +1733,7 @@ declare enum Provider {
 }
 type MrlTransferConfig = ContractConfig | ExtrinsicConfig | WormholeConfig | SnowbridgeConfig;
 type MrlConfigBuilder = ConfigBuilder<MrlTransferConfig, MrlBuilderParams> & {
-    provider: Provider;
+    provider?: Provider;
 };
 type MrlExecuteConfigBuilder = ConfigBuilder<ContractConfig, MrlExecuteBuilderParams>;
 interface MrlBuilderParams extends BuilderParams<AnyChain> {
@@ -1796,12 +1796,7 @@ declare function snowbridge(): {
 };
 
 declare function Batch(): {
-    /**
-     * Transfers assets and XCM message using XTokens contract for multi-currency transfer.
-     * Uses parents: 1 for multilocation derivation.
-     */
-    transferAssetsAndMessageViaXtokens: () => MrlConfigBuilder;
-    transferAssetsAndMessageViaXcmPrecompile: () => MrlConfigBuilder;
+    transferAssetsAndMessage: () => MrlConfigBuilder;
 };
 
 declare function Gmp(): {
@@ -1828,7 +1823,7 @@ declare function ethereumXcm(): {
 };
 
 declare function polkadotXcm(): {
-    send: (transferAssetsPallet?: "polkadotXcm" | "xTokens") => MrlConfigBuilder;
+    send: () => MrlConfigBuilder;
 };
 
 declare function extrinsic(): {

package/build/index.mjs

@@ -1114,7 +1114,6 @@ function XcmPrecompile() {
       }),
       foreignErc20: () => ({
         build: (params) => {
-          console.log("params", params);
           return buildTransferAssetsLocation({
             ...params,
             assetsMultilocations: [
@@ -5179,7 +5178,7 @@ var CROSS_CHAIN_FEE = 100000000000000000n;
 function polkadotXcm3() {
   const provider = "wormhole" /* Wormhole */;
   return {
-    send: (transferAssetsPallet) => ({
+    send: () => ({
       provider,
       build: ({
         asset,
@@ -5205,15 +5204,12 @@ function polkadotXcm3() {
         if (!Parachain2.is(source)) {
           throw new Error("Source chain needs to be a parachain");
         }
-        console.log("sourceAddress", sourceAddress);
         const { address20: computedOriginAccount } = getMultilocationDerivedAddresses({
           address: sourceAddress,
           paraId: source.parachainId,
-          parents: 1
+          isParents: true
         });
-        console.log("computedOriginAccount", computedOriginAccount);
         const assetTransferTxs = getAssetTransferTxs({
-          transferAssetsPallet,
           asset,
           computedOriginAccount,
           destination,
@@ -5252,28 +5248,7 @@ function polkadotXcm3() {
     })
   };
 }
-function getDestinationMultilocation2(source, bridgeChain) {
-  const isDifferentEcosystem = source.ecosystem !== bridgeChain.ecosystem;
-  if (isDifferentEcosystem) {
-    return {
-      parents: 2,
-      interior: {
-        X2: [
-          { GlobalConsensus: getGlobalConsensus(bridgeChain) },
-          { Parachain: bridgeChain.parachainId }
-        ]
-      }
-    };
-  }
-  return {
-    parents: 1,
-    interior: {
-      X1: { Parachain: bridgeChain.parachainId }
-    }
-  };
-}
 function buildSendExtrinsic({
-  source,
   computedOriginAccount,
   moonAsset,
   bridgeChain,
@@ -5284,13 +5259,14 @@ function buildSendExtrinsic({
     throw new Error("Transact params are required");
   }
   const version = getExtrinsicArgumentVersion(sourceApi.tx.polkadotXcm.send);
-  console.log("transact", transact);
   return sourceApi.tx.polkadotXcm.send(
     {
-      [version]: normalizeX1(
-        version,
-        getDestinationMultilocation2(source, bridgeChain)
-      )
+      [version]: normalizeX1(version, {
+        parents: 1,
+        interior: {
+          X1: { Parachain: bridgeChain.parachainId }
+        }
+      })
     },
     {
       [version]: [
@@ -5366,49 +5342,6 @@ function buildSendExtrinsic({
   );
 }
 function getAssetTransferTxs({
-  transferAssetsPallet = "xTokens",
-  ...params
-}) {
-  console.log("transferAssetsPallet", transferAssetsPallet);
-  if (transferAssetsPallet === "xTokens") {
-    return getAssetTransferTxsFromXtokens(params);
-  }
-  if (transferAssetsPallet === "polkadotXcm") {
-    return getAssetTransferTxsForPolkadotXcm(params);
-  }
-  throw new Error(
-    "Invalid transferAssetsPallet for polkadotXcm().send() function"
-  );
-}
-function getAssetTransferTxsForPolkadotXcm({
-  asset,
-  computedOriginAccount,
-  moonApi,
-  moonAsset,
-  bridgeChain,
-  source,
-  sourceAddress,
-  sourceApi
-}) {
-  const { transferAssets } = sourceApi.tx.polkadotXcm;
-  const polkadotXcmBuilder = ExtrinsicBuilder().polkadotXcm().transferAssetsToEcosystem().X4();
-  const transferAssetsTx = transferAssets(
-    ...polkadotXcmBuilder.build({
-      asset,
-      destination: bridgeChain,
-      destinationAddress: computedOriginAccount,
-      destinationApi: moonApi,
-      fee: AssetAmount.fromChainAsset(source.getChainAsset(moonAsset), {
-        amount: CROSS_CHAIN_FEE + BUY_EXECUTION_FEE
-      }),
-      source,
-      sourceAddress,
-      sourceApi
-    }).getArgs(transferAssets)
-  );
-  return [transferAssetsTx];
-}
-function getAssetTransferTxsFromXtokens({
   asset,
   computedOriginAccount,
   fee,
@@ -5419,9 +5352,9 @@ function getAssetTransferTxsFromXtokens({
   sourceAddress,
   sourceApi
 }) {
+  const { transfer, transferMulticurrencies } = sourceApi.tx.xTokens;
   const transferBuilder = ExtrinsicBuilder().xTokens().transfer();
   const transferMulticurrenciesBuilder = ExtrinsicBuilder().xTokens().transferMultiCurrencies();
-  const { transfer, transferMulticurrencies } = sourceApi.tx.xTokens;
   if (asset.isSame(fee)) {
     const assetTransferTx = transfer(
       ...transferBuilder.build({
@@ -5472,8 +5405,8 @@ function getAssetTransferTxsFromXtokens({
   return [multiCurrenciesTransferTx];
 }
 
-// src/mrl/providers/wormhole/contract/Batch/abi/BatchContractAbi.ts
-var BATCH_ABI = [
+// src/mrl/providers/wormhole/contract/Batch/abi/peaq/PeaqBatchContractAbi.ts
+var PEAQ_BATCH_ABI = [
   {
     anonymous: false,
     inputs: [
@@ -5586,8 +5519,8 @@ var BATCH_ABI = [
   }
 ];
 
-// src/mrl/providers/wormhole/contract/Batch/abi/XcmUtilsContractAbi.ts
-var XCM_UTILS_ABI = [
+// src/mrl/providers/wormhole/contract/Batch/abi/peaq/PeaqXcmUtilsContractAbi.ts
+var PEAQ_XCM_UTILS_ABI = [
   {
     inputs: [
       {
@@ -5688,8 +5621,8 @@ var XCM_UTILS_ABI = [
   }
 ];
 
-// src/mrl/providers/wormhole/contract/Batch/abi/XtokensContractAbi.ts
-var XTOKENS_ABI2 = [
+// src/mrl/providers/wormhole/contract/Batch/abi/peaq/PeaqXtokensContractAbi.ts
+var PEAQ_XTOKENS_ABI = [
   {
     inputs: [
       {
@@ -6005,9 +5938,9 @@ var XTOKENS_ABI2 = [
 // src/mrl/providers/wormhole/contract/Batch/abi/abi.helpers.ts
 function getAbisForChain(_) {
   return {
-    BatchAbi: BATCH_ABI,
-    XcmUtilsAbi: XCM_UTILS_ABI,
-    XtokensAbi: XTOKENS_ABI2
+    BatchAbi: PEAQ_BATCH_ABI,
+    XcmUtilsAbi: PEAQ_XCM_UTILS_ABI,
+    XtokensAbi: PEAQ_XTOKENS_ABI
   };
 }
 
@@ -6016,14 +5949,22 @@ var module = "Batch";
 function Batch() {
   const provider = "wormhole" /* Wormhole */;
   return {
-    /**
-     * Transfers assets and XCM message using XTokens contract for multi-currency transfer.
-     * Uses parents: 1 for multilocation derivation.
-     */
-    transferAssetsAndMessageViaXtokens: () => ({
+    transferAssetsAndMessage: () => ({
       provider,
-      build: (params) => {
-        const { source, sourceAddress, sourceApi } = params;
+      build: ({
+        asset,
+        destination,
+        destinationAddress,
+        fee,
+        isAutomatic,
+        moonAsset,
+        bridgeChain,
+        moonApi,
+        source,
+        sourceAddress,
+        sourceApi,
+        transact
+      }) => {
         if (!EvmParachain5.is(source)) {
           throw new Error("Source chain needs to be an EVMParachain");
         }
@@ -6036,53 +5977,44 @@ function Batch() {
           );
         }
         const subMappedAddress = evmToAddress3(sourceAddress);
+        const { BatchAbi, XcmUtilsAbi, XtokensAbi } = getAbisForChain(source);
         const { address20: computedOriginAccount } = getMultilocationDerivedAddresses2({
           address: subMappedAddress,
           paraId: source.parachainId,
-          parents: 1
+          isParents: true
         });
-        const encodedXcmMessage = buildXcmMessage2({
-          asset: params.asset,
-          destination: params.destination,
-          destinationAddress: params.destinationAddress,
+        const send = buildSendExtrinsic({
+          asset,
+          destination,
+          destinationAddress,
           computedOriginAccount,
-          fee: params.fee,
-          isAutomatic: params.isAutomatic,
-          moonAsset: params.moonAsset,
-          bridgeChain: params.bridgeChain,
-          moonApi: params.moonApi,
+          fee,
+          isAutomatic,
+          moonAsset,
+          bridgeChain,
+          moonApi,
           source,
           sourceAddress,
           sourceApi,
-          transact: params.transact
+          transact
         });
-        const { BatchAbi, XcmUtilsAbi, XtokensAbi } = getAbisForChain(source);
-        const { destinationParachainAndAddress } = getDestinationInHex(
-          params.bridgeChain,
-          computedOriginAccount
-        );
+        const encodedXcmMessage = send.args[1].toHex();
+        const { destinationParachain, destinationParachainAndAddress } = getDestinationInHex(bridgeChain, computedOriginAccount);
         const { currencies, feeItem } = getCurrencies({
           source,
-          moonAsset: params.moonAsset,
-          asset: params.asset
+          moonAsset,
+          asset
         });
+        const weight = maxUint64;
         const multiTransferTxData = encodeFunctionData2({
           abi: XtokensAbi,
           functionName: "transferMultiCurrencies",
-          args: [
-            currencies,
-            feeItem,
-            destinationParachainAndAddress,
-            maxUint64
-          ]
+          args: [currencies, feeItem, destinationParachainAndAddress, weight]
         });
-        const xcmSendTxData = buildXcmSendTxData({
+        const xcmSendTxData = encodeFunctionData2({
           abi: XcmUtilsAbi,
-          destination: getDestinationInHex(
-            params.bridgeChain,
-            computedOriginAccount
-          ).destinationParachain,
-          encodedXcmMessage
+          functionName: "xcmSend",
+          args: [destinationParachain, encodedXcmMessage]
         });
         return new ContractConfig({
           address: source.contracts.Batch,
@@ -6097,97 +6029,9 @@ function Batch() {
           module
         });
       }
-    }),
-    transferAssetsAndMessageViaXcmPrecompile: () => ({
-      provider,
-      build: (params) => {
-        const { source, sourceAddress, sourceApi } = params;
-        if (!EvmParachain5.is(source)) {
-          throw new Error("Source chain needs to be an EVMParachain");
-        }
-        if (!sourceApi) {
-          throw new Error("Source API needs to be defined");
-        }
-        if (!params.bridgeChainFee) {
-          throw new Error("Bridge chain fee is required");
-        }
-        if (!source.contracts?.XcmUtils || !source.contracts?.Batch || !source.contracts?.XcmPrecompile) {
-          throw new Error(
-            "Source chain needs to have the XcmUtils, Batch and XcmPrecompile contract addresses configured"
-          );
-        }
-        const { address20: computedOriginAccount } = getMultilocationDerivedAddresses2({
-          address: sourceAddress,
-          paraId: source.parachainId,
-          parents: 2
-          // this function is only used for global consensus currently
-        });
-        console.log("computedOriginAccount", computedOriginAccount);
-        const encodedXcmMessage = buildXcmMessage2({
-          asset: params.asset,
-          destination: params.destination,
-          destinationAddress: params.destinationAddress,
-          computedOriginAccount,
-          fee: params.fee,
-          isAutomatic: params.isAutomatic,
-          moonAsset: params.moonAsset,
-          bridgeChain: params.bridgeChain,
-          moonApi: params.moonApi,
-          source,
-          sourceAddress,
-          sourceApi,
-          transact: params.transact
-        });
-        const { BatchAbi, XcmUtilsAbi } = getAbisForChain(source);
-        const transferAssetsCall = ContractBuilder().XcmPrecompile().transferAssetsLocation().foreignErc20().build({
-          sourceApi,
-          asset: params.asset,
-          fee: params.bridgeChainFee,
-          destination: params.bridgeChain,
-          destinationAddress: computedOriginAccount,
-          source,
-          sourceAddress
-        });
-        const transferAssetsCallData = transferAssetsCall.encodeFunctionData();
-        const globalConsensusDestination = getGlobalConsensusDestination(
-          sourceApi,
-          params.bridgeChain
-        );
-        const xcmSendTxData = buildXcmSendTxData({
-          abi: XcmUtilsAbi,
-          destination: {
-            parents: globalConsensusDestination[0],
-            interior: globalConsensusDestination[1]
-          },
-          encodedXcmMessage
-        });
-        return new ContractConfig({
-          address: source.contracts.Batch,
-          abi: BatchAbi,
-          args: [
-            [source.contracts.XcmPrecompile, source.contracts.XcmUtils],
-            [],
-            [transferAssetsCallData, xcmSendTxData],
-            []
-          ],
-          func: "batchAll",
-          module
-        });
-      }
     })
   };
 }
-function buildXcmMessage2(params) {
-  const send = buildSendExtrinsic(params);
-  return send.args[1].toHex();
-}
-function buildXcmSendTxData(params) {
-  return encodeFunctionData2({
-    abi: params.abi,
-    functionName: "xcmSend",
-    args: [params.destination, params.encodedXcmMessage]
-  });
-}
 function getDestinationInHex(bridgeChain, computedOriginAccount) {
   const destinationParachain = {
     parents: 1,
@@ -6319,28 +6163,28 @@ function wormhole() {
         destinationAddress,
         isAutomatic,
         moonApi,
-        bridgeChain,
+        bridgeChain: moonChain,
         source,
         sourceAddress
       }) => {
         const isSourceParachain = Parachain3.is(source);
-        const isDestinationMoonChain = destination.isEqual(bridgeChain);
+        const isDestinationMoonChain = destination.isEqual(moonChain);
         const isDestinationEvmChain = EvmChain4.is(destination);
         const isNativeAsset = asset.isSame(
-          isDestinationEvmChain ? bridgeChain.nativeAsset : source.nativeAsset
+          isDestinationEvmChain ? moonChain.nativeAsset : source.nativeAsset
         );
-        const tokenAddress = isNativeAsset ? "native" : isDestinationEvmChain ? bridgeChain.getChainAsset(asset).address : asset.address;
+        const tokenAddress = isNativeAsset ? "native" : isDestinationEvmChain ? moonChain.getChainAsset(asset).address : asset.address;
         const { address20: computedOriginAccount } = getMultilocationDerivedAddresses3({
           address: sourceAddress,
           paraId: isSourceParachain ? source.parachainId : void 0,
-          parents: 1
+          isParents: true
         });
         if (!tokenAddress) {
           throw new Error(`Asset ${asset.key} has no address`);
         }
         const wh = wormholeFactory(source);
-        const whSource = isDestinationEvmChain ? wh.getChain(bridgeChain.getWormholeName()) : wh.getChain(source.getWormholeName());
-        const whDestination = isDestinationEvmChain ? wh.getChain(destination.getWormholeName()) : wh.getChain(bridgeChain.getWormholeName());
+        const whSource = isDestinationEvmChain ? wh.getChain(moonChain.getWormholeName()) : wh.getChain(source.getWormholeName());
+        const whDestination = isDestinationEvmChain ? wh.getChain(destination.getWormholeName()) : wh.getChain(moonChain.getWormholeName());
         const whAsset = Wormhole2.tokenId(whSource.chain, tokenAddress);
         const whSourceAddress = Wormhole2.chainAddress(
           whSource.chain,
@@ -6357,12 +6201,7 @@ function wormhole() {
             from: whSourceAddress,
             to: whDestinationAddress,
             protocol: isAutomatic ? "AutomaticTokenBridge" /* AutomaticTokenBridge */ : "TokenBridge" /* TokenBridge */,
-            payload: isDestinationMoonChain || isDestinationEvmChain ? void 0 : getPayload({
-              destination,
-              destinationAddress,
-              moonApi,
-              bridgeChain
-            })
+            payload: isDestinationMoonChain || isDestinationEvmChain ? void 0 : getPayload({ destination, destinationAddress, moonApi })
           },
           func: "tokenTransfer"
         });
@@ -6373,57 +6212,16 @@ function wormhole() {
 function getPayload({
   moonApi,
   destination,
-  destinationAddress,
-  bridgeChain
-}) {
-  const destinationMultilocation = getDestinationMultilocation3({
-    destination,
-    destinationAddress,
-    moonApi,
-    bridgeChain
-  });
-  console.log("destinationMultilocation", destinationMultilocation.toHuman());
-  const action = moonApi.createType("XcmRoutingUserAction", {
-    destination: destinationMultilocation
-  });
-  const versioned = moonApi.createType("VersionedUserAction", {
-    V1: action
-  });
-  return versioned.toU8a();
-}
-function getDestinationMultilocation3({
-  moonApi,
-  destination,
-  destinationAddress,
-  bridgeChain
+  destinationAddress
 }) {
   if (!EvmParachain7.isAnyParachain(destination)) {
     throw new Error(
       `Destination ${destination.name} is not a Parachain or EvmParachain`
     );
   }
-  const version = getExtrinsicArgumentVersion(moonApi.tx.polkadotXcm.send);
-  const isDifferentEcosystem = destination.ecosystem !== bridgeChain.ecosystem;
   const isEvmDestination = EvmParachain7.is(destination);
-  if (isDifferentEcosystem) {
-    return moonApi.createType("XcmVersionedLocation", {
-      [version]: {
-        parents: 2,
-        interior: {
-          X3: [
-            {
-              GlobalConsensus: getGlobalConsensus(destination)
-            },
-            {
-              Parachain: destination.parachainId
-            },
-            getExtrinsicAccount(destinationAddress)
-          ]
-        }
-      }
-    });
-  }
-  return moonApi.createType("XcmVersionedLocation", {
+  const version = getExtrinsicArgumentVersion(moonApi.tx.polkadotXcm.send);
+  const multilocation = moonApi.createType("XcmVersionedLocation", {
     [version]: {
       parents: 1,
       interior: {
@@ -6438,6 +6236,13 @@ function getDestinationMultilocation3({
       }
     }
   });
+  const action = moonApi.createType("XcmRoutingUserAction", {
+    destination: multilocation
+  });
+  const versioned = moonApi.createType("VersionedUserAction", {
+    V1: action
+  });
+  return versioned.toU8a();
 }
 
 // src/mrl/providers/wormhole/contract/TokenBridge/TokenBridgeAbi.ts
@@ -7982,7 +7787,6 @@ function ethereumXcm() {
           functionName: "approve",
           args: [contract3.address, tokenAmountOnBridgeChain]
         });
-        console.log("transact contract ", contract3);
         const batchAll = encodeFunctionData3({
           abi: BATCH_CONTRACT_ABI,
           functionName: "batchAll",