merge main

moonbeam-foundation · Oct 8, 2024 · 533970a · 533970a
2 parents 8ee36af + 242c274
commit 533970a
Show file tree

Hide file tree

Showing 70 changed files with 844 additions and 251 deletions.
diff --git a/examples/sdk-simple/package.json b/examples/sdk-simple/package.json
@@ -12,9 +12,9 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@moonbeam-network/xcm-config": "2.5.12",
-    "@moonbeam-network/xcm-sdk": "2.5.14",
-    "@moonbeam-network/xcm-utils": "2.1.7"
+    "@moonbeam-network/xcm-config": "2.6.3",
+    "@moonbeam-network/xcm-sdk": "2.6.3",
+    "@moonbeam-network/xcm-utils": "2.2.0"
   },
   "devDependencies": {
     "bun": "^1.1.25"

diff --git a/mkdocs/docs/contribute.md b/mkdocs/docs/contribute.md
@@ -48,7 +48,7 @@ Follow these steps:
 3. Add your asset to the `assetsList` array at the end of the file
 
 !!! note
-    Assets are listed in alphabetical order. Please make sure you follow this order when adding new assets.
+Assets are listed in alphabetical order. Please make sure you follow this order when adding new assets.
 
 ## Add a Chain
 
@@ -120,7 +120,7 @@ To add a chain, take the following steps:
 4.  Add the newly created chain to the `chainsList` array at the end of the file
 
 !!! note
-    Chains are listed in alphabetical order. Please make sure you follow this order when adding new chains.
+Chains are listed in alphabetical order. Please make sure you follow this order when adding new chains.
 
 Now that you've added the chain, you can continue to the next section to add the assets that this chain supports.
 
@@ -242,7 +242,7 @@ Assuming that all of the required pallets and methods are already supported, you
 4. Add the newly created chain configurations to the `chainsConfigList` in the `xcm-sdk/blob/main/packages/config/src/configs/index.ts` file
 
 !!! note
-    Chain configurations are listed in alphabetical order. Please follow this order when adding new chain configurations.
+Chain configurations are listed in alphabetical order. Please follow this order when adding new chain configurations.
 
 For example, to add support to transfer USDT from the Polkadot Asset Hub to Moonbeam, the Polkadot Asset Hub configuration file is as follows:
 
@@ -267,7 +267,9 @@ export const polkadotAssetHubConfig = new ChainConfig({
       balance: BalanceBuilder().substrate().assets().account(),
       destination: moonbeam,
       destinationFee: {
-        amount: FeeBuilder().assetManager().assetTypeUnitsPerSecond(),
+        amount: FeeBuilder()
+          .xcmPaymentApi()
+          .xcmPaymentFee({ isAssetReserveChain: false }),
         asset: usdt,
         balance: BalanceBuilder().substrate().assets().account(),
       },

diff --git a/mkdocs/docs/reference/interfaces.md b/mkdocs/docs/reference/interfaces.md
@@ -44,7 +44,7 @@ Defines an asset's key and symbol used on the asset's origin chain.
 Defines properties related to an asset, including `Asset` properties, the decimals and symbol of the asset, and the amount an associated source or destination address has of the asset.
 
 !!! note
-    A few utility methods are available for working with the `AssetAmount` class that converts the amount to various formats. Please refer to the [Methods for Asset Conversions](./methods.md#asset-utilities) section.
+A few utility methods are available for working with the `AssetAmount` class that converts the amount to various formats. Please refer to the [Methods for Asset Conversions](./methods.md#asset-utilities) section.
 
 **Attributes**
 
@@ -692,7 +692,9 @@ Defines a chain's configurations, including information for each chain's support
       balance: BalanceBuilder().substrate().assets().account(),
       destination: moonbeam,
       destinationFee: {
-        amount: FeeBuilder().assetManager().assetTypeUnitsPerSecond(),
+        amount: FeeBuilder()
+          .xcmPaymentApi()
+          .xcmPaymentFee({ isAssetReserveChain: false }),
         asset: usdt,
         balance: BalanceBuilder().substrate().assets().account(),
       },
@@ -762,7 +764,9 @@ Defines an asset's configurations for a source chain and includes information ab
   balance: BalanceBuilder().substrate().assets().account(),
   destination: moonbeam,
   destinationFee: {
-    amount: FeeBuilder().assetManager().assetTypeUnitsPerSecond(),
+    amount: FeeBuilder()
+          .xcmPaymentApi()
+          .xcmPaymentFee({ isAssetReserveChain: false }),
     asset: usdt,
     balance: BalanceBuilder().substrate().assets().account(),
   },
@@ -832,7 +836,9 @@ Defines the fees for a particular asset on the destination chain.
 {
   asset: dot,
   balance: BalanceBuilder().substrate().system().account(),
-  amount: FeeBuilder().assetManager().assetTypeUnitsPerSecond(),
+  amount: amount: FeeBuilder()
+          .xcmPaymentApi()
+          .xcmPaymentFee({ isAssetReserveChain: false }),
 }
 ```
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/builder/CHANGELOG.md b/packages/builder/CHANGELOG.md
@@ -1,5 +1,24 @@
 # @moonbeam-network/xcm-builder
 
+## 2.5.1
+
+### Patch Changes
+
+- Updated dependencies [[`4be5659`](https://github.com/moonbeam-foundation/xcm-sdk/commit/4be5659c05fe2487dd6f440c833fdf7cdc369917)]:
+  - @moonbeam-network/xcm-utils@2.2.0
+  - @moonbeam-network/xcm-types@2.4.1
+
+## 2.5.0
+
+### Minor Changes
+
+- [#351](https://github.com/moonbeam-foundation/xcm-sdk/pull/351) [`2a7ed04`](https://github.com/moonbeam-foundation/xcm-sdk/commit/2a7ed04887ee41e5a6c010f213265028a953a769) Thanks [@mmaurello](https://github.com/mmaurello)! - Implement XcmPaymentApi to calculate fees for routes going to Moonbeam / Moonriver / Moonbase-Alpha
+
+### Patch Changes
+
+- Updated dependencies [[`2a7ed04`](https://github.com/moonbeam-foundation/xcm-sdk/commit/2a7ed04887ee41e5a6c010f213265028a953a769)]:
+  - @moonbeam-network/xcm-types@2.4.0
+
 ## 2.4.7
 
 ### Patch Changes

diff --git a/packages/builder/package.json b/packages/builder/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@moonbeam-network/xcm-builder",
-  "version": "2.4.7",
+  "version": "2.5.1",
   "description": "Moonbeam XCM builder",
   "scripts": {
     "build": "tsup",
@@ -49,8 +49,8 @@
   "types": "./build/index.d.ts",
   "main": "./build/index.cjs",
   "dependencies": {
-    "@moonbeam-network/xcm-types": "2.3.4",
-    "@moonbeam-network/xcm-utils": "2.1.7",
+    "@moonbeam-network/xcm-types": "2.4.1",
+    "@moonbeam-network/xcm-utils": "2.2.0",
     "big.js": "^6.2.1"
   },
   "peerDependencies": {

diff --git a/packages/builder/src/fee/FeeBuilder.interfaces.ts b/packages/builder/src/fee/FeeBuilder.interfaces.ts
@@ -1,12 +1,28 @@
-import { ChainAssetId } from '@moonbeam-network/xcm-types';
+import { AnyParachain, ChainAssetId } from '@moonbeam-network/xcm-types';
 import { ApiPromise } from '@polkadot/api';
+import { Enum } from '@polkadot/types';
+import { StagingXcmV3MultiLocation } from '@polkadot/types/lookup';
 import { SubstrateCallConfig } from '../types/substrate/SubstrateCallConfig';
 
 export interface FeeConfigBuilder {
   build: (params: FeeConfigBuilderPrams) => SubstrateCallConfig;
 }
 
 export interface FeeConfigBuilderPrams {
-  asset: ChainAssetId;
+  address: string;
   api: ApiPromise;
+  feeAsset: ChainAssetId;
+  transferAsset: ChainAssetId;
+  chain: AnyParachain;
+}
+
+export interface XcmPaymentFeeProps {
+  isAssetReserveChain: boolean;
+  shouldTransferAssetPrecedeAsset?: boolean;
+}
+
+export interface MoonbeamRuntimeXcmConfigAssetType extends Enum {
+  readonly isXcm: boolean;
+  readonly asXcm: StagingXcmV3MultiLocation;
+  readonly type: 'Xcm';
 }
diff --git a/packages/builder/src/fee/FeeBuilder.ts b/packages/builder/src/fee/FeeBuilder.ts
@@ -1,41 +1,67 @@
 /* eslint-disable sort-keys */
 /* eslint-disable @typescript-eslint/no-use-before-define */
 
-import { Option, u128 } from '@polkadot/types';
 import { SubstrateCallConfig } from '../types/substrate/SubstrateCallConfig';
-import { FeeConfigBuilder } from './FeeBuilder.interfaces';
+import { FeeConfigBuilder, XcmPaymentFeeProps } from './FeeBuilder.interfaces';
+import {
+  getBuyExecutionInstruction,
+  getClearOriginInstruction,
+  getDepositAssetInstruction,
+  getFeeForXcmInstructionsAndAsset,
+  getReserveAssetDepositedInstruction,
+  getSetTopicInstruction,
+  getVersionedAssetId,
+  getWithdrawAssetInstruction,
+} from './FeeBuilder.utils';
 
 export function FeeBuilder() {
   return {
-    assetManager,
+    xcmPaymentApi,
   };
 }
 
-function assetManager() {
+function xcmPaymentApi() {
   return {
-    assetTypeUnitsPerSecond: (weight = 1_000_000_000): FeeConfigBuilder => ({
-      build: ({ api, asset }) =>
+    xcmPaymentFee: ({
+      isAssetReserveChain,
+      shouldTransferAssetPrecedeAsset = false,
+    }: XcmPaymentFeeProps): FeeConfigBuilder => ({
+      build: ({ address, api, feeAsset, chain, transferAsset }) =>
         new SubstrateCallConfig({
           api,
           call: async (): Promise<bigint> => {
-            const type = (await api.query.assetManager.assetIdType(
-              asset,
-              // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            )) as unknown as Option<any>;
+            const versionedAssetId = await getVersionedAssetId(
+              api,
+              feeAsset,
+              chain,
+            );
+            const versionedTransferAssetId = await getVersionedAssetId(
+              api,
+              transferAsset,
+              chain,
+            );
+            const versionedAssets = shouldTransferAssetPrecedeAsset
+              ? [versionedTransferAssetId, versionedAssetId]
+              : [versionedAssetId, versionedTransferAssetId];
 
-            if (type.isNone) {
-              throw new Error(`No asset type found for asset ${asset}`);
-            }
+            const assets =
+              feeAsset === transferAsset ? [versionedAssetId] : versionedAssets;
 
-            const unwrappedType = type.unwrap();
+            const instructions = [
+              isAssetReserveChain
+                ? getWithdrawAssetInstruction(assets)
+                : getReserveAssetDepositedInstruction(assets),
+              getClearOriginInstruction(),
+              getBuyExecutionInstruction(versionedAssetId),
+              getDepositAssetInstruction(address, assets),
+              getSetTopicInstruction(),
+            ];
 
-            const res = (await api.query.assetManager.assetTypeUnitsPerSecond(
-              unwrappedType,
-            )) as unknown as Option<u128>;
-
-            const unitsPerSecond = res.unwrapOrDefault().toBigInt();
-
-            return (BigInt(weight) * unitsPerSecond) / BigInt(10 ** 12);
+            return getFeeForXcmInstructionsAndAsset(
+              api,
+              instructions,
+              versionedAssetId,
+            );
           },
         }),
     }),