Configure minimal balance for GLMR and MOVR on Acala and Karura (#36)

* [WIP] solution for considering GLMR - Acala min balance * add min balance to movr-karura * Fixing types * Fixing tests * do not consider existential deposit when is native asset Co-authored-by: Elmar Kenigs <[email protected]>
moonbeam-foundation · Oct 21, 2022 · 19f2d56 · 19f2d56
1 parent 2578ec1
commit 19f2d56
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 17 deletions.
diff --git a/packages/config/src/balance/__snapshots__/balance.test.ts.snap b/packages/config/src/balance/__snapshots__/balance.test.ts.snap
@@ -19,7 +19,7 @@ exports[`balance assets should get correct params 1`] = `
 ]
 `;
 
-exports[`balance min should be correct min config 1`] = `
+exports[`balance min should be correct minAssetPallet config 1`] = `
 {
   "function": "asset",
   "pallet": "assets",
@@ -32,6 +32,21 @@ exports[`balance min should be correct min config 1`] = `
 }
 `;
 
+exports[`balance min should be correct minAssetRegistryPallet config 1`] = `
+{
+  "function": "assetMetadatas",
+  "pallet": "assetRegistry",
+  "params": [
+    {
+      "ForeignAssetId": 1,
+    },
+  ],
+  "path": [
+    "minimalBalance",
+  ],
+}
+`;
+
 exports[`balance system should be correct system config 1`] = `
 {
   "calc": [Function],

diff --git a/packages/config/src/balance/balance.constants.ts b/packages/config/src/balance/balance.constants.ts
@@ -1,5 +1,6 @@
 export enum BalancePallet {
   Assets = 'assets',
+  AssetRegistry = 'assetRegistry',
   OrmlTokens = 'ormlTokens',
   System = 'system',
   Tokens = 'tokens',
@@ -9,4 +10,5 @@ export enum BalanceFunction {
   Account = 'account',
   Accounts = 'accounts',
   Asset = 'asset',
+  AssetMetadatas = 'assetMetadatas',
 }
diff --git a/packages/config/src/balance/balance.interfaces.ts b/packages/config/src/balance/balance.interfaces.ts
@@ -58,9 +58,20 @@ export interface TokensBalanceConfig<
   calc: (data: TokensPalletAccountData) => bigint;
 }
 
-export interface MinBalanceConfig {
+export type MinBalanceConfig =
+  | MinBalanceAssetsConfig
+  | MinBalanceAssetRegistryConfig;
+
+export interface MinBalanceAssetsConfig {
   pallet: BalancePallet.Assets;
   function: BalanceFunction.Asset;
   path: ['minBalance'];
   params: [AssetId];
 }
+
+export interface MinBalanceAssetRegistryConfig {
+  pallet: BalancePallet.AssetRegistry;
+  function: BalanceFunction.AssetMetadatas;
+  path: ['minimalBalance'];
+  params: [{ ForeignAssetId: AssetId }];
+}
diff --git a/packages/config/src/balance/balance.test.ts b/packages/config/src/balance/balance.test.ts
@@ -17,10 +17,12 @@ describe('balance', () => {
   });
 
   describe('min', () => {
-    const cfg = balance.min(1);
+    it('should be correct minAssetPallet config', () => {
+      expect(balance.minAssetPallet(1)).toMatchSnapshot();
+    });
 
-    it('should be correct min config', () => {
-      expect(cfg).toMatchSnapshot();
+    it('should be correct minAssetRegistryPallet config', () => {
+      expect(balance.minAssetRegistryPallet(1)).toMatchSnapshot();
     });
   });
 

diff --git a/packages/config/src/balance/balance.ts b/packages/config/src/balance/balance.ts
@@ -7,7 +7,8 @@ import { AssetId } from '../interfaces';
 import { BalanceFunction, BalancePallet } from './balance.constants';
 import {
   AssetsBalanceConfig,
-  MinBalanceConfig,
+  MinBalanceAssetRegistryConfig,
+  MinBalanceAssetsConfig,
   OrmlTokensBalanceConfig,
   SystemBalanceConfig,
   TokensBalanceConfig,
@@ -20,7 +21,8 @@ export function createBalanceBuilder<
 >() {
   return {
     assets,
-    min,
+    minAssetPallet,
+    minAssetRegistryPallet,
     ormlTokens,
     system,
     tokens: (asset: number | bigint | Symbols | 'MOVR' | 'KUSD' | 'AUSD') =>
@@ -38,7 +40,7 @@ function assets(asset: AssetId): AssetsBalanceConfig {
   };
 }
 
-function min(asset: AssetId): MinBalanceConfig {
+function minAssetPallet(asset: AssetId): MinBalanceAssetsConfig {
   return {
     pallet: BalancePallet.Assets,
     function: BalanceFunction.Asset,
@@ -47,6 +49,15 @@ function min(asset: AssetId): MinBalanceConfig {
   };
 }
 
+function minAssetRegistryPallet(asset: AssetId): MinBalanceAssetRegistryConfig {
+  return {
+    pallet: BalancePallet.AssetRegistry,
+    function: BalanceFunction.AssetMetadatas,
+    path: ['minimalBalance'],
+    params: [{ ForeignAssetId: asset }],
+  };
+}
+
 function ormlTokens(asset: AssetId): OrmlTokensBalanceConfig {
   return {
     pallet: BalancePallet.OrmlTokens,

diff --git a/packages/config/src/config/moonbase/assets/tt1.ts b/packages/config/src/config/moonbase/assets/tt1.ts
@@ -22,7 +22,7 @@ export const TT1: MoonbaseXcmConfig = {
       source: origin,
       balance: balance.assets(originAssetId),
       sourceFeeBalance: balance.system(),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       extrinsic: extrinsic
         .polkadotXcm()
         .limitedReserveTransferAssets()
@@ -35,7 +35,7 @@ export const TT1: MoonbaseXcmConfig = {
   withdraw: {
     [origin.key]: withdraw.xTokens({
       balance: balance.assets(originAssetId),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       destination: origin,
       feePerWeight: 1_265_000_000,
     }),

diff --git a/packages/config/src/config/moonbeam/assets/glmr.ts b/packages/config/src/config/moonbeam/assets/glmr.ts
@@ -84,6 +84,7 @@ export const GLMR: MoonbeamXcmConfig = {
       balance: balance.tokens(acalaGlmrId),
       destination: acala,
       feePerWeight: 8_000_000,
+      sourceMinBalance: balance.minAssetRegistryPallet(acalaGlmrId),
     }),
     [astar.key]: withdraw.xTokens({
       balance: balance.assets(astarGlmrId),

diff --git a/packages/config/src/config/moonbeam/assets/usdt.ts b/packages/config/src/config/moonbeam/assets/usdt.ts
@@ -16,7 +16,7 @@ export const USDT: MoonbeamXcmConfig = {
       source: origin,
       balance: balance.assets(originAssetId),
       sourceFeeBalance: balance.system(),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       extrinsic: extrinsic
         .polkadotXcm()
         .limitedReserveTransferAssets()

diff --git a/packages/config/src/config/moonriver/assets/movr.ts b/packages/config/src/config/moonriver/assets/movr.ts
@@ -103,6 +103,7 @@ export const MOVR: MoonriverXcmConfig = {
       balance: balance.tokens(karuraMovrId),
       destination: karura,
       feePerWeight: 50_000,
+      sourceMinBalance: balance.minAssetRegistryPallet(karuraMovrId),
     }),
     [khala.key]: withdraw.xTokens({
       balance: balance.assets(khalaMovrId),

diff --git a/packages/config/src/config/moonriver/assets/rmrk.ts b/packages/config/src/config/moonriver/assets/rmrk.ts
@@ -22,7 +22,7 @@ export const RMRK: MoonriverXcmConfig = {
       source: origin,
       balance: balance.assets(originAssetId),
       sourceFeeBalance: balance.system(),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       extrinsic: extrinsic
         .polkadotXcm()
         .limitedReserveTransferAssets()
@@ -35,7 +35,7 @@ export const RMRK: MoonriverXcmConfig = {
   withdraw: {
     [origin.key]: withdraw.xTokens({
       balance: balance.assets(originAssetId),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       destination: origin,
       feePerWeight: 0.000126,
     }),

diff --git a/packages/config/src/config/moonriver/assets/usdt.ts b/packages/config/src/config/moonriver/assets/usdt.ts
@@ -22,7 +22,7 @@ export const USDT: MoonriverXcmConfig = {
       source: origin,
       balance: balance.assets(originAssetId),
       sourceFeeBalance: balance.system(),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       extrinsic: extrinsic
         .polkadotXcm()
         .limitedReserveTransferAssets()
@@ -35,7 +35,7 @@ export const USDT: MoonriverXcmConfig = {
   withdraw: {
     [origin.key]: withdraw.xTokens({
       balance: balance.assets(originAssetId),
-      sourceMinBalance: balance.min(originAssetId),
+      sourceMinBalance: balance.minAssetPallet(originAssetId),
       destination: origin,
       feePerWeight: 0.00000126,
     }),

diff --git a/packages/sdk/src/polkadot/PolkadotService.ts b/packages/sdk/src/polkadot/PolkadotService.ts
@@ -109,7 +109,9 @@ export class PolkadotService<
     params,
     path,
   }: MinBalanceConfig): Promise<bigint> {
-    const details = await this.#api.query[pallet][fn](...params);
+    const details = (await this.#api.query[pallet][fn](
+      ...params,
+    )) as Option<any>;
 
     if (details.isEmpty) {
       return 0n;

diff --git a/packages/sdk/src/sdk/sdk.withdraw.ts b/packages/sdk/src/sdk/sdk.withdraw.ts
@@ -94,7 +94,7 @@ export async function getWithdrawData<
     await Promise.all([
       asset.isNative ? moonChain.decimals : polkadot.getAssetDecimals(asset),
       destinationPolkadot.getGenericBalance(destinationAccount, config.balance),
-      destinationPolkadot.getExistentialDeposit(),
+      asset.isNative ? 0n : destinationPolkadot.getExistentialDeposit(),
       config.sourceMinBalance
         ? destinationPolkadot.getAssetMinBalance(config.sourceMinBalance)
         : 0n,