@ring-protocol/smart-order-router 0.5.0

package/build/main/providers/v2/subgraph-provider.js

@@ -0,0 +1,334 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V2SubgraphProvider = void 0;
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const async_retry_1 = __importDefault(require("async-retry"));
+const await_timeout_1 = __importDefault(require("await-timeout"));
+const graphql_request_1 = require("graphql-request");
+const lodash_1 = __importDefault(require("lodash"));
+const log_1 = require("../../util/log");
+const metric_1 = require("../../util/metric");
+const SUBGRAPH_URL_BY_CHAIN = {
+    [sdk_core_1.ChainId.MAINNET]: 'https://api.thegraph.com/subgraphs/name/ianlapham/uniswap-v2-dev',
+};
+const PAGE_SIZE = 1000; // 1k is max possible query size from subgraph.
+class V2SubgraphProvider {
+    constructor(chainId, retries = 2, timeout = 360000, rollback = true, pageSize = PAGE_SIZE, trackedEthThreshold = 0.025, untrackedUsdThreshold = Number.MAX_VALUE, subgraphUrlOverride) {
+        var _a;
+        this.chainId = chainId;
+        this.retries = retries;
+        this.timeout = timeout;
+        this.rollback = rollback;
+        this.pageSize = pageSize;
+        this.trackedEthThreshold = trackedEthThreshold;
+        this.untrackedUsdThreshold = untrackedUsdThreshold;
+        this.subgraphUrlOverride = subgraphUrlOverride;
+        const subgraphUrl = (_a = this.subgraphUrlOverride) !== null && _a !== void 0 ? _a : SUBGRAPH_URL_BY_CHAIN[this.chainId];
+        if (!subgraphUrl) {
+            throw new Error(`No subgraph url for chain id: ${this.chainId}`);
+        }
+        this.client = new graphql_request_1.GraphQLClient(subgraphUrl);
+    }
+    async getPools(_tokenIn, _tokenOut, providerConfig) {
+        const beforeAll = Date.now();
+        let blockNumber = (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber)
+            ? await providerConfig.blockNumber
+            : undefined;
+        log_1.log.info(`Getting V2 pools from the subgraph with page size ${this.pageSize}${(providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber)
+            ? ` as of block ${providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.blockNumber}`
+            : ''}.`);
+        // TODO: Remove. Temporary fix to ensure tokens without trackedReserveETH are in the list.
+        const FEI = '0x956f47f50a910163d8bf957cf5846d573e7f87ca';
+        const virtualTokenAddress = '0x0b3e328455c4059eeb9e3f84b5543f74e24e7e1b'.toLowerCase();
+        // Define separate queries for each filtering condition
+        // Note: GraphQL doesn't support OR conditions, so we need separate queries for each condition
+        const queries = [
+            // 1. FEI token pools - split into two queries since OR is not supported
+            {
+                name: 'FEI pools (token0)',
+                query: (0, graphql_request_1.gql) `
+          query getFEIPoolsToken0($pageSize: Int!, $id: String, $feiToken: String!) {
+            pairs(
+              first: $pageSize
+              ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+              where: { 
+                id_gt: $id,
+                token0: $feiToken
+              }
+            ) {
+              id
+              token0 { id, symbol }
+              token1 { id, symbol }
+              totalSupply
+              trackedReserveETH
+              reserveETH
+              reserveUSD
+            }
+          }
+        `,
+                variables: { feiToken: FEI },
+            },
+            {
+                name: 'FEI pools (token1)',
+                query: (0, graphql_request_1.gql) `
+          query getFEIPoolsToken1($pageSize: Int!, $id: String, $feiToken: String!) {
+            pairs(
+              first: $pageSize
+              ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+              where: { 
+                id_gt: $id,
+                token1: $feiToken
+              }
+            ) {
+              id
+              token0 { id, symbol }
+              token1 { id, symbol }
+              totalSupply
+              trackedReserveETH
+              reserveETH
+              reserveUSD
+            }
+          }
+        `,
+                variables: { feiToken: FEI },
+            },
+            // 2. Virtual pair pools (only for BASE chain) - split into two queries
+            ...(this.chainId === sdk_core_1.ChainId.BASE
+                ? [
+                    {
+                        name: 'Virtual pair pools (token0)',
+                        query: (0, graphql_request_1.gql) `
+            query getVirtualPoolsToken0($pageSize: Int!, $id: String, $virtualToken: String!) {
+              pairs(
+                first: $pageSize
+                ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+                where: { 
+                  id_gt: $id,
+                  token0: $virtualToken
+                }
+              ) {
+                id
+                token0 { id, symbol }
+                token1 { id, symbol }
+                totalSupply
+                trackedReserveETH
+                reserveETH
+                reserveUSD
+              }
+            }
+          `,
+                        variables: { virtualToken: virtualTokenAddress },
+                    },
+                    {
+                        name: 'Virtual pair pools (token1)',
+                        query: (0, graphql_request_1.gql) `
+            query getVirtualPoolsToken1($pageSize: Int!, $id: String, $virtualToken: String!) {
+              pairs(
+                first: $pageSize
+                ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+                where: { 
+                  id_gt: $id,
+                  token1: $virtualToken
+                }
+              ) {
+                id
+                token0 { id, symbol }
+                token1 { id, symbol }
+                totalSupply
+                trackedReserveETH
+                reserveETH
+                reserveUSD
+              }
+            }
+          `,
+                        variables: { virtualToken: virtualTokenAddress },
+                    },
+                ]
+                : []),
+            // 3. High tracked reserve ETH pools
+            {
+                name: 'High tracked reserve ETH pools',
+                query: (0, graphql_request_1.gql) `
+          query getHighTrackedReservePools($pageSize: Int!, $id: String, $threshold: String!) {
+            pairs(
+              first: $pageSize
+              ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+              where: { 
+                id_gt: $id,
+                trackedReserveETH_gt: $threshold
+              }
+            ) {
+              id
+              token0 { id, symbol }
+              token1 { id, symbol }
+              totalSupply
+              trackedReserveETH
+              reserveETH
+              reserveUSD
+            }
+          }
+        `,
+                variables: { threshold: this.trackedEthThreshold.toString() },
+            },
+            // 4. High untracked USD pools
+            {
+                name: 'High untracked USD pools',
+                query: (0, graphql_request_1.gql) `
+          query getHighUSDReservePools($pageSize: Int!, $id: String, $threshold: String!) {
+            pairs(
+              first: $pageSize
+              ${blockNumber ? `block: { number: ${blockNumber} }` : ``}
+              where: { 
+                id_gt: $id,
+                reserveUSD_gt: $threshold
+              }
+            ) {
+              id
+              token0 { id, symbol }
+              token1 { id, symbol }
+              totalSupply
+              trackedReserveETH
+              reserveETH
+              reserveUSD
+            }
+          }
+        `,
+                variables: { threshold: this.untrackedUsdThreshold.toString() },
+            },
+        ];
+        let allPools = [];
+        let outerRetries = 0;
+        await (0, async_retry_1.default)(async () => {
+            const timeout = new await_timeout_1.default();
+            const fetchPoolsForQuery = async (queryConfig) => {
+                let lastId = '';
+                let pools = [];
+                let poolsPage = [];
+                let totalPages = 0;
+                let retries = 0;
+                do {
+                    totalPages += 1;
+                    const start = Date.now();
+                    log_1.log.info(`Starting fetching for ${queryConfig.name} page ${totalPages} with page size ${this.pageSize}`);
+                    await (0, async_retry_1.default)(async () => {
+                        const before = Date.now();
+                        const poolsResult = await this.client.request(queryConfig.query, Object.assign({ pageSize: this.pageSize, id: lastId }, queryConfig.variables));
+                        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.${queryConfig.name
+                            .replace(/\s+/g, '_')
+                            .toLowerCase()}.paginate.latency`, Date.now() - before);
+                        poolsPage = poolsResult.pairs;
+                        pools = pools.concat(poolsPage);
+                        if (pools.length > 0) {
+                            lastId = pools[pools.length - 1].id;
+                        }
+                        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.${queryConfig.name
+                            .replace(/\s+/g, '_')
+                            .toLowerCase()}.paginate.pageSize`, poolsPage.length);
+                    }, {
+                        retries: this.retries,
+                        onRetry: (err, retry) => {
+                            retries += 1;
+                            log_1.log.error({ err, lastId }, `Failed request for ${queryConfig.name} page of pools from subgraph. Retry attempt: ${retry}. LastId: ${lastId}`);
+                        },
+                    });
+                    log_1.log.info(`Fetched ${poolsPage.length} pools for ${queryConfig.name} in ${Date.now() - start}ms`);
+                } while (poolsPage.length > 0);
+                metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.${queryConfig.name
+                    .replace(/\s+/g, '_')
+                    .toLowerCase()}.paginate`, totalPages);
+                metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.${queryConfig.name
+                    .replace(/\s+/g, '_')
+                    .toLowerCase()}.pairs.length`, pools.length);
+                metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.${queryConfig.name
+                    .replace(/\s+/g, '_')
+                    .toLowerCase()}.paginate.retries`, retries);
+                return pools;
+            };
+            try {
+                // Fetch pools for each query in parallel
+                const poolPromises = queries.map((queryConfig) => fetchPoolsForQuery(queryConfig));
+                const allPoolsArrays = await Promise.all(poolPromises);
+                // Merge all results and deduplicate by pool ID
+                const poolMap = new Map();
+                allPoolsArrays.forEach((pools) => {
+                    pools.forEach((pool) => {
+                        poolMap.set(pool.id, pool);
+                    });
+                });
+                allPools = Array.from(poolMap.values());
+                const getPoolsPromise = Promise.resolve(allPools);
+                const timerPromise = timeout.set(this.timeout).then(() => {
+                    throw new Error(`Timed out getting pools from subgraph: ${this.timeout}`);
+                });
+                allPools = await Promise.race([getPoolsPromise, timerPromise]);
+                return;
+            }
+            catch (err) {
+                log_1.log.error({ err }, 'Error fetching V2 Subgraph Pools.');
+                throw err;
+            }
+            finally {
+                timeout.clear();
+            }
+        }, {
+            retries: this.retries,
+            onRetry: (err, retry) => {
+                outerRetries += 1;
+                if (this.rollback &&
+                    blockNumber &&
+                    lodash_1.default.includes(err.message, 'indexed up to')) {
+                    metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.indexError`, 1);
+                    blockNumber = blockNumber - 10;
+                    log_1.log.info(`Detected subgraph indexing error. Rolled back block number to: ${blockNumber}`);
+                }
+                metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.timeout`, 1);
+                allPools = [];
+                log_1.log.info({ err }, `Failed to get pools from subgraph. Retry attempt: ${retry}`);
+            },
+        });
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.retries`, outerRetries);
+        // Apply the same filtering logic to ensure consistency
+        const beforeFilter = Date.now();
+        const poolsSanitized = allPools
+            .filter((pool) => {
+            return (pool.token0.id == FEI ||
+                pool.token1.id == FEI ||
+                this.isVirtualPairBaseV2Pool(pool) ||
+                parseFloat(pool.trackedReserveETH) > this.trackedEthThreshold ||
+                parseFloat(pool.reserveUSD) > this.untrackedUsdThreshold);
+        })
+            .map((pool) => {
+            return {
+                id: pool.id.toLowerCase(),
+                token0: {
+                    id: pool.token0.id.toLowerCase(),
+                },
+                token1: {
+                    id: pool.token1.id.toLowerCase(),
+                },
+                supply: parseFloat(pool.totalSupply),
+                reserve: parseFloat(pool.trackedReserveETH),
+                reserveUSD: parseFloat(pool.reserveUSD),
+            };
+        });
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.filter.latency`, Date.now() - beforeFilter);
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.untracked.length`, poolsSanitized.length);
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.untracked.percent`, (poolsSanitized.length / allPools.length) * 100);
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools`, 1);
+        metric_1.metric.putMetric(`V2SubgraphProvider.chain_${this.chainId}.getPools.latency`, Date.now() - beforeAll);
+        log_1.log.info(`Got ${allPools.length} V2 pools from the subgraph (after deduplication). ${poolsSanitized.length} after filtering`);
+        return poolsSanitized;
+    }
+    // This method checks if a given pool contains the VIRTUAL token.
+    isVirtualPairBaseV2Pool(pool) {
+        const virtualTokenAddress = '0x0b3e328455c4059eeb9e3f84b5543f74e24e7e1b'.toLowerCase();
+        return (this.chainId === sdk_core_1.ChainId.BASE &&
+            (pool.token0.id.toLowerCase() === virtualTokenAddress ||
+                pool.token1.id.toLowerCase() === virtualTokenAddress));
+    }
+}
+exports.V2SubgraphProvider = V2SubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"subgraph-provider.js","sourceRoot":"","sources":["../../../../src/providers/v2/subgraph-provider.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAyD;AACzD,8DAAgC;AAChC,kEAAoC;AACpC,qDAAqD;AACrD,oDAAuB;AAEvB,wCAAqC;AACrC,8CAA2C;AA+B3C,MAAM,qBAAqB,GAAsC;IAC/D,CAAC,kBAAO,CAAC,OAAO,CAAC,EACf,kEAAkE;CACrE,CAAC;AAEF,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,+CAA+C;AAgBvE,MAAa,kBAAkB;IAG7B,YACU,OAAgB,EAChB,UAAU,CAAC,EACX,UAAU,MAAM,EAChB,WAAW,IAAI,EACf,WAAW,SAAS,EACpB,sBAAsB,KAAK,EAC3B,wBAAwB,MAAM,CAAC,SAAS,EACxC,mBAA4B;;QAP5B,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAI;QACX,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAO;QACf,aAAQ,GAAR,QAAQ,CAAY;QACpB,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,0BAAqB,GAArB,qBAAqB,CAAmB;QACxC,wBAAmB,GAAnB,mBAAmB,CAAS;QAEpC,MAAM,WAAW,GACf,MAAA,IAAI,CAAC,mBAAmB,mCAAI,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClE,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;SAClE;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,+BAAa,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,QAAQ,CACnB,QAAgB,EAChB,SAAiB,EACjB,cAA+B;QAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,WAAW,GAAG,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;YAC3C,CAAC,CAAC,MAAM,cAAc,CAAC,WAAW;YAClC,CAAC,CAAC,SAAS,CAAC;QAEd,SAAG,CAAC,IAAI,CACN,qDAAqD,IAAI,CAAC,QAAQ,GAAG,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;YAC9F,CAAC,CAAC,gBAAgB,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,EAAE;YAC/C,CAAC,CAAC,EACJ,GAAG,CACJ,CAAC;QAEF,0FAA0F;QAC1F,MAAM,GAAG,GAAG,4CAA4C,CAAC;QACzD,MAAM,mBAAmB,GACvB,4CAA4C,CAAC,WAAW,EAAE,CAAC;QAE7D,uDAAuD;QACvD,8FAA8F;QAC9F,MAAM,OAAO,GAAG;YACd,wEAAwE;YACxE;gBACE,IAAI,EAAE,oBAAoB;gBAC1B,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;gBAIF,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;SAe7D;gBACD,SAAS,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;aAC7B;YACD;gBACE,IAAI,EAAE,oBAAoB;gBAC1B,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;gBAIF,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;SAe7D;gBACD,SAAS,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;aAC7B;YACD,uEAAuE;YACvE,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,kBAAO,CAAC,IAAI;gBAC/B,CAAC,CAAC;oBACA;wBACE,IAAI,EAAE,6BAA6B;wBACnC,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;kBAIJ,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;WAe7D;wBACC,SAAS,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE;qBACjD;oBACD;wBACE,IAAI,EAAE,6BAA6B;wBACnC,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;kBAIJ,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;WAe7D;wBACC,SAAS,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE;qBACjD;iBACF;gBACD,CAAC,CAAC,EAAE,CAAC;YACP,oCAAoC;YACpC;gBACE,IAAI,EAAE,gCAAgC;gBACtC,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;gBAIF,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;SAe7D;gBACD,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE;aAC9D;YACD,8BAA8B;YAC9B;gBACE,IAAI,EAAE,0BAA0B;gBAChC,KAAK,EAAE,IAAA,qBAAG,EAAA;;;;gBAIF,WAAW,CAAC,CAAC,CAAC,oBAAoB,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;;;;;;;;;;;;SAe7D;gBACD,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE;aAChE;SACF,CAAC;QAEF,IAAI,QAAQ,GAAwB,EAAE,CAAC;QACvC,IAAI,YAAY,GAAG,CAAC,CAAC;QAErB,MAAM,IAAA,qBAAK,EACT,KAAK,IAAI,EAAE;YACT,MAAM,OAAO,GAAG,IAAI,uBAAO,EAAE,CAAC;YAE9B,MAAM,kBAAkB,GAAG,KAAK,EAC9B,WAAgB,EACc,EAAE;gBAChC,IAAI,MAAM,GAAG,EAAE,CAAC;gBAChB,IAAI,KAAK,GAAwB,EAAE,CAAC;gBACpC,IAAI,SAAS,GAAwB,EAAE,CAAC;gBACxC,IAAI,UAAU,GAAG,CAAC,CAAC;gBACnB,IAAI,OAAO,GAAG,CAAC,CAAC;gBAEhB,GAAG;oBACD,UAAU,IAAI,CAAC,CAAC;oBAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACzB,SAAG,CAAC,IAAI,CACN,yBAAyB,WAAW,CAAC,IAAI,SAAS,UAAU,mBAAmB,IAAI,CAAC,QAAQ,EAAE,CAC/F,CAAC;oBAEF,MAAM,IAAA,qBAAK,EACT,KAAK,IAAI,EAAE;wBACT,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBAC1B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAE1C,WAAW,CAAC,KAAK,kBAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ,EACvB,EAAE,EAAE,MAAM,IACP,WAAW,CAAC,SAAS,EACxB,CAAC;wBACH,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OACjC,aAAa,WAAW,CAAC,IAAI;6BAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;6BACpB,WAAW,EAAE,mBAAmB,EACnC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CACpB,CAAC;wBAEF,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC;wBAE9B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;wBAChC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;4BACpB,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,EAAE,CAAC;yBACtC;wBAED,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OACjC,aAAa,WAAW,CAAC,IAAI;6BAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;6BACpB,WAAW,EAAE,oBAAoB,EACpC,SAAS,CAAC,MAAM,CACjB,CAAC;oBACJ,CAAC,EACD;wBACE,OAAO,EAAE,IAAI,CAAC,OAAO;wBACrB,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;4BACtB,OAAO,IAAI,CAAC,CAAC;4BACb,SAAG,CAAC,KAAK,CACP,EAAE,GAAG,EAAE,MAAM,EAAE,EACf,sBAAsB,WAAW,CAAC,IAAI,gDAAgD,KAAK,aAAa,MAAM,EAAE,CACjH,CAAC;wBACJ,CAAC;qBACF,CACF,CAAC;oBACF,SAAG,CAAC,IAAI,CACN,WAAW,SAAS,CAAC,MAAM,cAAc,WAAW,CAAC,IAAI,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAC7E,IAAI,CACL,CAAC;iBACH,QAAQ,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;gBAE/B,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OACjC,aAAa,WAAW,CAAC,IAAI;qBAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;qBACpB,WAAW,EAAE,WAAW,EAC3B,UAAU,CACX,CAAC;gBACF,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OACjC,aAAa,WAAW,CAAC,IAAI;qBAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;qBACpB,WAAW,EAAE,eAAe,EAC/B,KAAK,CAAC,MAAM,CACb,CAAC;gBACF,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OACjC,aAAa,WAAW,CAAC,IAAI;qBAC1B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;qBACpB,WAAW,EAAE,mBAAmB,EACnC,OAAO,CACR,CAAC;gBAEF,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YAEF,IAAI;gBACF,yCAAyC;gBACzC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAC/C,kBAAkB,CAAC,WAAW,CAAC,CAChC,CAAC;gBACF,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAEvD,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;gBACrD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC/B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;wBACrB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;oBAC7B,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;gBAExC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAClD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;oBACvD,MAAM,IAAI,KAAK,CACb,0CAA0C,IAAI,CAAC,OAAO,EAAE,CACzD,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC;gBAC/D,OAAO;aACR;YAAC,OAAO,GAAG,EAAE;gBACZ,SAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,mCAAmC,CAAC,CAAC;gBACxD,MAAM,GAAG,CAAC;aACX;oBAAS;gBACR,OAAO,CAAC,KAAK,EAAE,CAAC;aACjB;QACH,CAAC,EACD;YACE,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACtB,YAAY,IAAI,CAAC,CAAC;gBAClB,IACE,IAAI,CAAC,QAAQ;oBACb,WAAW;oBACX,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,EACxC;oBACA,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,sBAAsB,EAC9D,CAAC,CACF,CAAC;oBACF,WAAW,GAAG,WAAW,GAAG,EAAE,CAAC;oBAC/B,SAAG,CAAC,IAAI,CACN,kEAAkE,WAAW,EAAE,CAChF,CAAC;iBACH;gBACD,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,mBAAmB,EAC3D,CAAC,CACF,CAAC;gBACF,QAAQ,GAAG,EAAE,CAAC;gBACd,SAAG,CAAC,IAAI,CACN,EAAE,GAAG,EAAE,EACP,qDAAqD,KAAK,EAAE,CAC7D,CAAC;YACJ,CAAC;SACF,CACF,CAAC;QAEF,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,mBAAmB,EAC3D,YAAY,CACb,CAAC;QAEF,uDAAuD;QACvD,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,cAAc,GAAqB,QAAQ;aAC9C,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACf,OAAO,CACL,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,GAAG;gBACrB,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,GAAG;gBACrB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC;gBAClC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,mBAAmB;gBAC7D,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,qBAAqB,CACzD,CAAC;QACJ,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE;gBACzB,MAAM,EAAE;oBACN,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE;iBACjC;gBACD,MAAM,EAAE;oBACN,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE;iBACjC;gBACD,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;gBACpC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC;gBAC3C,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;aACxC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEL,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,0BAA0B,EAClE,IAAI,CAAC,GAAG,EAAE,GAAG,YAAY,CAC1B,CAAC;QACF,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,4BAA4B,EACpE,cAAc,CAAC,MAAM,CACtB,CAAC;QACF,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,6BAA6B,EACrE,CAAC,cAAc,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,CAChD,CAAC;QACF,eAAM,CAAC,SAAS,CAAC,4BAA4B,IAAI,CAAC,OAAO,WAAW,EAAE,CAAC,CAAC,CAAC;QACzE,eAAM,CAAC,SAAS,CACd,4BAA4B,IAAI,CAAC,OAAO,mBAAmB,EAC3D,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CACvB,CAAC;QAEF,SAAG,CAAC,IAAI,CACN,OAAO,QAAQ,CAAC,MAAM,sDAAsD,cAAc,CAAC,MAAM,kBAAkB,CACpH,CAAC;QAEF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,iEAAiE;IAC1D,uBAAuB,CAAC,IAAuB;QACpD,MAAM,mBAAmB,GACvB,4CAA4C,CAAC,WAAW,EAAE,CAAC;QAC7D,OAAO,CACL,IAAI,CAAC,OAAO,KAAK,kBAAO,CAAC,IAAI;YAC7B,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,mBAAmB;gBACnD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,mBAAmB,CAAC,CACxD,CAAC;IACJ,CAAC;CACF;AA7aD,gDA6aC"}

package/build/main/providers/v2/uri-subgraph-provider.d.ts

@@ -0,0 +1,4 @@
+import { URISubgraphProvider } from '../uri-subgraph-provider';
+import { IV2SubgraphProvider, V2SubgraphPool } from './subgraph-provider';
+export declare class V2URISubgraphProvider extends URISubgraphProvider<V2SubgraphPool> implements IV2SubgraphProvider {
+}

package/build/main/providers/v2/uri-subgraph-provider.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V2URISubgraphProvider = void 0;
+const uri_subgraph_provider_1 = require("../uri-subgraph-provider");
+class V2URISubgraphProvider extends uri_subgraph_provider_1.URISubgraphProvider {
+}
+exports.V2URISubgraphProvider = V2URISubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXJpLXN1YmdyYXBoLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy92Mi91cmktc3ViZ3JhcGgtcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsb0VBQStEO0FBSS9ELE1BQWEscUJBQ1gsU0FBUSwyQ0FBbUM7Q0FDVjtBQUZuQyxzREFFbUMifQ==

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

package/build/main/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/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("@ring-protocol/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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvdjMvY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSwwREFBcUQ7QUFDckQsNEVBQXVFO0FBSXZFOzs7OztHQUtHO0FBQ0gsTUFBYSx5QkFDWCxTQUFRLG1EQUF1QztJQUUvQzs7Ozs7T0FLRztJQUNILFlBQ0UsT0FBZ0IsRUFDaEIsZ0JBQXFDLEVBQ3JDLEtBQStCO1FBRS9CLEtBQUssQ0FBQyxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsS0FBSyxFQUFFLHFCQUFRLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztDQUNGO0FBaEJELDhEQWdCQyJ9

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 '@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/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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2FzLWRhdGEtcHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL3YzL2dhcy1kYXRhLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUlBLG1HQUFnRztBQUNoRyxxQ0FBaUQ7QUE0QmpELE1BQWEsdUJBQXVCO0lBS2xDLFlBQ1ksT0FBZ0IsRUFDaEIsUUFBc0IsRUFDaEMsY0FBdUI7UUFGYixZQUFPLEdBQVAsT0FBTyxDQUFTO1FBQ2hCLGFBQVEsR0FBUixRQUFRLENBQWM7UUFHaEMsSUFBSSxDQUFDLGNBQWMsR0FBRyxjQUFjLENBQUMsQ0FBQyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsMEJBQW1CLENBQUM7SUFDOUUsQ0FBQztJQUVNLEtBQUssQ0FBQyxVQUFVLENBQUMsY0FBK0I7UUFDckQsTUFBTSxlQUFlLEdBQUcsbURBQXdCLENBQUMsT0FBTyxDQUN0RCxJQUFJLENBQUMsY0FBYyxFQUNuQixJQUFJLENBQUMsUUFBUSxDQUNkLENBQUM7UUFDRixNQUFNLE9BQU8sR0FBRyxNQUFNLGVBQWUsQ0FBQyxjQUFjLENBQUM7WUFDbkQsUUFBUSxFQUFFLGNBQWMsYUFBZCxjQUFjLHVCQUFkLGNBQWMsQ0FBRSxXQUFXO1NBQ3RDLENBQUMsQ0FBQztRQUNILE1BQU0saUJBQWlCLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3JDLE9BQU87WUFDTCxVQUFVLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztZQUN0QixnQkFBZ0IsRUFBRSxpQkFBaUIsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzNDLGNBQWMsRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDO1NBQzNCLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUE1QkQsMERBNEJDIn0=