@moonbeam-network/xcm-types 3.0.0 → 3.0.2

package/README.md

@@ -1,14 +1,20 @@
-![Moonbeam](https://docs.moonbeam.network/images/builders/interoperability/xcm/sdk/xcm-sdk-banner.png)
+The Types package contains the type definitions 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/package.json

@@ -1,28 +1,26 @@
 {
   "name": "@moonbeam-network/xcm-types",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Moonbeam XCM Types",
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "link": "pnpm ln --global",
-    "test": "vitest --run",
-    "test:watch": "vitest",
-    "test:update": "vitest -u"
-  },
   "repository": {
     "directory": "packages/types",
     "type": "git",
     "url": "git+https://github.com/moonbeam-foundation/xcm-sdk.git"
   },
-  "keywords": ["moonbeam", "moonriver", "xcm"],
+  "keywords": [
+    "moonbeam",
+    "moonriver",
+    "xcm"
+  ],
   "author": "moonbeam-foundation",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/moonbeam-foundation/xcm-sdk/issues"
   },
   "homepage": "https://moonbeam-foundation.github.io/xcm-sdk/latest",
-  "files": ["build"],
+  "files": [
+    "build"
+  ],
   "type": "module",
   "exports": {
     "import": "./build/index.mjs",
@@ -32,8 +30,8 @@
   "types": "./build/index.d.ts",
   "main": "./build/index.mjs",
   "dependencies": {
-    "@moonbeam-network/xcm-utils": "3.0.0",
-    "big.js": "^6.2.1"
+    "big.js": "^6.2.1",
+    "@moonbeam-network/xcm-utils": "3.0.2"
   },
   "devDependencies": {
     "@types/big.js": "^6.2.2",
@@ -41,5 +39,13 @@
   },
   "peerDependencies": {
     "viem": "^2.21.7"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "link": "pnpm ln --global",
+    "test": "vitest --run",
+    "test:watch": "vitest",
+    "test:update": "vitest -u"
   }
-}
+}

package/build/index.d.mts

@@ -1,171 +0,0 @@
-import Big, { RoundingMode } from 'big.js';
-import { Chain as Chain$3 } from '@wormhole-foundation/sdk-connect';
-import { Chain as Chain$1, Address } from 'viem';
-import { Chain as Chain$2 } from 'viem/chains';
-
-interface AssetConstructorParams {
-    key: string;
-    originSymbol: string;
-}
-declare class Asset {
-    readonly key: string;
-    readonly originSymbol: string;
-    constructor({ key, originSymbol }: AssetConstructorParams);
-    copyWith(params: Partial<AssetConstructorParams>): Asset;
-    isEqual(asset: Asset): boolean;
-}
-
-interface ChainAssetConstructorParams extends AssetConstructorParams {
-    address?: string;
-    decimals: number;
-    ids?: ChainAssetIds;
-    min?: number | bigint;
-    symbol?: string;
-}
-interface ChainAssetIds {
-    balanceId?: ChainAssetId;
-    id?: ChainAssetId;
-    minId?: ChainAssetId;
-    palletInstance?: number;
-}
-type ChainAssetId = string | number | bigint | {
-    [key: string]: ChainAssetId;
-};
-declare class ChainAsset extends Asset {
-    readonly address?: string;
-    readonly decimals: number;
-    readonly ids?: ChainAssetIds;
-    readonly min?: bigint;
-    readonly symbol?: string;
-    constructor({ address, decimals, ids, min, symbol, ...other }: ChainAssetConstructorParams);
-    static fromAsset(asset: Asset, params: Omit<ChainAssetConstructorParams, keyof AssetConstructorParams>): ChainAsset;
-    copyWith(params: Partial<ChainAssetConstructorParams>): ChainAsset;
-    getSymbol(): string;
-    getAssetId(): ChainAssetId;
-    getBalanceAssetId(): ChainAssetId;
-    getMinAssetId(): ChainAssetId;
-    getAssetPalletInstance(): number | undefined;
-    getAssetMin(): bigint;
-    hasOnlyAddress(): this is {
-        address: string;
-    };
-}
-
-interface AssetAmountConstructorParams extends ChainAssetConstructorParams {
-    amount: number | bigint;
-    decimals: number;
-    symbol?: string;
-}
-declare class AssetAmount extends ChainAsset {
-    readonly amount: bigint;
-    constructor({ amount, ...other }: AssetAmountConstructorParams);
-    static fromChainAsset(asset: ChainAsset, params: Omit<AssetAmountConstructorParams, keyof ChainAssetConstructorParams>): AssetAmount;
-    isSame(asset: ChainAsset | AssetAmount): boolean;
-    isEqual(asset: AssetAmount): boolean;
-    copyWith(params: Partial<AssetAmountConstructorParams>): AssetAmount;
-    convertDecimals(decimals: number): AssetAmount;
-    toBig(): Big;
-    toBigDecimal(maxDecimal?: number, roundType?: RoundingMode): Big;
-    toDecimal(maxDecimal?: number, roundType?: RoundingMode): string;
-}
-
-type AnyAsset = Asset | ChainAsset | AssetAmount;
-
-interface EvmChainConstructorParams extends ChainConstructorParams {
-    id: number;
-    rpc: string;
-}
-declare class EvmChain extends Chain {
-    readonly id: number;
-    readonly rpc: string;
-    static is(obj: unknown): obj is EvmChain;
-    constructor({ id, rpc, ...others }: EvmChainConstructorParams);
-    getViemChain(): Chain$1;
-}
-
-interface ParachainConstructorParams extends ChainConstructorParams {
-    checkSovereignAccountBalances?: boolean;
-    genesisHash: string;
-    isRelay?: boolean;
-    parachainId: number;
-    ss58Format: number;
-    usesChainDecimals?: boolean;
-    weight?: number;
-    ws: string[];
-}
-declare class Parachain extends Chain {
-    readonly checkSovereignAccountBalances: boolean;
-    readonly genesisHash: string;
-    readonly isRelay: boolean;
-    readonly parachainId: number;
-    readonly ss58Format: number;
-    readonly usesChainDecimals: boolean;
-    readonly weight: number | undefined;
-    readonly ws: string[];
-    static is(obj: unknown): obj is Parachain;
-    constructor({ checkSovereignAccountBalances, genesisHash, isRelay, parachainId, usesChainDecimals, ss58Format, weight, ws, ...others }: ParachainConstructorParams);
-}
-
-interface EvmParachainConstructorParams extends ParachainConstructorParams {
-    id: number;
-    rpc: string;
-    isEvmSigner?: boolean;
-    contracts?: Contracts;
-}
-type Contracts = {
-    Batch?: Address;
-    XcmUtils?: Address;
-    Xtokens?: Address;
-};
-declare class EvmParachain extends Parachain {
-    readonly id: number;
-    readonly rpc: string;
-    readonly isEvmSigner: boolean;
-    readonly contracts?: Contracts;
-    static is(obj: unknown): obj is EvmParachain;
-    static isAnyParachain(obj: unknown): obj is EvmParachain | Parachain;
-    static isAnyEvmChain(obj: unknown): obj is EvmParachain | EvmChain;
-    constructor({ id, rpc, isEvmSigner, contracts, ...others }: EvmParachainConstructorParams);
-    getViemChain(): Chain$2;
-}
-
-type AnyChain = EvmChain | Parachain | EvmParachain;
-type AnyParachain = Parachain | EvmParachain;
-declare enum Ecosystem {
-    Polkadot = "polkadot",
-    Kusama = "kusama",
-    AlphanetRelay = "alphanet-relay"
-}
-interface WormholeConfig {
-    name?: Chain$3;
-}
-
-interface ChainConstructorParams {
-    assets: Map<string, ChainAsset> | ChainAsset[];
-    ecosystem?: Ecosystem;
-    explorer?: string;
-    isTestChain?: boolean;
-    key: string;
-    name: string;
-    nativeAsset: Asset;
-    wh?: WormholeConfig;
-}
-declare abstract class Chain {
-    #private;
-    readonly assets: Map<string, ChainAsset>;
-    readonly ecosystem?: Ecosystem;
-    readonly explorer?: string;
-    readonly isTestChain: boolean;
-    readonly key: string;
-    readonly name: string;
-    readonly wh?: WormholeConfig;
-    constructor({ assets, ecosystem, explorer, isTestChain, key, name, nativeAsset, wh, }: ChainConstructorParams);
-    get nativeAsset(): ChainAsset;
-    isEqual<T extends Chain>(chain: T): boolean;
-    getChainAsset(keyOrAsset: string | Asset | AssetAmount): ChainAsset;
-    getWormholeName(): Chain$3;
-}
-
-type SetOptional<Base, Keys extends keyof Base> = Omit<Base, Keys> & Partial<Pick<Base, Keys>>;
-
-export { type AnyAsset, type AnyChain, type AnyParachain, Asset, AssetAmount, type AssetAmountConstructorParams, type AssetConstructorParams, Chain, ChainAsset, type ChainAssetConstructorParams, type ChainAssetId, type ChainAssetIds, type ChainConstructorParams, Ecosystem, EvmChain, type EvmChainConstructorParams, EvmParachain, type EvmParachainConstructorParams, Parachain, type ParachainConstructorParams, type SetOptional, type WormholeConfig };