@moonbeam-network/xcm-config 1.0.0-dev.145 → 1.0.0-dev.147

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 PureStake
+Copyright 2024 Moonbeam Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/build/index.d.ts

@@ -1,145 +1,148 @@
-import {
-  Asset,
-  AnyChain,
-  Ecosystem,
-  Parachain,
-  EvmParachain,
-} from '@moonbeam-network/xcm-types';
-import {
-  BalanceConfigBuilder,
-  ContractConfigBuilder,
-  ExtrinsicConfigBuilder,
-  AssetMinConfigBuilder,
-  FeeConfigBuilder,
-} from '@moonbeam-network/xcm-builder';
+import { Asset, AnyChain, SetOptional, ChainAsset, AnyAsset, Ecosystem, Parachain, EvmParachain, EvmChain } from '@moonbeam-network/xcm-types';
+import { ContractConfigBuilder, ExtrinsicConfigBuilder, BalanceConfigBuilder, AssetMinConfigBuilder, MrlConfigBuilder, FeeConfigBuilder } from '@moonbeam-network/xcm-builder';
 
-interface AssetConfigConstructorParams {
-  asset: Asset;
-  balance: BalanceConfigBuilder;
-  contract?: ContractConfigBuilder;
-  destination: AnyChain;
-  destinationFee: DestinationFeeConfig;
-  extrinsic?: ExtrinsicConfigBuilder;
-  fee?: FeeAssetConfig;
-  min?: AssetMinConfigBuilder;
+interface AssetRouteConstructorParams {
+    source: SourceConfig;
+    destination: DestinationConfig;
+    contract?: ContractConfigBuilder;
+    extrinsic?: ExtrinsicConfigBuilder;
+    mrl?: MrlConfig;
 }
-interface DestinationFeeConfig extends FeeAssetConfig {
-  amount: number | FeeConfigBuilder;
-  destinationBalance?: BalanceConfigBuilder;
+interface SourceConfig {
+    asset: Asset;
+    chain: AnyChain;
+    balance: BalanceConfigBuilder;
+    fee?: FeeConfig;
+    destinationFee?: {
+        asset?: Asset;
+        balance: BalanceConfigBuilder;
+    };
+    min?: AssetMinConfigBuilder;
 }
-interface FeeAssetConfig {
-  asset: Asset;
-  balance: BalanceConfigBuilder;
-  xcmDeliveryFeeAmount?: number;
+interface DestinationConfig extends Omit<SourceConfig, 'fee'> {
+    fee: DestinationFeeConfig;
 }
-declare class AssetConfig {
-  readonly asset: Asset;
-  readonly balance: BalanceConfigBuilder;
-  readonly contract?: ContractConfigBuilder;
-  readonly destination: AnyChain;
-  readonly destinationFee: DestinationFeeConfig;
-  readonly extrinsic?: ExtrinsicConfigBuilder;
-  readonly fee?: FeeAssetConfig;
-  readonly min?: AssetMinConfigBuilder;
-  constructor({
-    asset,
-    balance,
-    contract,
-    destination,
-    destinationFee,
-    extrinsic,
-    fee,
-    min,
-  }: AssetConfigConstructorParams);
+interface FeeConfig {
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+    extra?: number;
 }
-
-interface ChainConfigConstructorParams {
-  assets: AssetConfig[];
-  chain: AnyChain;
+interface MrlConfig {
+    isAutomaticPossible: boolean;
+    transfer: MrlConfigBuilder;
+    moonChain: MoonChainConfig;
+}
+interface DestinationFeeConfig extends SetOptional<FeeConfig, 'balance'> {
+    amount: number | FeeConfigBuilder;
+}
+interface MoonChainConfig {
+    asset: Asset;
+    fee: MoonChainFeeConfig;
+}
+interface MoonChainFeeConfig extends FeeConfig {
+    amount: number | FeeConfigBuilder;
 }
-declare class ChainConfig {
-  #private;
-  readonly chain: AnyChain;
-  constructor({ assets, chain }: ChainConfigConstructorParams);
-  getAssetsConfigs(): AssetConfig[];
-  getAssetConfigs(asset: Asset): AssetConfig[];
-  getAssetDestinations(asset: Asset): AnyChain[];
-  getAssetDestinationConfig(asset: Asset, destination: AnyChain): AssetConfig;
+declare class AssetRoute {
+    readonly source: SourceConfig;
+    readonly destination: DestinationConfig;
+    readonly contract?: ContractConfigBuilder;
+    readonly extrinsic?: ExtrinsicConfigBuilder;
+    readonly mrl?: MrlConfig;
+    constructor({ source, destination, contract, extrinsic, mrl, }: AssetRouteConstructorParams);
+    getDestinationFeeAssetOnSource(): ChainAsset;
 }
 
-interface IConfigService {
-  getEcosystemAssets(ecosystem?: Ecosystem): Asset[];
-  getAsset(keyOrAsset: string | Asset): Asset;
-  getChain(keyOrAsset: string | AnyChain): AnyChain;
-  getSourceChains(asset: Asset, ecosystem: Ecosystem | undefined): AnyChain[];
-  getDestinationChains(asset: Asset, source: AnyChain): AnyChain[];
-  getAssetDestinationConfig(
-    asset: Asset,
-    source: AnyChain,
-    destination: AnyChain,
-  ): AssetConfig;
+interface ChainRoutesConstructorParams {
+    chain: AnyChain;
+    routes: RoutesParam[];
+}
+interface RoutesParam extends Omit<AssetRouteConstructorParams, 'source'> {
+    source: Omit<SourceConfig, 'chain'>;
+}
+declare class ChainRoutes {
+    #private;
+    readonly chain: AnyChain;
+    constructor({ chain, routes }: ChainRoutesConstructorParams);
+    getRoutes(): AssetRoute[];
+    getAssetRoutes(keyOrAsset: string | AnyAsset): AssetRoute[];
+    getAssetDestinations(keyOrAsset: string | AnyAsset): AnyChain[];
+    getDestinationAssets(keyOrChain: string | AnyChain): Asset[];
+    getAssetRoute(asset: string | AnyAsset, destination: string | AnyChain): AssetRoute;
 }
 
-interface ConfigServiceOptions {
-  assets?: Map<string, Asset>;
-  chains?: Map<string, AnyChain>;
-  chainsConfig?: Map<string, ChainConfig>;
+interface MrlAssetRouteConstructorParams extends AssetRouteConstructorParams {
+    source: MrlSourceConfig;
+}
+interface MrlSourceConfig extends SourceConfig {
+    moonChainFee?: {
+        asset: Asset;
+        balance: BalanceConfigBuilder;
+    };
 }
-declare class ConfigService implements IConfigService {
-  protected assets: Map<string, Asset>;
-  protected chains: Map<string, AnyChain>;
-  protected chainsConfig: Map<string, ChainConfig>;
-  constructor(options?: ConfigServiceOptions);
-  getEcosystemAssets(ecosystem?: Ecosystem): Asset[];
-  getAsset(keyOrAsset: string | Asset): Asset;
-  getChain(keyOrAsset: string | AnyChain): AnyChain;
-  getChainConfig(keyOrAsset: string | AnyChain): ChainConfig;
-  getSourceChains(asset: Asset, ecosystem: Ecosystem | undefined): AnyChain[];
-  getDestinationChains(asset: Asset, source: AnyChain): AnyChain[];
-  getAssetDestinationConfig(
-    asset: Asset,
-    source: AnyChain,
-    destination: AnyChain,
-  ): AssetConfig;
-  updateAsset(asset: Asset): void;
-  updateChain(chain: AnyChain): void;
-  updateChainConfig(chainConfig: ChainConfig): void;
+declare class MrlAssetRoute extends AssetRoute {
+    readonly source: MrlSourceConfig;
+    constructor({ source, destination, contract, extrinsic, mrl, }: MrlAssetRouteConstructorParams & {
+        source: MrlSourceConfig;
+    });
 }
 
-interface TransferConfig {
-  asset: Asset;
-  source: ChainTransferConfig;
-  destination: ChainTransferConfig;
+interface MrlChainRoutesConstructorParams extends ChainRoutesConstructorParams {
+    routes: MrlRoutesParam[];
 }
-interface ChainTransferConfig {
-  chain: AnyChain;
-  config: AssetConfig;
+interface MrlRoutesParam extends Omit<MrlAssetRouteConstructorParams, 'source'> {
+    source: Omit<MrlSourceConfig, 'chain'>;
+}
+declare class MrlChainRoutes extends ChainRoutes {
+    #private;
+    constructor({ chain, routes }: MrlChainRoutesConstructorParams);
+    getRoutes(): MrlAssetRoute[];
 }
 
-declare function ConfigBuilder(service?: IConfigService): {
-  assets: (ecosystem?: Ecosystem) => {
-    assets: Asset[];
-    asset: (keyOrAsset: string | Asset) => {
-      sourceChains: AnyChain[];
-      source: (keyOrChain: string | AnyChain) => {
-        destinationChains: AnyChain[];
-        destination: (keyOrChain: string | AnyChain) => {
-          build: () => TransferConfig;
-        };
-      };
-    };
-  };
-};
+interface ConfigServiceOptions {
+    assets?: Map<string, Asset>;
+    chains?: Map<string, AnyChain>;
+    routes: Map<string, ChainRoutes | MrlChainRoutes>;
+}
+declare class ConfigService {
+    protected assets: Map<string, Asset>;
+    protected chains: Map<string, AnyChain>;
+    protected routes: Map<string, ChainRoutes | MrlChainRoutes>;
+    constructor(options: ConfigServiceOptions);
+    getAsset(keyOrAsset: string | Asset): Asset;
+    getEcosystemAssets(ecosystem?: Ecosystem): Asset[];
+    getChain(keyOrChain: string | AnyChain): AnyChain;
+    getChainRoutes(keyOrChain: string | AnyChain): ChainRoutes | MrlChainRoutes;
+    getSourceChains({ asset, ecosystem, }: {
+        asset?: string | Asset;
+        ecosystem?: Ecosystem;
+    }): AnyChain[];
+    getDestinationChains({ asset, source, }: {
+        asset?: string | AnyAsset;
+        source: string | AnyChain;
+    }): AnyChain[];
+    getAssetRoute({ asset, source, destination, }: {
+        asset: string | AnyAsset;
+        source: string | AnyChain;
+        destination: string | AnyChain;
+    }): AssetRoute | MrlAssetRoute;
+    getRouteAssets({ source, destination, }: {
+        source: string | AnyChain;
+        destination: string | AnyChain;
+    }): Asset[];
+    updateAsset(asset: Asset): void;
+    updateChain(chain: AnyChain): void;
+    updateChainRoute(route: ChainRoutes): void;
+}
 
 declare const aca: Asset;
 declare const agng: Asset;
 declare const alan: Asset;
 declare const ampe: Asset;
 declare const apillon: Asset;
+declare const aseed: Asset;
 declare const astr: Asset;
 declare const atom: Asset;
 declare const auq: Asset;
-declare const aseed: Asset;
 declare const axlusdc: Asset;
 declare const betaDEV: Asset;
 declare const bnc: Asset;
@@ -147,13 +150,15 @@ declare const bncs: Asset;
 declare const cfg: Asset;
 declare const crab: Asset;
 declare const csm: Asset;
+declare const dai: Asset;
+declare const ded: Asset;
 declare const dev: Asset;
 declare const dot: Asset;
 declare const eq: Asset;
 declare const eqd: Asset;
-declare const dai: Asset;
-declare const ded: Asset;
 declare const fil: Asset;
+declare const ftm: Asset;
+declare const ftmwh: Asset;
 declare const glmr: Asset;
 declare const hdx: Asset;
 declare const ibtc: Asset;
@@ -168,8 +173,8 @@ declare const lit: Asset;
 declare const manta: Asset;
 declare const mgx: Asset;
 declare const movr: Asset;
-declare const nodl: Asset;
 declare const neuro: Asset;
+declare const nodl: Asset;
 declare const otp: Asset;
 declare const para: Asset;
 declare const paring: Asset;
@@ -193,9 +198,6 @@ declare const usdc: Asset;
 declare const usdcwh: Asset;
 declare const usdt: Asset;
 declare const usdtwh: Asset;
-declare const wbtc: Asset;
-declare const weth: Asset;
-declare const wftm: Asset;
 declare const vastr: Asset;
 declare const vbnc: Asset;
 declare const vdot: Asset;
@@ -204,10 +206,12 @@ declare const vglmr: Asset;
 declare const vksm: Asset;
 declare const vmanta: Asset;
 declare const vmovr: Asset;
+declare const wbtc: Asset;
+declare const weth: Asset;
+declare const wftm: Asset;
 declare const wifd: Asset;
 declare const xrt: Asset;
 declare const ztg: Asset;
-declare const ftmwh: Asset;
 declare const assetsList: Asset[];
 declare const assetsMap: Map<string, Asset>;
 
@@ -222,10 +226,11 @@ declare const centrifuge: Parachain;
 declare const crustShadow: Parachain;
 declare const darwinia: EvmParachain;
 declare const darwiniaCrab: EvmParachain;
+declare const fantomTestnet: EvmChain;
 declare const hydration: Parachain;
 declare const hydrationAlphanet: Parachain;
-declare const interlay: Parachain;
 declare const integritee: Parachain;
+declare const interlay: Parachain;
 declare const karura: Parachain;
 declare const khala: Parachain;
 declare const kintsugi: Parachain;
@@ -238,12 +243,11 @@ declare const moonbaseBeta: EvmParachain;
 declare const moonbeam: EvmParachain;
 declare const moonriver: EvmParachain;
 declare const neuroweb: Parachain;
-declare const nodle: Parachain;
 declare const originTrailAlphanet: Parachain;
 declare const peaqAlphanet: Parachain;
 declare const peaqChain: Parachain;
-declare const peaqEvmAlphanet: EvmParachain;
 declare const peaqEvm: EvmParachain;
+declare const peaqEvmAlphanet: EvmParachain;
 declare const pendulum: Parachain;
 declare const pendulumAlphanet: Parachain;
 declare const phala: Parachain;
@@ -262,146 +266,13 @@ declare const zeitgeist: Parachain;
 declare const chainsList: AnyChain[];
 declare const chainsMap: Map<string, AnyChain>;
 
-export {
-  AssetConfig,
-  type AssetConfigConstructorParams,
-  ChainConfig,
-  type ChainConfigConstructorParams,
-  type ChainTransferConfig,
-  ConfigBuilder,
-  ConfigService,
-  type ConfigServiceOptions,
-  type DestinationFeeConfig,
-  type FeeAssetConfig,
-  type IConfigService,
-  type TransferConfig,
-  aca,
-  acala,
-  agng,
-  alan,
-  alphanetAssetHub,
-  alphanetRelay,
-  ampe,
-  apillon,
-  aseed,
-  assetsList,
-  assetsMap,
-  astar,
-  astr,
-  atom,
-  auq,
-  axlusdc,
-  betaDEV,
-  bifrostKusama,
-  bifrostPolkadot,
-  bnc,
-  bncs,
-  calamari,
-  centrifuge,
-  cfg,
-  chainsList,
-  chainsMap,
-  crab,
-  crustShadow,
-  csm,
-  dai,
-  darwinia,
-  darwiniaCrab,
-  ded,
-  dev,
-  dot,
-  eq,
-  eqd,
-  fil,
-  ftmwh,
-  glmr,
-  hdx,
-  hydration,
-  hydrationAlphanet,
-  ibtc,
-  integritee,
-  interlay,
-  intr,
-  kar,
-  karura,
-  kbtc,
-  khala,
-  kint,
-  kintsugi,
-  kma,
-  ksm,
-  kusama,
-  kusamaAssetHub,
-  ldot,
-  lit,
-  mangataKusama,
-  manta,
-  mantaParachain,
-  mgx,
-  moonbaseAlpha,
-  moonbaseBeta,
-  moonbeam,
-  moonriver,
-  movr,
-  neuro,
-  neuroweb,
-  nodl,
-  nodle,
-  originTrailAlphanet,
-  otp,
-  para,
-  paring,
-  peaq,
-  peaqAlphanet,
-  peaqChain,
-  peaqEvm,
-  peaqEvmAlphanet,
-  pen,
-  pendulum,
-  pendulumAlphanet,
-  pha,
-  phala,
-  pica,
-  picasso,
-  picassoAlphanet,
-  pink,
-  polkadot,
-  polkadotAssetHub,
-  ring,
-  rmrk,
-  robonomics,
-  sdn,
-  shiden,
-  soon,
-  stink,
-  sub,
-  subsocial,
-  teer,
-  tinkernet,
-  tnkr,
-  tt1,
-  tur,
-  turing,
-  turingAlphanet,
-  uniqueAlpha,
-  unit,
-  usdc,
-  usdcwh,
-  usdt,
-  usdtwh,
-  vastr,
-  vbnc,
-  vdot,
-  vfil,
-  vglmr,
-  vksm,
-  vmanta,
-  vmovr,
-  wbtc,
-  weth,
-  wftm,
-  wifd,
-  xrt,
-  zeitgeist,
-  ztg,
-};
+declare function getKey(keyOrModel: string | AnyAsset | AnyChain): string;
+declare function getMoonChain(chain: AnyChain): EvmParachain;
+
+declare const mrlRoutesList: MrlChainRoutes[];
+declare const mrlRoutesMap: Map<string, MrlChainRoutes>;
+
+declare const xcmRoutesList: ChainRoutes[];
+declare const xcmRoutesMap: Map<string, ChainRoutes>;
+
+export { AssetRoute, type AssetRouteConstructorParams, ChainRoutes, type ChainRoutesConstructorParams, ConfigService, type ConfigServiceOptions, type DestinationConfig, type DestinationFeeConfig, type FeeConfig, type MoonChainConfig, type MoonChainFeeConfig, MrlAssetRoute, type MrlAssetRouteConstructorParams, MrlChainRoutes, type MrlChainRoutesConstructorParams, type MrlConfig, type MrlSourceConfig, type SourceConfig, aca, acala, agng, alan, alphanetAssetHub, alphanetRelay, ampe, apillon, aseed, assetsList, assetsMap, astar, astr, atom, auq, axlusdc, betaDEV, bifrostKusama, bifrostPolkadot, bnc, bncs, calamari, centrifuge, cfg, chainsList, chainsMap, crab, crustShadow, csm, dai, darwinia, darwiniaCrab, ded, dev, dot, eq, eqd, fantomTestnet, fil, ftm, ftmwh, getKey, getMoonChain, glmr, hdx, hydration, hydrationAlphanet, ibtc, integritee, interlay, intr, kar, karura, kbtc, khala, kint, kintsugi, kma, ksm, kusama, kusamaAssetHub, ldot, lit, mangataKusama, manta, mantaParachain, mgx, moonbaseAlpha, moonbaseBeta, moonbeam, moonriver, movr, mrlRoutesList, mrlRoutesMap, neuro, neuroweb, nodl, originTrailAlphanet, otp, para, paring, peaq, peaqAlphanet, peaqChain, peaqEvm, peaqEvmAlphanet, pen, pendulum, pendulumAlphanet, pha, phala, pica, picasso, picassoAlphanet, pink, polkadot, polkadotAssetHub, ring, rmrk, robonomics, sdn, shiden, soon, stink, sub, subsocial, teer, tinkernet, tnkr, tt1, tur, turing, turingAlphanet, uniqueAlpha, unit, usdc, usdcwh, usdt, usdtwh, vastr, vbnc, vdot, vfil, vglmr, vksm, vmanta, vmovr, wbtc, weth, wftm, wifd, xcmRoutesList, xcmRoutesMap, xrt, zeitgeist, ztg };