Merge pull request #103 from tinymanorg/chore/tiny-1787-always-enable…

…-swap-router

Enable swap-router as default

dist/swap/index.d.ts

@@ -47,24 +47,22 @@ export declare const Swap: {
         }) => Promise<Omit<import("./types").V1SwapExecution, "fees" | "groupID">>;
     };
     v2: {
-        getQuote: ({ type, amount, assetIn, assetOut, network, slippage, isSwapRouterEnabled, pool }: {
+        getQuote: ({ type, amount, assetIn, assetOut, network, slippage, pool }: {
             type: import("./constants").SwapType;
             amount: number | bigint;
             assetIn: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             assetOut: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             pool: import("..").V2PoolInfo | null;
             network: import("..").SupportedNetwork;
             slippage: number;
-            isSwapRouterEnabled?: boolean | undefined;
         }) => Promise<import("./types").SwapQuote>;
-        getFixedInputSwapQuote: ({ amount, assetIn, assetOut, isSwapRouterEnabled, network, slippage, pool }: {
+        getFixedInputSwapQuote: ({ amount, assetIn, assetOut, network, slippage, pool }: {
             amount: number | bigint;
             assetIn: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             assetOut: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             network: import("..").SupportedNetwork;
             pool: import("..").V2PoolInfo | null;
             slippage: number;
-            isSwapRouterEnabled?: boolean | undefined;
         }) => Promise<import("./types").SwapQuote>;
         getFixedInputDirectSwapQuote: ({ amount, assetIn, assetOut, pool }: {
             pool: import("..").V2PoolInfo;
@@ -78,14 +76,13 @@ export declare const Swap: {
             assetIn: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             assetOut: import("../util/asset/assetModels").AssetWithIdAndDecimals;
         }) => import("./types").SwapQuote;
-        getFixedOutputSwapQuote: ({ amount, assetIn, assetOut, isSwapRouterEnabled, network, slippage, pool }: {
+        getFixedOutputSwapQuote: ({ amount, assetIn, assetOut, network, slippage, pool }: {
             amount: number | bigint;
             assetIn: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             assetOut: import("../util/asset/assetModels").AssetWithIdAndDecimals;
             pool: import("..").V2PoolInfo | null;
             network: import("..").SupportedNetwork;
             slippage: number;
-            isSwapRouterEnabled?: boolean | undefined;
         }) => Promise<import("./types").SwapQuote>;
         generateTxns: (params: import("./types").GenerateSwapTxnsParams) => Promise<import("..").SignerTransaction[]>;
         signTxns: ({ txGroup, initiatorSigner }: {

dist/swap/types.d.ts

@@ -87,8 +87,6 @@ export type GetSwapQuoteParams = {
     amount: number | bigint;
     type: SwapType;
     network: SupportedNetwork;
-    /** If `true`, the function will also check the quotes that use swap route */
-    isSwapRouterEnabled?: boolean;
     /** Slippage rate. Should be given as 0.1% -> 0.001. */
     slippage: number;
 };

dist/swap/utils.d.ts

@@ -1,8 +1,8 @@
 import { CONTRACT_VERSION } from "../contract/constants";
 import { InitiatorSigner, SignerTransaction } from "../util/commonTypes";
 import { V1PoolInfo } from "../util/pool/poolTypes";
-import { GetSwapQuoteBySwapTypeParams, GenerateSwapTxnsParams, GetSwapQuoteParams, SwapQuote, ExecuteSwapCommonParams } from "./types";
 import { SwapType } from "./constants";
+import { ExecuteSwapCommonParams, GenerateSwapTxnsParams, GetSwapQuoteBySwapTypeParams, GetSwapQuoteParams, SwapQuote } from "./types";
 /**
  * Gets the best quote for swap from the pools and swap router and returns the best option.
  */

dist/swap/v2/index.d.ts

@@ -25,18 +25,16 @@ declare function execute({ client, quote, txGroup, signedTxns }: {
  * @param assetOut - Asset to be received
  * @param amount - Amount of asset to be swapped
  * @param network - Network to be used
- * @param isSwapRouterEnabled - Whether the swap router is enabled
  * @returns A promise for the Swap quote
  */
-declare function getQuote({ type, amount, assetIn, assetOut, network, slippage, isSwapRouterEnabled, pool }: {
+declare function getQuote({ type, amount, assetIn, assetOut, network, slippage, pool }: {
     type: SwapType;
     amount: number | bigint;
     assetIn: AssetWithIdAndDecimals;
     assetOut: AssetWithIdAndDecimals;
     pool: V2PoolInfo | null;
     network: SupportedNetwork;
     slippage: number;
-    isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote>;
 declare function getFixedInputDirectSwapQuote({ amount, assetIn, assetOut, pool }: {
     pool: V2PoolInfo;
@@ -53,26 +51,24 @@ declare function getFixedOutputDirectSwapQuote({ amount, assetIn, assetOut, pool
 /**
  * @returns A quote for a fixed input swap. Does NOT execute any transactions.
  */
-declare function getFixedInputSwapQuote({ amount, assetIn, assetOut, isSwapRouterEnabled, network, slippage, pool }: {
+declare function getFixedInputSwapQuote({ amount, assetIn, assetOut, network, slippage, pool }: {
     amount: number | bigint;
     assetIn: AssetWithIdAndDecimals;
     assetOut: AssetWithIdAndDecimals;
     network: SupportedNetwork;
     pool: V2PoolInfo | null;
     slippage: number;
-    isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote>;
 /**
  * @returns A quote for a fixed output swap. Does NOT execute any transactions.
  */
-declare function getFixedOutputSwapQuote({ amount, assetIn, assetOut, isSwapRouterEnabled, network, slippage, pool }: {
+declare function getFixedOutputSwapQuote({ amount, assetIn, assetOut, network, slippage, pool }: {
     amount: number | bigint;
     assetIn: AssetWithIdAndDecimals;
     assetOut: AssetWithIdAndDecimals;
     pool: V2PoolInfo | null;
     network: SupportedNetwork;
     slippage: number;
-    isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote>;
 declare function calculateFixedInputSwap({ inputSupply, outputSupply, swapInputAmount, totalFeeShare, decimals }: {
     inputSupply: bigint;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinymanorg/tinyman-js-sdk",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "Tinyman JS SDK",
   "author": "Tinyman Core Team",
   "license": "MIT",

src/liquid-stake/tAlgoClient.test.ts

@@ -126,7 +126,7 @@ describe("TinymanTAlgoClient", () => {
 
     // Check if the account has the correct amount of tALGOs
     expect(tAlgoAccountAsset?.amount).toBeCloseTo(expectedTAlgoAmount);
-  }, 10000);
+  }, 18000);
   it("should create burn transactions", async () => {
     const spy = jest.spyOn(client, "burn");
 

src/swap/types.ts

@@ -94,8 +94,6 @@ export type GetSwapQuoteParams = {
   amount: number | bigint;
   type: SwapType;
   network: SupportedNetwork;
-  /** If `true`, the function will also check the quotes that use swap route */
-  isSwapRouterEnabled?: boolean;
   /** Slippage rate. Should be given as 0.1% -> 0.001. */
   slippage: number;
 };

src/swap/utils.ts

@@ -1,24 +1,24 @@
 import {CONTRACT_VERSION} from "../contract/constants";
+import {getAssetId} from "../util/asset/assetUtils";
 import {InitiatorSigner, SignerTransaction} from "../util/commonTypes";
+import SwapQuoteError, {SwapQuoteErrorType} from "../util/error/SwapQuoteError";
 import {V1PoolInfo} from "../util/pool/poolTypes";
 import {
-  GetSwapQuoteBySwapTypeParams,
+  getBestQuote,
+  getSwapQuoteContractVersion,
+  isSwapQuoteErrorCausedByAmount
+} from "./common/utils";
+import {SwapType} from "./constants";
+import {
+  ExecuteSwapCommonParams,
   GenerateSwapTxnsParams,
+  GetSwapQuoteBySwapTypeParams,
   GetSwapQuoteParams,
   SwapQuote,
-  SwapQuoteType,
-  ExecuteSwapCommonParams
+  SwapQuoteType
 } from "./types";
-import {SwapType} from "./constants";
 import {SwapV1_1} from "./v1_1";
 import {SwapV2} from "./v2";
-import {
-  getBestQuote,
-  getSwapQuoteContractVersion,
-  isSwapQuoteErrorCausedByAmount
-} from "./common/utils";
-import {getAssetId} from "../util/asset/assetUtils";
-import SwapQuoteError, {SwapQuoteErrorType} from "../util/error/SwapQuoteError";
 
 /**
  * Gets the best quote for swap from the pools and swap router and returns the best option.
@@ -74,7 +74,7 @@ function validateQuotes(promises: Promise<SwapQuote>[]): Promise<SwapQuote[]> {
 export async function getFixedInputSwapQuote(
   params: GetSwapQuoteBySwapTypeParams
 ): Promise<SwapQuote> {
-  const {amount, assetIn, assetOut, isSwapRouterEnabled, pools} = params;
+  const {amount, assetIn, assetOut, pools} = params;
 
   const quotePromises: Promise<SwapQuote>[] = [];
 
@@ -124,7 +124,6 @@ export async function getFixedInputSwapQuote(
         decimals: assetOut.decimals
       },
       pool: v2Pool?.info ?? null,
-      isSwapRouterEnabled,
       network: params.network,
       slippage: params.slippage
     })
@@ -142,7 +141,7 @@ export async function getFixedInputSwapQuote(
 export async function getFixedOutputSwapQuote(
   params: GetSwapQuoteBySwapTypeParams
 ): Promise<SwapQuote> {
-  const {amount, assetIn, assetOut, pools, isSwapRouterEnabled} = params;
+  const {amount, assetIn, assetOut, pools} = params;
 
   const quotePromises: Promise<SwapQuote>[] = [];
 
@@ -192,7 +191,6 @@ export async function getFixedOutputSwapQuote(
         decimals: assetOut.decimals
       },
       pool: v2Pool?.info ?? null,
-      isSwapRouterEnabled,
       network: params.network,
       slippage: params.slippage
     })

src/swap/v2/index.ts

@@ -204,7 +204,6 @@ async function execute({
  * @param assetOut - Asset to be received
  * @param amount - Amount of asset to be swapped
  * @param network - Network to be used
- * @param isSwapRouterEnabled - Whether the swap router is enabled
  * @returns A promise for the Swap quote
  */
 async function getQuote({
@@ -214,7 +213,6 @@ async function getQuote({
   assetOut,
   network,
   slippage,
-  isSwapRouterEnabled,
   pool
 }: {
   type: SwapType;
@@ -224,7 +222,6 @@ async function getQuote({
   pool: V2PoolInfo | null;
   network: SupportedNetwork;
   slippage: number;
-  isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote> {
   let quote: SwapQuote;
 
@@ -233,7 +230,6 @@ async function getQuote({
       assetIn,
       assetOut,
       amount,
-      isSwapRouterEnabled,
       network,
       pool,
       slippage
@@ -243,7 +239,6 @@ async function getQuote({
       amount,
       assetIn,
       assetOut,
-      isSwapRouterEnabled,
       network,
       pool,
       slippage
@@ -460,7 +455,6 @@ async function getFixedInputSwapQuote({
   amount,
   assetIn,
   assetOut,
-  isSwapRouterEnabled,
   network,
   slippage,
   pool
@@ -471,7 +465,6 @@ async function getFixedInputSwapQuote({
   network: SupportedNetwork;
   pool: V2PoolInfo | null;
   slippage: number;
-  isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote> {
   const quotePromises: Promise<SwapQuote>[] = [];
 
@@ -509,18 +502,16 @@ async function getFixedInputSwapQuote({
     );
   }
 
-  if (isSwapRouterEnabled) {
-    quotePromises.push(
-      getSwapRoute({
-        amount,
-        assetInID: assetIn.id,
-        assetOutID: assetOut.id,
-        swapType: SwapType.FixedInput,
-        network,
-        slippage
-      }).then((data) => ({type: SwapQuoteType.Router, data}))
-    );
-  }
+  quotePromises.push(
+    getSwapRoute({
+      amount,
+      assetInID: assetIn.id,
+      assetOutID: assetOut.id,
+      swapType: SwapType.FixedInput,
+      network,
+      slippage
+    }).then((data) => ({type: SwapQuoteType.Router, data}))
+  );
 
   const validQuotes = await validateQuotes(quotePromises);
 
@@ -534,7 +525,6 @@ async function getFixedOutputSwapQuote({
   amount,
   assetIn,
   assetOut,
-  isSwapRouterEnabled,
   network,
   slippage,
   pool
@@ -545,7 +535,6 @@ async function getFixedOutputSwapQuote({
   pool: V2PoolInfo | null;
   network: SupportedNetwork;
   slippage: number;
-  isSwapRouterEnabled?: boolean;
 }): Promise<SwapQuote> {
   const quotePromises: Promise<SwapQuote>[] = [
     new Promise((resolve, reject) => {
@@ -564,18 +553,16 @@ async function getFixedOutputSwapQuote({
     })
   ];
 
-  if (isSwapRouterEnabled) {
-    quotePromises.push(
-      getSwapRoute({
-        amount,
-        assetInID: assetIn.id,
-        assetOutID: assetOut.id,
-        swapType: SwapType.FixedOutput,
-        network,
-        slippage
-      }).then((data) => ({type: SwapQuoteType.Router, data}))
-    );
-  }
+  quotePromises.push(
+    getSwapRoute({
+      amount,
+      assetInID: assetIn.id,
+      assetOutID: assetOut.id,
+      swapType: SwapType.FixedOutput,
+      network,
+      slippage
+    }).then((data) => ({type: SwapQuoteType.Router, data}))
+  );
 
   const validQuotes = await validateQuotes(quotePromises);