@moonbeam-network/xcm-config 1.0.0-dev.30 → 1.0.0-dev.300

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,44 @@
-![Moonbeam](https://docs.moonbeam.network/images/builders/interoperability/xcm/sdk/xcm-sdk-banner.png)
+# @moonbeam-network/xcm-config
 
-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.
+Configuration for supported chains and XCM routing definitions used in the Moonbeam XCM SDK and MRL SDK.
 
-# Documentation
+## Package Information
 
-## v1 (current)
+**NPM Package:** [https://www.npmjs.com/package/@moonbeam-network/xcm-config](https://www.npmjs.com/package/@moonbeam-network/xcm-config)
 
-- TODO: (coming soon)
+**Package Level:** Level 4  
+**Depends on:** `@moonbeam-network/xcm-utils`, `@moonbeam-network/xcm-types`, `@moonbeam-network/xcm-builder`
 
-## v0 (previous)
+## Features
 
-- [usage](https://docs.moonbeam.network/builders/xcm/xcm-sdk/xcm-sdk/)
-- [references](https://docs.moonbeam.network/builders/xcm/xcm-sdk/reference/)
+This package provides:
+
+- **Chain configurations** - Definitions for all supported blockchain networks
+- **Asset configurations** - Token and asset metadata
+- **XCM routing definitions** - Cross-chain message routing rules and parameters
+
+## Documentation
+
+### v4 (current)
+
+#### Usage
+
+- [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)
+
+#### References
+
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/latest/reference/mrl)
+
+### v3 (previous)
+
+#### Usage
+
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/example-usage/mrl)
+
+#### References
+
+- [XCM SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/xcm)
+- [MRL SDK](https://moonbeam-foundation.github.io/xcm-sdk/v3/reference/mrl)

package/build/index.d.mts

@@ -0,0 +1,317 @@
+import { Asset, AnyChain, SetOptional, ChainAsset, AnyAsset, AnyParachain, Ecosystem, Parachain, EvmParachain, EvmChain } from '@moonbeam-network/xcm-types';
+import { BalanceConfigBuilder, AssetMinConfigBuilder, FeeConfigBuilder, ContractConfigBuilder, ExtrinsicConfigBuilder, EventMonitoringConfig, MrlConfigBuilder, ProtocolFeeConfigBuilder } 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 auq: Asset;
+declare const axlusdc: Asset;
+declare const bnc: Asset;
+declare const cfg: 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 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 ibtc: Asset;
+declare const intr: Asset;
+declare const kar: Asset;
+declare const kbtc: Asset;
+declare const kint: Asset;
+declare const ksm: Asset;
+declare const lamaGLMR: Asset;
+declare const laos: Asset;
+declare const ldot: Asset;
+declare const lit: Asset;
+declare const manta: Asset;
+declare const maos: Asset;
+declare const movr: Asset;
+declare const samaMOVR: 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 pizza: Asset;
+declare const pizzaUSDC: 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 usdtksm: 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 assetsList: Asset[];
+declare const assetsMap: Map<string, Asset>;
+
+interface AssetRouteConstructorParams {
+    source: SourceConfig;
+    destination: DestinationConfig;
+    contract?: ContractConfigBuilder;
+    extrinsic?: ExtrinsicConfigBuilder;
+    monitoring?: EventMonitoringConfig;
+}
+interface SourceConfig {
+    asset: Asset;
+    chain: AnyChain;
+    balance: BalanceConfigBuilder;
+    fee: FeeConfig;
+    destinationFee?: {
+        asset?: Asset;
+        balance: BalanceConfigBuilder;
+    };
+    min?: AssetMinConfigBuilder;
+}
+interface DestinationConfig extends Omit<SourceConfig, 'fee'> {
+    fee: FeeAmountConfig;
+}
+interface FeeConfig {
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+    extra?: number;
+}
+interface FeeAmountConfig extends SetOptional<FeeConfig, 'balance'> {
+    amount: number | FeeConfigBuilder;
+}
+declare class AssetRoute {
+    readonly source: SourceConfig;
+    readonly destination: DestinationConfig;
+    readonly contract?: ContractConfigBuilder;
+    readonly extrinsic?: ExtrinsicConfigBuilder;
+    readonly monitoring?: EventMonitoringConfig;
+    constructor({ source, destination, contract, extrinsic, monitoring, }: 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;
+    bridgeChain: BridgeChainConfig;
+}
+interface ProtocolFeeConfig {
+    amount: number | ProtocolFeeConfigBuilder;
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+}
+interface MrlSourceConfig extends SourceConfig {
+    /** Protocol bridge fee (e.g., Snowbridge fee) */
+    protocolFee?: ProtocolFeeConfig;
+    bridgeChainFee?: {
+        asset: Asset;
+        balance: BalanceConfigBuilder;
+    };
+}
+interface BridgeChainConfig {
+    asset: Asset;
+    balance: BalanceConfigBuilder;
+    chain: AnyParachain;
+    fee: BridgeChainFeeConfig;
+}
+interface BridgeChainFeeConfig extends FeeConfig {
+    amount: number | FeeConfigBuilder;
+}
+declare class MrlAssetRoute extends AssetRoute {
+    readonly mrl: MrlConfig & {
+        isAutomaticPossible: boolean;
+    };
+    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 centrifuge: Parachain;
+declare const crustShadow: Parachain;
+declare const darwinia: EvmParachain;
+declare const ethereum: EvmChain;
+declare const fantomTestnet: EvmChain;
+declare const hydration: Parachain;
+declare const hydrationAlphanet: Parachain;
+declare const interlay: Parachain;
+declare const karura: Parachain;
+declare const kintsugi: Parachain;
+declare const kusama: Parachain;
+declare const kusamaAssetHub: 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 moonlama: EvmParachain;
+declare const moonsama: EvmParachain;
+declare const moonbeam: EvmParachain;
+declare const moonriver: EvmParachain;
+declare const neuroweb: Parachain;
+declare const originTrailAlphanet: Parachain;
+declare const peaqAlphanet: Parachain;
+declare const peaqChain: Parachain;
+declare const peaqEvm: EvmParachain;
+declare const peaqEvmAlphanet: EvmParachain;
+declare const pendulum: Parachain;
+declare const polkadot: Parachain;
+declare const polkadotAssetHub: Parachain;
+declare const robonomics: Parachain;
+declare const shiden: Parachain;
+declare const turingAlphanet: Parachain;
+declare const uniqueAlpha: Parachain;
+declare const zeitgeist: Parachain;
+declare const chainsList: AnyChain[];
+declare const chainsMap: Map<string, AnyChain>;
+
+declare function getKey(keyOrModel: string | AnyAsset | AnyChain): string;
+
+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, type BridgeChainConfig, type BridgeChainFeeConfig, ChainRoutes, type ChainRoutesConstructorParams, ConfigService, type ConfigServiceOptions, type DestinationConfig, type FeeAmountConfig, type FeeConfig, MrlAssetRoute, type MrlAssetRouteConstructorParams, MrlChainRoutes, type MrlChainRoutesConstructorParams, type MrlConfig, type MrlSourceConfig, type ProtocolFeeConfig, type SourceConfig, aca, acala, agng, alan, alphanetAssetHub, alphanetRelay, ampe, apillon, aseed, assetsList, assetsMap, astar, astr, auq, axlusdc, bifrostKusama, bifrostPolkadot, bnc, centrifuge, cfg, chainsList, chainsMap, crossEcosystemsRoutesList, crossEcosystemsRoutesMap, crustShadow, csm, dai, darwinia, ded, dev, devBeta, devStage, dot, eq, eqd, eth, ethereum, eurc, fantomTestnet, fil, ftm, ftmwh, getKey, glmr, hdx, hydration, hydrationAlphanet, ibtc, interlay, intr, kar, karura, kbtc, kint, kintsugi, ksm, kusama, kusamaAssetHub, lamaGLMR, laos, laosAlphanet, laosMainnet, ldot, lit, manta, mantaParachain, maos, moonbaseAlpha, moonbaseBeta, moonbaseStage, moonbeam, moonlama, moonriver, moonsama, movr, mrlRoutesList, mrlRoutesMap, neuro, neuroweb, nodl, originTrailAlphanet, otp, para, paring, peaq, peaqAlphanet, peaqChain, peaqEvm, peaqEvmAlphanet, pen, pendulum, pha, pica, pink, pizza, pizzaUSDC, polkadot, polkadotAssetHub, ring, rmrk, robonomics, samaMOVR, sdn, shiden, soon, stink, sub, teer, tnkr, tt1, tur, turingAlphanet, uniqueAlpha, unit, usdc, usdcwh, usdt, usdtksm, usdtwh, vastr, vbnc, vdot, vfil, vglmr, vksm, vmanta, vmovr, wbtc, wbtce, weth, wethe, wftm, wifd, wstethe, xcmRoutesList, xcmRoutesMap, xrt, zeitgeist, ztg };