@moonbeam-network/xcm-sdk 3.0.0 → 3.0.1

package/README.md

@@ -1,6 +1,6 @@
 The Moonbeam XCM SDK enables developers to easily transfer assets between chains, either between parachains or between a parachain and the relay chain, within 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.
 
-The XCM SDK offers helper functions, that provide a very simple interface to execute XCM transfers between chains in the Polkadot/Kusama ecosystem. In addition, the XCM config package allows any parachain project to add their information in a standard way, so they can be immediately supported by the XCM SDK.
+The XCM SDK offers helper functions that provide a very simple interface to execute XCM transfers between chains in the Polkadot/Kusama ecosystem. In addition, the XCM config package allows any parachain project to add their information in a standard way, so they can be immediately supported by the XCM SDK.
 
 # Documentation
 
@@ -15,40 +15,30 @@ npm i @moonbeam-network/xcm-sdk
 :warning: You need to have peer dependencies of SDK installed as well.
 
 ```bash
-npm i @polkadot/api @polkadot/api-augment @polkadot/types @polkadot/util @polkadot/util-crypto @polkadot/apps-config ethers
+npm i @polkadot/api @polkadot/util-crypto
 ```
 
 # Usage
 
-The following sections contain basic examples of how to work with the XCM SDK to build transfer data to transfer an asset from one chain to another and how to submit the transfer. For a detailed overview on how to use each method, including a reference to the parameters and returned data of each method exposed by the SDK, please refer to the [XCM SDK docs](https://docs.moonbeam.network/builders/interoperability/xcm/xcm-sdk/v1/).
+The following sections contain basic examples of how to work with the XCM SDK to build transfer data to transfer an asset from one chain to another and how to submit the transfer. For a detailed overview on how to use it, please refer to the [XCM SDK docs](https://moonbeam-foundation.github.io/xcm-sdk/latest/example-usage/xcm).
 
 ## Build XCM Transfer Data
 
 ```js
 import { Sdk } from '@moonbeam-network/xcm-sdk';
 
-const { assets, getTransferData } = Sdk();
-
-// You can build the XCM transfer data via the assets function
-const dataViaAssetsMethod = await assets()
-  .asset('INSERT_ASSET')
-  .source('INSERT_SOURCE_CHAIN')
-  .destination('INSERT_DESTINATION_CHAIN')
-  .accounts('INSERT_SOURCE_ADDRESS', 'INSERT_DESTINATION_ADDRESS', {
-    evmSigner?: 'INSERT_EVM_SIGNER',
-    polkadotSigner?: 'INSERT_POLKADOT_SIGNER',
-  });
-
-// Or via the getTransferData function
-const dataViaGetTransferDataMethod = await getTransferData({
-  destinationAddress: 'INSERT_DESTINATION_ADDRESS',
-  destinationKeyOrChain: 'INSERT_DESTINATION_CHAIN',
-  evmSigner?: 'INSERT_EVM_SIGNER',
-  keyOrAsset: 'INSERT_ASSET',
-  polkadotSigner?: 'INSERT_POLKADOT_SIGNER',
-  sourceAddress: 'INSERT_SOURCE_ADDRESS',
-  sourceKeyOrChain: 'INSERT_SOURCE_CHAIN',
-});
+const transferData = async () => {
+  const transferData = await Sdk()
+  .setAsset(INSERT_ASSET)
+  .setSource(INSERT_SOURCE_CHAIN)
+  .setDestination(INSERT_DESTINATION_CHAIN)
+  .setAddresses({
+    sourceAddress: INSERT_SOURCE_ADDRESS,
+      destinationAddress: INSERT_DESTINATION_ADDRESS,
+    });
+  };
+
+fromPolkadot();
 ```
 
 ## Transfer
@@ -56,7 +46,7 @@ const dataViaGetTransferDataMethod = await getTransferData({
 ```js
 ...
 
-const hash = await dataViaGetTransferDataMethod.transfer('INSERT_TRANSFER_AMOUNT');
+const hash = await transferData.transfer(INSERT_TRANSFER_AMOUNT, { INSERT_SIGNERS });
 ```
 
 # Examples
@@ -76,10 +66,11 @@ pnpm run start
 
 # Contributing
 
+First fork the repository and clone it.
+
 ```bash
-git clone git@github.com:moonbeam-foundation/xcm-sdk.git
+git clone git@github.com:YOUR_GITHUB_USERNAME/xcm-sdk.git
 pnpm install
-pnpm run dev
 ```
 
 Optionally, you can install the `pre-commit` hook to run the linter and tests before committing:
@@ -99,9 +90,6 @@ pnpm run test
 ## Acceptance tests
 
 ```bash
-cp .env.example .env
-# add private key and suri to .env file
-
 pnpm run test:acc
 ```
 

package/package.json

@@ -1,14 +1,7 @@
 {
   "name": "@moonbeam-network/xcm-sdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "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",
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "link": "pnpm ln --global",
-    "typecheck": "tsc --noEmit",
-    "test:acc": "vitest --run --testTimeout 300000 ./tests/acceptance"
-  },
   "author": "moonbeam-foundation",
   "license": "MIT",
   "repository": {
@@ -29,7 +22,9 @@
     "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",
@@ -39,11 +34,11 @@
   "types": "./build/index.d.ts",
   "main": "./build/index.mjs",
   "dependencies": {
-    "@moonbeam-network/xcm-builder": "3.0.0",
-    "@moonbeam-network/xcm-config": "3.0.0",
-    "@moonbeam-network/xcm-types": "3.0.0",
-    "@moonbeam-network/xcm-utils": "3.0.0",
-    "big.js": "^6.2.1"
+    "big.js": "^6.2.1",
+    "@moonbeam-network/xcm-builder": "3.0.1",
+    "@moonbeam-network/xcm-config": "3.0.1",
+    "@moonbeam-network/xcm-utils": "3.0.1",
+    "@moonbeam-network/xcm-types": "3.0.1"
   },
   "peerDependencies": {
     "@polkadot/api": "14.3.1",
@@ -54,5 +49,12 @@
   },
   "devDependencies": {
     "@types/big.js": "^6.2.2"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "link": "pnpm ln --global",
+    "typecheck": "tsc --noEmit",
+    "test:acc": "vitest --run --testTimeout 300000 ./tests/acceptance"
   }
-}
+}

package/build/index.d.mts

@@ -1,195 +0,0 @@
-import { ContractConfig, ExtrinsicConfig, BalanceConfigBuilder, AssetMinConfigBuilder, FeeConfigBuilder, SubstrateQueryConfig, EvmQueryConfig } from '@moonbeam-network/xcm-builder';
-import { AssetRoute, FeeConfig, ConfigService } from '@moonbeam-network/xcm-config';
-import * as _moonbeam_network_xcm_types from '@moonbeam-network/xcm-types';
-import { AssetAmount, AnyChain, AnyParachain, ChainAsset, Asset, EvmChain, EvmParachain, Ecosystem, AnyAsset } from '@moonbeam-network/xcm-types';
-import { Signer, SubmittableExtrinsic } from '@polkadot/api/types';
-import { IKeyringPair, ISubmittableResult } from '@polkadot/types/types';
-import { WalletClient, PublicClient, HttpTransport, Hash } from 'viem';
-import { ApiPromise } from '@polkadot/api';
-import { RuntimeDispatchInfo } from '@polkadot/types/interfaces';
-import { HexString } from '@polkadot/util/types';
-
-type EvmSigner = WalletClient;
-interface Signers {
-    evmSigner?: EvmSigner;
-    polkadotSigner?: Signer | IKeyringPair;
-}
-interface TransferData {
-    destination: DestinationChainTransferData;
-    getEstimate(amount: number | string): AssetAmount;
-    max: AssetAmount;
-    min: AssetAmount;
-    source: SourceChainTransferData;
-    transfer(amount: bigint | number | string, signers: Signers): Promise<string>;
-}
-interface SourceChainTransferData extends ChainTransferData {
-    destinationFee: AssetAmount;
-    destinationFeeBalance: AssetAmount;
-    feeBalance: AssetAmount;
-    max: AssetAmount;
-}
-interface SovereignAccountBalance {
-    feeAssetBalance: bigint | undefined;
-    transferAssetBalance: bigint;
-}
-interface DestinationChainTransferData extends ChainTransferData {
-    sovereignAccountBalances?: SovereignAccountBalance;
-}
-interface ChainTransferData {
-    balance: AssetAmount;
-    chain: AnyChain;
-    existentialDeposit?: AssetAmount;
-    fee: AssetAmount;
-    min: AssetAmount;
-}
-
-interface GetSourceDataParams {
-    route: AssetRoute;
-    destinationAddress: string;
-    destinationFee: AssetAmount;
-    sourceAddress: string;
-}
-declare function getSourceData({ route, destinationAddress, destinationFee, sourceAddress, }: GetSourceDataParams): Promise<SourceChainTransferData>;
-interface GetFeeParams {
-    balance: AssetAmount;
-    feeBalance: AssetAmount;
-    contract?: ContractConfig;
-    chain: AnyParachain;
-    destinationFee: AssetAmount;
-    extrinsic?: ExtrinsicConfig;
-    feeConfig?: FeeConfig;
-    sourceAddress: string;
-}
-declare function getFee({ balance, feeBalance, chain, contract, destinationFee, extrinsic, feeConfig, sourceAddress, }: GetFeeParams): Promise<AssetAmount>;
-interface GetAssetsBalancesParams {
-    address: string;
-    chain: AnyParachain;
-    routes: AssetRoute[];
-    evmSigner?: EvmSigner;
-}
-declare function getAssetsBalances({ address, chain, routes, }: GetAssetsBalancesParams): Promise<AssetAmount[]>;
-
-interface GetDestinationDataParams {
-    route: AssetRoute;
-    destinationAddress: string;
-}
-declare function getDestinationData({ route, destinationAddress, }: GetDestinationDataParams): Promise<DestinationChainTransferData>;
-
-interface GetBalancesParams {
-    address: string;
-    asset: ChainAsset;
-    builder: BalanceConfigBuilder;
-    chain: AnyChain;
-}
-declare function getBalance({ address, asset, builder, chain, }: GetBalancesParams): Promise<AssetAmount>;
-interface GetMinParams {
-    asset: Asset;
-    builder?: AssetMinConfigBuilder;
-    chain: AnyChain;
-}
-declare function getAssetMin({ asset, builder, chain, }: GetMinParams): Promise<AssetAmount>;
-declare function getMin({ balance, existentialDeposit, fee, min, }: DestinationChainTransferData): AssetAmount;
-interface GetMaxParams {
-    balance: AssetAmount;
-    existentialDeposit?: AssetAmount;
-    fee: AssetAmount;
-    min: AssetAmount;
-}
-declare function getMax({ balance, existentialDeposit, fee, min, }: GetMaxParams): AssetAmount;
-interface GetDestinationFeeParams {
-    address: string;
-    asset: Asset;
-    feeAsset: Asset;
-    destination: AnyChain;
-    fee: number | FeeConfigBuilder;
-}
-declare function getDestinationFee({ address, asset, destination, fee, feeAsset, }: GetDestinationFeeParams): Promise<AssetAmount>;
-interface ConvertToChainDecimalsParams {
-    asset: AssetAmount;
-    target: ChainAsset;
-}
-declare function convertToChainDecimals({ asset, target, }: ConvertToChainDecimalsParams): AssetAmount;
-declare function getExistentialDeposit(chain: AnyChain): Promise<AssetAmount | undefined>;
-interface GetDestinationFeeBalanceParams {
-    balance: AssetAmount;
-    feeBalance: AssetAmount;
-    route: AssetRoute;
-    sourceAddress: string;
-}
-declare function getDestinationFeeBalance({ balance, feeBalance, route, sourceAddress, }: GetDestinationFeeBalanceParams): Promise<AssetAmount>;
-interface GetExtrinsicFeeParams {
-    address: string;
-    balance: AssetAmount;
-    chain: AnyParachain;
-    extrinsic: ExtrinsicConfig;
-    feeBalance: AssetAmount;
-    feeConfig?: FeeConfig;
-}
-declare function getExtrinsicFee({ address, balance, chain, extrinsic, feeBalance, feeConfig, }: GetExtrinsicFeeParams): Promise<AssetAmount>;
-interface GetContractFeeParams {
-    address: string;
-    balance: AssetAmount;
-    chain: EvmChain | EvmParachain;
-    contract: ContractConfig;
-    destinationFee: AssetAmount;
-    feeBalance: AssetAmount;
-    feeConfig?: FeeConfig;
-}
-declare function getContractFee({ address, balance, chain, contract, destinationFee, feeBalance, feeConfig, }: GetContractFeeParams): Promise<AssetAmount>;
-interface ValidateSovereignAccountBalancesProps {
-    amount: bigint;
-    destinationData: DestinationChainTransferData;
-    sourceData: SourceChainTransferData;
-}
-declare function validateSovereignAccountBalances({ amount, sourceData, destinationData, }: ValidateSovereignAccountBalancesProps): void;
-
-interface SdkOptions {
-    configService?: ConfigService;
-    ecosystem?: Ecosystem;
-}
-declare function Sdk({ configService, ecosystem }?: SdkOptions): {
-    assets: _moonbeam_network_xcm_types.Asset[];
-    setAsset(asset: string | AnyAsset): {
-        sources: AnyChain[];
-        setSource(source: string | AnyChain): {
-            destinations: AnyChain[];
-            setDestination(destination: string | AnyChain): {
-                setAddresses({ sourceAddress, destinationAddress, }: {
-                    sourceAddress: string;
-                    destinationAddress: string;
-                }): Promise<TransferData>;
-            };
-        };
-    };
-};
-declare function getParachainBalances(chain: AnyParachain, address: string, service?: ConfigService): Promise<AssetAmount[]>;
-
-declare class PolkadotService {
-    #private;
-    readonly api: ApiPromise;
-    readonly chain: AnyParachain;
-    constructor(api: ApiPromise, chain: AnyParachain);
-    static create(chain: AnyParachain): Promise<PolkadotService>;
-    static createMulti(chains: AnyParachain[]): Promise<PolkadotService[]>;
-    get decimals(): number;
-    get existentialDeposit(): AssetAmount;
-    query(config: SubstrateQueryConfig): Promise<bigint>;
-    getExtrinsic(config: ExtrinsicConfig): SubmittableExtrinsic<'promise', ISubmittableResult>;
-    getExtrinsicCallHash(config: ExtrinsicConfig): HexString;
-    getPaymentInfo(account: string, config: ExtrinsicConfig): Promise<RuntimeDispatchInfo>;
-    getFee(account: string, config: ExtrinsicConfig): Promise<bigint>;
-    transfer(account: string, config: ExtrinsicConfig, signer: Signer | IKeyringPair, statusCallback?: (params: ISubmittableResult) => void): Promise<string>;
-}
-
-declare class EvmService {
-    readonly chain: EvmChain | EvmParachain;
-    readonly client: PublicClient<HttpTransport>;
-    static create(chain: EvmChain | EvmParachain): EvmService;
-    constructor(chain: EvmChain | EvmParachain);
-    query(query: EvmQueryConfig): Promise<bigint>;
-    getFee(address: string, contract: ContractConfig): Promise<bigint>;
-    getBalance(address: string, contract: ContractConfig): Promise<bigint>;
-    transfer(signer: EvmSigner, contract: ContractConfig): Promise<Hash>;
-}
-
-export { type ChainTransferData, type ConvertToChainDecimalsParams, type DestinationChainTransferData, EvmService, type EvmSigner, type GetAssetsBalancesParams, type GetBalancesParams, type GetContractFeeParams, type GetDestinationDataParams, type GetDestinationFeeBalanceParams, type GetDestinationFeeParams, type GetExtrinsicFeeParams, type GetFeeParams, type GetMaxParams, type GetMinParams, type GetSourceDataParams, PolkadotService, Sdk, type SdkOptions, type Signers, type SourceChainTransferData, type SovereignAccountBalance, type TransferData, convertToChainDecimals, getAssetMin, getAssetsBalances, getBalance, getContractFee, getDestinationData, getDestinationFee, getDestinationFeeBalance, getExistentialDeposit, getExtrinsicFee, getFee, getMax, getMin, getParachainBalances, getSourceData, validateSovereignAccountBalances };