@moonbeam-network/xcm-config 1.0.0-dev.21 → 1.0.0-dev.210

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/README.md

@@ -1,14 +1,20 @@
-![Moonbeam](https://docs.moonbeam.network/images/builders/interoperability/xcm/sdk/xcm-sdk-banner.png)
+The Config package contains the chains and assets configuration for the Moonbeam XCM SDK and MRL SDK.
 
-The Moonbeam XCM SDK enables developers to easily deposit and withdraw assets to Moonbeam/Moonriver from the relay chain and other parachains in the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to send XCM transfers. To deposit or withdraw assets, you simply define the asset and origin chain you want to deposit from or withdraw back to, along with the sending account's signer, and the amount to send.
+# Documentation for the Moonbeam XCM SDK
 
-# Documentation
+## v3 (current)
 
-## v1 (current)
+### Usage
 
-- TODO: (coming soon)
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/mrl)
 
-## v0 (previous)
+### References
 
-- [usage](https://docs.moonbeam.network/builders/xcm/xcm-sdk/xcm-sdk/)
-- [references](https://docs.moonbeam.network/builders/xcm/xcm-sdk/reference/)
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/mrl)
+
+## v2 (previous)
+
+- [usage](https://moonbeam-foundation.github.io/xcm-sdk/v2/example-usage)
+- [references](https://moonbeam-foundation.github.io/xcm-sdk/v2/reference/interfaces)

package/build/index.d.ts

@@ -1,355 +1,307 @@
-import {
-  Asset,
-  AnyChain,
-  Ecosystem,
-  Parachain,
-  EvmParachain,
-} from '@moonbeam-network/xcm-types';
-import {
-  BalanceConfigBuilder,
-  ContractConfigBuilder,
-  ExtrinsicConfigBuilder,
-  AssetMinConfigBuilder,
-  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 DestinationFeeConfig extends FeeAssetConfig {
-  amount: number | FeeConfigBuilder;
-}
-interface FeeAssetConfig {
-  asset: Asset;
-  balance: BalanceConfigBuilder;
-}
-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 ChainConfigConstructorParams {
-  assets: AssetConfig[];
-  chain: AnyChain;
-}
-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;
-}
-
-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 ConfigServiceOptions {
-  assets?: Map<string, Asset>;
-  chains?: Map<string, AnyChain>;
-  chainsConfig?: Map<string, ChainConfig>;
-}
-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;
-}
-
-interface TransferConfig {
-  asset: Asset;
-  source: ChainTransferConfig;
-  destination: ChainTransferConfig;
-}
-interface ChainTransferConfig {
-  chain: AnyChain;
-  config: AssetConfig;
-}
-
-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;
-        };
-      };
-    };
-  };
-};
+import { Asset, AnyChain, SetOptional, ChainAsset, AnyAsset, Ecosystem, Parachain, EvmParachain, EvmChain } from '@moonbeam-network/xcm-types';
+import { BalanceConfigBuilder, AssetMinConfigBuilder, FeeConfigBuilder, ContractConfigBuilder, ExtrinsicConfigBuilder, MrlConfigBuilder } from '@moonbeam-network/xcm-builder';
 
 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 betaDEV: Asset;
+declare const axlusdc: Asset;
 declare const bnc: Asset;
+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 devBeta: Asset;
+declare const devStage: Asset;
 declare const dot: Asset;
 declare const eq: Asset;
 declare const eqd: Asset;
-declare const dai: Asset;
+declare const eth: Asset;
+declare const eurc: Asset;
 declare const fil: Asset;
+declare const ftm: Asset;
+declare const ftmwh: Asset;
 declare const glmr: Asset;
 declare const hdx: Asset;
-declare const hko: Asset;
 declare const ibtc: Asset;
 declare const intr: Asset;
 declare const kar: Asset;
 declare const kbtc: Asset;
 declare const kint: Asset;
-declare const kma: Asset;
 declare const ksm: Asset;
+declare const ldot: Asset;
 declare const lit: Asset;
+declare const manta: Asset;
+declare const maos: Asset;
 declare const mgx: Asset;
 declare const movr: Asset;
+declare const neuro: Asset;
 declare const nodl: Asset;
 declare const otp: Asset;
 declare const para: Asset;
 declare const paring: Asset;
+declare const peaq: Asset;
+declare const pen: Asset;
 declare const pha: Asset;
 declare const pica: Asset;
+declare const pink: Asset;
 declare const ring: Asset;
 declare const rmrk: Asset;
 declare const sdn: Asset;
 declare const soon: Asset;
+declare const stink: Asset;
+declare const sub: Asset;
 declare const teer: Asset;
+declare const tnkr: Asset;
 declare const tt1: Asset;
 declare const tur: Asset;
 declare const unit: Asset;
 declare const usdc: Asset;
+declare const usdcwh: Asset;
 declare const usdt: Asset;
-declare const wbtc: Asset;
-declare const weth: Asset;
-declare const wftm: Asset;
+declare const usdtwh: Asset;
+declare const vastr: Asset;
 declare const vbnc: Asset;
 declare const vdot: Asset;
 declare const vfil: Asset;
 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 wbtce: Asset;
+declare const wstethe: Asset;
+declare const wethe: Asset;
+declare const laos: Asset;
 declare const assetsList: Asset[];
 declare const assetsMap: Map<string, Asset>;
 
+interface AssetRouteConstructorParams {
+    source: SourceConfig;
+    destination: DestinationConfig;
+    contract?: ContractConfigBuilder;
+    extrinsic?: ExtrinsicConfigBuilder;
+}
+interface SourceConfig {
+    asset: Asset;
+    chain: AnyChain;
+    balance: BalanceConfigBuilder;
+    fee: FeeConfig;
+    destinationFee?: {
+        asset?: Asset;
+        balance: BalanceConfigBuilder;
+    };
+    min?: AssetMinConfigBuilder;
+}
+interface DestinationConfig extends Omit<SourceConfig, 'fee'> {
+    fee: DestinationFeeConfig;
+}
+interface FeeConfig {
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+    extra?: number;
+}
+interface DestinationFeeConfig extends SetOptional<FeeConfig, 'balance'> {
+    amount: number | FeeConfigBuilder;
+}
+declare class AssetRoute {
+    readonly source: SourceConfig;
+    readonly destination: DestinationConfig;
+    readonly contract?: ContractConfigBuilder;
+    readonly extrinsic?: ExtrinsicConfigBuilder;
+    constructor({ source, destination, contract, extrinsic, }: AssetRouteConstructorParams);
+    getDestinationFeeAssetOnSource(): ChainAsset;
+}
+
+interface ChainRoutesConstructorParams {
+    chain: AnyChain;
+    routes: RoutesParam[];
+}
+interface RoutesParam extends Omit<AssetRouteConstructorParams, 'source'> {
+    source: Omit<SourceConfig, 'chain'>;
+}
+declare class ChainRoutes {
+    readonly chain: AnyChain;
+    protected routes: Map<string, AssetRoute>;
+    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 MrlAssetRouteConstructorParams extends AssetRouteConstructorParams {
+    source: MrlSourceConfig;
+    mrl: MrlConfig;
+}
+interface MrlConfig {
+    isAutomaticPossible: boolean;
+    transfer: MrlConfigBuilder;
+    moonChain: MoonChainConfig;
+}
+interface MrlSourceConfig extends SourceConfig {
+    moonChainFee?: {
+        asset: Asset;
+        balance: BalanceConfigBuilder;
+    };
+}
+interface MoonChainConfig {
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+    fee: MoonChainFeeConfig;
+}
+interface MoonChainFeeConfig extends FeeConfig {
+    amount: number | FeeConfigBuilder;
+}
+declare class MrlAssetRoute extends AssetRoute {
+    readonly mrl: MrlConfig;
+    readonly source: MrlSourceConfig;
+    constructor({ source, destination, contract, extrinsic, mrl, }: MrlAssetRouteConstructorParams & {
+        source: MrlSourceConfig;
+    });
+}
+
+interface MrlChainRoutesConstructorParams extends ChainRoutesConstructorParams {
+    routes: MrlRoutesParam[];
+}
+interface MrlRoutesParam extends Omit<MrlAssetRouteConstructorParams, 'source'> {
+    source: Omit<MrlSourceConfig, 'chain'>;
+}
+declare class MrlChainRoutes extends ChainRoutes {
+    protected routes: Map<string, MrlAssetRoute>;
+    constructor({ chain, routes }: MrlChainRoutesConstructorParams);
+    getRoutes(): MrlAssetRoute[];
+    getAssetRoute(asset: string | AnyAsset, destination: string | AnyChain): MrlAssetRoute;
+}
+
+/**
+ * Configuration options for initializing the ConfigService.
+ * This interface defines the structure for configuring assets, chains, routes, and endpoints.
+ */
+interface ConfigServiceOptions {
+    /**
+     * Optional map of assets where the key is the asset identifier and the value is the Asset object.
+     * If not provided, defaults to the predefined assetsMap.
+     */
+    assets?: Map<string, Asset>;
+    /**
+     * Optional map of chains where the key is the chain identifier and the value is the Chain object.
+     * If not provided, defaults to the predefined chainsMap.
+     */
+    chains?: Map<string, AnyChain>;
+    /**
+     * Routes configuration.
+     */
+    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;
+    updateEndpoints(endpoints: {
+        [key: string]: {
+            rpc: string;
+            ws: string[];
+        };
+    }): void;
+}
+
 declare const acala: Parachain;
 declare const alphanetAssetHub: Parachain;
 declare const alphanetRelay: Parachain;
 declare const astar: Parachain;
 declare const bifrostKusama: Parachain;
 declare const bifrostPolkadot: Parachain;
-declare const calamari: Parachain;
 declare const centrifuge: Parachain;
 declare const crustShadow: Parachain;
 declare const darwinia: EvmParachain;
 declare const darwiniaCrab: EvmParachain;
-declare const darwiniaPangoro: EvmParachain;
-declare const equilibrium: Parachain;
-declare const equilibriumAlphanet: Parachain;
-declare const hydraDX: Parachain;
-declare const interlay: Parachain;
+declare const ethereum: EvmChain;
+declare const fantomTestnet: EvmChain;
+declare const hydration: Parachain;
+declare const hydrationAlphanet: Parachain;
 declare const integritee: Parachain;
+declare const interlay: Parachain;
 declare const karura: Parachain;
-declare const khala: Parachain;
 declare const kintsugi: Parachain;
 declare const kusama: Parachain;
 declare const kusamaAssetHub: Parachain;
-declare const litentryAlphanet: Parachain;
-declare const litmus: Parachain;
 declare const mangataKusama: Parachain;
+declare const mantaParachain: Parachain;
+declare const laosAlphanet: EvmParachain;
+declare const laosMainnet: EvmParachain;
 declare const moonbaseAlpha: EvmParachain;
 declare const moonbaseBeta: EvmParachain;
+declare const moonbaseStage: EvmParachain;
 declare const moonbeam: EvmParachain;
 declare const moonriver: EvmParachain;
-declare const nodle: Parachain;
-declare const originTrail: Parachain;
+declare const neuroweb: Parachain;
 declare const originTrailAlphanet: Parachain;
-declare const parallel: Parachain;
-declare const parallelHeiko: Parachain;
+declare const peaqAlphanet: Parachain;
+declare const peaqChain: Parachain;
+declare const peaqEvm: EvmParachain;
+declare const peaqEvmAlphanet: EvmParachain;
+declare const pendulum: Parachain;
+declare const pendulumAlphanet: Parachain;
 declare const phala: Parachain;
-declare const picassoAlphanet: Parachain;
 declare const polkadot: Parachain;
 declare const polkadotAssetHub: Parachain;
 declare const robonomics: Parachain;
 declare const shiden: Parachain;
-declare const turing: Parachain;
 declare const turingAlphanet: Parachain;
-declare const subsocialAlphanet: Parachain;
 declare const uniqueAlpha: Parachain;
+declare const zeitgeist: Parachain;
 declare const chainsList: AnyChain[];
 declare const chainsMap: Map<string, AnyChain>;
 
-export {
-  AssetConfig,
-  AssetConfigConstructorParams,
-  ChainConfig,
-  ChainConfigConstructorParams,
-  ChainTransferConfig,
-  ConfigBuilder,
-  ConfigService,
-  ConfigServiceOptions,
-  DestinationFeeConfig,
-  FeeAssetConfig,
-  IConfigService,
-  TransferConfig,
-  aca,
-  acala,
-  alan,
-  alphanetAssetHub,
-  alphanetRelay,
-  aseed,
-  assetsList,
-  assetsMap,
-  astar,
-  astr,
-  atom,
-  auq,
-  betaDEV,
-  bifrostKusama,
-  bifrostPolkadot,
-  bnc,
-  calamari,
-  centrifuge,
-  cfg,
-  chainsList,
-  chainsMap,
-  crab,
-  crustShadow,
-  csm,
-  dai,
-  darwinia,
-  darwiniaCrab,
-  darwiniaPangoro,
-  dev,
-  dot,
-  eq,
-  eqd,
-  equilibrium,
-  equilibriumAlphanet,
-  fil,
-  glmr,
-  hdx,
-  hko,
-  hydraDX,
-  ibtc,
-  integritee,
-  interlay,
-  intr,
-  kar,
-  karura,
-  kbtc,
-  khala,
-  kint,
-  kintsugi,
-  kma,
-  ksm,
-  kusama,
-  kusamaAssetHub,
-  lit,
-  litentryAlphanet,
-  litmus,
-  mangataKusama,
-  mgx,
-  moonbaseAlpha,
-  moonbaseBeta,
-  moonbeam,
-  moonriver,
-  movr,
-  nodl,
-  nodle,
-  originTrail,
-  originTrailAlphanet,
-  otp,
-  para,
-  parallel,
-  parallelHeiko,
-  paring,
-  pha,
-  phala,
-  pica,
-  picassoAlphanet,
-  polkadot,
-  polkadotAssetHub,
-  ring,
-  rmrk,
-  robonomics,
-  sdn,
-  shiden,
-  soon,
-  subsocialAlphanet,
-  teer,
-  tt1,
-  tur,
-  turing,
-  turingAlphanet,
-  uniqueAlpha,
-  unit,
-  usdc,
-  usdt,
-  vbnc,
-  vdot,
-  vfil,
-  vglmr,
-  vksm,
-  vmovr,
-  wbtc,
-  weth,
-  wftm,
-  xrt,
-};
+declare function getKey(keyOrModel: string | AnyAsset | AnyChain): string;
+declare function getMoonChain(chain: AnyChain): EvmParachain;
+
+declare const crossEcosystemsRoutesList: ChainRoutes[];
+declare const crossEcosystemsRoutesMap: Map<string, ChainRoutes>;
+
+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, auq, axlusdc, bifrostKusama, bifrostPolkadot, bnc, bncs, centrifuge, cfg, chainsList, chainsMap, crab, crossEcosystemsRoutesList, crossEcosystemsRoutesMap, crustShadow, csm, dai, darwinia, darwiniaCrab, ded, dev, devBeta, devStage, dot, eq, eqd, eth, ethereum, eurc, fantomTestnet, fil, ftm, ftmwh, getKey, getMoonChain, glmr, hdx, hydration, hydrationAlphanet, ibtc, integritee, interlay, intr, kar, karura, kbtc, kint, kintsugi, ksm, kusama, kusamaAssetHub, laos, laosAlphanet, laosMainnet, ldot, lit, mangataKusama, manta, mantaParachain, maos, mgx, moonbaseAlpha, moonbaseBeta, moonbaseStage, moonbeam, moonriver, movr, mrlRoutesList, mrlRoutesMap, neuro, neuroweb, nodl, originTrailAlphanet, otp, para, paring, peaq, peaqAlphanet, peaqChain, peaqEvm, peaqEvmAlphanet, pen, pendulum, pendulumAlphanet, pha, phala, pica, pink, polkadot, polkadotAssetHub, ring, rmrk, robonomics, sdn, shiden, soon, stink, sub, teer, tnkr, tt1, tur, turingAlphanet, uniqueAlpha, unit, usdc, usdcwh, usdt, usdtwh, vastr, vbnc, vdot, vfil, vglmr, vksm, vmanta, vmovr, wbtc, wbtce, weth, wethe, wftm, wifd, wstethe, xcmRoutesList, xcmRoutesMap, xrt, zeitgeist, ztg };