@paraspell/sdk 4.1.0 → 5.0.0

package/dist/index.d.ts

@@ -13,16 +13,16 @@ declare abstract class ParachainNode {
     get node(): TNode;
     get version(): Version;
     get assetCheckEnabled(): boolean;
-    transfer(api: ApiPromise, currencySymbol: string | undefined, currencyId: string | undefined, amount: string, to: string, destination?: TNode, paraIdTo?: number, serializedApiCallEnabled?: boolean): Extrinsic | TSerializedApiCall;
-    transferRelayToPara(options: TTransferRelayToParaOptions): TSerializedApiCall;
+    transfer(options: TSendInternalOptions): Extrinsic | TSerializedApiCall;
+    transferRelayToPara(options: TRelayToParaInternalOptions): TSerializedApiCall;
     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", "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", "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", "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", "Equilibrium", "Unique", "Crust", "Manta", "Genshiro", "Nodle", "OriginTrail", "Pendulum", "Polkadex", "Zeitgeist", "Collectives", "Khala", "Phala", "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"];
+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", "Polkadot", "Kusama"];
 declare const SUPPORTED_PALLETS: readonly ["XTokens", "OrmlXTokens", "PolkadotXcm", "RelayerXcm", "XTransfer"];
 
 type UpdateFunction = (name: string, index: number) => string;
@@ -51,7 +51,6 @@ interface TNodeAssets {
 }
 type TAssetJsonMap = Record<TNode, TNodeAssets>;
 type TScenario = 'ParaToRelay' | 'ParaToPara' | 'RelayToPara';
-type Bool = 'Yes' | 'No';
 type TPallet = (typeof SUPPORTED_PALLETS)[number];
 interface TPalletMap {
     defaultPallet: TPallet;
@@ -103,14 +102,65 @@ interface PolkadotXCMTransferInput {
     currencySymbol: string | undefined;
     serializedApiCallEnabled?: boolean;
 }
-interface TTransferRelayToParaOptions {
+type TAmount = string | number | bigint;
+interface TSendBaseOptions {
+    address: string;
+    destination?: TNode;
+    paraIdTo?: number;
+    destApiForKeepAlive?: ApiPromise;
+}
+interface TSendOptions extends TSendBaseOptions {
+    api?: ApiPromise;
+    origin: TNode;
+    currency: string | number | bigint;
+    amount: TAmount;
+}
+interface TSendOptionsCommon extends TSendOptions {
+    serializedApiCallEnabled?: boolean;
+}
+interface TSendInternalOptions extends TSendBaseOptions {
     api: ApiPromise;
+    currencySymbol: string | undefined;
+    currencyId: string | undefined;
+    amount: string;
+    serializedApiCallEnabled?: boolean;
+}
+interface TRelayToParaBaseOptions {
     destination: TNode;
     address: string;
-    amount: string;
     paraIdTo?: number;
     destApiForKeepAlive?: ApiPromise;
 }
+interface TRelayToParaOptions extends TRelayToParaBaseOptions {
+    api?: ApiPromise;
+    amount: TAmount;
+}
+interface TRelayToParaInternalOptions extends TRelayToParaBaseOptions {
+    api: ApiPromise;
+    amount: string;
+}
+interface TRelayToParaCommonOptions extends TRelayToParaOptions {
+    serializedApiCallEnabled?: boolean;
+}
+interface TOpenChannelOptions {
+    api: ApiPromise;
+    origin: TNode;
+    destination: TNode;
+    maxSize: number;
+    maxMessageSize: number;
+}
+interface TOpenChannelInternalOptions extends TOpenChannelOptions {
+    serializedApiCallEnabled?: boolean;
+}
+interface TCloseChannelOptions {
+    api: ApiPromise;
+    origin: TNode;
+    inbound: number;
+    outbound: number;
+}
+interface TCloseChannelInternalOptions extends TCloseChannelOptions {
+    serializedApiCallEnabled?: boolean;
+}
 interface IPolkadotXCMTransfer {
     transferPolkadotXCM: (input: PolkadotXCMTransferInput) => Extrinsic | TSerializedApiCall;
 }
@@ -138,38 +188,23 @@ interface CheckKeepAliveOptions {
     destNode?: TNode;
 }
 
-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;
-declare const index$4_transferRelayToPara: typeof transferRelayToPara;
-declare const index$4_transferRelayToParaCommon: typeof transferRelayToParaCommon;
-declare const index$4_transferRelayToParaSerializedApiCall: typeof transferRelayToParaSerializedApiCall;
-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 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 transferRelayToParaSerializedApiCall: (options: TRelayToParaOptions) => Promise<TSerializedApiCall>;
 
-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;
-declare const index$3_createPool: typeof createPool;
-declare const index$3_removeLiquidity: typeof removeLiquidity;
-declare const index$3_sell: typeof sell;
+declare const index$3_send: typeof send;
+declare const index$3_sendSerializedApiCall: typeof sendSerializedApiCall;
+declare const index$3_transferRelayToPara: typeof transferRelayToPara;
+declare const index$3_transferRelayToParaCommon: typeof transferRelayToParaCommon;
+declare const index$3_transferRelayToParaSerializedApiCall: typeof transferRelayToParaSerializedApiCall;
 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 };
+  export { index$3_send as send, index$3_sendSerializedApiCall as sendSerializedApiCall, index$3_transferRelayToPara as transferRelayToPara, index$3_transferRelayToParaCommon as transferRelayToParaCommon, index$3_transferRelayToParaSerializedApiCall as transferRelayToParaSerializedApiCall };
 }
 
-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 openChannel: (options: TOpenChannelOptions) => Extrinsic;
+declare const openChannelSerializedApiCall: (options: TOpenChannelOptions) => TSerializedApiCall;
 
 declare const index$2_openChannel: typeof openChannel;
 declare const index$2_openChannelSerializedApiCall: typeof openChannelSerializedApiCall;
@@ -177,8 +212,8 @@ declare namespace index$2 {
   export { index$2_openChannel as openChannel, index$2_openChannelSerializedApiCall as openChannelSerializedApiCall };
 }
 
-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 closeChannel: (options: TCloseChannelOptions) => Extrinsic;
+declare const closeChannelSerializedApiCall: (options: TCloseChannelOptions) => TSerializedApiCall;
 
 declare const index$1_closeChannel: typeof closeChannel;
 declare const index$1_closeChannelSerializedApiCall: typeof closeChannelSerializedApiCall;
@@ -214,41 +249,6 @@ declare namespace index {
 declare const getDefaultPallet: (node: TNode) => TPallet;
 declare const getSupportedPallets: (node: TNode) => TPallet[];
 
-interface FinalAddLiquidityBuilder {
-    build: () => Extrinsic;
-}
-interface AmountBMaxLimitAddLiquidityBuilder {
-    amountBMaxLimit: (amountBMaxLimit: number) => FinalAddLiquidityBuilder;
-}
-interface AmountAAddLiquidityBuilder {
-    amountA: (amountA: number) => AmountBMaxLimitAddLiquidityBuilder;
-}
-interface AssetBAddLiquidityBuilder {
-    assetB: (assetB: number) => AmountAAddLiquidityBuilder;
-}
-interface AssetAAddLiquidityBuilder {
-    assetA: (assetA: number) => AssetBAddLiquidityBuilder;
-}
-
-interface FinalBuyBuilder {
-    build: () => Extrinsic;
-}
-interface DiscountBuyBuilder {
-    discount: (discount: Bool) => FinalBuyBuilder;
-}
-interface MaxLimitBuyBuilder {
-    maxLimit: (maxLimit: number) => DiscountBuyBuilder;
-}
-interface AmountBuyBuilder {
-    amount: (amount: number) => MaxLimitBuyBuilder;
-}
-interface AssetInBuyBuilder {
-    assetIn: (assetIn: number) => AmountBuyBuilder;
-}
-interface AssetOutBuyBuilder {
-    assetOut: (assetOut: number) => AssetInBuyBuilder;
-}
-
 interface OutboundCloseChannelBuilder {
     outbound: (inbound: number) => FinalBuilder;
 }
@@ -256,22 +256,6 @@ interface InboundCloseChannelBuilder {
     inbound: (inbound: number) => OutboundCloseChannelBuilder;
 }
 
-interface FinalCreatePoolBuilder {
-    build: () => Extrinsic;
-}
-interface AmountBCreatePoolBuilder {
-    amountB: (amountB: number) => FinalCreatePoolBuilder;
-}
-interface AssetBCreatePoolBuilder {
-    assetB: (assetB: number) => AmountBCreatePoolBuilder;
-}
-interface AmountACreatePoolBuilder {
-    amountA: (amountA: number) => AssetBCreatePoolBuilder;
-}
-interface AssetACreatePoolBuilder {
-    assetA: (assetA: number) => AmountACreatePoolBuilder;
-}
-
 interface MaxMessageSizeOpenChannelBuilder {
     maxMessageSize: (size: number) => FinalBuilder;
 }
@@ -279,38 +263,6 @@ interface MaxSizeOpenChannelBuilder {
     maxSize: (size: number) => MaxMessageSizeOpenChannelBuilder;
 }
 
-interface FinalRemoveLiquidityBuilder {
-    build: () => Extrinsic;
-}
-interface LiquidityAmountRemoveLiquidityBuilder {
-    liquidityAmount: (liquidityAmount: number) => FinalRemoveLiquidityBuilder;
-}
-interface AssetBRemoveLiquidityBuilder {
-    assetB: (assetB: number) => LiquidityAmountRemoveLiquidityBuilder;
-}
-interface AssetARemoveLiquidityBuilder {
-    assetA: (assetA: number) => AssetBRemoveLiquidityBuilder;
-}
-
-interface FinalSellBuilder {
-    build: () => Extrinsic;
-}
-interface DiscountSellBuilder {
-    discount: (discount: Bool) => FinalSellBuilder;
-}
-interface MaxLimitSellBuilder {
-    maxLimit: (maxLimit: number) => DiscountSellBuilder;
-}
-interface AmountSellBuilder {
-    amount: (amount: number) => MaxLimitSellBuilder;
-}
-interface AssetOutSellBuilder {
-    assetOut: (assetOut: number) => AmountSellBuilder;
-}
-interface AssetInSellBuilder {
-    assetIn: (assetIn: number) => AssetOutSellBuilder;
-}
-
 declare class ToGeneralBuilder {
     private readonly api?;
     private readonly from;
@@ -333,11 +285,6 @@ declare class GeneralBuilder {
     constructor(api?: ApiPromise);
     from(node: TNode): FromGeneralBuilder;
     to(node: TNode, paraIdTo?: number): AmountBuilder;
-    addLiquidity(): AssetAAddLiquidityBuilder;
-    removeLiquidity(): AssetARemoveLiquidityBuilder;
-    buy(): AssetOutBuyBuilder;
-    sell(): AssetInSellBuilder;
-    createPool(): AssetACreatePoolBuilder;
 }
 declare const Builder: (api?: ApiPromise) => GeneralBuilder;
 interface FinalBuilder {
@@ -384,4 +331,4 @@ declare class IncompatibleNodesError extends Error {
 
 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 };
+export { 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 TAmount, type TAssetDetails, type TAssetJsonMap, type TCloseChannelInternalOptions, type TCloseChannelOptions, type TEdJsonMap, type TNativeAssetDetails, type TNode, type TNodeAssets, 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 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$3 as xcmPallet };