@moonbeam-network/xcm-config 1.0.0-dev.163 → 1.0.0-dev.165

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,12 +1,11 @@
 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';
+import { ContractConfigBuilder, ExtrinsicConfigBuilder, BalanceConfigBuilder, AssetMinConfigBuilder, FeeConfigBuilder, MrlConfigBuilder } from '@moonbeam-network/xcm-builder';
 
 interface AssetRouteConstructorParams {
     source: SourceConfig;
     destination: DestinationConfig;
     contract?: ContractConfigBuilder;
     extrinsic?: ExtrinsicConfigBuilder;
-    mrl?: MrlConfig;
 }
 interface SourceConfig {
     asset: Asset;
@@ -27,29 +26,15 @@ interface FeeConfig {
     balance: BalanceConfigBuilder;
     extra?: number;
 }
-interface MrlConfig {
-    isAutomaticPossible: boolean;
-    transfer: MrlConfigBuilder;
-    moonChain: MoonChainConfig;
-}
 interface DestinationFeeConfig extends SetOptional<FeeConfig, 'balance'> {
     amount: number | FeeConfigBuilder;
 }
-interface MoonChainConfig {
-    asset: Asset;
-    balance: BalanceConfigBuilder;
-    fee: MoonChainFeeConfig;
-}
-interface MoonChainFeeConfig extends FeeConfig {
-    amount: number | FeeConfigBuilder;
-}
 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);
+    constructor({ source, destination, contract, extrinsic, }: AssetRouteConstructorParams);
     getDestinationFeeAssetOnSource(): ChainAsset;
 }
 
@@ -61,8 +46,8 @@ interface RoutesParam extends Omit<AssetRouteConstructorParams, 'source'> {
     source: Omit<SourceConfig, 'chain'>;
 }
 declare class ChainRoutes {
-    #private;
     readonly chain: AnyChain;
+    protected routes: Map<string, AssetRoute>;
     constructor({ chain, routes }: ChainRoutesConstructorParams);
     getRoutes(): AssetRoute[];
     getAssetRoutes(keyOrAsset: string | AnyAsset): AssetRoute[];
@@ -73,6 +58,12 @@ declare class ChainRoutes {
 
 interface MrlAssetRouteConstructorParams extends AssetRouteConstructorParams {
     source: MrlSourceConfig;
+    mrl: MrlConfig;
+}
+interface MrlConfig {
+    isAutomaticPossible: boolean;
+    transfer: MrlConfigBuilder;
+    moonChain: MoonChainConfig;
 }
 interface MrlSourceConfig extends SourceConfig {
     moonChainFee?: {
@@ -80,7 +71,16 @@ interface MrlSourceConfig extends SourceConfig {
         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;
@@ -94,9 +94,10 @@ interface MrlRoutesParam extends Omit<MrlAssetRouteConstructorParams, 'source'>
     source: Omit<MrlSourceConfig, 'chain'>;
 }
 declare class MrlChainRoutes extends ChainRoutes {
-    #private;
+    protected routes: Map<string, MrlAssetRoute>;
     constructor({ chain, routes }: MrlChainRoutesConstructorParams);
     getRoutes(): MrlAssetRoute[];
+    getAssetRoute(asset: string | AnyAsset, destination: string | AnyChain): MrlAssetRoute;
 }
 
 interface ConfigServiceOptions {
@@ -264,7 +265,6 @@ declare const polkadotAssetHub: Parachain;
 declare const robonomics: Parachain;
 declare const shiden: Parachain;
 declare const subsocial: Parachain;
-declare const tinkernet: Parachain;
 declare const turing: Parachain;
 declare const turingAlphanet: Parachain;
 declare const uniqueAlpha: Parachain;
@@ -281,4 +281,4 @@ 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, eth, ethereum, 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, wbtce, weth, wethe, wftm, wifd, wstethe, xcmRoutesList, xcmRoutesMap, xrt, zeitgeist, ztg };
+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, eth, ethereum, 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, tnkr, tt1, tur, turing, 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 };