@moonbeam-network/xcm-config 0.3.13 → 0.4.0

package/build/index.d.ts

@@ -1,18 +1,20 @@
-import { u128 } from '@polkadot/types';
+import { Type, u128, Struct } from '@polkadot/types';
 import { PalletBalancesAccountData } from '@polkadot/types/lookup';
 import { SubmittableExtrinsicFunction } from '@polkadot/api/types';
 
 declare enum AssetSymbol {
   ACA = 'ACA',
   ASTR = 'ASTR',
-  AUSD = 'AUSD',
   AUQ = 'AUQ',
+  AUSD = 'AUSD',
   BIT = 'BIT',
   BNC = 'BNC',
   CRAB = 'CRAB',
   CSM = 'CSM',
   DEV = 'DEV',
   DOT = 'DOT',
+  EQ = 'EQ',
+  EQD = 'EQD',
   GLMR = 'GLMR',
   HKO = 'HKO',
   IBTC = 'IBTC',
@@ -39,7 +41,7 @@ declare enum AssetSymbol {
   XRT = 'XRT',
 }
 
-declare type AssetId = number | bigint | string;
+type AssetId = number | bigint | string;
 interface Asset<Symbols extends AssetSymbol = AssetSymbol> {
   id: string;
   /**
@@ -86,6 +88,7 @@ interface Chain<ChainKeys extends ChainKey = ChainKey>
   ss58Format?: number;
   usesEthereumAccounts?: boolean;
   genesisHash: string;
+  assetsDecimals?: Record<string, number>;
 }
 interface XcmFeeAsset<Symbols extends AssetSymbol = AssetSymbol> {
   balance: BalanceConfig<Symbols>;
@@ -110,6 +113,7 @@ declare enum ChainKey {
   CrustShadow = 'CrustShadow',
   Darwinia = 'Darwinia',
   DarwiniaPangoro = 'DarwiniaPangoro',
+  EquilibriumAlphanet = 'EquilibriumAlphanet',
   Integritee = 'Integritee',
   Interlay = 'Interlay',
   Karura = 'Karura',
@@ -154,18 +158,28 @@ declare enum BalanceCurrencyTypes {
   FungibleToken = 'FungibleToken',
 }
 
-declare type BalanceConfig<Symbols extends AssetSymbol = AssetSymbol> =
+type BalanceConfig<Symbols extends AssetSymbol = AssetSymbol> =
   | SystemBalanceConfig
   | AssetsBalanceConfig
+  | EquilibriumSystemBalanceConfig
   | OrmlTokensBalanceConfig
   | TokensBalanceConfig<Symbols>;
-interface SystemBalanceConfig {
+interface SystemBalanceConfig<Data = PalletBalancesAccountData> {
   pallet: BalancePallet.System;
   function: BalanceFunction.Account;
   path: ['data'];
   getParams: (account: string) => [string];
-  calc: (data: PalletBalancesAccountData) => bigint;
+  calc: (data: Data) => bigint;
 }
+type EquilibriumSystemBalanceConfig = SystemBalanceConfig<Type>;
+type EquilibriumSystemBalanceData = Array<
+  [
+    number,
+    {
+      positive: number;
+    },
+  ]
+>;
 interface AssetsBalanceConfig {
   pallet: BalancePallet.Assets;
   function: BalanceFunction.Account;
@@ -197,9 +211,7 @@ interface TokensBalanceConfig<Symbols extends AssetSymbol = AssetSymbol> {
   getParams: (account: string) => [string, TokensBalanceParamAsset<Symbols>];
   calc: (data: TokensPalletAccountData) => bigint;
 }
-declare type TokensBalanceParamAsset<
-  Symbols extends AssetSymbol = AssetSymbol,
-> =
+type TokensBalanceParamAsset<Symbols extends AssetSymbol = AssetSymbol> =
   | {
       [BalanceCurrencyTypes.Token]: Symbols | AssetSymbol.KUSD;
     }
@@ -215,9 +227,7 @@ declare type TokensBalanceParamAsset<
   | {
       [BalanceCurrencyTypes.Token2]: AssetId;
     };
-declare type MinBalanceConfig =
-  | MinBalanceAssetsConfig
-  | MinBalanceAssetRegistryConfig;
+type MinBalanceConfig = MinBalanceAssetsConfig | MinBalanceAssetRegistryConfig;
 interface MinBalanceAssetsConfig {
   pallet: BalancePallet.Assets;
   function: BalanceFunction.Asset;
@@ -237,6 +247,12 @@ interface MinBalanceAssetRegistryConfig {
       },
   ];
 }
+interface PalletBalancesAccountDataOld extends Struct {
+  readonly free: u128;
+  readonly reserved: u128;
+  readonly miscFrozen: u128;
+  readonly feeFrozen: u128;
+}
 
 declare function createBalanceBuilder<
   Symbols extends AssetSymbol = AssetSymbol,
@@ -247,6 +263,7 @@ declare function createBalanceBuilder<
   minCurrencyMetadata: typeof minCurrencyMetadata;
   ormlTokens: typeof ormlTokens;
   system: typeof system;
+  systemEquilibrium: typeof systemEquilibrium;
   tokens: () => {
     foreignAsset: (asset: AssetId | Symbols) => TokensBalanceConfig<Symbols>;
     fungibleToken: (asset: AssetId) => TokensBalanceConfig<Symbols>;
@@ -265,8 +282,9 @@ declare function minCurrencyMetadata(
 ): MinBalanceAssetRegistryConfig;
 declare function ormlTokens(asset: AssetId): OrmlTokensBalanceConfig;
 declare function system(): SystemBalanceConfig;
+declare function systemEquilibrium(id: number): EquilibriumSystemBalanceConfig;
 
-declare type Parents = 0 | 1;
+type Parents = 0 | 1;
 interface XcmExtrinsicGetParams {
   account: string;
   amount: bigint;
@@ -279,6 +297,7 @@ declare enum ExtrinsicPallet {
   XcmPallet = 'xcmPallet',
   XTokens = 'xTokens',
   XTransfer = 'xTransfer',
+  EqBalances = 'eqBalances',
 }
 
 declare enum PolkadotXcmExtrinsic {
@@ -295,7 +314,7 @@ interface PolkadotXcmPallet {
   successEvent: PolkadotXcmExtrinsicSuccessEvent;
   getParams: (params: XcmExtrinsicGetParams) => PolkadotXcmPalletParams;
 }
-declare type PolkadotXcmPalletParams = [
+type PolkadotXcmPalletParams = [
   /**
    * destination
    */
@@ -347,7 +366,7 @@ declare enum XcmMLVersion {
   v1 = 'V1',
   v2 = 'V2',
 }
-declare type PolkadotXcmAssetParam = {
+type PolkadotXcmAssetParam = {
   id: {
     Concrete: {
       parents: Parents;
@@ -450,20 +469,19 @@ declare enum XTokensExtrinsicCurrencyTypes {
   Token2 = 'Token2',
 }
 
-declare type XTokensPallet<Symbols extends AssetSymbol = AssetSymbol> =
+type XTokensPallet<Symbols extends AssetSymbol = AssetSymbol> =
   | XTokensTransferExtrinsic<Symbols>
   | XTokensTransferMultiAssetExtrinsic<Symbols>
   | XTokensTransferMultiCurrenciesExtrinsic<Symbols>;
-declare type XTokensTransferExtrinsic<
-  Symbols extends AssetSymbol = AssetSymbol,
-> = XTokensBaseExtrinsic<XTokensExtrinsic.Transfer, Symbols>;
-declare type XTokensTransferMultiAssetExtrinsic<
+type XTokensTransferExtrinsic<Symbols extends AssetSymbol = AssetSymbol> =
+  XTokensBaseExtrinsic<XTokensExtrinsic.Transfer, Symbols>;
+type XTokensTransferMultiAssetExtrinsic<
   Symbols extends AssetSymbol = AssetSymbol,
 > = XTokensBaseExtrinsic<XTokensExtrinsic.TransferMultiAsset, Symbols>;
-declare type XTokensTransferMultiCurrenciesExtrinsic<
+type XTokensTransferMultiCurrenciesExtrinsic<
   Symbols extends AssetSymbol = AssetSymbol,
 > = XTokensBaseExtrinsic<XTokensExtrinsic.TransferMultiCurrencies, Symbols>;
-declare type XTokensWeightLimit =
+type XTokensWeightLimit =
   | number
   | {
       Limited: number;
@@ -484,47 +502,46 @@ interface XTokensParamsByExtrinsic<Symbols extends AssetSymbol = AssetSymbol> {
   [XTokensExtrinsic.TransferMultiAsset]: XTokensTransferMultiAssetExtrinsicParams<Symbols>;
   [XTokensExtrinsic.TransferMultiCurrencies]: XTokensTransferMultiCurrenciesExtrinsicParams<Symbols>;
 }
-declare type XTokensTransferExtrinsicParams<
-  Symbols extends AssetSymbol = AssetSymbol,
-> = [
-  /**
-   * asset
-   */
-  XTokensTransferExtrinsicParamsAsset<Symbols>,
-  /**
-   * amount
-   */
-  bigint,
-  /**
-   * destination
-   */
-  {
-    V1: {
-      parents: 1;
-      interior: {
-        X2: [
-          {
-            Parachain: number;
-          },
-          {
-            AccountKey20: {
-              network: 'Any';
-              /**
-               * account
-               */
-              key: string;
-            };
-          },
-        ];
+type XTokensTransferExtrinsicParams<Symbols extends AssetSymbol = AssetSymbol> =
+  [
+    /**
+     * asset
+     */
+    XTokensTransferExtrinsicParamsAsset<Symbols>,
+    /**
+     * amount
+     */
+    bigint,
+    /**
+     * destination
+     */
+    {
+      V1: {
+        parents: 1;
+        interior: {
+          X2: [
+            {
+              Parachain: number;
+            },
+            {
+              AccountKey20: {
+                network: 'Any';
+                /**
+                 * account
+                 */
+                key: string;
+              };
+            },
+          ];
+        };
       };
-    };
-  },
-  /**
-   * weight
-   */
-  XTokensWeightLimit,
-];
-declare type XTokensTransferMultiAssetExtrinsicParams<
+    },
+    /**
+     * weight
+     */
+    XTokensWeightLimit,
+  ];
+type XTokensTransferMultiAssetExtrinsicParams<
   Symbols extends AssetSymbol = AssetSymbol,
 > = [
   /**
@@ -581,7 +598,7 @@ declare type XTokensTransferMultiAssetExtrinsicParams<
    */
   XTokensWeightLimit,
 ];
-declare type XTokensTransferMultiCurrenciesExtrinsicParams<
+type XTokensTransferMultiCurrenciesExtrinsicParams<
   Symbols extends AssetSymbol = AssetSymbol,
 > = [
   [
@@ -630,7 +647,7 @@ declare type XTokensTransferMultiCurrenciesExtrinsicParams<
    */
   XTokensWeightLimit,
 ];
-declare type XTokensTransferExtrinsicParamsAsset<
+type XTokensTransferExtrinsicParamsAsset<
   Symbols extends AssetSymbol = AssetSymbol,
 > =
   | {
@@ -717,7 +734,7 @@ interface XTransferPallet {
   successEvent: XTransferExtrinsicSuccessEvent;
   getParams: (params: XcmExtrinsicGetParams) => XTransferPalletParams;
 }
-declare type XTransferPalletParams = [
+type XTransferPalletParams = [
   /**
    * asset
    */
@@ -760,7 +777,7 @@ interface XTransferConcreteParam {
   parents: Parents;
   interior: XTransferInteriorParam;
 }
-declare type XTransferInteriorParam =
+type XTransferInteriorParam =
   | 'Here'
   | {
       X2: [
@@ -786,6 +803,61 @@ declare function xTransfer<ChainKeys extends ChainKey>(
   };
 };
 
+declare enum EqBalancesExtrinsic {
+  XcmTransfer = 'xcmTransfer',
+}
+declare enum EqBalancesSuccessEvent {
+  ExtrinsicSuccess = 'ExtrinsicSuccess',
+}
+declare enum EqBalancesFee {
+  SovereignAccWillPay = 'SovereignAccWillPay',
+  TargetChainAccWillPay = 'TargetChainAccWillPay',
+  ThisAccWillPay = 'ThisAccWillPay',
+}
+
+interface EqBalancesPallet {
+  pallet: ExtrinsicPallet.EqBalances;
+  extrinsic: EqBalancesExtrinsic;
+  successEvent: EqBalancesSuccessEvent;
+  getParams: (params: XcmExtrinsicGetParams) => EqBalancesPalletParams;
+}
+type EqBalancesPalletParams = [
+  /**
+   * asset
+   */
+  number,
+  /**
+   * amount
+   */
+  bigint,
+  /**
+   * destination
+   */
+  {
+    parents: 1;
+    interior: {
+      X2: [
+        {
+          Parachain: number;
+        },
+        {
+          AccountKey20: {
+            network: 'Any';
+            /**
+             * account
+             */
+            key: string;
+          };
+        },
+      ];
+    };
+  },
+  /**
+   * Fee type
+   */
+  EqBalancesFee,
+];
+
 declare function createExtrinsicBuilder<
   Symbols extends AssetSymbol,
   ChainKeys extends ChainKey,
@@ -860,9 +932,18 @@ declare function createExtrinsicBuilder<
       };
     };
   };
+  eqBalances: () => {
+    xcmTransfer: () => {
+      successEvent: (event: EqBalancesSuccessEvent) => {
+        asset: (id: number) => {
+          fee: (fee: EqBalancesFee) => EqBalancesPallet;
+        };
+      };
+    };
+  };
 };
 
-declare type ExtrinsicConfig<Symbols extends AssetSymbol = AssetSymbol> =
+type ExtrinsicConfig<Symbols extends AssetSymbol = AssetSymbol> =
   | PolkadotXcmPallet
   | XcmPallet
   | XTokensPallet<Symbols>
@@ -913,7 +994,7 @@ interface DestinationMultilocationV1 {
   };
   toPrecompileMultilocation: () => PrecompileDestinationMultilocationV1;
 }
-declare type PrecompileDestinationMultilocationV1 = [Parents, [string]];
+type PrecompileDestinationMultilocationV1 = [Parents, [string]];
 interface GetterAccountMultilocationV1 {
   get: (account: string) => AccountMultilocationV1;
 }
@@ -1003,7 +1084,7 @@ interface PrecompileXcmTransactThroughSignedMultilocationParams {
    */
   overallWeight: bigint;
 }
-declare type XcmTransactThroughSignedParams = [
+type XcmTransactThroughSignedParams = [
   {
     V1: {
       parents: 1;
@@ -1063,7 +1144,7 @@ declare function createTransactBuilder<
   };
 };
 
-declare type WithdrawConfig<Symbols extends AssetSymbol = AssetSymbol> =
+type WithdrawConfig<Symbols extends AssetSymbol = AssetSymbol> =
   WithdrawXTokensConfig<Symbols>;
 interface WithdrawXTokensConfig<
   Symbols extends AssetSymbol = AssetSymbol,
@@ -1080,7 +1161,7 @@ interface WithdrawXTokensConfig<
     usesEthereumAccounts: boolean | undefined,
   ) => WithdrawXTokensParams;
 }
-declare type WithdrawXTokensParams = [
+type WithdrawXTokensParams = [
   /**
    * 1 - if transaction is going through a relay chain
    */
@@ -1188,15 +1269,15 @@ interface WithdrawConfigBuilder<
     config: WithdrawConfig<Symbols>;
   };
 }
-declare type AssetsMap<Symbols extends AssetSymbol = AssetSymbol> = Record<
+type AssetsMap<Symbols extends AssetSymbol = AssetSymbol> = Record<
   Symbols,
   Asset<Symbols>
 >;
-declare type ChainsMap<ChainKeys extends ChainKey = ChainKey> = Record<
+type ChainsMap<ChainKeys extends ChainKey = ChainKey> = Record<
   ChainKeys,
   Chain<ChainKeys>
 >;
-declare type ChainXcmConfigs<
+type ChainXcmConfigs<
   Symbols extends AssetSymbol = AssetSymbol,
   ChainKeys extends ChainKey = ChainKey,
 > = Partial<Record<AssetSymbol, XcmConfig<Symbols, ChainKeys>>>;
@@ -1209,7 +1290,7 @@ interface XcmConfig<
   deposit: Partial<Record<ChainKeys, DepositConfig<Symbols>>>;
   withdraw: Partial<Record<ChainKeys, WithdrawConfig<Symbols>>>;
 }
-declare type ChainTransactConfigs<
+type ChainTransactConfigs<
   Symbols extends AssetSymbol = AssetSymbol,
   ChainKeys extends ChainKey = ChainKey,
 > = Partial<Record<ChainKeys, TransactConfig<Symbols, ChainKeys>>>;
@@ -1287,6 +1368,8 @@ declare const moonbase: XcmConfigBuilder<
   | AssetSymbol.AUQ
   | AssetSymbol.BIT
   | AssetSymbol.DEV
+  | AssetSymbol.EQ
+  | AssetSymbol.EQD
   | AssetSymbol.LIT
   | AssetSymbol.NEER
   | AssetSymbol.PARING
@@ -1295,6 +1378,7 @@ declare const moonbase: XcmConfigBuilder<
   | ChainKey.AlphanetRelay
   | ChainKey.BitCountryPioneer
   | ChainKey.DarwiniaPangoro
+  | ChainKey.EquilibriumAlphanet
   | ChainKey.LitentryAlphanet
   | ChainKey.MoonbaseBeta
   | ChainKey.StatemineAlphanet
@@ -1366,6 +1450,8 @@ declare const MOONBASE_ASSETS: readonly [
   AssetSymbol.AUQ,
   AssetSymbol.BIT,
   AssetSymbol.DEV,
+  AssetSymbol.EQ,
+  AssetSymbol.EQD,
   AssetSymbol.LIT,
   AssetSymbol.NEER,
   AssetSymbol.PARING,
@@ -1376,6 +1462,7 @@ declare const MOONBASE_ASSETS_MAP: AssetsMap<MoonbaseAssets>;
 
 declare const MOONBASE_CHAINS: readonly [
   ChainKey.AlphanetRelay,
+  ChainKey.EquilibriumAlphanet,
   ChainKey.LitentryAlphanet,
   ChainKey.BitCountryPioneer,
   ChainKey.DarwiniaPangoro,
@@ -1385,18 +1472,12 @@ declare const MOONBASE_CHAINS: readonly [
 ];
 declare const MOONBASE_CHAINS_MAP: ChainsMap<MoonbaseChains>;
 
-declare type MoonbaseAssets = typeof MOONBASE_ASSETS[number];
-declare type MoonbaseChains = typeof MOONBASE_CHAINS[number];
-declare type MoonbaseXcmConfig = XcmConfig<MoonbaseAssets, MoonbaseChains>;
-declare type MoonbaseXcmConfigs = ChainXcmConfigs<
-  MoonbaseAssets,
-  MoonbaseChains
->;
-declare type MoonbaseTransactConfig = TransactConfig<
-  MoonbaseAssets,
-  MoonbaseChains
->;
-declare type MoonbaseTransactConfigs = ChainTransactConfigs<
+type MoonbaseAssets = (typeof MOONBASE_ASSETS)[number];
+type MoonbaseChains = (typeof MOONBASE_CHAINS)[number];
+type MoonbaseXcmConfig = XcmConfig<MoonbaseAssets, MoonbaseChains>;
+type MoonbaseXcmConfigs = ChainXcmConfigs<MoonbaseAssets, MoonbaseChains>;
+type MoonbaseTransactConfig = TransactConfig<MoonbaseAssets, MoonbaseChains>;
+type MoonbaseTransactConfigs = ChainTransactConfigs<
   MoonbaseAssets,
   MoonbaseChains
 >;
@@ -1434,13 +1515,10 @@ declare const MOONBEAM_CHAINS: readonly [
 ];
 declare const MOONBEAM_CHAINS_MAP: ChainsMap<MoonbeamChains>;
 
-declare type MoonbeamAssets = typeof MOONBEAM_ASSETS[number];
-declare type MoonbeamChains = typeof MOONBEAM_CHAINS[number];
-declare type MoonbeamXcmConfig = XcmConfig<MoonbeamAssets, MoonbeamChains>;
-declare type MoonbeamXcmConfigs = ChainXcmConfigs<
-  MoonbeamAssets,
-  MoonbeamChains
->;
+type MoonbeamAssets = (typeof MOONBEAM_ASSETS)[number];
+type MoonbeamChains = (typeof MOONBEAM_CHAINS)[number];
+type MoonbeamXcmConfig = XcmConfig<MoonbeamAssets, MoonbeamChains>;
+type MoonbeamXcmConfigs = ChainXcmConfigs<MoonbeamAssets, MoonbeamChains>;
 
 declare const MOONBEAM_CONFIGS: MoonbeamXcmConfigs;
 
@@ -1484,13 +1562,10 @@ declare const MOONRIVER_CHAINS: readonly [
 ];
 declare const MOONRIVER_CHAINS_MAP: ChainsMap<MoonriverChains>;
 
-declare type MoonriverAssets = typeof MOONRIVER_ASSETS[number];
-declare type MoonriverChains = typeof MOONRIVER_CHAINS[number];
-declare type MoonriverXcmConfig = XcmConfig<MoonriverAssets, MoonriverChains>;
-declare type MoonriverXcmConfigs = ChainXcmConfigs<
-  MoonriverAssets,
-  MoonriverChains
->;
+type MoonriverAssets = (typeof MOONRIVER_ASSETS)[number];
+type MoonriverChains = (typeof MOONRIVER_CHAINS)[number];
+type MoonriverXcmConfig = XcmConfig<MoonriverAssets, MoonriverChains>;
+type MoonriverXcmConfigs = ChainXcmConfigs<MoonriverAssets, MoonriverChains>;
 
 declare const MOONRIVER_CONFIGS: MoonriverXcmConfigs;
 
@@ -1515,6 +1590,8 @@ export {
   DepositConfig,
   DepositConfigBuilder,
   DestinationMultilocationV1,
+  EquilibriumSystemBalanceConfig,
+  EquilibriumSystemBalanceData,
   ExtrinsicConfig,
   ExtrinsicPallet,
   GetterAccountMultilocationV1,
@@ -1555,6 +1632,7 @@ export {
   MoonriverXcmConfig,
   MoonriverXcmConfigs,
   OrmlTokensBalanceConfig,
+  PalletBalancesAccountDataOld,
   Parents,
   PolkadotXcmAssetParam,
   PolkadotXcmAssetParamInteriorX1,