@fenine/router-sdk 1.0.0

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

@@ -0,0 +1,354 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MixedRouteTrade = exports.tradeComparator = void 0;
+const tslib_1 = require("tslib");
+const sdk_core_1 = require("@fenine/sdk-core");
+const v2_sdk_1 = require("@uniswap/v2-sdk");
+const v3_sdk_1 = require("@fenine/v3-sdk");
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const constants_1 = require("../../constants");
+const route_1 = require("./route");
+const pathCurrency_1 = require("../../utils/pathCurrency");
+/**
+ * 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
+ */
+function tradeComparator(a, b) {
+    // must have same input and output token for comparison
+    (0, tiny_invariant_1.default)(a.inputAmount.currency.equals(b.inputAmount.currency), 'INPUT_CURRENCY');
+    (0, tiny_invariant_1.default)(a.outputAmount.currency.equals(b.outputAmount.currency), 'OUTPUT_CURRENCY');
+    if (a.outputAmount.equalTo(b.outputAmount)) {
+        if (a.inputAmount.equalTo(b.inputAmount)) {
+            // consider the number of hops since each hop costs gas
+            const aHops = a.swaps.reduce((total, cur) => total + cur.route.path.length, 0);
+            const bHops = b.swaps.reduce((total, cur) => total + cur.route.path.length, 0);
+            return aHops - bHops;
+        }
+        // trade A requires less input than trade B, so A should come first
+        if (a.inputAmount.lessThan(b.inputAmount)) {
+            return -1;
+        }
+        else {
+            return 1;
+        }
+    }
+    else {
+        // tradeA has less output than trade B, so should come second
+        if (a.outputAmount.lessThan(b.outputAmount)) {
+            return 1;
+        }
+        else {
+            return -1;
+        }
+    }
+}
+exports.tradeComparator = tradeComparator;
+/**
+ * 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
+ */
+class MixedRouteTrade {
+    /**
+     * @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() {
+        (0, tiny_invariant_1.default)(this.swaps.length === 1, 'MULTIPLE_ROUTES');
+        return this.swaps[0].route;
+    }
+    /**
+     * The input amount for the trade assuming no slippage.
+     */
+    get inputAmount() {
+        if (this._inputAmount) {
+            return this._inputAmount;
+        }
+        const inputCurrency = this.swaps[0].inputAmount.currency;
+        const totalInputFromRoutes = this.swaps
+            .map(({ inputAmount }) => inputAmount)
+            .reduce((total, cur) => total.add(cur), sdk_core_1.CurrencyAmount.fromRawAmount(inputCurrency, 0));
+        this._inputAmount = totalInputFromRoutes;
+        return this._inputAmount;
+    }
+    /**
+     * The output amount for the trade assuming no slippage.
+     */
+    get outputAmount() {
+        if (this._outputAmount) {
+            return this._outputAmount;
+        }
+        const outputCurrency = this.swaps[0].outputAmount.currency;
+        const totalOutputFromRoutes = this.swaps
+            .map(({ outputAmount }) => outputAmount)
+            .reduce((total, cur) => total.add(cur), sdk_core_1.CurrencyAmount.fromRawAmount(outputCurrency, 0));
+        this._outputAmount = totalOutputFromRoutes;
+        return this._outputAmount;
+    }
+    /**
+     * The price expressed in terms of output amount/input amount.
+     */
+    get executionPrice() {
+        var _a;
+        return ((_a = this._executionPrice) !== null && _a !== void 0 ? _a : (this._executionPrice = new sdk_core_1.Price(this.inputAmount.currency, this.outputAmount.currency, this.inputAmount.quotient, this.outputAmount.quotient)));
+    }
+    /**
+     * Returns the percent difference between the route's mid price and the price impact
+     */
+    get priceImpact() {
+        if (this._priceImpact) {
+            return this._priceImpact;
+        }
+        let spotOutputAmount = sdk_core_1.CurrencyAmount.fromRawAmount(this.outputAmount.currency, 0);
+        for (const { route, inputAmount } of this.swaps) {
+            const midPrice = route.midPrice;
+            spotOutputAmount = spotOutputAmount.add(midPrice.quote(inputAmount));
+        }
+        const priceImpact = spotOutputAmount.subtract(this.outputAmount).divide(spotOutputAmount);
+        this._priceImpact = new sdk_core_1.Percent(priceImpact.numerator, priceImpact.denominator);
+        return this._priceImpact;
+    }
+    /**
+     * 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 async fromRoute(route, amount, tradeType) {
+        const amounts = new Array(route.path.length);
+        let inputAmount;
+        let outputAmount;
+        (0, tiny_invariant_1.default)(tradeType === sdk_core_1.TradeType.EXACT_INPUT, 'TRADE_TYPE');
+        (0, tiny_invariant_1.default)(amount.currency.equals(route.input), 'INPUT');
+        amounts[0] = (0, pathCurrency_1.amountWithPathCurrency)(amount, route.pools[0]);
+        for (let i = 0; i < route.path.length - 1; i++) {
+            const pool = route.pools[i];
+            const [outputAmount] = await pool.getOutputAmount((0, pathCurrency_1.amountWithPathCurrency)(amounts[i], pool));
+            amounts[i + 1] = outputAmount;
+        }
+        inputAmount = sdk_core_1.CurrencyAmount.fromFractionalAmount(route.input, amount.numerator, amount.denominator);
+        outputAmount = sdk_core_1.CurrencyAmount.fromFractionalAmount(route.output, amounts[amounts.length - 1].numerator, amounts[amounts.length - 1].denominator);
+        return new MixedRouteTrade({
+            routes: [{ inputAmount, outputAmount, route }],
+            tradeType,
+        });
+    }
+    /**
+     * 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 async fromRoutes(routes, tradeType) {
+        const populatedRoutes = [];
+        (0, tiny_invariant_1.default)(tradeType === sdk_core_1.TradeType.EXACT_INPUT, 'TRADE_TYPE');
+        for (const { route, amount } of routes) {
+            const amounts = new Array(route.path.length);
+            let inputAmount;
+            let outputAmount;
+            (0, tiny_invariant_1.default)(amount.currency.equals(route.input), 'INPUT');
+            inputAmount = sdk_core_1.CurrencyAmount.fromFractionalAmount(route.input, amount.numerator, amount.denominator);
+            amounts[0] = sdk_core_1.CurrencyAmount.fromFractionalAmount(route.pathInput, amount.numerator, amount.denominator);
+            for (let i = 0; i < route.path.length - 1; i++) {
+                const pool = route.pools[i];
+                const [outputAmount] = await pool.getOutputAmount((0, pathCurrency_1.amountWithPathCurrency)(amounts[i], pool));
+                amounts[i + 1] = outputAmount;
+            }
+            outputAmount = sdk_core_1.CurrencyAmount.fromFractionalAmount(route.output, amounts[amounts.length - 1].numerator, amounts[amounts.length - 1].denominator);
+            populatedRoutes.push({ route, inputAmount, outputAmount });
+        }
+        return new MixedRouteTrade({
+            routes: populatedRoutes,
+            tradeType,
+        });
+    }
+    /**
+     * 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(constructorArguments) {
+        return new MixedRouteTrade({
+            ...constructorArguments,
+            routes: [
+                {
+                    inputAmount: constructorArguments.inputAmount,
+                    outputAmount: constructorArguments.outputAmount,
+                    route: constructorArguments.route,
+                },
+            ],
+        });
+    }
+    /**
+     * 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(constructorArguments) {
+        return new MixedRouteTrade(constructorArguments);
+    }
+    /**
+     * 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
+     */
+    constructor({ routes, tradeType, }) {
+        const inputCurrency = routes[0].inputAmount.currency;
+        const outputCurrency = routes[0].outputAmount.currency;
+        (0, tiny_invariant_1.default)(routes.every(({ route }) => inputCurrency.wrapped.equals(route.input.wrapped)), 'INPUT_CURRENCY_MATCH');
+        (0, tiny_invariant_1.default)(routes.every(({ route }) => outputCurrency.wrapped.equals(route.output.wrapped)), 'OUTPUT_CURRENCY_MATCH');
+        const numPools = routes.map(({ route }) => route.pools.length).reduce((total, cur) => total + cur, 0);
+        const poolIdentifierSet = new Set();
+        for (const { route } of routes) {
+            for (const pool of route.pools) {
+                if (pool instanceof v4_sdk_1.Pool) {
+                    poolIdentifierSet.add(pool.poolId);
+                }
+                else if (pool instanceof v3_sdk_1.Pool) {
+                    poolIdentifierSet.add(v3_sdk_1.Pool.getAddress(pool.token0, pool.token1, pool.fee));
+                }
+                else if (pool instanceof v2_sdk_1.Pair) {
+                    const pair = pool;
+                    poolIdentifierSet.add(v2_sdk_1.Pair.getAddress(pair.token0, pair.token1));
+                }
+                else {
+                    throw new Error('Unexpected pool type in route when constructing trade object');
+                }
+            }
+        }
+        (0, tiny_invariant_1.default)(numPools === poolIdentifierSet.size, 'POOLS_DUPLICATED');
+        (0, tiny_invariant_1.default)(tradeType === sdk_core_1.TradeType.EXACT_INPUT, 'TRADE_TYPE');
+        this.swaps = routes;
+        this.tradeType = tradeType;
+    }
+    /**
+     * 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, amountOut = this.outputAmount) {
+        (0, tiny_invariant_1.default)(!slippageTolerance.lessThan(constants_1.ZERO), 'SLIPPAGE_TOLERANCE');
+        /// does not support exactOutput, as enforced in the constructor
+        const slippageAdjustedAmountOut = new sdk_core_1.Fraction(constants_1.ONE)
+            .add(slippageTolerance)
+            .invert()
+            .multiply(amountOut.quotient).quotient;
+        return sdk_core_1.CurrencyAmount.fromRawAmount(amountOut.currency, slippageAdjustedAmountOut);
+    }
+    /**
+     * 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, amountIn = this.inputAmount) {
+        (0, tiny_invariant_1.default)(!slippageTolerance.lessThan(constants_1.ZERO), 'SLIPPAGE_TOLERANCE');
+        return amountIn;
+        /// does not support exactOutput
+    }
+    /**
+     * Return the execution price after accounting for slippage tolerance
+     * @param slippageTolerance the allowed tolerated slippage
+     * @returns The execution price
+     */
+    worstExecutionPrice(slippageTolerance) {
+        return new sdk_core_1.Price(this.inputAmount.currency, this.outputAmount.currency, this.maximumAmountIn(slippageTolerance).quotient, this.minimumAmountOut(slippageTolerance).quotient);
+    }
+    /**
+     * 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 async bestTradeExactIn(pools, currencyAmountIn, currencyOut, { maxNumResults = 3, maxHops = 3 } = {}, 
+    // used in recursion.
+    currentPools = [], nextAmountIn = currencyAmountIn, bestTrades = []) {
+        (0, tiny_invariant_1.default)(pools.length > 0, 'POOLS');
+        (0, tiny_invariant_1.default)(maxHops > 0, 'MAX_HOPS');
+        (0, tiny_invariant_1.default)(currencyAmountIn === nextAmountIn || currentPools.length > 0, 'INVALID_RECURSION');
+        const amountIn = nextAmountIn;
+        for (let i = 0; i < pools.length; i++) {
+            const pool = pools[i];
+            const amountInAdjusted = pool instanceof v4_sdk_1.Pool ? amountIn : amountIn.wrapped;
+            // pool irrelevant
+            if (!pool.token0.equals(amountInAdjusted.currency) && !pool.token1.equals(amountInAdjusted.currency))
+                continue;
+            if (pool instanceof v2_sdk_1.Pair) {
+                if (pool.reserve0.equalTo(constants_1.ZERO) || pool.reserve1.equalTo(constants_1.ZERO))
+                    continue;
+            }
+            let amountOut;
+            try {
+                ;
+                [amountOut] =
+                    pool instanceof v4_sdk_1.Pool
+                        ? await pool.getOutputAmount(amountInAdjusted)
+                        : await pool.getOutputAmount(amountInAdjusted.wrapped);
+            }
+            catch (error) {
+                // input too low
+                // @ts-ignore[2571] error is unknown
+                if (error.isInsufficientInputAmountError) {
+                    continue;
+                }
+                throw error;
+            }
+            // we have arrived at the output token, so this is the final trade of one of the paths
+            if (amountOut.currency.wrapped.equals(currencyOut.wrapped)) {
+                (0, sdk_core_1.sortedInsert)(bestTrades, await MixedRouteTrade.fromRoute(new route_1.MixedRouteSDK([...currentPools, pool], currencyAmountIn.currency, currencyOut), currencyAmountIn, sdk_core_1.TradeType.EXACT_INPUT), maxNumResults, tradeComparator);
+            }
+            else if (maxHops > 1 && pools.length > 1) {
+                const poolsExcludingThisPool = pools.slice(0, i).concat(pools.slice(i + 1, pools.length));
+                // otherwise, consider all the other paths that lead from this token as long as we have not exceeded maxHops
+                await MixedRouteTrade.bestTradeExactIn(poolsExcludingThisPool, currencyAmountIn, currencyOut, {
+                    maxNumResults,
+                    maxHops: maxHops - 1,
+                }, [...currentPools, pool], amountOut, bestTrades);
+            }
+        }
+        return bestTrades;
+    }
+}
+exports.MixedRouteTrade = MixedRouteTrade;
+//# sourceMappingURL=trade.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trade.js","sourceRoot":"","sources":["../../../../../src/entities/mixedRoute/trade.ts"],"names":[],"mappings":";;;;AAAA,+CAAqH;AACrH,4CAAsC;AACtC,2CAAiE;AACjE,4CAAgD;AAChD,4EAAsC;AACtC,+CAA2C;AAC3C,mCAAuC;AACvC,2DAAiE;AAGjE;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,CAA+C,EAC/C,CAA+C;IAE/C,uDAAuD;IACvD,IAAA,wBAAS,EAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAClF,IAAA,wBAAS,EAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAC,CAAA;IACrF,IAAI,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE;QAC1C,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE;YACxC,uDAAuD;YACvD,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;YAC9E,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;YAC9E,OAAO,KAAK,GAAG,KAAK,CAAA;SACrB;QACD,mEAAmE;QACnE,IAAI,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,CAAC,CAAC,CAAA;SACV;aAAM;YACL,OAAO,CAAC,CAAA;SACT;KACF;SAAM;QACL,6DAA6D;QAC7D,IAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE;YAC3C,OAAO,CAAC,CAAA;SACT;aAAM;YACL,OAAO,CAAC,CAAC,CAAA;SACV;KACF;AACH,CAAC;AA5BD,0CA4BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,eAAe;IAC1B;;;;;;OAMG;IACH,IAAW,KAAK;QACd,IAAA,wBAAS,EAAC,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAA;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5B,CAAC;IAuBD;;OAEG;IACH,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,IAAI,CAAC,YAAY,CAAA;SACzB;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAA;QACxD,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK;aACpC,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC;aACrC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,yBAAc,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAA;QAEzF,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAA;QACxC,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAQD;;OAEG;IACH,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,OAAO,IAAI,CAAC,aAAa,CAAA;SAC1B;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAA;QAC1D,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK;aACrC,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC;aACvC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,yBAAc,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAA;QAE1F,IAAI,CAAC,aAAa,GAAG,qBAAqB,CAAA;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAQD;;OAEG;IACH,IAAW,cAAc;;QACvB,OAAO,CACL,MAAA,IAAI,CAAC,eAAe,mCACpB,CAAC,IAAI,CAAC,eAAe,GAAG,IAAI,gBAAK,CAC/B,IAAI,CAAC,WAAW,CAAC,QAAQ,EACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAC1B,IAAI,CAAC,WAAW,CAAC,QAAQ,EACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAC3B,CAAC,CACH,CAAA;IACH,CAAC;IAQD;;OAEG;IACH,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,IAAI,CAAC,YAAY,CAAA;SACzB;QAED,IAAI,gBAAgB,GAAG,yBAAc,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QAClF,KAAK,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE;YAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;YAC/B,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAA;SACrE;QAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;QACzF,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAO,CAAC,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;QAE/E,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,KAAqC,EACrC,MAAmG,EACnG,SAAqB;QAErB,MAAM,OAAO,GAA+B,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACxE,IAAI,WAAmC,CAAA;QACvC,IAAI,YAAqC,CAAA;QAEzC,IAAA,wBAAS,EAAC,SAAS,KAAK,oBAAS,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QAC5D,IAAA,wBAAS,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAA;QAEvD,OAAO,CAAC,CAAC,CAAC,GAAG,IAAA,qCAAsB,EAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC3B,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,IAAI,CAAC,eAAe,CAC/C,IAAA,qCAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAA0B,CAClE,CAAA;YACD,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,YAAY,CAAA;SAC9B;QAED,WAAW,GAAG,yBAAc,CAAC,oBAAoB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;QACpG,YAAY,GAAG,yBAAc,CAAC,oBAAoB,CAChD,KAAK,CAAC,MAAM,EACZ,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,EACrC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,CACxC,CAAA;QAED,OAAO,IAAI,eAAe,CAAC;YACzB,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;YAC9C,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAC5B,MAGG,EACH,SAAqB;QAErB,MAAM,eAAe,GAIf,EAAE,CAAA;QAER,IAAA,wBAAS,EAAC,SAAS,KAAK,oBAAS,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QAE5D,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE;YACtC,MAAM,OAAO,GAA+B,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACxE,IAAI,WAAmC,CAAA;YACvC,IAAI,YAAqC,CAAA;YAEzC,IAAA,wBAAS,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAA;YACvD,WAAW,GAAG,yBAAc,CAAC,oBAAoB,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;YACpG,OAAO,CAAC,CAAC,CAAC,GAAG,yBAAc,CAAC,oBAAoB,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;YAEvG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC3B,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,IAAI,CAAC,eAAe,CAC/C,IAAA,qCAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAA0B,CAClE,CAAA;gBACD,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,YAAY,CAAA;aAC9B;YAED,YAAY,GAAG,yBAAc,CAAC,oBAAoB,CAChD,KAAK,CAAC,MAAM,EACZ,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,EACrC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,CACxC,CAAA;YAED,eAAe,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAAA;SAC3D;QAED,OAAO,IAAI,eAAe,CAAC;YACzB,MAAM,EAAE,eAAe;YACvB,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,oBAAoB,CAIhC,oBAKD;QACC,OAAO,IAAI,eAAe,CAAC;YACzB,GAAG,oBAAoB;YACvB,MAAM,EAAE;gBACN;oBACE,WAAW,EAAE,oBAAoB,CAAC,WAAW;oBAC7C,YAAY,EAAE,oBAAoB,CAAC,YAAY;oBAC/C,KAAK,EAAE,oBAAoB,CAAC,KAAK;iBAClC;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,sCAAsC,CAIlD,oBAOD;QACC,OAAO,IAAI,eAAe,CAAC,oBAAoB,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACH,YAAoB,EAClB,MAAM,EACN,SAAS,GAQV;QACC,MAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAA;QACpD,MAAM,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAA;QACtD,IAAA,wBAAS,EACP,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAC9E,sBAAsB,CACvB,CAAA;QACD,IAAA,wBAAS,EACP,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAChF,uBAAuB,CACxB,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC,CAAA;QACrG,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAA;QAC3C,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,MAAM,EAAE;YAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE;gBAC9B,IAAI,IAAI,YAAY,aAAM,EAAE;oBAC1B,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;iBACnC;qBAAM,IAAI,IAAI,YAAY,aAAM,EAAE;oBACjC,iBAAiB,CAAC,GAAG,CAAC,aAAM,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;iBAC7E;qBAAM,IAAI,IAAI,YAAY,aAAI,EAAE;oBAC/B,MAAM,IAAI,GAAG,IAAI,CAAA;oBACjB,iBAAiB,CAAC,GAAG,CAAC,aAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;iBACjE;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;iBAChF;aACF;SACF;QAED,IAAA,wBAAS,EAAC,QAAQ,KAAK,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAA;QAElE,IAAA,wBAAS,EAAC,SAAS,KAAK,oBAAS,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QAE5D,IAAI,CAAC,KAAK,GAAG,MAAM,CAAA;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,iBAA0B,EAAE,SAAS,GAAG,IAAI,CAAC,YAAY;QAC/E,IAAA,wBAAS,EAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,gBAAI,CAAC,EAAE,oBAAoB,CAAC,CAAA;QAClE,gEAAgE;QAChE,MAAM,yBAAyB,GAAG,IAAI,mBAAQ,CAAC,eAAG,CAAC;aAChD,GAAG,CAAC,iBAAiB,CAAC;aACtB,MAAM,EAAE;aACR,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAA;QACxC,OAAO,yBAAc,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAA;IACpF,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,iBAA0B,EAAE,QAAQ,GAAG,IAAI,CAAC,WAAW;QAC5E,IAAA,wBAAS,EAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,gBAAI,CAAC,EAAE,oBAAoB,CAAC,CAAA;QAClE,OAAO,QAAQ,CAAA;QACf,gCAAgC;IAClC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,iBAA0B;QACnD,OAAO,IAAI,gBAAK,CACd,IAAI,CAAC,WAAW,CAAC,QAAQ,EACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAC1B,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAChD,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAClD,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAClC,KAAc,EACd,gBAAwC,EACxC,WAAoB,EACpB,EAAE,aAAa,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,KAAuB,EAAE;IACzD,qBAAqB;IACrB,eAAwB,EAAE,EAC1B,eAAyC,gBAAgB,EACzD,aAAwE,EAAE;QAE1E,IAAA,wBAAS,EAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;QACpC,IAAA,wBAAS,EAAC,OAAO,GAAG,CAAC,EAAE,UAAU,CAAC,CAAA;QAClC,IAAA,wBAAS,EAAC,gBAAgB,KAAK,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,mBAAmB,CAAC,CAAA;QAE5F,MAAM,QAAQ,GAAG,YAAY,CAAA;QAC7B,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,gBAAgB,GAAG,IAAI,YAAY,aAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAA;YAC7E,kBAAkB;YAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC;gBAAE,SAAQ;YAC9G,IAAI,IAAI,YAAY,aAAI,EAAE;gBACxB,IAAK,IAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAI,CAAC,IAAK,IAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAI,CAAC;oBAAE,SAAQ;aAC7F;YAED,IAAI,SAAmC,CAAA;YACvC,IAAI;gBACF,CAAC;gBAAA,CAAC,SAAS,CAAC;oBACV,IAAI,YAAY,aAAM;wBACpB,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC;wBAC9C,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,gBAAgB;gBAChB,oCAAoC;gBACpC,IAAI,KAAK,CAAC,8BAA8B,EAAE;oBACxC,SAAQ;iBACT;gBACD,MAAM,KAAK,CAAA;aACZ;YACD,sFAAsF;YACtF,IAAI,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;gBAC1D,IAAA,uBAAY,EACV,UAAU,EACV,MAAM,eAAe,CAAC,SAAS,CAC7B,IAAI,qBAAa,CAAC,CAAC,GAAG,YAAY,EAAE,IAAI,CAAC,EAAE,gBAAgB,CAAC,QAAQ,EAAE,WAAW,CAAC,EAClF,gBAAgB,EAChB,oBAAS,CAAC,WAAW,CACtB,EACD,aAAa,EACb,eAAe,CAChB,CAAA;aACF;iBAAM,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC1C,MAAM,sBAAsB,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;gBAEzF,4GAA4G;gBAC5G,MAAM,eAAe,CAAC,gBAAgB,CACpC,sBAAsB,EACtB,gBAAgB,EAChB,WAAW,EACX;oBACE,aAAa;oBACb,OAAO,EAAE,OAAO,GAAG,CAAC;iBACrB,EACD,CAAC,GAAG,YAAY,EAAE,IAAI,CAAC,EACvB,SAAS,EACT,UAAU,CACX,CAAA;aACF;SACF;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;CACF;AAvcD,0CAucC"}

package/dist/cjs/src/entities/protocol.d.ts

@@ -0,0 +1,6 @@
+export declare enum Protocol {
+    V2 = "V2",
+    V3 = "V3",
+    V4 = "V4",
+    MIXED = "MIXED"
+}

package/dist/cjs/src/entities/protocol.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Protocol = void 0;
+var Protocol;
+(function (Protocol) {
+    Protocol["V2"] = "V2";
+    Protocol["V3"] = "V3";
+    Protocol["V4"] = "V4";
+    Protocol["MIXED"] = "MIXED";
+})(Protocol = exports.Protocol || (exports.Protocol = {}));
+//# sourceMappingURL=protocol.js.map

package/dist/cjs/src/entities/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../../../src/entities/protocol.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,qBAAS,CAAA;IACT,qBAAS,CAAA;IACT,qBAAS,CAAA;IACT,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB"}

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

@@ -0,0 +1,40 @@
+import { Route as V2RouteSDK, Pair } from '@uniswap/v2-sdk';
+import { Route as V3RouteSDK, Pool as V3Pool } from '@fenine/v3-sdk';
+import { Route as V4RouteSDK, Pool as V4Pool } from '@uniswap/v4-sdk';
+import { Protocol } from './protocol';
+import { Currency, Price, Token } from '@fenine/sdk-core';
+import { MixedRouteSDK } from './mixedRoute/route';
+export declare function getPathToken(currency: Currency, pool: Pair | V3Pool): Token;
+export interface IRoute<TInput extends Currency, TOutput extends Currency, TPool extends Pair | V3Pool | V4Pool> {
+    protocol: Protocol;
+    pools: TPool[];
+    path: Currency[];
+    midPrice: Price<TInput, TOutput>;
+    input: TInput;
+    output: TOutput;
+    pathInput: Currency;
+    pathOutput: Currency;
+}
+export declare class RouteV2<TInput extends Currency, TOutput extends Currency> extends V2RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair> {
+    readonly protocol: Protocol;
+    readonly pools: Pair[];
+    pathInput: Currency;
+    pathOutput: Currency;
+    constructor(v2Route: V2RouteSDK<TInput, TOutput>);
+}
+export declare class RouteV3<TInput extends Currency, TOutput extends Currency> extends V3RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V3Pool> {
+    readonly protocol: Protocol;
+    readonly path: Token[];
+    pathInput: Currency;
+    pathOutput: Currency;
+    constructor(v3Route: V3RouteSDK<TInput, TOutput>);
+}
+export declare class RouteV4<TInput extends Currency, TOutput extends Currency> extends V4RouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, V4Pool> {
+    readonly protocol: Protocol;
+    readonly path: Currency[];
+    constructor(v4Route: V4RouteSDK<TInput, TOutput>);
+}
+export declare class MixedRoute<TInput extends Currency, TOutput extends Currency> extends MixedRouteSDK<TInput, TOutput> implements IRoute<TInput, TOutput, Pair | V3Pool | V4Pool> {
+    readonly protocol: Protocol;
+    constructor(mixedRoute: MixedRouteSDK<TInput, TOutput>);
+}

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

@@ -0,0 +1,63 @@
+"use strict";
+// entities/route.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MixedRoute = exports.RouteV4 = exports.RouteV3 = exports.RouteV2 = exports.getPathToken = void 0;
+const v2_sdk_1 = require("@uniswap/v2-sdk");
+const v3_sdk_1 = require("@fenine/v3-sdk");
+const v4_sdk_1 = require("@uniswap/v4-sdk");
+const protocol_1 = require("./protocol");
+const route_1 = require("./mixedRoute/route");
+// Helper function to get the pathInput and pathOutput for a V2 / V3 route
+// currency could be native so we check against the wrapped version as they don't support native ETH in path
+function getPathToken(currency, pool) {
+    if (pool.token0.wrapped.equals(currency.wrapped)) {
+        return pool.token0;
+    }
+    else if (pool.token1.wrapped.equals(currency.wrapped)) {
+        return pool.token1;
+    }
+    else {
+        throw new Error(`Expected token ${currency.symbol} to be either ${pool.token0.symbol} or ${pool.token1.symbol}`);
+    }
+}
+exports.getPathToken = getPathToken;
+// V2 route wrapper
+class RouteV2 extends v2_sdk_1.Route {
+    constructor(v2Route) {
+        super(v2Route.pairs, v2Route.input, v2Route.output);
+        this.protocol = protocol_1.Protocol.V2;
+        this.pools = this.pairs;
+        this.pathInput = getPathToken(v2Route.input, this.pairs[0]);
+        this.pathOutput = getPathToken(v2Route.output, this.pairs[this.pairs.length - 1]);
+    }
+}
+exports.RouteV2 = RouteV2;
+// V3 route wrapper
+class RouteV3 extends v3_sdk_1.Route {
+    constructor(v3Route) {
+        super(v3Route.pools, v3Route.input, v3Route.output);
+        this.protocol = protocol_1.Protocol.V3;
+        this.path = v3Route.tokenPath;
+        this.pathInput = getPathToken(v3Route.input, this.pools[0]);
+        this.pathOutput = getPathToken(v3Route.output, this.pools[this.pools.length - 1]);
+    }
+}
+exports.RouteV3 = RouteV3;
+// V4 route wrapper
+class RouteV4 extends v4_sdk_1.Route {
+    constructor(v4Route) {
+        super(v4Route.pools, v4Route.input, v4Route.output);
+        this.protocol = protocol_1.Protocol.V4;
+        this.path = v4Route.currencyPath;
+    }
+}
+exports.RouteV4 = RouteV4;
+// Mixed route wrapper
+class MixedRoute extends route_1.MixedRouteSDK {
+    constructor(mixedRoute) {
+        super(mixedRoute.pools, mixedRoute.input, mixedRoute.output);
+        this.protocol = protocol_1.Protocol.MIXED;
+    }
+}
+exports.MixedRoute = MixedRoute;
+//# sourceMappingURL=route.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/entities/route.ts"],"names":[],"mappings":";AAAA,oBAAoB;;;AAEpB,4CAA2D;AAC3D,2CAAoE;AACpE,4CAAqE;AACrE,yCAAqC;AAErC,8CAAkD;AAElD,0EAA0E;AAC1E,4GAA4G;AAC5G,SAAgB,YAAY,CAAC,QAAkB,EAAE,IAAmB;IAClE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QAChD,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;SAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACvD,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,kBAAkB,QAAQ,CAAC,MAAM,iBAAiB,IAAI,CAAC,MAAM,CAAC,MAAM,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;KACjH;AACH,CAAC;AARD,oCAQC;AAcD,mBAAmB;AACnB,MAAa,OACX,SAAQ,cAA2B;IAQnC,YAAY,OAAoC;QAC9C,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QANrC,aAAQ,GAAa,mBAAQ,CAAC,EAAE,CAAA;QAO9C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;IACnF,CAAC;CACF;AAfD,0BAeC;AAED,mBAAmB;AACnB,MAAa,OACX,SAAQ,cAA2B;IAQnC,YAAY,OAAoC;QAC9C,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QANrC,aAAQ,GAAa,mBAAQ,CAAC,EAAE,CAAA;QAO9C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;IACnF,CAAC;CACF;AAfD,0BAeC;AAED,mBAAmB;AACnB,MAAa,OACX,SAAQ,cAA2B;IAMnC,YAAY,OAAoC;QAC9C,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAJrC,aAAQ,GAAa,mBAAQ,CAAC,EAAE,CAAA;QAK9C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,YAAY,CAAA;IAClC,CAAC;CACF;AAXD,0BAWC;AAED,sBAAsB;AACtB,MAAa,UACX,SAAQ,qBAA8B;IAKtC,YAAY,UAA0C;QACpD,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;QAH9C,aAAQ,GAAa,mBAAQ,CAAC,KAAK,CAAA;IAInD,CAAC;CACF;AATD,gCASC"}

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

@@ -0,0 +1,136 @@
+import { Currency, CurrencyAmount, Percent, Price, TradeType } from '@fenine/sdk-core';
+import { Pair, Route as V2RouteSDK } from '@uniswap/v2-sdk';
+import { Pool as V3Pool, Route as V3RouteSDK } from '@fenine/v3-sdk';
+import { Pool as V4Pool, Route as V4RouteSDK } from '@uniswap/v4-sdk';
+import { MixedRouteSDK } from './mixedRoute/route';
+import { IRoute } from './route';
+export declare class Trade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
+    readonly routes: IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
+    readonly tradeType: TTradeType;
+    private _outputAmount;
+    private _inputAmount;
+    private _nativeInputRoutes;
+    private _wethInputRoutes;
+    /**
+     * The swaps of the trade, i.e. which routes and how much is swapped in each that
+     * make up the trade. May consist of swaps in v2 or v3.
+     */
+    readonly swaps: {
+        route: IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>;
+        inputAmount: CurrencyAmount<TInput>;
+        outputAmount: CurrencyAmount<TOutput>;
+        minHopPriceX36?: bigint[];
+    }[];
+    constructor({ v2Routes, v3Routes, v4Routes, mixedRoutes, tradeType, }: {
+        v2Routes?: {
+            routev2: V2RouteSDK<TInput, TOutput>;
+            inputAmount: CurrencyAmount<TInput>;
+            outputAmount: CurrencyAmount<TOutput>;
+            minHopPriceX36?: bigint[];
+        }[];
+        v3Routes?: {
+            routev3: V3RouteSDK<TInput, TOutput>;
+            inputAmount: CurrencyAmount<TInput>;
+            outputAmount: CurrencyAmount<TOutput>;
+            minHopPriceX36?: bigint[];
+        }[];
+        v4Routes?: {
+            routev4: V4RouteSDK<TInput, TOutput>;
+            inputAmount: CurrencyAmount<TInput>;
+            outputAmount: CurrencyAmount<TOutput>;
+            minHopPriceX36?: bigint[];
+        }[];
+        mixedRoutes?: {
+            mixedRoute: MixedRouteSDK<TInput, TOutput>;
+            inputAmount: CurrencyAmount<TInput>;
+            outputAmount: CurrencyAmount<TOutput>;
+            minHopPriceX36?: bigint[];
+        }[];
+        tradeType: TTradeType;
+    });
+    get inputAmount(): CurrencyAmount<TInput>;
+    get outputAmount(): CurrencyAmount<TOutput>;
+    /**
+     * Returns the sum of all swaps within the trade
+     * @returns
+     * inputAmount: total input amount
+     * inputAmountNative: total amount of native currency required for ETH input paths
+     *  - 0 if inputAmount is native but no native input paths
+     *  - undefined if inputAmount is not native
+     * outputAmount: total output amount
+     * outputAmountNative: total amount of native currency returned from ETH output paths
+     *  - 0 if outputAmount is native but no native output paths
+     *  - undefined if outputAmount is not native
+     */
+    get amounts(): {
+        inputAmount: CurrencyAmount<TInput>;
+        inputAmountNative: CurrencyAmount<TInput> | undefined;
+        outputAmount: CurrencyAmount<TOutput>;
+        outputAmountNative: CurrencyAmount<TOutput> | undefined;
+    };
+    get numberOfInputWraps(): number;
+    get numberOfInputUnwraps(): number;
+    get nativeInputRoutes(): IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
+    get wethInputRoutes(): IRoute<TInput, TOutput, Pair | V3Pool | V4Pool>[];
+    private _executionPrice;
+    /**
+     * The price expressed in terms of output amount/input amount.
+     */
+    get executionPrice(): Price<TInput, TOutput>;
+    /**
+     * Returns the sell tax of the input token
+     */
+    get inputTax(): Percent;
+    /**
+     * Returns the buy tax of the output token
+     */
+    get outputTax(): Percent;
+    private isWrappedNative;
+    /**
+     * The cached result of the price impact computation
+     * @private
+     */
+    private _priceImpact;
+    /**
+     * Returns the percent difference between the route's mid price and the expected execution price
+     * In order to exclude token taxes from the price impact calculation, the spot price is calculated
+     * using a ratio of values that go into the pools, which are the post-tax input amount and pre-tax output amount.
+     */
+    get priceImpact(): Percent;
+    /**
+     * 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>;
+    static fromRoutes<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(v2Routes: {
+        routev2: V2RouteSDK<TInput, TOutput>;
+        amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
+        minHopPriceX36?: bigint[];
+    }[], v3Routes: {
+        routev3: V3RouteSDK<TInput, TOutput>;
+        amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
+        minHopPriceX36?: bigint[];
+    }[], tradeType: TTradeType, mixedRoutes?: {
+        mixedRoute: MixedRouteSDK<TInput, TOutput>;
+        amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
+        minHopPriceX36?: bigint[];
+    }[], v4Routes?: {
+        routev4: V4RouteSDK<TInput, TOutput>;
+        amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>;
+        minHopPriceX36?: bigint[];
+    }[]): Promise<Trade<TInput, TOutput, TTradeType>>;
+    static fromRoute<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType>(route: V2RouteSDK<TInput, TOutput> | V3RouteSDK<TInput, TOutput> | V4RouteSDK<TInput, TOutput> | MixedRouteSDK<TInput, TOutput>, amount: TTradeType extends TradeType.EXACT_INPUT ? CurrencyAmount<TInput> : CurrencyAmount<TOutput>, tradeType: TTradeType): Promise<Trade<TInput, TOutput, TTradeType>>;
+}