@paraspell/swap 13.4.1 → 13.6.0

package/dist/index.d.ts

@@ -1,10 +1,23 @@
-import { TSubstrateChain, TExchangeInput, TChain, TCurrencyInput, TAmount, TStatusChangeCallback, TAssetInfo, PolkadotApi, TExchangeChain, TLocation, WithApi, TSwapBuilder, TGetXcmFeeBuilderOptions, TGetXcmFeeResult, TTransactionContext, TDryRunResult } from '@paraspell/sdk-core';
-import { TPapiApi } from '@paraspell/sdk';
-import { TPjsApi, Extrinsic } from '@paraspell/sdk-pjs';
+import { TSubstrateChain, TExchangeInput, TChain, TCurrencyInput, TAmount, TStatusChangeCallback, TAssetInfo, PolkadotApi, TExchangeChain, TLocation, WithApi, TCustomCtx, TSwapBuilder, TGetXcmFeeBuilderOptions, TGetXcmFeeResult, TXcmFeeDetailWithForwardedXcm, TTransferInfo, TTransactionContext, TDryRunResult, TDryRunPreviewOptions } from '@paraspell/sdk-core';
+import { TPapiApi, TPapiTransaction } from '@paraspell/sdk';
+import { Extrinsic } from '@paraspell/sdk-pjs';
 import { ApiPromise } from '@polkadot/api';
 
-type TSwapOptions<TApi, TRes, TSigner> = {
+type TExchangeApiType = 'PJS' | 'PAPI' | 'GENERIC';
+type TExchangeApiVariant = {
+    apiType: 'PJS';
     apiPjs: ApiPromise;
+} | {
+    apiType: 'PAPI';
+    apiPapi: TPapiApi;
+} | {
+    apiType: 'GENERIC';
+};
+type TGetDexConfigApi<TApiType extends TExchangeApiType> = TApiType extends 'PJS' ? ApiPromise : TPapiApi;
+type WithApiVariant<TBase, TApiType extends TExchangeApiType = TExchangeApiType> = TBase & Extract<TExchangeApiVariant, {
+    apiType: TApiType;
+}>;
+type TSwapOptionsCommon<TApi, TRes, TSigner> = {
     api: PolkadotApi<TApi, TRes, TSigner>;
     assetFrom: TAssetInfo;
     assetTo: TAssetInfo;
@@ -15,8 +28,12 @@ type TSwapOptions<TApi, TRes, TSigner> = {
     origin?: TOriginInfo<TApi>;
     isForFeeEstimation?: boolean;
 };
-type TGetAmountOutOptions<TApi, TRes, TSigner> = {
-    apiPjs: ApiPromise;
+type TSwapOptions<TApi, TRes, TSigner> = WithApiVariant<TSwapOptionsCommon<TApi, TRes, TSigner>>;
+type TSwapOptionsFor<TApi, TRes, TSigner, TApiType extends TExchangeApiType> = WithApiVariant<TSwapOptionsCommon<TApi, TRes, TSigner>, TApiType>;
+type TPjsSwapOptions<TApi, TRes, TSigner> = TSwapOptionsFor<TApi, TRes, TSigner, 'PJS'>;
+type TPapiSwapOptions<TApi, TRes, TSigner> = TSwapOptionsFor<TApi, TRes, TSigner, 'PAPI'>;
+type TGenericSwapOptions<TApi, TRes, TSigner> = TSwapOptionsFor<TApi, TRes, TSigner, 'GENERIC'>;
+type TGetAmountOutOptionsCommon<TApi, TRes, TSigner> = {
     api: PolkadotApi<TApi, TRes, TSigner>;
     origin?: TOriginInfo<TApi>;
     assetFrom: TAssetInfo;
@@ -24,7 +41,12 @@ type TGetAmountOutOptions<TApi, TRes, TSigner> = {
     amount: bigint;
     slippagePct?: string;
 };
-type TExtrinsic<TRes> = Extrinsic | TRes;
+type TGetAmountOutOptions<TApi, TRes, TSigner> = WithApiVariant<TGetAmountOutOptionsCommon<TApi, TRes, TSigner>>;
+type TGetAmountOutOptionsFor<TApi, TRes, TSigner, TApiType extends TExchangeApiType> = WithApiVariant<TGetAmountOutOptionsCommon<TApi, TRes, TSigner>, TApiType>;
+type TPjsGetAmountOutOptions<TApi, TRes, TSigner> = TGetAmountOutOptionsFor<TApi, TRes, TSigner, 'PJS'>;
+type TPapiGetAmountOutOptions<TApi, TRes, TSigner> = TGetAmountOutOptionsFor<TApi, TRes, TSigner, 'PAPI'>;
+type TGenericGetAmountOutOptions<TApi, TRes, TSigner> = TGetAmountOutOptionsFor<TApi, TRes, TSigner, 'GENERIC'>;
+type TExtrinsic<TRes> = Extrinsic | TPapiTransaction | TRes;
 type TSingleSwapResult<TRes> = {
     tx: TExtrinsic<TRes>;
     amountOut: bigint;
@@ -112,15 +134,18 @@ type TOriginInfo<TApi> = {
     assetFrom: TAssetInfo;
     feeAssetInfo?: TAssetInfo;
 };
-type TExchangeInfo<TApi, TRes, TSigner> = {
-    apiPjs: TPjsApi;
-    apiPapi: TPapiApi;
+type TExchangeInfoCommon<TApi, TRes, TSigner> = {
     api: PolkadotApi<TApi, TRes, TSigner>;
     chain: TExchangeChain;
     assetFrom: TAssetInfo;
     assetTo: TAssetInfo;
     feeAssetInfo?: TAssetInfo;
 };
+type TExchangeInfo<TApi, TRes, TSigner> = WithApiVariant<TExchangeInfoCommon<TApi, TRes, TSigner>>;
+type TExchangeInfoFor<TApi, TRes, TSigner, TApiType extends TExchangeApiType> = WithApiVariant<TExchangeInfoCommon<TApi, TRes, TSigner>, TApiType>;
+type TPjsExchangeInfo<TApi, TRes, TSigner> = TExchangeInfoFor<TApi, TRes, TSigner, 'PJS'>;
+type TPapiExchangeInfo<TApi, TRes, TSigner> = TExchangeInfoFor<TApi, TRes, TSigner, 'PAPI'>;
+type TGenericExchangeInfo<TApi, TRes, TSigner> = TExchangeInfoFor<TApi, TRes, TSigner, 'GENERIC'>;
 type TDestinationInfo = {
     chain: TChain;
     address: string;
@@ -194,12 +219,23 @@ type TBuildFromExchangeTxOptions<TApi, TRes, TSigner> = {
     sender: string;
     api: PolkadotApi<TApi, TRes, TSigner>;
 };
+type TSwapTransformedOptions<TApi, TRes, TSigner> = TTransformedOptions<TBuildTransactionsOptions<TApi, TRes, TSigner>, TApi, TRes, TSigner>;
+type TCallDexAmountOutOverrides = {
+    amount?: bigint;
+    assetTo?: TAssetInfo;
+    slippagePct?: string;
+};
+type TBuildSwapExecuteOverrides = {
+    amount?: bigint;
+    feeEstimation?: boolean;
+};
 
 declare const getExchangeConfig: (exchange: TExchangeChain) => TDexConfig;
 declare const getExchangeAssets: (exchange: TExchangeChain) => TAssetInfo[];
 
 declare const getExchangePairs: (exchange: TExchangeInput) => [TAssetInfo, TAssetInfo][];
 
+declare const getSupportedAssetsFromImpl: <TCustomChain extends string = never>(from: TChain | TCustomChain | undefined, exchangeInput: TExchangeInput, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of assets supported for transfer from the origin chain to the exchange chain.
  *
@@ -209,6 +245,7 @@ declare const getExchangePairs: (exchange: TExchangeInput) => [TAssetInfo, TAsse
  */
 declare const getSupportedAssetsFrom: (from: TChain | undefined, exchangeInput: TExchangeInput) => TAssetInfo[];
 
+declare const getSupportedAssetsToImpl: <TCustomChain extends string = never>(exchangeInput: TExchangeInput, to: TChain | TCustomChain | undefined, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of assets supported for transfer to the destination chain.
  *
@@ -219,6 +256,7 @@ declare const getSupportedAssetsFrom: (from: TChain | undefined, exchangeInput:
  */
 declare const getSupportedAssetsTo: (exchangeInput: TExchangeInput, to: TChain | undefined) => TAssetInfo[];
 
+declare const getSupportedFeeAssetsImpl: <TCustomChain extends string = never>(from: TChain | TCustomChain | undefined, exchangeInput: TExchangeInput, ctx?: TCustomCtx) => TAssetInfo[];
 /**
  * Retrieves the list of assets that can be used to pay for fees on the origin chain.
  *
@@ -277,11 +315,16 @@ declare class SwapBuilderCore<TApi, TRes, TSigner, T extends Partial<TTransferBa
     getXcmFees<TDisableFallback extends boolean = false>(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>, options?: TGetXcmFeeBuilderOptions & {
         disableFallback: TDisableFallback;
     }): Promise<TGetXcmFeeResult<TDisableFallback>>;
+    getOriginXcmFee<TDisableFallback extends boolean = false>(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>, options?: TGetXcmFeeBuilderOptions & {
+        disableFallback: TDisableFallback;
+    }): Promise<TXcmFeeDetailWithForwardedXcm<TDisableFallback>>;
+    getSwapInfo(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<TTransferInfo>;
     getTransferableAmount(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<bigint>;
     getMinTransferableAmount(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<bigint>;
     signAndSubmit(this: SwapBuilderCore<TApi, TRes, TSigner, TTransferBaseOptions<TApi, TRes, TSigner>>): Promise<string[]>;
     build(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<TTransactionContext<TApi, TRes>[]>;
     dryRun(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<TDryRunResult>;
+    dryRunPreview(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>, previewOptions?: TDryRunPreviewOptions): Promise<TDryRunResult>;
     getBestAmountOut(this: SwapBuilderCore<TApi, TRes, TSigner, TGetBestAmountOutBaseOptions<TApi, TRes, TSigner>>): Promise<{
         exchange: TExchangeChain;
         amountOut: bigint;
@@ -294,5 +337,5 @@ declare const DEST_FEE_BUFFER_PCT = -1;
 declare const FALLBACK_FEE_CALC_ADDRESS = "5EtHZF4E8QagNCz6naobCkCAUT52SbcEqaXiDUu2PjUHxZid";
 declare const FALLBACK_FEE_CALC_EVM_ADDRESS = "0x1501C1413e4178c38567Ada8945A80351F7B8496";
 
-export { DEST_FEE_BUFFER_PCT, FALLBACK_FEE_CALC_ADDRESS, FALLBACK_FEE_CALC_EVM_ADDRESS, FEE_BUFFER_PCT, SwapBuilder, SwapBuilderCore, getExchangeAssets, getExchangeConfig, getExchangePairs, getSupportedAssetsFrom, getSupportedAssetsTo, getSupportedFeeAssets };
-export type { TAdditionalTransferOptions, TAssetsRecord, TBuildFromExchangeTxOptions, TBuildToExchangeTxOptions, TBuildTransactionsBaseOptions, TBuildTransactionsOptions, TCommonRouterOptions, TDestinationInfo, TDexConfig, TDexConfigBase, TDexConfigStored, TExchangeInfo, TExecuteRouterPlanOptions, TExtrinsic, TGetAmountOutOptions, TGetBestAmountOutBaseOptions, TGetBestAmountOutOptions, TGetBestAmountOutResult, TMultiSwapResult, TOriginInfo, TPairs, TPreparedExtrinsics, TRouterPlan, TSingleSwapResult, TSwapAndTransferTransaction, TSwapOptions, TSwapTransaction, TTransaction, TTransferBaseOptions, TTransferOptions, TTransformedOptions };
+export { DEST_FEE_BUFFER_PCT, FALLBACK_FEE_CALC_ADDRESS, FALLBACK_FEE_CALC_EVM_ADDRESS, FEE_BUFFER_PCT, SwapBuilder, SwapBuilderCore, getExchangeAssets, getExchangeConfig, getExchangePairs, getSupportedAssetsFrom, getSupportedAssetsFromImpl, getSupportedAssetsTo, getSupportedAssetsToImpl, getSupportedFeeAssets, getSupportedFeeAssetsImpl };
+export type { TAdditionalTransferOptions, TAssetsRecord, TBuildFromExchangeTxOptions, TBuildSwapExecuteOverrides, TBuildToExchangeTxOptions, TBuildTransactionsBaseOptions, TBuildTransactionsOptions, TCallDexAmountOutOverrides, TCommonRouterOptions, TDestinationInfo, TDexConfig, TDexConfigBase, TDexConfigStored, TExchangeApiType, TExchangeApiVariant, TExchangeInfo, TExchangeInfoFor, TExecuteRouterPlanOptions, TExtrinsic, TGenericExchangeInfo, TGenericGetAmountOutOptions, TGenericSwapOptions, TGetAmountOutOptions, TGetAmountOutOptionsFor, TGetBestAmountOutBaseOptions, TGetBestAmountOutOptions, TGetBestAmountOutResult, TGetDexConfigApi, TMultiSwapResult, TOriginInfo, TPairs, TPapiExchangeInfo, TPapiGetAmountOutOptions, TPapiSwapOptions, TPjsExchangeInfo, TPjsGetAmountOutOptions, TPjsSwapOptions, TPreparedExtrinsics, TRouterPlan, TSingleSwapResult, TSwapAndTransferTransaction, TSwapOptions, TSwapOptionsFor, TSwapTransaction, TSwapTransformedOptions, TTransaction, TTransferBaseOptions, TTransferOptions, TTransformedOptions };