@paraspell/sdk 3.0.11 → 4.0.0

package/dist/index.d.ts

@@ -18,11 +18,12 @@ declare abstract class ParachainNode {
     getProvider(): string;
     createApiInstance(): Promise<ApiPromise>;
     createCurrencySpec(amount: string, scenario: TScenario, version: Version, currencyId?: string): any;
+    createPolkadotXcmHeader(scenario: TScenario, paraId?: number): any;
 }
 
-declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "Clover", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Equilibrium", "Unique", "Crust", "Manta", "Genshiro", "Nodle", "OriginTrail", "Pendulum", "Polkadex", "Zeitgeist"];
-declare const NODES_WITH_RELAY_CHAINS: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "Clover", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Equilibrium", "Unique", "Crust", "Manta", "Genshiro", "Nodle", "OriginTrail", "Pendulum", "Polkadex", "Zeitgeist", "Polkadot", "Kusama"];
-declare const SUPPORTED_PALLETS: readonly ["XTokens", "OrmlXTokens", "PolkadotXcm", "RelayerXcm"];
+declare const NODE_NAMES: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "Clover", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Equilibrium", "Unique", "Crust", "Manta", "Genshiro", "Nodle", "OriginTrail", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala"];
+declare const NODES_WITH_RELAY_CHAINS: readonly ["AssetHubPolkadot", "Acala", "Astar", "BifrostPolkadot", "Bitgreen", "Centrifuge", "Clover", "ComposableFinance", "Darwinia", "HydraDX", "Interlay", "Litentry", "Moonbeam", "Parallel", "AssetHubKusama", "Encointer", "Altair", "Amplitude", "Bajun", "Basilisk", "BifrostKusama", "Pioneer", "Calamari", "CrustShadow", "Crab", "Imbue", "Integritee", "InvArchTinker", "Karura", "Kintsugi", "Litmus", "Mangata", "Moonriver", "ParallelHeiko", "Picasso", "Quartz", "Robonomics", "Shiden", "Turing", "Equilibrium", "Unique", "Crust", "Manta", "Genshiro", "Nodle", "OriginTrail", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "Polkadot", "Kusama"];
+declare const SUPPORTED_PALLETS: readonly ["XTokens", "OrmlXTokens", "PolkadotXcm", "RelayerXcm", "XTransfer"];
 
 type UpdateFunction = (name: string, index: number) => string;
 type Extrinsic = SubmittableExtrinsic<'promise'>;
@@ -44,6 +45,7 @@ interface TNativeAssetDetails {
 interface TNodeAssets {
     paraId: number;
     relayChainAssetSymbol: TRelayChainSymbol;
+    nativeAssetSymbol: string;
     nativeAssets: TNativeAssetDetails[];
     otherAssets: TAssetDetails[];
 }
@@ -56,6 +58,7 @@ interface TPalletMap {
     supportedPallets: TPallet[];
 }
 type TPalletJsonMap = Record<TNode, TPalletMap>;
+type TEdJsonMap = Record<TNodeWithRelayChains, string | null>;
 interface TSerializedApiCall {
     module: string;
     section: string;
@@ -69,11 +72,28 @@ interface XTokensTransferInput {
     addressSelection: any;
     fees: number;
     scenario: TScenario;
+    origin: TNode;
+    destination?: TNode;
+    paraIdTo?: number;
+    serializedApiCallEnabled?: boolean;
+}
+interface XTransferTransferInput {
+    api: ApiPromise;
+    currency: string | undefined;
+    currencyID: string | undefined;
+    amount: string;
+    recipientAddress: string;
+    origin: TNode;
+    paraId?: number;
+    destination?: TNode;
     serializedApiCallEnabled?: boolean;
 }
 interface IXTokensTransfer {
     transferXTokens: (input: XTokensTransferInput) => Extrinsic | TSerializedApiCall;
 }
+interface IXTransferTransfer {
+    transferXTransfer: (input: XTransferTransferInput) => Extrinsic | TSerializedApiCall;
+}
 interface PolkadotXCMTransferInput {
     api: ApiPromise;
     header: any;
@@ -89,6 +109,7 @@ interface TTransferRelayToParaOptions {
     address: string;
     amount: string;
     paraIdTo?: number;
+    destApiForKeepAlive?: ApiPromise;
 }
 interface IPolkadotXCMTransfer {
     transferPolkadotXCM: (input: PolkadotXCMTransferInput) => Extrinsic | TSerializedApiCall;
@@ -101,12 +122,27 @@ declare enum Parents {
     ONE = 1,
     ZERO = 0
 }
+type PolkadotXCMHeader = {
+    [K in Version]?: {
+        parents: Parents;
+        interior: any;
+    };
+};
+interface CheckKeepAliveOptions {
+    originApi: ApiPromise;
+    address: string;
+    amount: string;
+    originNode?: TNode;
+    destApi?: ApiPromise;
+    currencySymbol?: string;
+    destNode?: TNode;
+}
 
-declare const sendSerializedApiCall: (api: ApiPromise, origin: TNode, currencySymbolOrId: string | number | bigint, amount: string | number | bigint, to: string, destination?: TNode, paraIdTo?: number) => TSerializedApiCall;
-declare function send(api: ApiPromise, origin: TNode, currencySymbolOrId: string | number | bigint, amount: string | number | bigint, to: string, destination?: TNode, paraIdTo?: number): Extrinsic;
-declare const transferRelayToParaCommon: (api: ApiPromise, destination: TNode, amount: string, address: string, paraIdTo?: number, serializedApiCallEnabled?: boolean) => Extrinsic | TSerializedApiCall | never;
-declare function transferRelayToPara(api: ApiPromise, destination: TNode, amount: string | number | bigint, to: string, paraIdTo?: number): Extrinsic | never;
-declare const transferRelayToParaSerializedApiCall: (api: ApiPromise, destination: TNode, amount: string | number | bigint, to: string, paraIdTo?: number) => TSerializedApiCall;
+declare const sendSerializedApiCall: (api: ApiPromise | undefined, origin: TNode, currencySymbolOrId: string | number | bigint, amount: string | number | bigint, to: string, destination?: TNode, paraIdTo?: number, destApiForKeepAlive?: ApiPromise) => Promise<TSerializedApiCall>;
+declare const send: (api: ApiPromise | undefined, origin: TNode, currencySymbolOrId: string | number | bigint, amount: string | number | bigint, to: string, destination?: TNode, paraIdTo?: number, destApiForKeepAlive?: ApiPromise) => Promise<Extrinsic>;
+declare const transferRelayToParaCommon: (api: ApiPromise | undefined, destination: TNode, amount: string, address: string, paraIdTo?: number, destApiForKeepAlive?: ApiPromise, serializedApiCallEnabled?: boolean) => Promise<Extrinsic | TSerializedApiCall | never>;
+declare const transferRelayToPara: (api: ApiPromise | undefined, destination: TNode, amount: string | number | bigint, to: string, paraIdTo?: number, destApiForKeepAlive?: ApiPromise) => Promise<Extrinsic | never>;
+declare const transferRelayToParaSerializedApiCall: (api: ApiPromise | undefined, destination: TNode, amount: string | number | bigint, to: string, paraIdTo?: number, destApiForKeepAlive?: ApiPromise) => Promise<TSerializedApiCall>;
 
 declare const index$4_send: typeof send;
 declare const index$4_sendSerializedApiCall: typeof sendSerializedApiCall;
@@ -117,11 +153,11 @@ declare namespace index$4 {
   export { index$4_send as send, index$4_sendSerializedApiCall as sendSerializedApiCall, index$4_transferRelayToPara as transferRelayToPara, index$4_transferRelayToParaCommon as transferRelayToParaCommon, index$4_transferRelayToParaSerializedApiCall as transferRelayToParaSerializedApiCall };
 }
 
-declare function addLiquidity(api: ApiPromise, assetA: number, assetB: number, amountA: any, amountBMaxLimit: any): Extrinsic;
-declare function buy(api: ApiPromise, assetOut: number, assetIn: number, amount: any, maxLimit: any, discount: Bool): Extrinsic;
-declare function createPool(api: ApiPromise, assetA: number, amountA: any, assetB: number, amountB: any): Extrinsic;
-declare function removeLiquidity(api: ApiPromise, assetA: number, assetB: number, liquidityAmount: any): Extrinsic;
-declare function sell(api: ApiPromise, assetIn: number, assetOut: number, amount: any, maxLimit: any, discount: Bool): Extrinsic;
+declare const addLiquidity: (api: ApiPromise, assetA: number, assetB: number, amountA: any, amountBMaxLimit: any) => Extrinsic;
+declare const buy: (api: ApiPromise, assetOut: number, assetIn: number, amount: any, maxLimit: any, discount: Bool) => Extrinsic;
+declare const createPool: (api: ApiPromise, assetA: number, amountA: any, assetB: number, amountB: any) => Extrinsic;
+declare const removeLiquidity: (api: ApiPromise, assetA: number, assetB: number, liquidityAmount: any) => Extrinsic;
+declare const sell: (api: ApiPromise, assetIn: number, assetOut: number, amount: any, maxLimit: any, discount: Bool) => Extrinsic;
 
 declare const index$3_addLiquidity: typeof addLiquidity;
 declare const index$3_buy: typeof buy;
@@ -132,8 +168,8 @@ declare namespace index$3 {
   export { index$3_addLiquidity as addLiquidity, index$3_buy as buy, index$3_createPool as createPool, index$3_removeLiquidity as removeLiquidity, index$3_sell as sell };
 }
 
-declare function openChannel(api: ApiPromise, origin: TNode, destination: TNode, maxSize: number, maxMessageSize: number): Extrinsic;
-declare function openChannelSerializedApiCall(api: ApiPromise, origin: TNode, destination: TNode, maxSize: number, maxMessageSize: number): TSerializedApiCall;
+declare const openChannel: (api: ApiPromise, origin: TNode, destination: TNode, maxSize: number, maxMessageSize: number) => Extrinsic;
+declare const openChannelSerializedApiCall: (api: ApiPromise, origin: TNode, destination: TNode, maxSize: number, maxMessageSize: number) => TSerializedApiCall;
 
 declare const index$2_openChannel: typeof openChannel;
 declare const index$2_openChannelSerializedApiCall: typeof openChannelSerializedApiCall;
@@ -141,8 +177,8 @@ declare namespace index$2 {
   export { index$2_openChannel as openChannel, index$2_openChannelSerializedApiCall as openChannelSerializedApiCall };
 }
 
-declare function closeChannel(api: ApiPromise, origin: TNode, inbound: number, outbound: number): Extrinsic;
-declare function closeChannelSerializedApiCall(api: ApiPromise, origin: TNode, inbound: number, outbound: number): TSerializedApiCall;
+declare const closeChannel: (api: ApiPromise, origin: TNode, inbound: number, outbound: number) => Extrinsic;
+declare const closeChannelSerializedApiCall: (api: ApiPromise, origin: TNode, inbound: number, outbound: number) => TSerializedApiCall;
 
 declare const index$1_closeChannel: typeof closeChannel;
 declare const index$1_closeChannelSerializedApiCall: typeof closeChannelSerializedApiCall;
@@ -175,6 +211,9 @@ 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 };
 }
 
+declare const getDefaultPallet: (node: TNode) => TPallet;
+declare const getSupportedPallets: (node: TNode) => TPallet[];
+
 interface FinalAddLiquidityBuilder {
     build: () => Extrinsic;
 }
@@ -273,25 +312,25 @@ interface AssetInSellBuilder {
 }
 
 declare class ToGeneralBuilder {
-    private readonly api;
+    private readonly api?;
     private readonly from;
     private readonly to;
     private readonly paraIdTo?;
-    constructor(api: ApiPromise, from: TNode, to: TNode, paraIdTo?: number);
+    constructor(api: ApiPromise | undefined, from: TNode, to: TNode, paraIdTo?: number);
     currency(currency: string | number | bigint): AmountBuilder;
     openChannel(): MaxSizeOpenChannelBuilder;
 }
 declare class FromGeneralBuilder {
-    private readonly api;
+    private readonly api?;
     private readonly from;
-    constructor(api: ApiPromise, from: TNode);
+    constructor(api: ApiPromise | undefined, from: TNode);
     to(node: TNode, paraIdTo?: number): ToGeneralBuilder;
     amount(amount: string | number | bigint): AddressBuilder;
     closeChannel(): InboundCloseChannelBuilder;
 }
 declare class GeneralBuilder {
-    private readonly api;
-    constructor(api: ApiPromise);
+    private readonly api?;
+    constructor(api?: ApiPromise);
     from(node: TNode): FromGeneralBuilder;
     to(node: TNode, paraIdTo?: number): AmountBuilder;
     addLiquidity(): AssetAAddLiquidityBuilder;
@@ -300,21 +339,23 @@ declare class GeneralBuilder {
     sell(): AssetInSellBuilder;
     createPool(): AssetACreatePoolBuilder;
 }
-declare const Builder: (api: ApiPromise) => GeneralBuilder;
+declare const Builder: (api?: ApiPromise) => GeneralBuilder;
 interface FinalBuilder {
     build: () => Extrinsic | never;
     buildSerializedApiCall: () => TSerializedApiCall;
 }
+interface UseKeepAliveFinalBuilder {
+    useKeepAlive: (destApi: ApiPromise) => UseKeepAliveFinalBuilder;
+    build: () => Promise<Extrinsic | never>;
+    buildSerializedApiCall: () => Promise<TSerializedApiCall>;
+}
 interface AddressBuilder {
-    address: (address: string) => FinalBuilder;
+    address: (address: string) => UseKeepAliveFinalBuilder;
 }
 interface AmountBuilder {
     amount: (amount: string | number | bigint) => AddressBuilder;
 }
 
-declare const getDefaultPallet: (node: TNode) => TPallet;
-declare const getSupportedPallets: (node: TNode) => TPallet[];
-
 declare const getNode: (node: TNode) => ParachainNode;
 declare const getNodeEndpointOption: (node: TNode) => any;
 declare const getAllNodeProviders: (node: TNode) => string[];
@@ -341,4 +382,6 @@ declare class IncompatibleNodesError extends Error {
     constructor();
 }
 
-export { type Bool, Builder, type Extrinsic, type ExtrinsicFunction, type IPolkadotXCMTransfer, type IXTokensTransfer, IncompatibleNodesError, InvalidCurrencyError, NODES_WITH_RELAY_CHAINS, NODE_NAMES, NoXCMSupportImplementedError, NodeNotSupportedError, Parents, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAssetDetails, type TAssetJsonMap, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeWithRelayChains, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TScenario, type TSerializedApiCall, type TTransferRelayToParaOptions, type UpdateFunction, Version, type XTokensTransferInput, index as assets, index$1 as closeChannels, createApiInstanceForNode, getAllAssetsSymbols, getAllNodeProviders, getAssetDecimals, getAssetId, getAssetsObject, getDefaultPallet, getNativeAssets, getNode, getNodeEndpointOption, getNodeProvider, getOtherAssets, getParaId, getRelayChainSymbol, getSupportedPallets, getTNode, hasSupportForAsset, index$2 as openChannels, index$4 as xcmPallet, index$3 as xyk };
+declare const getExistentialDeposit: (node: TNodeWithRelayChains) => string | null;
+
+export { type Bool, Builder, type CheckKeepAliveOptions, type Extrinsic, type ExtrinsicFunction, type IPolkadotXCMTransfer, type IXTokensTransfer, type IXTransferTransfer, IncompatibleNodesError, InvalidCurrencyError, NODES_WITH_RELAY_CHAINS, NODE_NAMES, NoXCMSupportImplementedError, NodeNotSupportedError, Parents, type PolkadotXCMHeader, type PolkadotXCMTransferInput, SUPPORTED_PALLETS, ScenarioNotSupportedError, type TAssetDetails, type TAssetJsonMap, type TEdJsonMap, type TNativeAssetDetails, type TNode, type TNodeAssets, type TNodeWithRelayChains, type TPallet, type TPalletJsonMap, type TPalletMap, type TRelayChainSymbol, type TRelayChainType, type TScenario, type TSerializedApiCall, type TTransferRelayToParaOptions, type UpdateFunction, 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$4 as xcmPallet, index$3 as xyk };