@ring-protocol/smart-order-router 0.5.0

package/build/main/routers/alpha-router/gas-models/fewV2/v2-heuristic-gas-model.d.ts

@@ -0,0 +1,31 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { RingFewV2RouteWithValidQuote } from '../../entities/route-with-valid-quote';
+import { BuildRingFewV2GasModelFactoryType, IRingFewV2GasModelFactory, IRingGasModel } from '../ring-gas-model';
+export declare const BASE_SWAP_COST: BigNumber;
+export declare const COST_PER_EXTRA_HOP: BigNumber;
+/**
+ * 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 declare class RingFewV2HeuristicGasModelFactory extends IRingFewV2GasModelFactory {
+    private provider;
+    constructor(provider: BaseProvider);
+    buildGasModel({ chainId, gasPriceWei, poolProvider, token, l2GasDataProvider, providerConfig, }: BuildRingFewV2GasModelFactoryType): Promise<IRingGasModel<RingFewV2RouteWithValidQuote>>;
+    private estimateGas;
+    private getEthPool;
+    private getHighestLiquidityUSDPool;
+}

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

@@ -0,0 +1,169 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RingFewV2HeuristicGasModelFactory = exports.COST_PER_EXTRA_HOP = exports.BASE_SWAP_COST = void 0;
+const bignumber_1 = require("@ethersproject/bignumber");
+const lodash_1 = __importDefault(require("lodash"));
+const util_1 = require("../../../../util");
+const amounts_1 = require("../../../../util/amounts");
+const gas_factory_helpers_1 = require("../../../../util/gas-factory-helpers");
+const ring_gas_model_1 = require("../ring-gas-model");
+// Constant cost for doing any swap regardless of pools.
+exports.BASE_SWAP_COST = bignumber_1.BigNumber.from(135000); // 115000, bumped up by 20_000 @eric 7/8/2022
+// Constant per extra hop in the route.
+exports.COST_PER_EXTRA_HOP = bignumber_1.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
+ */
+class RingFewV2HeuristicGasModelFactory extends ring_gas_model_1.IRingFewV2GasModelFactory {
+    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(util_1.FEW_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(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId])) {
+            ethPool = await this.getEthPool(chainId, token, poolProvider, providerConfig);
+        }
+        const usdToken = usdPool.token0.address == util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId].address
+            ? usdPool.token1
+            : usdPool.token0;
+        const calculateL1GasFees = async (route) => {
+            const nativePool = !token.equals(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId])
+                ? await (0, gas_factory_helpers_1.getRingFewV2NativePool)(token, poolProvider, providerConfig)
+                : null;
+            return await (0, gas_factory_helpers_1.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 = (0, ring_gas_model_1.getRingQuoteThroughNativePool)(chainId, gasCostInEth, usdPool);
+                /** ------ MARK: Conditional logic run if gasToken is specified  -------- */
+                let gasCostInTermsOfGasToken = undefined;
+                if (nativeAndSpecifiedGasTokenPool) {
+                    gasCostInTermsOfGasToken = (0, ring_gas_model_1.getRingQuoteThroughNativePool)(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(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId])) {
+                    gasCostInTermsOfGasToken = gasCostInEth;
+                }
+                /** ------ MARK: return early if quoteToken is wrapped native currency ------- */
+                if (token.equals(util_1.FEW_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) {
+                    util_1.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: amounts_1.CurrencyAmount.fromRawAmount(token, 0),
+                        gasCostInUSD: amounts_1.CurrencyAmount.fromRawAmount(usdToken, 0),
+                    };
+                }
+                const gasCostInTermsOfQuoteToken = (0, ring_gas_model_1.getRingQuoteThroughNativePool)(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 = exports.BASE_SWAP_COST.add(exports.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 = util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId];
+        const gasCostInEth = amounts_1.CurrencyAmount.fromRawAmount(weth, totalGasCostWei.toString());
+        return { gasCostInEth, gasUse };
+    }
+    async getEthPool(chainId, token, poolProvider, providerConfig) {
+        const weth = util_1.FEW_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)) {
+            util_1.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 = ring_gas_model_1.ringUsdGasTokensByChain[chainId];
+        if (!usdTokens) {
+            throw new Error(`Could not find a USD token for computing gas costs on ${chainId}`);
+        }
+        const usdPools = lodash_1.default.map(usdTokens, (usdToken) => [
+            usdToken,
+            util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId],
+        ]);
+        const poolAccessor = await poolProvider.getPools(usdPools, providerConfig);
+        const poolsRaw = poolAccessor.getAllPools();
+        const pools = lodash_1.default.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(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId]) ||
+                pool.token1.equals(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId])));
+        if (pools.length == 0) {
+            util_1.log.error({ pools }, `Could not find a USD/WETH pool for computing gas costs.`);
+            throw new Error(`Can't find fwUSD/fwWETH pool for computing gas costs.`);
+        }
+        const maxPool = lodash_1.default.maxBy(pools, (pool) => {
+            if (pool.token0.equals(util_1.FEW_WRAPPED_NATIVE_CURRENCY[chainId])) {
+                return parseFloat(pool.reserve0.toSignificant(2));
+            }
+            else {
+                return parseFloat(pool.reserve1.toSignificant(2));
+            }
+        });
+        return maxPool;
+    }
+}
+exports.RingFewV2HeuristicGasModelFactory = RingFewV2HeuristicGasModelFactory;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidjItaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL2Zld1YyL3YyLWhldXJpc3RpYy1nYXMtbW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsd0RBQXFEO0FBR3JELG9EQUF1QjtBQUt2QiwyQ0FBb0U7QUFDcEUsc0RBQTBEO0FBQzFELDhFQUc4QztBQUU5QyxzREFPMkI7QUFFM0Isd0RBQXdEO0FBQzNDLFFBQUEsY0FBYyxHQUFHLHFCQUFTLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsNkNBQTZDO0FBRW5HLHVDQUF1QztBQUMxQixRQUFBLGtCQUFrQixHQUFHLHFCQUFTLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsNENBQTRDO0FBRXJHOzs7Ozs7Ozs7Ozs7Ozs7O0dBZ0JHO0FBQ0gsTUFBYSxpQ0FBa0MsU0FBUSwwQ0FBeUI7SUFHOUUsWUFBWSxRQUFzQjtRQUNoQyxLQUFLLEVBQUUsQ0FBQztRQUNSLElBQUksQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO0lBQzNCLENBQUM7SUFFTSxLQUFLLENBQUMsYUFBYSxDQUFDLEVBQ3pCLE9BQU8sRUFDUCxXQUFXLEVBQ1gsWUFBWSxFQUNaLEtBQUssRUFDTCxpQkFBaUIsRUFDakIsY0FBYyxHQUNvQjtRQUNsQyxNQUFNLFNBQVMsR0FBRyxpQkFBaUI7WUFDakMsQ0FBQyxDQUFDLE1BQU0saUJBQWlCLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQztZQUNwRCxDQUFDLENBQUMsU0FBUyxDQUFDO1FBRWQsTUFBTSxjQUFjLEdBQWtCLElBQUksQ0FBQywwQkFBMEIsQ0FDbkUsT0FBTyxFQUNQLFlBQVksRUFDWixjQUFjLENBQ2YsQ0FBQztRQUVGLCtHQUErRztRQUMvRyxNQUFNLHFDQUFxQyxHQUN6QyxDQUFBLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxRQUFRO1lBQ3RCLENBQUMsQ0FBQSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsUUFBUSxDQUFDLE1BQU0sQ0FBQyxrQ0FBMkIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxDQUFBO1lBQ3ZFLENBQUMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUNmLE9BQU8sRUFDUCxjQUFjLENBQUMsUUFBUSxFQUN2QixZQUFZLEVBQ1osY0FBYyxDQUNmO1lBQ0QsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFNUIsTUFBTSxDQUFDLE9BQU8sRUFBRSw4QkFBOEIsQ0FBQyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQztZQUNsRSxjQUFjO1lBQ2QscUNBQXFDO1NBQ3RDLENBQUMsQ0FBQztRQUVILElBQUksT0FBTyxHQUFnQixJQUFJLENBQUM7UUFDaEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsa0NBQTJCLENBQUMsT0FBTyxDQUFFLENBQUMsRUFBRTtZQUN4RCxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUM3QixPQUFPLEVBQ1AsS0FBSyxFQUNMLFlBQVksRUFDWixjQUFjLENBQ2YsQ0FBQztTQUNIO1FBRUQsTUFBTSxRQUFRLEdBQ1osT0FBTyxDQUFDLE1BQU0sQ0FBQyxPQUFPLElBQUksa0NBQTJCLENBQUMsT0FBTyxDQUFFLENBQUMsT0FBTztZQUNyRSxDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU07WUFDaEIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7UUFFckIsTUFBTSxrQkFBa0IsR0FBRyxLQUFLLEVBQzlCLEtBQXFDLEVBTXBDLEVBQUU7WUFDSCxNQUFNLFVBQVUsR0FBRyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsa0NBQTJCLENBQUMsT0FBTyxDQUFFLENBQUM7Z0JBQ3JFLENBQUMsQ0FBQyxNQUFNLElBQUEsNENBQXNCLEVBQUMsS0FBSyxFQUFFLFlBQVksRUFBRSxjQUFjLENBQUM7Z0JBQ25FLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFFVCxPQUFPLE1BQU0sSUFBQSw4Q0FBd0IsRUFDbkMsS0FBSyxFQUNMLE9BQU8sRUFDUCxPQUFPLEVBQ1AsS0FBSyxFQUNMLFVBQVUsRUFDVixJQUFJLENBQUMsUUFBUSxFQUNiLFNBQVMsQ0FDVixDQUFDO1FBQ0osQ0FBQyxDQUFDO1FBRUYsT0FBTztZQUNMLGVBQWUsRUFBRSxDQUFDLG1CQUFpRCxFQUFFLEVBQUU7O2dCQUNyRSxNQUFNLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQy9DLG1CQUFtQixFQUNuQixXQUFXLEVBQ1gsT0FBTyxFQUNQLGNBQWMsQ0FDZixDQUFDO2dCQUVGLHVDQUF1QztnQkFDdkMsTUFBTSxtQkFBbUIsR0FBRyxJQUFBLDhDQUE2QixFQUN2RCxPQUFPLEVBQ1AsWUFBWSxFQUNaLE9BQU8sQ0FDUixDQUFDO2dCQUVGLDRFQUE0RTtnQkFDNUUsSUFBSSx3QkFBd0IsR0FBK0IsU0FBUyxDQUFDO2dCQUNyRSxJQUFJLDhCQUE4QixFQUFFO29CQUNsQyx3QkFBd0IsR0FBRyxJQUFBLDhDQUE2QixFQUN0RCxPQUFPLEVBQ1AsWUFBWSxFQUNaLDhCQUE4QixDQUMvQixDQUFDO2lCQUNIO2dCQUNELDJFQUEyRTtxQkFDdEUsSUFDSCxNQUFBLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxRQUFRLDBDQUFFLE1BQU0sQ0FBQyxrQ0FBMkIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxFQUN2RTtvQkFDQSx3QkFBd0IsR0FBRyxZQUFZLENBQUM7aUJBQ3pDO2dCQUVELGlGQUFpRjtnQkFDakYsSUFBSSxLQUFLLENBQUMsTUFBTSxDQUFDLGtDQUEyQixDQUFDLE9BQU8sQ0FBRSxDQUFDLEVBQUU7b0JBQ3ZELE9BQU87d0JBQ0wsV0FBVyxFQUFFLE1BQU07d0JBQ25CLGNBQWMsRUFBRSxZQUFZO3dCQUM1QixZQUFZLEVBQUUsbUJBQW1CO3dCQUNqQyxpQkFBaUIsRUFBRSx3QkFBd0I7cUJBQzVDLENBQUM7aUJBQ0g7Z0JBRUQsNkZBQTZGO2dCQUM3RixnRUFBZ0U7Z0JBQ2hFLElBQUksQ0FBQyxPQUFPLEVBQUU7b0JBQ1osVUFBRyxDQUFDLElBQUksQ0FDTiw2R0FBNkcsQ0FDOUcsQ0FBQztvQkFDRixPQUFPO3dCQUNMLFdBQVcsRUFBRSxNQUFNO3dCQUNuQixjQUFjLEVBQUUsd0JBQWMsQ0FBQyxhQUFhLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQzt3QkFDdEQsWUFBWSxFQUFFLHdCQUFjLENBQUMsYUFBYSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7cUJBQ3hELENBQUM7aUJBQ0g7Z0JBRUQsTUFBTSwwQkFBMEIsR0FBRyxJQUFBLDhDQUE2QixFQUM5RCxPQUFPLEVBQ1AsWUFBWSxFQUNaLE9BQU8sQ0FDUixDQUFDO2dCQUVGLE9BQU87b0JBQ0wsV0FBVyxFQUFFLE1BQU07b0JBQ25CLGNBQWMsRUFBRSwwQkFBMEI7b0JBQzFDLFlBQVksRUFBRSxtQkFBb0I7b0JBQ2xDLGlCQUFpQixFQUFFLHdCQUF3QjtpQkFDNUMsQ0FBQztZQUNKLENBQUM7WUFDRCxrQkFBa0I7U0FDbkIsQ0FBQztJQUNKLENBQUM7SUFFTyxXQUFXLENBQ2pCLG1CQUFpRCxFQUNqRCxXQUFzQixFQUN0QixPQUFnQixFQUNoQixjQUEyQztRQUUzQyxNQUFNLElBQUksR0FBRyxtQkFBbUIsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQztRQUNwRCxJQUFJLE1BQU0sR0FBRyxzQkFBYyxDQUFDLEdBQUcsQ0FBQywwQkFBa0IsQ0FBQyxHQUFHLENBQUMsSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFFbEUsSUFBSSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUscUJBQXFCLEVBQUU7WUFDekMsTUFBTSxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLHFCQUFxQixDQUFDLENBQUM7U0FDM0Q7UUFFRCxNQUFNLGVBQWUsR0FBRyxXQUFXLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRWhELE1BQU0sSUFBSSxHQUFHLGtDQUEyQixDQUFDLE9BQU8sQ0FBRSxDQUFDO1FBRW5ELE1BQU0sWUFBWSxHQUFHLHdCQUFjLENBQUMsYUFBYSxDQUMvQyxJQUFJLEVBQ0osZUFBZSxDQUFDLFFBQVEsRUFBRSxDQUMzQixDQUFDO1FBRUYsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNsQyxDQUFDO0lBRU8sS0FBSyxDQUFDLFVBQVUsQ0FDdEIsT0FBZ0IsRUFDaEIsS0FBWSxFQUNaLFlBQWlDLEVBQ2pDLGNBQStCO1FBRS9CLE1BQU0sSUFBSSxHQUFHLGtDQUEyQixDQUFDLE9BQU8sQ0FBRSxDQUFDO1FBRW5ELE1BQU0sWUFBWSxHQUFHLE1BQU0sWUFBWSxDQUFDLFFBQVEsQ0FDOUMsQ0FBQyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQyxFQUNmLGNBQWMsQ0FDZixDQUFDO1FBQ0YsTUFBTSxJQUFJLEdBQUcsWUFBWSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFFL0MsSUFBSSxDQUFDLElBQUksSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsRUFBRTtZQUNqRSxVQUFHLENBQUMsS0FBSyxDQUNQO2dCQUNFLElBQUk7Z0JBQ0osS0FBSztnQkFDTCxRQUFRLEVBQUUsSUFBSSxhQUFKLElBQUksdUJBQUosSUFBSSxDQUFFLFFBQVEsQ0FBQyxPQUFPLEVBQUU7Z0JBQ2xDLFFBQVEsRUFBRSxJQUFJLGFBQUosSUFBSSx1QkFBSixJQUFJLENBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRTthQUNuQyxFQUNELHlDQUF5QyxLQUFLLENBQUMsTUFBTSwyQkFBMkIsQ0FDakYsQ0FBQztZQUVGLE9BQU8sSUFBSSxDQUFDO1NBQ2I7UUFFRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFTyxLQUFLLENBQUMsMEJBQTBCLENBQ3RDLE9BQWdCLEVBQ2hCLFlBQWlDLEVBQ2pDLGNBQStCO1FBRS9CLE1BQU0sU0FBUyxHQUFHLHdDQUF1QixDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBRW5ELElBQUksQ0FBQyxTQUFTLEVBQUU7WUFDZCxNQUFNLElBQUksS0FBSyxDQUNiLHlEQUF5RCxPQUFPLEVBQUUsQ0FDbkUsQ0FBQztTQUNIO1FBRUQsTUFBTSxRQUFRLEdBQUcsZ0JBQUMsQ0FBQyxHQUFHLENBQXdCLFNBQVMsRUFBRSxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUM7WUFDckUsUUFBUTtZQUNSLGtDQUEyQixDQUFDLE9BQU8sQ0FBRTtTQUN0QyxDQUFDLENBQUM7UUFDSCxNQUFNLFlBQVksR0FBRyxNQUFNLFlBQVksQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQzNFLE1BQU0sUUFBUSxHQUFHLFlBQVksQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUM1QyxNQUFNLEtBQUssR0FBRyxnQkFBQyxDQUFDLE1BQU0sQ0FDcEIsUUFBUSxFQUNSLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FDUCxJQUFJLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDNUIsSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQzVCLGlIQUFpSDtZQUNqSCxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLGtDQUEyQixDQUFDLE9BQU8sQ0FBRSxDQUFDO2dCQUN4RCxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxrQ0FBMkIsQ0FBQyxPQUFPLENBQUUsQ0FBQyxDQUFDLENBQy9ELENBQUM7UUFFRixJQUFJLEtBQUssQ0FBQyxNQUFNLElBQUksQ0FBQyxFQUFFO1lBQ3JCLFVBQUcsQ0FBQyxLQUFLLENBQ1AsRUFBRSxLQUFLLEVBQUUsRUFDVCx5REFBeUQsQ0FDMUQsQ0FBQztZQUNGLE1BQU0sSUFBSSxLQUFLLENBQUMsdURBQXVELENBQUMsQ0FBQztTQUMxRTtRQUVELE1BQU0sT0FBTyxHQUFHLGdCQUFDLENBQUMsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDLElBQUksRUFBRSxFQUFFO1lBQ3RDLElBQUksSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsa0NBQTJCLENBQUMsT0FBTyxDQUFFLENBQUMsRUFBRTtnQkFDN0QsT0FBTyxVQUFVLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQzthQUNuRDtpQkFBTTtnQkFDTCxPQUFPLFVBQVUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2FBQ25EO1FBQ0gsQ0FBQyxDQUFTLENBQUM7UUFFWCxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0NBQ0Y7QUFoUUQsOEVBZ1FDIn0=

package/build/main/routers/alpha-router/gas-models/gas-costs.d.ts

@@ -0,0 +1,12 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { ChainId, Currency } from '@ring-protocol/sdk-core';
+import { V3Route, V4Route } from '../../router';
+export declare const COST_PER_UNINIT_TICK: BigNumber;
+export declare const BASE_SWAP_COST: (id: ChainId) => BigNumber;
+export declare const COST_PER_INIT_TICK: (id: ChainId) => BigNumber;
+export declare const COST_PER_HOP: (id: ChainId) => BigNumber;
+export declare const SINGLE_HOP_OVERHEAD: (_id: ChainId) => BigNumber;
+export declare const TOKEN_OVERHEAD: (id: ChainId, route: V3Route | V4Route) => BigNumber;
+export declare const NATIVE_WRAP_OVERHEAD: (id: ChainId) => BigNumber;
+export declare const NATIVE_UNWRAP_OVERHEAD: (id: ChainId) => BigNumber;
+export declare const NATIVE_OVERHEAD: (chainId: ChainId, amount: Currency, quote: Currency) => BigNumber;

package/build/main/routers/alpha-router/gas-models/gas-costs.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NATIVE_OVERHEAD = exports.NATIVE_UNWRAP_OVERHEAD = exports.NATIVE_WRAP_OVERHEAD = exports.TOKEN_OVERHEAD = exports.SINGLE_HOP_OVERHEAD = exports.COST_PER_HOP = exports.COST_PER_INIT_TICK = exports.BASE_SWAP_COST = exports.COST_PER_UNINIT_TICK = void 0;
+const bignumber_1 = require("@ethersproject/bignumber");
+const router_sdk_1 = require("@ring-protocol/router-sdk");
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const providers_1 = require("../../../providers");
+// Cost for crossing an uninitialized tick.
+exports.COST_PER_UNINIT_TICK = bignumber_1.BigNumber.from(0);
+//l2 execution fee on optimism is roughly the same as mainnet
+const BASE_SWAP_COST = (id) => {
+    switch (id) {
+        case sdk_core_1.ChainId.HYPER_MAINNET:
+        case sdk_core_1.ChainId.MAINNET:
+        case sdk_core_1.ChainId.GOERLI:
+        case sdk_core_1.ChainId.SEPOLIA:
+        case sdk_core_1.ChainId.OPTIMISM:
+        case sdk_core_1.ChainId.OPTIMISM_GOERLI:
+        case sdk_core_1.ChainId.OPTIMISM_SEPOLIA:
+        case sdk_core_1.ChainId.BNB:
+        case sdk_core_1.ChainId.AVALANCHE:
+        case sdk_core_1.ChainId.BASE:
+        case sdk_core_1.ChainId.BASE_GOERLI:
+        case sdk_core_1.ChainId.ZORA:
+        case sdk_core_1.ChainId.ZORA_SEPOLIA:
+        case sdk_core_1.ChainId.ROOTSTOCK:
+        case sdk_core_1.ChainId.BLAST:
+        case sdk_core_1.ChainId.BLAST_SEPOLIA:
+        case sdk_core_1.ChainId.ZKSYNC:
+        case sdk_core_1.ChainId.WORLDCHAIN:
+        case sdk_core_1.ChainId.UNICHAIN_SEPOLIA:
+        case sdk_core_1.ChainId.UNICHAIN:
+        case sdk_core_1.ChainId.BASE_SEPOLIA:
+        case sdk_core_1.ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.MONAD: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.SONEIUM:
+        case sdk_core_1.ChainId.STORY_ODYSSEY:
+        case sdk_core_1.ChainId.STORY_MAINNET:
+            return bignumber_1.BigNumber.from(2000);
+        case sdk_core_1.ChainId.ARBITRUM_ONE:
+        case sdk_core_1.ChainId.ARBITRUM_GOERLI:
+        case sdk_core_1.ChainId.ARBITRUM_SEPOLIA:
+            return bignumber_1.BigNumber.from(5000);
+        case sdk_core_1.ChainId.POLYGON:
+        case sdk_core_1.ChainId.POLYGON_MUMBAI:
+            return bignumber_1.BigNumber.from(2000);
+        case sdk_core_1.ChainId.CELO:
+        case sdk_core_1.ChainId.CELO_ALFAJORES:
+            return bignumber_1.BigNumber.from(2000);
+        //TODO determine if sufficient
+        case sdk_core_1.ChainId.GNOSIS:
+            return bignumber_1.BigNumber.from(2000);
+        case sdk_core_1.ChainId.MOONBEAM:
+            return bignumber_1.BigNumber.from(2000);
+    }
+};
+exports.BASE_SWAP_COST = BASE_SWAP_COST;
+const COST_PER_INIT_TICK = (id) => {
+    switch (id) {
+        case sdk_core_1.ChainId.HYPER_MAINNET:
+        case sdk_core_1.ChainId.MAINNET:
+        case sdk_core_1.ChainId.GOERLI:
+        case sdk_core_1.ChainId.SEPOLIA:
+        case sdk_core_1.ChainId.BNB:
+        case sdk_core_1.ChainId.AVALANCHE:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.OPTIMISM:
+        case sdk_core_1.ChainId.OPTIMISM_GOERLI:
+        case sdk_core_1.ChainId.OPTIMISM_SEPOLIA:
+        case sdk_core_1.ChainId.BASE:
+        case sdk_core_1.ChainId.BASE_GOERLI:
+        case sdk_core_1.ChainId.ZORA:
+        case sdk_core_1.ChainId.ZORA_SEPOLIA:
+        case sdk_core_1.ChainId.ROOTSTOCK:
+        case sdk_core_1.ChainId.BLAST:
+        case sdk_core_1.ChainId.ZKSYNC:
+        case sdk_core_1.ChainId.WORLDCHAIN:
+        case sdk_core_1.ChainId.UNICHAIN_SEPOLIA:
+        case sdk_core_1.ChainId.UNICHAIN:
+        case sdk_core_1.ChainId.BASE_SEPOLIA:
+        case sdk_core_1.ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.MONAD: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.SONEIUM:
+        case sdk_core_1.ChainId.BLAST_SEPOLIA:
+        case sdk_core_1.ChainId.STORY_ODYSSEY:
+        case sdk_core_1.ChainId.STORY_MAINNET:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.ARBITRUM_ONE:
+        case sdk_core_1.ChainId.ARBITRUM_GOERLI:
+        case sdk_core_1.ChainId.ARBITRUM_SEPOLIA:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.POLYGON:
+        case sdk_core_1.ChainId.POLYGON_MUMBAI:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.CELO:
+        case sdk_core_1.ChainId.CELO_ALFAJORES:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.GNOSIS:
+            return bignumber_1.BigNumber.from(31000);
+        case sdk_core_1.ChainId.MOONBEAM:
+            return bignumber_1.BigNumber.from(31000);
+    }
+};
+exports.COST_PER_INIT_TICK = COST_PER_INIT_TICK;
+const COST_PER_HOP = (id) => {
+    switch (id) {
+        case sdk_core_1.ChainId.HYPER_MAINNET:
+        case sdk_core_1.ChainId.MAINNET:
+        case sdk_core_1.ChainId.GOERLI:
+        case sdk_core_1.ChainId.SEPOLIA:
+        case sdk_core_1.ChainId.BNB:
+        case sdk_core_1.ChainId.OPTIMISM:
+        case sdk_core_1.ChainId.OPTIMISM_GOERLI:
+        case sdk_core_1.ChainId.OPTIMISM_SEPOLIA:
+        case sdk_core_1.ChainId.AVALANCHE:
+        case sdk_core_1.ChainId.BASE:
+        case sdk_core_1.ChainId.BASE_GOERLI:
+        case sdk_core_1.ChainId.ZORA:
+        case sdk_core_1.ChainId.ZORA_SEPOLIA:
+        case sdk_core_1.ChainId.ROOTSTOCK:
+        case sdk_core_1.ChainId.BLAST:
+        case sdk_core_1.ChainId.ZKSYNC:
+        case sdk_core_1.ChainId.WORLDCHAIN:
+        case sdk_core_1.ChainId.UNICHAIN_SEPOLIA:
+        case sdk_core_1.ChainId.UNICHAIN:
+        case sdk_core_1.ChainId.BASE_SEPOLIA:
+        case sdk_core_1.ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.MONAD: // TODO: double check on monad gas
+        case sdk_core_1.ChainId.SONEIUM:
+        case sdk_core_1.ChainId.BLAST_SEPOLIA:
+        case sdk_core_1.ChainId.STORY_ODYSSEY:
+        case sdk_core_1.ChainId.STORY_MAINNET:
+            return bignumber_1.BigNumber.from(80000);
+        case sdk_core_1.ChainId.ARBITRUM_ONE:
+        case sdk_core_1.ChainId.ARBITRUM_GOERLI:
+        case sdk_core_1.ChainId.ARBITRUM_SEPOLIA:
+            return bignumber_1.BigNumber.from(80000);
+        case sdk_core_1.ChainId.POLYGON:
+        case sdk_core_1.ChainId.POLYGON_MUMBAI:
+            return bignumber_1.BigNumber.from(80000);
+        case sdk_core_1.ChainId.CELO:
+        case sdk_core_1.ChainId.CELO_ALFAJORES:
+            return bignumber_1.BigNumber.from(80000);
+        case sdk_core_1.ChainId.GNOSIS:
+            return bignumber_1.BigNumber.from(80000);
+        case sdk_core_1.ChainId.MOONBEAM:
+            return bignumber_1.BigNumber.from(80000);
+    }
+};
+exports.COST_PER_HOP = COST_PER_HOP;
+const SINGLE_HOP_OVERHEAD = (_id) => {
+    return bignumber_1.BigNumber.from(15000);
+};
+exports.SINGLE_HOP_OVERHEAD = SINGLE_HOP_OVERHEAD;
+const TOKEN_OVERHEAD = (id, route) => {
+    const currencies = route.protocol === router_sdk_1.Protocol.V4 ? route.currencyPath : route.tokenPath;
+    let overhead = bignumber_1.BigNumber.from(0);
+    if (id == sdk_core_1.ChainId.MAINNET) {
+        // AAVE's transfer contains expensive governance snapshotting logic. We estimate
+        // it at around 150k.
+        if (currencies.some((t) => t.equals(providers_1.AAVE_MAINNET))) {
+            overhead = overhead.add(150000);
+        }
+        // LDO's reaches out to an external token controller which adds a large overhead
+        // of around 150k.
+        if (currencies.some((t) => t.equals(providers_1.LIDO_MAINNET))) {
+            overhead = overhead.add(150000);
+        }
+    }
+    return overhead;
+};
+exports.TOKEN_OVERHEAD = TOKEN_OVERHEAD;
+// TODO: change per chain
+const NATIVE_WRAP_OVERHEAD = (id) => {
+    switch (id) {
+        default:
+            return bignumber_1.BigNumber.from(27938);
+    }
+};
+exports.NATIVE_WRAP_OVERHEAD = NATIVE_WRAP_OVERHEAD;
+const NATIVE_UNWRAP_OVERHEAD = (id) => {
+    switch (id) {
+        default:
+            return bignumber_1.BigNumber.from(36000);
+    }
+};
+exports.NATIVE_UNWRAP_OVERHEAD = NATIVE_UNWRAP_OVERHEAD;
+const NATIVE_OVERHEAD = (chainId, amount, quote) => {
+    if (amount.isNative) {
+        // need to wrap eth in
+        return (0, exports.NATIVE_WRAP_OVERHEAD)(chainId);
+    }
+    if (quote.isNative) {
+        // need to unwrap eth out
+        return (0, exports.NATIVE_UNWRAP_OVERHEAD)(chainId);
+    }
+    return bignumber_1.BigNumber.from(0);
+};
+exports.NATIVE_OVERHEAD = NATIVE_OVERHEAD;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"gas-costs.js","sourceRoot":"","sources":["../../../../../src/routers/alpha-router/gas-models/gas-costs.ts"],"names":[],"mappings":";;;AAAA,wDAAqD;AAErD,0DAAqD;AACrD,sDAA4D;AAC5D,kDAAgE;AAGhE,2CAA2C;AAC9B,QAAA,oBAAoB,GAAG,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEtD,6DAA6D;AACtD,MAAM,cAAc,GAAG,CAAC,EAAW,EAAa,EAAE;IACvD,QAAQ,EAAE,EAAE;QACV,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,GAAG,CAAC;QACjB,KAAK,kBAAO,CAAC,SAAS,CAAC;QACvB,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,WAAW,CAAC;QACzB,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,SAAS,CAAC;QACvB,KAAK,kBAAO,CAAC,KAAK,CAAC;QACnB,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,UAAU,CAAC;QACxB,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,kBAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,aAAa;YACxB,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB;YAC3B,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,8BAA8B;QAC9B,KAAK,kBAAO,CAAC,MAAM;YACjB,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,kBAAO,CAAC,QAAQ;YACnB,OAAO,qBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC/B;AACH,CAAC,CAAC;AA/CW,QAAA,cAAc,kBA+CzB;AACK,MAAM,kBAAkB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC3D,QAAQ,EAAE,EAAE;QACV,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,GAAG,CAAC;QACjB,KAAK,kBAAO,CAAC,SAAS;YACpB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,WAAW,CAAC;QACzB,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,SAAS,CAAC;QACvB,KAAK,kBAAO,CAAC,KAAK,CAAC;QACnB,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,UAAU,CAAC;QACxB,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,kBAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,aAAa;YACxB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB;YAC3B,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,MAAM;YACjB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,QAAQ;YACnB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AA7CW,QAAA,kBAAkB,sBA6C7B;AAEK,MAAM,YAAY,GAAG,CAAC,EAAW,EAAa,EAAE;IACrD,QAAQ,EAAE,EAAE;QACV,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,GAAG,CAAC;QACjB,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,SAAS,CAAC;QACvB,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,WAAW,CAAC;QACzB,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,SAAS,CAAC;QACvB,KAAK,kBAAO,CAAC,KAAK,CAAC;QACnB,KAAK,kBAAO,CAAC,MAAM,CAAC;QACpB,KAAK,kBAAO,CAAC,UAAU,CAAC;QACxB,KAAK,kBAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,kBAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,kBAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,kBAAO,CAAC,aAAa;YACxB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,kBAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,kBAAO,CAAC,gBAAgB;YAC3B,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,OAAO,CAAC;QACrB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,IAAI,CAAC;QAClB,KAAK,kBAAO,CAAC,cAAc;YACzB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,MAAM;YACjB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,kBAAO,CAAC,QAAQ;YACnB,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AA5CW,QAAA,YAAY,gBA4CvB;AAEK,MAAM,mBAAmB,GAAG,CAAC,GAAY,EAAa,EAAE;IAC7D,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B;AAEK,MAAM,cAAc,GAAG,CAC5B,EAAW,EACX,KAAwB,EACb,EAAE;IACb,MAAM,UAAU,GACd,KAAK,CAAC,QAAQ,KAAK,qBAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;IACxE,IAAI,QAAQ,GAAG,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjC,IAAI,EAAE,IAAI,kBAAO,CAAC,OAAO,EAAE;QACzB,gFAAgF;QAChF,qBAAqB;QACrB,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,wBAAY,CAAC,CAAC,EAAE;YAC5D,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SACjC;QAED,gFAAgF;QAChF,kBAAkB;QAClB,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,wBAAY,CAAC,CAAC,EAAE;YAC5D,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SACjC;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAvBW,QAAA,cAAc,kBAuBzB;AAEF,yBAAyB;AAClB,MAAM,oBAAoB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC7D,QAAQ,EAAE,EAAE;QACV;YACE,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AALW,QAAA,oBAAoB,wBAK/B;AAEK,MAAM,sBAAsB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC/D,QAAQ,EAAE,EAAE;QACV;YACE,OAAO,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC;AAEK,MAAM,eAAe,GAAG,CAC7B,OAAgB,EAChB,MAAgB,EAChB,KAAe,EACJ,EAAE;IACb,IAAI,MAAM,CAAC,QAAQ,EAAE;QACnB,sBAAsB;QACtB,OAAO,IAAA,4BAAoB,EAAC,OAAO,CAAC,CAAC;KACtC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE;QAClB,yBAAyB;QACzB,OAAO,IAAA,8BAAsB,EAAC,OAAO,CAAC,CAAC;KACxC;IACD,OAAO,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC;AAdW,QAAA,eAAe,mBAc1B"}

package/build/main/routers/alpha-router/gas-models/gas-model.d.ts

@@ -0,0 +1,111 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { ChainId, CurrencyAmount as CurrencyAmountRaw, Token } from '@ring-protocol/sdk-core';
+import { Pair } from '@ring-protocol/v2-sdk';
+import { Pool } from '@ring-protocol/v3-sdk';
+import { ProviderConfig } from '../../../providers/provider';
+import { IV2PoolProvider } from '../../../providers/v2/pool-provider';
+import { ArbitrumGasData, IL2GasDataProvider } from '../../../providers/v3/gas-data-provider';
+import { CurrencyAmount } from '../../../util/amounts';
+import { MixedRouteWithValidQuote, RingFewV2RouteWithValidQuote, RouteWithValidQuote, UniswapFewV3RouteWithValidQuote, UniswapFewV4RouteWithValidQuote, V2RouteWithValidQuote, V3RouteWithValidQuote, V4RouteWithValidQuote } from '../entities/route-with-valid-quote';
+export declare const usdGasTokensByChain: {
+    [chainId in ChainId]?: Token[];
+};
+export declare type L1ToL2GasCosts = {
+    gasUsedL1: BigNumber;
+    gasUsedL1OnL2: BigNumber;
+    gasCostL1USD: CurrencyAmount;
+    gasCostL1QuoteToken: CurrencyAmount;
+};
+export declare type GasModelProviderConfig = ProviderConfig & {
+    additionalGasOverhead?: BigNumber;
+    gasToken?: Token;
+};
+export declare type BuildOnChainGasModelFactoryType = {
+    chainId: ChainId;
+    gasPriceWei: BigNumber;
+    pools: LiquidityCalculationPools | null;
+    amountToken: Token;
+    quoteToken: Token;
+    v2poolProvider: IV2PoolProvider;
+    l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    providerConfig?: GasModelProviderConfig;
+};
+export declare type BuildV2GasModelFactoryType = {
+    chainId: ChainId;
+    gasPriceWei: BigNumber;
+    poolProvider: IV2PoolProvider;
+    token: Token;
+    l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    providerConfig?: GasModelProviderConfig;
+};
+export declare type LiquidityCalculationPools = {
+    usdPool: Pool | null;
+    nativeAndQuoteTokenV3Pool: Pool | null;
+    nativeAndAmountTokenV3Pool: Pool | null;
+    nativeAndSpecifiedGasTokenV3Pool: Pool | null;
+};
+export declare type GasModelType = {
+    ringFewV2GasModel?: IGasModel<RingFewV2RouteWithValidQuote>;
+    v2GasModel?: IGasModel<V2RouteWithValidQuote>;
+    fewV2GasModel?: IGasModel<V2RouteWithValidQuote>;
+    v3GasModel: IGasModel<V3RouteWithValidQuote>;
+    fewV3GasModel: IGasModel<UniswapFewV3RouteWithValidQuote>;
+    v4GasModel: IGasModel<V4RouteWithValidQuote>;
+    fewV4GasModel: IGasModel<UniswapFewV4RouteWithValidQuote>;
+    mixedRouteGasModel: IGasModel<MixedRouteWithValidQuote>;
+};
+/**
+ * Contains functions for generating gas estimates for given routes.
+ *
+ * We generally 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
+ *  3/ For V2 we simulate all our swaps off-chain so have no way to track gas used.
+ *
+ * Generally these models should be optimized to return quickly by performing any
+ * long running operations (like fetching external data) outside of the functions defined.
+ * This is because the functions in the model are called once for every route and every
+ * amount that is considered in the algorithm so it is important to minimize the number of
+ * long running operations.
+ */
+export declare type IGasModel<TRouteWithValidQuote extends RouteWithValidQuote> = {
+    estimateGasCost(routeWithValidQuote: TRouteWithValidQuote): {
+        gasEstimate: BigNumber;
+        gasCostInToken: CurrencyAmount;
+        gasCostInUSD: CurrencyAmount;
+        gasCostInGasToken?: CurrencyAmount;
+    };
+    calculateL1GasFees?(routes: TRouteWithValidQuote[]): Promise<L1ToL2GasCosts>;
+};
+/**
+ * Factory for building gas models that can be used with any route to generate
+ * gas estimates.
+ *
+ * Factory model is used so that any supporting data can be fetched once and
+ * returned as part of the model.
+ *
+ * @export
+ * @abstract
+ * @class IV2GasModelFactory
+ */
+export declare abstract class IV2GasModelFactory {
+    abstract buildGasModel({ chainId, gasPriceWei, poolProvider, token, providerConfig, }: BuildV2GasModelFactoryType): Promise<IGasModel<V2RouteWithValidQuote>>;
+}
+/**
+ * Factory for building gas models that can be used with any route to generate
+ * gas estimates.
+ *
+ * Factory model is used so that any supporting data can be fetched once and
+ * returned as part of the model.
+ *
+ * @export
+ * @abstract
+ * @class IOnChainGasModelFactory
+ */
+export declare abstract class IOnChainGasModelFactory<TRouteWithValidQuote extends RouteWithValidQuote> {
+    abstract buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, v2poolProvider, l2GasDataProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<TRouteWithValidQuote>>;
+    protected totalInitializedTicksCrossed(initializedTicksCrossedList: number[]): number;
+}
+export declare const getQuoteThroughNativePool: (chainId: ChainId, nativeTokenAmount: CurrencyAmountRaw<Token>, nativeTokenPool: Pool | Pair | null) => CurrencyAmount;