@ring-protocol/smart-order-router 0.5.0

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

@@ -0,0 +1,5 @@
+export * from './gas-model';
+export * from './ring-gas-model';
+export * from './fewV2/v2-heuristic-gas-model';
+export * from './v3/v3-heuristic-gas-model';
+export * from './uniswapFewV3/v3-heuristic-gas-model';

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

@@ -0,0 +1,6 @@
+export * from './gas-model';
+export * from './ring-gas-model';
+export * from './fewV2/v2-heuristic-gas-model';
+export * from './v3/v3-heuristic-gas-model';
+export * from './uniswapFewV3/v3-heuristic-gas-model';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvcm91dGVycy9hbHBoYS1yb3V0ZXIvZ2FzLW1vZGVscy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsZ0NBQWdDLENBQUM7QUFDL0MsY0FBYyw2QkFBNkIsQ0FBQztBQUM1QyxjQUFjLHVDQUF1QyxDQUFDIn0=

package/build/module/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.d.ts

@@ -0,0 +1,24 @@
+import { MixedRouteWithValidQuote } from '../../entities/route-with-valid-quote';
+import { BuildOnChainGasModelFactoryType, IGasModel, IOnChainGasModelFactory } from '../gas-model';
+/**
+ * Computes a gas estimate for a mixed route 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 MixedRouteQuoterV1
+ * 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 MixedRouteHeuristicGasModelFactory
+ */
+export declare class MixedRouteHeuristicGasModelFactory extends IOnChainGasModelFactory<MixedRouteWithValidQuote> {
+    buildGasModel({ chainId, gasPriceWei, pools, quoteToken, v2poolProvider: V2poolProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<MixedRouteWithValidQuote>>;
+    private estimateGas;
+}

package/build/module/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.js

@@ -0,0 +1,154 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { partitionMixedRouteByProtocol } from '@ring-protocol/router-sdk';
+import { Pair } from '@ring-protocol/v2-sdk';
+import { Pool as V3Pool } from '@ring-protocol/v3-sdk';
+import { Pool as V4Pool } from '@ring-protocol/v4-sdk';
+import JSBI from 'jsbi';
+import { WRAPPED_NATIVE_CURRENCY } from '../../../..';
+import { log } from '../../../../util';
+import { CurrencyAmount } from '../../../../util/amounts';
+import { getV2NativePool } from '../../../../util/gas-factory-helpers';
+import { BASE_SWAP_COST, COST_PER_HOP, COST_PER_INIT_TICK, COST_PER_UNINIT_TICK, } from '../gas-costs';
+import { getQuoteThroughNativePool, IOnChainGasModelFactory, } from '../gas-model';
+import { BASE_SWAP_COST as BASE_SWAP_COST_V2, COST_PER_EXTRA_HOP as COST_PER_EXTRA_HOP_V2, } from '../v2/v2-heuristic-gas-model';
+/**
+ * Computes a gas estimate for a mixed route 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 MixedRouteQuoterV1
+ * 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 MixedRouteHeuristicGasModelFactory
+ */
+export class MixedRouteHeuristicGasModelFactory extends IOnChainGasModelFactory {
+    async buildGasModel({ chainId, gasPriceWei, pools, quoteToken, v2poolProvider: V2poolProvider, providerConfig, }) {
+        const nativeCurrency = WRAPPED_NATIVE_CURRENCY[chainId];
+        const usdPool = pools != null ? pools.usdPool : null;
+        const usdToken = usdPool != null ? (usdPool.token0.equals(nativeCurrency)
+            ? usdPool.token1
+            : usdPool.token0) : null;
+        let nativeV2Pool;
+        // Avoid fetching for a (WETH,WETH) pool here, we handle the quoteToken = wrapped native case in estimateGasCost
+        if (!quoteToken.equals(nativeCurrency) && V2poolProvider) {
+            /// MixedRoutes
+            nativeV2Pool = await getV2NativePool(quoteToken, V2poolProvider, providerConfig);
+        }
+        const estimateGasCost = (routeWithValidQuote) => {
+            var _a;
+            const { totalGasCostNativeCurrency, baseGasUse } = this.estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig);
+            /** ------ MARK: USD Logic -------- */
+            const gasCostInTermsOfUSD = getQuoteThroughNativePool(chainId, totalGasCostNativeCurrency, usdPool);
+            /** ------ MARK: Conditional logic run if gasToken is specified  -------- */
+            const nativeAndSpecifiedGasTokenPool = pools != null ? pools.nativeAndSpecifiedGasTokenV3Pool : null;
+            let gasCostInTermsOfGasToken = undefined;
+            if (nativeAndSpecifiedGasTokenPool) {
+                gasCostInTermsOfGasToken = getQuoteThroughNativePool(chainId, totalGasCostNativeCurrency, nativeAndSpecifiedGasTokenPool);
+            }
+            // if the gasToken is the native currency, we can just use the totalGasCostNativeCurrency
+            else if ((_a = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.gasToken) === null || _a === void 0 ? void 0 : _a.equals(nativeCurrency)) {
+                gasCostInTermsOfGasToken = totalGasCostNativeCurrency;
+            }
+            /** ------ MARK: return early if quoteToken is wrapped native currency ------- */
+            if (quoteToken.equals(nativeCurrency)) {
+                return {
+                    gasEstimate: baseGasUse,
+                    gasCostInToken: totalGasCostNativeCurrency,
+                    gasCostInUSD: gasCostInTermsOfUSD,
+                    gasCostInGasToken: gasCostInTermsOfGasToken,
+                };
+            }
+            /** ------ MARK: Main gas logic in terms of quote token -------- */
+            // If the quote token is not in the native currency, we convert the gas cost to be in terms of the quote token.
+            // We do this by getting the highest liquidity <quoteToken>/<nativeCurrency> pool. eg. <quoteToken>/ETH pool.
+            const nativeV3Pool = pools != null ? pools.nativeAndQuoteTokenV3Pool : null;
+            if (!nativeV3Pool && !nativeV2Pool) {
+                log.info(`Unable to find ${nativeCurrency.symbol} pool with the quote token, ${quoteToken.symbol} to produce gas adjusted costs. Route will not account for gas.`);
+                return {
+                    gasEstimate: baseGasUse,
+                    gasCostInToken: CurrencyAmount.fromRawAmount(quoteToken, 0),
+                    gasCostInUSD: CurrencyAmount.fromRawAmount(usdToken, 0),
+                };
+            }
+            /// we will use nativeV2Pool for fallback if nativeV3 does not exist or has 0 liquidity
+            /// can use ! here because we return above if v3Pool and v2Pool are null
+            const nativePool = (!nativeV3Pool || JSBI.equal(nativeV3Pool.liquidity, JSBI.BigInt(0))) &&
+                nativeV2Pool
+                ? nativeV2Pool
+                : nativeV3Pool;
+            const gasCostInTermsOfQuoteToken = getQuoteThroughNativePool(chainId, totalGasCostNativeCurrency, nativePool);
+            return {
+                gasEstimate: baseGasUse,
+                gasCostInToken: gasCostInTermsOfQuoteToken,
+                gasCostInUSD: gasCostInTermsOfUSD,
+                gasCostInGasToken: gasCostInTermsOfGasToken,
+            };
+        };
+        return {
+            estimateGasCost: estimateGasCost.bind(this),
+        };
+    }
+    estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig) {
+        const totalInitializedTicksCrossed = this.totalInitializedTicksCrossed(routeWithValidQuote.initializedTicksCrossedList);
+        /**
+         * Since we must make a separate call to multicall for each v3 and v2 section, we will have to
+         * add the BASE_SWAP_COST to each section.
+         */
+        let baseGasUseV2Only = BigNumber.from(0);
+        let baseGasUseV3Only = BigNumber.from(0);
+        let baseGasUse = BigNumber.from(0);
+        let routeContainsV4Pool = false;
+        const route = routeWithValidQuote.route;
+        const res = partitionMixedRouteByProtocol(route);
+        res.map((section) => {
+            if (section.every((pool) => pool instanceof V3Pool)) {
+                baseGasUseV3Only = baseGasUseV3Only.add(BASE_SWAP_COST(chainId));
+                baseGasUseV3Only = baseGasUseV3Only.add(COST_PER_HOP(chainId).mul(section.length));
+                baseGasUse = baseGasUse.add(baseGasUseV3Only);
+            }
+            else if (section.every((pool) => pool instanceof Pair)) {
+                baseGasUseV2Only = baseGasUseV2Only.add(BASE_SWAP_COST_V2);
+                baseGasUseV2Only = baseGasUseV2Only.add(
+                /// same behavior in v2 heuristic gas model factory
+                COST_PER_EXTRA_HOP_V2.mul(section.length - 1));
+                baseGasUse = baseGasUse.add(baseGasUseV2Only);
+            }
+            else if (section.every((pool) => pool instanceof V4Pool)) {
+                routeContainsV4Pool = true;
+            }
+        });
+        const tickGasUse = COST_PER_INIT_TICK(chainId).mul(totalInitializedTicksCrossed);
+        const uninitializedTickGasUse = COST_PER_UNINIT_TICK.mul(0);
+        if (routeContainsV4Pool) {
+            // If the route contains a V4 pool, we know we are hitting mixed quoter V2, not mixed quoter V1,
+            // Hence we already know the v3 and v4 hops part of the quoter gas estimate.
+            // We only need to add the base gas use for the v2 part of the route,
+            // because mixed quoter doesn't have a way to estimate gas for v2 pools swaps.
+            baseGasUse = baseGasUseV2Only.add(routeWithValidQuote.quoterGasEstimate);
+        }
+        else {
+            // base estimate gas used based on chainId estimates for hops and ticks gas useage
+            baseGasUse = baseGasUse.add(tickGasUse).add(uninitializedTickGasUse);
+        }
+        if (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.additionalGasOverhead) {
+            baseGasUse = baseGasUse.add(providerConfig.additionalGasOverhead);
+        }
+        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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWl4ZWQtcm91dGUtaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL21peGVkUm91dGUvbWl4ZWQtcm91dGUtaGV1cmlzdGljLWdhcy1tb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDckQsT0FBTyxFQUFFLDZCQUE2QixFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFFMUUsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBQzdDLE9BQU8sRUFBRSxJQUFJLElBQUksTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDdkQsT0FBTyxFQUFFLElBQUksSUFBSSxNQUFNLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUN2RCxPQUFPLElBQUksTUFBTSxNQUFNLENBQUM7QUFHeEIsT0FBTyxFQUFFLHVCQUF1QixFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3RELE9BQU8sRUFBRSxHQUFHLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN2QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDMUQsT0FBTyxFQUFFLGVBQWUsRUFBRSxNQUFNLHNDQUFzQyxDQUFDO0FBRXZFLE9BQU8sRUFDTCxjQUFjLEVBQ2QsWUFBWSxFQUNaLGtCQUFrQixFQUNsQixvQkFBb0IsR0FDckIsTUFBTSxjQUFjLENBQUM7QUFDdEIsT0FBTyxFQUdMLHlCQUF5QixFQUV6Qix1QkFBdUIsR0FDeEIsTUFBTSxjQUFjLENBQUM7QUFDdEIsT0FBTyxFQUNMLGNBQWMsSUFBSSxpQkFBaUIsRUFDbkMsa0JBQWtCLElBQUkscUJBQXFCLEdBQzVDLE1BQU0sOEJBQThCLENBQUM7QUFFdEM7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBaUJHO0FBQ0gsTUFBTSxPQUFPLGtDQUFtQyxTQUFRLHVCQUFpRDtJQUNoRyxLQUFLLENBQUMsYUFBYSxDQUFDLEVBQ3pCLE9BQU8sRUFDUCxXQUFXLEVBQ1gsS0FBSyxFQUNMLFVBQVUsRUFDVixjQUFjLEVBQUUsY0FBYyxFQUM5QixjQUFjLEdBQ2tCO1FBR2hDLE1BQU0sY0FBYyxHQUFHLHVCQUF1QixDQUFDLE9BQU8sQ0FBRSxDQUFDO1FBQ3pELE1BQU0sT0FBTyxHQUFrQixLQUFLLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7UUFDcEUsTUFBTSxRQUFRLEdBQUcsT0FBTyxJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUM7WUFDdkUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNO1lBQ2hCLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztRQUUzQixJQUFJLFlBQXlCLENBQUM7UUFDOUIsZ0hBQWdIO1FBQ2hILElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLGNBQWMsRUFBRTtZQUN4RCxlQUFlO1lBQ2YsWUFBWSxHQUFHLE1BQU0sZUFBZSxDQUNsQyxVQUFVLEVBQ1YsY0FBYyxFQUNkLGNBQWMsQ0FDZixDQUFDO1NBQ0g7UUFFRCxNQUFNLGVBQWUsR0FBRyxDQUN0QixtQkFBNkMsRUFNN0MsRUFBRTs7WUFDRixNQUFNLEVBQUUsMEJBQTBCLEVBQUUsVUFBVSxFQUFFLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FDakUsbUJBQW1CLEVBQ25CLFdBQVcsRUFDWCxPQUFPLEVBQ1AsY0FBYyxDQUNmLENBQUM7WUFFRixzQ0FBc0M7WUFDdEMsTUFBTSxtQkFBbUIsR0FBRyx5QkFBeUIsQ0FDbkQsT0FBTyxFQUNQLDBCQUEwQixFQUMxQixPQUFPLENBQ1IsQ0FBQztZQUVGLDRFQUE0RTtZQUM1RSxNQUFNLDhCQUE4QixHQUNsQyxLQUFLLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsZ0NBQWdDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUNoRSxJQUFJLHdCQUF3QixHQUErQixTQUFTLENBQUM7WUFDckUsSUFBSSw4QkFBOEIsRUFBRTtnQkFDbEMsd0JBQXdCLEdBQUcseUJBQXlCLENBQ2xELE9BQU8sRUFDUCwwQkFBMEIsRUFDMUIsOEJBQThCLENBQy9CLENBQUM7YUFDSDtZQUNELHlGQUF5RjtpQkFDcEYsSUFBSSxNQUFBLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxRQUFRLDBDQUFFLE1BQU0sQ0FBQyxjQUFjLENBQUMsRUFBRTtnQkFDekQsd0JBQXdCLEdBQUcsMEJBQTBCLENBQUM7YUFDdkQ7WUFFRCxpRkFBaUY7WUFDakYsSUFBSSxVQUFVLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxFQUFFO2dCQUNyQyxPQUFPO29CQUNMLFdBQVcsRUFBRSxVQUFVO29CQUN2QixjQUFjLEVBQUUsMEJBQTBCO29CQUMxQyxZQUFZLEVBQUUsbUJBQW1CO29CQUNqQyxpQkFBaUIsRUFBRSx3QkFBd0I7aUJBQzVDLENBQUM7YUFDSDtZQUVELG1FQUFtRTtZQUVuRSwrR0FBK0c7WUFDL0csNkdBQTZHO1lBQzdHLE1BQU0sWUFBWSxHQUFrQixLQUFLLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMseUJBQXlCLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUUzRixJQUFJLENBQUMsWUFBWSxJQUFJLENBQUMsWUFBWSxFQUFFO2dCQUNsQyxHQUFHLENBQUMsSUFBSSxDQUNOLGtCQUFrQixjQUFjLENBQUMsTUFBTSwrQkFBK0IsVUFBVSxDQUFDLE1BQU0saUVBQWlFLENBQ3pKLENBQUM7Z0JBQ0YsT0FBTztvQkFDTCxXQUFXLEVBQUUsVUFBVTtvQkFDdkIsY0FBYyxFQUFFLGNBQWMsQ0FBQyxhQUFhLENBQUMsVUFBVSxFQUFFLENBQUMsQ0FBQztvQkFDM0QsWUFBWSxFQUFFLGNBQWMsQ0FBQyxhQUFhLENBQUMsUUFBUyxFQUFFLENBQUMsQ0FBQztpQkFDekQsQ0FBQzthQUNIO1lBRUQsdUZBQXVGO1lBQ3ZGLHdFQUF3RTtZQUN4RSxNQUFNLFVBQVUsR0FDZCxDQUFDLENBQUMsWUFBWSxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLFNBQVMsRUFBRSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQ25FLFlBQVk7Z0JBQ1osQ0FBQyxDQUFDLFlBQVk7Z0JBQ2QsQ0FBQyxDQUFDLFlBQWEsQ0FBQztZQUVwQixNQUFNLDBCQUEwQixHQUFHLHlCQUF5QixDQUMxRCxPQUFPLEVBQ1AsMEJBQTBCLEVBQzFCLFVBQVUsQ0FDWCxDQUFDO1lBRUYsT0FBTztnQkFDTCxXQUFXLEVBQUUsVUFBVTtnQkFDdkIsY0FBYyxFQUFFLDBCQUEwQjtnQkFDMUMsWUFBWSxFQUFFLG1CQUFvQjtnQkFDbEMsaUJBQWlCLEVBQUUsd0JBQXdCO2FBQzVDLENBQUM7UUFDSixDQUFDLENBQUM7UUFFRixPQUFPO1lBQ0wsZUFBZSxFQUFFLGVBQWUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1NBQzVDLENBQUM7SUFDSixDQUFDO0lBRU8sV0FBVyxDQUNqQixtQkFBNkMsRUFDN0MsV0FBc0IsRUFDdEIsT0FBZ0IsRUFDaEIsY0FBdUM7UUFFdkMsTUFBTSw0QkFBNEIsR0FBRyxJQUFJLENBQUMsNEJBQTRCLENBQ3BFLG1CQUFtQixDQUFDLDJCQUEyQixDQUNoRCxDQUFDO1FBRUY7OztXQUdHO1FBQ0gsSUFBSSxnQkFBZ0IsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3pDLElBQUksZ0JBQWdCLEdBQUcsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN6QyxJQUFJLFVBQVUsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ25DLElBQUksbUJBQW1CLEdBQUcsS0FBSyxDQUFDO1FBRWhDLE1BQU0sS0FBSyxHQUFHLG1CQUFtQixDQUFDLEtBQUssQ0FBQztRQUV4QyxNQUFNLEdBQUcsR0FBRyw2QkFBNkIsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUNqRCxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUMsT0FBZ0IsRUFBRSxFQUFFO1lBQzNCLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxZQUFZLE1BQU0sQ0FBQyxFQUFFO2dCQUNuRCxnQkFBZ0IsR0FBRyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7Z0JBQ2pFLGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLEdBQUcsQ0FDckMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQzFDLENBQUM7Z0JBQ0YsVUFBVSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsZ0JBQWdCLENBQUMsQ0FBQzthQUMvQztpQkFBTSxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksWUFBWSxJQUFJLENBQUMsRUFBRTtnQkFDeEQsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsR0FBRyxDQUFDLGlCQUFpQixDQUFDLENBQUM7Z0JBQzNELGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLEdBQUc7Z0JBQ3JDLG1EQUFtRDtnQkFDbkQscUJBQXFCLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQzlDLENBQUM7Z0JBQ0YsVUFBVSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsZ0JBQWdCLENBQUMsQ0FBQzthQUMvQztpQkFBTSxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksWUFBWSxNQUFNLENBQUMsRUFBRTtnQkFDMUQsbUJBQW1CLEdBQUcsSUFBSSxDQUFDO2FBQzVCO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFFSCxNQUFNLFVBQVUsR0FBRyxrQkFBa0IsQ0FBQyxPQUFPLENBQUMsQ0FBQyxHQUFHLENBQ2hELDRCQUE0QixDQUM3QixDQUFDO1FBQ0YsTUFBTSx1QkFBdUIsR0FBRyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFFNUQsSUFBSSxtQkFBbUIsRUFBRTtZQUN2QixnR0FBZ0c7WUFDaEcsNEVBQTRFO1lBQzVFLHFFQUFxRTtZQUNyRSw4RUFBOEU7WUFDOUUsVUFBVSxHQUFHLGdCQUFnQixDQUFDLEdBQUcsQ0FBQyxtQkFBbUIsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDO1NBQzFFO2FBQU07WUFDTCxrRkFBa0Y7WUFDbEYsVUFBVSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUMsR0FBRyxDQUFDLHVCQUF1QixDQUFDLENBQUM7U0FDdEU7UUFFRCxJQUFJLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxxQkFBcUIsRUFBRTtZQUN6QyxVQUFVLEdBQUcsVUFBVSxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMscUJBQXFCLENBQUMsQ0FBQztTQUNuRTtRQUVELE1BQU0sY0FBYyxHQUFHLFdBQVcsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUM7UUFFbkQsTUFBTSxlQUFlLEdBQUcsdUJBQXVCLENBQUMsT0FBTyxDQUFFLENBQUM7UUFFMUQsTUFBTSwwQkFBMEIsR0FBRyxjQUFjLENBQUMsYUFBYSxDQUM3RCxlQUFlLEVBQ2YsY0FBYyxDQUFDLFFBQVEsRUFBRSxDQUMxQixDQUFDO1FBRUYsT0FBTztZQUNMLDBCQUEwQjtZQUMxQiw0QkFBNEI7WUFDNUIsVUFBVTtTQUNYLENBQUM7SUFDSixDQUFDO0NBQ0YifQ==

package/build/module/routers/alpha-router/gas-models/ring-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 { Pair as RingV2Pair } from '@ring-protocol/few-v2-sdk';
+import { IRingV2PoolProvider } from '../../../providers/fewV2/ring-pool-provider';
+import { ProviderConfig } from '../../../providers/provider';
+import { ArbitrumGasData, IL2GasDataProvider } from '../../../providers/v3/gas-data-provider';
+import { CurrencyAmount } from '../../../util/amounts';
+import { MixedRouteWithValidQuote, RingFewV2RouteWithValidQuote, RouteWithValidQuote, V3RouteWithValidQuote, V4RouteWithValidQuote } from '../entities/route-with-valid-quote';
+export declare const ringUsdGasTokensByChain: {
+    [chainId in ChainId]?: Token[];
+};
+export declare const onlySupportV2NetworkUsdGasTokensByChain: {
+    [chainId in ChainId]?: Token[];
+};
+export declare type RingL1ToL2GasCosts = {
+    gasUsedL1: BigNumber;
+    gasUsedL1OnL2: BigNumber;
+    gasCostL1USD: CurrencyAmount;
+    gasCostL1QuoteToken: CurrencyAmount;
+};
+export declare type RingGasModelProviderConfig = ProviderConfig & {
+    additionalGasOverhead?: BigNumber;
+    gasToken?: Token;
+};
+export declare type BuildRingOnChainGasModelFactoryType = {
+    chainId: ChainId;
+    gasPriceWei: BigNumber;
+    pools: RingLiquidityCalculationPools;
+    amountToken: Token;
+    quoteToken: Token;
+    ringV2poolProvider: IRingV2PoolProvider;
+    l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    providerConfig?: RingGasModelProviderConfig;
+};
+export declare type BuildRingFewV2GasModelFactoryType = {
+    chainId: ChainId;
+    gasPriceWei: BigNumber;
+    poolProvider: IRingV2PoolProvider;
+    token: Token;
+    l2GasDataProvider?: IL2GasDataProvider<ArbitrumGasData>;
+    providerConfig?: RingGasModelProviderConfig;
+};
+export declare type RingLiquidityCalculationPools = {
+    usdPool: Pool;
+    nativeAndQuoteTokenV3Pool: Pool | null;
+    nativeAndAmountTokenV3Pool: Pool | null;
+    nativeAndSpecifiedGasTokenV3Pool: Pool | null;
+};
+export declare type RingGasModelType = {
+    ringV2GasModel?: IRingGasModel<RingFewV2RouteWithValidQuote>;
+    v3GasModel: IRingGasModel<V3RouteWithValidQuote>;
+    v4GasModel: IRingGasModel<V4RouteWithValidQuote>;
+    mixedRouteGasModel: IRingGasModel<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 IRingGasModel<TRouteWithValidQuote extends RouteWithValidQuote> = {
+    estimateGasCost(routeWithValidQuote: TRouteWithValidQuote): {
+        gasEstimate: BigNumber;
+        gasCostInToken: CurrencyAmount;
+        gasCostInUSD: CurrencyAmount;
+        gasCostInGasToken?: CurrencyAmount;
+    };
+    calculateL1GasFees?(routes: TRouteWithValidQuote[]): Promise<RingL1ToL2GasCosts>;
+};
+/**
+ * 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 IRingFewV2GasModelFactory
+ */
+export declare abstract class IRingFewV2GasModelFactory {
+    abstract buildGasModel({ chainId, gasPriceWei, poolProvider, token, providerConfig, }: BuildRingFewV2GasModelFactoryType): Promise<IRingGasModel<RingFewV2RouteWithValidQuote>>;
+}
+/**
+ * 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 IOnChainRingFewGasModelFactory
+ */
+export declare abstract class IOnChainRingFewGasModelFactory<TRouteWithValidQuote extends RouteWithValidQuote> {
+    abstract buildGasModel({ chainId, gasPriceWei, pools, amountToken, quoteToken, ringV2poolProvider, l2GasDataProvider, providerConfig, }: BuildRingOnChainGasModelFactoryType): Promise<IRingGasModel<TRouteWithValidQuote>>;
+    protected totalInitializedTicksCrossed(initializedTicksCrossedList: number[]): number;
+}
+export declare const getRingQuoteThroughNativePool: (chainId: ChainId, nativeTokenAmount: CurrencyAmountRaw<Token>, nativeTokenPool: Pool | Pair | RingV2Pair | null) => CurrencyAmount;

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

@@ -0,0 +1,163 @@
+import { ChainId, Token, } from '@ring-protocol/sdk-core';
+import { CUSD_CELO, CUSD_CELO_ALFAJORES, DAI_AVAX, DAI_BNB, DAI_GOERLI, DAI_OPTIMISM, DAI_OPTIMISM_GOERLI, DAI_OPTIMISM_SEPOLIA, DAI_POLYGON_MUMBAI, DAI_ZKSYNC, FEW_DAI_ARB_SEPOLIA, FEW_DAI_ARBITRUM, FEW_DAI_MAINNET, FEW_DAI_SEPOLIA, FEW_UNI_MAINNET, FEW_USDB_BLAST, FEW_USDC_ARBITRUM, FEW_USDC_BASE, FEW_USDC_BNB, FEW_USDC_MAINNET, FEW_USDC_SEPOLIA, FEW_USDC_STORY_MAINNET, FEW_USDC_UNICHAIN, FEW_USDT_ARBITRUM, FEW_USDT_BNB, FEW_USDT_HYPER_MAINNET, FEW_USDT_MAINNET, USDB_BLAST, USDC_ARBITRUM_GOERLI, USDC_AVAX, USDC_BASE_SEPOLIA, USDC_BNB, USDC_ETHEREUM_GNOSIS, USDC_GOERLI, USDC_MOONBEAM, USDC_OPTIMISM, USDC_OPTIMISM_GOERLI, USDC_OPTIMISM_SEPOLIA, USDC_POLYGON, USDC_SONEIUM, USDC_WORLDCHAIN, USDC_ZKSYNC, USDC_ZORA, USDCE_ZKSYNC, USDT_BNB, USDT_GOERLI, USDT_HYPER_MAINNET, USDT_MONAD_TESTNET, USDT_OPTIMISM, USDT_OPTIMISM_GOERLI, USDT_OPTIMISM_SEPOLIA, WBTC_GOERLI, } from '../../../providers/token-provider';
+import { FEW_WRAPPED_NATIVE_CURRENCY } from '../../../util';
+import { CurrencyAmount } from '../../../util/amounts';
+// When adding new usd gas tokens, ensure the tokens are ordered
+// from tokens with highest decimals to lowest decimals. For example,
+// DAI_AVAX has 18 decimals and comes before USDC_AVAX which has 6 decimals.
+export const ringUsdGasTokensByChain = {
+    [ChainId.HYPER_MAINNET]: [FEW_USDT_HYPER_MAINNET],
+    [ChainId.MAINNET]: [FEW_DAI_MAINNET, FEW_USDC_MAINNET, FEW_USDT_MAINNET, FEW_UNI_MAINNET],
+    [ChainId.ARBITRUM_ONE]: [FEW_DAI_ARBITRUM, FEW_USDC_ARBITRUM, FEW_USDT_ARBITRUM],
+    [ChainId.OPTIMISM]: [DAI_OPTIMISM, USDC_OPTIMISM, USDT_OPTIMISM],
+    [ChainId.OPTIMISM_GOERLI]: [
+        DAI_OPTIMISM_GOERLI,
+        USDC_OPTIMISM_GOERLI,
+        USDT_OPTIMISM_GOERLI,
+    ],
+    [ChainId.OPTIMISM_SEPOLIA]: [
+        DAI_OPTIMISM_SEPOLIA,
+        USDC_OPTIMISM_SEPOLIA,
+        USDT_OPTIMISM_SEPOLIA,
+    ],
+    [ChainId.ARBITRUM_GOERLI]: [USDC_ARBITRUM_GOERLI],
+    [ChainId.ARBITRUM_SEPOLIA]: [FEW_DAI_ARB_SEPOLIA],
+    [ChainId.GOERLI]: [DAI_GOERLI, USDC_GOERLI, USDT_GOERLI, WBTC_GOERLI],
+    [ChainId.SEPOLIA]: [FEW_DAI_SEPOLIA, FEW_USDC_SEPOLIA],
+    [ChainId.POLYGON]: [USDC_POLYGON],
+    [ChainId.POLYGON_MUMBAI]: [DAI_POLYGON_MUMBAI],
+    [ChainId.CELO]: [CUSD_CELO],
+    [ChainId.CELO_ALFAJORES]: [CUSD_CELO_ALFAJORES],
+    [ChainId.GNOSIS]: [USDC_ETHEREUM_GNOSIS],
+    [ChainId.MOONBEAM]: [USDC_MOONBEAM],
+    [ChainId.BNB]: [FEW_USDT_BNB, FEW_USDC_BNB],
+    [ChainId.AVALANCHE]: [DAI_AVAX, USDC_AVAX],
+    [ChainId.BASE]: [FEW_USDC_BASE],
+    [ChainId.BLAST]: [FEW_USDB_BLAST],
+    [ChainId.ZORA]: [USDC_ZORA],
+    [ChainId.ZKSYNC]: [DAI_ZKSYNC, USDCE_ZKSYNC, USDC_ZKSYNC],
+    [ChainId.WORLDCHAIN]: [USDC_WORLDCHAIN],
+    [ChainId.UNICHAIN_SEPOLIA]: [FEW_DAI_SEPOLIA, FEW_USDC_SEPOLIA],
+    [ChainId.MONAD_TESTNET]: [USDT_MONAD_TESTNET],
+    [ChainId.BASE_SEPOLIA]: [USDC_BASE_SEPOLIA],
+    [ChainId.UNICHAIN]: [FEW_USDC_UNICHAIN],
+    [ChainId.SONEIUM]: [USDC_SONEIUM],
+    [ChainId.STORY_MAINNET]: [FEW_USDC_STORY_MAINNET],
+};
+export const onlySupportV2NetworkUsdGasTokensByChain = {
+    [ChainId.HYPER_MAINNET]: [USDT_HYPER_MAINNET],
+    [ChainId.MAINNET]: [FEW_DAI_MAINNET, FEW_USDC_MAINNET, FEW_USDT_MAINNET, FEW_UNI_MAINNET],
+    [ChainId.ARBITRUM_ONE]: [FEW_DAI_ARBITRUM, FEW_USDC_ARBITRUM, FEW_USDT_ARBITRUM],
+    [ChainId.OPTIMISM]: [DAI_OPTIMISM, USDC_OPTIMISM, USDT_OPTIMISM],
+    [ChainId.OPTIMISM_GOERLI]: [
+        DAI_OPTIMISM_GOERLI,
+        USDC_OPTIMISM_GOERLI,
+        USDT_OPTIMISM_GOERLI,
+    ],
+    [ChainId.OPTIMISM_SEPOLIA]: [
+        DAI_OPTIMISM_SEPOLIA,
+        USDC_OPTIMISM_SEPOLIA,
+        USDT_OPTIMISM_SEPOLIA,
+    ],
+    [ChainId.ARBITRUM_GOERLI]: [USDC_ARBITRUM_GOERLI],
+    [ChainId.ARBITRUM_SEPOLIA]: [FEW_DAI_ARB_SEPOLIA],
+    [ChainId.GOERLI]: [DAI_GOERLI, USDC_GOERLI, USDT_GOERLI, WBTC_GOERLI],
+    [ChainId.SEPOLIA]: [FEW_DAI_SEPOLIA, FEW_USDC_SEPOLIA],
+    [ChainId.POLYGON]: [USDC_POLYGON],
+    [ChainId.POLYGON_MUMBAI]: [DAI_POLYGON_MUMBAI],
+    [ChainId.CELO]: [CUSD_CELO],
+    [ChainId.CELO_ALFAJORES]: [CUSD_CELO_ALFAJORES],
+    [ChainId.GNOSIS]: [USDC_ETHEREUM_GNOSIS],
+    [ChainId.MOONBEAM]: [USDC_MOONBEAM],
+    [ChainId.BNB]: [USDT_BNB, USDC_BNB, DAI_BNB],
+    [ChainId.AVALANCHE]: [DAI_AVAX, USDC_AVAX],
+    [ChainId.BASE]: [FEW_USDC_BASE],
+    [ChainId.BLAST]: [USDB_BLAST],
+    [ChainId.ZORA]: [USDC_ZORA],
+    [ChainId.ZKSYNC]: [DAI_ZKSYNC, USDCE_ZKSYNC, USDC_ZKSYNC],
+    [ChainId.WORLDCHAIN]: [USDC_WORLDCHAIN],
+    [ChainId.UNICHAIN_SEPOLIA]: [FEW_DAI_SEPOLIA, FEW_USDC_SEPOLIA],
+    [ChainId.MONAD_TESTNET]: [USDT_MONAD_TESTNET],
+    [ChainId.BASE_SEPOLIA]: [USDC_BASE_SEPOLIA],
+    [ChainId.UNICHAIN]: [FEW_USDC_UNICHAIN],
+    [ChainId.SONEIUM]: [USDC_SONEIUM],
+    [ChainId.STORY_MAINNET]: [FEW_USDC_STORY_MAINNET],
+};
+/**
+ * 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 IRingFewV2GasModelFactory
+ */
+export class IRingFewV2GasModelFactory {
+}
+/**
+ * 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 IOnChainRingFewGasModelFactory
+ */
+export class IOnChainRingFewGasModelFactory {
+    totalInitializedTicksCrossed(initializedTicksCrossedList) {
+        let ticksCrossed = 0;
+        for (let i = 0; i < initializedTicksCrossedList.length; i++) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            if (initializedTicksCrossedList[i] > 0) {
+                // Quoter returns Array<number of calls to crossTick + 1>, so we need to subtract 1 here.
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                ticksCrossed += initializedTicksCrossedList[i] - 1;
+            }
+        }
+        return ticksCrossed;
+    }
+}
+// Determines if native currency is token0
+// Gets the native price of the pool, dependent on 0 or 1
+// quotes across the pool
+export const getRingQuoteThroughNativePool = (chainId, nativeTokenAmount, nativeTokenPool) => {
+    // if(!isFewToken(nativeTokenPool.token0) || !isFewToken(nativeTokenPool.token1)) {
+    //   const nativeCurrency = WRAPPED_NATIVE_CURRENCY[chainId];
+    //   const isToken0 = nativeTokenPool.token0.equals(nativeCurrency!.wrapped);
+    //   // returns mid price in terms of the native currency (the ratio of token/nativeToken)
+    //   const nativeTokenPrice = isToken0
+    //     ? nativeTokenPool.token0Price
+    //     : nativeTokenPool.token1Price;
+    //   return nativeTokenPrice.quote(nativeTokenAmount) as CurrencyAmount;
+    // } else {
+    //   const nativeCurrency = FEW_WRAPPED_NATIVE_CURRENCY[chainId];
+    //   const isToken0 = nativeTokenPool.token0.equals(nativeCurrency!.wrapped);
+    //   // returns mid price in terms of the native currency (the ratio of token/nativeToken)
+    //   const nativeTokenPrice = isToken0
+    //     ? nativeTokenPool.token0Price
+    //     : nativeTokenPool.token1Price;
+    //   const FewBaseCurrency = getFewTokenFromOriginalToken(nativeTokenPrice.baseCurrency, chainId)
+    //   const FewQuoteCurrency = getFewTokenFromOriginalToken(nativeTokenPrice.quoteCurrency, chainId)
+    //   const fewNativeTokenPrice = new Price(
+    //     FewBaseCurrency,
+    //     FewQuoteCurrency,
+    //     nativeTokenPrice.denominator,
+    //     nativeTokenPrice.numerator
+    //   );
+    //   // return gas cost in terms of the non native currency
+    //   return fewNativeTokenPrice.quote(nativeTokenAmount) as CurrencyAmount;
+    // }
+    const nativeCurrency = FEW_WRAPPED_NATIVE_CURRENCY[chainId];
+    const isToken0 = nativeTokenPool != null ? nativeTokenPool.token0.equals(nativeCurrency.wrapped) : false;
+    // returns mid price in terms of the native currency (the ratio of token/nativeToken)
+    const nativeTokenPrice = isToken0
+        ? nativeTokenPool != null ? nativeTokenPool.token0Price : null
+        : nativeTokenPool != null ? nativeTokenPool.token1Price : null;
+    // return gas cost in terms of the non native currency
+    return nativeTokenPrice != null ? nativeTokenPrice.quote(nativeTokenAmount) : CurrencyAmount.fromRawAmount(nativeTokenAmount.currency instanceof Token ? nativeTokenAmount.currency : nativeCurrency, 0);
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ring-gas-model.js","sourceRoot":"","sources":["../../../../../src/routers/alpha-router/gas-models/ring-gas-model.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EAEP,KAAK,GACN,MAAM,yBAAyB,CAAC;AAOjC,OAAO,EACL,SAAS,EACT,mBAAmB,EACnB,QAAQ,EACR,OAAO,EACP,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,iBAAiB,EACjB,QAAQ,EACR,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,WAAW,EACX,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,GACZ,MAAM,mCAAmC,CAAC;AAK3C,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AASvD,gEAAgE;AAChE,qEAAqE;AACrE,4EAA4E;AAC5E,MAAM,CAAC,MAAM,uBAAuB,GAAuC;IACzE,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,sBAAsB,CAAC;IACjD,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,eAAe,CAAC;IACzF,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;IAChF,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,aAAa,CAAC;IAChE,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;QACzB,mBAAmB;QACnB,oBAAoB;QACpB,oBAAoB;KACrB;IACD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1B,oBAAoB;QACpB,qBAAqB;QACrB,qBAAqB;KACtB;IACD,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,oBAAoB,CAAC;IACjD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,mBAAmB,CAAC;IACjD,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC;IACrE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IACtD,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IACjC,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,kBAAkB,CAAC;IAC9C,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC;IAC3B,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,mBAAmB,CAAC;IAC/C,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC;IACxC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,aAAa,CAAC;IACnC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC;IAC3C,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC1C,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC;IAC/B,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,CAAC;IACjC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC;IAC3B,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,WAAW,CAAC;IACzD,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,eAAe,CAAC;IACvC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC/D,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,kBAAkB,CAAC;IAC7C,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,iBAAiB,CAAC;IAC3C,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,iBAAiB,CAAC;IACvC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IACjC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,sBAAsB,CAAC;CAClD,CAAC;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAuC;IACzF,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,kBAAkB,CAAC;IAC7C,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,eAAe,CAAC;IACzF,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;IAChF,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,aAAa,CAAC;IAChE,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;QACzB,mBAAmB;QACnB,oBAAoB;QACpB,oBAAoB;KACrB;IACD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1B,oBAAoB;QACpB,qBAAqB;QACrB,qBAAqB;KACtB;IACD,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,oBAAoB,CAAC;IACjD,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,mBAAmB,CAAC;IACjD,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC;IACrE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IACtD,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IACjC,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,kBAAkB,CAAC;IAC9C,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC;IAC3B,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,mBAAmB,CAAC;IAC/C,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC;IACxC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,aAAa,CAAC;IACnC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC;IAC5C,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC1C,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC;IAC/B,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC;IAC7B,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC;IAC3B,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,WAAW,CAAC;IACzD,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,eAAe,CAAC;IACvC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC/D,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,kBAAkB,CAAC;IAC7C,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,iBAAiB,CAAC;IAC3C,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,iBAAiB,CAAC;IACvC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC;IACjC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,sBAAsB,CAAC;CAClD,CAAC;AA8EF;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,yBAAyB;CAQ9C;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,8BAA8B;IAcxC,4BAA4B,CACpC,2BAAqC;QAErC,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,2BAA2B,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC3D,oEAAoE;YACpE,IAAI,2BAA2B,CAAC,CAAC,CAAE,GAAG,CAAC,EAAE;gBACvC,yFAAyF;gBACzF,oEAAoE;gBACpE,YAAY,IAAI,2BAA2B,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC;aACrD;SACF;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED,0CAA0C;AAC1C,yDAAyD;AACzD,yBAAyB;AACzB,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,OAAgB,EAChB,iBAA2C,EAC3C,eAAgD,EAChC,EAAE;IAClB,mFAAmF;IACnF,6DAA6D;IAC7D,6EAA6E;IAC7E,0FAA0F;IAC1F,sCAAsC;IACtC,oCAAoC;IACpC,qCAAqC;IAErC,wEAAwE;IACxE,WAAW;IACX,iEAAiE;IACjE,6EAA6E;IAC7E,0FAA0F;IAC1F,sCAAsC;IACtC,oCAAoC;IACpC,qCAAqC;IAErC,iGAAiG;IACjG,mGAAmG;IACnG,2CAA2C;IAC3C,uBAAuB;IACvB,wBAAwB;IACxB,oCAAoC;IACpC,iCAAiC;IACjC,OAAO;IAEP,2DAA2D;IAC3D,2EAA2E;IAC3E,IAAI;IACJ,MAAM,cAAc,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,cAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1G,qFAAqF;IACrF,MAAM,gBAAgB,GAAG,QAAQ;QAC/B,CAAC,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI;QAC9D,CAAC,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,sDAAsD;IACtD,OAAO,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,iBAAiB,CAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,YAAY,KAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAe,EAAE,CAAC,CAAC,CAAC;AAC9N,CAAC,CAAC"}

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

@@ -0,0 +1,21 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { ChainId } from '@ring-protocol/sdk-core';
+import { UniswapFewV3RouteWithValidQuote, UniswapFewV4RouteWithValidQuote, V3RouteWithValidQuote, V4RouteWithValidQuote } from '../entities';
+import { BuildOnChainGasModelFactoryType, GasModelProviderConfig, IGasModel, IOnChainGasModelFactory } from './gas-model';
+export declare abstract class TickBasedHeuristicGasModelFactory<TRouteWithValidQuote extends V3RouteWithValidQuote | UniswapFewV3RouteWithValidQuote | V4RouteWithValidQuote | UniswapFewV4RouteWithValidQuote> extends IOnChainGasModelFactory<TRouteWithValidQuote> {
+    protected provider: BaseProvider;
+    protected constructor(provider: BaseProvider);
+    protected buildGasModelInternal({ chainId, gasPriceWei, pools, amountToken, quoteToken, l2GasDataProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<TRouteWithValidQuote>>;
+    protected buildFewGasModelInternal({ chainId, gasPriceWei, pools, amountToken, quoteToken, l2GasDataProvider, providerConfig, }: BuildOnChainGasModelFactoryType): Promise<IGasModel<TRouteWithValidQuote>>;
+    protected estimateGas(routeWithValidQuote: TRouteWithValidQuote, gasPriceWei: BigNumber, chainId: ChainId, providerConfig?: GasModelProviderConfig): {
+        totalGasCostNativeCurrency: import("@ring-protocol/sdk-core").CurrencyAmount<import("@ring-protocol/sdk-core").Token>;
+        totalInitializedTicksCrossed: number;
+        baseGasUse: BigNumber;
+    };
+    protected estimateFewGas(routeWithValidQuote: TRouteWithValidQuote, gasPriceWei: BigNumber, chainId: ChainId, providerConfig?: GasModelProviderConfig): {
+        totalGasCostNativeCurrency: import("@ring-protocol/sdk-core").CurrencyAmount<import("@ring-protocol/sdk-core").Token>;
+        totalInitializedTicksCrossed: number;
+        baseGasUse: BigNumber;
+    };
+}