@ring-protocol/smart-order-router 0.5.0

package/build/main/providers/caching/route/model/cached-routes.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachedRoutes = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const cached_route_1 = require("./cached-route");
+/**
+ * Class defining the route to cache
+ *
+ * @export
+ * @class CachedRoute
+ */
+class CachedRoutes {
+    /**
+     * @param routes
+     * @param chainId
+     * @param currencyIn
+     * @param currencyOut
+     * @param protocolsCovered
+     * @param blockNumber
+     * @param tradeType
+     * @param originalAmount
+     * @param blocksToLive
+     */
+    constructor({ routes, chainId, currencyIn, currencyOut, protocolsCovered, blockNumber, tradeType, originalAmount, blocksToLive = 0, }) {
+        this.routes = routes;
+        this.chainId = chainId;
+        this.currencyIn = currencyIn;
+        this.currencyOut = currencyOut;
+        this.protocolsCovered = protocolsCovered;
+        this.blockNumber = blockNumber;
+        this.tradeType = tradeType;
+        this.originalAmount = originalAmount;
+        this.blocksToLive = blocksToLive;
+    }
+    /**
+     * Factory method that creates a `CachedRoutes` object from an array of RouteWithValidQuote.
+     *
+     * @public
+     * @static
+     * @param routes
+     * @param chainId
+     * @param currencyIn
+     * @param currencyOut
+     * @param protocolsCovered
+     * @param blockNumber
+     * @param tradeType
+     * @param originalAmount
+     */
+    static fromRoutesWithValidQuotes(routes, chainId, currencyIn, currencyOut, protocolsCovered, blockNumber, tradeType, originalAmount) {
+        if (routes.length == 0)
+            return undefined;
+        const cachedRoutes = lodash_1.default.map(routes, (route) => new cached_route_1.CachedRoute({ route: route.route, percent: route.percent }));
+        return new CachedRoutes({
+            routes: cachedRoutes,
+            chainId,
+            currencyIn,
+            currencyOut,
+            protocolsCovered,
+            blockNumber,
+            tradeType,
+            originalAmount,
+        });
+    }
+    /**
+     * Function to determine if, given a block number, the CachedRoute is expired or not.
+     *
+     * @param currentBlockNumber
+     * @param optimistic
+     */
+    notExpired(currentBlockNumber, optimistic = false) {
+        // When it's not optimistic, we only allow the route of the existing block.
+        const blocksToLive = optimistic ? this.blocksToLive : 0;
+        const blocksDifference = currentBlockNumber - this.blockNumber;
+        return blocksDifference <= blocksToLive;
+    }
+}
+exports.CachedRoutes = CachedRoutes;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGVkLXJvdXRlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvY2FjaGluZy9yb3V0ZS9tb2RlbC9jYWNoZWQtcm91dGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUVBLG9EQUF1QjtBQUl2QixpREFBNkM7QUFjN0M7Ozs7O0dBS0c7QUFDSCxNQUFhLFlBQVk7SUFZdkI7Ozs7Ozs7Ozs7T0FVRztJQUNILFlBQVksRUFDVixNQUFNLEVBQ04sT0FBTyxFQUNQLFVBQVUsRUFDVixXQUFXLEVBQ1gsZ0JBQWdCLEVBQ2hCLFdBQVcsRUFDWCxTQUFTLEVBQ1QsY0FBYyxFQUNkLFlBQVksR0FBRyxDQUFDLEdBQ0c7UUFDbkIsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7UUFDckIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7UUFDdkIsSUFBSSxDQUFDLFVBQVUsR0FBRyxVQUFVLENBQUM7UUFDN0IsSUFBSSxDQUFDLFdBQVcsR0FBRyxXQUFXLENBQUM7UUFDL0IsSUFBSSxDQUFDLGdCQUFnQixHQUFHLGdCQUFnQixDQUFDO1FBQ3pDLElBQUksQ0FBQyxXQUFXLEdBQUcsV0FBVyxDQUFDO1FBQy9CLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxjQUFjLEdBQUcsY0FBYyxDQUFDO1FBQ3JDLElBQUksQ0FBQyxZQUFZLEdBQUcsWUFBWSxDQUFDO0lBQ25DLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0ksTUFBTSxDQUFDLHlCQUF5QixDQUNyQyxNQUE2QixFQUM3QixPQUFnQixFQUNoQixVQUFvQixFQUNwQixXQUFxQixFQUNyQixnQkFBNEIsRUFDNUIsV0FBbUIsRUFDbkIsU0FBb0IsRUFDcEIsY0FBc0I7UUFFdEIsSUFBSSxNQUFNLENBQUMsTUFBTSxJQUFJLENBQUM7WUFBRSxPQUFPLFNBQVMsQ0FBQztRQUV6QyxNQUFNLFlBQVksR0FBRyxnQkFBQyxDQUFDLEdBQUcsQ0FDeEIsTUFBTSxFQUNOLENBQUMsS0FBMEIsRUFBRSxFQUFFLENBQzdCLElBQUksMEJBQVcsQ0FBQyxFQUFFLEtBQUssRUFBRSxLQUFLLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxLQUFLLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FDbEUsQ0FBQztRQUVGLE9BQU8sSUFBSSxZQUFZLENBQUM7WUFDdEIsTUFBTSxFQUFFLFlBQVk7WUFDcEIsT0FBTztZQUNQLFVBQVU7WUFDVixXQUFXO1lBQ1gsZ0JBQWdCO1lBQ2hCLFdBQVc7WUFDWCxTQUFTO1lBQ1QsY0FBYztTQUNmLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLFVBQVUsQ0FBQyxrQkFBMEIsRUFBRSxVQUFVLEdBQUcsS0FBSztRQUM5RCwyRUFBMkU7UUFDM0UsTUFBTSxZQUFZLEdBQUcsVUFBVSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDeEQsTUFBTSxnQkFBZ0IsR0FBRyxrQkFBa0IsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDO1FBRS9ELE9BQU8sZ0JBQWdCLElBQUksWUFBWSxDQUFDO0lBQzFDLENBQUM7Q0FDRjtBQXRHRCxvQ0FzR0MifQ==

package/build/main/providers/caching/route/model/index.d.ts

@@ -0,0 +1,3 @@
+export * from './cache-mode';
+export * from './cached-route';
+export * from './cached-routes';

package/build/main/providers/caching/route/model/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cache-mode"), exports);
+__exportStar(require("./cached-route"), exports);
+__exportStar(require("./cached-routes"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9zcmMvcHJvdmlkZXJzL2NhY2hpbmcvcm91dGUvbW9kZWwvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLCtDQUE2QjtBQUM3QixpREFBK0I7QUFDL0Isa0RBQWdDIn0=

package/build/main/providers/caching/route/route-caching-provider.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Provider for getting currency data from a currency List.
+ *
+ * @export
+ * @interface IRouteCachingProvider
+ */
+import { Protocol } from '@ring-protocol/router-sdk';
+import { ChainId, Currency, CurrencyAmount, TradeType } from '@ring-protocol/sdk-core';
+import { AlphaRouterConfig } from '../../../routers';
+import { SwapOptions } from '../../../routers/router';
+import { CacheMode } from './model';
+import { CachedRoutes } from './model/cached-routes';
+/**
+ * Abstract class for a RouteCachingProvider.
+ * Defines the base methods of how to interact with this interface, but not the implementation of how to cache.
+ */
+export declare abstract class IRouteCachingProvider {
+    /**
+     * Final implementation of the public `getCachedRoute` method, this is how code will interact with the implementation
+     *
+     * @public
+     * @readonly
+     * @param chainId
+     * @param amount
+     * @param quoteCurrency
+     * @param tradeType
+     * @param protocols
+     * @param blockNumber
+     * @param optimistic
+     * @param alphaRouterConfig
+     * @param swapOptions
+     */
+    readonly getCachedRoute: (chainId: number, amount: CurrencyAmount<Currency>, quoteCurrency: Currency, tradeType: TradeType, protocols: Protocol[], blockNumber: number, optimistic?: boolean, alphaRouterConfig?: AlphaRouterConfig, swapOptions?: SwapOptions) => Promise<CachedRoutes | undefined>;
+    /**
+     * Final implementation of the public `setCachedRoute` method.
+     * This method will set the blockToLive in the CachedRoutes object before calling the internal method to insert in cache.
+     *
+     * @public
+     * @readonly
+     * @param cachedRoutes The route to cache.
+     * @returns Promise<boolean> Indicates if the route was inserted into cache.
+     */
+    readonly setCachedRoute: (cachedRoutes: CachedRoutes, amount: CurrencyAmount<Currency>) => Promise<boolean>;
+    /**
+     * Final implementation of the public `deleteCachedRoute` method.
+     * This method will delete the cached route from the cache.
+     *
+     * @public
+     * @readonly
+     * @param cachedRoutes the cached routes to delete
+     */
+    readonly deleteCachedRoute: (cachedRoutes: CachedRoutes) => Promise<boolean>;
+    /**
+     * Returns the CacheMode for the given cachedRoutes and amount
+     *
+     * @param cachedRoutes
+     * @param amount
+     */
+    getCacheModeFromCachedRoutes(cachedRoutes: CachedRoutes, amount: CurrencyAmount<Currency>): Promise<CacheMode>;
+    /**
+     * Returns the CacheMode for the given combination of chainId, currencyIn, currencyOut and tradetype
+     *
+     * @public
+     * @abstract
+     * @param chainId
+     * @param amount
+     * @param tradeType
+     */
+    abstract getCacheMode(chainId: ChainId, amount: CurrencyAmount<Currency>, quoteCurrency: Currency, tradeType: TradeType, protocols: Protocol[]): Promise<CacheMode>;
+    protected filterExpiredCachedRoutes(cachedRoutes: CachedRoutes | undefined, blockNumber: number, optimistic: boolean): CachedRoutes | undefined;
+    /**
+     * Internal function to fetch the CachedRoute from the cache.
+     * Must be implemented.
+     *
+     * @param chainId
+     * @param amount
+     * @param quoteCurrency
+     * @param tradeType
+     * @param protocols
+     * @param currentBlockNumber
+     * @param optimistic
+     * @param alphaRouterConfig
+     * @param swapOptions
+     * @protected
+     */
+    protected abstract _getCachedRoute(chainId: ChainId, amount: CurrencyAmount<Currency>, quoteCurrency: Currency, tradeType: TradeType, protocols: Protocol[], currentBlockNumber: number, optimistic: boolean, alphaRouterConfig?: AlphaRouterConfig, swapOptions?: SwapOptions): Promise<CachedRoutes | undefined>;
+    /**
+     * Internal function to insert the CachedRoute into cache.
+     * Must be implemented.
+     *
+     * @param cachedRoutes
+     * @param amount
+     * @protected
+     */
+    protected abstract _setCachedRoute(cachedRoutes: CachedRoutes, amount: CurrencyAmount<Currency>): Promise<boolean>;
+    /**
+     * Internal function to getBlocksToLive for a given cachedRoute.
+     * This function is called before attempting to insert the route into cache.
+     * Must be implemented.
+     *
+     * @param cachedRoutes
+     * @param amount
+     * @protected
+     */
+    protected abstract _getBlocksToLive(cachedRoutes: CachedRoutes, amount: CurrencyAmount<Currency>): Promise<number>;
+    /**
+     * Removes or invalidates a cached route from the cache.
+     * Must be implemented by subclasses.
+     */
+    protected abstract _deleteCachedRoute(cachedRoutes: CachedRoutes): Promise<boolean>;
+}

package/build/main/providers/caching/route/route-caching-provider.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IRouteCachingProvider = void 0;
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const model_1 = require("./model");
+/**
+ * Abstract class for a RouteCachingProvider.
+ * Defines the base methods of how to interact with this interface, but not the implementation of how to cache.
+ */
+class IRouteCachingProvider {
+    constructor() {
+        /**
+         * Final implementation of the public `getCachedRoute` method, this is how code will interact with the implementation
+         *
+         * @public
+         * @readonly
+         * @param chainId
+         * @param amount
+         * @param quoteCurrency
+         * @param tradeType
+         * @param protocols
+         * @param blockNumber
+         * @param optimistic
+         * @param alphaRouterConfig
+         * @param swapOptions
+         */
+        this.getCachedRoute = async (
+        // Defined as a readonly member instead of a regular function to make it final.
+        chainId, amount, quoteCurrency, tradeType, protocols, blockNumber, optimistic = false, alphaRouterConfig, swapOptions) => {
+            if ((await this.getCacheMode(chainId, amount, quoteCurrency, tradeType, protocols)) == model_1.CacheMode.Darkmode) {
+                return undefined;
+            }
+            const cachedRoute = await this._getCachedRoute(chainId, amount, quoteCurrency, tradeType, protocols, blockNumber, optimistic, alphaRouterConfig, swapOptions);
+            return this.filterExpiredCachedRoutes(cachedRoute, blockNumber, optimistic);
+        };
+        /**
+         * Final implementation of the public `setCachedRoute` method.
+         * This method will set the blockToLive in the CachedRoutes object before calling the internal method to insert in cache.
+         *
+         * @public
+         * @readonly
+         * @param cachedRoutes The route to cache.
+         * @returns Promise<boolean> Indicates if the route was inserted into cache.
+         */
+        this.setCachedRoute = async (
+        // Defined as a readonly member instead of a regular function to make it final.
+        cachedRoutes, amount) => {
+            if ((await this.getCacheModeFromCachedRoutes(cachedRoutes, amount)) ==
+                model_1.CacheMode.Darkmode) {
+                return false;
+            }
+            cachedRoutes.blocksToLive = await this._getBlocksToLive(cachedRoutes, amount);
+            return this._setCachedRoute(cachedRoutes, amount);
+        };
+        /**
+         * Final implementation of the public `deleteCachedRoute` method.
+         * This method will delete the cached route from the cache.
+         *
+         * @public
+         * @readonly
+         * @param cachedRoutes the cached routes to delete
+         */
+        this.deleteCachedRoute = async (cachedRoutes) => {
+            return this._deleteCachedRoute(cachedRoutes);
+        };
+    }
+    /**
+     * Returns the CacheMode for the given cachedRoutes and amount
+     *
+     * @param cachedRoutes
+     * @param amount
+     */
+    getCacheModeFromCachedRoutes(cachedRoutes, amount) {
+        const quoteCurrency = cachedRoutes.tradeType == sdk_core_1.TradeType.EXACT_INPUT
+            ? cachedRoutes.currencyOut
+            : cachedRoutes.currencyIn;
+        return this.getCacheMode(cachedRoutes.chainId, amount, quoteCurrency, cachedRoutes.tradeType, cachedRoutes.protocolsCovered);
+    }
+    filterExpiredCachedRoutes(cachedRoutes, blockNumber, optimistic) {
+        return (cachedRoutes === null || cachedRoutes === void 0 ? void 0 : cachedRoutes.notExpired(blockNumber, optimistic))
+            ? cachedRoutes
+            : undefined;
+    }
+}
+exports.IRouteCachingProvider = IRouteCachingProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGUtY2FjaGluZy1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9wcm92aWRlcnMvY2FjaGluZy9yb3V0ZS9yb3V0ZS1jYWNoaW5nLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQU9BLHNEQUtpQztBQUlqQyxtQ0FBb0M7QUFHcEM7OztHQUdHO0FBQ0gsTUFBc0IscUJBQXFCO0lBQTNDO1FBQ0U7Ozs7Ozs7Ozs7Ozs7O1dBY0c7UUFDYSxtQkFBYyxHQUFHLEtBQUs7UUFDcEMsK0VBQStFO1FBQy9FLE9BQWUsRUFDZixNQUFnQyxFQUNoQyxhQUF1QixFQUN2QixTQUFvQixFQUNwQixTQUFxQixFQUNyQixXQUFtQixFQUNuQixVQUFVLEdBQUcsS0FBSyxFQUNsQixpQkFBcUMsRUFDckMsV0FBeUIsRUFDVSxFQUFFO1lBQ3JDLElBQ0UsQ0FBQyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQ3RCLE9BQU8sRUFDUCxNQUFNLEVBQ04sYUFBYSxFQUNiLFNBQVMsRUFDVCxTQUFTLENBQ1YsQ0FBQyxJQUFJLGlCQUFTLENBQUMsUUFBUSxFQUN4QjtnQkFDQSxPQUFPLFNBQVMsQ0FBQzthQUNsQjtZQUVELE1BQU0sV0FBVyxHQUFHLE1BQU0sSUFBSSxDQUFDLGVBQWUsQ0FDNUMsT0FBTyxFQUNQLE1BQU0sRUFDTixhQUFhLEVBQ2IsU0FBUyxFQUNULFNBQVMsRUFDVCxXQUFXLEVBQ1gsVUFBVSxFQUNWLGlCQUFpQixFQUNqQixXQUFXLENBQ1osQ0FBQztZQUVGLE9BQU8sSUFBSSxDQUFDLHlCQUF5QixDQUFDLFdBQVcsRUFBRSxXQUFXLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDOUUsQ0FBQyxDQUFDO1FBRUY7Ozs7Ozs7O1dBUUc7UUFDYSxtQkFBYyxHQUFHLEtBQUs7UUFDcEMsK0VBQStFO1FBQy9FLFlBQTBCLEVBQzFCLE1BQWdDLEVBQ2QsRUFBRTtZQUNwQixJQUNFLENBQUMsTUFBTSxJQUFJLENBQUMsNEJBQTRCLENBQUMsWUFBWSxFQUFFLE1BQU0sQ0FBQyxDQUFDO2dCQUMvRCxpQkFBUyxDQUFDLFFBQVEsRUFDbEI7Z0JBQ0EsT0FBTyxLQUFLLENBQUM7YUFDZDtZQUVELFlBQVksQ0FBQyxZQUFZLEdBQUcsTUFBTSxJQUFJLENBQUMsZ0JBQWdCLENBQ3JELFlBQVksRUFDWixNQUFNLENBQ1AsQ0FBQztZQUVGLE9BQU8sSUFBSSxDQUFDLGVBQWUsQ0FBQyxZQUFZLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDcEQsQ0FBQyxDQUFDO1FBRUY7Ozs7Ozs7V0FPRztRQUNhLHNCQUFpQixHQUFHLEtBQUssRUFDdkMsWUFBMEIsRUFDUixFQUFFO1lBQ3BCLE9BQU8sSUFBSSxDQUFDLGtCQUFrQixDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQy9DLENBQUMsQ0FBQztJQWtISixDQUFDO0lBaEhDOzs7OztPQUtHO0lBQ0ksNEJBQTRCLENBQ2pDLFlBQTBCLEVBQzFCLE1BQWdDO1FBRWhDLE1BQU0sYUFBYSxHQUNqQixZQUFZLENBQUMsU0FBUyxJQUFJLG9CQUFTLENBQUMsV0FBVztZQUM3QyxDQUFDLENBQUMsWUFBWSxDQUFDLFdBQVc7WUFDMUIsQ0FBQyxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUM7UUFFOUIsT0FBTyxJQUFJLENBQUMsWUFBWSxDQUN0QixZQUFZLENBQUMsT0FBTyxFQUNwQixNQUFNLEVBQ04sYUFBYSxFQUNiLFlBQVksQ0FBQyxTQUFTLEVBQ3RCLFlBQVksQ0FBQyxnQkFBZ0IsQ0FDOUIsQ0FBQztJQUNKLENBQUM7SUFtQlMseUJBQXlCLENBQ2pDLFlBQXNDLEVBQ3RDLFdBQW1CLEVBQ25CLFVBQW1CO1FBRW5CLE9BQU8sQ0FBQSxZQUFZLGFBQVosWUFBWSx1QkFBWixZQUFZLENBQUUsVUFBVSxDQUFDLFdBQVcsRUFBRSxVQUFVLENBQUM7WUFDdEQsQ0FBQyxDQUFDLFlBQVk7WUFDZCxDQUFDLENBQUMsU0FBUyxDQUFDO0lBQ2hCLENBQUM7Q0ErREY7QUFsTkQsc0RBa05DIn0=

package/build/main/providers/caching-gas-provider.d.ts

@@ -0,0 +1,23 @@
+import { ChainId } from '@ring-protocol/sdk-core';
+import { ICache } from './cache';
+import { GasPrice, IGasPriceProvider } from './gas-price-provider';
+/**
+ * Provider for getting gas price, with functionality for caching the results.
+ *
+ * @export
+ * @class CachingV3SubgraphProvider
+ */
+export declare class CachingGasStationProvider extends IGasPriceProvider {
+    protected chainId: ChainId;
+    private gasPriceProvider;
+    private cache;
+    private GAS_KEY;
+    /**
+     * Creates an instance of CachingGasStationProvider.
+     * @param chainId The chain id to use.
+     * @param gasPriceProvider The provider to use to get the gas price when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId: ChainId, gasPriceProvider: IGasPriceProvider, cache: ICache<GasPrice>);
+    getGasPrice(latestBlockNumber: number, requestBlockNumber?: number): Promise<GasPrice>;
+}

package/build/main/providers/caching-gas-provider.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachingGasStationProvider = void 0;
+const log_1 = require("../util/log");
+const gas_price_provider_1 = require("./gas-price-provider");
+/**
+ * Provider for getting gas price, with functionality for caching the results.
+ *
+ * @export
+ * @class CachingV3SubgraphProvider
+ */
+class CachingGasStationProvider extends gas_price_provider_1.IGasPriceProvider {
+    /**
+     * Creates an instance of CachingGasStationProvider.
+     * @param chainId The chain id to use.
+     * @param gasPriceProvider The provider to use to get the gas price when not in the cache.
+     * @param cache Cache instance to hold cached pools.
+     */
+    constructor(chainId, gasPriceProvider, cache) {
+        super();
+        this.chainId = chainId;
+        this.gasPriceProvider = gasPriceProvider;
+        this.cache = cache;
+        this.GAS_KEY = (chainId, blockNumber) => `gasPrice-${chainId}-${blockNumber}`;
+    }
+    async getGasPrice(latestBlockNumber, requestBlockNumber) {
+        // If block number is specified in the request, we have to use that block number find any potential cache hits.
+        // Otherwise, we can use the latest block number.
+        const targetBlockNumber = requestBlockNumber !== null && requestBlockNumber !== void 0 ? requestBlockNumber : latestBlockNumber;
+        const cachedGasPrice = await this.cache.get(this.GAS_KEY(this.chainId, targetBlockNumber));
+        if (cachedGasPrice) {
+            log_1.log.info({ cachedGasPrice }, `Got gas station price from local cache: ${cachedGasPrice.gasPriceWei}.`);
+            return cachedGasPrice;
+        }
+        const gasPrice = await this.gasPriceProvider.getGasPrice(latestBlockNumber, requestBlockNumber);
+        await this.cache.set(this.GAS_KEY(this.chainId, targetBlockNumber), gasPrice);
+        return gasPrice;
+    }
+}
+exports.CachingGasStationProvider = CachingGasStationProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1nYXMtcHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcHJvdmlkZXJzL2NhY2hpbmctZ2FzLXByb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBLHFDQUFrQztBQUdsQyw2REFBbUU7QUFFbkU7Ozs7O0dBS0c7QUFDSCxNQUFhLHlCQUEwQixTQUFRLHNDQUFpQjtJQUk5RDs7Ozs7T0FLRztJQUNILFlBQ1ksT0FBZ0IsRUFDbEIsZ0JBQW1DLEVBQ25DLEtBQXVCO1FBRS9CLEtBQUssRUFBRSxDQUFDO1FBSkUsWUFBTyxHQUFQLE9BQU8sQ0FBUztRQUNsQixxQkFBZ0IsR0FBaEIsZ0JBQWdCLENBQW1CO1FBQ25DLFVBQUssR0FBTCxLQUFLLENBQWtCO1FBWnpCLFlBQU8sR0FBRyxDQUFDLE9BQWdCLEVBQUUsV0FBbUIsRUFBRSxFQUFFLENBQzFELFlBQVksT0FBTyxJQUFJLFdBQVcsRUFBRSxDQUFDO0lBY3ZDLENBQUM7SUFFZSxLQUFLLENBQUMsV0FBVyxDQUMvQixpQkFBeUIsRUFDekIsa0JBQTJCO1FBRTNCLCtHQUErRztRQUMvRyxpREFBaUQ7UUFDakQsTUFBTSxpQkFBaUIsR0FBRyxrQkFBa0IsYUFBbEIsa0JBQWtCLGNBQWxCLGtCQUFrQixHQUFJLGlCQUFpQixDQUFDO1FBQ2xFLE1BQU0sY0FBYyxHQUFHLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQ3pDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxpQkFBaUIsQ0FBQyxDQUM5QyxDQUFDO1FBRUYsSUFBSSxjQUFjLEVBQUU7WUFDbEIsU0FBRyxDQUFDLElBQUksQ0FDTixFQUFFLGNBQWMsRUFBRSxFQUNsQiwyQ0FBMkMsY0FBYyxDQUFDLFdBQVcsR0FBRyxDQUN6RSxDQUFDO1lBRUYsT0FBTyxjQUFjLENBQUM7U0FDdkI7UUFFRCxNQUFNLFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxXQUFXLENBQ3RELGlCQUFpQixFQUNqQixrQkFBa0IsQ0FDbkIsQ0FBQztRQUNGLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQ2xCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxpQkFBaUIsQ0FBQyxFQUM3QyxRQUFRLENBQ1QsQ0FBQztRQUVGLE9BQU8sUUFBUSxDQUFDO0lBQ2xCLENBQUM7Q0FDRjtBQWpERCw4REFpREMifQ==

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

@@ -0,0 +1,33 @@
+import { Protocol } from '@ring-protocol/router-sdk';
+import { ChainId, Currency, Token } from '@ring-protocol/sdk-core';
+import { SubgraphPool } from '../routers/alpha-router/functions/get-candidate-pools';
+import { ICache } from './cache';
+import { ProviderConfig } from './provider';
+import { V3SubgraphPool } from './v3/subgraph-provider';
+declare type ChainTokenList = {
+    readonly [chainId in ChainId]: Currency[];
+};
+export declare const BASES_TO_CHECK_TRADES_AGAINST: ChainTokenList;
+export interface IV3SubgraphProvider {
+    getPools(tokenIn?: Token, tokenOut?: Token, providerConfig?: ProviderConfig): Promise<V3SubgraphPool[]>;
+}
+export interface ISubgraphProvider<TSubgraphPool extends SubgraphPool> {
+    getPools(tokenIn?: Token, tokenOut?: Token, providerConfig?: ProviderConfig): Promise<TSubgraphPool[]>;
+}
+export declare abstract class CachingSubgraphProvider<TSubgraphPool extends SubgraphPool> implements ISubgraphProvider<TSubgraphPool> {
+    private chainId;
+    protected subgraphProvider: ISubgraphProvider<TSubgraphPool>;
+    private cache;
+    private protocol;
+    private SUBGRAPH_KEY;
+    /**
+     * 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.
+     * @param protocol Subgraph protocol version
+     */
+    constructor(chainId: ChainId, subgraphProvider: ISubgraphProvider<TSubgraphPool>, cache: ICache<TSubgraphPool[]>, protocol: Protocol);
+    getPools(): Promise<TSubgraphPool[]>;
+}
+export {};

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

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachingSubgraphProvider = exports.BASES_TO_CHECK_TRADES_AGAINST = void 0;
+const sdk_core_1 = require("@ring-protocol/sdk-core");
+const util_1 = require("../util");
+const token_provider_1 = require("./token-provider");
+exports.BASES_TO_CHECK_TRADES_AGAINST = {
+    [sdk_core_1.ChainId.HYPER_MAINNET]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.HYPER_MAINNET),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.HYPER_MAINNET],
+        token_provider_1.USDT_HYPER_MAINNET,
+    ],
+    [sdk_core_1.ChainId.MAINNET]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.MAINNET),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.MAINNET],
+        token_provider_1.DAI_MAINNET,
+        token_provider_1.USDC_MAINNET,
+        token_provider_1.USDT_MAINNET,
+        token_provider_1.WBTC_MAINNET,
+        token_provider_1.WSTETH_MAINNET,
+    ],
+    [sdk_core_1.ChainId.GOERLI]: [util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.GOERLI]],
+    [sdk_core_1.ChainId.SEPOLIA]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.SEPOLIA),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.SEPOLIA],
+        token_provider_1.USDC_SEPOLIA,
+    ],
+    //v2 not deployed on [arbitrum, polygon, celo, gnosis, moonbeam, bnb, avalanche] and their testnets
+    [sdk_core_1.ChainId.OPTIMISM]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.OPTIMISM),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.OPTIMISM],
+        token_provider_1.USDC_OPTIMISM,
+        token_provider_1.DAI_OPTIMISM,
+        token_provider_1.USDT_OPTIMISM,
+        token_provider_1.WBTC_OPTIMISM,
+        token_provider_1.OP_OPTIMISM,
+    ],
+    [sdk_core_1.ChainId.ARBITRUM_ONE]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.ARBITRUM_ONE),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.ARBITRUM_ONE],
+        token_provider_1.WBTC_ARBITRUM,
+        token_provider_1.DAI_ARBITRUM,
+        token_provider_1.USDC_ARBITRUM,
+        token_provider_1.USDC_NATIVE_ARBITRUM,
+        token_provider_1.USDT_ARBITRUM,
+        token_provider_1.ARB_ARBITRUM,
+    ],
+    [sdk_core_1.ChainId.ARBITRUM_GOERLI]: [],
+    [sdk_core_1.ChainId.ARBITRUM_SEPOLIA]: [],
+    [sdk_core_1.ChainId.OPTIMISM_GOERLI]: [],
+    [sdk_core_1.ChainId.OPTIMISM_SEPOLIA]: [],
+    [sdk_core_1.ChainId.POLYGON]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.POLYGON),
+        token_provider_1.USDC_POLYGON,
+        token_provider_1.WETH_POLYGON,
+        token_provider_1.WMATIC_POLYGON,
+    ],
+    [sdk_core_1.ChainId.POLYGON_MUMBAI]: [],
+    [sdk_core_1.ChainId.CELO]: [token_provider_1.CELO, token_provider_1.CUSD_CELO, token_provider_1.CEUR_CELO, token_provider_1.DAI_CELO],
+    [sdk_core_1.ChainId.CELO_ALFAJORES]: [],
+    [sdk_core_1.ChainId.GNOSIS]: [],
+    [sdk_core_1.ChainId.MOONBEAM]: [
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.MOONBEAM],
+        token_provider_1.DAI_MOONBEAM,
+        token_provider_1.USDC_MOONBEAM,
+        token_provider_1.WBTC_MOONBEAM,
+    ],
+    [sdk_core_1.ChainId.BNB]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.BNB),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.BNB],
+        token_provider_1.BUSD_BNB,
+        token_provider_1.DAI_BNB,
+        token_provider_1.USDC_BNB,
+        token_provider_1.USDT_BNB,
+        token_provider_1.BTC_BNB,
+        token_provider_1.ETH_BNB,
+    ],
+    [sdk_core_1.ChainId.AVALANCHE]: [
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.AVALANCHE],
+        token_provider_1.USDC_AVAX,
+        token_provider_1.DAI_AVAX,
+    ],
+    [sdk_core_1.ChainId.BASE_GOERLI]: [],
+    [sdk_core_1.ChainId.BASE]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.BASE),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.BASE],
+        token_provider_1.USDC_BASE,
+    ],
+    [sdk_core_1.ChainId.ZORA]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.ZORA),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.ZORA],
+    ],
+    [sdk_core_1.ChainId.ZORA_SEPOLIA]: [util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.ZORA_SEPOLIA]],
+    [sdk_core_1.ChainId.ROOTSTOCK]: [util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.ROOTSTOCK]],
+    [sdk_core_1.ChainId.BLAST]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.BLAST),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.BLAST],
+        token_provider_1.USDB_BLAST,
+    ],
+    [sdk_core_1.ChainId.ZKSYNC]: [
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.ZKSYNC],
+        token_provider_1.USDCE_ZKSYNC,
+        token_provider_1.USDC_ZKSYNC,
+    ],
+    [sdk_core_1.ChainId.WORLDCHAIN]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.WORLDCHAIN),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.WORLDCHAIN],
+        token_provider_1.USDC_WORLDCHAIN,
+        token_provider_1.WLD_WORLDCHAIN,
+        token_provider_1.WBTC_WORLDCHAIN,
+    ],
+    [sdk_core_1.ChainId.UNICHAIN_SEPOLIA]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.UNICHAIN_SEPOLIA),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.UNICHAIN_SEPOLIA],
+        token_provider_1.USDC_UNICHAIN_SEPOLIA,
+    ],
+    [sdk_core_1.ChainId.UNICHAIN]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.UNICHAIN),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.UNICHAIN],
+        token_provider_1.DAI_UNICHAIN,
+        token_provider_1.USDC_UNICHAIN,
+    ],
+    [sdk_core_1.ChainId.BASE_SEPOLIA]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.BASE_SEPOLIA),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.BASE_SEPOLIA],
+        token_provider_1.USDC_BASE_SEPOLIA,
+    ],
+    [sdk_core_1.ChainId.MONAD_TESTNET]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.MONAD_TESTNET),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.MONAD_TESTNET],
+        token_provider_1.USDT_MONAD_TESTNET,
+    ],
+    [sdk_core_1.ChainId.SONEIUM]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.SONEIUM),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.SONEIUM],
+        token_provider_1.USDC_SONEIUM,
+    ],
+    [sdk_core_1.ChainId.MONAD]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.MONAD),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.MONAD],
+        token_provider_1.USDC_MONAD,
+    ],
+    // networks exclusive to ring swap
+    [sdk_core_1.ChainId.BLAST_SEPOLIA]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.BLAST_SEPOLIA),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.BLAST_SEPOLIA],
+        token_provider_1.USDB_BLAST_SEPOLIA,
+    ],
+    [sdk_core_1.ChainId.STORY_ODYSSEY]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.STORY_ODYSSEY),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.STORY_ODYSSEY],
+        token_provider_1.SUSD_STORY_ODYSSEY,
+    ],
+    [sdk_core_1.ChainId.STORY_MAINNET]: [
+        (0, util_1.nativeOnChain)(sdk_core_1.ChainId.STORY_MAINNET),
+        util_1.WRAPPED_NATIVE_CURRENCY[sdk_core_1.ChainId.STORY_MAINNET],
+        token_provider_1.USDC_STORY_MAINNET,
+    ],
+};
+class 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.
+     * @param protocol Subgraph protocol version
+     */
+    constructor(chainId, subgraphProvider, cache, protocol) {
+        this.chainId = chainId;
+        this.subgraphProvider = subgraphProvider;
+        this.cache = cache;
+        this.protocol = protocol;
+        this.SUBGRAPH_KEY = (chainId) => `subgraph-pools-${this.protocol}-${chainId}`;
+    }
+    async getPools() {
+        const cachedPools = await this.cache.get(this.SUBGRAPH_KEY(this.chainId));
+        if (cachedPools) {
+            return cachedPools;
+        }
+        const pools = await this.subgraphProvider.getPools();
+        await this.cache.set(this.SUBGRAPH_KEY(this.chainId), pools);
+        return pools;
+    }
+}
+exports.CachingSubgraphProvider = CachingSubgraphProvider;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wcm92aWRlcnMvY2FjaGluZy1zdWJncmFwaC1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxzREFBbUU7QUFHbkUsa0NBQWlFO0FBSWpFLHFEQXNEMEI7QUFPYixRQUFBLDZCQUE2QixHQUFtQjtJQUMzRCxDQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFDLEVBQUU7UUFDdkIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFDO1FBQ3BDLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFFO1FBQy9DLG1DQUFrQjtLQUNuQjtJQUNELENBQUMsa0JBQU8sQ0FBQyxPQUFPLENBQUMsRUFBRTtRQUNqQixJQUFBLG9CQUFhLEVBQUMsa0JBQU8sQ0FBQyxPQUFPLENBQUM7UUFDOUIsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxPQUFPLENBQUU7UUFDekMsNEJBQVc7UUFDWCw2QkFBWTtRQUNaLDZCQUFZO1FBQ1osNkJBQVk7UUFDWiwrQkFBYztLQUNmO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxNQUFNLENBQUUsQ0FBQztJQUM1RCxDQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDakIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFDO1FBQzlCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFFO1FBQ3pDLDZCQUFZO0tBQ2I7SUFDRCxtR0FBbUc7SUFDbkcsQ0FBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1FBQ2xCLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBQztRQUMvQiw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBRTtRQUMxQyw4QkFBYTtRQUNiLDZCQUFZO1FBQ1osOEJBQWE7UUFDYiw4QkFBYTtRQUNiLDRCQUFXO0tBQ1o7SUFDRCxDQUFDLGtCQUFPLENBQUMsWUFBWSxDQUFDLEVBQUU7UUFDdEIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsWUFBWSxDQUFDO1FBQ25DLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsWUFBWSxDQUFFO1FBQzlDLDhCQUFhO1FBQ2IsNkJBQVk7UUFDWiw4QkFBYTtRQUNiLHFDQUFvQjtRQUNwQiw4QkFBYTtRQUNiLDZCQUFZO0tBQ2I7SUFDRCxDQUFDLGtCQUFPLENBQUMsZUFBZSxDQUFDLEVBQUUsRUFBRTtJQUM3QixDQUFDLGtCQUFPLENBQUMsZ0JBQWdCLENBQUMsRUFBRSxFQUFFO0lBQzlCLENBQUMsa0JBQU8sQ0FBQyxlQUFlLENBQUMsRUFBRSxFQUFFO0lBQzdCLENBQUMsa0JBQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxFQUFFLEVBQUU7SUFDOUIsQ0FBQyxrQkFBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFO1FBQ2pCLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLE9BQU8sQ0FBQztRQUM5Qiw2QkFBWTtRQUNaLDZCQUFZO1FBQ1osK0JBQWM7S0FDZjtJQUNELENBQUMsa0JBQU8sQ0FBQyxjQUFjLENBQUMsRUFBRSxFQUFFO0lBQzVCLENBQUMsa0JBQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLHFCQUFJLEVBQUUsMEJBQVMsRUFBRSwwQkFBUyxFQUFFLHlCQUFRLENBQUM7SUFDdEQsQ0FBQyxrQkFBTyxDQUFDLGNBQWMsQ0FBQyxFQUFFLEVBQUU7SUFDNUIsQ0FBQyxrQkFBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLEVBQUU7SUFDcEIsQ0FBQyxrQkFBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1FBQ2xCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsUUFBUSxDQUFDO1FBQ3pDLDZCQUFZO1FBQ1osOEJBQWE7UUFDYiw4QkFBYTtLQUNkO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFO1FBQ2IsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsR0FBRyxDQUFDO1FBQzFCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsR0FBRyxDQUFDO1FBQ3BDLHlCQUFRO1FBQ1Isd0JBQU87UUFDUCx5QkFBUTtRQUNSLHlCQUFRO1FBQ1Isd0JBQU87UUFDUCx3QkFBTztLQUNSO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFO1FBQ25CLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsU0FBUyxDQUFDO1FBQzFDLDBCQUFTO1FBQ1QseUJBQVE7S0FDVDtJQUNELENBQUMsa0JBQU8sQ0FBQyxXQUFXLENBQUMsRUFBRSxFQUFFO0lBQ3pCLENBQUMsa0JBQU8sQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNkLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLElBQUksQ0FBQztRQUMzQiw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLElBQUksQ0FBQztRQUNyQywwQkFBUztLQUNWO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2QsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsSUFBSSxDQUFDO1FBQzNCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsSUFBSSxDQUFFO0tBQ3ZDO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLFlBQVksQ0FBQyxFQUFFLENBQUMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxZQUFZLENBQUUsQ0FBQztJQUN4RSxDQUFDLGtCQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLFNBQVMsQ0FBRSxDQUFDO0lBQ2xFLENBQUMsa0JBQU8sQ0FBQyxLQUFLLENBQUMsRUFBRTtRQUNmLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLEtBQUssQ0FBQztRQUM1Qiw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLEtBQUssQ0FBRTtRQUN2QywyQkFBVTtLQUNYO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFO1FBQ2hCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsTUFBTSxDQUFFO1FBQ3hDLDZCQUFZO1FBQ1osNEJBQVc7S0FDWjtJQUNELENBQUMsa0JBQU8sQ0FBQyxVQUFVLENBQUMsRUFBRTtRQUNwQixJQUFBLG9CQUFhLEVBQUMsa0JBQU8sQ0FBQyxVQUFVLENBQUM7UUFDakMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxVQUFVLENBQUU7UUFDNUMsZ0NBQWU7UUFDZiwrQkFBYztRQUNkLGdDQUFlO0tBQ2hCO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLGdCQUFnQixDQUFDLEVBQUU7UUFDMUIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsZ0JBQWdCLENBQUM7UUFDdkMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxnQkFBZ0IsQ0FBRTtRQUNsRCxzQ0FBcUI7S0FDdEI7SUFDRCxDQUFDLGtCQUFPLENBQUMsUUFBUSxDQUFDLEVBQUU7UUFDbEIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsUUFBUSxDQUFDO1FBQy9CLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsUUFBUSxDQUFFO1FBQzFDLDZCQUFZO1FBQ1osOEJBQWE7S0FDZDtJQUNELENBQUMsa0JBQU8sQ0FBQyxZQUFZLENBQUMsRUFBRTtRQUN0QixJQUFBLG9CQUFhLEVBQUMsa0JBQU8sQ0FBQyxZQUFZLENBQUM7UUFDbkMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxZQUFZLENBQUU7UUFDOUMsa0NBQWlCO0tBQ2xCO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFO1FBQ3ZCLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQztRQUNwQyw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBRTtRQUMvQyxtQ0FBa0I7S0FDbkI7SUFDRCxDQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDakIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFDO1FBQzlCLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsT0FBTyxDQUFFO1FBQ3pDLDZCQUFZO0tBQ2I7SUFDRCxDQUFDLGtCQUFPLENBQUMsS0FBSyxDQUFDLEVBQUU7UUFDZixJQUFBLG9CQUFhLEVBQUMsa0JBQU8sQ0FBQyxLQUFLLENBQUM7UUFDNUIsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxLQUFLLENBQUU7UUFDdkMsMkJBQVU7S0FDWDtJQUNELGtDQUFrQztJQUNsQyxDQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFDLEVBQUU7UUFDdkIsSUFBQSxvQkFBYSxFQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFDO1FBQ3BDLDhCQUF1QixDQUFDLGtCQUFPLENBQUMsYUFBYSxDQUFFO1FBQy9DLG1DQUFrQjtLQUNuQjtJQUNELENBQUMsa0JBQU8sQ0FBQyxhQUFhLENBQUMsRUFBRTtRQUN2QixJQUFBLG9CQUFhLEVBQUMsa0JBQU8sQ0FBQyxhQUFhLENBQUM7UUFDcEMsOEJBQXVCLENBQUMsa0JBQU8sQ0FBQyxhQUFhLENBQUU7UUFDL0MsbUNBQWtCO0tBQ25CO0lBQ0QsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFO1FBQ3ZCLElBQUEsb0JBQWEsRUFBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBQztRQUNwQyw4QkFBdUIsQ0FBQyxrQkFBTyxDQUFDLGFBQWEsQ0FBRTtRQUMvQyxtQ0FBa0I7S0FDbkI7Q0FDRixDQUFDO0FBa0JGLE1BQXNCLHVCQUF1QjtJQU0zQzs7Ozs7O09BTUc7SUFDSCxZQUNVLE9BQWdCLEVBQ2QsZ0JBQWtELEVBQ3BELEtBQThCLEVBQzlCLFFBQWtCO1FBSGxCLFlBQU8sR0FBUCxPQUFPLENBQVM7UUFDZCxxQkFBZ0IsR0FBaEIsZ0JBQWdCLENBQWtDO1FBQ3BELFVBQUssR0FBTCxLQUFLLENBQXlCO1FBQzlCLGFBQVEsR0FBUixRQUFRLENBQVU7UUFkcEIsaUJBQVksR0FBRyxDQUFDLE9BQWdCLEVBQUUsRUFBRSxDQUMxQyxrQkFBa0IsSUFBSSxDQUFDLFFBQVEsSUFBSSxPQUFPLEVBQUUsQ0FBQztJQWMzQyxDQUFDO0lBRUUsS0FBSyxDQUFDLFFBQVE7UUFDbkIsTUFBTSxXQUFXLEdBQUcsTUFBTSxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO1FBRTFFLElBQUksV0FBVyxFQUFFO1lBQ2YsT0FBTyxXQUFXLENBQUM7U0FDcEI7UUFFRCxNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUVyRCxNQUFNLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRTdELE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztDQUNGO0FBakNELDBEQWlDQyJ9

package/build/main/providers/caching-token-list-provider.d.ts

@@ -0,0 +1,52 @@
+import { ChainId, Token } from '@ring-protocol/sdk-core';
+import { TokenList } from '@uniswap/token-lists';
+import { ICache } from './cache';
+import { ITokenProvider, TokenAccessor } from './token-provider';
+/**
+ * Provider for getting token data from a Token List.
+ *
+ * @export
+ * @interface ITokenListProvider
+ */
+export interface ITokenListProvider {
+    hasTokenBySymbol(_symbol: string): Promise<boolean>;
+    getTokenBySymbol(_symbol: string): Promise<Token | undefined>;
+    hasTokenByAddress(address: string): Promise<boolean>;
+    getTokenByAddress(address: string): Promise<Token | undefined>;
+}
+export declare class CachingTokenListProvider implements ITokenProvider, ITokenListProvider {
+    private tokenCache;
+    private CACHE_KEY;
+    private chainId;
+    private chainToTokenInfos;
+    private chainSymbolToTokenInfo;
+    private chainAddressToTokenInfo;
+    private tokenList;
+    private CHAIN_SYMBOL_KEY;
+    private CHAIN_ADDRESS_KEY;
+    /**
+     * Creates an instance of CachingTokenListProvider.
+     * Token metadata (e.g. symbol and decimals) generally don't change so can be cached indefinitely.
+     *
+     * @param chainId The chain id to use.
+     * @param tokenList The token list to get the tokens from.
+     * @param tokenCache Cache instance to hold cached tokens.
+     */
+    constructor(chainId: ChainId | number, tokenList: TokenList, tokenCache: ICache<Token>);
+    static fromTokenListURI(chainId: ChainId | number, tokenListURI: string, tokenCache: ICache<Token>): Promise<CachingTokenListProvider>;
+    private static buildTokenList;
+    static fromTokenList(chainId: ChainId | number, tokenList: TokenList, tokenCache: ICache<Token>): Promise<CachingTokenListProvider>;
+    /**
+     * If no addresses array is specified, all tokens in the token list are
+     * returned.
+     *
+     * @param _addresses (optional) The token addresses to get.
+     * @returns Promise<TokenAccessor> A token accessor with methods for accessing the tokens.
+     */
+    getTokens(_addresses?: string[]): Promise<TokenAccessor>;
+    hasTokenBySymbol(_symbol: string): Promise<boolean>;
+    getTokenBySymbol(_symbol: string): Promise<Token | undefined>;
+    hasTokenByAddress(address: string): Promise<boolean>;
+    getTokenByAddress(address: string): Promise<Token | undefined>;
+    private buildToken;
+}