@ring-protocol/smart-order-router 0.5.0

package/build/module/routers/alpha-router/gas-models/v2/v2-heuristic-gas-model.js

@@ -0,0 +1,162 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import _ from 'lodash';
+import { log, WRAPPED_NATIVE_CURRENCY } from '../../../../util';
+import { CurrencyAmount } from '../../../../util/amounts';
+import { calculateL1GasFeesHelper, getV2NativePool, } from '../../../../util/gas-factory-helpers';
+import { getQuoteThroughNativePool, IV2GasModelFactory, usdGasTokensByChain, } from '../gas-model';
+// Constant cost for doing any swap regardless of pools.
+export const BASE_SWAP_COST = BigNumber.from(135000); // 115000, bumped up by 20_000 @eric 7/8/2022
+// Constant per extra hop in the route.
+export const COST_PER_EXTRA_HOP = BigNumber.from(50000); // 20000, bumped up by 30_000 @eric 7/8/2022
+/**
+ * Computes a gas estimate for a V2 swap using heuristics.
+ * Considers number of hops in the route and the typical base cost for a swap.
+ *
+ * We compute gas estimates off-chain because
+ *  1/ Calling eth_estimateGas for a swaps requires the caller to have
+ *     the full balance token being swapped, and approvals.
+ *  2/ Tracking gas used using a wrapper contract is not accurate with Multicall
+ *     due to EIP-2929. We would have to make a request for every swap we wanted to estimate.
+ *  3/ For V2 we simulate all our swaps off-chain so have no way to track gas used.
+ *
+ * Note, certain tokens e.g. rebasing/fee-on-transfer, may incur higher gas costs than
+ * what we estimate here. This is because they run extra logic on token transfer.
+ *
+ * @export
+ * @class V2HeuristicGasModelFactory
+ */
+export class V2HeuristicGasModelFactory extends IV2GasModelFactory {
+    constructor(provider) {
+        super();
+        this.provider = provider;
+    }
+    async buildGasModel({ chainId, gasPriceWei, poolProvider, token, l2GasDataProvider, providerConfig, }) {
+        const l2GasData = l2GasDataProvider
+            ? await l2GasDataProvider.getGasData(providerConfig)
+            : undefined;
+        const usdPoolPromise = this.getHighestLiquidityUSDPool(chainId, poolProvider, providerConfig);
+        // Only fetch the native gasToken pool if specified by the config AND the gas token is not the native currency.
+        const nativeAndSpecifiedGasTokenPoolPromise = (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.gasToken) &&
+            !(providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.gasToken.equals(WRAPPED_NATIVE_CURRENCY[chainId]))
+            ? this.getEthPool(chainId, providerConfig.gasToken, poolProvider, providerConfig)
+            : Promise.resolve(null);
+        const [usdPool, nativeAndSpecifiedGasTokenPool] = await Promise.all([
+            usdPoolPromise,
+            nativeAndSpecifiedGasTokenPoolPromise,
+        ]);
+        let ethPool = null;
+        if (!token.equals(WRAPPED_NATIVE_CURRENCY[chainId])) {
+            ethPool = await this.getEthPool(chainId, token, poolProvider, providerConfig);
+        }
+        const usdToken = usdPool.token0.address == WRAPPED_NATIVE_CURRENCY[chainId].address
+            ? usdPool.token1
+            : usdPool.token0;
+        const calculateL1GasFees = async (route) => {
+            const nativePool = !token.equals(WRAPPED_NATIVE_CURRENCY[chainId])
+                ? await getV2NativePool(token, poolProvider, providerConfig)
+                : null;
+            return await calculateL1GasFeesHelper(route, chainId, usdPool, token, nativePool, this.provider, l2GasData);
+        };
+        return {
+            estimateGasCost: (routeWithValidQuote) => {
+                var _a;
+                const { gasCostInEth, gasUse } = this.estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig);
+                /** ------ MARK: USD logic  -------- */
+                const gasCostInTermsOfUSD = getQuoteThroughNativePool(chainId, gasCostInEth, usdPool);
+                /** ------ MARK: Conditional logic run if gasToken is specified  -------- */
+                let gasCostInTermsOfGasToken = undefined;
+                if (nativeAndSpecifiedGasTokenPool) {
+                    gasCostInTermsOfGasToken = getQuoteThroughNativePool(chainId, gasCostInEth, nativeAndSpecifiedGasTokenPool);
+                }
+                // if the gasToken is the native currency, we can just use the gasCostInEth
+                else if ((_a = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.gasToken) === null || _a === void 0 ? void 0 : _a.equals(WRAPPED_NATIVE_CURRENCY[chainId])) {
+                    gasCostInTermsOfGasToken = gasCostInEth;
+                }
+                /** ------ MARK: return early if quoteToken is wrapped native currency ------- */
+                if (token.equals(WRAPPED_NATIVE_CURRENCY[chainId])) {
+                    return {
+                        gasEstimate: gasUse,
+                        gasCostInToken: gasCostInEth,
+                        gasCostInUSD: gasCostInTermsOfUSD,
+                        gasCostInGasToken: gasCostInTermsOfGasToken,
+                    };
+                }
+                // If the quote token is not WETH, we convert the gas cost to be in terms of the quote token.
+                // We do this by getting the highest liquidity <token>/ETH pool.
+                if (!ethPool) {
+                    log.info('Unable to find ETH pool with the quote token to produce gas adjusted costs. Route will not account for gas.');
+                    return {
+                        gasEstimate: gasUse,
+                        gasCostInToken: CurrencyAmount.fromRawAmount(token, 0),
+                        gasCostInUSD: CurrencyAmount.fromRawAmount(usdToken, 0),
+                    };
+                }
+                const gasCostInTermsOfQuoteToken = getQuoteThroughNativePool(chainId, gasCostInEth, ethPool);
+                return {
+                    gasEstimate: gasUse,
+                    gasCostInToken: gasCostInTermsOfQuoteToken,
+                    gasCostInUSD: gasCostInTermsOfUSD,
+                    gasCostInGasToken: gasCostInTermsOfGasToken,
+                };
+            },
+            calculateL1GasFees,
+        };
+    }
+    estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig) {
+        const hops = routeWithValidQuote.route.pairs.length;
+        let gasUse = BASE_SWAP_COST.add(COST_PER_EXTRA_HOP.mul(hops - 1));
+        if (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.additionalGasOverhead) {
+            gasUse = gasUse.add(providerConfig.additionalGasOverhead);
+        }
+        const totalGasCostWei = gasPriceWei.mul(gasUse);
+        const weth = WRAPPED_NATIVE_CURRENCY[chainId];
+        const gasCostInEth = CurrencyAmount.fromRawAmount(weth, totalGasCostWei.toString());
+        return { gasCostInEth, gasUse };
+    }
+    async getEthPool(chainId, token, poolProvider, providerConfig) {
+        const weth = WRAPPED_NATIVE_CURRENCY[chainId];
+        const poolAccessor = await poolProvider.getPools([[weth, token]], providerConfig);
+        const pool = poolAccessor.getPool(weth, token);
+        if (!pool || pool.reserve0.equalTo(0) || pool.reserve1.equalTo(0)) {
+            log.error({
+                weth,
+                token,
+                reserve0: pool === null || pool === void 0 ? void 0 : pool.reserve0.toExact(),
+                reserve1: pool === null || pool === void 0 ? void 0 : pool.reserve1.toExact(),
+            }, `Could not find a valid WETH pool with ${token.symbol} for computing gas costs.`);
+            return null;
+        }
+        return pool;
+    }
+    async getHighestLiquidityUSDPool(chainId, poolProvider, providerConfig) {
+        const usdTokens = usdGasTokensByChain[chainId];
+        if (!usdTokens) {
+            throw new Error(`Could not find a USD token for computing gas costs on ${chainId}`);
+        }
+        const usdPools = _.map(usdTokens, (usdToken) => [
+            usdToken,
+            WRAPPED_NATIVE_CURRENCY[chainId],
+        ]);
+        const poolAccessor = await poolProvider.getPools(usdPools, providerConfig);
+        const poolsRaw = poolAccessor.getAllPools();
+        const pools = _.filter(poolsRaw, (pool) => pool.reserve0.greaterThan(0) &&
+            pool.reserve1.greaterThan(0) &&
+            // this case should never happen in production, but when we mock the pool provider it may return non native pairs
+            (pool.token0.equals(WRAPPED_NATIVE_CURRENCY[chainId]) ||
+                pool.token1.equals(WRAPPED_NATIVE_CURRENCY[chainId])));
+        if (pools.length == 0) {
+            log.error({ pools }, `Could not find a USD/WETH pool for computing gas costs.`);
+            throw new Error(`Can't find USD/WETH pool for computing gas costs.`);
+        }
+        const maxPool = _.maxBy(pools, (pool) => {
+            if (pool.token0.equals(WRAPPED_NATIVE_CURRENCY[chainId])) {
+                return parseFloat(pool.reserve0.toSignificant(2));
+            }
+            else {
+                return parseFloat(pool.reserve1.toSignificant(2));
+            }
+        });
+        return maxPool;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidjItaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL3YyL3YyLWhldXJpc3RpYy1nYXMtbW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBR3JELE9BQU8sQ0FBQyxNQUFNLFFBQVEsQ0FBQztBQUt2QixPQUFPLEVBQUUsR0FBRyxFQUFFLHVCQUF1QixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDaEUsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQzFELE9BQU8sRUFDTCx3QkFBd0IsRUFDeEIsZUFBZSxHQUNoQixNQUFNLHNDQUFzQyxDQUFDO0FBRTlDLE9BQU8sRUFHTCx5QkFBeUIsRUFFekIsa0JBQWtCLEVBQ2xCLG1CQUFtQixHQUNwQixNQUFNLGNBQWMsQ0FBQztBQUV0Qix3REFBd0Q7QUFDeEQsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLFNBQVMsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyw2Q0FBNkM7QUFFbkcsdUNBQXVDO0FBQ3ZDLE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLFNBQVMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyw0Q0FBNEM7QUFFckc7Ozs7Ozs7Ozs7Ozs7Ozs7R0FnQkc7QUFDSCxNQUFNLE9BQU8sMEJBQTJCLFNBQVEsa0JBQWtCO0lBR2hFLFlBQVksUUFBc0I7UUFDaEMsS0FBSyxFQUFFLENBQUM7UUFDUixJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsQ0FBQztJQUMzQixDQUFDO0lBRU0sS0FBSyxDQUFDLGFBQWEsQ0FBQyxFQUN6QixPQUFPLEVBQ1AsV0FBVyxFQUNYLFlBQVksRUFDWixLQUFLLEVBQ0wsaUJBQWlCLEVBQ2pCLGNBQWMsR0FDYTtRQUMzQixNQUFNLFNBQVMsR0FBRyxpQkFBaUI7WUFDakMsQ0FBQyxDQUFDLE1BQU0saUJBQWlCLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQztZQUNwRCxDQUFDLENBQUMsU0FBUyxDQUFDO1FBRWQsTUFBTSxjQUFjLEdBQWtCLElBQUksQ0FBQywwQkFBMEIsQ0FDbkUsT0FBTyxFQUNQLFlBQVksRUFDWixjQUFjLENBQ2YsQ0FBQztRQUVGLCtHQUErRztRQUMvRyxNQUFNLHFDQUFxQyxHQUN6QyxDQUFBLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxRQUFRO1lBQ3RCLENBQUMsQ0FBQSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsUUFBUSxDQUFDLE1BQU0sQ0FBQyx1QkFBdUIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxDQUFBO1lBQ25FLENBQUMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUNmLE9BQU8sRUFDUCxjQUFjLENBQUMsUUFBUSxFQUN2QixZQUFZLEVBQ1osY0FBYyxDQUNmO1lBQ0QsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFNUIsTUFBTSxDQUFDLE9BQU8sRUFBRSw4QkFBOEIsQ0FBQyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQztZQUNsRSxjQUFjO1lBQ2QscUNBQXFDO1NBQ3RDLENBQUMsQ0FBQztRQUVILElBQUksT0FBTyxHQUFnQixJQUFJLENBQUM7UUFDaEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsdUJBQXVCLENBQUMsT0FBTyxDQUFFLENBQUMsRUFBRTtZQUNwRCxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUM3QixPQUFPLEVBQ1AsS0FBSyxFQUNMLFlBQVksRUFDWixjQUFjLENBQ2YsQ0FBQztTQUNIO1FBRUQsTUFBTSxRQUFRLEdBQ1osT0FBTyxDQUFDLE1BQU0sQ0FBQyxPQUFPLElBQUksdUJBQXVCLENBQUMsT0FBTyxDQUFFLENBQUMsT0FBTztZQUNqRSxDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU07WUFDaEIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7UUFFckIsTUFBTSxrQkFBa0IsR0FBRyxLQUFLLEVBQzlCLEtBQThCLEVBTTdCLEVBQUU7WUFDSCxNQUFNLFVBQVUsR0FBRyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsdUJBQXVCLENBQUMsT0FBTyxDQUFDLENBQUM7Z0JBQ2hFLENBQUMsQ0FBQyxNQUFNLGVBQWUsQ0FBQyxLQUFLLEVBQUUsWUFBWSxFQUFFLGNBQWMsQ0FBQztnQkFDNUQsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUVULE9BQU8sTUFBTSx3QkFBd0IsQ0FDbkMsS0FBSyxFQUNMLE9BQU8sRUFDUCxPQUFPLEVBQ1AsS0FBSyxFQUNMLFVBQVUsRUFDVixJQUFJLENBQUMsUUFBUSxFQUNiLFNBQVMsQ0FDVixDQUFDO1FBQ0osQ0FBQyxDQUFDO1FBRUYsT0FBTztZQUNMLGVBQWUsRUFBRSxDQUFDLG1CQUEwQyxFQUFFLEVBQUU7O2dCQUM5RCxNQUFNLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQy9DLG1CQUFtQixFQUNuQixXQUFXLEVBQ1gsT0FBTyxFQUNQLGNBQWMsQ0FDZixDQUFDO2dCQUVGLHVDQUF1QztnQkFDdkMsTUFBTSxtQkFBbUIsR0FBRyx5QkFBeUIsQ0FDbkQsT0FBTyxFQUNQLFlBQVksRUFDWixPQUFPLENBQ1IsQ0FBQztnQkFFRiw0RUFBNEU7Z0JBQzVFLElBQUksd0JBQXdCLEdBQStCLFNBQVMsQ0FBQztnQkFDckUsSUFBSSw4QkFBOEIsRUFBRTtvQkFDbEMsd0JBQXdCLEdBQUcseUJBQXlCLENBQ2xELE9BQU8sRUFDUCxZQUFZLEVBQ1osOEJBQThCLENBQy9CLENBQUM7aUJBQ0g7Z0JBQ0QsMkVBQTJFO3FCQUN0RSxJQUNILE1BQUEsY0FBYyxhQUFkLGNBQWMsdUJBQWQsY0FBYyxDQUFFLFFBQVEsMENBQUUsTUFBTSxDQUFDLHVCQUF1QixDQUFDLE9BQU8sQ0FBRSxDQUFDLEVBQ25FO29CQUNBLHdCQUF3QixHQUFHLFlBQVksQ0FBQztpQkFDekM7Z0JBRUQsaUZBQWlGO2dCQUNqRixJQUFJLEtBQUssQ0FBQyxNQUFNLENBQUMsdUJBQXVCLENBQUMsT0FBTyxDQUFFLENBQUMsRUFBRTtvQkFDbkQsT0FBTzt3QkFDTCxXQUFXLEVBQUUsTUFBTTt3QkFDbkIsY0FBYyxFQUFFLFlBQVk7d0JBQzVCLFlBQVksRUFBRSxtQkFBbUI7d0JBQ2pDLGlCQUFpQixFQUFFLHdCQUF3QjtxQkFDNUMsQ0FBQztpQkFDSDtnQkFFRCw2RkFBNkY7Z0JBQzdGLGdFQUFnRTtnQkFDaEUsSUFBSSxDQUFDLE9BQU8sRUFBRTtvQkFDWixHQUFHLENBQUMsSUFBSSxDQUNOLDZHQUE2RyxDQUM5RyxDQUFDO29CQUNGLE9BQU87d0JBQ0wsV0FBVyxFQUFFLE1BQU07d0JBQ25CLGNBQWMsRUFBRSxjQUFjLENBQUMsYUFBYSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUM7d0JBQ3RELFlBQVksRUFBRSxjQUFjLENBQUMsYUFBYSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7cUJBQ3hELENBQUM7aUJBQ0g7Z0JBRUQsTUFBTSwwQkFBMEIsR0FBRyx5QkFBeUIsQ0FDMUQsT0FBTyxFQUNQLFlBQVksRUFDWixPQUFPLENBQ1IsQ0FBQztnQkFFRixPQUFPO29CQUNMLFdBQVcsRUFBRSxNQUFNO29CQUNuQixjQUFjLEVBQUUsMEJBQTBCO29CQUMxQyxZQUFZLEVBQUUsbUJBQW9CO29CQUNsQyxpQkFBaUIsRUFBRSx3QkFBd0I7aUJBQzVDLENBQUM7WUFDSixDQUFDO1lBQ0Qsa0JBQWtCO1NBQ25CLENBQUM7SUFDSixDQUFDO0lBRU8sV0FBVyxDQUNqQixtQkFBMEMsRUFDMUMsV0FBc0IsRUFDdEIsT0FBZ0IsRUFDaEIsY0FBdUM7UUFFdkMsTUFBTSxJQUFJLEdBQUcsbUJBQW1CLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUM7UUFDcEQsSUFBSSxNQUFNLEdBQUcsY0FBYyxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsQ0FBQyxHQUFHLENBQUMsSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFFbEUsSUFBSSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUscUJBQXFCLEVBQUU7WUFDekMsTUFBTSxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLHFCQUFxQixDQUFDLENBQUM7U0FDM0Q7UUFFRCxNQUFNLGVBQWUsR0FBRyxXQUFXLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRWhELE1BQU0sSUFBSSxHQUFHLHVCQUF1QixDQUFDLE9BQU8sQ0FBRSxDQUFDO1FBRS9DLE1BQU0sWUFBWSxHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQy9DLElBQUksRUFDSixlQUFlLENBQUMsUUFBUSxFQUFFLENBQzNCLENBQUM7UUFFRixPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxDQUFDO0lBQ2xDLENBQUM7SUFFTyxLQUFLLENBQUMsVUFBVSxDQUN0QixPQUFnQixFQUNoQixLQUFZLEVBQ1osWUFBNkIsRUFDN0IsY0FBK0I7UUFFL0IsTUFBTSxJQUFJLEdBQUcsdUJBQXVCLENBQUMsT0FBTyxDQUFFLENBQUM7UUFFL0MsTUFBTSxZQUFZLEdBQUcsTUFBTSxZQUFZLENBQUMsUUFBUSxDQUM5QyxDQUFDLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDLEVBQ2YsY0FBYyxDQUNmLENBQUM7UUFDRixNQUFNLElBQUksR0FBRyxZQUFZLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztRQUUvQyxJQUFJLENBQUMsSUFBSSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxFQUFFO1lBQ2pFLEdBQUcsQ0FBQyxLQUFLLENBQ1A7Z0JBQ0UsSUFBSTtnQkFDSixLQUFLO2dCQUNMLFFBQVEsRUFBRSxJQUFJLGFBQUosSUFBSSx1QkFBSixJQUFJLENBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRTtnQkFDbEMsUUFBUSxFQUFFLElBQUksYUFBSixJQUFJLHVCQUFKLElBQUksQ0FBRSxRQUFRLENBQUMsT0FBTyxFQUFFO2FBQ25DLEVBQ0QseUNBQXlDLEtBQUssQ0FBQyxNQUFNLDJCQUEyQixDQUNqRixDQUFDO1lBRUYsT0FBTyxJQUFJLENBQUM7U0FDYjtRQUVELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVPLEtBQUssQ0FBQywwQkFBMEIsQ0FDdEMsT0FBZ0IsRUFDaEIsWUFBNkIsRUFDN0IsY0FBK0I7UUFFL0IsTUFBTSxTQUFTLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFL0MsSUFBSSxDQUFDLFNBQVMsRUFBRTtZQUNkLE1BQU0sSUFBSSxLQUFLLENBQ2IseURBQXlELE9BQU8sRUFBRSxDQUNuRSxDQUFDO1NBQ0g7UUFFRCxNQUFNLFFBQVEsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUF3QixTQUFTLEVBQUUsQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDO1lBQ3JFLFFBQVE7WUFDUix1QkFBdUIsQ0FBQyxPQUFPLENBQUU7U0FDbEMsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxZQUFZLEdBQUcsTUFBTSxZQUFZLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxjQUFjLENBQUMsQ0FBQztRQUMzRSxNQUFNLFFBQVEsR0FBRyxZQUFZLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDNUMsTUFBTSxLQUFLLEdBQUcsQ0FBQyxDQUFDLE1BQU0sQ0FDcEIsUUFBUSxFQUNSLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FDUCxJQUFJLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDNUIsSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQzVCLGlIQUFpSDtZQUNqSCxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLHVCQUF1QixDQUFDLE9BQU8sQ0FBRSxDQUFDO2dCQUNwRCxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyx1QkFBdUIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxDQUFDLENBQzNELENBQUM7UUFFRixJQUFJLEtBQUssQ0FBQyxNQUFNLElBQUksQ0FBQyxFQUFFO1lBQ3JCLEdBQUcsQ0FBQyxLQUFLLENBQ1AsRUFBRSxLQUFLLEVBQUUsRUFDVCx5REFBeUQsQ0FDMUQsQ0FBQztZQUNGLE1BQU0sSUFBSSxLQUFLLENBQUMsbURBQW1ELENBQUMsQ0FBQztTQUN0RTtRQUVELE1BQU0sT0FBTyxHQUFHLENBQUMsQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFLENBQUMsSUFBSSxFQUFFLEVBQUU7WUFDdEMsSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyx1QkFBdUIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxFQUFFO2dCQUN6RCxPQUFPLFVBQVUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2FBQ25EO2lCQUFNO2dCQUNMLE9BQU8sVUFBVSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7YUFDbkQ7UUFDSCxDQUFDLENBQVMsQ0FBQztRQUVYLE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7Q0FDRiJ9

package/build/module/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.d.ts

@@ -0,0 +1,26 @@
+import { V3RouteWithValidQuote } from '../../entities/route-with-valid-quote';
+import { BuildOnChainGasModelFactoryType, IGasModel } from '../gas-model';
+import { BaseProvider } from '@ethersproject/providers';
+import { TickBasedHeuristicGasModelFactory } from '../tick-based-heuristic-gas-model';
+/**
+ * Computes a gas estimate for a V3 swap using heuristics.
+ * Considers number of hops in the route, number of ticks crossed
+ * and the typical base cost for a swap.
+ *
+ * We get the number of ticks crossed in a swap from the QuoterV2
+ * contract.
+ *
+ * We compute gas estimates off-chain because
+ *  1/ Calling eth_estimateGas for a swaps requires the caller to have
+ *     the full balance token being swapped, and approvals.
+ *  2/ Tracking gas used using a wrapper contract is not accurate with Multicall
+ *     due to EIP-2929. We would have to make a request for every swap we wanted to estimate.
+ *  3/ For V2 we simulate all our swaps off-chain so have no way to track gas used.
+ *
+ * @export
+ * @class V3HeuristicGasModelFactory
+ */
+export declare class V3HeuristicGasModelFactory extends TickBasedHeuristicGasModelFactory<V3RouteWithValidQuote> {
+    constructor(provider: BaseProvider);
+    buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, v2poolProvider, l2GasDataProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<V3RouteWithValidQuote>>;
+}

package/build/module/routers/alpha-router/gas-models/v3/v3-heuristic-gas-model.js

@@ -0,0 +1,37 @@
+import { TickBasedHeuristicGasModelFactory } from '../tick-based-heuristic-gas-model';
+/**
+ * Computes a gas estimate for a V3 swap using heuristics.
+ * Considers number of hops in the route, number of ticks crossed
+ * and the typical base cost for a swap.
+ *
+ * We get the number of ticks crossed in a swap from the QuoterV2
+ * contract.
+ *
+ * We compute gas estimates off-chain because
+ *  1/ Calling eth_estimateGas for a swaps requires the caller to have
+ *     the full balance token being swapped, and approvals.
+ *  2/ Tracking gas used using a wrapper contract is not accurate with Multicall
+ *     due to EIP-2929. We would have to make a request for every swap we wanted to estimate.
+ *  3/ For V2 we simulate all our swaps off-chain so have no way to track gas used.
+ *
+ * @export
+ * @class V3HeuristicGasModelFactory
+ */
+export class V3HeuristicGasModelFactory extends TickBasedHeuristicGasModelFactory {
+    constructor(provider) {
+        super(provider);
+    }
+    async buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, v2poolProvider, l2GasDataProvider, providerConfig, }) {
+        return await super.buildGasModelInternal({
+            chainId,
+            gasPriceWei,
+            pools,
+            amountToken,
+            quoteToken,
+            v2poolProvider,
+            l2GasDataProvider,
+            providerConfig,
+        });
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidjMtaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL3YzL3YzLWhldXJpc3RpYy1nYXMtbW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBSUEsT0FBTyxFQUFFLGlDQUFpQyxFQUFFLE1BQU0sbUNBQW1DLENBQUM7QUFFdEY7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBaUJHO0FBQ0gsTUFBTSxPQUFPLDBCQUEyQixTQUFRLGlDQUF3RDtJQUN0RyxZQUFZLFFBQXNCO1FBQ2hDLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNsQixDQUFDO0lBRWUsS0FBSyxDQUFDLGFBQWEsQ0FBQyxFQUNsQyxPQUFPLEVBQ1AsV0FBVyxFQUNYLEtBQUssRUFDTCxXQUFXLEVBQ1gsVUFBVSxFQUNWLGNBQWMsRUFDZCxpQkFBaUIsRUFDakIsY0FBYyxHQUNrQjtRQUdoQyxPQUFPLE1BQU0sS0FBSyxDQUFDLHFCQUFxQixDQUFDO1lBQ3ZDLE9BQU87WUFDUCxXQUFXO1lBQ1gsS0FBSztZQUNMLFdBQVc7WUFDWCxVQUFVO1lBQ1YsY0FBYztZQUNkLGlCQUFpQjtZQUNqQixjQUFjO1NBQ2YsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztDQUNGIn0=

package/build/module/routers/alpha-router/gas-models/v4/v4-heuristic-gas-model.d.ts

@@ -0,0 +1,15 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { V4RouteWithValidQuote } from '../../entities';
+import { BuildOnChainGasModelFactoryType, GasModelProviderConfig, IGasModel, IOnChainGasModelFactory } from '../gas-model';
+import { TickBasedHeuristicGasModelFactory } from '../tick-based-heuristic-gas-model';
+import { ChainId } from '@ring-protocol/sdk-core';
+export declare class V4HeuristicGasModelFactory extends TickBasedHeuristicGasModelFactory<V4RouteWithValidQuote> implements IOnChainGasModelFactory<V4RouteWithValidQuote> {
+    constructor(provider: BaseProvider);
+    buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, v2poolProvider, l2GasDataProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<V4RouteWithValidQuote>>;
+    protected estimateGas(routeWithValidQuote: V4RouteWithValidQuote, gasPriceWei: BigNumber, chainId: ChainId, providerConfig?: GasModelProviderConfig): {
+        totalGasCostNativeCurrency: import("@ring-protocol/sdk-core").CurrencyAmount<import("@ring-protocol/sdk-core").Token>;
+        totalInitializedTicksCrossed: number;
+        baseGasUse: BigNumber;
+    };
+}

package/build/module/routers/alpha-router/gas-models/v4/v4-heuristic-gas-model.js

@@ -0,0 +1,36 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { CurrencyAmount, WRAPPED_NATIVE_CURRENCY } from '../../../../util';
+import { TickBasedHeuristicGasModelFactory } from '../tick-based-heuristic-gas-model';
+export class V4HeuristicGasModelFactory extends TickBasedHeuristicGasModelFactory {
+    constructor(provider) {
+        super(provider);
+    }
+    async buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, v2poolProvider, l2GasDataProvider, providerConfig, }) {
+        return await super.buildGasModelInternal({
+            chainId,
+            gasPriceWei,
+            pools,
+            amountToken,
+            quoteToken,
+            v2poolProvider,
+            l2GasDataProvider,
+            providerConfig,
+        });
+    }
+    estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig) {
+        var _a;
+        const totalInitializedTicksCrossed = this.totalInitializedTicksCrossed(routeWithValidQuote.initializedTicksCrossedList);
+        const baseGasUse = routeWithValidQuote.quoterGasEstimate
+            // we still need the gas override for native wrap/unwrap, because quoter doesn't simulate on universal router level
+            .add((_a = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.additionalGasOverhead) !== null && _a !== void 0 ? _a : BigNumber.from(0));
+        const baseGasCostWei = gasPriceWei.mul(baseGasUse);
+        const wrappedCurrency = WRAPPED_NATIVE_CURRENCY[chainId];
+        const totalGasCostNativeCurrency = CurrencyAmount.fromRawAmount(wrappedCurrency, baseGasCostWei.toString());
+        return {
+            totalGasCostNativeCurrency,
+            totalInitializedTicksCrossed,
+            baseGasUse,
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidjQtaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL3Y0L3Y0LWhldXJpc3RpYy1nYXMtbW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBRXJELE9BQU8sRUFBRSxjQUFjLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQVEzRSxPQUFPLEVBQUUsaUNBQWlDLEVBQUUsTUFBTSxtQ0FBbUMsQ0FBQztBQUl0RixNQUFNLE9BQU8sMEJBQ1gsU0FBUSxpQ0FBd0Q7SUFFaEUsWUFBWSxRQUFzQjtRQUNoQyxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDbEIsQ0FBQztJQUVNLEtBQUssQ0FBQyxhQUFhLENBQUMsRUFDekIsT0FBTyxFQUNQLFdBQVcsRUFDWCxLQUFLLEVBQ0wsV0FBVyxFQUNYLFVBQVUsRUFDVixjQUFjLEVBQ2QsaUJBQWlCLEVBQ2pCLGNBQWMsR0FDa0I7UUFHaEMsT0FBTyxNQUFNLEtBQUssQ0FBQyxxQkFBcUIsQ0FBQztZQUN2QyxPQUFPO1lBQ1AsV0FBVztZQUNYLEtBQUs7WUFDTCxXQUFXO1lBQ1gsVUFBVTtZQUNWLGNBQWM7WUFDZCxpQkFBaUI7WUFDakIsY0FBYztTQUNmLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFa0IsV0FBVyxDQUM1QixtQkFBMEMsRUFDMUMsV0FBc0IsRUFDdEIsT0FBZ0IsRUFDaEIsY0FBdUM7O1FBRXZDLE1BQU0sNEJBQTRCLEdBQUcsSUFBSSxDQUFDLDRCQUE0QixDQUNwRSxtQkFBbUIsQ0FBQywyQkFBMkIsQ0FDaEQsQ0FBQztRQUVGLE1BQU0sVUFBVSxHQUFHLG1CQUFtQixDQUFDLGlCQUFpQjtZQUN0RCxtSEFBbUg7YUFDbEgsR0FBRyxDQUFDLE1BQUEsY0FBYyxhQUFkLGNBQWMsdUJBQWQsY0FBYyxDQUFFLHFCQUFxQixtQ0FBSSxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFFbkUsTUFBTSxjQUFjLEdBQUcsV0FBVyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUVuRCxNQUFNLGVBQWUsR0FBRyx1QkFBdUIsQ0FBQyxPQUFPLENBQUUsQ0FBQztRQUUxRCxNQUFNLDBCQUEwQixHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQzdELGVBQWUsRUFDZixjQUFjLENBQUMsUUFBUSxFQUFFLENBQzFCLENBQUM7UUFFRixPQUFPO1lBQ0wsMEJBQTBCO1lBQzFCLDRCQUE0QjtZQUM1QixVQUFVO1NBQ1gsQ0FBQztJQUNKLENBQUM7Q0FDRiJ9

package/build/module/routers/alpha-router/index.d.ts

@@ -0,0 +1,4 @@
+export * from './alpha-router';
+export * from './entities';
+export * from './gas-models';
+export * from './quoters';

package/build/module/routers/alpha-router/index.js

@@ -0,0 +1,5 @@
+export * from './alpha-router';
+export * from './entities';
+export * from './gas-models';
+export * from './quoters';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcm91dGVycy9hbHBoYS1yb3V0ZXIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxnQkFBZ0IsQ0FBQztBQUMvQixjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFdBQVcsQ0FBQyJ9

package/build/module/routers/alpha-router/quoters/base-quoter.d.ts

@@ -0,0 +1,78 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Protocol } from '@ring-protocol/router-sdk';
+import { ChainId, Currency, TradeType } from '@ring-protocol/sdk-core';
+import { ITokenListProvider, ITokenProvider, ITokenValidatorProvider, TokenValidationResult } from '../../../providers';
+import { CurrencyAmount } from '../../../util';
+import { SupportedRoutes } from '../../router';
+import { AlphaRouterConfig } from '../alpha-router';
+import { RouteWithValidQuote } from '../entities/route-with-valid-quote';
+import { CandidatePoolsBySelectionCriteria, CrossLiquidityCandidatePools, RingFewV2CandidatePools, SupportedCandidatePools, V2CandidatePools, V3CandidatePools, V4CandidatePools } from '../functions/get-candidate-pools';
+import { IGasModel } from '../gas-models';
+import { TPool } from '@ring-protocol/router-sdk';
+import { GetQuotesResult, GetRoutesResult } from './model/results';
+/**
+ * Interface for a Quoter.
+ * Defines the base dependencies, helper methods and interface for how to fetch quotes.
+ *
+ * @abstract
+ * @template CandidatePools
+ * @template Route
+ */
+export declare abstract class BaseQuoter<CandidatePools extends SupportedCandidatePools | [
+    V4CandidatePools | undefined,
+    V3CandidatePools | undefined,
+    V2CandidatePools | undefined,
+    RingFewV2CandidatePools | undefined,
+    CrossLiquidityCandidatePools
+], Route extends SupportedRoutes, TCurrency extends Currency> {
+    protected tokenProvider: ITokenProvider;
+    protected chainId: ChainId;
+    protected protocol: Protocol;
+    protected blockedTokenListProvider?: ITokenListProvider;
+    protected tokenValidatorProvider?: ITokenValidatorProvider;
+    constructor(tokenProvider: ITokenProvider, chainId: ChainId, protocol: Protocol, blockedTokenListProvider?: ITokenListProvider, tokenValidatorProvider?: ITokenValidatorProvider);
+    /**
+     * Protected method in charge of fetching the routes for the tokenIn/tokenOut pair.
+     *
+     * @protected
+     * @abstract
+     * @param tokenIn The token that the user wants to provide
+     * @param tokenOut The token that the usaw wants to receive
+     * @param candidatePools the candidate pools that are used to generate the routes
+     * @param tradeType The type of quote the user wants. He could want to provide exactly X tokenIn or receive exactly X tokenOut
+     * @param routingConfig
+     * @returns Promise<GetRoutesResult<Route>>
+     */
+    protected abstract getRoutes(tokenIn: TCurrency, tokenOut: TCurrency, candidatePools: CandidatePools, tradeType: TradeType, routingConfig: AlphaRouterConfig): Promise<GetRoutesResult<Route>>;
+    /**
+     * Public method that will fetch quotes for the combination of every route and every amount.
+     *
+     * @param routes the list of route that can be used to fetch a quote.
+     * @param amounts the list of amounts to query for EACH route.
+     * @param percents the percentage of each amount.
+     * @param quoteToken
+     * @param tradeType
+     * @param routingConfig
+     * @param candidatePools the candidate pools that were used to generate the routes
+     * @param gasModel the gasModel to be used for estimating gas cost
+     * @param gasPriceWei instead of passing gasModel, gasPriceWei is used to generate a gasModel
+     * @returns Promise<GetQuotesResult<Route>>
+     */
+    abstract getQuotes(routes: Route[], amounts: CurrencyAmount[], percents: number[], quoteToken: TCurrency, tradeType: TradeType, routingConfig: AlphaRouterConfig, candidatePools?: CandidatePoolsBySelectionCriteria, gasModel?: IGasModel<RouteWithValidQuote>, gasPriceWei?: BigNumber): Promise<GetQuotesResult>;
+    /**
+     * Public method which would first get the routes and then get the quotes.
+     *
+     * @param tokenIn The token that the user wants to provide
+     * @param tokenOut The token that the usaw wants to receive
+     * @param amounts the list of amounts to query for EACH route.
+     * @param percents the percentage of each amount.
+     * @param quoteToken
+     * @param candidatePools
+     * @param tradeType
+     * @param routingConfig
+     * @param gasModel the gasModel to be used for estimating gas cost
+     * @param gasPriceWei instead of passing gasModel, gasPriceWei is used to generate a gasModel
+     */
+    getRoutesThenQuotes(tokenIn: TCurrency, tokenOut: TCurrency, amount: CurrencyAmount, amounts: CurrencyAmount[], percents: number[], quoteToken: TCurrency, candidatePools: CandidatePools, tradeType: TradeType, routingConfig: AlphaRouterConfig, gasModel?: IGasModel<RouteWithValidQuote>, gasPriceWei?: BigNumber): Promise<GetQuotesResult>;
+    protected applyTokenValidatorToPools<T extends TPool>(pools: T[], isInvalidFn: (token: Currency, tokenValidation: TokenValidationResult | undefined) => boolean): Promise<T[]>;
+}

package/build/module/routers/alpha-router/quoters/base-quoter.js

@@ -0,0 +1,70 @@
+import _ from 'lodash';
+import { log, metric, MetricLoggerUnit, poolToString, } from '../../../util';
+/**
+ * Interface for a Quoter.
+ * Defines the base dependencies, helper methods and interface for how to fetch quotes.
+ *
+ * @abstract
+ * @template CandidatePools
+ * @template Route
+ */
+export class BaseQuoter {
+    constructor(tokenProvider, chainId, protocol, blockedTokenListProvider, tokenValidatorProvider) {
+        this.tokenProvider = tokenProvider;
+        this.chainId = chainId;
+        this.protocol = protocol;
+        this.blockedTokenListProvider = blockedTokenListProvider;
+        this.tokenValidatorProvider = tokenValidatorProvider;
+    }
+    /**
+     * Public method which would first get the routes and then get the quotes.
+     *
+     * @param tokenIn The token that the user wants to provide
+     * @param tokenOut The token that the usaw wants to receive
+     * @param amounts the list of amounts to query for EACH route.
+     * @param percents the percentage of each amount.
+     * @param quoteToken
+     * @param candidatePools
+     * @param tradeType
+     * @param routingConfig
+     * @param gasModel the gasModel to be used for estimating gas cost
+     * @param gasPriceWei instead of passing gasModel, gasPriceWei is used to generate a gasModel
+     */
+    getRoutesThenQuotes(tokenIn, tokenOut, amount, amounts, percents, quoteToken, candidatePools, tradeType, routingConfig, gasModel, gasPriceWei) {
+        return this.getRoutes(tokenIn, tokenOut, candidatePools, tradeType, routingConfig).then((routesResult) => {
+            if (routesResult.routes.length == 1) {
+                metric.putMetric(`${this.protocol}QuoterSingleRoute`, 1, MetricLoggerUnit.Count);
+                percents = [100];
+                amounts = [amount];
+            }
+            if (routesResult.routes.length > 0) {
+                metric.putMetric(`${this.protocol}QuoterRoutesFound`, routesResult.routes.length, MetricLoggerUnit.Count);
+            }
+            else {
+                metric.putMetric(`${this.protocol}QuoterNoRoutesFound`, routesResult.routes.length, MetricLoggerUnit.Count);
+            }
+            // console.log(routesResult.routes.map((route) => route), 'routesResult.routes');
+            return this.getQuotes(routesResult.routes, amounts, percents, quoteToken, tradeType, routingConfig, routesResult.candidatePools, gasModel, gasPriceWei);
+        });
+    }
+    async applyTokenValidatorToPools(pools, isInvalidFn) {
+        if (!this.tokenValidatorProvider) {
+            return pools;
+        }
+        log.info(`Running token validator on ${pools.length} pools`);
+        const tokens = _.flatMap(pools, (pool) => [pool.token0, pool.token1]);
+        const tokenValidationResults = await this.tokenValidatorProvider.validateTokens(tokens.map((token) => token.wrapped));
+        const poolsFiltered = _.filter(pools, (pool) => {
+            const token0Validation = tokenValidationResults.getValidationByToken(pool.token0.wrapped);
+            const token1Validation = tokenValidationResults.getValidationByToken(pool.token1.wrapped);
+            const token0Invalid = isInvalidFn(pool.token0, token0Validation);
+            const token1Invalid = isInvalidFn(pool.token1, token1Validation);
+            if (token0Invalid || token1Invalid) {
+                log.info(`Dropping pool ${poolToString(pool)} because token is invalid. ${pool.token0.symbol}: ${token0Validation}, ${pool.token1.symbol}: ${token1Validation}`);
+            }
+            return !token0Invalid && !token1Invalid;
+        });
+        return poolsFiltered;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS1xdW90ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvcm91dGVycy9hbHBoYS1yb3V0ZXIvcXVvdGVycy9iYXNlLXF1b3Rlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFHQSxPQUFPLENBQUMsTUFBTSxRQUFRLENBQUM7QUFRdkIsT0FBTyxFQUVMLEdBQUcsRUFDSCxNQUFNLEVBQ04sZ0JBQWdCLEVBQ2hCLFlBQVksR0FDYixNQUFNLGVBQWUsQ0FBQztBQWtCdkI7Ozs7Ozs7R0FPRztBQUNILE1BQU0sT0FBZ0IsVUFBVTtJQW1COUIsWUFDRSxhQUE2QixFQUM3QixPQUFnQixFQUNoQixRQUFrQixFQUNsQix3QkFBNkMsRUFDN0Msc0JBQWdEO1FBRWhELElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO1FBQ25DLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO1FBQ3pCLElBQUksQ0FBQyx3QkFBd0IsR0FBRyx3QkFBd0IsQ0FBQztRQUN6RCxJQUFJLENBQUMsc0JBQXNCLEdBQUcsc0JBQXNCLENBQUM7SUFDdkQsQ0FBQztJQWdERDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0ksbUJBQW1CLENBQ3hCLE9BQWtCLEVBQ2xCLFFBQW1CLEVBQ25CLE1BQXNCLEVBQ3RCLE9BQXlCLEVBQ3pCLFFBQWtCLEVBQ2xCLFVBQXFCLEVBQ3JCLGNBQThCLEVBQzlCLFNBQW9CLEVBQ3BCLGFBQWdDLEVBQ2hDLFFBQXlDLEVBQ3pDLFdBQXVCO1FBRXZCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FDbkIsT0FBTyxFQUNQLFFBQVEsRUFDUixjQUFjLEVBQ2QsU0FBUyxFQUNULGFBQWEsQ0FDZCxDQUFDLElBQUksQ0FBQyxDQUFDLFlBQVksRUFBRSxFQUFFO1lBQ3RCLElBQUksWUFBWSxDQUFDLE1BQU0sQ0FBQyxNQUFNLElBQUksQ0FBQyxFQUFFO2dCQUNuQyxNQUFNLENBQUMsU0FBUyxDQUNkLEdBQUcsSUFBSSxDQUFDLFFBQVEsbUJBQW1CLEVBQ25DLENBQUMsRUFDRCxnQkFBZ0IsQ0FBQyxLQUFLLENBQ3ZCLENBQUM7Z0JBQ0YsUUFBUSxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7Z0JBQ2pCLE9BQU8sR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO2FBQ3BCO1lBRUQsSUFBSSxZQUFZLENBQUMsTUFBTSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7Z0JBQ2xDLE1BQU0sQ0FBQyxTQUFTLENBQ2QsR0FBRyxJQUFJLENBQUMsUUFBUSxtQkFBbUIsRUFDbkMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQzFCLGdCQUFnQixDQUFDLEtBQUssQ0FDdkIsQ0FBQzthQUNIO2lCQUFNO2dCQUNMLE1BQU0sQ0FBQyxTQUFTLENBQ2QsR0FBRyxJQUFJLENBQUMsUUFBUSxxQkFBcUIsRUFDckMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQzFCLGdCQUFnQixDQUFDLEtBQUssQ0FDdkIsQ0FBQzthQUNIO1lBRUQsaUZBQWlGO1lBQ2pGLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FDbkIsWUFBWSxDQUFDLE1BQU0sRUFDbkIsT0FBTyxFQUNQLFFBQVEsRUFDUixVQUFVLEVBQ1YsU0FBUyxFQUNULGFBQWEsRUFDYixZQUFZLENBQUMsY0FBYyxFQUMzQixRQUFRLEVBQ1IsV0FBVyxDQUNaLENBQUM7UUFDSixDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFUyxLQUFLLENBQUMsMEJBQTBCLENBQ3hDLEtBQVUsRUFDVixXQUdZO1FBRVosSUFBSSxDQUFDLElBQUksQ0FBQyxzQkFBc0IsRUFBRTtZQUNoQyxPQUFPLEtBQUssQ0FBQztTQUNkO1FBRUQsR0FBRyxDQUFDLElBQUksQ0FBQyw4QkFBOEIsS0FBSyxDQUFDLE1BQU0sUUFBUSxDQUFDLENBQUM7UUFFN0QsTUFBTSxNQUFNLEdBQUcsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztRQUV0RSxNQUFNLHNCQUFzQixHQUMxQixNQUFNLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxjQUFjLENBQzlDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FDckMsQ0FBQztRQUVKLE1BQU0sYUFBYSxHQUFHLENBQUMsQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUMsSUFBTyxFQUFFLEVBQUU7WUFDaEQsTUFBTSxnQkFBZ0IsR0FBRyxzQkFBc0IsQ0FBQyxvQkFBb0IsQ0FDbEUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQ3BCLENBQUM7WUFDRixNQUFNLGdCQUFnQixHQUFHLHNCQUFzQixDQUFDLG9CQUFvQixDQUNsRSxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FDcEIsQ0FBQztZQUVGLE1BQU0sYUFBYSxHQUFHLFdBQVcsQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGdCQUFnQixDQUFDLENBQUM7WUFDakUsTUFBTSxhQUFhLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsZ0JBQWdCLENBQUMsQ0FBQztZQUVqRSxJQUFJLGFBQWEsSUFBSSxhQUFhLEVBQUU7Z0JBQ2xDLEdBQUcsQ0FBQyxJQUFJLENBQ04saUJBQWlCLFlBQVksQ0FBQyxJQUFJLENBQUMsOEJBQThCLElBQUksQ0FBQyxNQUFNLENBQUMsTUFDN0UsS0FBSyxnQkFBZ0IsS0FBSyxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sS0FBSyxnQkFBZ0IsRUFBRSxDQUNwRSxDQUFDO2FBQ0g7WUFFRCxPQUFPLENBQUMsYUFBYSxJQUFJLENBQUMsYUFBYSxDQUFDO1FBQzFDLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxhQUFhLENBQUM7SUFDdkIsQ0FBQztDQUNGIn0=

package/build/module/routers/alpha-router/quoters/few-v2-quoter.d.ts

@@ -0,0 +1,24 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { ChainId, Token, TradeType } from '@ring-protocol/sdk-core';
+import { IRingV2PoolProvider, IRingV2QuoteProvider, IRingV2SubgraphProvider, ITokenListProvider, ITokenProvider, ITokenValidatorProvider } from '../../../providers';
+import { ArbitrumGasData, IL2GasDataProvider } from '../../../providers/v3/gas-data-provider';
+import { CurrencyAmount } from '../../../util';
+import { RingFewV2Route } from '../../router';
+import { AlphaRouterConfig } from '../alpha-router';
+import { RingFewV2RouteWithValidQuote } from '../entities';
+import { CandidatePoolsBySelectionCriteria, RingFewV2CandidatePools } from '../functions/get-candidate-pools';
+import { IRingFewV2GasModelFactory, IGasModel } from '../gas-models';
+import { BaseQuoter } from './base-quoter';
+import { GetQuotesResult } from './model/results/get-quotes-result';
+import { GetRoutesResult } from './model/results/get-routes-result';
+export declare class RingFewV2Quoter extends BaseQuoter<RingFewV2CandidatePools, RingFewV2Route, Token> {
+    protected v2SubgraphProvider: IRingV2SubgraphProvider;
+    protected v2PoolProvider: IRingV2PoolProvider;
+    protected v2QuoteProvider: IRingV2QuoteProvider;
+    protected v2GasModelFactory: IRingFewV2GasModelFactory;
+    protected l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    constructor(v2SubgraphProvider: IRingV2SubgraphProvider, v2PoolProvider: IRingV2PoolProvider, v2QuoteProvider: IRingV2QuoteProvider, v2GasModelFactory: IRingFewV2GasModelFactory, tokenProvider: ITokenProvider, chainId: ChainId, blockedTokenListProvider?: ITokenListProvider, tokenValidatorProvider?: ITokenValidatorProvider, l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>);
+    protected getRoutes(tokenIn: Token, tokenOut: Token, v2CandidatePools: RingFewV2CandidatePools, _tradeType: TradeType, routingConfig: AlphaRouterConfig): Promise<GetRoutesResult<RingFewV2Route>>;
+    getQuotes(routes: RingFewV2Route[], amounts: CurrencyAmount[], percents: number[], quoteToken: Token, tradeType: TradeType, _routingConfig: AlphaRouterConfig, candidatePools?: CandidatePoolsBySelectionCriteria, _gasModel?: IGasModel<RingFewV2RouteWithValidQuote>, gasPriceWei?: BigNumber): Promise<GetQuotesResult>;
+    refreshRoutesThenGetQuotes(tokenIn: Token, tokenOut: Token, routes: RingFewV2Route[], amounts: CurrencyAmount[], percents: number[], quoteToken: Token, tradeType: TradeType, routingConfig: AlphaRouterConfig, gasPriceWei?: BigNumber): Promise<GetQuotesResult>;
+}