@paraspell/swap 13.2.1 → 13.3.0

package/README.md

@@ -14,7 +14,7 @@
       <img alt="build" src="https://github.com/paraspell/xcm-tools/actions/workflows/ci.yml/badge.svg" />
     </a>
   </p>
-  <p>How to swap <a href = "https://paraspell.github.io/docs/sdk/xcmPallet.html#swap" \>[here]</p>
+  <p>How to swap <a href = "https://paraspell.github.io/docs/xcm-sdk/send-xcm.html#swap" \>[here]</p>
     <p>XCM SDK starter template project <a href = "https://github.com/paraspell/xcm-sdk-template" \>[here]</p>
 </div>
 
@@ -23,7 +23,7 @@
 
 # Installation
 
-Please reffer to [SDK documentation](https://paraspell.github.io/docs/sdk/getting-started.html#install-swap-extension) 
+Please reffer to [SDK documentation](https://paraspell.github.io/docs/xcm-sdk/getting-started.html#install-swap-extension) 
 
 ## 💻 Testing
 
@@ -38,7 +38,7 @@ Please reffer to [SDK documentation](https://paraspell.github.io/docs/sdk/gettin
 
 ## Contribute to XCM Tools and earn rewards 💰
 
-We run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution.html).
+We run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution-guidelines.html).
 
 ## Get Support 🚑
 

package/dist/index.d.ts

@@ -1,9 +1,11 @@
-import { TSubstrateChain, TExchangeInput, TChain, TCurrencyInput, TAmount, TStatusChangeCallback, TExchangeChain, TAssetInfo, PolkadotApi, TLocation, WithApi, TGetXcmFeeBuilderOptions, TGetXcmFeeResult, TDryRunResult } from '@paraspell/sdk-core';
-import { TPapiApi, TPapiTransaction } from '@paraspell/sdk';
+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 { ApiPromise } from '@polkadot/api';
 
-type TSwapOptions<TApi> = {
-    papiApi: TPapiApi;
+type TSwapOptions<TApi, TRes, TSigner> = {
+    apiPjs: ApiPromise;
+    api: PolkadotApi<TApi, TRes, TSigner>;
     assetFrom: TAssetInfo;
     assetTo: TAssetInfo;
     amount: bigint;
@@ -13,21 +15,22 @@ type TSwapOptions<TApi> = {
     origin?: TOriginInfo<TApi>;
     isForFeeEstimation?: boolean;
 };
-type TGetAmountOutOptions<TApi> = {
-    papiApi: TPapiApi;
+type TGetAmountOutOptions<TApi, TRes, TSigner> = {
+    apiPjs: ApiPromise;
+    api: PolkadotApi<TApi, TRes, TSigner>;
     origin?: TOriginInfo<TApi>;
     assetFrom: TAssetInfo;
     assetTo: TAssetInfo;
     amount: bigint;
     slippagePct?: string;
 };
-type TExtrinsic = Extrinsic | TPapiTransaction;
-type TSingleSwapResult = {
-    tx: TExtrinsic;
+type TExtrinsic<TRes> = Extrinsic | TRes;
+type TSingleSwapResult<TRes> = {
+    tx: TExtrinsic<TRes>;
     amountOut: bigint;
 };
-type TMultiSwapResult = {
-    txs: TExtrinsic[];
+type TMultiSwapResult<TRes> = {
+    txs: TExtrinsic<TRes>[];
     amountOut: bigint;
 };
 /**
@@ -225,167 +228,71 @@ declare const getSupportedAssetsTo: (exchangeInput: TExchangeInput, to: TChain |
  */
 declare const getSupportedFeeAssets: (from: TChain | undefined, exchangeInput: TExchangeInput) => TAssetInfo[];
 
-declare class RouterBuilderCore<TApi, TRes, TSigner, T extends Partial<TTransferBaseOptions<TApi, TRes, TSigner>> = object> {
+declare class SwapBuilderCore<TApi, TRes, TSigner, T extends Partial<TTransferBaseOptions<TApi, TRes, TSigner>> = object> {
     readonly _api: PolkadotApi<TApi, TRes, TSigner>;
     readonly _options: T;
-    readonly _builderOptions?: TTransferBaseOptions<TApi, TRes, TSigner>;
     constructor(api: PolkadotApi<TApi, TRes, TSigner>, options?: T);
-    /**
-     * Specifies the origin chain of the transfer.
-     *
-     * @param chain - The origin chain.
-     * @returns The current builder instance.
-     */
-    from(chain: TSubstrateChain | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    from(chain: TSubstrateChain | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         from: TSubstrateChain | undefined;
     }>;
-    /**
-     * Specifies the exchange chain to use.
-     *
-     * @param chain - The exchange chain, or `undefined` to auto-select.
-     * @returns The current builder instance.
-     */
-    exchange(chain: TExchangeInput): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    exchange(chain: TExchangeInput): SwapBuilderCore<TApi, TRes, TSigner, T & {
         exchange: TExchangeInput;
     }>;
-    /**
-     * Specifies the destination chain of the transfer.
-     *
-     * @param chain - The destination chain.
-     * @returns The current builder instance.
-     */
-    to(chain: TChain | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    to(chain: TChain | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         to: TChain | undefined;
     }>;
-    /**
-     * Specifies the currency to send from the origin chain.
-     *
-     * @param currencyFrom - The currency to send.
-     * @returns The current builder instance.
-     */
-    currencyFrom(currency: TCurrencyInput): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    currencyFrom(currency: TCurrencyInput): SwapBuilderCore<TApi, TRes, TSigner, T & {
         currencyFrom: TCurrencyInput;
     }>;
-    /**
-     * Specifies the currency that the origin currency will be exchanged to and received on the destination chain.
-     *
-     * @param currencyTo - The currency to receive.
-     * @returns The current builder instance.
-     */
-    currencyTo(currency: TCurrencyInput): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    currencyTo(currency: TCurrencyInput): SwapBuilderCore<TApi, TRes, TSigner, T & {
         currencyTo: TCurrencyInput;
     }>;
-    /**
-     * Specifies the asset used to pay XCM fees.
-     *
-     * @param currency - The fee asset currency, or `undefined` to use the default.
-     * @returns The current builder instance.
-     */
-    feeAsset(currency: TCurrencyInput | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    feeAsset(currency: TCurrencyInput | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         feeAsset: TCurrencyInput | undefined;
     }>;
-    /**
-     * Specifies the amount to transfer.
-     *
-     * @param amount - The amount to transfer.
-     * @returns The current builder instance.
-     */
-    amount(amount: TAmount): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    amount(amount: TAmount): SwapBuilderCore<TApi, TRes, TSigner, T & {
         amount: TAmount;
     }>;
-    /**
-     * Specifies the recipient address on the destination chain.
-     *
-     * @param recipient - The recipient address.
-     * @returns The current builder instance.
-     */
-    recipient(address: string | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    recipient(address: string | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         recipient: string | undefined;
     }>;
-    /**
-     * Specifies the sender address initiating the transfer.
-     *
-     * @param senderAddress - The sender address.
-     * @returns The current builder instance.
-     */
-    sender(address: string): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    sender(address: string): SwapBuilderCore<TApi, TRes, TSigner, T & {
         sender: string;
     }>;
-    /**
-     * Specifies the signer for the transaction.
-     *
-     * @param signer - The signer instance.
-     * @returns The current builder instance.
-     */
-    signer(signer: TSigner): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    signer(signer: TSigner): SwapBuilderCore<TApi, TRes, TSigner, T & {
         signer: TSigner;
     }>;
-    /**
-     * Specifies the EVM sender address, required if `evmSigner` is provided. Used when dealing with EVM chains.
-     *
-     * @param evmSenderAddress - The EVM sender address.
-     * @returns The current builder instance.
-     */
-    evmSenderAddress(address: string | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    evmSenderAddress(address: string | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         evmSenderAddress: string | undefined;
     }>;
-    /**
-     * Specifies the EVM signer, required if `evmSenderAddress` is provided.
-     *
-     * @param evmSigner - The EVM signer.
-     * @returns The current builder instance.
-     */
-    evmSigner(signer: TSigner | undefined): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    evmSigner(signer: TSigner | undefined): SwapBuilderCore<TApi, TRes, TSigner, T & {
         evmSigner: TSigner | undefined;
     }>;
-    /**
-     * Specifies the maximum slippage percentage for swaps.
-     *
-     * @param slippagePct - The slippage percentage.
-     * @returns The current builder instance.
-     */
-    slippagePct(pct: string): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    slippagePct(pct: string): SwapBuilderCore<TApi, TRes, TSigner, T & {
         slippagePct: string;
     }>;
-    /**
-     * Sets a callback to receive status updates during the transfer.
-     *
-     * @param callback - The status change callback.
-     * @returns The current builder instance.
-     */
-    onStatusChange(callback: TStatusChangeCallback<TApi, TRes>): RouterBuilderCore<TApi, TRes, TSigner, T & {
+    onStatusChange(callback: TStatusChangeCallback<TApi, TRes>): SwapBuilderCore<TApi, TRes, TSigner, T & {
         onStatusChange: TStatusChangeCallback<TApi, TRes>;
     }>;
-    /**
-     * Returns the XCM fee for origin, exchange, and destination.
-     *
-     * @returns The XCM fee result.
-     */
-    getXcmFees<TDisableFallback extends boolean = false>(this: RouterBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>, options?: TGetXcmFeeBuilderOptions & {
+    getXcmFees<TDisableFallback extends boolean = false>(this: SwapBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>, options?: TGetXcmFeeBuilderOptions & {
         disableFallback: TDisableFallback;
     }): Promise<TGetXcmFeeResult<TDisableFallback>>;
-    getTransferableAmount(this: RouterBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<bigint>;
-    getMinTransferableAmount(this: RouterBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<bigint>;
-    /**
-     * Executes the transfer with the provided parameters.
-     *
-     * @returns An array of finalized transaction hashes (hex) in execution order.
-     * @throws Error if required parameters are missing.
-     */
-    signAndSubmit(this: RouterBuilderCore<TApi, TRes, TSigner, TTransferBaseOptions<TApi, TRes, TSigner>>): Promise<string[]>;
-    /**
-     * Builds the transactions for the transfer with the provided parameters.
-     */
-    build(this: RouterBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<TRouterPlan<TApi, TRes>>;
-    dryRun(this: RouterBuilderCore<TApi, TRes, TSigner, TBuildTransactionsBaseOptions<TApi, TRes, TSigner>>): Promise<TDryRunResult>;
-    getBestAmountOut(this: RouterBuilderCore<TApi, TRes, TSigner, TGetBestAmountOutBaseOptions<TApi, TRes, TSigner>>): Promise<TGetBestAmountOutResult>;
+    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>;
+    getBestAmountOut(this: SwapBuilderCore<TApi, TRes, TSigner, TGetBestAmountOutBaseOptions<TApi, TRes, TSigner>>): Promise<{
+        exchange: TExchangeChain;
+        amountOut: bigint;
+    }>;
 }
-declare const RouterBuilder: <TApi, TRes, TSigner>(api: PolkadotApi<TApi, TRes, TSigner>) => RouterBuilderCore<TApi, TRes, TSigner, object>;
+declare const SwapBuilder: <TApi, TRes, TSigner>(api: PolkadotApi<TApi, TRes, TSigner>) => TSwapBuilder<TApi, TRes, TSigner>;
 
 declare const FEE_BUFFER_PCT = 10;
 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, RouterBuilder, RouterBuilderCore, getExchangeAssets, getExchangeConfig, getExchangePairs, getSupportedAssetsFrom, getSupportedAssetsTo, getSupportedFeeAssets };
+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 };