@fenine/router-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Uniswap Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# Fenine Router SDK
+
+`@fenine/router-sdk` helps compose swap routes and calldata for Fenine-compatible
+V2, V3, and mixed-route trades.
+
+## Install
+
+```bash
+npm install @fenine/router-sdk
+```
+
+## Notes
+
+- This package is intended for Fenine-compatible routing flows.
+- It interoperates with `@fenine/sdk-core` and `@fenine/v3-sdk`.
+- Contract execution still targets swap-router style contracts.

package/dist/cjs/src/approveAndCall.d.ts

@@ -0,0 +1,33 @@
+import { Interface } from '@ethersproject/abi';
+import { Currency, Percent, Token } from '@fenine/sdk-core';
+import { MintSpecificOptions, IncreaseSpecificOptions, Position } from '@fenine/v3-sdk';
+export type CondensedAddLiquidityOptions = Omit<MintSpecificOptions, 'createPool'> | IncreaseSpecificOptions;
+export declare enum ApprovalTypes {
+    NOT_REQUIRED = 0,
+    MAX = 1,
+    MAX_MINUS_ONE = 2,
+    ZERO_THEN_MAX = 3,
+    ZERO_THEN_MAX_MINUS_ONE = 4
+}
+export declare function isMint(options: CondensedAddLiquidityOptions): options is Omit<MintSpecificOptions, 'createPool'>;
+export declare abstract class ApproveAndCall {
+    static INTERFACE: Interface;
+    /**
+     * Cannot be constructed.
+     */
+    private constructor();
+    static encodeApproveMax(token: Token): string;
+    static encodeApproveMaxMinusOne(token: Token): string;
+    static encodeApproveZeroThenMax(token: Token): string;
+    static encodeApproveZeroThenMaxMinusOne(token: Token): string;
+    static encodeCallPositionManager(calldatas: string[]): string;
+    /**
+     * Encode adding liquidity to a position in the nft manager contract
+     * @param position Forcasted position with expected amount out from swap
+     * @param minimalPosition Forcasted position with custom minimal token amounts
+     * @param addLiquidityOptions Options for adding liquidity
+     * @param slippageTolerance Defines maximum slippage
+     */
+    static encodeAddLiquidity(position: Position, minimalPosition: Position, addLiquidityOptions: CondensedAddLiquidityOptions, slippageTolerance: Percent): string;
+    static encodeApprove(token: Currency, approvalType: ApprovalTypes): string;
+}

package/dist/cjs/src/approveAndCall.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApproveAndCall = exports.isMint = exports.ApprovalTypes = void 0;
+const tslib_1 = require("tslib");
+const abi_1 = require("@ethersproject/abi");
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const IApproveAndCall_json_1 = tslib_1.__importDefault(require("@uniswap/swap-router-contracts/artifacts/contracts/interfaces/IApproveAndCall.sol/IApproveAndCall.json"));
+const v3_sdk_1 = require("@fenine/v3-sdk");
+const jsbi_1 = tslib_1.__importDefault(require("jsbi"));
+var ApprovalTypes;
+(function (ApprovalTypes) {
+    ApprovalTypes[ApprovalTypes["NOT_REQUIRED"] = 0] = "NOT_REQUIRED";
+    ApprovalTypes[ApprovalTypes["MAX"] = 1] = "MAX";
+    ApprovalTypes[ApprovalTypes["MAX_MINUS_ONE"] = 2] = "MAX_MINUS_ONE";
+    ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX"] = 3] = "ZERO_THEN_MAX";
+    ApprovalTypes[ApprovalTypes["ZERO_THEN_MAX_MINUS_ONE"] = 4] = "ZERO_THEN_MAX_MINUS_ONE";
+})(ApprovalTypes = exports.ApprovalTypes || (exports.ApprovalTypes = {}));
+// type guard
+function isMint(options) {
+    return Object.keys(options).some((k) => k === 'recipient');
+}
+exports.isMint = isMint;
+class ApproveAndCall {
+    /**
+     * Cannot be constructed.
+     */
+    constructor() { }
+    static encodeApproveMax(token) {
+        return ApproveAndCall.INTERFACE.encodeFunctionData('approveMax', [token.address]);
+    }
+    static encodeApproveMaxMinusOne(token) {
+        return ApproveAndCall.INTERFACE.encodeFunctionData('approveMaxMinusOne', [token.address]);
+    }
+    static encodeApproveZeroThenMax(token) {
+        return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMax', [token.address]);
+    }
+    static encodeApproveZeroThenMaxMinusOne(token) {
+        return ApproveAndCall.INTERFACE.encodeFunctionData('approveZeroThenMaxMinusOne', [token.address]);
+    }
+    static encodeCallPositionManager(calldatas) {
+        (0, tiny_invariant_1.default)(calldatas.length > 0, 'NULL_CALLDATA');
+        if (calldatas.length === 1) {
+            return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', calldatas);
+        }
+        else {
+            const encodedMulticall = v3_sdk_1.NonfungiblePositionManager.INTERFACE.encodeFunctionData('multicall', [calldatas]);
+            return ApproveAndCall.INTERFACE.encodeFunctionData('callPositionManager', [encodedMulticall]);
+        }
+    }
+    /**
+     * Encode adding liquidity to a position in the nft manager contract
+     * @param position Forcasted position with expected amount out from swap
+     * @param minimalPosition Forcasted position with custom minimal token amounts
+     * @param addLiquidityOptions Options for adding liquidity
+     * @param slippageTolerance Defines maximum slippage
+     */
+    static encodeAddLiquidity(position, minimalPosition, addLiquidityOptions, slippageTolerance) {
+        let { amount0: amount0Min, amount1: amount1Min } = position.mintAmountsWithSlippage(slippageTolerance);
+        // position.mintAmountsWithSlippage() can create amounts not dependenable in scenarios
+        // such as range orders. Allow the option to provide a position with custom minimum amounts
+        // for these scenarios
+        if (jsbi_1.default.lessThan(minimalPosition.amount0.quotient, amount0Min)) {
+            amount0Min = minimalPosition.amount0.quotient;
+        }
+        if (jsbi_1.default.lessThan(minimalPosition.amount1.quotient, amount1Min)) {
+            amount1Min = minimalPosition.amount1.quotient;
+        }
+        if (isMint(addLiquidityOptions)) {
+            return ApproveAndCall.INTERFACE.encodeFunctionData('mint', [
+                {
+                    token0: position.pool.token0.address,
+                    token1: position.pool.token1.address,
+                    fee: position.pool.fee,
+                    tickLower: position.tickLower,
+                    tickUpper: position.tickUpper,
+                    amount0Min: (0, v3_sdk_1.toHex)(amount0Min),
+                    amount1Min: (0, v3_sdk_1.toHex)(amount1Min),
+                    recipient: addLiquidityOptions.recipient,
+                },
+            ]);
+        }
+        else {
+            return ApproveAndCall.INTERFACE.encodeFunctionData('increaseLiquidity', [
+                {
+                    token0: position.pool.token0.address,
+                    token1: position.pool.token1.address,
+                    amount0Min: (0, v3_sdk_1.toHex)(amount0Min),
+                    amount1Min: (0, v3_sdk_1.toHex)(amount1Min),
+                    tokenId: (0, v3_sdk_1.toHex)(addLiquidityOptions.tokenId),
+                },
+            ]);
+        }
+    }
+    static encodeApprove(token, approvalType) {
+        switch (approvalType) {
+            case ApprovalTypes.MAX:
+                return ApproveAndCall.encodeApproveMax(token.wrapped);
+            case ApprovalTypes.MAX_MINUS_ONE:
+                return ApproveAndCall.encodeApproveMaxMinusOne(token.wrapped);
+            case ApprovalTypes.ZERO_THEN_MAX:
+                return ApproveAndCall.encodeApproveZeroThenMax(token.wrapped);
+            case ApprovalTypes.ZERO_THEN_MAX_MINUS_ONE:
+                return ApproveAndCall.encodeApproveZeroThenMaxMinusOne(token.wrapped);
+            default:
+                throw new Error('Error: invalid ApprovalType');
+        }
+    }
+}
+exports.ApproveAndCall = ApproveAndCall;
+ApproveAndCall.INTERFACE = new abi_1.Interface(IApproveAndCall_json_1.default.abi);
+//# sourceMappingURL=approveAndCall.js.map

package/dist/cjs/src/approveAndCall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"approveAndCall.js","sourceRoot":"","sources":["../../../src/approveAndCall.ts"],"names":[],"mappings":";;;;AAAA,4CAA8C;AAC9C,4EAAsC;AACtC,0KAAoI;AAEpI,2CAMuB;AACvB,wDAAuB;AAKvB,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,iEAAgB,CAAA;IAChB,+CAAO,CAAA;IACP,mEAAiB,CAAA;IACjB,mEAAiB,CAAA;IACjB,uFAA2B,CAAA;AAC7B,CAAC,EANW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAMxB;AAED,aAAa;AACb,SAAgB,MAAM,CAAC,OAAqC;IAC1D,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,WAAW,CAAC,CAAA;AAC5D,CAAC;AAFD,wBAEC;AAED,MAAsB,cAAc;IAGlC;;OAEG;IACH,gBAAuB,CAAC;IAEjB,MAAM,CAAC,gBAAgB,CAAC,KAAY;QACzC,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACnF,CAAC;IAEM,MAAM,CAAC,wBAAwB,CAAC,KAAY;QACjD,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3F,CAAC;IAEM,MAAM,CAAC,wBAAwB,CAAC,KAAY;QACjD,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3F,CAAC;IAEM,MAAM,CAAC,gCAAgC,CAAC,KAAY;QACzD,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,4BAA4B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACnG,CAAC;IAEM,MAAM,CAAC,yBAAyB,CAAC,SAAmB;QACzD,IAAA,wBAAS,EAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,eAAe,CAAC,CAAA;QAEhD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1B,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAA;SACrF;aAAM;YACL,MAAM,gBAAgB,GAAG,mCAA0B,CAAC,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;YAC1G,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAA;SAC9F;IACH,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAC9B,QAAkB,EAClB,eAAyB,EACzB,mBAAiD,EACjD,iBAA0B;QAE1B,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAA;QAEtG,sFAAsF;QACtF,2FAA2F;QAC3F,sBAAsB;QACtB,IAAI,cAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE;YAC/D,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAA;SAC9C;QACD,IAAI,cAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE;YAC/D,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAA;SAC9C;QAED,IAAI,MAAM,CAAC,mBAAmB,CAAC,EAAE;YAC/B,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE;gBACzD;oBACE,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;oBACpC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;oBACpC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG;oBACtB,SAAS,EAAE,QAAQ,CAAC,SAAS;oBAC7B,SAAS,EAAE,QAAQ,CAAC,SAAS;oBAC7B,UAAU,EAAE,IAAA,cAAK,EAAC,UAAU,CAAC;oBAC7B,UAAU,EAAE,IAAA,cAAK,EAAC,UAAU,CAAC;oBAC7B,SAAS,EAAE,mBAAmB,CAAC,SAAS;iBACzC;aACF,CAAC,CAAA;SACH;aAAM;YACL,OAAO,cAAc,CAAC,SAAS,CAAC,kBAAkB,CAAC,mBAAmB,EAAE;gBACtE;oBACE,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;oBACpC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;oBACpC,UAAU,EAAE,IAAA,cAAK,EAAC,UAAU,CAAC;oBAC7B,UAAU,EAAE,IAAA,cAAK,EAAC,UAAU,CAAC;oBAC7B,OAAO,EAAE,IAAA,cAAK,EAAC,mBAAmB,CAAC,OAAO,CAAC;iBAC5C;aACF,CAAC,CAAA;SACH;IACH,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,KAAe,EAAE,YAA2B;QACtE,QAAQ,YAAY,EAAE;YACpB,KAAK,aAAa,CAAC,GAAG;gBACpB,OAAO,cAAc,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACvD,KAAK,aAAa,CAAC,aAAa;gBAC9B,OAAO,cAAc,CAAC,wBAAwB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAC/D,KAAK,aAAa,CAAC,aAAa;gBAC9B,OAAO,cAAc,CAAC,wBAAwB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAC/D,KAAK,aAAa,CAAC,uBAAuB;gBACxC,OAAO,cAAc,CAAC,gCAAgC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACvE;gBACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SACjD;IACH,CAAC;;AAlGH,wCAmGC;AAlGe,wBAAS,GAAc,IAAI,eAAS,CAAC,8BAAe,CAAC,GAAG,CAAC,CAAA"}

package/dist/cjs/src/constants.d.ts

@@ -0,0 +1,13 @@
+import { Percent } from '@fenine/sdk-core';
+import JSBI from 'jsbi';
+export declare const ADDRESS_ZERO = "0x0000000000000000000000000000000000000000";
+export declare const MSG_SENDER = "0x0000000000000000000000000000000000000001";
+export declare const ADDRESS_THIS = "0x0000000000000000000000000000000000000002";
+export declare const ZERO: JSBI;
+export declare const ONE: JSBI;
+export declare const MIXED_QUOTER_V1_V2_FEE_PATH_PLACEHOLDER: number;
+export declare const MIXED_QUOTER_V2_V2_FEE_PATH_PLACEHOLDER: number;
+export declare const MIXED_QUOTER_V2_V3_FEE_PATH_PLACEHOLDER: number;
+export declare const MIXED_QUOTER_V2_V4_FEE_PATH_PLACEHOLDER: number;
+export declare const ZERO_PERCENT: Percent;
+export declare const ONE_HUNDRED_PERCENT: Percent;

package/dist/cjs/src/constants.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ONE_HUNDRED_PERCENT = exports.ZERO_PERCENT = exports.MIXED_QUOTER_V2_V4_FEE_PATH_PLACEHOLDER = exports.MIXED_QUOTER_V2_V3_FEE_PATH_PLACEHOLDER = exports.MIXED_QUOTER_V2_V2_FEE_PATH_PLACEHOLDER = exports.MIXED_QUOTER_V1_V2_FEE_PATH_PLACEHOLDER = exports.ONE = exports.ZERO = exports.ADDRESS_THIS = exports.MSG_SENDER = exports.ADDRESS_ZERO = void 0;
+const tslib_1 = require("tslib");
+const sdk_core_1 = require("@fenine/sdk-core");
+const jsbi_1 = tslib_1.__importDefault(require("jsbi"));
+exports.ADDRESS_ZERO = '0x0000000000000000000000000000000000000000';
+exports.MSG_SENDER = '0x0000000000000000000000000000000000000001';
+exports.ADDRESS_THIS = '0x0000000000000000000000000000000000000002';
+exports.ZERO = jsbi_1.default.BigInt(0);
+exports.ONE = jsbi_1.default.BigInt(1);
+// = 1 << 23 or 0b0100000000000000000000000
+exports.MIXED_QUOTER_V1_V2_FEE_PATH_PLACEHOLDER = 1 << 23;
+// = 10 << 4 or 0b00100000
+exports.MIXED_QUOTER_V2_V2_FEE_PATH_PLACEHOLDER = 2 << 4;
+// = 11 << 20 or 0b001100000000000000000000
+exports.MIXED_QUOTER_V2_V3_FEE_PATH_PLACEHOLDER = 3 << 20;
+// = 100 << 20 or 0b010000000000000000000000
+exports.MIXED_QUOTER_V2_V4_FEE_PATH_PLACEHOLDER = 4 << 20;
+exports.ZERO_PERCENT = new sdk_core_1.Percent(exports.ZERO);
+exports.ONE_HUNDRED_PERCENT = new sdk_core_1.Percent(100, 100);
+//# sourceMappingURL=constants.js.map

package/dist/cjs/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/constants.ts"],"names":[],"mappings":";;;;AAAA,+CAA0C;AAC1C,wDAAuB;AAEV,QAAA,YAAY,GAAG,4CAA4C,CAAA;AAC3D,QAAA,UAAU,GAAG,4CAA4C,CAAA;AACzD,QAAA,YAAY,GAAG,4CAA4C,CAAA;AAE3D,QAAA,IAAI,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AACrB,QAAA,GAAG,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAEjC,2CAA2C;AAC9B,QAAA,uCAAuC,GAAG,CAAC,IAAI,EAAE,CAAA;AAE9D,0BAA0B;AACb,QAAA,uCAAuC,GAAG,CAAC,IAAI,CAAC,CAAA;AAE7D,2CAA2C;AAC9B,QAAA,uCAAuC,GAAG,CAAC,IAAI,EAAE,CAAA;AAE9D,4CAA4C;AAC/B,QAAA,uCAAuC,GAAG,CAAC,IAAI,EAAE,CAAA;AAEjD,QAAA,YAAY,GAAG,IAAI,kBAAO,CAAC,YAAI,CAAC,CAAA;AAChC,QAAA,mBAAmB,GAAG,IAAI,kBAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA"}

package/dist/cjs/src/entities/mixedRoute/route.d.ts

@@ -0,0 +1,29 @@
+import { Currency, Price } from '@fenine/sdk-core';
+import { TPool } from '../../utils/TPool';
+/**
+ * Represents a list of pools or pairs through which a swap can occur
+ * @template TInput The input token
+ * @template TOutput The output token
+ */
+export declare class MixedRouteSDK<TInput extends Currency, TOutput extends Currency> {
+    readonly pools: TPool[];
+    readonly path: Currency[];
+    readonly input: TInput;
+    readonly output: TOutput;
+    readonly pathInput: Currency;
+    readonly pathOutput: Currency;
+    private _midPrice;
+    /**
+     * Creates an instance of route.
+     * @param pools An array of `TPool` objects (pools or pairs), ordered by the route the swap will take
+     * @param input The input token
+     * @param output The output token
+     * @param retainsFakePool Set to true to filter out a pool that has a fake eth-weth pool
+     */
+    constructor(pools: TPool[], input: TInput, output: TOutput, retainFakePools?: boolean);
+    get chainId(): number;
+    /**
+     * Returns the mid price of the route
+     */
+    get midPrice(): Price<TInput, TOutput>;
+}

package/dist/cjs/src/entities/mixedRoute/route.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MixedRouteSDK = void 0;
+const tslib_1 = require("tslib");
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const sdk_core_1 = require("@fenine/sdk-core");
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+const pathCurrency_1 = require("../../utils/pathCurrency");
+/**
+ * Represents a list of pools or pairs through which a swap can occur
+ * @template TInput The input token
+ * @template TOutput The output token
+ */
+class MixedRouteSDK {
+    /**
+     * Creates an instance of route.
+     * @param pools An array of `TPool` objects (pools or pairs), ordered by the route the swap will take
+     * @param input The input token
+     * @param output The output token
+     * @param retainsFakePool Set to true to filter out a pool that has a fake eth-weth pool
+     */
+    constructor(pools, input, output, retainFakePools = false) {
+        this._midPrice = null;
+        pools = retainFakePools ? pools : pools.filter((pool) => !(pool instanceof v4_sdk_1.Pool && pool.tickSpacing === 0));
+        (0, tiny_invariant_1.default)(pools.length > 0, 'POOLS');
+        // there is a pool mismatched to the path if we do not retain the fake eth-weth pools
+        const chainId = pools[0].chainId;
+        const allOnSameChain = pools.every((pool) => pool.chainId === chainId);
+        (0, tiny_invariant_1.default)(allOnSameChain, 'CHAIN_IDS');
+        this.pathInput = (0, pathCurrency_1.getPathCurrency)(input, pools[0]);
+        this.pathOutput = (0, pathCurrency_1.getPathCurrency)(output, pools[pools.length - 1]);
+        if (!(pools[0] instanceof v4_sdk_1.Pool)) {
+            (0, tiny_invariant_1.default)(pools[0].involvesToken(this.pathInput), 'INPUT');
+        }
+        else {
+            (0, tiny_invariant_1.default)(pools[0].v4InvolvesToken(this.pathInput), 'INPUT');
+        }
+        const lastPool = pools[pools.length - 1];
+        if (lastPool instanceof v4_sdk_1.Pool) {
+            (0, tiny_invariant_1.default)(lastPool.v4InvolvesToken(output) || lastPool.v4InvolvesToken(output.wrapped), 'OUTPUT');
+        }
+        else {
+            (0, tiny_invariant_1.default)(lastPool.involvesToken(output.wrapped), 'OUTPUT');
+        }
+        /**
+         * Normalizes token0-token1 order and selects the next token/fee step to add to the path
+         * */
+        const tokenPath = [this.pathInput];
+        pools[0].token0.equals(this.pathInput) ? tokenPath.push(pools[0].token1) : tokenPath.push(pools[0].token0);
+        for (let i = 1; i < pools.length; i++) {
+            const pool = pools[i];
+            const inputToken = tokenPath[i];
+            let outputToken;
+            if (
+            // we hit an edge case if it's a v4 pool and neither of the tokens are in the pool OR it is not a v4 pool but the input currency is eth
+            (pool instanceof v4_sdk_1.Pool && !pool.involvesToken(inputToken)) ||
+                (!(pool instanceof v4_sdk_1.Pool) && inputToken.isNative)) {
+                // We handle the case where the inputToken =/= pool.token0 or pool.token1. There are 2 specific cases.
+                if (inputToken.equals(pool.token0.wrapped)) {
+                    // 1) the inputToken is WETH and the current pool has ETH
+                    // for example, pools: USDC-WETH, ETH-PEPE, path: USDC, WETH, PEPE
+                    // second pool is a v4 pool, the first could be any version
+                    outputToken = pool.token1;
+                }
+                else if (inputToken.wrapped.equals(pool.token0) || inputToken.wrapped.equals(pool.token1)) {
+                    // 2) the inputToken is ETH and the current pool has WETH
+                    // for example, pools: USDC-ETH, WETH-PEPE, path: USDC, ETH, PEPE
+                    // first pool is a v4 pool, the second could be any version
+                    outputToken = inputToken.wrapped.equals(pool.token0) ? pool.token1 : pool.token0;
+                }
+                else {
+                    throw new Error(`POOL_MISMATCH pool: ${JSON.stringify(pool)} inputToken: ${JSON.stringify(inputToken)}`);
+                }
+            }
+            else {
+                // then the input token must equal either token0 or token1
+                (0, tiny_invariant_1.default)(inputToken.equals(pool.token0) || inputToken.equals(pool.token1), `PATH pool ${JSON.stringify(pool)} inputToken ${JSON.stringify(inputToken)}`);
+                outputToken = inputToken.equals(pool.token0) ? pool.token1 : pool.token0;
+            }
+            tokenPath.push(outputToken);
+        }
+        this.pools = pools;
+        this.path = tokenPath;
+        this.input = input;
+        this.output = output !== null && output !== void 0 ? output : tokenPath[tokenPath.length - 1];
+    }
+    get chainId() {
+        return this.pools[0].chainId;
+    }
+    /**
+     * Returns the mid price of the route
+     */
+    get midPrice() {
+        if (this._midPrice !== null)
+            return this._midPrice;
+        const price = this.pools.slice(1).reduce(({ nextInput, price }, pool) => {
+            return nextInput.equals(pool.token0)
+                ? {
+                    nextInput: pool.token1,
+                    price: price.multiply(pool.token0Price.asFraction),
+                }
+                : {
+                    nextInput: pool.token0,
+                    price: price.multiply(pool.token1Price.asFraction),
+                };
+        }, this.pools[0].token0.equals(this.pathInput)
+            ? {
+                nextInput: this.pools[0].token1,
+                price: this.pools[0].token0Price.asFraction,
+            }
+            : {
+                nextInput: this.pools[0].token0,
+                price: this.pools[0].token1Price.asFraction,
+            }).price;
+        return (this._midPrice = new sdk_core_1.Price(this.input, this.output, price.denominator, price.numerator));
+    }
+}
+exports.MixedRouteSDK = MixedRouteSDK;
+//# sourceMappingURL=route.js.map

package/dist/cjs/src/entities/mixedRoute/route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../../src/entities/mixedRoute/route.ts"],"names":[],"mappings":";;;;AAAA,4EAAsC;AACtC,+CAAyD;AACzD,4CAAgD;AAChD,2DAA0D;AAG1D;;;;GAIG;AACH,MAAa,aAAa;IAUxB;;;;;;OAMG;IACH,YAAmB,KAAc,EAAE,KAAa,EAAE,MAAe,EAAE,eAAe,GAAG,KAAK;QATlF,cAAS,GAAkC,IAAI,CAAA;QAUrD,KAAK,GAAG,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,YAAY,aAAM,IAAI,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAA;QAC7G,IAAA,wBAAS,EAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,qFAAqF;QAErF,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;QAChC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAA;QACtE,IAAA,wBAAS,EAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAEtC,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAe,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACjD,IAAI,CAAC,UAAU,GAAG,IAAA,8BAAe,EAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;QAElE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,aAAM,CAAC,EAAE;YACjC,IAAA,wBAAS,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAkB,CAAC,EAAE,OAAO,CAAC,CAAA;SACpE;aAAM;YACL,IAAA,wBAAS,EAAE,KAAK,CAAC,CAAC,CAAY,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAA;SACzE;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACxC,IAAI,QAAQ,YAAY,aAAM,EAAE;YAC9B,IAAA,wBAAS,EAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;SAClG;aAAM;YACL,IAAA,wBAAS,EAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,OAAgB,CAAC,EAAE,QAAQ,CAAC,CAAA;SACrE;QAED;;aAEK;QACL,MAAM,SAAS,GAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC9C,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QAE1G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;YACrB,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YAE/B,IAAI,WAAW,CAAA;YACf;YACE,uIAAuI;YACvI,CAAC,IAAI,YAAY,aAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;gBAC3D,CAAC,CAAC,CAAC,IAAI,YAAY,aAAM,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,EAClD;gBACA,sGAAsG;gBACtG,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oBAC1C,yDAAyD;oBACzD,kEAAkE;oBAClE,2DAA2D;oBAC3D,WAAW,GAAG,IAAI,CAAC,MAAM,CAAA;iBAC1B;qBAAM,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBAC3F,yDAAyD;oBACzD,iEAAiE;oBACjE,2DAA2D;oBAC3D,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;iBACjF;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;iBACzG;aACF;iBAAM;gBACL,0DAA0D;gBAC1D,IAAA,wBAAS,EACP,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAChE,aAAa,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAC7E,CAAA;gBACD,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;aACzE;YACD,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;SAC5B;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,SAAS,CAAA;QAElD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CACtC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE;YAC7B,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClC,CAAC,CAAC;oBACE,SAAS,EAAE,IAAI,CAAC,MAAM;oBACtB,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;iBACnD;gBACH,CAAC,CAAC;oBACE,SAAS,EAAE,IAAI,CAAC,MAAM;oBACtB,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;iBACnD,CAAA;QACP,CAAC,EAED,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YACzC,CAAC,CAAC;gBACE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;gBAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU;aAC5C;YACH,CAAC,CAAC;gBACE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;gBAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU;aAC5C,CACN,CAAC,KAAK,CAAA;QAEP,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAA;IAClG,CAAC;CACF;AA5HD,sCA4HC"}

package/dist/cjs/src/entities/mixedRoute/trade.d.ts

@@ -0,0 +1,183 @@
+import { Currency, Percent, Price, CurrencyAmount, TradeType } from '@fenine/sdk-core';
+import { BestTradeOptions } from '@fenine/v3-sdk';
+import { MixedRouteSDK } from './route';
+import { TPool } from '../../utils/TPool';
+/**
+ * Trades comparator, an extension of the input output comparator that also considers other dimensions of the trade in ranking them
+ * @template TInput The input token, either Ether or an ERC-20
+ * @template TOutput The output token, either Ether or an ERC-20
+ * @template TTradeType The trade type, either exact input or exact output
+ * @param a The first trade to compare
+ * @param b The second trade to compare
+ * @returns A sorted ordering for two neighboring elements in a trade array
+ */
+export declare function tradeComparator<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(a: MixedRouteTrade<TInput, TOutput, TTradeType>, b: MixedRouteTrade<TInput, TOutput, TTradeType>): number;
+/**
+ * Represents a trade executed against a set of routes where some percentage of the input is
+ * split across each route.
+ *
+ * Each route has its own set of pools. Pools can not be re-used across routes.
+ *
+ * Does not account for slippage, i.e., changes in price environment that can occur between
+ * the time the trade is submitted and when it is executed.
+ * @notice This class is functionally the same as the `Trade` class in the `@uniswap/v3-sdk` package, aside from typing and some input validation.
+ * @template TInput The input token, either Ether or an ERC-20
+ * @template TOutput The output token, either Ether or an ERC-20
+ * @template TTradeType The trade type, either exact input or exact output
+ */
+export declare class MixedRouteTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
+    /**
+     * @deprecated Deprecated in favor of 'swaps' property. If the trade consists of multiple routes
+     * this will return an error.
+     *
+     * When the trade consists of just a single route, this returns the route of the trade,
+     * i.e. which pools the trade goes through.
+     */
+    get route(): MixedRouteSDK<TInput, TOutput>;
+    /**
+     * The swaps of the trade, i.e. which routes and how much is swapped in each that
+     * make up the trade.
+     */
+    readonly swaps: {
+        route: MixedRouteSDK<TInput, TOutput>;
+        inputAmount: CurrencyAmount<TInput>;
+        outputAmount: CurrencyAmount<TOutput>;
+    }[];
+    /**
+     * The type of the trade, either exact in or exact out.
+     */
+    readonly tradeType: TTradeType;
+    /**
+     * The cached result of the input amount computation
+     * @private
+     */
+    private _inputAmount;
+    /**
+     * The input amount for the trade assuming no slippage.
+     */
+    get inputAmount(): CurrencyAmount<TInput>;
+    /**
+     * The cached result of the output amount computation
+     * @private
+     */
+    private _outputAmount;
+    /**
+     * The output amount for the trade assuming no slippage.
+     */
+    get outputAmount(): CurrencyAmount<TOutput>;
+    /**
+     * The cached result of the computed execution price
+     * @private
+     */
+    private _executionPrice;
+    /**
+     * The price expressed in terms of output amount/input amount.
+     */
+    get executionPrice(): Price<TInput, TOutput>;
+    /**
+     * The cached result of the price impact computation
+     * @private
+     */
+    private _priceImpact;
+    /**
+     * Returns the percent difference between the route's mid price and the price impact
+     */
+    get priceImpact(): Percent;
+    /**
+     * Constructs a trade by simulating swaps through the given route
+     * @template TInput The input token, either Ether or an ERC-20.
+     * @template TOutput The output token, either Ether or an ERC-20.
+     * @template TTradeType The type of the trade, either exact in or exact out.
+     * @param route route to swap through
+     * @param amount the amount specified, either input or output, depending on tradeType
+     * @param tradeType whether the trade is an exact input or exact output swap
+     * @returns The route
+     */
+    static fromRoute<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(route: MixedRouteSDK<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType): Promise<MixedRouteTrade<TInput, TOutput, TTradeType>>;
+    /**
+     * Constructs a trade from routes by simulating swaps
+     *
+     * @template TInput The input token, either Ether or an ERC-20.
+     * @template TOutput The output token, either Ether or an ERC-20.
+     * @template TTradeType The type of the trade, either exact in or exact out.
+     * @param routes the routes to swap through and how much of the amount should be routed through each
+     * @param tradeType whether the trade is an exact input or exact output swap
+     * @returns The trade
+     */
+    static fromRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(routes: {
+        amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
+        route: MixedRouteSDK<TInput, TOutput>;
+    }[], tradeType: TTradeType): Promise<MixedRouteTrade<TInput, TOutput, TTradeType>>;
+    /**
+     * Creates a trade without computing the result of swapping through the route. Useful when you have simulated the trade
+     * elsewhere and do not have any tick data
+     * @template TInput The input token, either Ether or an ERC-20
+     * @template TOutput The output token, either Ether or an ERC-20
+     * @template TTradeType The type of the trade, either exact in or exact out
+     * @param constructorArguments The arguments passed to the trade constructor
+     * @returns The unchecked trade
+     */
+    static createUncheckedTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
+        route: MixedRouteSDK<TInput, TOutput>;
+        inputAmount: CurrencyAmount<TInput>;
+        outputAmount: CurrencyAmount<TOutput>;
+        tradeType: TTradeType;
+    }): MixedRouteTrade<TInput, TOutput, TTradeType>;
+    /**
+     * Creates a trade without computing the result of swapping through the routes. Useful when you have simulated the trade
+     * elsewhere and do not have any tick data
+     * @template TInput The input token, either Ether or an ERC-20
+     * @template TOutput The output token, either Ether or an ERC-20
+     * @template TTradeType The type of the trade, either exact in or exact out
+     * @param constructorArguments The arguments passed to the trade constructor
+     * @returns The unchecked trade
+     */
+    static createUncheckedTradeWithMultipleRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(constructorArguments: {
+        routes: {
+            route: MixedRouteSDK<TInput, TOutput>;
+            inputAmount: CurrencyAmount<TInput>;
+            outputAmount: CurrencyAmount<TOutput>;
+        }[];
+        tradeType: TTradeType;
+    }): MixedRouteTrade<TInput, TOutput, TTradeType>;
+    /**
+     * Construct a trade by passing in the pre-computed property values
+     * @param routes The routes through which the trade occurs
+     * @param tradeType The type of trade, exact input or exact output
+     */
+    private constructor();
+    /**
+     * Get the minimum amount that must be received from this trade for the given slippage tolerance
+     * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
+     * @returns The amount out
+     */
+    minimumAmountOut(slippageTolerance: Percent, amountOut?: CurrencyAmount<TOutput>): CurrencyAmount<TOutput>;
+    /**
+     * Get the maximum amount in that can be spent via this trade for the given slippage tolerance
+     * @param slippageTolerance The tolerance of unfavorable slippage from the execution price of this trade
+     * @returns The amount in
+     */
+    maximumAmountIn(slippageTolerance: Percent, amountIn?: CurrencyAmount<TInput>): CurrencyAmount<TInput>;
+    /**
+     * Return the execution price after accounting for slippage tolerance
+     * @param slippageTolerance the allowed tolerated slippage
+     * @returns The execution price
+     */
+    worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
+    /**
+     * Given a list of pools, and a fixed amount in, returns the top `maxNumResults` trades that go from an input token
+     * amount to an output token, making at most `maxHops` hops.
+     * Note this does not consider aggregation, as routes are linear. It's possible a better route exists by splitting
+     * the amount in among multiple routes.
+     * @param pools the pools to consider in finding the best trade
+     * @param nextAmountIn exact amount of input currency to spend
+     * @param currencyOut the desired currency out
+     * @param maxNumResults maximum number of results to return
+     * @param maxHops maximum number of hops a returned trade can make, e.g. 1 hop goes through a single pool
+     * @param currentPools used in recursion; the current list of pools
+     * @param currencyAmountIn used in recursion; the original value of the currencyAmountIn parameter
+     * @param bestTrades used in recursion; the current list of best trades
+     * @returns The exact in trade
+     */
+    static bestTradeExactIn<TInput extends Currency, TOutput extends Currency>(pools: TPool[], currencyAmountIn: CurrencyAmount<TInput>, currencyOut: TOutput, { maxNumResults, maxHops }?: BestTradeOptions, currentPools?: TPool[], nextAmountIn?: CurrencyAmount<Currency>, bestTrades?: MixedRouteTrade<TInput, TOutput, TradeType.EXACT_INPUT>[]): Promise<MixedRouteTrade<TInput, TOutput, TradeType.EXACT_INPUT>[]>;
+}