@moonbeam-network/xcm-builder 1.0.0-dev.163 → 1.0.0-dev.165

package/README.md

@@ -1,14 +1,20 @@
-![Moonbeam](https://docs.moonbeam.network/images/builders/interoperability/xcm/sdk/xcm-sdk-banner.png)
+The Builder package contains the builders for the queries, extrinsics, functions, and contract calls used in the Moonbeam XCM SDK and MRL SDK.
 
-The Moonbeam XCM SDK enables developers to easily deposit and withdraw assets to Moonbeam/Moonriver from the relay chain and other parachains in the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to send XCM transfers. To deposit or withdraw assets, you simply define the asset and origin chain you want to deposit from or withdraw back to, along with the sending account's signer, and the amount to send.
+# Documentation for the Moonbeam XCM SDK
 
-# Documentation
+## v3 (current)
 
-## v1 (current)
+### Usage
 
-- TODO: (coming soon)
+- [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)
 
-## v0 (previous)
+### References
 
-- [usage](https://docs.moonbeam.network/builders/xcm/xcm-sdk/xcm-sdk/)
-- [references](https://docs.moonbeam.network/builders/xcm/xcm-sdk/reference/)
+- [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)
+
+- [usage](https://moonbeam-foundation.github.io/xcm-sdk/v2/example-usage)
+- [references](https://moonbeam-foundation.github.io/xcm-sdk/v2/reference/interfaces)

package/build/index.d.ts

@@ -82,7 +82,7 @@ type ContractConfigBuilder = ConfigBuilder<ContractConfig>;
 
 declare function Xtokens(): {
     transfer: (weight?: bigint) => ContractConfigBuilder;
-    transferMultiCurrencies: (weight?: bigint) => ContractConfigBuilder;
+    transferMultiCurrencies: (shouldTransferAssetPrecedeFeeAsset?: boolean, weight?: bigint) => ContractConfigBuilder;
     transferWithEvmTo32: (weight?: bigint) => ContractConfigBuilder;
 };
 
@@ -362,6 +362,7 @@ declare function polkadotXcm$1(): {
     };
     transferAssets: () => {
         here: () => ExtrinsicConfigBuilder;
+        X2AndFeeHere: () => ExtrinsicConfigBuilder;
     };
     transferAssetsUsingTypeAndThen: () => {
         globalConsensusEthereum: () => ExtrinsicConfigBuilder;
@@ -458,7 +459,7 @@ declare class WormholeConfig {
 declare function wormholeFactory(chain: AnyChain): Wormhole<"Mainnet" | "Testnet">;
 
 type MrlConfigBuilder = ConfigBuilder<ContractConfig | ExtrinsicConfig | WormholeConfig, MrlBuilderParams>;
-type MrlRedeemConfigBuilder = ConfigBuilder<ContractConfig, MrlRedeemBuilderParams>;
+type MrlExecuteConfigBuilder = ConfigBuilder<ContractConfig, MrlExecuteBuilderParams>;
 interface MrlBuilderParams extends BuilderParams<AnyChain> {
     isAutomatic: boolean;
     moonApi: ApiPromise;
@@ -468,7 +469,7 @@ interface MrlBuilderParams extends BuilderParams<AnyChain> {
     sendOnlyRemoteExecution?: boolean;
     transact?: Transact;
 }
-interface MrlRedeemBuilderParams {
+interface MrlExecuteBuilderParams {
     bytes?: Uint8Array;
 }
 interface Transact {
@@ -484,7 +485,7 @@ declare function Batch(): {
 };
 
 declare function Gmp(): {
-    wormholeTransferERC20: () => MrlRedeemConfigBuilder;
+    wormholeTransferERC20: () => MrlExecuteConfigBuilder;
 };
 
 declare function TokenBridge(): {
@@ -615,4 +616,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 EvmFunctionArgs, EvmQueryConfig, type EvmQueryConfigParams, type EvmQueryFunctions, ExtrinsicBuilder, ExtrinsicConfig, type ExtrinsicConfigBuilder, type ExtrinsicConfigConstructorParams, FeeBuilder, type FeeConfigBuilder, type FeeConfigBuilderParams, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlRedeemBuilderParams, type MrlRedeemConfigBuilder, type PalletBalancesAccountDataOld, type Parents, 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 { 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 EvmFunctionArgs, EvmQueryConfig, type EvmQueryConfigParams, type EvmQueryFunctions, ExtrinsicBuilder, ExtrinsicConfig, type ExtrinsicConfigBuilder, type ExtrinsicConfigConstructorParams, FeeBuilder, type FeeConfigBuilder, type FeeConfigBuilderParams, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlExecuteBuilderParams, type MrlExecuteConfigBuilder, type PalletBalancesAccountDataOld, type Parents, 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 };

package/build/index.mjs

@@ -355,29 +355,31 @@ function Xtokens() {
         module: "Xtokens"
       })
     }),
-    transferMultiCurrencies: (weight = U_64_MAX) => ({
-      build: ({ asset, destination, destinationAddress, fee }) => new ContractConfig({
-        address: XTOKENS_CONTRACT_ADDRESS,
-        abi: XTOKENS_ABI,
-        args: [
-          [
-            [
-              asset.address ? formatAssetIdToERC20(asset.address) : asset.getAssetId(),
-              asset.amount
-            ],
-            [
-              fee.address ? formatAssetIdToERC20(fee.address) : fee.getAssetId(),
-              fee.amount
-            ]
+    transferMultiCurrencies: (shouldTransferAssetPrecedeFeeAsset = true, weight = U_64_MAX) => ({
+      build: ({ asset, destination, destinationAddress, fee }) => {
+        const transferAsset = [
+          asset.address ? formatAssetIdToERC20(asset.address) : asset.getAssetId(),
+          asset.amount
+        ];
+        const feeAsset = [
+          fee.address ? formatAssetIdToERC20(fee.address) : fee.getAssetId(),
+          fee.amount
+        ];
+        const assets3 = shouldTransferAssetPrecedeFeeAsset ? [transferAsset, feeAsset] : [feeAsset, transferAsset];
+        const feeAssetIndex = shouldTransferAssetPrecedeFeeAsset ? 1 : 0;
+        return new ContractConfig({
+          address: XTOKENS_CONTRACT_ADDRESS,
+          abi: XTOKENS_ABI,
+          args: [
+            assets3,
+            feeAssetIndex,
+            getDestinationMultilocation(destinationAddress, destination),
+            weight
           ],
-          1,
-          // index of the fee asset
-          getDestinationMultilocation(destinationAddress, destination),
-          weight
-        ],
-        func: "transferMultiCurrencies",
-        module: "Xtokens"
-      })
+          func: "transferMultiCurrencies",
+          module: "Xtokens"
+        });
+      }
     }),
     transferWithEvmTo32: (weight = U_64_MAX) => ({
       build: ({ destinationAddress, asset, destination }) => {
@@ -904,7 +906,6 @@ function getPolkadotXcmExtrinsicArgs({
   func,
   parents = 1,
   feeIndex = 0
-  // biome-ignore lint/suspicious/noExplicitAny: not sure how to fix this
 }) {
   const version = getExtrinsicArgumentVersion(func);
   return [
@@ -1135,6 +1136,50 @@ function polkadotXcm() {
               });
             }
           })
+        }),
+        X2AndFeeHere: () => ({
+          build: (params) => new ExtrinsicConfig({
+            module: pallet2,
+            func,
+            getArgs: (extrinsicFunction) => {
+              const version = getExtrinsicArgumentVersion(extrinsicFunction);
+              return getPolkadotXcmExtrinsicArgs({
+                ...params,
+                func: extrinsicFunction,
+                asset: [
+                  {
+                    id: normalizeConcrete(version, {
+                      parents: 0,
+                      interior: {
+                        X2: [
+                          {
+                            PalletInstance: params.asset.getAssetPalletInstance()
+                          },
+                          {
+                            GeneralIndex: params.asset.getAssetId()
+                          }
+                        ]
+                      }
+                    }),
+                    fun: {
+                      Fungible: params.asset.amount
+                    }
+                  },
+                  // Fee Asset
+                  {
+                    id: normalizeConcrete(version, {
+                      parents: 1,
+                      interior: "Here"
+                    }),
+                    fun: {
+                      Fungible: params.fee.amount
+                    }
+                  }
+                ],
+                feeIndex: 1
+              });
+            }
+          })
         })
       };
     },