v-swap-smart-order-router 3.10.2

package/build/main/providers/v3/subgraph-provider.js

@@ -0,0 +1,145 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V3SubgraphProvider = exports.printV2SubgraphPool = exports.printV3SubgraphPool = void 0;
+const async_retry_1 = __importDefault(require("async-retry"));
+const await_timeout_1 = __importDefault(require("await-timeout"));
+const graphql_request_1 = require("graphql-request");
+const lodash_1 = __importDefault(require("lodash"));
+const util_1 = require("../../util");
+const printV3SubgraphPool = (s) => `${s.token0.id}/${s.token1.id}/${s.feeTier}`;
+exports.printV3SubgraphPool = printV3SubgraphPool;
+const printV2SubgraphPool = (s) => `${s.token0.id}/${s.token1.id}`;
+exports.printV2SubgraphPool = printV2SubgraphPool;
+const SUBGRAPH_URL_BY_CHAIN = {
+    [util_1.ChainId.MAINNET]: 'https://api.thegraph.com/subgraphs/name/uniswap/uniswap-v3',
+    [util_1.ChainId.RINKEBY]: 'https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-rinkeby',
+    [util_1.ChainId.OPTIMISM]: 'https://api.thegraph.com/subgraphs/name/ianlapham/optimism-post-regenesis',
+    [util_1.ChainId.ARBITRUM_ONE]: 'https://api.thegraph.com/subgraphs/name/ianlapham/arbitrum-minimal',
+    [util_1.ChainId.POLYGON]: 'https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-polygon',
+    [util_1.ChainId.CELO]: 'https://api.thegraph.com/subgraphs/name/jesse-sawa/uniswap-celo',
+    [util_1.ChainId.GÖRLI]: 'https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v3-gorli',
+    [util_1.ChainId.BSC]: 'https://api.thegraph.com/subgraphs/name/ilyamk/uniswap-v3---bnb-chain',
+    [util_1.ChainId.CFX]: "",
+    [util_1.ChainId.CFX_TEST]: "https://thegraph-espace.conflux123.xyz/subgraphs/name/ianlapham/uniswap-v3",
+};
+const PAGE_SIZE = 1000; // 1k is max possible query size from subgraph.
+class V3SubgraphProvider {
+    constructor(chainId, retries = 2, timeout = 30000, rollback = true) {
+        this.chainId = chainId;
+        this.retries = retries;
+        this.timeout = timeout;
+        this.rollback = rollback;
+        const subgraphUrl = SUBGRAPH_URL_BY_CHAIN[this.chainId];
+        if (!subgraphUrl) {
+            throw new Error(`No subgraph url for chain id: ${this.chainId}`);
+        }
+        this.client = new graphql_request_1.GraphQLClient(subgraphUrl);
+    }
+    async getPools(_tokenIn, _tokenOut, providerConfig) {
+        let blockNumber = (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber)
+            ? await providerConfig.blockNumber
+            : undefined;
+        const query = (0, graphql_request_1.gql) `
+      query getPools($pageSize: Int!, $id: String) {
+        pools(
+          first: $pageSize
+          ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+          where: { id_gt: $id }
+        ) {
+          id
+          token0 {
+            symbol
+            id
+          }
+          token1 {
+            symbol
+            id
+          }
+          feeTier
+          liquidity
+          totalValueLockedUSD
+          totalValueLockedETH
+        }
+      }
+    `;
+        let pools = [];
+        util_1.log.info(`Getting V3 pools from the subgraph with page size ${PAGE_SIZE}${(providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber)
+            ? ` as of block ${providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber}`
+            : ''}.`);
+        await (0, async_retry_1.default)(async () => {
+            const timeout = new await_timeout_1.default();
+            const getPools = async () => {
+                let lastId = '';
+                let pools = [];
+                let poolsPage = [];
+                do {
+                    const poolsResult = await this.client.request(query, {
+                        pageSize: PAGE_SIZE,
+                        id: lastId,
+                    });
+                    poolsPage = poolsResult.pools;
+                    pools = pools.concat(poolsPage);
+                    lastId = pools[pools.length - 1].id;
+                } while (poolsPage.length > 0);
+                return pools;
+            };
+            /* eslint-disable no-useless-catch */
+            try {
+                const getPoolsPromise = getPools();
+                const timerPromise = timeout.set(this.timeout).then(() => {
+                    throw new Error(`Timed out getting pools from subgraph: ${this.timeout}`);
+                });
+                pools = await Promise.race([getPoolsPromise, timerPromise]);
+                return;
+            }
+            catch (err) {
+                throw err;
+            }
+            finally {
+                timeout.clear();
+            }
+            /* eslint-enable no-useless-catch */
+        }, {
+            retries: this.retries,
+            onRetry: (err, retry) => {
+                if (this.rollback &&
+                    blockNumber &&
+                    lodash_1.default.includes(err.message, 'indexed up to')) {
+                    blockNumber = blockNumber - 10;
+                    util_1.log.info(`Detected subgraph indexing error. Rolled back block number to: ${blockNumber}`);
+                }
+                pools = [];
+                util_1.log.info({ err }, `Failed to get pools from subgraph. Retry attempt: ${retry}`);
+            },
+        });
+        const poolsSanitized = pools
+            .filter((pool) => parseInt(pool.liquidity) > 0 ||
+            parseFloat(pool.totalValueLockedETH) > 0.01)
+            .map((pool) => {
+            const { totalValueLockedETH, totalValueLockedUSD } = pool, rest = __rest(pool, ["totalValueLockedETH", "totalValueLockedUSD"]);
+            return Object.assign(Object.assign({}, rest), { id: pool.id.toLowerCase(), token0: {
+                    id: pool.token0.id.toLowerCase(),
+                }, token1: {
+                    id: pool.token1.id.toLowerCase(),
+                }, tvlETH: parseFloat(totalValueLockedETH), tvlUSD: parseFloat(totalValueLockedUSD) });
+        });
+        util_1.log.info(`Got ${pools.length} V3 pools from the subgraph. ${poolsSanitized.length} after filtering`);
+        return poolsSanitized;
+    }
+}
+exports.V3SubgraphProvider = V3SubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3ViZ3JhcGgtcHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL3YzL3N1YmdyYXBoLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQ0EsOERBQWdDO0FBQ2hDLGtFQUFvQztBQUNwQyxxREFBcUQ7QUFDckQsb0RBQXVCO0FBRXZCLHFDQUEwQztBQWtDbkMsTUFBTSxtQkFBbUIsR0FBRyxDQUFDLENBQWlCLEVBQUUsRUFBRSxDQUN2RCxHQUFHLENBQUMsQ0FBQyxNQUFNLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQyxNQUFNLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQztBQURsQyxRQUFBLG1CQUFtQix1QkFDZTtBQUV4QyxNQUFNLG1CQUFtQixHQUFHLENBQUMsQ0FBaUIsRUFBRSxFQUFFLENBQ3ZELEdBQUcsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFDLE1BQU0sQ0FBQyxFQUFFLEVBQUUsQ0FBQztBQURyQixRQUFBLG1CQUFtQix1QkFDRTtBQUVsQyxNQUFNLHFCQUFxQixHQUFzQztJQUMvRCxDQUFDLGNBQU8sQ0FBQyxPQUFPLENBQUMsRUFDZiw0REFBNEQ7SUFDOUQsQ0FBQyxjQUFPLENBQUMsT0FBTyxDQUFDLEVBQ2Ysc0VBQXNFO0lBQ3hFLENBQUMsY0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUNoQiwyRUFBMkU7SUFDN0UsQ0FBQyxjQUFPLENBQUMsWUFBWSxDQUFDLEVBQ3BCLG9FQUFvRTtJQUN0RSxDQUFDLGNBQU8sQ0FBQyxPQUFPLENBQUMsRUFDZixzRUFBc0U7SUFDeEUsQ0FBQyxjQUFPLENBQUMsSUFBSSxDQUFDLEVBQ1osaUVBQWlFO0lBQ25FLENBQUMsY0FBTyxDQUFDLEtBQUssQ0FBQyxFQUNiLG9FQUFvRTtJQUN0RSxDQUFDLGNBQU8sQ0FBQyxHQUFHLENBQUMsRUFDWCx1RUFBdUU7SUFDekUsQ0FBQyxjQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsRUFBRTtJQUNqQixDQUFDLGNBQU8sQ0FBQyxRQUFRLENBQUMsRUFDaEIsNEVBQTRFO0NBQy9FLENBQUM7QUFFRixNQUFNLFNBQVMsR0FBRyxJQUFJLENBQUMsQ0FBQywrQ0FBK0M7QUFnQnZFLE1BQWEsa0JBQWtCO0lBRzdCLFlBQ1UsT0FBZ0IsRUFDaEIsVUFBVSxDQUFDLEVBQ1gsVUFBVSxLQUFLLEVBQ2YsV0FBVyxJQUFJO1FBSGYsWUFBTyxHQUFQLE9BQU8sQ0FBUztRQUNoQixZQUFPLEdBQVAsT0FBTyxDQUFJO1FBQ1gsWUFBTyxHQUFQLE9BQU8sQ0FBUTtRQUNmLGFBQVEsR0FBUixRQUFRLENBQU87UUFFdkIsTUFBTSxXQUFXLEdBQUcscUJBQXFCLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3hELElBQUksQ0FBQyxXQUFXLEVBQUU7WUFDaEIsTUFBTSxJQUFJLEtBQUssQ0FBQyxpQ0FBaUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7U0FDbEU7UUFDRCxJQUFJLENBQUMsTUFBTSxHQUFHLElBQUksK0JBQWEsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUMvQyxDQUFDO0lBRU0sS0FBSyxDQUFDLFFBQVEsQ0FDbkIsUUFBZ0IsRUFDaEIsU0FBaUIsRUFDakIsY0FBK0I7UUFFL0IsSUFBSSxXQUFXLEdBQUcsQ0FBQSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsV0FBVztZQUMzQyxDQUFDLENBQUMsTUFBTSxjQUFjLENBQUMsV0FBVztZQUNsQyxDQUFDLENBQUMsU0FBUyxDQUFDO1FBRWQsTUFBTSxLQUFLLEdBQUcsSUFBQSxxQkFBRyxFQUFBOzs7O1lBSVQsV0FBVyxDQUFDLENBQUMsQ0FBQyxvQkFBb0IsV0FBVyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7OztLQWtCN0QsQ0FBQztRQUVGLElBQUksS0FBSyxHQUF3QixFQUFFLENBQUM7UUFFcEMsVUFBRyxDQUFDLElBQUksQ0FDTixxREFBcUQsU0FBUyxHQUM1RCxDQUFBLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxXQUFXO1lBQ3pCLENBQUMsQ0FBQyxnQkFBZ0IsY0FBYyxhQUFkLGNBQWMsdUJBQWQsY0FBYyxDQUFFLFdBQVcsRUFBRTtZQUMvQyxDQUFDLENBQUMsRUFDTixHQUFHLENBQ0osQ0FBQztRQUVGLE1BQU0sSUFBQSxxQkFBSyxFQUNULEtBQUssSUFBSSxFQUFFO1lBQ1QsTUFBTSxPQUFPLEdBQUcsSUFBSSx1QkFBTyxFQUFFLENBQUM7WUFFOUIsTUFBTSxRQUFRLEdBQUcsS0FBSyxJQUFrQyxFQUFFO2dCQUN4RCxJQUFJLE1BQU0sR0FBRyxFQUFFLENBQUM7Z0JBQ2hCLElBQUksS0FBSyxHQUF3QixFQUFFLENBQUM7Z0JBQ3BDLElBQUksU0FBUyxHQUF3QixFQUFFLENBQUM7Z0JBRXhDLEdBQUc7b0JBQ0QsTUFBTSxXQUFXLEdBQUcsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FFMUMsS0FBSyxFQUFFO3dCQUNSLFFBQVEsRUFBRSxTQUFTO3dCQUNuQixFQUFFLEVBQUUsTUFBTTtxQkFDWCxDQUFDLENBQUM7b0JBRUgsU0FBUyxHQUFHLFdBQVcsQ0FBQyxLQUFLLENBQUM7b0JBRTlCLEtBQUssR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxDQUFDO29CQUVoQyxNQUFNLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFFLENBQUMsRUFBRSxDQUFDO2lCQUN0QyxRQUFRLFNBQVMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO2dCQUUvQixPQUFPLEtBQUssQ0FBQztZQUNmLENBQUMsQ0FBQztZQUVGLHFDQUFxQztZQUNyQyxJQUFJO2dCQUNGLE1BQU0sZUFBZSxHQUFHLFFBQVEsRUFBRSxDQUFDO2dCQUNuQyxNQUFNLFlBQVksR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFO29CQUN2RCxNQUFNLElBQUksS0FBSyxDQUNiLDBDQUEwQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQ3pELENBQUM7Z0JBQ0osQ0FBQyxDQUFDLENBQUM7Z0JBQ0gsS0FBSyxHQUFHLE1BQU0sT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLGVBQWUsRUFBRSxZQUFZLENBQUMsQ0FBQyxDQUFDO2dCQUM1RCxPQUFPO2FBQ1I7WUFBQyxPQUFPLEdBQUcsRUFBRTtnQkFDWixNQUFNLEdBQUcsQ0FBQzthQUNYO29CQUFTO2dCQUNSLE9BQU8sQ0FBQyxLQUFLLEVBQUUsQ0FBQzthQUNqQjtZQUNELG9DQUFvQztRQUN0QyxDQUFDLEVBQ0Q7WUFDRSxPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87WUFDckIsT0FBTyxFQUFFLENBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxFQUFFO2dCQUN0QixJQUNFLElBQUksQ0FBQyxRQUFRO29CQUNiLFdBQVc7b0JBQ1gsZ0JBQUMsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxlQUFlLENBQUMsRUFDeEM7b0JBQ0EsV0FBVyxHQUFHLFdBQVcsR0FBRyxFQUFFLENBQUM7b0JBQy9CLFVBQUcsQ0FBQyxJQUFJLENBQ04sa0VBQWtFLFdBQVcsRUFBRSxDQUNoRixDQUFDO2lCQUNIO2dCQUNELEtBQUssR0FBRyxFQUFFLENBQUM7Z0JBQ1gsVUFBRyxDQUFDLElBQUksQ0FDTixFQUFFLEdBQUcsRUFBRSxFQUNQLHFEQUFxRCxLQUFLLEVBQUUsQ0FDN0QsQ0FBQztZQUNKLENBQUM7U0FDRixDQUNGLENBQUM7UUFFRixNQUFNLGNBQWMsR0FBRyxLQUFLO2FBQ3pCLE1BQU0sQ0FDTCxDQUFDLElBQUksRUFBRSxFQUFFLENBQ1AsUUFBUSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDO1lBQzVCLFVBQVUsQ0FBQyxJQUFJLENBQUMsbUJBQW1CLENBQUMsR0FBRyxJQUFJLENBQzlDO2FBQ0EsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUU7WUFDWixNQUFNLEVBQUUsbUJBQW1CLEVBQUUsbUJBQW1CLEtBQWMsSUFBSSxFQUFiLElBQUksVUFBSyxJQUFJLEVBQTVELDhDQUFxRCxDQUFPLENBQUM7WUFFbkUsdUNBQ0ssSUFBSSxLQUNQLEVBQUUsRUFBRSxJQUFJLENBQUMsRUFBRSxDQUFDLFdBQVcsRUFBRSxFQUN6QixNQUFNLEVBQUU7b0JBQ04sRUFBRSxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLFdBQVcsRUFBRTtpQkFDakMsRUFDRCxNQUFNLEVBQUU7b0JBQ04sRUFBRSxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLFdBQVcsRUFBRTtpQkFDakMsRUFDRCxNQUFNLEVBQUUsVUFBVSxDQUFDLG1CQUFtQixDQUFDLEVBQ3ZDLE1BQU0sRUFBRSxVQUFVLENBQUMsbUJBQW1CLENBQUMsSUFDdkM7UUFDSixDQUFDLENBQUMsQ0FBQztRQUVMLFVBQUcsQ0FBQyxJQUFJLENBQ04sT0FBTyxLQUFLLENBQUMsTUFBTSxnQ0FBZ0MsY0FBYyxDQUFDLE1BQU0sa0JBQWtCLENBQzNGLENBQUM7UUFFRixPQUFPLGNBQWMsQ0FBQztJQUN4QixDQUFDO0NBQ0Y7QUExSkQsZ0RBMEpDIn0=

package/build/main/providers/v3/uri-subgraph-provider.d.ts

@@ -0,0 +1,4 @@
+import { URISubgraphProvider } from '../uri-subgraph-provider';
+import { IV3SubgraphProvider, V3SubgraphPool } from './subgraph-provider';
+export declare class V3URISubgraphProvider extends URISubgraphProvider<V3SubgraphPool> implements IV3SubgraphProvider {
+}

package/build/main/providers/v3/uri-subgraph-provider.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V3URISubgraphProvider = void 0;
+const uri_subgraph_provider_1 = require("../uri-subgraph-provider");
+class V3URISubgraphProvider extends uri_subgraph_provider_1.URISubgraphProvider {
+}
+exports.V3URISubgraphProvider = V3URISubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXJpLXN1YmdyYXBoLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy92My91cmktc3ViZ3JhcGgtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsb0VBQStEO0FBSS9ELE1BQWEscUJBQ1gsU0FBUSwyQ0FBbUM7Q0FDVjtBQUZuQyxzREFFbUMifQ==

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

@@ -0,0 +1,267 @@
+import { BaseProvider } from '@ethersproject/providers';
+import { Protocol } from '@uniswap/router-sdk';
+import { Currency, TradeType } from '@uniswap/sdk-core';
+import { Position } from '@uniswap/v3-sdk';
+import { IOnChainQuoteProvider, IRouteCachingProvider, ISwapRouterProvider, IV2QuoteProvider, IV2SubgraphProvider, Simulator, UniswapMulticallProvider } from '../../providers';
+import { ITokenListProvider } from '../../providers/caching-token-list-provider';
+import { IGasPriceProvider } from '../../providers/gas-price-provider';
+import { ITokenProvider } from '../../providers/token-provider';
+import { ITokenValidatorProvider } from '../../providers/token-validator-provider';
+import { IV2PoolProvider } from '../../providers/v2/pool-provider';
+import { ArbitrumGasData, IL2GasDataProvider, OptimismGasData } from '../../providers/v3/gas-data-provider';
+import { IV3PoolProvider } from '../../providers/v3/pool-provider';
+import { IV3SubgraphProvider } from '../../providers/v3/subgraph-provider';
+import { CurrencyAmount } from '../../util/amounts';
+import { ChainId } from '../../util/chains';
+import { IRouter, ISwapToRatio, SwapAndAddConfig, SwapAndAddOptions, SwapOptions, SwapRoute, SwapToRatioResponse } from '../router';
+import { IOnChainGasModelFactory, IV2GasModelFactory } from './gas-models/gas-model';
+import { MixedQuoter, V2Quoter, V3Quoter } from './quoters';
+export declare type AlphaRouterParams = {
+    /**
+     * The chain id for this instance of the Alpha Router.
+     */
+    chainId: ChainId;
+    /**
+     * The Web3 provider for getting on-chain data.
+     */
+    provider: BaseProvider;
+    /**
+     * The provider to use for making multicalls. Used for getting on-chain data
+     * like pools, tokens, quotes in batch.
+     */
+    multicall2Provider?: UniswapMulticallProvider;
+    /**
+     * The provider for getting all pools that exist on V3 from the Subgraph. The pools
+     * from this provider are filtered during the algorithm to a set of candidate pools.
+     */
+    v3SubgraphProvider?: IV3SubgraphProvider;
+    /**
+     * The provider for getting data about V3 pools.
+     */
+    v3PoolProvider?: IV3PoolProvider;
+    /**
+     * The provider for getting V3 quotes.
+     */
+    onChainQuoteProvider?: IOnChainQuoteProvider;
+    /**
+     * The provider for getting all pools that exist on V2 from the Subgraph. The pools
+     * from this provider are filtered during the algorithm to a set of candidate pools.
+     */
+    v2SubgraphProvider?: IV2SubgraphProvider;
+    /**
+     * The provider for getting data about V2 pools.
+     */
+    v2PoolProvider?: IV2PoolProvider;
+    /**
+     * The provider for getting V3 quotes.
+     */
+    v2QuoteProvider?: IV2QuoteProvider;
+    /**
+     * The provider for getting data about Tokens.
+     */
+    tokenProvider?: ITokenProvider;
+    /**
+     * The provider for getting the current gas price to use when account for gas in the
+     * algorithm.
+     */
+    gasPriceProvider?: IGasPriceProvider;
+    /**
+     * A factory for generating a gas model that is used when estimating the gas used by
+     * V3 routes.
+     */
+    v3GasModelFactory?: IOnChainGasModelFactory;
+    /**
+     * A factory for generating a gas model that is used when estimating the gas used by
+     * V2 routes.
+     */
+    v2GasModelFactory?: IV2GasModelFactory;
+    /**
+     * A factory for generating a gas model that is used when estimating the gas used by
+     * V3 routes.
+     */
+    mixedRouteGasModelFactory?: IOnChainGasModelFactory;
+    /**
+     * A token list that specifies Token that should be blocked from routing through.
+     * Defaults to Uniswap's unsupported token list.
+     */
+    blockedTokenListProvider?: ITokenListProvider;
+    /**
+     * Calls lens function on SwapRouter02 to determine ERC20 approval types for
+     * LP position tokens.
+     */
+    swapRouterProvider?: ISwapRouterProvider;
+    /**
+     * Calls the optimism gas oracle contract to fetch constants for calculating the l1 security fee.
+     */
+    optimismGasDataProvider?: IL2GasDataProvider<OptimismGasData>;
+    /**
+     * A token validator for detecting fee-on-transfer tokens or tokens that can't be transferred.
+     */
+    tokenValidatorProvider?: ITokenValidatorProvider;
+    /**
+     * Calls the arbitrum gas data contract to fetch constants for calculating the l1 fee.
+     */
+    arbitrumGasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    /**
+     * Simulates swaps and returns new SwapRoute with updated gas estimates.
+     */
+    simulator?: Simulator;
+    /**
+     * A provider for caching the best route given an amount, quoteToken, tradeType
+     */
+    routeCachingProvider?: IRouteCachingProvider;
+};
+export declare class MapWithLowerCaseKey<V> extends Map<string, V> {
+    set(key: string, value: V): this;
+}
+/**
+ * Determines the pools that the algorithm will consider when finding the optimal swap.
+ *
+ * All pools on each protocol are filtered based on the heuristics specified here to generate
+ * the set of candidate pools. The Top N pools are taken by Total Value Locked (TVL).
+ *
+ * Higher values here result in more pools to explore which results in higher latency.
+ */
+export declare type ProtocolPoolSelection = {
+    /**
+     * The top N pools by TVL out of all pools on the protocol.
+     */
+    topN: number;
+    /**
+     * The top N pools by TVL of pools that consist of tokenIn and tokenOut.
+     */
+    topNDirectSwaps: number;
+    /**
+     * The top N pools by TVL of pools where one token is tokenIn and the
+     * top N pools by TVL of pools where one token is tokenOut tokenOut.
+     */
+    topNTokenInOut: number;
+    /**
+     * Given the topNTokenInOut pools, gets the top N pools that involve the other token.
+     * E.g. for a WETH -> USDC swap, if topNTokenInOut found WETH -> DAI and WETH -> USDT,
+     * a value of 2 would find the top 2 pools that involve DAI and top 2 pools that involve USDT.
+     */
+    topNSecondHop: number;
+    /**
+     * Given the topNTokenInOut pools and a token address,
+     * gets the top N pools that involve the other token.
+     * If token address is not on the list, we default to topNSecondHop.
+     * E.g. for a WETH -> USDC swap, if topNTokenInOut found WETH -> DAI and WETH -> USDT,
+     * and there's a mapping USDT => 4, but no mapping for DAI
+     * it would find the top 4 pools that involve USDT, and find the topNSecondHop pools that involve DAI
+     */
+    topNSecondHopForTokenAddress?: MapWithLowerCaseKey<number>;
+    /**
+     * The top N pools for token in and token out that involve a token from a list of
+     * hardcoded 'base tokens'. These are standard tokens such as WETH, USDC, DAI, etc.
+     * This is similar to how the legacy routing algorithm used by Uniswap would select
+     * pools and is intended to make the new pool selection algorithm close to a superset
+     * of the old algorithm.
+     */
+    topNWithEachBaseToken: number;
+    /**
+     * Given the topNWithEachBaseToken pools, takes the top N pools from the full list.
+     * E.g. for a WETH -> USDC swap, if topNWithEachBaseToken found WETH -0.05-> DAI,
+     * WETH -0.01-> DAI, WETH -0.05-> USDC, WETH -0.3-> USDC, a value of 2 would reduce
+     * this set to the top 2 pools from that full list.
+     */
+    topNWithBaseToken: number;
+};
+export declare type AlphaRouterConfig = {
+    /**
+     * The block number to use for all on-chain data. If not provided, the router will
+     * use the latest block returned by the provider.
+     */
+    blockNumber?: number | Promise<number>;
+    /**
+     * The protocols to consider when finding the optimal swap. If not provided all protocols
+     * will be used.
+     */
+    protocols?: Protocol[];
+    /**
+     * Config for selecting which pools to consider routing via on V2.
+     */
+    v2PoolSelection: ProtocolPoolSelection;
+    /**
+     * Config for selecting which pools to consider routing via on V3.
+     */
+    v3PoolSelection: ProtocolPoolSelection;
+    /**
+     * For each route, the maximum number of hops to consider. More hops will increase latency of the algorithm.
+     */
+    maxSwapsPerPath: number;
+    /**
+     * The maximum number of splits in the returned route. A higher maximum will increase latency of the algorithm.
+     */
+    maxSplits: number;
+    /**
+     * The minimum number of splits in the returned route.
+     * This parameters should always be set to 1. It is only included for testing purposes.
+     */
+    minSplits: number;
+    /**
+     * Forces the returned swap to route across all protocols.
+     * This parameter should always be false. It is only included for testing purposes.
+     */
+    forceCrossProtocol: boolean;
+    /**
+     * Force the alpha router to choose a mixed route swap.
+     * Default will be falsy. It is only included for testing purposes.
+     */
+    forceMixedRoutes?: boolean;
+    /**
+     * The minimum percentage of the input token to use for each route in a split route.
+     * All routes will have a multiple of this value. For example is distribution percentage is 5,
+     * a potential return swap would be:
+     *
+     * 5% of input => Route 1
+     * 55% of input => Route 2
+     * 40% of input => Route 3
+     */
+    distributionPercent: number;
+};
+export declare class AlphaRouter implements IRouter<AlphaRouterConfig>, ISwapToRatio<AlphaRouterConfig, SwapAndAddConfig> {
+    protected chainId: ChainId;
+    protected provider: BaseProvider;
+    protected multicall2Provider: UniswapMulticallProvider;
+    protected v3SubgraphProvider: IV3SubgraphProvider;
+    protected v3PoolProvider: IV3PoolProvider;
+    protected onChainQuoteProvider: IOnChainQuoteProvider;
+    protected v2SubgraphProvider: IV2SubgraphProvider;
+    protected v2QuoteProvider: IV2QuoteProvider;
+    protected v2PoolProvider: IV2PoolProvider;
+    protected tokenProvider: ITokenProvider;
+    protected gasPriceProvider: IGasPriceProvider;
+    protected swapRouterProvider: ISwapRouterProvider;
+    protected v3GasModelFactory: IOnChainGasModelFactory;
+    protected v2GasModelFactory: IV2GasModelFactory;
+    protected mixedRouteGasModelFactory: IOnChainGasModelFactory;
+    protected tokenValidatorProvider?: ITokenValidatorProvider;
+    protected blockedTokenListProvider?: ITokenListProvider;
+    protected l2GasDataProvider?: IL2GasDataProvider<OptimismGasData> | IL2GasDataProvider<ArbitrumGasData>;
+    protected simulator?: Simulator;
+    protected v2Quoter: V2Quoter;
+    protected v3Quoter: V3Quoter;
+    protected mixedQuoter: MixedQuoter;
+    protected routeCachingProvider?: IRouteCachingProvider;
+    constructor({ chainId, provider, multicall2Provider, v3PoolProvider, onChainQuoteProvider, v2PoolProvider, v2QuoteProvider, v2SubgraphProvider, tokenProvider, blockedTokenListProvider, v3SubgraphProvider, gasPriceProvider, v3GasModelFactory, v2GasModelFactory, mixedRouteGasModelFactory, swapRouterProvider, optimismGasDataProvider, tokenValidatorProvider, arbitrumGasDataProvider, simulator, routeCachingProvider, }: AlphaRouterParams);
+    routeToRatio(token0Balance: CurrencyAmount, token1Balance: CurrencyAmount, position: Position, swapAndAddConfig: SwapAndAddConfig, swapAndAddOptions?: SwapAndAddOptions, routingConfig?: Partial<AlphaRouterConfig>): Promise<SwapToRatioResponse>;
+    /**
+     * @inheritdoc IRouter
+     */
+    route(amount: CurrencyAmount, quoteCurrency: Currency, tradeType: TradeType, swapConfig?: SwapOptions, partialRoutingConfig?: Partial<AlphaRouterConfig>): Promise<SwapRoute | null>;
+    private getSwapRouteFromCache;
+    private getSwapRouteFromChain;
+    private tradeTypeStr;
+    private tokenPairSymbolTradeTypeChainId;
+    private determineCurrencyInOutFromTradeType;
+    private getGasPriceWei;
+    private getGasModels;
+    private getAmountDistribution;
+    private buildSwapAndAddMethodParameters;
+    private emitPoolSelectionMetrics;
+    private calculateOptimalRatio;
+    userHasSufficientBalance(fromAddress: string, tradeType: TradeType, amount: CurrencyAmount, quote: CurrencyAmount): Promise<boolean>;
+    private absoluteValue;
+    private getBlockNumberPromise;
+}