v-swap-smart-order-router 3.10.2

package/build/main/routers/alpha-router/config.d.ts

@@ -0,0 +1,4 @@
+import { ChainId } from '../../util/chains';
+import { AlphaRouterConfig } from './alpha-router';
+export declare const DEFAULT_ROUTING_CONFIG_BY_CHAIN: (chainId: ChainId) => AlphaRouterConfig;
+export declare const ETH_GAS_STATION_API_URL = "https://ethgasstation.info/api/ethgasAPI.json";

package/build/main/routers/alpha-router/config.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ETH_GAS_STATION_API_URL = exports.DEFAULT_ROUTING_CONFIG_BY_CHAIN = void 0;
+const chains_1 = require("../../util/chains");
+const DEFAULT_ROUTING_CONFIG_BY_CHAIN = (chainId) => {
+    switch (chainId) {
+        // Optimism
+        case chains_1.ChainId.OPTIMISM:
+        case chains_1.ChainId.OPTIMISM_GOERLI:
+        case chains_1.ChainId.OPTIMISTIC_KOVAN:
+            return {
+                v2PoolSelection: {
+                    topN: 3,
+                    topNDirectSwaps: 1,
+                    topNTokenInOut: 5,
+                    topNSecondHop: 2,
+                    topNWithEachBaseToken: 2,
+                    topNWithBaseToken: 6,
+                },
+                v3PoolSelection: {
+                    topN: 2,
+                    topNDirectSwaps: 2,
+                    topNTokenInOut: 2,
+                    topNSecondHop: 1,
+                    topNWithEachBaseToken: 3,
+                    topNWithBaseToken: 3,
+                },
+                maxSwapsPerPath: 3,
+                minSplits: 1,
+                maxSplits: 7,
+                distributionPercent: 10,
+                forceCrossProtocol: false,
+            };
+        // Arbitrum calls have lower gas limits and tend to timeout more, which causes us to reduce the multicall
+        // batch size and send more multicalls per quote. To reduce the amount of requests each quote sends, we
+        // have to adjust the routing config so we explore fewer routes.
+        case chains_1.ChainId.ARBITRUM_ONE:
+        case chains_1.ChainId.ARBITRUM_RINKEBY:
+        case chains_1.ChainId.ARBITRUM_GOERLI:
+        case chains_1.ChainId.CELO:
+        case chains_1.ChainId.CELO_ALFAJORES:
+            return {
+                v2PoolSelection: {
+                    topN: 3,
+                    topNDirectSwaps: 1,
+                    topNTokenInOut: 5,
+                    topNSecondHop: 2,
+                    topNWithEachBaseToken: 2,
+                    topNWithBaseToken: 6,
+                },
+                v3PoolSelection: {
+                    topN: 2,
+                    topNDirectSwaps: 2,
+                    topNTokenInOut: 2,
+                    topNSecondHop: 1,
+                    topNWithEachBaseToken: 3,
+                    topNWithBaseToken: 2,
+                },
+                maxSwapsPerPath: 2,
+                minSplits: 1,
+                maxSplits: 7,
+                distributionPercent: 25,
+                forceCrossProtocol: false,
+            };
+        default:
+            return {
+                v2PoolSelection: {
+                    topN: 3,
+                    topNDirectSwaps: 1,
+                    topNTokenInOut: 5,
+                    topNSecondHop: 2,
+                    topNWithEachBaseToken: 2,
+                    topNWithBaseToken: 6,
+                },
+                v3PoolSelection: {
+                    topN: 2,
+                    topNDirectSwaps: 2,
+                    topNTokenInOut: 3,
+                    topNSecondHop: 1,
+                    topNWithEachBaseToken: 3,
+                    topNWithBaseToken: 5,
+                },
+                maxSwapsPerPath: 3,
+                minSplits: 1,
+                maxSplits: 7,
+                distributionPercent: 5,
+                forceCrossProtocol: false,
+            };
+    }
+};
+exports.DEFAULT_ROUTING_CONFIG_BY_CHAIN = DEFAULT_ROUTING_CONFIG_BY_CHAIN;
+exports.ETH_GAS_STATION_API_URL = 'https://ethgasstation.info/api/ethgasAPI.json';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3JvdXRlcnMvYWxwaGEtcm91dGVyL2NvbmZpZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw4Q0FBNEM7QUFJckMsTUFBTSwrQkFBK0IsR0FBRyxDQUM3QyxPQUFnQixFQUNHLEVBQUU7SUFDckIsUUFBUSxPQUFPLEVBQUU7UUFDZixXQUFXO1FBQ1gsS0FBSyxnQkFBTyxDQUFDLFFBQVEsQ0FBQztRQUN0QixLQUFLLGdCQUFPLENBQUMsZUFBZSxDQUFDO1FBQzdCLEtBQUssZ0JBQU8sQ0FBQyxnQkFBZ0I7WUFDM0IsT0FBTztnQkFDTCxlQUFlLEVBQUU7b0JBQ2YsSUFBSSxFQUFFLENBQUM7b0JBQ1AsZUFBZSxFQUFFLENBQUM7b0JBQ2xCLGNBQWMsRUFBRSxDQUFDO29CQUNqQixhQUFhLEVBQUUsQ0FBQztvQkFDaEIscUJBQXFCLEVBQUUsQ0FBQztvQkFDeEIsaUJBQWlCLEVBQUUsQ0FBQztpQkFDckI7Z0JBQ0QsZUFBZSxFQUFFO29CQUNmLElBQUksRUFBRSxDQUFDO29CQUNQLGVBQWUsRUFBRSxDQUFDO29CQUNsQixjQUFjLEVBQUUsQ0FBQztvQkFDakIsYUFBYSxFQUFFLENBQUM7b0JBQ2hCLHFCQUFxQixFQUFFLENBQUM7b0JBQ3hCLGlCQUFpQixFQUFFLENBQUM7aUJBQ3JCO2dCQUNELGVBQWUsRUFBRSxDQUFDO2dCQUNsQixTQUFTLEVBQUUsQ0FBQztnQkFDWixTQUFTLEVBQUUsQ0FBQztnQkFDWixtQkFBbUIsRUFBRSxFQUFFO2dCQUN2QixrQkFBa0IsRUFBRSxLQUFLO2FBQzFCLENBQUM7UUFDSix5R0FBeUc7UUFDekcsdUdBQXVHO1FBQ3ZHLGdFQUFnRTtRQUNoRSxLQUFLLGdCQUFPLENBQUMsWUFBWSxDQUFDO1FBQzFCLEtBQUssZ0JBQU8sQ0FBQyxnQkFBZ0IsQ0FBQztRQUM5QixLQUFLLGdCQUFPLENBQUMsZUFBZSxDQUFDO1FBQzdCLEtBQUssZ0JBQU8sQ0FBQyxJQUFJLENBQUM7UUFDbEIsS0FBSyxnQkFBTyxDQUFDLGNBQWM7WUFDekIsT0FBTztnQkFDTCxlQUFlLEVBQUU7b0JBQ2YsSUFBSSxFQUFFLENBQUM7b0JBQ1AsZUFBZSxFQUFFLENBQUM7b0JBQ2xCLGNBQWMsRUFBRSxDQUFDO29CQUNqQixhQUFhLEVBQUUsQ0FBQztvQkFDaEIscUJBQXFCLEVBQUUsQ0FBQztvQkFDeEIsaUJBQWlCLEVBQUUsQ0FBQztpQkFDckI7Z0JBQ0QsZUFBZSxFQUFFO29CQUNmLElBQUksRUFBRSxDQUFDO29CQUNQLGVBQWUsRUFBRSxDQUFDO29CQUNsQixjQUFjLEVBQUUsQ0FBQztvQkFDakIsYUFBYSxFQUFFLENBQUM7b0JBQ2hCLHFCQUFxQixFQUFFLENBQUM7b0JBQ3hCLGlCQUFpQixFQUFFLENBQUM7aUJBQ3JCO2dCQUNELGVBQWUsRUFBRSxDQUFDO2dCQUNsQixTQUFTLEVBQUUsQ0FBQztnQkFDWixTQUFTLEVBQUUsQ0FBQztnQkFDWixtQkFBbUIsRUFBRSxFQUFFO2dCQUN2QixrQkFBa0IsRUFBRSxLQUFLO2FBQzFCLENBQUM7UUFDSjtZQUNFLE9BQU87Z0JBQ0wsZUFBZSxFQUFFO29CQUNmLElBQUksRUFBRSxDQUFDO29CQUNQLGVBQWUsRUFBRSxDQUFDO29CQUNsQixjQUFjLEVBQUUsQ0FBQztvQkFDakIsYUFBYSxFQUFFLENBQUM7b0JBQ2hCLHFCQUFxQixFQUFFLENBQUM7b0JBQ3hCLGlCQUFpQixFQUFFLENBQUM7aUJBQ3JCO2dCQUNELGVBQWUsRUFBRTtvQkFDZixJQUFJLEVBQUUsQ0FBQztvQkFDUCxlQUFlLEVBQUUsQ0FBQztvQkFDbEIsY0FBYyxFQUFFLENBQUM7b0JBQ2pCLGFBQWEsRUFBRSxDQUFDO29CQUNoQixxQkFBcUIsRUFBRSxDQUFDO29CQUN4QixpQkFBaUIsRUFBRSxDQUFDO2lCQUNyQjtnQkFDRCxlQUFlLEVBQUUsQ0FBQztnQkFDbEIsU0FBUyxFQUFFLENBQUM7Z0JBQ1osU0FBUyxFQUFFLENBQUM7Z0JBQ1osbUJBQW1CLEVBQUUsQ0FBQztnQkFDdEIsa0JBQWtCLEVBQUUsS0FBSzthQUMxQixDQUFDO0tBQ0w7QUFDSCxDQUFDLENBQUM7QUF2RlcsUUFBQSwrQkFBK0IsbUNBdUYxQztBQUNXLFFBQUEsdUJBQXVCLEdBQ2xDLCtDQUErQyxDQUFDIn0=

package/build/main/routers/alpha-router/entities/index.d.ts

@@ -0,0 +1 @@
+export * from './route-with-valid-quote';

package/build/main/routers/alpha-router/entities/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./route-with-valid-quote"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvcm91dGVycy9hbHBoYS1yb3V0ZXIvZW50aXRpZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJEQUF5QyJ9

package/build/main/routers/alpha-router/entities/route-with-valid-quote.d.ts

@@ -0,0 +1,163 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Protocol } from '@uniswap/router-sdk';
+import { Token, TradeType } from '@uniswap/sdk-core';
+import { IV2PoolProvider } from '../../../providers/v2/pool-provider';
+import { IV3PoolProvider } from '../../../providers/v3/pool-provider';
+import { CurrencyAmount } from '../../../util/amounts';
+import { MixedRoute, V2Route, V3Route } from '../../router';
+import { IGasModel } from '../gas-models/gas-model';
+/**
+ * Represents a route, a quote for swapping some amount on it, and other
+ * metadata used by the routing algorithm.
+ *
+ * @export
+ * @interface IRouteWithValidQuote
+ * @template Route
+ */
+export interface IRouteWithValidQuote<Route extends V3Route | V2Route | MixedRoute> {
+    amount: CurrencyAmount;
+    percent: number;
+    quoteAdjustedForGas: CurrencyAmount;
+    quote: CurrencyAmount;
+    route: Route;
+    gasEstimate: BigNumber;
+    gasCostInToken: CurrencyAmount;
+    gasCostInUSD: CurrencyAmount;
+    tradeType: TradeType;
+    poolAddresses: string[];
+    tokenPath: Token[];
+}
+export declare type IV2RouteWithValidQuote = {
+    protocol: Protocol.V2;
+} & IRouteWithValidQuote<V2Route>;
+export declare type IV3RouteWithValidQuote = {
+    protocol: Protocol.V3;
+} & IRouteWithValidQuote<V3Route>;
+export declare type IMixedRouteWithValidQuote = {
+    protocol: Protocol.MIXED;
+} & IRouteWithValidQuote<MixedRoute>;
+export declare type RouteWithValidQuote = V2RouteWithValidQuote | V3RouteWithValidQuote | MixedRouteWithValidQuote;
+export declare type V2RouteWithValidQuoteParams = {
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    percent: number;
+    route: V2Route;
+    gasModel: IGasModel<V2RouteWithValidQuote>;
+    quoteToken: Token;
+    tradeType: TradeType;
+    v2PoolProvider: IV2PoolProvider;
+};
+/**
+ * Represents a quote for swapping on a V2 only route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class V2RouteWithValidQuote
+ */
+export declare class V2RouteWithValidQuote implements IV2RouteWithValidQuote {
+    readonly protocol = Protocol.V2;
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    quote: CurrencyAmount;
+    quoteAdjustedForGas: CurrencyAmount;
+    percent: number;
+    route: V2Route;
+    quoteToken: Token;
+    gasModel: IGasModel<V2RouteWithValidQuote>;
+    gasEstimate: BigNumber;
+    gasCostInToken: CurrencyAmount;
+    gasCostInUSD: CurrencyAmount;
+    tradeType: TradeType;
+    poolAddresses: string[];
+    tokenPath: Token[];
+    toString(): string;
+    constructor({ amount, rawQuote, percent, route, gasModel, quoteToken, tradeType, v2PoolProvider, }: V2RouteWithValidQuoteParams);
+}
+export declare type V3RouteWithValidQuoteParams = {
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    sqrtPriceX96AfterList: BigNumber[];
+    initializedTicksCrossedList: number[];
+    quoterGasEstimate: BigNumber;
+    percent: number;
+    route: V3Route;
+    gasModel: IGasModel<V3RouteWithValidQuote>;
+    quoteToken: Token;
+    tradeType: TradeType;
+    v3PoolProvider: IV3PoolProvider;
+};
+/**
+ * Represents a quote for swapping on a V3 only route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class V3RouteWithValidQuote
+ */
+export declare class V3RouteWithValidQuote implements IV3RouteWithValidQuote {
+    readonly protocol = Protocol.V3;
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    quote: CurrencyAmount;
+    quoteAdjustedForGas: CurrencyAmount;
+    sqrtPriceX96AfterList: BigNumber[];
+    initializedTicksCrossedList: number[];
+    quoterGasEstimate: BigNumber;
+    percent: number;
+    route: V3Route;
+    quoteToken: Token;
+    gasModel: IGasModel<V3RouteWithValidQuote>;
+    gasEstimate: BigNumber;
+    gasCostInToken: CurrencyAmount;
+    gasCostInUSD: CurrencyAmount;
+    tradeType: TradeType;
+    poolAddresses: string[];
+    tokenPath: Token[];
+    toString(): string;
+    constructor({ amount, rawQuote, sqrtPriceX96AfterList, initializedTicksCrossedList, quoterGasEstimate, percent, route, gasModel, quoteToken, tradeType, v3PoolProvider, }: V3RouteWithValidQuoteParams);
+}
+export declare type MixedRouteWithValidQuoteParams = {
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    sqrtPriceX96AfterList: BigNumber[];
+    initializedTicksCrossedList: number[];
+    quoterGasEstimate: BigNumber;
+    percent: number;
+    route: MixedRoute;
+    mixedRouteGasModel: IGasModel<MixedRouteWithValidQuote>;
+    quoteToken: Token;
+    tradeType: TradeType;
+    v3PoolProvider: IV3PoolProvider;
+    v2PoolProvider: IV2PoolProvider;
+};
+/**
+ * Represents a quote for swapping on a Mixed Route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class MixedRouteWithValidQuote
+ */
+export declare class MixedRouteWithValidQuote implements IMixedRouteWithValidQuote {
+    readonly protocol = Protocol.MIXED;
+    amount: CurrencyAmount;
+    rawQuote: BigNumber;
+    quote: CurrencyAmount;
+    quoteAdjustedForGas: CurrencyAmount;
+    sqrtPriceX96AfterList: BigNumber[];
+    initializedTicksCrossedList: number[];
+    quoterGasEstimate: BigNumber;
+    percent: number;
+    route: MixedRoute;
+    quoteToken: Token;
+    gasModel: IGasModel<MixedRouteWithValidQuote>;
+    gasEstimate: BigNumber;
+    gasCostInToken: CurrencyAmount;
+    gasCostInUSD: CurrencyAmount;
+    tradeType: TradeType;
+    poolAddresses: string[];
+    tokenPath: Token[];
+    toString(): string;
+    constructor({ amount, rawQuote, sqrtPriceX96AfterList, initializedTicksCrossedList, quoterGasEstimate, percent, route, mixedRouteGasModel, quoteToken, tradeType, v3PoolProvider, v2PoolProvider, }: MixedRouteWithValidQuoteParams);
+}

package/build/main/routers/alpha-router/entities/route-with-valid-quote.js

@@ -0,0 +1,143 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MixedRouteWithValidQuote = exports.V3RouteWithValidQuote = exports.V2RouteWithValidQuote = void 0;
+const router_sdk_1 = require("@uniswap/router-sdk");
+const sdk_core_1 = require("@uniswap/sdk-core");
+const v3_sdk_1 = require("@uniswap/v3-sdk");
+const lodash_1 = __importDefault(require("lodash"));
+const amounts_1 = require("../../../util/amounts");
+const routes_1 = require("../../../util/routes");
+/**
+ * Represents a quote for swapping on a V2 only route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class V2RouteWithValidQuote
+ */
+class V2RouteWithValidQuote {
+    constructor({ amount, rawQuote, percent, route, gasModel, quoteToken, tradeType, v2PoolProvider, }) {
+        this.protocol = router_sdk_1.Protocol.V2;
+        this.amount = amount;
+        this.rawQuote = rawQuote;
+        this.quote = amounts_1.CurrencyAmount.fromRawAmount(quoteToken, rawQuote.toString());
+        this.percent = percent;
+        this.route = route;
+        this.gasModel = gasModel;
+        this.quoteToken = quoteToken;
+        this.tradeType = tradeType;
+        const { gasEstimate, gasCostInToken, gasCostInUSD } = this.gasModel.estimateGasCost(this);
+        this.gasCostInToken = gasCostInToken;
+        this.gasCostInUSD = gasCostInUSD;
+        this.gasEstimate = gasEstimate;
+        // If its exact out, we need to request *more* of the input token to account for the gas.
+        if (this.tradeType == sdk_core_1.TradeType.EXACT_INPUT) {
+            const quoteGasAdjusted = this.quote.subtract(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        else {
+            const quoteGasAdjusted = this.quote.add(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        this.poolAddresses = lodash_1.default.map(route.pairs, (p) => v2PoolProvider.getPoolAddress(p.token0, p.token1).poolAddress);
+        this.tokenPath = this.route.path;
+    }
+    toString() {
+        return `${this.percent.toFixed(2)}% QuoteGasAdj[${this.quoteAdjustedForGas.toExact()}] Quote[${this.quote.toExact()}] Gas[${this.gasEstimate.toString()}] = ${(0, routes_1.routeToString)(this.route)}`;
+    }
+}
+exports.V2RouteWithValidQuote = V2RouteWithValidQuote;
+/**
+ * Represents a quote for swapping on a V3 only route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class V3RouteWithValidQuote
+ */
+class V3RouteWithValidQuote {
+    constructor({ amount, rawQuote, sqrtPriceX96AfterList, initializedTicksCrossedList, quoterGasEstimate, percent, route, gasModel, quoteToken, tradeType, v3PoolProvider, }) {
+        this.protocol = router_sdk_1.Protocol.V3;
+        this.amount = amount;
+        this.rawQuote = rawQuote;
+        this.sqrtPriceX96AfterList = sqrtPriceX96AfterList;
+        this.initializedTicksCrossedList = initializedTicksCrossedList;
+        this.quoterGasEstimate = quoterGasEstimate;
+        this.quote = amounts_1.CurrencyAmount.fromRawAmount(quoteToken, rawQuote.toString());
+        this.percent = percent;
+        this.route = route;
+        this.gasModel = gasModel;
+        this.quoteToken = quoteToken;
+        this.tradeType = tradeType;
+        const { gasEstimate, gasCostInToken, gasCostInUSD } = this.gasModel.estimateGasCost(this);
+        this.gasCostInToken = gasCostInToken;
+        this.gasCostInUSD = gasCostInUSD;
+        this.gasEstimate = gasEstimate;
+        // If its exact out, we need to request *more* of the input token to account for the gas.
+        if (this.tradeType == sdk_core_1.TradeType.EXACT_INPUT) {
+            const quoteGasAdjusted = this.quote.subtract(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        else {
+            const quoteGasAdjusted = this.quote.add(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        this.poolAddresses = lodash_1.default.map(route.pools, (p) => v3PoolProvider.getPoolAddress(p.token0, p.token1, p.fee).poolAddress);
+        this.tokenPath = this.route.tokenPath;
+    }
+    toString() {
+        return `${this.percent.toFixed(2)}% QuoteGasAdj[${this.quoteAdjustedForGas.toExact()}] Quote[${this.quote.toExact()}] Gas[${this.gasEstimate.toString()}] = ${(0, routes_1.routeToString)(this.route)}`;
+    }
+}
+exports.V3RouteWithValidQuote = V3RouteWithValidQuote;
+/**
+ * Represents a quote for swapping on a Mixed Route. Contains all information
+ * such as the route used, the amount specified by the user, the type of quote
+ * (exact in or exact out), the quote itself, and gas estimates.
+ *
+ * @export
+ * @class MixedRouteWithValidQuote
+ */
+class MixedRouteWithValidQuote {
+    constructor({ amount, rawQuote, sqrtPriceX96AfterList, initializedTicksCrossedList, quoterGasEstimate, percent, route, mixedRouteGasModel, quoteToken, tradeType, v3PoolProvider, v2PoolProvider, }) {
+        this.protocol = router_sdk_1.Protocol.MIXED;
+        this.amount = amount;
+        this.rawQuote = rawQuote;
+        this.sqrtPriceX96AfterList = sqrtPriceX96AfterList;
+        this.initializedTicksCrossedList = initializedTicksCrossedList;
+        this.quoterGasEstimate = quoterGasEstimate;
+        this.quote = amounts_1.CurrencyAmount.fromRawAmount(quoteToken, rawQuote.toString());
+        this.percent = percent;
+        this.route = route;
+        this.gasModel = mixedRouteGasModel;
+        this.quoteToken = quoteToken;
+        this.tradeType = tradeType;
+        const { gasEstimate, gasCostInToken, gasCostInUSD } = this.gasModel.estimateGasCost(this);
+        this.gasCostInToken = gasCostInToken;
+        this.gasCostInUSD = gasCostInUSD;
+        this.gasEstimate = gasEstimate;
+        // If its exact out, we need to request *more* of the input token to account for the gas.
+        if (this.tradeType == sdk_core_1.TradeType.EXACT_INPUT) {
+            const quoteGasAdjusted = this.quote.subtract(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        else {
+            const quoteGasAdjusted = this.quote.add(gasCostInToken);
+            this.quoteAdjustedForGas = quoteGasAdjusted;
+        }
+        this.poolAddresses = lodash_1.default.map(route.pools, (p) => {
+            return p instanceof v3_sdk_1.Pool
+                ? v3PoolProvider.getPoolAddress(p.token0, p.token1, p.fee).poolAddress
+                : v2PoolProvider.getPoolAddress(p.token0, p.token1).poolAddress;
+        });
+        this.tokenPath = this.route.path;
+    }
+    toString() {
+        return `${this.percent.toFixed(2)}% QuoteGasAdj[${this.quoteAdjustedForGas.toExact()}] Quote[${this.quote.toExact()}] Gas[${this.gasEstimate.toString()}] = ${(0, routes_1.routeToString)(this.route)}`;
+    }
+}
+exports.MixedRouteWithValidQuote = MixedRouteWithValidQuote;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGUtd2l0aC12YWxpZC1xdW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9lbnRpdGllcy9yb3V0ZS13aXRoLXZhbGlkLXF1b3RlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUNBLG9EQUErQztBQUMvQyxnREFBcUQ7QUFDckQsNENBQXVDO0FBQ3ZDLG9EQUF1QjtBQUl2QixtREFBdUQ7QUFDdkQsaURBQXFEO0FBMERyRDs7Ozs7OztHQU9HO0FBQ0gsTUFBYSxxQkFBcUI7SUEwQmhDLFlBQVksRUFDVixNQUFNLEVBQ04sUUFBUSxFQUNSLE9BQU8sRUFDUCxLQUFLLEVBQ0wsUUFBUSxFQUNSLFVBQVUsRUFDVixTQUFTLEVBQ1QsY0FBYyxHQUNjO1FBbENkLGFBQVEsR0FBRyxxQkFBUSxDQUFDLEVBQUUsQ0FBQztRQW1DckMsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7UUFDckIsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7UUFDekIsSUFBSSxDQUFDLEtBQUssR0FBRyx3QkFBYyxDQUFDLGFBQWEsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDM0UsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7UUFDbkIsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7UUFDekIsSUFBSSxDQUFDLFVBQVUsR0FBRyxVQUFVLENBQUM7UUFDN0IsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7UUFFM0IsTUFBTSxFQUFFLFdBQVcsRUFBRSxjQUFjLEVBQUUsWUFBWSxFQUFFLEdBQ2pELElBQUksQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRXRDLElBQUksQ0FBQyxjQUFjLEdBQUcsY0FBYyxDQUFDO1FBQ3JDLElBQUksQ0FBQyxZQUFZLEdBQUcsWUFBWSxDQUFDO1FBQ2pDLElBQUksQ0FBQyxXQUFXLEdBQUcsV0FBVyxDQUFDO1FBRS9CLHlGQUF5RjtRQUN6RixJQUFJLElBQUksQ0FBQyxTQUFTLElBQUksb0JBQVMsQ0FBQyxXQUFXLEVBQUU7WUFDM0MsTUFBTSxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxjQUFjLENBQUMsQ0FBQztZQUM3RCxJQUFJLENBQUMsbUJBQW1CLEdBQUcsZ0JBQWdCLENBQUM7U0FDN0M7YUFBTTtZQUNMLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDeEQsSUFBSSxDQUFDLG1CQUFtQixHQUFHLGdCQUFnQixDQUFDO1NBQzdDO1FBRUQsSUFBSSxDQUFDLGFBQWEsR0FBRyxnQkFBQyxDQUFDLEdBQUcsQ0FDeEIsS0FBSyxDQUFDLEtBQUssRUFDWCxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxXQUFXLENBQ3JFLENBQUM7UUFFRixJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDO0lBQ25DLENBQUM7SUFqRE0sUUFBUTtRQUNiLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FDNUIsQ0FBQyxDQUNGLGlCQUFpQixJQUFJLENBQUMsbUJBQW1CLENBQUMsT0FBTyxFQUFFLFdBQVcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsU0FBUyxJQUFJLENBQUMsV0FBVyxDQUFDLFFBQVEsRUFBRSxPQUFPLElBQUEsc0JBQWEsRUFDekksSUFBSSxDQUFDLEtBQUssQ0FDWCxFQUFFLENBQUM7SUFDTixDQUFDO0NBNENGO0FBcEVELHNEQW9FQztBQWdCRDs7Ozs7OztHQU9HO0FBQ0gsTUFBYSxxQkFBcUI7SUE0QmhDLFlBQVksRUFDVixNQUFNLEVBQ04sUUFBUSxFQUNSLHFCQUFxQixFQUNyQiwyQkFBMkIsRUFDM0IsaUJBQWlCLEVBQ2pCLE9BQU8sRUFDUCxLQUFLLEVBQ0wsUUFBUSxFQUNSLFVBQVUsRUFDVixTQUFTLEVBQ1QsY0FBYyxHQUNjO1FBdkNkLGFBQVEsR0FBRyxxQkFBUSxDQUFDLEVBQUUsQ0FBQztRQXdDckMsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7UUFDckIsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7UUFDekIsSUFBSSxDQUFDLHFCQUFxQixHQUFHLHFCQUFxQixDQUFDO1FBQ25ELElBQUksQ0FBQywyQkFBMkIsR0FBRywyQkFBMkIsQ0FBQztRQUMvRCxJQUFJLENBQUMsaUJBQWlCLEdBQUcsaUJBQWlCLENBQUM7UUFDM0MsSUFBSSxDQUFDLEtBQUssR0FBRyx3QkFBYyxDQUFDLGFBQWEsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDM0UsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7UUFDbkIsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7UUFDekIsSUFBSSxDQUFDLFVBQVUsR0FBRyxVQUFVLENBQUM7UUFDN0IsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7UUFFM0IsTUFBTSxFQUFFLFdBQVcsRUFBRSxjQUFjLEVBQUUsWUFBWSxFQUFFLEdBQ2pELElBQUksQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRXRDLElBQUksQ0FBQyxjQUFjLEdBQUcsY0FBYyxDQUFDO1FBQ3JDLElBQUksQ0FBQyxZQUFZLEdBQUcsWUFBWSxDQUFDO1FBQ2pDLElBQUksQ0FBQyxXQUFXLEdBQUcsV0FBVyxDQUFDO1FBRS9CLHlGQUF5RjtRQUN6RixJQUFJLElBQUksQ0FBQyxTQUFTLElBQUksb0JBQVMsQ0FBQyxXQUFXLEVBQUU7WUFDM0MsTUFBTSxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxjQUFjLENBQUMsQ0FBQztZQUM3RCxJQUFJLENBQUMsbUJBQW1CLEdBQUcsZ0JBQWdCLENBQUM7U0FDN0M7YUFBTTtZQUNMLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDeEQsSUFBSSxDQUFDLG1CQUFtQixHQUFHLGdCQUFnQixDQUFDO1NBQzdDO1FBRUQsSUFBSSxDQUFDLGFBQWEsR0FBRyxnQkFBQyxDQUFDLEdBQUcsQ0FDeEIsS0FBSyxDQUFDLEtBQUssRUFDWCxDQUFDLENBQUMsRUFBRSxFQUFFLENBQ0osY0FBYyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLFdBQVcsQ0FDdkUsQ0FBQztRQUVGLElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUM7SUFDeEMsQ0FBQztJQXhETSxRQUFRO1FBQ2IsT0FBTyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUM1QixDQUFDLENBQ0YsaUJBQWlCLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsV0FBVyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxTQUFTLElBQUksQ0FBQyxXQUFXLENBQUMsUUFBUSxFQUFFLE9BQU8sSUFBQSxzQkFBYSxFQUN6SSxJQUFJLENBQUMsS0FBSyxDQUNYLEVBQUUsQ0FBQztJQUNOLENBQUM7Q0FtREY7QUE3RUQsc0RBNkVDO0FBaUJEOzs7Ozs7O0dBT0c7QUFDSCxNQUFhLHdCQUF3QjtJQTRCbkMsWUFBWSxFQUNWLE1BQU0sRUFDTixRQUFRLEVBQ1IscUJBQXFCLEVBQ3JCLDJCQUEyQixFQUMzQixpQkFBaUIsRUFDakIsT0FBTyxFQUNQLEtBQUssRUFDTCxrQkFBa0IsRUFDbEIsVUFBVSxFQUNWLFNBQVMsRUFDVCxjQUFjLEVBQ2QsY0FBYyxHQUNpQjtRQXhDakIsYUFBUSxHQUFHLHFCQUFRLENBQUMsS0FBSyxDQUFDO1FBeUN4QyxJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztRQUNyQixJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsQ0FBQztRQUN6QixJQUFJLENBQUMscUJBQXFCLEdBQUcscUJBQXFCLENBQUM7UUFDbkQsSUFBSSxDQUFDLDJCQUEyQixHQUFHLDJCQUEyQixDQUFDO1FBQy9ELElBQUksQ0FBQyxpQkFBaUIsR0FBRyxpQkFBaUIsQ0FBQztRQUMzQyxJQUFJLENBQUMsS0FBSyxHQUFHLHdCQUFjLENBQUMsYUFBYSxDQUFDLFVBQVUsRUFBRSxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUMzRSxJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQztRQUN2QixJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztRQUNuQixJQUFJLENBQUMsUUFBUSxHQUFHLGtCQUFrQixDQUFDO1FBQ25DLElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBRTNCLE1BQU0sRUFBRSxXQUFXLEVBQUUsY0FBYyxFQUFFLFlBQVksRUFBRSxHQUNqRCxJQUFJLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUV0QyxJQUFJLENBQUMsY0FBYyxHQUFHLGNBQWMsQ0FBQztRQUNyQyxJQUFJLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztRQUNqQyxJQUFJLENBQUMsV0FBVyxHQUFHLFdBQVcsQ0FBQztRQUUvQix5RkFBeUY7UUFDekYsSUFBSSxJQUFJLENBQUMsU0FBUyxJQUFJLG9CQUFTLENBQUMsV0FBVyxFQUFFO1lBQzNDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDN0QsSUFBSSxDQUFDLG1CQUFtQixHQUFHLGdCQUFnQixDQUFDO1NBQzdDO2FBQU07WUFDTCxNQUFNLGdCQUFnQixHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQ3hELElBQUksQ0FBQyxtQkFBbUIsR0FBRyxnQkFBZ0IsQ0FBQztTQUM3QztRQUVELElBQUksQ0FBQyxhQUFhLEdBQUcsZ0JBQUMsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFO1lBQzVDLE9BQU8sQ0FBQyxZQUFZLGFBQUk7Z0JBQ3RCLENBQUMsQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsV0FBVztnQkFDdEUsQ0FBQyxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsV0FBVyxDQUFDO1FBQ3BFLENBQUMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQztJQUNuQyxDQUFDO0lBekRNLFFBQVE7UUFDYixPQUFPLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQzVCLENBQUMsQ0FDRixpQkFBaUIsSUFBSSxDQUFDLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxXQUFXLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLFNBQVMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLEVBQUUsT0FBTyxJQUFBLHNCQUFhLEVBQ3pJLElBQUksQ0FBQyxLQUFLLENBQ1gsRUFBRSxDQUFDO0lBQ04sQ0FBQztDQW9ERjtBQTlFRCw0REE4RUMifQ==

package/build/main/routers/alpha-router/functions/best-swap-route.d.ts

@@ -0,0 +1,19 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { TradeType } from '@uniswap/sdk-core';
+import { ChainId } from '../../../util';
+import { CurrencyAmount } from '../../../util/amounts';
+import { AlphaRouterConfig } from '../alpha-router';
+import { IGasModel } from '../gas-models';
+import { RouteWithValidQuote, V3RouteWithValidQuote } from './../entities/route-with-valid-quote';
+export declare type BestSwapRoute = {
+    quote: CurrencyAmount;
+    quoteGasAdjusted: CurrencyAmount;
+    estimatedGasUsed: BigNumber;
+    estimatedGasUsedUSD: CurrencyAmount;
+    estimatedGasUsedQuoteToken: CurrencyAmount;
+    routes: RouteWithValidQuote[];
+};
+export declare function getBestSwapRoute(amount: CurrencyAmount, percents: number[], routesWithValidQuotes: RouteWithValidQuote[], routeType: TradeType, chainId: ChainId, routingConfig: AlphaRouterConfig, gasModel?: IGasModel<V3RouteWithValidQuote>): Promise<BestSwapRoute | null>;
+export declare function getBestSwapRouteBy(routeType: TradeType, percentToQuotes: {
+    [percent: number]: RouteWithValidQuote[];
+}, percents: number[], chainId: ChainId, by: (routeQuote: RouteWithValidQuote) => CurrencyAmount, routingConfig: AlphaRouterConfig, gasModel?: IGasModel<V3RouteWithValidQuote>): Promise<BestSwapRoute | undefined>;