@moonbeam-network/xcm-sdk 2.7.9 → 3.0.0

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

@@ -66,20 +66,26 @@ const hash = await dataViaGetTransferDataMethod.transfer('INSERT_TRANSFER_AMOUNT
 ```bash
 git clone git@github.com:moonbeam-foundation/xcm-sdk.git
 cd xcm-sdk
-npm i
+pnpm install
 cd examples/sdk-simple
 
 # edit index.ts by adding your accounts
 
-npm start
+pnpm run start
 ```
 
 # Contributing
 
 ```bash
 git clone git@github.com:moonbeam-foundation/xcm-sdk.git
-npm i
-npm run dev
+pnpm install
+pnpm run dev
+```
+
+Optionally, you can install the `pre-commit` hook to run the linter and tests before committing:
+
+```bash
+pnpm lefthook install
 ```
 
 # Tests
@@ -87,7 +93,7 @@ npm run dev
 ## Unit tests
 
 ```bash
-npm run test
+pnpm run test
 ```
 
 ## Acceptance tests
@@ -96,7 +102,7 @@ npm run test
 cp .env.example .env
 # add private key and suri to .env file
 
-npm run test:acc
+pnpm run test:acc
 ```
 
 # Release
@@ -106,7 +112,7 @@ To create a dev version go to GitHub actions and run `publish dev versions` work
 To create a release version run:
 
 ```bash
-npm run changeset
+pnpm run changeset
 ```
 
 # Testing the change in the SDK locally
@@ -114,17 +120,19 @@ npm run changeset
 Build the project:
 
 ```bash
-npm run build
+pnpm run build
 ```
 
+Link the SDK:
+
 ```bash
-npm run link
+pnpm run clean && pnpm run build && pnpm run link
 ```
 
 In your project where you would like to test the changes:
 
 ```bash
-npm link @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk
+pnpm link @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk
 ```
 
 If you need you can link other packages too.
@@ -132,5 +140,5 @@ If you need you can link other packages too.
 After testing is done, unlink the SDK:
 
 ```bash
-npm unlink @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk
+pnpm unlink @moonbeam-network/xcm-types @moonbeam-network/xcm-utils @moonbeam-network/xcm-builder @moonbeam-network/xcm-config @moonbeam-network/xcm-sdk
 ```

package/build/index.d.mts

@@ -0,0 +1,195 @@
+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 };