@moonbeam-network/xcm-builder 1.0.0-dev.281 → 1.0.0-dev.283

package/build/index.d.ts

@@ -494,7 +494,7 @@ declare class SubstrateCallConfig {
 }
 
 type FeeConfigBuilder = ConfigBuilder<SubstrateCallConfig | ContractConfig, FeeConfigBuilderParams>;
-type BridgeFeeConfigBuilder = ConfigBuilder<SubstrateQueryConfig | ContractConfig, BridgeFeeConfigBuilderParams>;
+type ProtocolFeeConfigBuilder = ConfigBuilder<SubstrateQueryConfig | ContractConfig, ProtocolFeeConfigBuilderParams>;
 interface FeeConfigBuilderParams {
     address: string;
     api: ApiPromise;
@@ -504,13 +504,8 @@ interface FeeConfigBuilderParams {
     feeAsset: ChainAsset;
     source: AnyChain;
 }
-interface BridgeFeeConfigBuilderParams {
-    asset: ChainAsset;
-    feeAsset: ChainAsset;
-    address: string;
-    balance?: AssetAmount;
-    destination: AnyChain;
-    source: AnyChain;
+interface ProtocolFeeConfigBuilderParams extends Omit<FeeConfigBuilderParams, 'api'> {
+    bridgeChainFee: AssetAmount;
 }
 interface XcmPaymentFeeProps {
     isAssetReserveChain: boolean;
@@ -526,11 +521,14 @@ interface MoonbeamRuntimeXcmConfigAssetType extends Enum {
 type GetVersionedAssetId = (params: FeeConfigBuilderParams) => Promise<object> | object;
 
 declare function gateway(): {
-    quoteSendTokenFee(): BridgeFeeConfigBuilder;
+    quoteSendTokenFee(): ProtocolFeeConfigBuilder;
 };
 
 declare function outboundQueueApi(): {
-    calculateFee: () => BridgeFeeConfigBuilder;
+    calculateFee: () => {
+        mintForeignToken: () => ProtocolFeeConfigBuilder;
+        agentExecute: () => ProtocolFeeConfigBuilder;
+    };
 };
 
 declare function xcmPaymentApi(): {
@@ -607,6 +605,7 @@ interface SnowbridgeFunctionArgs {
     destinationParaId: number;
     amount: bigint;
     bridgeFeeAmount: bigint;
+    bridgeChainFee: bigint;
     requiresApproval: boolean;
 }
 interface SnowbridgeConfigConstructorParams {
@@ -1739,6 +1738,7 @@ type MrlExecuteConfigBuilder = ConfigBuilder<ContractConfig, MrlExecuteBuilderPa
 interface MrlBuilderParams extends BuilderParams<AnyChain> {
     isAutomatic: boolean;
     protocolFee?: AssetAmount;
+    bridgeChainFee?: AssetAmount;
     moonApi: ApiPromise;
     moonAsset: ChainAsset;
     bridgeChain: AnyParachain;
@@ -1931,4 +1931,4 @@ declare function MrlBuilder(): {
 
 declare const BATCH_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000000808";
 
-export { type AssetAddressFormat, AssetMinBuilder, type AssetMinConfigBuilder, type AssetMinConfigBuilderParams, type AssetMultilocation, BATCH_CONTRACT_ABI, BATCH_CONTRACT_ADDRESS, BalanceBuilder, type BalanceBuilderParams, type BalanceConfigBuilder, type BridgeFeeConfigBuilder, type BridgeFeeConfigBuilderParams, 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, GATEWAY_ABI, type GetVersionedAssetId, MonitoringBuilder, type MonitoringBuilderConfig, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlExecuteBuilderParams, type MrlExecuteConfigBuilder, type MrlTransferConfig, type PalletBalancesAccountDataOld, type Parents, Protocols, Provider, type QueryConfigConstructorParams, SnowbridgeConfig, type SnowbridgeConfigConstructorParams, type SnowbridgeFunctionArgs, type SnowbridgeFunctions, SubstrateCallConfig, type SubstrateCallConfigConstructorParams, SubstrateQueryConfig, type TokensPalletAccountData, type Transact, TransferType, WormholeConfig, type WormholeConfigConstructorParams, type WormholeFunctionArgs, type WormholeTransferFunctions, type XcmPaymentFeeProps, XcmVersion, calculateSystemAccountBalance, evm, snowbridge, substrate, wormhole, wormholeFactory };
+export { type AssetAddressFormat, AssetMinBuilder, type AssetMinConfigBuilder, type AssetMinConfigBuilderParams, type AssetMultilocation, 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, GATEWAY_ABI, type GetVersionedAssetId, MonitoringBuilder, type MonitoringBuilderConfig, type MoonbeamRuntimeXcmConfigAssetType, MrlBuilder, type MrlBuilderParams, type MrlConfigBuilder, type MrlExecuteBuilderParams, type MrlExecuteConfigBuilder, type MrlTransferConfig, type PalletBalancesAccountDataOld, type Parents, type ProtocolFeeConfigBuilder, type ProtocolFeeConfigBuilderParams, Protocols, Provider, type QueryConfigConstructorParams, SnowbridgeConfig, type SnowbridgeConfigConstructorParams, type SnowbridgeFunctionArgs, type SnowbridgeFunctions, SubstrateCallConfig, type SubstrateCallConfigConstructorParams, SubstrateQueryConfig, type TokensPalletAccountData, type Transact, TransferType, WormholeConfig, type WormholeConfigConstructorParams, type WormholeFunctionArgs, type WormholeTransferFunctions, type XcmPaymentFeeProps, XcmVersion, calculateSystemAccountBalance, evm, snowbridge, substrate, wormhole, wormholeFactory };

package/build/index.mjs

@@ -3912,7 +3912,7 @@ function gateway() {
   return {
     quoteSendTokenFee() {
       return {
-        build: ({ asset, destination, source }) => {
+        build: ({ asset, destination, source, bridgeChainFee }) => {
           if (!asset.address) {
             throw new Error(`Asset ${asset.key} has no address`);
           }
@@ -3932,8 +3932,7 @@ function gateway() {
             args: [
               asset.address,
               destination.parachainId,
-              10000000000000n
-              // TODO mjm get from config? if not possible, we could default this, as it doesn't affect when sending to relay chain
+              bridgeChainFee.amount
             ],
             func: "quoteSendTokenFee",
             module: "Gateway"
@@ -3947,8 +3946,8 @@ function gateway() {
 // src/fee/outboundQueueApi/outboundQueueApi.ts
 function outboundQueueApi() {
   return {
-    calculateFee: () => {
-      return {
+    calculateFee: () => ({
+      mintForeignToken: () => ({
         build: ({ address, balance, feeAsset }) => {
           const args = [
             {
@@ -3968,8 +3967,34 @@ function outboundQueueApi() {
             transform: async (data) => data.local.toBigInt() + data.remote.toBigInt()
           });
         }
-      };
-    }
+      }),
+      agentExecute: () => ({
+        build: ({ address, balance, destination }) => {
+          const assetInDestination = balance ? destination.getChainAsset(balance) : void 0;
+          const args = [
+            {
+              AgentExecute: {
+                agentId: "0x0000000000000000000000000000000000000000000000000000000000000000",
+                // actual value is not important
+                TokenTransfer: {
+                  tokenId: assetInDestination?.address,
+                  recipient: address,
+                  amount: balance?.amount
+                }
+              }
+            },
+            null
+          ];
+          return new SubstrateQueryConfig({
+            module: "outboundQueueApi",
+            func: "calculateFee",
+            args,
+            queryType: "call",
+            transform: async (data) => data.local.toBigInt() + data.remote.toBigInt()
+          });
+        }
+      })
+    })
   };
 }
 
@@ -4720,27 +4745,49 @@ function Gateway() {
   return {
     sendToken: () => ({
       provider,
-      build: ({ asset, destinationAddress, protocolFee, destination }) => callSendToken(asset, protocolFee, destination, destinationAddress)
+      build: ({
+        asset,
+        destinationAddress,
+        protocolFee,
+        destination,
+        bridgeChainFee
+      }) => callSendToken(
+        asset,
+        protocolFee,
+        destination,
+        destinationAddress,
+        bridgeChainFee
+      )
     }),
     approveAndSendToken: () => ({
       provider,
-      build: ({ asset, destinationAddress, protocolFee, destination }) => {
+      build: ({
+        asset,
+        destinationAddress,
+        protocolFee,
+        destination,
+        bridgeChainFee
+      }) => {
         const requiresApproval = protocolFee && !protocolFee.isSame(asset);
         return callSendToken(
           asset,
           protocolFee,
           destination,
           destinationAddress,
+          bridgeChainFee,
           requiresApproval
         );
       }
     })
   };
 }
-function callSendToken(asset, protocolFee, destination, destinationAddress, requiresApproval = false) {
+function callSendToken(asset, protocolFee, destination, destinationAddress, bridgeChainFee, requiresApproval = false) {
   if (!protocolFee) {
     throw new Error("Protocol fee is required for Gateway module");
   }
+  if (!bridgeChainFee) {
+    throw new Error("Bridge chain fee is required for Gateway module");
+  }
   if (!EvmParachain4.isAnyParachain(destination)) {
     throw new Error(
       "Destination must be a Parachain or EvmParachain for sending token with Gateway module"
@@ -4753,6 +4800,7 @@ function callSendToken(asset, protocolFee, destination, destinationAddress, requ
       destinationParaId: destination.parachainId,
       amount: asset.amount,
       bridgeFeeAmount: protocolFee.amount,
+      bridgeChainFee: bridgeChainFee.amount,
       requiresApproval
     },
     func: "sendToken"
@@ -4794,7 +4842,6 @@ function polkadotXcm2() {
       const func = "transferAssetsUsingTypeAndThen";
       const provider = "snowbridge" /* Snowbridge */;
       return {
-        // TODO mjm rename ? nativeEth?
         canonicalEth: () => ({
           provider,
           build: ({ asset, destination, destinationAddress, protocolFee }) => {
@@ -4803,6 +4850,11 @@ function polkadotXcm2() {
                 "Destination must be an EVM chain for globalConsensus function"
               );
             }
+            if (!protocolFee) {
+              throw new Error(
+                "Bridge chain fee is required for the polkadotXcm.canonicalEth function"
+              );
+            }
             return new ExtrinsicConfig({
               module: pallet7,
               func,
@@ -4821,8 +4873,7 @@ function polkadotXcm2() {
                         parents: 1,
                         interior: "Here"
                       },
-                      fun: { Fungible: protocolFee?.amount }
-                      // TODO mjm
+                      fun: { Fungible: protocolFee.amount }
                     },
                     {
                       id: {