@paraspell/sdk 5.6.0 → 5.7.0

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import { ApiPromise } from '@polkadot/api';
 import { SubmittableExtrinsic } from '@polkadot/api/types';
+import { AbstractProvider, Signer } from 'ethers';
+import * as _polkadot_apps_config_endpoints_types from '@polkadot/apps-config/endpoints/types';
 
 type TMultiAsset = TMultiAssetV3 | TMultiAssetV4;
 interface TMultiAssetV3 {
@@ -154,10 +156,10 @@ interface CheckKeepAliveOptions {
     originApi: ApiPromise;
     address: string;
     amount: string;
-    originNode?: TNode;
+    originNode?: TNodePolkadotKusama;
     destApi?: ApiPromise;
     currencySymbol?: string;
-    destNode?: TNode;
+    destNode?: TNodePolkadotKusama;
 }
 
 type JunctionType = 'Parachain' | 'AccountId32' | 'AccountIndex64' | 'AccountKey20' | 'PalletInstance' | 'GeneralIndex' | 'GeneralKey' | 'OnlyChild' | 'Plurality' | 'GlobalConsensus';
@@ -209,7 +211,7 @@ interface JunctionPlurality {
     };
 }
 interface JunctionGlobalConsensus {
-    GlobalConsensus: NetworkId;
+    GlobalConsensus: NetworkId | object;
 }
 type TJunction = JunctionParachain | JunctionAccountId32 | JunctionAccountIndex64 | JunctionAccountKey20 | JunctionPalletInstance | JunctionGeneralIndex | JunctionGeneralKey | JunctionOnlyChild | JunctionPlurality | JunctionGlobalConsensus;
 interface Junctions {
@@ -271,17 +273,20 @@ declare abstract class ParachainNode {
     transferRelayToPara(options: TRelayToParaInternalOptions): TSerializedApiCall;
     getProvider(): string;
     createApiInstance(): Promise<ApiPromise>;
-    createCurrencySpec(amount: string, scenario: TScenario, version: Version, _?: string, overridedMultiLocation?: TMultiLocation | TMultiAsset[]): any;
-    createPolkadotXcmHeader(scenario: TScenario, version: Version, destination?: TDestination, paraId?: number): any;
+    createCurrencySpec(amount: string, scenario: TScenario, version: Version, _?: string, overridedMultiLocation?: TMultiLocation | TMultiAsset[]): TCurrencySelectionHeaderArr;
+    createPolkadotXcmHeader(scenario: TScenario, version: Version, destination?: TDestination, paraId?: number): TMultiLocationHeader;
 }
 
-declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio"];
-declare const NODES_WITH_RELAY_CHAINS: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio", "Polkadot", "Kusama"];
+declare const NODE_NAMES_DOT_KSM: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio", "Mythos", "Peaq"];
+declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio", "Mythos", "Peaq", "Ethereum"];
+declare const NODES_WITH_RELAY_CHAINS: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio", "Mythos", "Peaq", "Ethereum", "Polkadot", "Kusama"];
+declare const NODES_WITH_RELAY_CHAINS_DOT_KSM: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "BridgeHubPolkadot", "BridgeHubKusama", "Centrifuge", "ComposableFinance", "Darwinia", "Hydration", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Curio", "Mythos", "Peaq", "Polkadot", "Kusama"];
 declare const SUPPORTED_PALLETS: readonly ["XTokens", "OrmlXTokens", "PolkadotXcm", "RelayerXcm", "XTransfer"];
 
 type TNode = (typeof NODE_NAMES)[number];
+type TNodePolkadotKusama = Exclude<TNode, 'Ethereum'>;
 type TNodeWithRelayChains = (typeof NODES_WITH_RELAY_CHAINS)[number];
-type TNodeToAssetModuleMap = Record<TNode, string | null>;
+type TNodeDotKsmWithRelayChains = Exclude<TNodeWithRelayChains, 'Ethereum'>;
 
 type TRelayChainType = 'polkadot' | 'kusama';
 type TRelayChainSymbol = 'DOT' | 'KSM';
@@ -310,7 +315,7 @@ interface TPalletMap {
     defaultPallet: TPallet;
     supportedPallets: TPallet[];
 }
-type TPalletJsonMap = Record<TNode, TPalletMap>;
+type TPalletJsonMap = Record<TNodePolkadotKusama, TPalletMap>;
 
 interface TOpenChannelOptions {
     api: ApiPromise;
@@ -332,12 +337,12 @@ interface TOpenChannelInternalOptions extends TOpenChannelOptions {
     serializedApiCallEnabled?: boolean;
 }
 
-type TEdJsonMap = Record<TNodeWithRelayChains, string | null>;
+type TEdJsonMap = Record<TNodeDotKsmWithRelayChains, string | null>;
 
 declare const sendSerializedApiCall: (options: TSendOptions) => Promise<TSerializedApiCall>;
 declare const send: (options: TSendOptions) => Promise<Extrinsic>;
-declare const transferRelayToParaCommon: (options: TRelayToParaCommonOptions) => Promise<Extrinsic | TSerializedApiCall | never>;
-declare const transferRelayToPara: (options: TRelayToParaOptions) => Promise<Extrinsic | never>;
+declare const transferRelayToParaCommon: (options: TRelayToParaCommonOptions) => Promise<Extrinsic | TSerializedApiCall>;
+declare const transferRelayToPara: (options: TRelayToParaOptions) => Promise<Extrinsic>;
 declare const transferRelayToParaSerializedApiCall: (options: TRelayToParaOptions) => Promise<TSerializedApiCall>;
 
 declare const index$3_send: typeof send;
@@ -373,6 +378,7 @@ declare const getRelayChainSymbol: (node: TNode) => TRelayChainSymbol;
 declare const getNativeAssets: (node: TNode) => TNativeAssetDetails[];
 declare const getOtherAssets: (node: TNode) => TAssetDetails[];
 declare const getAllAssetsSymbols: (node: TNode) => string[];
+declare const getNativeAssetSymbol: (node: TNodeWithRelayChains) => string;
 declare const hasSupportForAsset: (node: TNode, symbol: string) => boolean;
 declare const getAssetDecimals: (node: TNode, symbol: string) => number | null;
 declare const getParaId: (node: TNode) => number;
@@ -380,7 +386,7 @@ declare const getTNode: (paraId: number) => TNode | null;
 
 declare const getBalanceNative: (address: string, node: TNodeWithRelayChains, api?: ApiPromise) => Promise<bigint>;
 
-declare const getBalanceForeign: (address: string, node: TNode, symbolOrId: string, api?: ApiPromise) => Promise<bigint | null>;
+declare const getBalanceForeign: (address: string, node: TNodePolkadotKusama, symbolOrId: string, api?: ApiPromise) => Promise<bigint | null>;
 
 interface TTransferInfo {
     chain: {
@@ -410,7 +416,7 @@ interface TTransferInfo {
         existentialDeposit: bigint;
     };
 }
-declare const getTransferInfo: (origin: TNodeWithRelayChains, destination: TNodeWithRelayChains, accountOrigin: string, accountDestination: string, assetSymbolOrId: string, amount: string) => Promise<TTransferInfo>;
+declare const getTransferInfo: (origin: TNodeDotKsmWithRelayChains, destination: TNodeDotKsmWithRelayChains, accountOrigin: string, accountDestination: string, assetSymbolOrId: string, amount: string) => Promise<TTransferInfo>;
 
 declare const index_getAllAssetsSymbols: typeof getAllAssetsSymbols;
 declare const index_getAssetDecimals: typeof getAssetDecimals;
@@ -418,6 +424,7 @@ declare const index_getAssetId: typeof getAssetId;
 declare const index_getAssetsObject: typeof getAssetsObject;
 declare const index_getBalanceForeign: typeof getBalanceForeign;
 declare const index_getBalanceNative: typeof getBalanceNative;
+declare const index_getNativeAssetSymbol: typeof getNativeAssetSymbol;
 declare const index_getNativeAssets: typeof getNativeAssets;
 declare const index_getOtherAssets: typeof getOtherAssets;
 declare const index_getParaId: typeof getParaId;
@@ -426,11 +433,11 @@ declare const index_getTNode: typeof getTNode;
 declare const index_getTransferInfo: typeof getTransferInfo;
 declare const index_hasSupportForAsset: typeof hasSupportForAsset;
 declare namespace index {
-  export { index_getAllAssetsSymbols as getAllAssetsSymbols, index_getAssetDecimals as getAssetDecimals, index_getAssetId as getAssetId, index_getAssetsObject as getAssetsObject, index_getBalanceForeign as getBalanceForeign, index_getBalanceNative as getBalanceNative, index_getNativeAssets as getNativeAssets, index_getOtherAssets as getOtherAssets, index_getParaId as getParaId, index_getRelayChainSymbol as getRelayChainSymbol, index_getTNode as getTNode, index_getTransferInfo as getTransferInfo, index_hasSupportForAsset as hasSupportForAsset };
+  export { index_getAllAssetsSymbols as getAllAssetsSymbols, index_getAssetDecimals as getAssetDecimals, index_getAssetId as getAssetId, index_getAssetsObject as getAssetsObject, index_getBalanceForeign as getBalanceForeign, index_getBalanceNative as getBalanceNative, index_getNativeAssetSymbol as getNativeAssetSymbol, index_getNativeAssets as getNativeAssets, index_getOtherAssets as getOtherAssets, index_getParaId as getParaId, index_getRelayChainSymbol as getRelayChainSymbol, index_getTNode as getTNode, index_getTransferInfo as getTransferInfo, index_hasSupportForAsset as hasSupportForAsset };
 }
 
-declare const getDefaultPallet: (node: TNode) => TPallet;
-declare const getSupportedPallets: (node: TNode) => TPallet[];
+declare const getDefaultPallet: (node: TNodePolkadotKusama) => TPallet;
+declare const getSupportedPallets: (node: TNodePolkadotKusama) => TPallet[];
 
 interface OutboundCloseChannelBuilder {
     outbound: (inbound: number) => FinalBuilder;
@@ -438,6 +445,19 @@ interface OutboundCloseChannelBuilder {
 interface InboundCloseChannelBuilder {
     inbound: (inbound: number) => OutboundCloseChannelBuilder;
 }
+declare class CloseChannelBuilder implements InboundCloseChannelBuilder, OutboundCloseChannelBuilder, FinalBuilder {
+    private readonly api;
+    private readonly from;
+    private _inbound;
+    private _outbound;
+    private constructor();
+    static create(api: ApiPromise, from: TNode): InboundCloseChannelBuilder;
+    inbound(inbound: number): this;
+    outbound(outbound: number): this;
+    private buildOptions;
+    build(): Extrinsic;
+    buildSerializedApiCall(): TSerializedApiCall;
+}
 
 interface MaxMessageSizeOpenChannelBuilder {
     maxMessageSize: (size: number) => FinalBuilder;
@@ -445,6 +465,20 @@ interface MaxMessageSizeOpenChannelBuilder {
 interface MaxSizeOpenChannelBuilder {
     maxSize: (size: number) => MaxMessageSizeOpenChannelBuilder;
 }
+declare class OpenChannelBuilder implements MaxSizeOpenChannelBuilder, MaxMessageSizeOpenChannelBuilder, FinalBuilder {
+    private readonly api;
+    private readonly from;
+    private readonly to;
+    private _maxSize;
+    private _maxMessageSize;
+    private constructor();
+    static create(api: ApiPromise, from: TNode, to: TDestination): MaxSizeOpenChannelBuilder;
+    maxSize(size: number): this;
+    maxMessageSize(size: number): this;
+    private buildOptions;
+    build(): Extrinsic;
+    buildSerializedApiCall(): TSerializedApiCall;
+}
 
 declare class ToGeneralBuilder {
     private readonly api?;
@@ -478,13 +512,13 @@ interface FinalBuilder {
     buildSerializedApiCall: () => TSerializedApiCall;
 }
 interface FinalBuilderAsync {
-    build: () => Promise<Extrinsic | never>;
+    build: () => Promise<Extrinsic>;
     buildSerializedApiCall: () => Promise<TSerializedApiCall>;
 }
 interface UseKeepAliveFinalBuilder {
     useKeepAlive: (destApi: ApiPromise) => UseKeepAliveFinalBuilder;
     xcmVersion: (version: Version) => UseKeepAliveFinalBuilder;
-    build: () => Promise<Extrinsic | never>;
+    build: () => Promise<Extrinsic>;
     buildSerializedApiCall: () => Promise<TSerializedApiCall>;
 }
 interface AddressBuilder {
@@ -507,9 +541,22 @@ interface VersionBuilder extends FinalBuilderAsync {
     xcmVersion: (version: TVersionClaimAssets) => FinalBuilderAsync;
 }
 
+declare class EvmBuilderClass {
+    private readonly _options;
+    private readonly _provider;
+    constructor(provider: AbstractProvider);
+    to(node: TNodePolkadotKusama): this;
+    amount(amount: string): this;
+    currency(currency: string): this;
+    address(address: string): this;
+    signer(signer: Signer): this;
+    build(): Promise<void>;
+}
+declare const EvmBuilder: (provider: AbstractProvider) => EvmBuilderClass;
+
 declare const getNode: (node: TNode) => ParachainNode;
-declare const getNodeEndpointOption: (node: TNode) => any;
-declare const getAllNodeProviders: (node: TNode) => string[];
+declare const getNodeEndpointOption: (node: TNodePolkadotKusama) => _polkadot_apps_config_endpoints_types.EndpointOption | undefined;
+declare const getAllNodeProviders: (node: TNodePolkadotKusama) => string[];
 declare const getNodeProvider: (node: TNode) => string;
 declare const createApiInstanceForNode: (node: TNodeWithRelayChains) => Promise<ApiPromise>;
 
@@ -533,6 +580,6 @@ declare class IncompatibleNodesError extends Error {
     constructor();
 }
 
-declare const getExistentialDeposit: (node: TNodeWithRelayChains) => string | null;
+declare const getExistentialDeposit: (node: TNodeDotKsmWithRelayChains) => string | null;
 
-export { Builder, type CheckKeepAliveOptions, type Extrinsic, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, type JunctionType, type Junctions, NODES_WITH_RELAY_CHAINS, NODE_NAMES, NoXCMSupportImplementedError, NodeNotSupportedError, Parents, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAddress, type TAmount, type TAssetDetails, type TAssetJsonMap, type TCloseChannelInternalOptions, type TCloseChannelOptions, type TCurrency, type TCurrencyInput, type TCurrencySelection, type TCurrencySelectionHeader, type TCurrencySelectionHeaderArr, type TDestination, type TEdJsonMap, type TJunction, type TMultiAsset, type TMultiAssetV3, type TMultiAssetV4, type TMultiLocation, type TMultiLocationHeader, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeToAssetModuleMap, type TNodeWithRelayChains, type TOpenChannelInternalOptions, type TOpenChannelOptions, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TRelayToParaCommonOptions, type TRelayToParaInternalOptions, type TRelayToParaOptions, type TScenario, type TSendBaseOptions, type TSendInternalOptions, type TSendOptions, type TSendOptionsCommon, type TSerializedApiCall, type TVersionClaimAssets, Version, type XTokensTransferInput, type XTransferTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getBalanceForeign, getBalanceNative, getDefaultPallet, getExistentialDeposit, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, getTransferInfo, hasSupportForAsset, index$2 as openChannels, index$3 as xcmPallet };
+export { Builder, type CheckKeepAliveOptions, CloseChannelBuilder, EvmBuilder, type Extrinsic, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, type InboundCloseChannelBuilder, IncompatibleNodesError, InvalidCurrencyError, type JunctionType, type Junctions, type MaxMessageSizeOpenChannelBuilder, type MaxSizeOpenChannelBuilder, NODES_WITH_RELAY_CHAINS, NODES_WITH_RELAY_CHAINS_DOT_KSM, NODE_NAMES, NODE_NAMES_DOT_KSM, NoXCMSupportImplementedError, NodeNotSupportedError, OpenChannelBuilder, type OutboundCloseChannelBuilder, Parents, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAddress, type TAmount, type TAssetDetails, type TAssetJsonMap, type TCloseChannelInternalOptions, type TCloseChannelOptions, type TCurrency, type TCurrencyInput, type TCurrencySelection, type TCurrencySelectionHeader, type TCurrencySelectionHeaderArr, type TDestination, type TEdJsonMap, type TJunction, type TMultiAsset, type TMultiAssetV3, type TMultiAssetV4, type TMultiLocation, type TMultiLocationHeader, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeDotKsmWithRelayChains, type TNodePolkadotKusama, type TNodeWithRelayChains, type TOpenChannelInternalOptions, type TOpenChannelOptions, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TRelayToParaCommonOptions, type TRelayToParaInternalOptions, type TRelayToParaOptions, type TScenario, type TSendBaseOptions, type TSendInternalOptions, type TSendOptions, type TSendOptionsCommon, type TSerializedApiCall, type TVersionClaimAssets, Version, type XTokensTransferInput, type XTransferTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getBalanceForeign, getBalanceNative, getDefaultPallet, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, getTransferInfo, hasSupportForAsset, index$2 as openChannels, index$3 as xcmPallet };