@paraspell/sdk 5.2.1 → 5.4.0

package/dist/index.d.ts

@@ -1,6 +1,15 @@
 import { ApiPromise } from '@polkadot/api';
 import { SubmittableExtrinsic } from '@polkadot/api/types';
 
+interface TMultiAsset {
+    id: {
+        Concrete: TMultiLocation;
+    };
+    fun: {
+        Fungible: TAmount;
+    };
+}
+
 type Extrinsic = SubmittableExtrinsic<'promise'>;
 interface PolkadotXCMTransferInput {
     api: ApiPromise;
@@ -23,7 +32,7 @@ interface XTokensTransferInput {
     origin: TNode;
     destination?: TDestination;
     paraIdTo?: number;
-    overridedCurrencyMultiLocation?: TMultiLocation;
+    overridedCurrencyMultiLocation?: TMultiLocation | TMultiAsset[];
     feeAsset?: TCurrency;
     serializedApiCallEnabled?: boolean;
 }
@@ -36,7 +45,7 @@ interface XTransferTransferInput {
     origin: TNode;
     paraId?: number;
     destination?: TDestination;
-    overridedCurrencyMultiLocation?: TMultiLocation;
+    overridedCurrencyMultiLocation?: TMultiLocation | TMultiAsset[];
     serializedApiCallEnabled?: boolean;
 }
 interface IPolkadotXCMTransfer {
@@ -54,13 +63,14 @@ declare enum Version {
     V2 = "V2",
     V3 = "V3"
 }
+type TVersionClaimAssets = Version.V3 | Version.V2;
 declare enum Parents {
     ONE = 1,
     ZERO = 0
 }
 type TAmount = string | number | bigint;
 type TCurrency = string | number | bigint;
-type TCurrencyInput = string | number | bigint | TMultiLocation;
+type TCurrencyInput = string | number | bigint | TMultiLocation | TMultiAsset[];
 type TAddress = string | TMultiLocation;
 type TDestination = TNode | TMultiLocation;
 interface TSendBaseOptions {
@@ -74,7 +84,7 @@ interface TSendOptions extends TSendBaseOptions {
     api?: ApiPromise;
     origin: TNode;
     currency: TCurrencyInput;
-    amount: TAmount;
+    amount: TAmount | null;
 }
 interface TSendOptionsCommon extends TSendOptions {
     serializedApiCallEnabled?: boolean;
@@ -84,7 +94,7 @@ interface TSendInternalOptions extends TSendBaseOptions {
     currencySymbol: string | undefined;
     currencyId: string | undefined;
     amount: string;
-    overridedCurrencyMultiLocation?: TMultiLocation;
+    overridedCurrencyMultiLocation?: TMultiLocation | TMultiAsset[];
     serializedApiCallEnabled?: boolean;
 }
 interface TRelayToParaBaseOptions {
@@ -186,6 +196,7 @@ interface JunctionGlobalConsensus {
 }
 type TJunction = JunctionParachain | JunctionAccountId32 | JunctionAccountIndex64 | JunctionAccountKey20 | JunctionPalletInstance | JunctionGeneralIndex | JunctionGeneralKey | JunctionOnlyChild | JunctionPlurality | JunctionGlobalConsensus;
 interface Junctions {
+    Here?: null;
     X1?: TJunction;
     X2?: [TJunction, TJunction];
     X3?: [TJunction, TJunction, TJunction];
@@ -242,12 +253,12 @@ declare abstract class ParachainNode {
     transferRelayToPara(options: TRelayToParaInternalOptions): TSerializedApiCall;
     getProvider(): string;
     createApiInstance(): Promise<ApiPromise>;
-    createCurrencySpec(amount: string, scenario: TScenario, version: Version, _?: string, overridedMultiLocation?: TMultiLocation): any;
+    createCurrencySpec(amount: string, scenario: TScenario, version: Version, _?: string, overridedMultiLocation?: TMultiLocation | TMultiAsset[]): any;
     createPolkadotXcmHeader(scenario: TScenario, destination?: TDestination, paraId?: number): any;
 }
 
-declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet"];
-declare const NODES_WITH_RELAY_CHAINS: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Unique", "Crust", "Manta", "Nodle", "NeuroWeb", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Subsocial", "KiltSpiritnet", "Polkadot", "Kusama"];
+declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "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", "Centrifuge", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "CoretimeKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "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 SUPPORTED_PALLETS: readonly ["XTokens", "OrmlXTokens", "PolkadotXcm", "RelayerXcm", "XTransfer"];
 
 type TNode = (typeof NODE_NAMES)[number];
@@ -349,18 +360,55 @@ declare const getAssetDecimals: (node: TNode, symbol: string) => number | null;
 declare const getParaId: (node: TNode) => number;
 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>;
+
+interface TTransferInfo {
+    chain: {
+        origin: TNodeWithRelayChains;
+        destination: TNodeWithRelayChains;
+        ecosystem: string;
+    };
+    currencyBalanceOrigin: {
+        balance: bigint;
+        currency: string;
+    };
+    originFeeBalance: {
+        balance: bigint;
+        expectedBalanceAfterXCMFee: bigint;
+        xcmFee: {
+            sufficientForXCM: boolean;
+            xcmFee: bigint;
+        };
+        existentialDeposit: bigint;
+        asset: string;
+        minNativeTransferableAmount: bigint;
+        maxNativeTransferableAmount: bigint;
+    };
+    destinationFeeBalance: {
+        balance: bigint;
+        currency: string;
+        existentialDeposit: bigint;
+    };
+}
+declare const getTransferInfo: (origin: TNodeWithRelayChains, destination: TNodeWithRelayChains, accountOrigin: string, accountDestination: string, assetSymbolOrId: string, amount: string) => Promise<TTransferInfo>;
+
 declare const index_getAllAssetsSymbols: typeof getAllAssetsSymbols;
 declare const index_getAssetDecimals: typeof getAssetDecimals;
 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_getNativeAssets: typeof getNativeAssets;
 declare const index_getOtherAssets: typeof getOtherAssets;
 declare const index_getParaId: typeof getParaId;
 declare const index_getRelayChainSymbol: typeof getRelayChainSymbol;
 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_getNativeAssets as getNativeAssets, index_getOtherAssets as getOtherAssets, index_getParaId as getParaId, index_getRelayChainSymbol as getRelayChainSymbol, index_getTNode as getTNode, 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_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;
@@ -396,7 +444,7 @@ declare class FromGeneralBuilder {
     constructor(api: ApiPromise | undefined, from: TNode);
     to(node: TDestination, paraIdTo?: number): ToGeneralBuilder;
     feeAsset(feeAsset: TCurrency): AmountBuilder;
-    amount(amount: TAmount): AddressBuilder;
+    amount(amount: TAmount | null): AddressBuilder;
     closeChannel(): InboundCloseChannelBuilder;
 }
 declare class GeneralBuilder {
@@ -404,12 +452,17 @@ declare class GeneralBuilder {
     constructor(api?: ApiPromise);
     from(node: TNode): FromGeneralBuilder;
     to(node: TDestination, paraIdTo?: number): AmountBuilder;
+    claimFrom(node: TNodeWithRelayChains): FungibleBuilder;
 }
 declare const Builder: (api?: ApiPromise) => GeneralBuilder;
 interface FinalBuilder {
     build: () => Extrinsic | never;
     buildSerializedApiCall: () => TSerializedApiCall;
 }
+interface FinalBuilderAsync {
+    build: () => Promise<Extrinsic | never>;
+    buildSerializedApiCall: () => Promise<TSerializedApiCall>;
+}
 interface UseKeepAliveFinalBuilder {
     useKeepAlive: (destApi: ApiPromise) => UseKeepAliveFinalBuilder;
     build: () => Promise<Extrinsic | never>;
@@ -419,12 +472,21 @@ interface AddressBuilder {
     address: (address: TAddress) => UseKeepAliveFinalBuilder;
 }
 interface AmountBuilder {
-    amount: (amount: TAmount) => AddressBuilder;
+    amount: (amount: TAmount | null) => AddressBuilder;
 }
 interface AmountOrFeeAssetBuilder {
-    amount: (amount: TAmount) => AddressBuilder;
+    amount: (amount: TAmount | null) => AddressBuilder;
     feeAsset: (feeAsset: TCurrencyInput) => AmountBuilder;
 }
+interface FungibleBuilder {
+    fungible: (multiAssets: TMultiAsset[]) => AccountBuilder;
+}
+interface AccountBuilder {
+    account: (address: TAddress) => VersionBuilder;
+}
+interface VersionBuilder extends FinalBuilderAsync {
+    xcmVersion: (version: TVersionClaimAssets) => FinalBuilderAsync;
+}
 
 declare const getNode: (node: TNode) => ParachainNode;
 declare const getNodeEndpointOption: (node: TNode) => any;
@@ -454,4 +516,4 @@ declare class IncompatibleNodesError extends Error {
 
 declare const getExistentialDeposit: (node: TNodeWithRelayChains) => string | null;
 
-export { Builder, type CheckKeepAliveOptions, type Extrinsic, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, type JunctionType, 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 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, Version, type XTokensTransferInput, type XTransferTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getDefaultPallet, getExistentialDeposit, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, hasSupportForAsset, index$2 as openChannels, index$3 as xcmPallet };
+export { Builder, type CheckKeepAliveOptions, type Extrinsic, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, type JunctionType, 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 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 };