@ring-protocol/smart-order-router 0.5.0

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

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQuoteThroughNativePool = exports.IOnChainGasModelFactory = exports.IV2GasModelFactory = exports.usdGasTokensByChain = void 0;
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const token_provider_1 = require("../../../providers/token-provider");
+const util_1 = require("../../../util");
+const amounts_1 = require("../../../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.
+exports.usdGasTokensByChain = {
+    [sdk_core_1.ChainId.HYPER_MAINNET]: [token_provider_1.USDT_HYPER_MAINNET],
+    [sdk_core_1.ChainId.MAINNET]: [token_provider_1.DAI_MAINNET, token_provider_1.USDC_MAINNET, token_provider_1.USDT_MAINNET],
+    [sdk_core_1.ChainId.ARBITRUM_ONE]: [
+        token_provider_1.DAI_ARBITRUM,
+        token_provider_1.USDC_ARBITRUM,
+        token_provider_1.USDC_NATIVE_ARBITRUM,
+        token_provider_1.USDT_ARBITRUM,
+    ],
+    [sdk_core_1.ChainId.OPTIMISM]: [
+        token_provider_1.DAI_OPTIMISM,
+        token_provider_1.USDC_OPTIMISM,
+        token_provider_1.USDC_NATIVE_OPTIMISM,
+        token_provider_1.USDT_OPTIMISM,
+    ],
+    [sdk_core_1.ChainId.OPTIMISM_GOERLI]: [
+        token_provider_1.DAI_OPTIMISM_GOERLI,
+        token_provider_1.USDC_OPTIMISM_GOERLI,
+        token_provider_1.USDT_OPTIMISM_GOERLI,
+    ],
+    [sdk_core_1.ChainId.OPTIMISM_SEPOLIA]: [
+        token_provider_1.DAI_OPTIMISM_SEPOLIA,
+        token_provider_1.USDC_OPTIMISM_SEPOLIA,
+        token_provider_1.USDT_OPTIMISM_SEPOLIA,
+    ],
+    [sdk_core_1.ChainId.ARBITRUM_GOERLI]: [token_provider_1.USDC_ARBITRUM_GOERLI],
+    [sdk_core_1.ChainId.ARBITRUM_SEPOLIA]: [token_provider_1.USDC_ARBITRUM_SEPOLIA],
+    [sdk_core_1.ChainId.GOERLI]: [token_provider_1.DAI_GOERLI, token_provider_1.USDC_GOERLI, token_provider_1.USDT_GOERLI, token_provider_1.WBTC_GOERLI],
+    [sdk_core_1.ChainId.SEPOLIA]: [token_provider_1.USDC_SEPOLIA, token_provider_1.DAI_SEPOLIA],
+    [sdk_core_1.ChainId.POLYGON]: [token_provider_1.USDC_POLYGON, token_provider_1.USDC_NATIVE_POLYGON],
+    [sdk_core_1.ChainId.POLYGON_MUMBAI]: [token_provider_1.DAI_POLYGON_MUMBAI],
+    [sdk_core_1.ChainId.CELO]: [token_provider_1.CUSD_CELO, token_provider_1.USDC_CELO, token_provider_1.USDC_NATIVE_CELO, token_provider_1.USDC_WORMHOLE_CELO],
+    [sdk_core_1.ChainId.CELO_ALFAJORES]: [token_provider_1.CUSD_CELO_ALFAJORES],
+    [sdk_core_1.ChainId.GNOSIS]: [token_provider_1.USDC_ETHEREUM_GNOSIS],
+    [sdk_core_1.ChainId.MOONBEAM]: [token_provider_1.USDC_MOONBEAM],
+    [sdk_core_1.ChainId.BNB]: [token_provider_1.USDT_BNB, token_provider_1.USDC_BNB, token_provider_1.DAI_BNB],
+    [sdk_core_1.ChainId.AVALANCHE]: [
+        token_provider_1.DAI_AVAX,
+        token_provider_1.USDC_AVAX,
+        token_provider_1.USDC_NATIVE_AVAX,
+        token_provider_1.USDC_BRIDGED_AVAX,
+    ],
+    [sdk_core_1.ChainId.BASE]: [token_provider_1.USDC_BASE, token_provider_1.USDC_NATIVE_BASE],
+    [sdk_core_1.ChainId.BLAST]: [token_provider_1.USDB_BLAST],
+    [sdk_core_1.ChainId.ZORA]: [token_provider_1.USDC_ZORA],
+    [sdk_core_1.ChainId.ZKSYNC]: [token_provider_1.DAI_ZKSYNC, token_provider_1.USDCE_ZKSYNC, token_provider_1.USDC_ZKSYNC],
+    [sdk_core_1.ChainId.WORLDCHAIN]: [token_provider_1.USDC_WORLDCHAIN],
+    [sdk_core_1.ChainId.UNICHAIN_SEPOLIA]: [token_provider_1.USDC_UNICHAIN_SEPOLIA],
+    [sdk_core_1.ChainId.MONAD_TESTNET]: [token_provider_1.USDT_MONAD_TESTNET],
+    [sdk_core_1.ChainId.BASE_SEPOLIA]: [token_provider_1.USDC_BASE_SEPOLIA],
+    [sdk_core_1.ChainId.UNICHAIN]: [token_provider_1.DAI_UNICHAIN, token_provider_1.USDC_UNICHAIN],
+    [sdk_core_1.ChainId.SONEIUM]: [token_provider_1.USDC_SONEIUM],
+    [sdk_core_1.ChainId.STORY_MAINNET]: [token_provider_1.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 IV2GasModelFactory
+ */
+class IV2GasModelFactory {
+}
+exports.IV2GasModelFactory = IV2GasModelFactory;
+/**
+ * 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
+ */
+class IOnChainGasModelFactory {
+    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;
+    }
+}
+exports.IOnChainGasModelFactory = IOnChainGasModelFactory;
+// Determines if native currency is token0
+// Gets the native price of the pool, dependent on 0 or 1
+// quotes across the pool
+const getQuoteThroughNativePool = (chainId, nativeTokenAmount, nativeTokenPool) => {
+    const nativeCurrency = util_1.WRAPPED_NATIVE_CURRENCY[chainId];
+    const isToken0 = nativeTokenPool != null ? nativeTokenPool.token0.equals(nativeCurrency) : 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) : amounts_1.CurrencyAmount.fromRawAmount(nativeTokenAmount.currency instanceof sdk_core_1.Token ? nativeTokenAmount.currency : nativeCurrency, 0);
+    // return nativeTokenPrice != null ? nativeTokenPrice.quote(nativeTokenAmount) as CurrencyAmount : CurrencyAmount.fromRawAmount(nativeTokenAmount.token, 0);
+};
+exports.getQuoteThroughNativePool = getQuoteThroughNativePool;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLW1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3JvdXRlcnMvYWxwaGEtcm91dGVyL2dhcy1tb2RlbHMvZ2FzLW1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLHNEQUlpQztBQUtqQyxzRUEyRDJDO0FBTTNDLHdDQUF3RDtBQUN4RCxtREFBdUQ7QUFZdkQsZ0VBQWdFO0FBQ2hFLHFFQUFxRTtBQUNyRSw0RUFBNEU7QUFDL0QsUUFBQSxtQkFBbUIsR0FBdUM7SUFDckUsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFLENBQUMsbUNBQWtCLENBQUM7SUFDN0MsQ0FBQyxrQkFBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUMsNEJBQVcsRUFBRSw2QkFBWSxFQUFFLDZCQUFZLENBQUM7SUFDNUQsQ0FBQyxrQkFBTyxDQUFDLFlBQVksQ0FBQyxFQUFFO1FBQ3RCLDZCQUFZO1FBQ1osOEJBQWE7UUFDYixxQ0FBb0I7UUFDcEIsOEJBQWE7S0FDZDtJQUNELENBQUMsa0JBQU8sQ0FBQyxRQUFRLENBQUMsRUFBRTtRQUNsQiw2QkFBWTtRQUNaLDhCQUFhO1FBQ2IscUNBQW9CO1FBQ3BCLDhCQUFhO0tBQ2Q7SUFDRCxDQUFDLGtCQUFPLENBQUMsZUFBZSxDQUFDLEVBQUU7UUFDekIsb0NBQW1CO1FBQ25CLHFDQUFvQjtRQUNwQixxQ0FBb0I7S0FDckI7SUFDRCxDQUFDLGtCQUFPLENBQUMsZ0JBQWdCLENBQUMsRUFBRTtRQUMxQixxQ0FBb0I7UUFDcEIsc0NBQXFCO1FBQ3JCLHNDQUFxQjtLQUN0QjtJQUNELENBQUMsa0JBQU8sQ0FBQyxlQUFlLENBQUMsRUFBRSxDQUFDLHFDQUFvQixDQUFDO0lBQ2pELENBQUMsa0JBQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUMsc0NBQXFCLENBQUM7SUFDbkQsQ0FBQyxrQkFBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsMkJBQVUsRUFBRSw0QkFBVyxFQUFFLDRCQUFXLEVBQUUsNEJBQVcsQ0FBQztJQUNyRSxDQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyw2QkFBWSxFQUFFLDRCQUFXLENBQUM7SUFDOUMsQ0FBQyxrQkFBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUMsNkJBQVksRUFBRSxvQ0FBbUIsQ0FBQztJQUN0RCxDQUFDLGtCQUFPLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQyxtQ0FBa0IsQ0FBQztJQUM5QyxDQUFDLGtCQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQywwQkFBUyxFQUFFLDBCQUFTLEVBQUUsaUNBQWdCLEVBQUUsbUNBQWtCLENBQUM7SUFDNUUsQ0FBQyxrQkFBTyxDQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUMsb0NBQW1CLENBQUM7SUFDL0MsQ0FBQyxrQkFBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMscUNBQW9CLENBQUM7SUFDeEMsQ0FBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsOEJBQWEsQ0FBQztJQUNuQyxDQUFDLGtCQUFPLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyx5QkFBUSxFQUFFLHlCQUFRLEVBQUUsd0JBQU8sQ0FBQztJQUM1QyxDQUFDLGtCQUFPLENBQUMsU0FBUyxDQUFDLEVBQUU7UUFDbkIseUJBQVE7UUFDUiwwQkFBUztRQUNULGlDQUFnQjtRQUNoQixrQ0FBaUI7S0FDbEI7SUFDRCxDQUFDLGtCQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQywwQkFBUyxFQUFFLGlDQUFnQixDQUFDO0lBQzdDLENBQUMsa0JBQU8sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLDJCQUFVLENBQUM7SUFDN0IsQ0FBQyxrQkFBTyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsMEJBQVMsQ0FBQztJQUMzQixDQUFDLGtCQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQywyQkFBVSxFQUFFLDZCQUFZLEVBQUUsNEJBQVcsQ0FBQztJQUN6RCxDQUFDLGtCQUFPLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FBQyxnQ0FBZSxDQUFDO0lBQ3ZDLENBQUMsa0JBQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUMsc0NBQXFCLENBQUM7SUFDbkQsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFLENBQUMsbUNBQWtCLENBQUM7SUFDN0MsQ0FBQyxrQkFBTyxDQUFDLFlBQVksQ0FBQyxFQUFFLENBQUMsa0NBQWlCLENBQUM7SUFDM0MsQ0FBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsNkJBQVksRUFBRSw4QkFBYSxDQUFDO0lBQ2pELENBQUMsa0JBQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLDZCQUFZLENBQUM7SUFDakMsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFLENBQUMsbUNBQWtCLENBQUM7Q0FDOUMsQ0FBQztBQWtGRjs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBc0Isa0JBQWtCO0NBUXZDO0FBUkQsZ0RBUUM7QUFFRDs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBc0IsdUJBQXVCO0lBY2pDLDRCQUE0QixDQUNwQywyQkFBcUM7UUFFckMsSUFBSSxZQUFZLEdBQUcsQ0FBQyxDQUFDO1FBQ3JCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRywyQkFBMkIsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDM0Qsb0VBQW9FO1lBQ3BFLElBQUksMkJBQTJCLENBQUMsQ0FBQyxDQUFFLEdBQUcsQ0FBQyxFQUFFO2dCQUN2Qyx5RkFBeUY7Z0JBQ3pGLG9FQUFvRTtnQkFDcEUsWUFBWSxJQUFJLDJCQUEyQixDQUFDLENBQUMsQ0FBRSxHQUFHLENBQUMsQ0FBQzthQUNyRDtTQUNGO1FBRUQsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGO0FBN0JELDBEQTZCQztBQUVELDBDQUEwQztBQUMxQyx5REFBeUQ7QUFDekQseUJBQXlCO0FBQ2xCLE1BQU0seUJBQXlCLEdBQUcsQ0FDdkMsT0FBZ0IsRUFDaEIsaUJBQTJDLEVBQzNDLGVBQW1DLEVBQ25CLEVBQUU7SUFDbEIsTUFBTSxjQUFjLEdBQUcsOEJBQXVCLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDeEQsTUFBTSxRQUFRLEdBQUcsZUFBZSxJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQztJQUNqRyxxRkFBcUY7SUFDckYsTUFBTSxnQkFBZ0IsR0FBRyxRQUFRO1FBQy9CLENBQUMsQ0FBQyxlQUFlLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJO1FBQzlELENBQUMsQ0FBQyxlQUFlLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7SUFDakUsc0RBQXNEO0lBQ3RELE9BQU8sZ0JBQWdCLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsaUJBQWlCLENBQW1CLENBQUMsQ0FBQyxDQUFDLHdCQUFjLENBQUMsYUFBYSxDQUFDLGlCQUFpQixDQUFDLFFBQVEsWUFBWSxnQkFBSyxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLGNBQWUsRUFBRSxDQUFDLENBQUMsQ0FBQztJQUM1Tiw0SkFBNEo7QUFDOUosQ0FBQyxDQUFDO0FBZFcsUUFBQSx5QkFBeUIsNkJBY3BDIn0=

package/build/main/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/main/routers/alpha-router/gas-models/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./gas-model"), exports);
+__exportStar(require("./ring-gas-model"), exports);
+__exportStar(require("./fewV2/v2-heuristic-gas-model"), exports);
+__exportStar(require("./v3/v3-heuristic-gas-model"), exports);
+__exportStar(require("./uniswapFewV3/v3-heuristic-gas-model"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvcm91dGVycy9hbHBoYS1yb3V0ZXIvZ2FzLW1vZGVscy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsOENBQTRCO0FBQzVCLG1EQUFpQztBQUNqQyxpRUFBK0M7QUFDL0MsOERBQTRDO0FBQzVDLHdFQUFzRCJ9

package/build/main/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/main/routers/alpha-router/gas-models/mixedRoute/mixed-route-heuristic-gas-model.js

@@ -0,0 +1,161 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MixedRouteHeuristicGasModelFactory = void 0;
+const bignumber_1 = require("@ethersproject/bignumber");
+const router_sdk_1 = require("@ring-protocol/router-sdk");
+const v2_sdk_1 = require("@ring-protocol/v2-sdk");
+const v3_sdk_1 = require("@ring-protocol/v3-sdk");
+const v4_sdk_1 = require("@ring-protocol/v4-sdk");
+const jsbi_1 = __importDefault(require("jsbi"));
+const __1 = require("../../../..");
+const util_1 = require("../../../../util");
+const amounts_1 = require("../../../../util/amounts");
+const gas_factory_helpers_1 = require("../../../../util/gas-factory-helpers");
+const gas_costs_1 = require("../gas-costs");
+const gas_model_1 = require("../gas-model");
+const v2_heuristic_gas_model_1 = require("../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
+ */
+class MixedRouteHeuristicGasModelFactory extends gas_model_1.IOnChainGasModelFactory {
+    async buildGasModel({ chainId, gasPriceWei, pools, quoteToken, v2poolProvider: V2poolProvider, providerConfig, }) {
+        const nativeCurrency = __1.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 (0, gas_factory_helpers_1.getV2NativePool)(quoteToken, V2poolProvider, providerConfig);
+        }
+        const estimateGasCost = (routeWithValidQuote) => {
+            var _a;
+            const { totalGasCostNativeCurrency, baseGasUse } = this.estimateGas(routeWithValidQuote, gasPriceWei, chainId, providerConfig);
+            /** ------ MARK: USD Logic -------- */
+            const gasCostInTermsOfUSD = (0, gas_model_1.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 = (0, gas_model_1.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) {
+                util_1.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: amounts_1.CurrencyAmount.fromRawAmount(quoteToken, 0),
+                    gasCostInUSD: amounts_1.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_1.default.equal(nativeV3Pool.liquidity, jsbi_1.default.BigInt(0))) &&
+                nativeV2Pool
+                ? nativeV2Pool
+                : nativeV3Pool;
+            const gasCostInTermsOfQuoteToken = (0, gas_model_1.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_1.BigNumber.from(0);
+        let baseGasUseV3Only = bignumber_1.BigNumber.from(0);
+        let baseGasUse = bignumber_1.BigNumber.from(0);
+        let routeContainsV4Pool = false;
+        const route = routeWithValidQuote.route;
+        const res = (0, router_sdk_1.partitionMixedRouteByProtocol)(route);
+        res.map((section) => {
+            if (section.every((pool) => pool instanceof v3_sdk_1.Pool)) {
+                baseGasUseV3Only = baseGasUseV3Only.add((0, gas_costs_1.BASE_SWAP_COST)(chainId));
+                baseGasUseV3Only = baseGasUseV3Only.add((0, gas_costs_1.COST_PER_HOP)(chainId).mul(section.length));
+                baseGasUse = baseGasUse.add(baseGasUseV3Only);
+            }
+            else if (section.every((pool) => pool instanceof v2_sdk_1.Pair)) {
+                baseGasUseV2Only = baseGasUseV2Only.add(v2_heuristic_gas_model_1.BASE_SWAP_COST);
+                baseGasUseV2Only = baseGasUseV2Only.add(
+                /// same behavior in v2 heuristic gas model factory
+                v2_heuristic_gas_model_1.COST_PER_EXTRA_HOP.mul(section.length - 1));
+                baseGasUse = baseGasUse.add(baseGasUseV2Only);
+            }
+            else if (section.every((pool) => pool instanceof v4_sdk_1.Pool)) {
+                routeContainsV4Pool = true;
+            }
+        });
+        const tickGasUse = (0, gas_costs_1.COST_PER_INIT_TICK)(chainId).mul(totalInitializedTicksCrossed);
+        const uninitializedTickGasUse = gas_costs_1.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 = __1.WRAPPED_NATIVE_CURRENCY[chainId];
+        const totalGasCostNativeCurrency = amounts_1.CurrencyAmount.fromRawAmount(wrappedCurrency, baseGasCostWei.toString());
+        return {
+            totalGasCostNativeCurrency,
+            totalInitializedTicksCrossed,
+            baseGasUse,
+        };
+    }
+}
+exports.MixedRouteHeuristicGasModelFactory = MixedRouteHeuristicGasModelFactory;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWl4ZWQtcm91dGUtaGV1cmlzdGljLWdhcy1tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9yb3V0ZXJzL2FscGhhLXJvdXRlci9nYXMtbW9kZWxzL21peGVkUm91dGUvbWl4ZWQtcm91dGUtaGV1cmlzdGljLWdhcy1tb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSx3REFBcUQ7QUFDckQsMERBQTBFO0FBRTFFLGtEQUE2QztBQUM3QyxrREFBdUQ7QUFDdkQsa0RBQXVEO0FBQ3ZELGdEQUF3QjtBQUd4QixtQ0FBc0Q7QUFDdEQsMkNBQXVDO0FBQ3ZDLHNEQUEwRDtBQUMxRCw4RUFBdUU7QUFFdkUsNENBS3NCO0FBQ3RCLDRDQU1zQjtBQUN0Qix5RUFHc0M7QUFFdEM7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBaUJHO0FBQ0gsTUFBYSxrQ0FBbUMsU0FBUSxtQ0FBaUQ7SUFDaEcsS0FBSyxDQUFDLGFBQWEsQ0FBQyxFQUN6QixPQUFPLEVBQ1AsV0FBVyxFQUNYLEtBQUssRUFDTCxVQUFVLEVBQ1YsY0FBYyxFQUFFLGNBQWMsRUFDOUIsY0FBYyxHQUNrQjtRQUdoQyxNQUFNLGNBQWMsR0FBRywyQkFBdUIsQ0FBQyxPQUFPLENBQUUsQ0FBQztRQUN6RCxNQUFNLE9BQU8sR0FBa0IsS0FBSyxJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO1FBQ3BFLE1BQU0sUUFBUSxHQUFHLE9BQU8sSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDO1lBQ3ZFLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTTtZQUNoQixDQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7UUFFM0IsSUFBSSxZQUF5QixDQUFDO1FBQzlCLGdIQUFnSDtRQUNoSCxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsSUFBSSxjQUFjLEVBQUU7WUFDeEQsZUFBZTtZQUNmLFlBQVksR0FBRyxNQUFNLElBQUEscUNBQWUsRUFDbEMsVUFBVSxFQUNWLGNBQWMsRUFDZCxjQUFjLENBQ2YsQ0FBQztTQUNIO1FBRUQsTUFBTSxlQUFlLEdBQUcsQ0FDdEIsbUJBQTZDLEVBTTdDLEVBQUU7O1lBQ0YsTUFBTSxFQUFFLDBCQUEwQixFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQ2pFLG1CQUFtQixFQUNuQixXQUFXLEVBQ1gsT0FBTyxFQUNQLGNBQWMsQ0FDZixDQUFDO1lBRUYsc0NBQXNDO1lBQ3RDLE1BQU0sbUJBQW1CLEdBQUcsSUFBQSxxQ0FBeUIsRUFDbkQsT0FBTyxFQUNQLDBCQUEwQixFQUMxQixPQUFPLENBQ1IsQ0FBQztZQUVGLDRFQUE0RTtZQUM1RSxNQUFNLDhCQUE4QixHQUNsQyxLQUFLLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsZ0NBQWdDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUNoRSxJQUFJLHdCQUF3QixHQUErQixTQUFTLENBQUM7WUFDckUsSUFBSSw4QkFBOEIsRUFBRTtnQkFDbEMsd0JBQXdCLEdBQUcsSUFBQSxxQ0FBeUIsRUFDbEQsT0FBTyxFQUNQLDBCQUEwQixFQUMxQiw4QkFBOEIsQ0FDL0IsQ0FBQzthQUNIO1lBQ0QseUZBQXlGO2lCQUNwRixJQUFJLE1BQUEsY0FBYyxhQUFkLGNBQWMsdUJBQWQsY0FBYyxDQUFFLFFBQVEsMENBQUUsTUFBTSxDQUFDLGNBQWMsQ0FBQyxFQUFFO2dCQUN6RCx3QkFBd0IsR0FBRywwQkFBMEIsQ0FBQzthQUN2RDtZQUVELGlGQUFpRjtZQUNqRixJQUFJLFVBQVUsQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLEVBQUU7Z0JBQ3JDLE9BQU87b0JBQ0wsV0FBVyxFQUFFLFVBQVU7b0JBQ3ZCLGNBQWMsRUFBRSwwQkFBMEI7b0JBQzFDLFlBQVksRUFBRSxtQkFBbUI7b0JBQ2pDLGlCQUFpQixFQUFFLHdCQUF3QjtpQkFDNUMsQ0FBQzthQUNIO1lBRUQsbUVBQW1FO1lBRW5FLCtHQUErRztZQUMvRyw2R0FBNkc7WUFDN0csTUFBTSxZQUFZLEdBQWtCLEtBQUssSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO1lBRTNGLElBQUksQ0FBQyxZQUFZLElBQUksQ0FBQyxZQUFZLEVBQUU7Z0JBQ2xDLFVBQUcsQ0FBQyxJQUFJLENBQ04sa0JBQWtCLGNBQWMsQ0FBQyxNQUFNLCtCQUErQixVQUFVLENBQUMsTUFBTSxpRUFBaUUsQ0FDekosQ0FBQztnQkFDRixPQUFPO29CQUNMLFdBQVcsRUFBRSxVQUFVO29CQUN2QixjQUFjLEVBQUUsd0JBQWMsQ0FBQyxhQUFhLENBQUMsVUFBVSxFQUFFLENBQUMsQ0FBQztvQkFDM0QsWUFBWSxFQUFFLHdCQUFjLENBQUMsYUFBYSxDQUFDLFFBQVMsRUFBRSxDQUFDLENBQUM7aUJBQ3pELENBQUM7YUFDSDtZQUVELHVGQUF1RjtZQUN2Rix3RUFBd0U7WUFDeEUsTUFBTSxVQUFVLEdBQ2QsQ0FBQyxDQUFDLFlBQVksSUFBSSxjQUFJLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxTQUFTLEVBQUUsY0FBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNuRSxZQUFZO2dCQUNaLENBQUMsQ0FBQyxZQUFZO2dCQUNkLENBQUMsQ0FBQyxZQUFhLENBQUM7WUFFcEIsTUFBTSwwQkFBMEIsR0FBRyxJQUFBLHFDQUF5QixFQUMxRCxPQUFPLEVBQ1AsMEJBQTBCLEVBQzFCLFVBQVUsQ0FDWCxDQUFDO1lBRUYsT0FBTztnQkFDTCxXQUFXLEVBQUUsVUFBVTtnQkFDdkIsY0FBYyxFQUFFLDBCQUEwQjtnQkFDMUMsWUFBWSxFQUFFLG1CQUFvQjtnQkFDbEMsaUJBQWlCLEVBQUUsd0JBQXdCO2FBQzVDLENBQUM7UUFDSixDQUFDLENBQUM7UUFFRixPQUFPO1lBQ0wsZUFBZSxFQUFFLGVBQWUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1NBQzVDLENBQUM7SUFDSixDQUFDO0lBRU8sV0FBVyxDQUNqQixtQkFBNkMsRUFDN0MsV0FBc0IsRUFDdEIsT0FBZ0IsRUFDaEIsY0FBdUM7UUFFdkMsTUFBTSw0QkFBNEIsR0FBRyxJQUFJLENBQUMsNEJBQTRCLENBQ3BFLG1CQUFtQixDQUFDLDJCQUEyQixDQUNoRCxDQUFDO1FBRUY7OztXQUdHO1FBQ0gsSUFBSSxnQkFBZ0IsR0FBRyxxQkFBUyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN6QyxJQUFJLGdCQUFnQixHQUFHLHFCQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3pDLElBQUksVUFBVSxHQUFHLHFCQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ25DLElBQUksbUJBQW1CLEdBQUcsS0FBSyxDQUFDO1FBRWhDLE1BQU0sS0FBSyxHQUFHLG1CQUFtQixDQUFDLEtBQUssQ0FBQztRQUV4QyxNQUFNLEdBQUcsR0FBRyxJQUFBLDBDQUE2QixFQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ2pELEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxPQUFnQixFQUFFLEVBQUU7WUFDM0IsSUFBSSxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLFlBQVksYUFBTSxDQUFDLEVBQUU7Z0JBQ25ELGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLEdBQUcsQ0FBQyxJQUFBLDBCQUFjLEVBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztnQkFDakUsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsR0FBRyxDQUNyQyxJQUFBLHdCQUFZLEVBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FDMUMsQ0FBQztnQkFDRixVQUFVLEdBQUcsVUFBVSxDQUFDLEdBQUcsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO2FBQy9DO2lCQUFNLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxZQUFZLGFBQUksQ0FBQyxFQUFFO2dCQUN4RCxnQkFBZ0IsR0FBRyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUMsdUNBQWlCLENBQUMsQ0FBQztnQkFDM0QsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsR0FBRztnQkFDckMsbURBQW1EO2dCQUNuRCwyQ0FBcUIsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FDOUMsQ0FBQztnQkFDRixVQUFVLEdBQUcsVUFBVSxDQUFDLEdBQUcsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO2FBQy9DO2lCQUFNLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxZQUFZLGFBQU0sQ0FBQyxFQUFFO2dCQUMxRCxtQkFBbUIsR0FBRyxJQUFJLENBQUM7YUFDNUI7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUVILE1BQU0sVUFBVSxHQUFHLElBQUEsOEJBQWtCLEVBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxDQUNoRCw0QkFBNEIsQ0FDN0IsQ0FBQztRQUNGLE1BQU0sdUJBQXVCLEdBQUcsZ0NBQW9CLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBRTVELElBQUksbUJBQW1CLEVBQUU7WUFDdkIsZ0dBQWdHO1lBQ2hHLDRFQUE0RTtZQUM1RSxxRUFBcUU7WUFDckUsOEVBQThFO1lBQzlFLFVBQVUsR0FBRyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUMsbUJBQW1CLENBQUMsaUJBQWlCLENBQUMsQ0FBQztTQUMxRTthQUFNO1lBQ0wsa0ZBQWtGO1lBQ2xGLFVBQVUsR0FBRyxVQUFVLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO1NBQ3RFO1FBRUQsSUFBSSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUscUJBQXFCLEVBQUU7WUFDekMsVUFBVSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLHFCQUFxQixDQUFDLENBQUM7U0FDbkU7UUFFRCxNQUFNLGNBQWMsR0FBRyxXQUFXLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBRW5ELE1BQU0sZUFBZSxHQUFHLDJCQUF1QixDQUFDLE9BQU8sQ0FBRSxDQUFDO1FBRTFELE1BQU0sMEJBQTBCLEdBQUcsd0JBQWMsQ0FBQyxhQUFhLENBQzdELGVBQWUsRUFDZixjQUFjLENBQUMsUUFBUSxFQUFFLENBQzFCLENBQUM7UUFFRixPQUFPO1lBQ0wsMEJBQTBCO1lBQzFCLDRCQUE0QjtZQUM1QixVQUFVO1NBQ1gsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQXBNRCxnRkFvTUMifQ==

package/build/main/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;