@ring-protocol/smart-order-router 0.5.0

package/build/module/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/module/routers/alpha-router/gas-models/fewV2/v2-heuristic-gas-model.js

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

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

@@ -0,0 +1,189 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { Protocol } from '@ring-protocol/router-sdk';
+import { ChainId } from '@ring-protocol/sdk-core';
+import { AAVE_MAINNET, LIDO_MAINNET } from '../../../providers';
+// Cost for crossing an uninitialized tick.
+export const COST_PER_UNINIT_TICK = BigNumber.from(0);
+//l2 execution fee on optimism is roughly the same as mainnet
+export const BASE_SWAP_COST = (id) => {
+    switch (id) {
+        case ChainId.HYPER_MAINNET:
+        case ChainId.MAINNET:
+        case ChainId.GOERLI:
+        case ChainId.SEPOLIA:
+        case ChainId.OPTIMISM:
+        case ChainId.OPTIMISM_GOERLI:
+        case ChainId.OPTIMISM_SEPOLIA:
+        case ChainId.BNB:
+        case ChainId.AVALANCHE:
+        case ChainId.BASE:
+        case ChainId.BASE_GOERLI:
+        case ChainId.ZORA:
+        case ChainId.ZORA_SEPOLIA:
+        case ChainId.ROOTSTOCK:
+        case ChainId.BLAST:
+        case ChainId.BLAST_SEPOLIA:
+        case ChainId.ZKSYNC:
+        case ChainId.WORLDCHAIN:
+        case ChainId.UNICHAIN_SEPOLIA:
+        case ChainId.UNICHAIN:
+        case ChainId.BASE_SEPOLIA:
+        case ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case ChainId.MONAD: // TODO: double check on monad gas
+        case ChainId.SONEIUM:
+        case ChainId.STORY_ODYSSEY:
+        case ChainId.STORY_MAINNET:
+            return BigNumber.from(2000);
+        case ChainId.ARBITRUM_ONE:
+        case ChainId.ARBITRUM_GOERLI:
+        case ChainId.ARBITRUM_SEPOLIA:
+            return BigNumber.from(5000);
+        case ChainId.POLYGON:
+        case ChainId.POLYGON_MUMBAI:
+            return BigNumber.from(2000);
+        case ChainId.CELO:
+        case ChainId.CELO_ALFAJORES:
+            return BigNumber.from(2000);
+        //TODO determine if sufficient
+        case ChainId.GNOSIS:
+            return BigNumber.from(2000);
+        case ChainId.MOONBEAM:
+            return BigNumber.from(2000);
+    }
+};
+export const COST_PER_INIT_TICK = (id) => {
+    switch (id) {
+        case ChainId.HYPER_MAINNET:
+        case ChainId.MAINNET:
+        case ChainId.GOERLI:
+        case ChainId.SEPOLIA:
+        case ChainId.BNB:
+        case ChainId.AVALANCHE:
+            return BigNumber.from(31000);
+        case ChainId.OPTIMISM:
+        case ChainId.OPTIMISM_GOERLI:
+        case ChainId.OPTIMISM_SEPOLIA:
+        case ChainId.BASE:
+        case ChainId.BASE_GOERLI:
+        case ChainId.ZORA:
+        case ChainId.ZORA_SEPOLIA:
+        case ChainId.ROOTSTOCK:
+        case ChainId.BLAST:
+        case ChainId.ZKSYNC:
+        case ChainId.WORLDCHAIN:
+        case ChainId.UNICHAIN_SEPOLIA:
+        case ChainId.UNICHAIN:
+        case ChainId.BASE_SEPOLIA:
+        case ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case ChainId.MONAD: // TODO: double check on monad gas
+        case ChainId.SONEIUM:
+        case ChainId.BLAST_SEPOLIA:
+        case ChainId.STORY_ODYSSEY:
+        case ChainId.STORY_MAINNET:
+            return BigNumber.from(31000);
+        case ChainId.ARBITRUM_ONE:
+        case ChainId.ARBITRUM_GOERLI:
+        case ChainId.ARBITRUM_SEPOLIA:
+            return BigNumber.from(31000);
+        case ChainId.POLYGON:
+        case ChainId.POLYGON_MUMBAI:
+            return BigNumber.from(31000);
+        case ChainId.CELO:
+        case ChainId.CELO_ALFAJORES:
+            return BigNumber.from(31000);
+        case ChainId.GNOSIS:
+            return BigNumber.from(31000);
+        case ChainId.MOONBEAM:
+            return BigNumber.from(31000);
+    }
+};
+export const COST_PER_HOP = (id) => {
+    switch (id) {
+        case ChainId.HYPER_MAINNET:
+        case ChainId.MAINNET:
+        case ChainId.GOERLI:
+        case ChainId.SEPOLIA:
+        case ChainId.BNB:
+        case ChainId.OPTIMISM:
+        case ChainId.OPTIMISM_GOERLI:
+        case ChainId.OPTIMISM_SEPOLIA:
+        case ChainId.AVALANCHE:
+        case ChainId.BASE:
+        case ChainId.BASE_GOERLI:
+        case ChainId.ZORA:
+        case ChainId.ZORA_SEPOLIA:
+        case ChainId.ROOTSTOCK:
+        case ChainId.BLAST:
+        case ChainId.ZKSYNC:
+        case ChainId.WORLDCHAIN:
+        case ChainId.UNICHAIN_SEPOLIA:
+        case ChainId.UNICHAIN:
+        case ChainId.BASE_SEPOLIA:
+        case ChainId.MONAD_TESTNET: // TODO: double check on monad gas
+        case ChainId.MONAD: // TODO: double check on monad gas
+        case ChainId.SONEIUM:
+        case ChainId.BLAST_SEPOLIA:
+        case ChainId.STORY_ODYSSEY:
+        case ChainId.STORY_MAINNET:
+            return BigNumber.from(80000);
+        case ChainId.ARBITRUM_ONE:
+        case ChainId.ARBITRUM_GOERLI:
+        case ChainId.ARBITRUM_SEPOLIA:
+            return BigNumber.from(80000);
+        case ChainId.POLYGON:
+        case ChainId.POLYGON_MUMBAI:
+            return BigNumber.from(80000);
+        case ChainId.CELO:
+        case ChainId.CELO_ALFAJORES:
+            return BigNumber.from(80000);
+        case ChainId.GNOSIS:
+            return BigNumber.from(80000);
+        case ChainId.MOONBEAM:
+            return BigNumber.from(80000);
+    }
+};
+export const SINGLE_HOP_OVERHEAD = (_id) => {
+    return BigNumber.from(15000);
+};
+export const TOKEN_OVERHEAD = (id, route) => {
+    const currencies = route.protocol === Protocol.V4 ? route.currencyPath : route.tokenPath;
+    let overhead = BigNumber.from(0);
+    if (id == ChainId.MAINNET) {
+        // AAVE's transfer contains expensive governance snapshotting logic. We estimate
+        // it at around 150k.
+        if (currencies.some((t) => t.equals(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(LIDO_MAINNET))) {
+            overhead = overhead.add(150000);
+        }
+    }
+    return overhead;
+};
+// TODO: change per chain
+export const NATIVE_WRAP_OVERHEAD = (id) => {
+    switch (id) {
+        default:
+            return BigNumber.from(27938);
+    }
+};
+export const NATIVE_UNWRAP_OVERHEAD = (id) => {
+    switch (id) {
+        default:
+            return BigNumber.from(36000);
+    }
+};
+export const NATIVE_OVERHEAD = (chainId, amount, quote) => {
+    if (amount.isNative) {
+        // need to wrap eth in
+        return NATIVE_WRAP_OVERHEAD(chainId);
+    }
+    if (quote.isNative) {
+        // need to unwrap eth out
+        return NATIVE_UNWRAP_OVERHEAD(chainId);
+    }
+    return BigNumber.from(0);
+};
+//# 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,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,OAAO,EAAY,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGhE,2CAA2C;AAC3C,MAAM,CAAC,MAAM,oBAAoB,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEtD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAW,EAAa,EAAE;IACvD,QAAQ,EAAE,EAAE;QACV,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,GAAG,CAAC;QACjB,KAAK,OAAO,CAAC,SAAS,CAAC;QACvB,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,WAAW,CAAC;QACzB,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,SAAS,CAAC;QACvB,KAAK,OAAO,CAAC,KAAK,CAAC;QACnB,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,UAAU,CAAC;QACxB,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,aAAa;YACxB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB;YAC3B,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,8BAA8B;QAC9B,KAAK,OAAO,CAAC,MAAM;YACjB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,OAAO,CAAC,QAAQ;YACnB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC/B;AACH,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC3D,QAAQ,EAAE,EAAE;QACV,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,GAAG,CAAC;QACjB,KAAK,OAAO,CAAC,SAAS;YACpB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,WAAW,CAAC;QACzB,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,SAAS,CAAC;QACvB,KAAK,OAAO,CAAC,KAAK,CAAC;QACnB,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,UAAU,CAAC;QACxB,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,aAAa;YACxB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB;YAC3B,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,MAAM;YACjB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,QAAQ;YACnB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAW,EAAa,EAAE;IACrD,QAAQ,EAAE,EAAE;QACV,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,GAAG,CAAC;QACjB,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,SAAS,CAAC;QACvB,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,WAAW,CAAC;QACzB,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,SAAS,CAAC;QACvB,KAAK,OAAO,CAAC,KAAK,CAAC;QACnB,KAAK,OAAO,CAAC,MAAM,CAAC;QACpB,KAAK,OAAO,CAAC,UAAU,CAAC;QACxB,KAAK,OAAO,CAAC,gBAAgB,CAAC;QAC9B,KAAK,OAAO,CAAC,QAAQ,CAAC;QACtB,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,kCAAkC;QAC9D,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,kCAAkC;QACtD,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,aAAa,CAAC;QAC3B,KAAK,OAAO,CAAC,aAAa;YACxB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,YAAY,CAAC;QAC1B,KAAK,OAAO,CAAC,eAAe,CAAC;QAC7B,KAAK,OAAO,CAAC,gBAAgB;YAC3B,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,OAAO,CAAC;QACrB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,IAAI,CAAC;QAClB,KAAK,OAAO,CAAC,cAAc;YACzB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,MAAM;YACjB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,OAAO,CAAC,QAAQ;YACnB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAY,EAAa,EAAE;IAC7D,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,EAAW,EACX,KAAwB,EACb,EAAE;IACb,MAAM,UAAU,GACd,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;IACxE,IAAI,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjC,IAAI,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE;QACzB,gFAAgF;QAChF,qBAAqB;QACrB,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,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,YAAY,CAAC,CAAC,EAAE;YAC5D,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SACjC;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,yBAAyB;AACzB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC7D,QAAQ,EAAE,EAAE;QACV;YACE,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EAAW,EAAa,EAAE;IAC/D,QAAQ,EAAE,EAAE;QACV;YACE,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,OAAgB,EAChB,MAAgB,EAChB,KAAe,EACJ,EAAE;IACb,IAAI,MAAM,CAAC,QAAQ,EAAE;QACnB,sBAAsB;QACtB,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAC;KACtC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE;QAClB,yBAAyB;QACzB,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;KACxC;IACD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC"}

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

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

@@ -0,0 +1,114 @@
+import { ChainId, Token, } from '@ring-protocol/sdk-core';
+import { CUSD_CELO, CUSD_CELO_ALFAJORES, DAI_ARBITRUM, DAI_AVAX, DAI_BNB, DAI_GOERLI, DAI_MAINNET, DAI_OPTIMISM, DAI_OPTIMISM_GOERLI, DAI_OPTIMISM_SEPOLIA, DAI_POLYGON_MUMBAI, DAI_SEPOLIA, DAI_UNICHAIN, DAI_ZKSYNC, USDB_BLAST, USDC_ARBITRUM, USDC_ARBITRUM_GOERLI, USDC_ARBITRUM_SEPOLIA, USDC_AVAX, USDC_BASE, USDC_BASE_SEPOLIA, USDC_BNB, USDC_BRIDGED_AVAX, USDC_CELO, USDC_ETHEREUM_GNOSIS, USDC_GOERLI, USDC_MAINNET, USDC_MOONBEAM, USDC_NATIVE_ARBITRUM, USDC_NATIVE_AVAX, USDC_NATIVE_BASE, USDC_NATIVE_CELO, USDC_NATIVE_OPTIMISM, USDC_NATIVE_POLYGON, USDC_OPTIMISM, USDC_OPTIMISM_GOERLI, USDC_OPTIMISM_SEPOLIA, USDC_POLYGON, USDC_SEPOLIA, USDC_SONEIUM, USDC_STORY_MAINNET, USDC_UNICHAIN, USDC_UNICHAIN_SEPOLIA, USDC_WORLDCHAIN, USDC_WORMHOLE_CELO, USDC_ZKSYNC, USDC_ZORA, USDCE_ZKSYNC, USDT_ARBITRUM, USDT_BNB, USDT_GOERLI, USDT_HYPER_MAINNET, USDT_MAINNET, USDT_MONAD_TESTNET, USDT_OPTIMISM, USDT_OPTIMISM_GOERLI, USDT_OPTIMISM_SEPOLIA, WBTC_GOERLI, } from '../../../providers/token-provider';
+import { 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 usdGasTokensByChain = {
+    [ChainId.HYPER_MAINNET]: [USDT_HYPER_MAINNET],
+    [ChainId.MAINNET]: [DAI_MAINNET, USDC_MAINNET, USDT_MAINNET],
+    [ChainId.ARBITRUM_ONE]: [
+        DAI_ARBITRUM,
+        USDC_ARBITRUM,
+        USDC_NATIVE_ARBITRUM,
+        USDT_ARBITRUM,
+    ],
+    [ChainId.OPTIMISM]: [
+        DAI_OPTIMISM,
+        USDC_OPTIMISM,
+        USDC_NATIVE_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]: [USDC_ARBITRUM_SEPOLIA],
+    [ChainId.GOERLI]: [DAI_GOERLI, USDC_GOERLI, USDT_GOERLI, WBTC_GOERLI],
+    [ChainId.SEPOLIA]: [USDC_SEPOLIA, DAI_SEPOLIA],
+    [ChainId.POLYGON]: [USDC_POLYGON, USDC_NATIVE_POLYGON],
+    [ChainId.POLYGON_MUMBAI]: [DAI_POLYGON_MUMBAI],
+    [ChainId.CELO]: [CUSD_CELO, USDC_CELO, USDC_NATIVE_CELO, USDC_WORMHOLE_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,
+        USDC_NATIVE_AVAX,
+        USDC_BRIDGED_AVAX,
+    ],
+    [ChainId.BASE]: [USDC_BASE, USDC_NATIVE_BASE],
+    [ChainId.BLAST]: [USDB_BLAST],
+    [ChainId.ZORA]: [USDC_ZORA],
+    [ChainId.ZKSYNC]: [DAI_ZKSYNC, USDCE_ZKSYNC, USDC_ZKSYNC],
+    [ChainId.WORLDCHAIN]: [USDC_WORLDCHAIN],
+    [ChainId.UNICHAIN_SEPOLIA]: [USDC_UNICHAIN_SEPOLIA],
+    [ChainId.MONAD_TESTNET]: [USDT_MONAD_TESTNET],
+    [ChainId.BASE_SEPOLIA]: [USDC_BASE_SEPOLIA],
+    [ChainId.UNICHAIN]: [DAI_UNICHAIN, USDC_UNICHAIN],
+    [ChainId.SONEIUM]: [USDC_SONEIUM],
+    [ChainId.STORY_MAINNET]: [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
+ */
+export class 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
+ */
+export 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;
+    }
+}
+// Determines if native currency is token0
+// Gets the native price of the pool, dependent on 0 or 1
+// quotes across the pool
+export const getQuoteThroughNativePool = (chainId, nativeTokenAmount, nativeTokenPool) => {
+    const nativeCurrency = 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) : CurrencyAmount.fromRawAmount(nativeTokenAmount.currency instanceof Token ? nativeTokenAmount.currency : nativeCurrency, 0);
+    // return nativeTokenPrice != null ? nativeTokenPrice.quote(nativeTokenAmount) as CurrencyAmount : CurrencyAmount.fromRawAmount(nativeTokenAmount.token, 0);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLW1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3JvdXRlcnMvYWxwaGEtcm91dGVyL2dhcy1tb2RlbHMvZ2FzLW1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFDTCxPQUFPLEVBRVAsS0FBSyxHQUNOLE1BQU0seUJBQXlCLENBQUM7QUFLakMsT0FBTyxFQUNMLFNBQVMsRUFDVCxtQkFBbUIsRUFDbkIsWUFBWSxFQUNaLFFBQVEsRUFDUixPQUFPLEVBQ1AsVUFBVSxFQUNWLFdBQVcsRUFDWCxZQUFZLEVBQ1osbUJBQW1CLEVBQ25CLG9CQUFvQixFQUNwQixrQkFBa0IsRUFDbEIsV0FBVyxFQUNYLFlBQVksRUFDWixVQUFVLEVBQ1YsVUFBVSxFQUNWLGFBQWEsRUFDYixvQkFBb0IsRUFDcEIscUJBQXFCLEVBQ3JCLFNBQVMsRUFDVCxTQUFTLEVBQ1QsaUJBQWlCLEVBQ2pCLFFBQVEsRUFDUixpQkFBaUIsRUFDakIsU0FBUyxFQUNULG9CQUFvQixFQUNwQixXQUFXLEVBQ1gsWUFBWSxFQUNaLGFBQWEsRUFDYixvQkFBb0IsRUFDcEIsZ0JBQWdCLEVBQ2hCLGdCQUFnQixFQUNoQixnQkFBZ0IsRUFDaEIsb0JBQW9CLEVBQ3BCLG1CQUFtQixFQUNuQixhQUFhLEVBQ2Isb0JBQW9CLEVBQ3BCLHFCQUFxQixFQUNyQixZQUFZLEVBQ1osWUFBWSxFQUNaLFlBQVksRUFDWixrQkFBa0IsRUFDbEIsYUFBYSxFQUNiLHFCQUFxQixFQUNyQixlQUFlLEVBQ2Ysa0JBQWtCLEVBQ2xCLFdBQVcsRUFDWCxTQUFTLEVBQ1QsWUFBWSxFQUNaLGFBQWEsRUFDYixRQUFRLEVBQ1IsV0FBVyxFQUNYLGtCQUFrQixFQUNsQixZQUFZLEVBQ1osa0JBQWtCLEVBQ2xCLGFBQWEsRUFDYixvQkFBb0IsRUFDcEIscUJBQXFCLEVBQ3JCLFdBQVcsR0FDWixNQUFNLG1DQUFtQyxDQUFDO0FBTTNDLE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUN4RCxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFZdkQsZ0VBQWdFO0FBQ2hFLHFFQUFxRTtBQUNyRSw0RUFBNEU7QUFDNUUsTUFBTSxDQUFDLE1BQU0sbUJBQW1CLEdBQXVDO0lBQ3JFLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFLENBQUMsa0JBQWtCLENBQUM7SUFDN0MsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxXQUFXLEVBQUUsWUFBWSxFQUFFLFlBQVksQ0FBQztJQUM1RCxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsRUFBRTtRQUN0QixZQUFZO1FBQ1osYUFBYTtRQUNiLG9CQUFvQjtRQUNwQixhQUFhO0tBQ2Q7SUFDRCxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsRUFBRTtRQUNsQixZQUFZO1FBQ1osYUFBYTtRQUNiLG9CQUFvQjtRQUNwQixhQUFhO0tBQ2Q7SUFDRCxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUMsRUFBRTtRQUN6QixtQkFBbUI7UUFDbkIsb0JBQW9CO1FBQ3BCLG9CQUFvQjtLQUNyQjtJQUNELENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDLEVBQUU7UUFDMUIsb0JBQW9CO1FBQ3BCLHFCQUFxQjtRQUNyQixxQkFBcUI7S0FDdEI7SUFDRCxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUMsRUFBRSxDQUFDLG9CQUFvQixDQUFDO0lBQ2pELENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDLEVBQUUsQ0FBQyxxQkFBcUIsQ0FBQztJQUNuRCxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLFVBQVUsRUFBRSxXQUFXLEVBQUUsV0FBVyxFQUFFLFdBQVcsQ0FBQztJQUNyRSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLFlBQVksRUFBRSxXQUFXLENBQUM7SUFDOUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxZQUFZLEVBQUUsbUJBQW1CLENBQUM7SUFDdEQsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQyxrQkFBa0IsQ0FBQztJQUM5QyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLFNBQVMsRUFBRSxTQUFTLEVBQUUsZ0JBQWdCLEVBQUUsa0JBQWtCLENBQUM7SUFDNUUsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQztJQUMvQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLG9CQUFvQixDQUFDO0lBQ3hDLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsYUFBYSxDQUFDO0lBQ25DLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsUUFBUSxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUM7SUFDNUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUU7UUFDbkIsUUFBUTtRQUNSLFNBQVM7UUFDVCxnQkFBZ0I7UUFDaEIsaUJBQWlCO0tBQ2xCO0lBQ0QsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsZ0JBQWdCLENBQUM7SUFDN0MsQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUM7SUFDN0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxTQUFTLENBQUM7SUFDM0IsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxVQUFVLEVBQUUsWUFBWSxFQUFFLFdBQVcsQ0FBQztJQUN6RCxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUFDLGVBQWUsQ0FBQztJQUN2QyxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLENBQUMscUJBQXFCLENBQUM7SUFDbkQsQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDLEVBQUUsQ0FBQyxrQkFBa0IsQ0FBQztJQUM3QyxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsRUFBRSxDQUFDLGlCQUFpQixDQUFDO0lBQzNDLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUMsWUFBWSxFQUFFLGFBQWEsQ0FBQztJQUNqRCxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQztJQUNqQyxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsRUFBRSxDQUFDLGtCQUFrQixDQUFDO0NBQzlDLENBQUM7QUFrRkY7Ozs7Ozs7Ozs7R0FVRztBQUNILE1BQU0sT0FBZ0Isa0JBQWtCO0NBUXZDO0FBRUQ7Ozs7Ozs7Ozs7R0FVRztBQUNILE1BQU0sT0FBZ0IsdUJBQXVCO0lBY2pDLDRCQUE0QixDQUNwQywyQkFBcUM7UUFFckMsSUFBSSxZQUFZLEdBQUcsQ0FBQyxDQUFDO1FBQ3JCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRywyQkFBMkIsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDM0Qsb0VBQW9FO1lBQ3BFLElBQUksMkJBQTJCLENBQUMsQ0FBQyxDQUFFLEdBQUcsQ0FBQyxFQUFFO2dCQUN2Qyx5RkFBeUY7Z0JBQ3pGLG9FQUFvRTtnQkFDcEUsWUFBWSxJQUFJLDJCQUEyQixDQUFDLENBQUMsQ0FBRSxHQUFHLENBQUMsQ0FBQzthQUNyRDtTQUNGO1FBRUQsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGO0FBRUQsMENBQTBDO0FBQzFDLHlEQUF5RDtBQUN6RCx5QkFBeUI7QUFDekIsTUFBTSxDQUFDLE1BQU0seUJBQXlCLEdBQUcsQ0FDdkMsT0FBZ0IsRUFDaEIsaUJBQTJDLEVBQzNDLGVBQW1DLEVBQ25CLEVBQUU7SUFDbEIsTUFBTSxjQUFjLEdBQUcsdUJBQXVCLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDeEQsTUFBTSxRQUFRLEdBQUcsZUFBZSxJQUFJLElBQUksQ0FBQyxDQUFDLENBQUMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQztJQUNqRyxxRkFBcUY7SUFDckYsTUFBTSxnQkFBZ0IsR0FBRyxRQUFRO1FBQy9CLENBQUMsQ0FBQyxlQUFlLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJO1FBQzlELENBQUMsQ0FBQyxlQUFlLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxlQUFlLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7SUFDakUsc0RBQXNEO0lBQ3RELE9BQU8sZ0JBQWdCLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsaUJBQWlCLENBQW1CLENBQUMsQ0FBQyxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsaUJBQWlCLENBQUMsUUFBUSxZQUFZLEtBQUssQ0FBQyxDQUFDLENBQUMsaUJBQWlCLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxjQUFlLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDNU4sNEpBQTRKO0FBQzlKLENBQUMsQ0FBQyJ9