@paraspell/swap 12.8.6 → 12.8.8

package/dist/index.d.ts

@@ -8,8 +8,8 @@ type TRouterBuilderOptions = Omit<TBuilderConfig<TUrl>, 'xcmFormatCheck'>;
 
 type TSwapOptions = {
     papiApi: TPapiApi;
-    assetFrom: TRouterAsset;
-    assetTo: TRouterAsset;
+    assetFrom: TAssetInfo;
+    assetTo: TAssetInfo;
     amount: bigint;
     slippagePct: string;
     senderAddress: string;
@@ -20,8 +20,8 @@ type TSwapOptions = {
 type TGetAmountOutOptions = {
     papiApi: TPapiApi;
     origin?: TOriginInfo;
-    assetFrom: TRouterAsset;
-    assetTo: TRouterAsset;
+    assetFrom: TAssetInfo;
+    assetTo: TAssetInfo;
     amount: bigint;
     slippagePct?: string;
 };
@@ -145,8 +145,8 @@ type TExchangeInfo = {
     apiPapi: TPapiApi;
     baseChain: TParachain;
     exchangeChain: TExchangeChain;
-    assetFrom: TRouterAsset;
-    assetTo: TRouterAsset;
+    assetFrom: TAssetInfo;
+    assetTo: TAssetInfo;
     feeAssetInfo?: TAssetInfo;
 };
 type TDestinationInfo = {
@@ -161,21 +161,18 @@ type TAdditionalTransferOptions = {
     feeCalcAddress: string;
     builderOptions?: TRouterBuilderOptions;
 };
-type TRouterAsset = {
-    symbol: string;
-    decimals: number;
-    assetId?: string;
-    location: TLocation;
-    alias?: string;
-};
-type TPairKey = string | object;
-type TPairs = TPairKey[][];
-type TDexConfig = {
-    assets: TRouterAsset[];
+type TPairs = TLocation[][];
+type TDexConfigBase = {
     isOmni: boolean;
     pairs: TPairs;
 };
-type TAssetsRecord = Record<TExchangeChain, TDexConfig>;
+type TDexConfig = {
+    assets: TAssetInfo[];
+} & TDexConfigBase;
+type TDexConfigStored = {
+    assets: TLocation[];
+} & TDexConfigBase;
+type TAssetsRecord = Record<TExchangeChain, TDexConfigStored>;
 /** @deprecated Will be removed in v13 */
 type TTransactionType = 'TRANSFER' | 'SWAP' | 'SWAP_AND_TRANSFER';
 type TBaseTransaction = {
@@ -243,9 +240,9 @@ type TRouterXcmFeeDetail = TXcmFeeDetail;
 type TRouterXcmFeeResult = TGetXcmFeeResult;
 
 declare const getExchangeConfig: (exchange: TExchangeChain) => TDexConfig;
-declare const getExchangeAssets: (exchange: TExchangeChain) => TRouterAsset[];
+declare const getExchangeAssets: (exchange: TExchangeChain) => TAssetInfo[];
 
-declare const getExchangePairs: (exchange: TExchangeInput) => [TRouterAsset, TRouterAsset][];
+declare const getExchangePairs: (exchange: TExchangeInput) => [TAssetInfo, TAssetInfo][];
 
 /**
  * Retrieves the list of assets supported for transfer from the origin chain to the exchange chain.
@@ -264,7 +261,7 @@ declare const getSupportedAssetsFrom: (from: TChain | undefined, exchange: TExch
  * @param to - The destination chain.
  * @returns An array of supported assets.
  */
-declare const getSupportedAssetsTo: (exchange: TExchangeInput, to: TChain | undefined) => TRouterAsset[];
+declare const getSupportedAssetsTo: (exchange: TExchangeInput, to: TChain | undefined) => TAssetInfo[];
 
 /**
  * Retrieves the list of assets that can be used to pay for fees on the origin chain.
@@ -475,7 +472,7 @@ declare abstract class ExchangeChain {
     abstract swapCurrency(api: ApiPromise, options: TSwapOptions, toDestTransactionFee: bigint): Promise<TSingleSwapResult>;
     handleMultiSwap(api: ApiPromise, options: TSwapOptions, toDestTransactionFee: bigint): Promise<TMultiSwapResult>;
     abstract getAmountOut(api: ApiPromise, options: TGetAmountOutOptions): Promise<bigint>;
-    abstract getDexConfig(api: ApiPromise): Promise<TDexConfig>;
+    abstract getDexConfig(api: ApiPromise): Promise<TDexConfigStored>;
     createApiInstance(builderOptions?: TBuilderOptions<TPjsApiOrUrl>): Promise<ApiPromise>;
     createApiInstancePapi(builderOptions?: TBuilderOptions<TPapiApiOrUrl>): Promise<TPapiApi>;
 }
@@ -516,4 +513,4 @@ declare const buildTransactions: (dex: ExchangeChain, options: TTransformedOptio
 declare const transfer: (initialOptions: TTransferOptions, builderOptions?: TRouterBuilderOptions) => Promise<void>;
 
 export { DEST_FEE_BUFFER_PCT, FALLBACK_FEE_CALC_ADDRESS, FALLBACK_FEE_CALC_EVM_ADDRESS, FEE_BUFFER_PCT, RouterBuilder, RouterBuilderCore, buildApiTransactions, buildTransactions, createExchangeInstance, getExchangeAssets, getExchangeConfig, getExchangePairs, getSupportedAssetsFrom, getSupportedAssetsTo, getSupportedFeeAssets, transfer };
-export type { TAdditionalTransferOptions, TAssetsRecord, TBuildFromExchangeTxOptions, TBuildToExchangeTxOptions, TBuildTransactionsOptions, TCommonRouterOptions, TDestinationInfo, TDexConfig, TExchangeInfo, TExecuteRouterPlanOptions, TExtrinsic, TGetAmountOutOptions, TGetBestAmountOutOptions, TGetBestAmountOutResult, TMultiSwapResult, TOriginInfo, TPairKey, TPairs, TPreparedExtrinsics, TRouterAsset, TRouterBuilderOptions, TRouterDryRunChainResult, TRouterDryRunHopInfo, TRouterDryRunResult, TRouterEvent, TRouterEventType, TRouterPlan, TRouterXcmFeeDetail, TRouterXcmFeeHopInfo, TRouterXcmFeeResult, TSingleSwapResult, TStatusChangeCallback, TSwapAndTransferTransaction, TSwapOptions, TSwapTransaction, TTransaction, TTransactionType, TTransferOptions, TTransformedOptions };
+export type { TAdditionalTransferOptions, TAssetsRecord, TBuildFromExchangeTxOptions, TBuildToExchangeTxOptions, TBuildTransactionsOptions, TCommonRouterOptions, TDestinationInfo, TDexConfig, TDexConfigBase, TDexConfigStored, TExchangeInfo, TExecuteRouterPlanOptions, TExtrinsic, TGetAmountOutOptions, TGetBestAmountOutOptions, TGetBestAmountOutResult, TMultiSwapResult, TOriginInfo, TPairs, TPreparedExtrinsics, TRouterBuilderOptions, TRouterDryRunChainResult, TRouterDryRunHopInfo, TRouterDryRunResult, TRouterEvent, TRouterEventType, TRouterPlan, TRouterXcmFeeDetail, TRouterXcmFeeHopInfo, TRouterXcmFeeResult, TSingleSwapResult, TStatusChangeCallback, TSwapAndTransferTransaction, TSwapOptions, TSwapTransaction, TTransaction, TTransactionType, TTransferOptions, TTransformedOptions };