@ring-protocol/smart-order-router 0.5.0

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

@@ -0,0 +1,32 @@
+import { ChainId, Token } from '@ring-protocol/sdk-core';
+import { FeeAmount, Pool } from '@ring-protocol/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/module/providers/v3/caching-pool-provider.js

@@ -0,0 +1,77 @@
+import _ from 'lodash';
+import { metric, MetricLoggerUnit } from '../../util';
+import { log } from '../../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
+ */
+export 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) {
+                metric.putMetric('V3_INMEMORY_CACHING_POOL_HIT_IN_MEMORY', 1, MetricLoggerUnit.None);
+                poolAddressToPool[poolAddress] = cachedPool;
+                continue;
+            }
+            metric.putMetric('V3_INMEMORY_CACHING_POOL_MISS_NOT_IN_MEMORY', 1, MetricLoggerUnit.None);
+            poolsToGetTokenPairs.push([token0, token1, feeAmount]);
+            poolsToGetAddresses.push(poolAddress);
+        }
+        log.info({
+            poolsFound: _.map(Object.values(poolAddressToPool), (p) => `${p.token0.symbol} ${p.token1.symbol} ${p.fee}`),
+            poolsToGetTokenPairs: _.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);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1wb29sLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy92My9jYWNoaW5nLXBvb2wtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsT0FBTyxDQUFDLE1BQU0sUUFBUSxDQUFDO0FBRXZCLE9BQU8sRUFBRSxNQUFNLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxZQUFZLENBQUM7QUFDdEQsT0FBTyxFQUFFLEdBQUcsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBTXJDOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLE9BQU8scUJBQXFCO0lBVWhDOzs7OztPQUtHO0lBQ0gsWUFDWSxPQUFnQixFQUNoQixZQUE2QixFQUMvQixLQUFtQjtRQUZqQixZQUFPLEdBQVAsT0FBTyxDQUFTO1FBQ2hCLGlCQUFZLEdBQVosWUFBWSxDQUFpQjtRQUMvQixVQUFLLEdBQUwsS0FBSyxDQUFjO1FBbEJyQixhQUFRLEdBQUcsQ0FDakIsT0FBZ0IsRUFDaEIsT0FBZSxFQUNmLFdBQW9CLEVBQ3BCLEVBQUUsQ0FDRixXQUFXO1lBQ1QsQ0FBQyxDQUFDLFFBQVEsT0FBTyxJQUFJLE9BQU8sSUFBSSxXQUFXLEVBQUU7WUFDN0MsQ0FBQyxDQUFDLFFBQVEsT0FBTyxJQUFJLE9BQU8sRUFBRSxDQUFDO0lBWS9CLENBQUM7SUFFRSxLQUFLLENBQUMsUUFBUSxDQUNuQixVQUF1QyxFQUN2QyxjQUErQjtRQUUvQixNQUFNLGNBQWMsR0FBZ0IsSUFBSSxHQUFHLEVBQVUsQ0FBQztRQUN0RCxNQUFNLG9CQUFvQixHQUFxQyxFQUFFLENBQUM7UUFDbEUsTUFBTSxtQkFBbUIsR0FBYSxFQUFFLENBQUM7UUFDekMsTUFBTSxpQkFBaUIsR0FBb0MsRUFBRSxDQUFDO1FBQzlELE1BQU0sV0FBVyxHQUFHLE1BQU0sQ0FBQSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsV0FBVyxDQUFBLENBQUM7UUFFdEQsS0FBSyxNQUFNLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsSUFBSSxVQUFVLEVBQUU7WUFDcEQsTUFBTSxFQUFFLFdBQVcsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FDekQsTUFBTSxFQUNOLE1BQU0sRUFDTixTQUFTLENBQ1YsQ0FBQztZQUVGLElBQUksY0FBYyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsRUFBRTtnQkFDbkMsU0FBUzthQUNWO1lBRUQsY0FBYyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUVoQyxNQUFNLFVBQVUsR0FBRyxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUNyQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsV0FBVyxFQUFFLFdBQVcsQ0FBQyxDQUN0RCxDQUFDO1lBQ0YsSUFBSSxVQUFVLEVBQUU7Z0JBQ2QsTUFBTSxDQUFDLFNBQVMsQ0FDZCx3Q0FBd0MsRUFDeEMsQ0FBQyxFQUNELGdCQUFnQixDQUFDLElBQUksQ0FDdEIsQ0FBQztnQkFDRixpQkFBaUIsQ0FBQyxXQUFXLENBQUMsR0FBRyxVQUFVLENBQUM7Z0JBQzVDLFNBQVM7YUFDVjtZQUVELE1BQU0sQ0FBQyxTQUFTLENBQ2QsNkNBQTZDLEVBQzdDLENBQUMsRUFDRCxnQkFBZ0IsQ0FBQyxJQUFJLENBQ3RCLENBQUM7WUFDRixvQkFBb0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDLENBQUM7WUFDdkQsbUJBQW1CLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1NBQ3ZDO1FBRUQsR0FBRyxDQUFDLElBQUksQ0FDTjtZQUNFLFVBQVUsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUNmLE1BQU0sQ0FBQyxNQUFNLENBQUMsaUJBQWlCLENBQUMsRUFDaEMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLEdBQUcsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUN4RDtZQUNELG9CQUFvQixFQUFFLENBQUMsQ0FBQyxHQUFHLENBQ3pCLG9CQUFvQixFQUNwQixDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQy9DO1NBQ0YsRUFDRCxTQUFTLE1BQU0sQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxNQUN4QywyRUFBMkUsb0JBQW9CLENBQUMsTUFDaEcsU0FBUyxDQUNWLENBQUM7UUFFRixJQUFJLG1CQUFtQixDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7WUFDbEMsTUFBTSxZQUFZLEdBQUcsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FDbkQsb0JBQW9CLEVBQ3BCLGNBQWMsQ0FDZixDQUFDO1lBQ0YsS0FBSyxNQUFNLE9BQU8sSUFBSSxtQkFBbUIsRUFBRTtnQkFDekMsTUFBTSxJQUFJLEdBQUcsWUFBWSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxDQUFDO2dCQUNwRCxJQUFJLElBQUksRUFBRTtvQkFDUixpQkFBaUIsQ0FBQyxPQUFPLENBQUMsR0FBRyxJQUFJLENBQUM7b0JBQ2xDLGlGQUFpRjtvQkFDakYsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQ1osSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxXQUFXLENBQUMsRUFDakQsSUFBSSxDQUNMLENBQUM7aUJBQ0g7YUFDRjtTQUNGO1FBRUQsT0FBTztZQUNMLE9BQU8sRUFBRSxDQUNQLE1BQWEsRUFDYixNQUFhLEVBQ2IsU0FBb0IsRUFDRixFQUFFO2dCQUNwQixNQUFNLEVBQUUsV0FBVyxFQUFFLEdBQUcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDO2dCQUN2RSxPQUFPLGlCQUFpQixDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ3hDLENBQUM7WUFDRCxnQkFBZ0IsRUFBRSxDQUFDLE9BQWUsRUFBb0IsRUFBRSxDQUN0RCxpQkFBaUIsQ0FBQyxPQUFPLENBQUM7WUFDNUIsV0FBVyxFQUFFLEdBQVcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsaUJBQWlCLENBQUM7U0FDNUQsQ0FBQztJQUNKLENBQUM7SUFFTSxjQUFjLENBQ25CLE1BQWEsRUFDYixNQUFhLEVBQ2IsU0FBb0I7UUFFcEIsT0FBTyxJQUFJLENBQUMsWUFBWSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7Q0FDRiJ9

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

@@ -0,0 +1,19 @@
+import { ChainId } from '@ring-protocol/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/module/providers/v3/caching-subgraph-provider.js

@@ -0,0 +1,20 @@
+import { Protocol } from '@ring-protocol/router-sdk';
+import { CachingSubgraphProvider } from '../caching-subgraph-provider';
+/**
+ * Provider for getting V3 pools, with functionality for caching the results.
+ *
+ * @export
+ * @class CachingV3SubgraphProvider
+ */
+export class CachingV3SubgraphProvider extends 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, Protocol.V3);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvdjMvY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFDckQsT0FBTyxFQUFFLHVCQUF1QixFQUFFLE1BQU0sOEJBQThCLENBQUM7QUFJdkU7Ozs7O0dBS0c7QUFDSCxNQUFNLE9BQU8seUJBQ1gsU0FBUSx1QkFBdUM7SUFFL0M7Ozs7O09BS0c7SUFDSCxZQUNFLE9BQWdCLEVBQ2hCLGdCQUFxQyxFQUNyQyxLQUErQjtRQUUvQixLQUFLLENBQUMsT0FBTyxFQUFFLGdCQUFnQixFQUFFLEtBQUssRUFBRSxRQUFRLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztDQUNGIn0=

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

@@ -0,0 +1,39 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { BaseProvider } from '@ethersproject/providers';
+import { ChainId } from '@ring-protocol/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 declare 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/module/providers/v3/gas-data-provider.js

@@ -0,0 +1,22 @@
+import { GasDataArbitrum__factory } from '../../types/other/factories/GasDataArbitrum__factory';
+import { ARB_GASINFO_ADDRESS } from '../../util';
+export class ArbitrumGasDataProvider {
+    constructor(chainId, provider, gasDataAddress) {
+        this.chainId = chainId;
+        this.provider = provider;
+        this.gasFeesAddress = gasDataAddress ? gasDataAddress : ARB_GASINFO_ADDRESS;
+    }
+    async getGasData(providerConfig) {
+        const gasDataContract = 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],
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLWRhdGEtcHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL3YzL2dhcy1kYXRhLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUlBLE9BQU8sRUFBRSx3QkFBd0IsRUFBRSxNQUFNLHNEQUFzRCxDQUFDO0FBQ2hHLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLFlBQVksQ0FBQztBQTRCakQsTUFBTSxPQUFPLHVCQUF1QjtJQUtsQyxZQUNZLE9BQWdCLEVBQ2hCLFFBQXNCLEVBQ2hDLGNBQXVCO1FBRmIsWUFBTyxHQUFQLE9BQU8sQ0FBUztRQUNoQixhQUFRLEdBQVIsUUFBUSxDQUFjO1FBR2hDLElBQUksQ0FBQyxjQUFjLEdBQUcsY0FBYyxDQUFDLENBQUMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDLG1CQUFtQixDQUFDO0lBQzlFLENBQUM7SUFFTSxLQUFLLENBQUMsVUFBVSxDQUFDLGNBQStCO1FBQ3JELE1BQU0sZUFBZSxHQUFHLHdCQUF3QixDQUFDLE9BQU8sQ0FDdEQsSUFBSSxDQUFDLGNBQWMsRUFDbkIsSUFBSSxDQUFDLFFBQVEsQ0FDZCxDQUFDO1FBQ0YsTUFBTSxPQUFPLEdBQUcsTUFBTSxlQUFlLENBQUMsY0FBYyxDQUFDO1lBQ25ELFFBQVEsRUFBRSxjQUFjLGFBQWQsY0FBYyx1QkFBZCxjQUFjLENBQUUsV0FBVztTQUN0QyxDQUFDLENBQUM7UUFDSCxNQUFNLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNyQyxPQUFPO1lBQ0wsVUFBVSxFQUFFLE9BQU8sQ0FBQyxDQUFDLENBQUM7WUFDdEIsZ0JBQWdCLEVBQUUsaUJBQWlCLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUMzQyxjQUFjLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztTQUMzQixDQUFDO0lBQ0osQ0FBQztDQUNGIn0=

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

@@ -0,0 +1,77 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { ChainId, Token } from '@ring-protocol/sdk-core';
+import { FeeAmount, Pool } from '@ring-protocol/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';
+declare type V3ISlot0 = ISlot0 & {
+    sqrtPriceX96: BigNumber;
+    tick: number;
+};
+declare 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 declare type V3PoolAccessor = {
+    getPool: (tokenA: Token, tokenB: Token, feeAmount: FeeAmount) => Pool | undefined;
+    getPoolByAddress: (address: string) => Pool | undefined;
+    getAllPools: () => Pool[];
+};
+export declare type V3PoolRetryOptions = RetryOptions;
+export declare 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/module/providers/v3/pool-provider.js

@@ -0,0 +1,101 @@
+import { computePoolAddress, Pool } from '@ring-protocol/v3-sdk';
+import retry from 'async-retry';
+import { IUniswapV3PoolState__factory } from '../../types/v3/factories/IUniswapV3PoolState__factory';
+import { V3_CORE_FACTORY_ADDRESSES } from '../../util/addresses';
+import { log } from '../../util/log';
+import { PoolProvider } from '../pool-provider';
+export class V3PoolProvider extends 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 retry(async () => {
+            return this.multicall2Provider.callSameFunctionOnMultipleContracts({
+                addresses: poolAddresses,
+                contractInterface: IUniswapV3PoolState__factory.createInterface(),
+                functionName: functionName,
+                providerConfig,
+            });
+        }, this.retryOptions);
+        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 = computePoolAddress({
+            factoryAddress: 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 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),
+        };
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicG9vbC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvdjMvcG9vbC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsa0JBQWtCLEVBQWEsSUFBSSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDNUUsT0FBTyxLQUFrQyxNQUFNLGFBQWEsQ0FBQztBQUU3RCxPQUFPLEVBQUUsNEJBQTRCLEVBQUUsTUFBTSx1REFBdUQsQ0FBQztBQUNyRyxPQUFPLEVBQUUseUJBQXlCLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRSxPQUFPLEVBQUUsR0FBRyxFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFFckMsT0FBTyxFQUFzQixZQUFZLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQXlEcEUsTUFBTSxPQUFPLGNBQ1gsU0FBUSxZQU1QO0lBTUQ7Ozs7O09BS0c7SUFDSCxZQUNFLE9BQWdCLEVBQ2hCLGtCQUFzQyxFQUN0QyxlQUFtQztRQUNqQyxPQUFPLEVBQUUsQ0FBQztRQUNWLFVBQVUsRUFBRSxFQUFFO1FBQ2QsVUFBVSxFQUFFLEdBQUc7S0FDaEI7UUFFRCxLQUFLLENBQUMsT0FBTyxFQUFFLGtCQUFrQixFQUFFLFlBQVksQ0FBQyxDQUFDO1FBbkJuRCx5RUFBeUU7UUFDekUsa0RBQWtEO1FBQzFDLHVCQUFrQixHQUE4QixFQUFFLENBQUM7SUFrQjNELENBQUM7SUFFTSxLQUFLLENBQUMsUUFBUSxDQUNuQixVQUE2QixFQUM3QixjQUErQjtRQUUvQixPQUFPLE1BQU0sS0FBSyxDQUFDLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxjQUFjLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRU0sY0FBYyxDQUNuQixNQUFhLEVBQ2IsTUFBYSxFQUNiLFNBQW9CO1FBRXBCLE1BQU0sRUFBRSxjQUFjLEVBQUUsU0FBUyxFQUFFLFNBQVMsRUFBRSxHQUFHLElBQUksQ0FBQyxpQkFBaUIsQ0FBQztZQUN0RSxNQUFNO1lBQ04sTUFBTTtZQUNOLFNBQVM7U0FDVixDQUFDLENBQUM7UUFDSCxPQUFPO1lBQ0wsV0FBVyxFQUFFLGNBQWM7WUFDM0IsTUFBTSxFQUFFLFNBQVM7WUFDakIsTUFBTSxFQUFFLFNBQVM7U0FDbEIsQ0FBQztJQUNKLENBQUM7SUFFa0Isd0JBQXdCO1FBQ3pDLE9BQU8sV0FBVyxDQUFDO0lBQ3JCLENBQUM7SUFFa0Isb0JBQW9CO1FBQ3JDLE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7SUFFa0IsS0FBSyxDQUFDLFlBQVksQ0FDbkMsYUFBdUIsRUFDdkIsWUFBb0IsRUFDcEIsY0FBK0I7UUFFL0IsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsR0FBRyxNQUFNLEtBQUssQ0FBQyxLQUFLLElBQUksRUFBRTtZQUN0RCxPQUFPLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxtQ0FBbUMsQ0FHaEU7Z0JBQ0EsU0FBUyxFQUFFLGFBQWE7Z0JBQ3hCLGlCQUFpQixFQUFFLDRCQUE0QixDQUFDLGVBQWUsRUFBRTtnQkFDakUsWUFBWSxFQUFFLFlBQVk7Z0JBQzFCLGNBQWM7YUFDZixDQUFDLENBQUM7UUFDTCxDQUFDLEVBQUUsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBRXRCLEdBQUcsQ0FBQyxLQUFLLENBQUMsaUNBQWlDLFdBQVcsRUFBRSxDQUFDLENBQUM7UUFFMUQsT0FBTyxPQUFPLENBQUM7SUFDakIsQ0FBQztJQUVrQixpQkFBaUIsQ0FBQyxJQUFxQjtRQUt4RCxNQUFNLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsR0FBRyxJQUFJLENBQUM7UUFFekMsTUFBTSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsR0FBRyxNQUFNLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztZQUNqRCxDQUFDLENBQUMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDO1lBQ2xCLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztRQUVyQixNQUFNLFFBQVEsR0FBRyxHQUFHLElBQUksQ0FBQyxPQUFPLElBQUksTUFBTSxDQUFDLE9BQU8sSUFBSSxNQUFNLENBQUMsT0FBTyxJQUFJLFNBQVMsRUFBRSxDQUFDO1FBRXBGLE1BQU0sYUFBYSxHQUFHLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUV4RCxJQUFJLGFBQWEsRUFBRTtZQUNqQixPQUFPO2dCQUNMLGNBQWMsRUFBRSxhQUFhO2dCQUM3QixTQUFTLEVBQUUsTUFBTTtnQkFDakIsU0FBUyxFQUFFLE1BQU07YUFDbEIsQ0FBQztTQUNIO1FBRUQsTUFBTSxXQUFXLEdBQUcsa0JBQWtCLENBQUM7WUFDckMsY0FBYyxFQUFFLHlCQUF5QixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUU7WUFDeEQsTUFBTSxFQUFFLE1BQU07WUFDZCxNQUFNLEVBQUUsTUFBTTtZQUNkLEdBQUcsRUFBRSxTQUFTO1lBQ2QsMEJBQTBCLEVBQUUsU0FBUztZQUNyQyxPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87U0FDdEIsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLGtCQUFrQixDQUFDLFFBQVEsQ0FBQyxHQUFHLFdBQVcsQ0FBQztRQUVoRCxPQUFPO1lBQ0wsY0FBYyxFQUFFLFdBQVc7WUFDM0IsU0FBUyxFQUFFLE1BQU07WUFDakIsU0FBUyxFQUFFLE1BQU07U0FDbEIsQ0FBQztJQUNKLENBQUM7SUFFUyxlQUFlLENBQ3ZCLElBQXFCLEVBQ3JCLEtBQWUsRUFDZixTQUF1QjtRQUV2QixNQUFNLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLENBQUMsR0FBRyxJQUFJLENBQUM7UUFFekMsT0FBTyxJQUFJLElBQUksQ0FDYixNQUFNLEVBQ04sTUFBTSxFQUNOLFNBQVMsRUFDVCxLQUFLLENBQUMsWUFBWSxDQUFDLFFBQVEsRUFBRSxFQUM3QixTQUFTLENBQUMsUUFBUSxFQUFFLEVBQ3BCLEtBQUssQ0FBQyxJQUFJLENBQ1gsQ0FBQztJQUNKLENBQUM7SUFFUyx1QkFBdUIsQ0FBQyxvQkFFakM7UUFDQyxPQUFPO1lBQ0wsT0FBTyxFQUFFLENBQ1AsTUFBYSxFQUNiLE1BQWEsRUFDYixTQUFvQixFQUNGLEVBQUU7Z0JBQ3BCLE1BQU0sRUFBRSxXQUFXLEVBQUUsR0FBRyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsU0FBUyxDQUFDLENBQUM7Z0JBQ3ZFLE9BQU8sb0JBQW9CLENBQUMsV0FBVyxDQUFDLENBQUM7WUFDM0MsQ0FBQztZQUNELGdCQUFnQixFQUFFLENBQUMsT0FBZSxFQUFvQixFQUFFLENBQ3RELG9CQUFvQixDQUFDLE9BQU8sQ0FBQztZQUMvQixXQUFXLEVBQUUsR0FBVyxFQUFFLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQztTQUMvRCxDQUFDO0lBQ0osQ0FBQztDQUNGIn0=

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

@@ -0,0 +1,21 @@
+import { ChainId, Token } from '@ring-protocol/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[]>;
+}