@kumbaya_xyz/smart-order-router 4.22.38

package/build/main/providers/v3/caching-pool-provider.d.ts

@@ -0,0 +1,32 @@
+import { ChainId, Token } from '@uniswap/sdk-core';
+import { FeeAmount, Pool } from '@uniswap/v3-sdk';
+import { ICache } from './../cache';
+import { ProviderConfig } from './../provider';
+import { IV3PoolProvider, V3PoolAccessor } from './pool-provider';
+/**
+ * Provider for getting V3 pools, with functionality for caching the results.
+ * Does not cache by block because we compute quotes using the on-chain quoter
+ * so do not mind if the liquidity values are out of date.
+ *
+ * @export
+ * @class CachingV3PoolProvider
+ */
+export declare class CachingV3PoolProvider implements IV3PoolProvider {
+    protected chainId: ChainId;
+    protected poolProvider: IV3PoolProvider;
+    private cache;
+    private POOL_KEY;
+    /**
+     * Creates an instance of CachingV3PoolProvider.
+     * @param chainId The chain id to use.
+     * @param poolProvider The provider to use to get the pools when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId: ChainId, poolProvider: IV3PoolProvider, cache: ICache<Pool>);
+    getPools(tokenPairs: [Token, Token, FeeAmount][], providerConfig?: ProviderConfig): Promise<V3PoolAccessor>;
+    getPoolAddress(tokenA: Token, tokenB: Token, feeAmount: FeeAmount): {
+        poolAddress: string;
+        token0: Token;
+        token1: Token;
+    };
+}

package/build/main/providers/v3/caching-pool-provider.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachingV3PoolProvider = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const util_1 = require("../../util");
+const log_1 = require("../../util/log");
+/**
+ * Provider for getting V3 pools, with functionality for caching the results.
+ * Does not cache by block because we compute quotes using the on-chain quoter
+ * so do not mind if the liquidity values are out of date.
+ *
+ * @export
+ * @class CachingV3PoolProvider
+ */
+class CachingV3PoolProvider {
+    /**
+     * Creates an instance of CachingV3PoolProvider.
+     * @param chainId The chain id to use.
+     * @param poolProvider The provider to use to get the pools when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId, poolProvider, cache) {
+        this.chainId = chainId;
+        this.poolProvider = poolProvider;
+        this.cache = cache;
+        this.POOL_KEY = (chainId, address, blockNumber) => blockNumber
+            ? `pool-${chainId}-${address}-${blockNumber}`
+            : `pool-${chainId}-${address}`;
+    }
+    async getPools(tokenPairs, providerConfig) {
+        const poolAddressSet = new Set();
+        const poolsToGetTokenPairs = [];
+        const poolsToGetAddresses = [];
+        const poolAddressToPool = {};
+        const blockNumber = await (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber);
+        for (const [tokenA, tokenB, feeAmount] of tokenPairs) {
+            const { poolAddress, token0, token1 } = this.getPoolAddress(tokenA, tokenB, feeAmount);
+            if (poolAddressSet.has(poolAddress)) {
+                continue;
+            }
+            poolAddressSet.add(poolAddress);
+            const cachedPool = await this.cache.get(this.POOL_KEY(this.chainId, poolAddress, blockNumber));
+            if (cachedPool) {
+                util_1.metric.putMetric('V3_INMEMORY_CACHING_POOL_HIT_IN_MEMORY', 1, util_1.MetricLoggerUnit.None);
+                poolAddressToPool[poolAddress] = cachedPool;
+                continue;
+            }
+            util_1.metric.putMetric('V3_INMEMORY_CACHING_POOL_MISS_NOT_IN_MEMORY', 1, util_1.MetricLoggerUnit.None);
+            poolsToGetTokenPairs.push([token0, token1, feeAmount]);
+            poolsToGetAddresses.push(poolAddress);
+        }
+        log_1.log.info({
+            poolsFound: lodash_1.default.map(Object.values(poolAddressToPool), (p) => `${p.token0.symbol} ${p.token1.symbol} ${p.fee}`),
+            poolsToGetTokenPairs: lodash_1.default.map(poolsToGetTokenPairs, (t) => `${t[0].symbol} ${t[1].symbol} ${t[2]}`),
+        }, `Found ${Object.keys(poolAddressToPool).length} V3 pools already in local cache. About to get liquidity and slot0s for ${poolsToGetTokenPairs.length} pools.`);
+        if (poolsToGetAddresses.length > 0) {
+            const poolAccessor = await this.poolProvider.getPools(poolsToGetTokenPairs, providerConfig);
+            for (const address of poolsToGetAddresses) {
+                const pool = poolAccessor.getPoolByAddress(address);
+                if (pool) {
+                    poolAddressToPool[address] = pool;
+                    // We don't want to wait for this caching to complete before returning the pools.
+                    this.cache.set(this.POOL_KEY(this.chainId, address, blockNumber), pool);
+                }
+            }
+        }
+        return {
+            getPool: (tokenA, tokenB, feeAmount) => {
+                const { poolAddress } = this.getPoolAddress(tokenA, tokenB, feeAmount);
+                return poolAddressToPool[poolAddress];
+            },
+            getPoolByAddress: (address) => poolAddressToPool[address],
+            getAllPools: () => Object.values(poolAddressToPool),
+        };
+    }
+    getPoolAddress(tokenA, tokenB, feeAmount) {
+        return this.poolProvider.getPoolAddress(tokenA, tokenB, feeAmount);
+    }
+}
+exports.CachingV3PoolProvider = CachingV3PoolProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1wb29sLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy92My9jYWNoaW5nLXBvb2wtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBRUEsb0RBQXVCO0FBRXZCLHFDQUFzRDtBQUN0RCx3Q0FBcUM7QUFNckM7Ozs7Ozs7R0FPRztBQUNILE1BQWEscUJBQXFCO0lBVWhDOzs7OztPQUtHO0lBQ0gsWUFDWSxPQUFnQixFQUNoQixZQUE2QixFQUMvQixLQUFtQjtRQUZqQixZQUFPLEdBQVAsT0FBTyxDQUFTO1FBQ2hCLGlCQUFZLEdBQVosWUFBWSxDQUFpQjtRQUMvQixVQUFLLEdBQUwsS0FBSyxDQUFjO1FBbEJyQixhQUFRLEdBQUcsQ0FDakIsT0FBZ0IsRUFDaEIsT0FBZSxFQUNmLFdBQW9CLEVBQ3BCLEVBQUUsQ0FDRixXQUFXO1lBQ1QsQ0FBQyxDQUFDLFFBQVEsT0FBTyxJQUFJLE9BQU8sSUFBSSxXQUFXLEVBQUU7WUFDN0MsQ0FBQyxDQUFDLFFBQVEsT0FBTyxJQUFJLE9BQU8sRUFBRSxDQUFDO0lBWWhDLENBQUM7SUFFRyxLQUFLLENBQUMsUUFBUSxDQUNuQixVQUF1QyxFQUN2QyxjQUErQjtRQUUvQixNQUFNLGNBQWMsR0FBZ0IsSUFBSSxHQUFHLEVBQVUsQ0FBQztRQUN0RCxNQUFNLG9CQUFvQixHQUFxQyxFQUFFLENBQUM7UUFDbEUsTUFBTSxtQkFBbUIsR0FBYSxFQUFFLENBQUM7UUFDekMsTUFBTSxpQkFBaUIsR0FBb0MsRUFBRSxDQUFDO1FBQzlELE1BQU0sV0FBVyxHQUFHLE1BQU0sQ0FBQSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsV0FBVyxDQUFBLENBQUM7UUFFdEQsS0FBSyxNQUFNLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsSUFBSSxVQUFVLEVBQUU7WUFDcEQsTUFBTSxFQUFFLFdBQVcsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FDekQsTUFBTSxFQUNOLE1BQU0sRUFDTixTQUFTLENBQ1YsQ0FBQztZQUVGLElBQUksY0FBYyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsRUFBRTtnQkFDbkMsU0FBUzthQUNWO1lBRUQsY0FBYyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUVoQyxNQUFNLFVBQVUsR0FBRyxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUNyQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsV0FBVyxFQUFFLFdBQVcsQ0FBQyxDQUN0RCxDQUFDO1lBQ0YsSUFBSSxVQUFVLEVBQUU7Z0JBQ2QsYUFBTSxDQUFDLFNBQVMsQ0FDZCx3Q0FBd0MsRUFDeEMsQ0FBQyxFQUNELHVCQUFnQixDQUFDLElBQUksQ0FDdEIsQ0FBQztnQkFDRixpQkFBaUIsQ0FBQyxXQUFXLENBQUMsR0FBRyxVQUFVLENBQUM7Z0JBQzVDLFNBQVM7YUFDVjtZQUVELGFBQU0sQ0FBQyxTQUFTLENBQ2QsNkNBQTZDLEVBQzdDLENBQUMsRUFDRCx1QkFBZ0IsQ0FBQyxJQUFJLENBQ3RCLENBQUM7WUFDRixvQkFBb0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDLENBQUM7WUFDdkQsbUJBQW1CLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1NBQ3ZDO1FBRUQsU0FBRyxDQUFDLElBQUksQ0FDTjtZQUNFLFVBQVUsRUFBRSxnQkFBQyxDQUFDLEdBQUcsQ0FDZixNQUFNLENBQUMsTUFBTSxDQUFDLGlCQUFpQixDQUFDLEVBQ2hDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxJQUFJLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FDeEQ7WUFDRCxvQkFBb0IsRUFBRSxnQkFBQyxDQUFDLEdBQUcsQ0FDekIsb0JBQW9CLEVBQ3BCLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FDL0M7U0FDRixFQUNELFNBQ0UsTUFBTSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLE1BQ2pDLDJFQUNFLG9CQUFvQixDQUFDLE1BQ3ZCLFNBQVMsQ0FDVixDQUFDO1FBRUYsSUFBSSxtQkFBbUIsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO1lBQ2xDLE1BQU0sWUFBWSxHQUFHLE1BQU0sSUFBSSxDQUFDLFlBQVksQ0FBQyxRQUFRLENBQ25ELG9CQUFvQixFQUNwQixjQUFjLENBQ2YsQ0FBQztZQUNGLEtBQUssTUFBTSxPQUFPLElBQUksbUJBQW1CLEVBQUU7Z0JBQ3pDLE1BQU0sSUFBSSxHQUFHLFlBQVksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztnQkFDcEQsSUFBSSxJQUFJLEVBQUU7b0JBQ1IsaUJBQWlCLENBQUMsT0FBTyxDQUFDLEdBQUcsSUFBSSxDQUFDO29CQUNsQyxpRkFBaUY7b0JBQ2pGLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUNaLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsV0FBVyxDQUFDLEVBQ2pELElBQUksQ0FDTCxDQUFDO2lCQUNIO2FBQ0Y7U0FDRjtRQUVELE9BQU87WUFDTCxPQUFPLEVBQUUsQ0FDUCxNQUFhLEVBQ2IsTUFBYSxFQUNiLFNBQW9CLEVBQ0YsRUFBRTtnQkFDcEIsTUFBTSxFQUFFLFdBQVcsRUFBRSxHQUFHLElBQUksQ0FBQyxjQUFjLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsQ0FBQztnQkFDdkUsT0FBTyxpQkFBaUIsQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUN4QyxDQUFDO1lBQ0QsZ0JBQWdCLEVBQUUsQ0FBQyxPQUFlLEVBQW9CLEVBQUUsQ0FDdEQsaUJBQWlCLENBQUMsT0FBTyxDQUFDO1lBQzVCLFdBQVcsRUFBRSxHQUFXLEVBQUUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLGlCQUFpQixDQUFDO1NBQzVELENBQUM7SUFDSixDQUFDO0lBRU0sY0FBYyxDQUNuQixNQUFhLEVBQ2IsTUFBYSxFQUNiLFNBQW9CO1FBRXBCLE9BQU8sSUFBSSxDQUFDLFlBQVksQ0FBQyxjQUFjLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsQ0FBQztJQUNyRSxDQUFDO0NBQ0Y7QUE3SEQsc0RBNkhDIn0=

package/build/main/providers/v3/caching-subgraph-provider.d.ts

@@ -0,0 +1,19 @@
+import { ChainId } from '@uniswap/sdk-core';
+import { CachingSubgraphProvider } from '../caching-subgraph-provider';
+import { ICache } from './../cache';
+import { IV3SubgraphProvider, V3SubgraphPool } from './subgraph-provider';
+/**
+ * Provider for getting V3 pools, with functionality for caching the results.
+ *
+ * @export
+ * @class CachingV3SubgraphProvider
+ */
+export declare class CachingV3SubgraphProvider extends CachingSubgraphProvider<V3SubgraphPool> implements IV3SubgraphProvider {
+    /**
+     * Creates an instance of CachingV3SubgraphProvider.
+     * @param chainId The chain id to use.
+     * @param subgraphProvider The provider to use to get the subgraph pools when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId: ChainId, subgraphProvider: IV3SubgraphProvider, cache: ICache<V3SubgraphPool[]>);
+}

package/build/main/providers/v3/caching-subgraph-provider.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachingV3SubgraphProvider = void 0;
+const router_sdk_1 = require("@uniswap/router-sdk");
+const caching_subgraph_provider_1 = require("../caching-subgraph-provider");
+/**
+ * Provider for getting V3 pools, with functionality for caching the results.
+ *
+ * @export
+ * @class CachingV3SubgraphProvider
+ */
+class CachingV3SubgraphProvider extends caching_subgraph_provider_1.CachingSubgraphProvider {
+    /**
+     * Creates an instance of CachingV3SubgraphProvider.
+     * @param chainId The chain id to use.
+     * @param subgraphProvider The provider to use to get the subgraph pools when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId, subgraphProvider, cache) {
+        super(chainId, subgraphProvider, cache, router_sdk_1.Protocol.V3);
+    }
+}
+exports.CachingV3SubgraphProvider = CachingV3SubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvdjMvY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxvREFBK0M7QUFHL0MsNEVBQXVFO0FBS3ZFOzs7OztHQUtHO0FBQ0gsTUFBYSx5QkFDWCxTQUFRLG1EQUF1QztJQUcvQzs7Ozs7T0FLRztJQUNILFlBQ0UsT0FBZ0IsRUFDaEIsZ0JBQXFDLEVBQ3JDLEtBQStCO1FBRS9CLEtBQUssQ0FBQyxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsS0FBSyxFQUFFLHFCQUFRLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztDQUNGO0FBakJELDhEQWlCQyJ9

package/build/main/providers/v3/gas-data-provider.d.ts

@@ -0,0 +1,39 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { ChainId } from '@uniswap/sdk-core';
+import { ProviderConfig } from '../provider';
+/**
+ * Provider for getting gas constants on L2s.
+ *
+ * @export
+ * @interface IL2GasDataProvider
+ */
+export interface IL2GasDataProvider<T> {
+    /**
+     * Gets the data constants needed to calculate the l1 security fee on L2s like arbitrum and optimism.
+     * @returns An object that includes the data necessary for the off chain estimations.
+     */
+    getGasData(providerConfig?: ProviderConfig): Promise<T>;
+}
+/**
+ * perL2TxFee is the base fee in wei for an l2 transaction.
+ * perL2CalldataFee is the fee in wei per byte of calldata the swap uses. Multiply by the total bytes of the calldata.
+ * perArbGasTotal is the fee in wei per unit of arbgas. Multiply this by the estimate we calculate based on ticks/hops in the gasModel.
+ */
+export type ArbitrumGasData = {
+    perL2TxFee: BigNumber;
+    perL1CalldataFee: BigNumber;
+    perArbGasTotal: BigNumber;
+};
+export declare class ArbitrumGasDataProvider implements IL2GasDataProvider<ArbitrumGasData> {
+    protected chainId: ChainId;
+    protected provider: BaseProvider;
+    protected gasFeesAddress: string;
+    protected blockNumberOverride: number | Promise<number> | undefined;
+    constructor(chainId: ChainId, provider: BaseProvider, gasDataAddress?: string);
+    getGasData(providerConfig?: ProviderConfig): Promise<{
+        perL2TxFee: BigNumber;
+        perL1CalldataFee: BigNumber;
+        perArbGasTotal: BigNumber;
+    }>;
+}

package/build/main/providers/v3/gas-data-provider.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArbitrumGasDataProvider = void 0;
+const GasDataArbitrum__factory_1 = require("../../types/other/factories/GasDataArbitrum__factory");
+const util_1 = require("../../util");
+class ArbitrumGasDataProvider {
+    constructor(chainId, provider, gasDataAddress) {
+        this.chainId = chainId;
+        this.provider = provider;
+        this.gasFeesAddress = gasDataAddress ? gasDataAddress : util_1.ARB_GASINFO_ADDRESS;
+    }
+    async getGasData(providerConfig) {
+        const gasDataContract = GasDataArbitrum__factory_1.GasDataArbitrum__factory.connect(this.gasFeesAddress, this.provider);
+        const gasData = await gasDataContract.getPricesInWei({
+            blockTag: providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber,
+        });
+        const perL1CalldataByte = gasData[1];
+        return {
+            perL2TxFee: gasData[0],
+            perL1CalldataFee: perL1CalldataByte.div(16),
+            perArbGasTotal: gasData[5],
+        };
+    }
+}
+exports.ArbitrumGasDataProvider = ArbitrumGasDataProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLWRhdGEtcHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL3YzL2dhcy1kYXRhLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUlBLG1HQUFnRztBQUNoRyxxQ0FBaUQ7QUE0QmpELE1BQWEsdUJBQXVCO0lBTWxDLFlBQ1ksT0FBZ0IsRUFDaEIsUUFBc0IsRUFDaEMsY0FBdUI7UUFGYixZQUFPLEdBQVAsT0FBTyxDQUFTO1FBQ2hCLGFBQVEsR0FBUixRQUFRLENBQWM7UUFHaEMsSUFBSSxDQUFDLGNBQWMsR0FBRyxjQUFjLENBQUMsQ0FBQyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsMEJBQW1CLENBQUM7SUFDOUUsQ0FBQztJQUVNLEtBQUssQ0FBQyxVQUFVLENBQUMsY0FBK0I7UUFDckQsTUFBTSxlQUFlLEdBQUcsbURBQXdCLENBQUMsT0FBTyxDQUN0RCxJQUFJLENBQUMsY0FBYyxFQUNuQixJQUFJLENBQUMsUUFBUSxDQUNkLENBQUM7UUFDRixNQUFNLE9BQU8sR0FBRyxNQUFNLGVBQWUsQ0FBQyxjQUFjLENBQUM7WUFDbkQsUUFBUSxFQUFFLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxXQUFXO1NBQ3RDLENBQUMsQ0FBQztRQUNILE1BQU0saUJBQWlCLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3JDLE9BQU87WUFDTCxVQUFVLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztZQUN0QixnQkFBZ0IsRUFBRSxpQkFBaUIsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzNDLGNBQWMsRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDO1NBQzNCLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUE3QkQsMERBNkJDIn0=

package/build/main/providers/v3/pool-provider.d.ts

@@ -0,0 +1,77 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { ChainId, Token } from '@uniswap/sdk-core';
+import { FeeAmount, Pool } from '@uniswap/v3-sdk';
+import { Options as RetryOptions } from 'async-retry';
+import { IMulticallProvider, Result } from '../multicall-provider';
+import { ILiquidity, ISlot0, PoolProvider } from '../pool-provider';
+import { ProviderConfig } from '../provider';
+type V3ISlot0 = ISlot0 & {
+    sqrtPriceX96: BigNumber;
+    tick: number;
+};
+type V3ILiquidity = ILiquidity;
+/**
+ * Provider or getting V3 pools.
+ *
+ * @export
+ * @interface IV3PoolProvider
+ */
+export interface IV3PoolProvider {
+    /**
+     * Gets the specified pools.
+     *
+     * @param tokenPairs The token pairs and fee amount of the pools to get.
+     * @param [providerConfig] The provider config.
+     * @returns A pool accessor with methods for accessing the pools.
+     */
+    getPools(tokenPairs: [Token, Token, FeeAmount][], providerConfig?: ProviderConfig): Promise<V3PoolAccessor>;
+    /**
+     * Gets the pool address for the specified token pair and fee tier.
+     *
+     * @param tokenA Token A in the pool.
+     * @param tokenB Token B in the pool.
+     * @param feeAmount The fee amount of the pool.
+     * @returns The pool address and the two tokens.
+     */
+    getPoolAddress(tokenA: Token, tokenB: Token, feeAmount: FeeAmount): {
+        poolAddress: string;
+        token0: Token;
+        token1: Token;
+    };
+}
+export type V3PoolAccessor = {
+    getPool: (tokenA: Token, tokenB: Token, feeAmount: FeeAmount) => Pool | undefined;
+    getPoolByAddress: (address: string) => Pool | undefined;
+    getAllPools: () => Pool[];
+};
+export type V3PoolRetryOptions = RetryOptions;
+export type V3PoolConstruct = [Token, Token, FeeAmount];
+export declare class V3PoolProvider extends PoolProvider<Token, V3PoolConstruct, V3ISlot0, V3ILiquidity, V3PoolAccessor> implements IV3PoolProvider {
+    private POOL_ADDRESS_CACHE;
+    /**
+     * Creates an instance of V4PoolProvider.
+     * @param chainId The chain id to use.
+     * @param multicall2Provider The multicall provider to use to get the pools.
+     * @param retryOptions The retry options for each call to the multicall.
+     */
+    constructor(chainId: ChainId, multicall2Provider: IMulticallProvider, retryOptions?: V3PoolRetryOptions);
+    getPools(tokenPairs: V3PoolConstruct[], providerConfig?: ProviderConfig): Promise<V3PoolAccessor>;
+    getPoolAddress(tokenA: Token, tokenB: Token, feeAmount: FeeAmount): {
+        poolAddress: string;
+        token0: Token;
+        token1: Token;
+    };
+    protected getLiquidityFunctionName(): string;
+    protected getSlot0FunctionName(): string;
+    protected getPoolsData<TReturn>(poolAddresses: string[], functionName: string, providerConfig?: ProviderConfig): Promise<Result<TReturn>[]>;
+    protected getPoolIdentifier(pool: V3PoolConstruct): {
+        poolIdentifier: string;
+        currency0: Token;
+        currency1: Token;
+    };
+    protected instantiatePool(pool: V3PoolConstruct, slot0: V3ISlot0, liquidity: V3ILiquidity): Pool;
+    protected instantiatePoolAccessor(poolIdentifierToPool: {
+        [p: string]: Pool;
+    }): V3PoolAccessor;
+}
+export {};

package/build/main/providers/v3/pool-provider.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V3PoolProvider = void 0;
+const v3_sdk_1 = require("@uniswap/v3-sdk");
+const async_retry_1 = __importDefault(require("async-retry"));
+const IUniswapV3PoolState__factory_1 = require("../../types/v3/factories/IUniswapV3PoolState__factory");
+const addresses_1 = require("../../util/addresses");
+const log_1 = require("../../util/log");
+const pool_provider_1 = require("../pool-provider");
+class V3PoolProvider extends pool_provider_1.PoolProvider {
+    /**
+     * Creates an instance of V4PoolProvider.
+     * @param chainId The chain id to use.
+     * @param multicall2Provider The multicall provider to use to get the pools.
+     * @param retryOptions The retry options for each call to the multicall.
+     */
+    constructor(chainId, multicall2Provider, retryOptions = {
+        retries: 2,
+        minTimeout: 50,
+        maxTimeout: 500,
+    }) {
+        super(chainId, multicall2Provider, retryOptions);
+        // Computing pool addresses is slow as it requires hashing, encoding etc.
+        // Addresses never change so can always be cached.
+        this.POOL_ADDRESS_CACHE = {};
+    }
+    async getPools(tokenPairs, providerConfig) {
+        return await super.getPoolsInternal(tokenPairs, providerConfig);
+    }
+    getPoolAddress(tokenA, tokenB, feeAmount) {
+        const { poolIdentifier, currency0, currency1 } = this.getPoolIdentifier([
+            tokenA,
+            tokenB,
+            feeAmount,
+        ]);
+        return {
+            poolAddress: poolIdentifier,
+            token0: currency0,
+            token1: currency1,
+        };
+    }
+    getLiquidityFunctionName() {
+        return 'liquidity';
+    }
+    getSlot0FunctionName() {
+        return 'slot0';
+    }
+    async getPoolsData(poolAddresses, functionName, providerConfig) {
+        const { results, blockNumber } = await (0, async_retry_1.default)(async () => {
+            return this.multicall2Provider.callSameFunctionOnMultipleContracts({
+                addresses: poolAddresses,
+                contractInterface: IUniswapV3PoolState__factory_1.IUniswapV3PoolState__factory.createInterface(),
+                functionName: functionName,
+                providerConfig,
+            });
+        }, this.retryOptions);
+        log_1.log.debug(`Pool data fetched as of block ${blockNumber}`);
+        return results;
+    }
+    getPoolIdentifier(pool) {
+        const [tokenA, tokenB, feeAmount] = pool;
+        const [token0, token1] = tokenA.sortsBefore(tokenB)
+            ? [tokenA, tokenB]
+            : [tokenB, tokenA];
+        const cacheKey = `${this.chainId}/${token0.address}/${token1.address}/${feeAmount}`;
+        const cachedAddress = this.POOL_ADDRESS_CACHE[cacheKey];
+        if (cachedAddress) {
+            return {
+                poolIdentifier: cachedAddress,
+                currency0: token0,
+                currency1: token1,
+            };
+        }
+        const poolAddress = (0, v3_sdk_1.computePoolAddress)({
+            factoryAddress: addresses_1.V3_CORE_FACTORY_ADDRESSES[this.chainId],
+            tokenA: token0,
+            tokenB: token1,
+            fee: feeAmount,
+            initCodeHashManualOverride: undefined,
+            chainId: this.chainId,
+        });
+        this.POOL_ADDRESS_CACHE[cacheKey] = poolAddress;
+        return {
+            poolIdentifier: poolAddress,
+            currency0: token0,
+            currency1: token1,
+        };
+    }
+    instantiatePool(pool, slot0, liquidity) {
+        const [token0, token1, feeAmount] = pool;
+        return new v3_sdk_1.Pool(token0, token1, feeAmount, slot0.sqrtPriceX96.toString(), liquidity.toString(), slot0.tick);
+    }
+    instantiatePoolAccessor(poolIdentifierToPool) {
+        return {
+            getPool: (tokenA, tokenB, feeAmount) => {
+                const { poolAddress } = this.getPoolAddress(tokenA, tokenB, feeAmount);
+                return poolIdentifierToPool[poolAddress];
+            },
+            getPoolByAddress: (address) => poolIdentifierToPool[address],
+            getAllPools: () => Object.values(poolIdentifierToPool),
+        };
+    }
+}
+exports.V3PoolProvider = V3PoolProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicG9vbC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvdjMvcG9vbC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFFQSw0Q0FBc0U7QUFDdEUsOERBQTZEO0FBRTdELHdHQUFxRztBQUNyRyxvREFBaUU7QUFDakUsd0NBQXFDO0FBRXJDLG9EQUFvRTtBQXlEcEUsTUFBYSxjQUNYLFNBQVEsNEJBTVA7SUFPRDs7Ozs7T0FLRztJQUNILFlBQ0UsT0FBZ0IsRUFDaEIsa0JBQXNDLEVBQ3RDLGVBQW1DO1FBQ2pDLE9BQU8sRUFBRSxDQUFDO1FBQ1YsVUFBVSxFQUFFLEVBQUU7UUFDZCxVQUFVLEVBQUUsR0FBRztLQUNoQjtRQUVELEtBQUssQ0FBQyxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsWUFBWSxDQUFDLENBQUM7UUFuQm5ELHlFQUF5RTtRQUN6RSxrREFBa0Q7UUFDMUMsdUJBQWtCLEdBQThCLEVBQUUsQ0FBQztJQWtCM0QsQ0FBQztJQUVNLEtBQUssQ0FBQyxRQUFRLENBQ25CLFVBQTZCLEVBQzdCLGNBQStCO1FBRS9CLE9BQU8sTUFBTSxLQUFLLENBQUMsZ0JBQWdCLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO0lBQ2xFLENBQUM7SUFFTSxjQUFjLENBQ25CLE1BQWEsRUFDYixNQUFhLEVBQ2IsU0FBb0I7UUFFcEIsTUFBTSxFQUFFLGNBQWMsRUFBRSxTQUFTLEVBQUUsU0FBUyxFQUFFLEdBQUcsSUFBSSxDQUFDLGlCQUFpQixDQUFDO1lBQ3RFLE1BQU07WUFDTixNQUFNO1lBQ04sU0FBUztTQUNWLENBQUMsQ0FBQztRQUNILE9BQU87WUFDTCxXQUFXLEVBQUUsY0FBYztZQUMzQixNQUFNLEVBQUUsU0FBUztZQUNqQixNQUFNLEVBQUUsU0FBUztTQUNsQixDQUFDO0lBQ0osQ0FBQztJQUVrQix3QkFBd0I7UUFDekMsT0FBTyxXQUFXLENBQUM7SUFDckIsQ0FBQztJQUVrQixvQkFBb0I7UUFDckMsT0FBTyxPQUFPLENBQUM7SUFDakIsQ0FBQztJQUVrQixLQUFLLENBQUMsWUFBWSxDQUNuQyxhQUF1QixFQUN2QixZQUFvQixFQUNwQixjQUErQjtRQUUvQixNQUFNLEVBQUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxHQUFHLE1BQU0sSUFBQSxxQkFBSyxFQUFDLEtBQUssSUFBSSxFQUFFO1lBQ3RELE9BQU8sSUFBSSxDQUFDLGtCQUFrQixDQUFDLG1DQUFtQyxDQUdoRTtnQkFDQSxTQUFTLEVBQUUsYUFBYTtnQkFDeEIsaUJBQWlCLEVBQUUsMkRBQTRCLENBQUMsZUFBZSxFQUFFO2dCQUNqRSxZQUFZLEVBQUUsWUFBWTtnQkFDMUIsY0FBYzthQUNmLENBQUMsQ0FBQztRQUNMLENBQUMsRUFBRSxJQUFJLENBQUMsWUFBWSxDQUFDLENBQUM7UUFFdEIsU0FBRyxDQUFDLEtBQUssQ0FBQyxpQ0FBaUMsV0FBVyxFQUFFLENBQUMsQ0FBQztRQUUxRCxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0lBRWtCLGlCQUFpQixDQUFDLElBQXFCO1FBS3hELE1BQU0sQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxHQUFHLElBQUksQ0FBQztRQUV6QyxNQUFNLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxHQUFHLE1BQU0sQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1lBQ2pELENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUM7WUFDbEIsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBRXJCLE1BQU0sUUFBUSxHQUFHLEdBQUcsSUFBSSxDQUFDLE9BQU8sSUFBSSxNQUFNLENBQUMsT0FBTyxJQUFJLE1BQU0sQ0FBQyxPQUFPLElBQUksU0FBUyxFQUFFLENBQUM7UUFFcEYsTUFBTSxhQUFhLEdBQUcsSUFBSSxDQUFDLGtCQUFrQixDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBRXhELElBQUksYUFBYSxFQUFFO1lBQ2pCLE9BQU87Z0JBQ0wsY0FBYyxFQUFFLGFBQWE7Z0JBQzdCLFNBQVMsRUFBRSxNQUFNO2dCQUNqQixTQUFTLEVBQUUsTUFBTTthQUNsQixDQUFDO1NBQ0g7UUFFRCxNQUFNLFdBQVcsR0FBRyxJQUFBLDJCQUFrQixFQUFDO1lBQ3JDLGNBQWMsRUFBRSxxQ0FBeUIsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFFO1lBQ3hELE1BQU0sRUFBRSxNQUFNO1lBQ2QsTUFBTSxFQUFFLE1BQU07WUFDZCxHQUFHLEVBQUUsU0FBUztZQUNkLDBCQUEwQixFQUFFLFNBQVM7WUFDckMsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO1NBQ3RCLENBQUMsQ0FBQztRQUVILElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxRQUFRLENBQUMsR0FBRyxXQUFXLENBQUM7UUFFaEQsT0FBTztZQUNMLGNBQWMsRUFBRSxXQUFXO1lBQzNCLFNBQVMsRUFBRSxNQUFNO1lBQ2pCLFNBQVMsRUFBRSxNQUFNO1NBQ2xCLENBQUM7SUFDSixDQUFDO0lBRVMsZUFBZSxDQUN2QixJQUFxQixFQUNyQixLQUFlLEVBQ2YsU0FBdUI7UUFFdkIsTUFBTSxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsU0FBUyxDQUFDLEdBQUcsSUFBSSxDQUFDO1FBRXpDLE9BQU8sSUFBSSxhQUFJLENBQ2IsTUFBTSxFQUNOLE1BQU0sRUFDTixTQUFTLEVBQ1QsS0FBSyxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsRUFDN0IsU0FBUyxDQUFDLFFBQVEsRUFBRSxFQUNwQixLQUFLLENBQUMsSUFBSSxDQUNYLENBQUM7SUFDSixDQUFDO0lBRVMsdUJBQXVCLENBQUMsb0JBRWpDO1FBQ0MsT0FBTztZQUNMLE9BQU8sRUFBRSxDQUNQLE1BQWEsRUFDYixNQUFhLEVBQ2IsU0FBb0IsRUFDRixFQUFFO2dCQUNwQixNQUFNLEVBQUUsV0FBVyxFQUFFLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDO2dCQUN2RSxPQUFPLG9CQUFvQixDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQzNDLENBQUM7WUFDRCxnQkFBZ0IsRUFBRSxDQUFDLE9BQWUsRUFBb0IsRUFBRSxDQUN0RCxvQkFBb0IsQ0FBQyxPQUFPLENBQUM7WUFDL0IsV0FBVyxFQUFFLEdBQVcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsb0JBQW9CLENBQUM7U0FDL0QsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQWpLRCx3Q0FpS0MifQ==

package/build/main/providers/v3/static-subgraph-provider.d.ts

@@ -0,0 +1,21 @@
+import { ChainId, Token } from '@uniswap/sdk-core';
+import { ProviderConfig } from '../provider';
+import { IV3PoolProvider } from './pool-provider';
+import { IV3SubgraphProvider, V3SubgraphPool } from './subgraph-provider';
+/**
+ * Provider that uses a hardcoded list of V3 pools to generate a list of subgraph pools.
+ *
+ * Since the pools are hardcoded and the data does not come from the Subgraph, the TVL values
+ * are dummys and should not be depended on.
+ *
+ * Useful for instances where other data sources are unavailable. E.g. Subgraph not available.
+ *
+ * @export
+ * @class StaticV3SubgraphProvider
+ */
+export declare class StaticV3SubgraphProvider implements IV3SubgraphProvider {
+    private chainId;
+    private poolProvider;
+    constructor(chainId: ChainId, poolProvider: IV3PoolProvider);
+    getPools(tokenIn?: Token, tokenOut?: Token, providerConfig?: ProviderConfig): Promise<V3SubgraphPool[]>;
+}