@chainlink/external-adapter-framework 0.0.6 → 0.0.8

package/package/cache/factory.js

@@ -0,0 +1,57 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheFactory = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const util_1 = require("../util");
+const local_1 = require("./local");
+const cacheMetrics = __importStar(require("./metrics"));
+const redis_1 = require("./redis");
+const logger = (0, util_1.makeLogger)('CacheFactory');
+class CacheFactory {
+    static buildCache(config) {
+        logger.info(`Using "${config.CACHE_TYPE}" cache.`);
+        if (config.CACHE_TYPE === 'local') {
+            return new local_1.LocalCache();
+        }
+        else if (config.CACHE_TYPE === 'redis') {
+            const redis = new ioredis_1.default({
+                enableAutoPipelining: true,
+                host: config.CACHE_REDIS_HOST,
+                port: config.CACHE_REDIS_PORT,
+            });
+            redis.on('connect', () => {
+                cacheMetrics.redisConnectionsOpen.inc();
+            });
+            // TODO: Maybe track active redis connections instead of just total count of connections created
+            // Use a Gauge and track with a combo of connect/end events listeners
+            return new redis_1.RedisCache(redis);
+        }
+    }
+}
+exports.CacheFactory = CacheFactory;

package/package/cache/index.d.ts

@@ -0,0 +1,90 @@
+import { AdapterEndpoint } from '../adapter';
+import { AdapterConfig } from '../config';
+import { AdapterMiddlewareBuilder, AdapterResponse, sleep } from '../util';
+export * from './local';
+export * from './redis';
+/**
+ * An object describing an entry in the cache.
+ * @typeParam T - the type of the entry's value
+ */
+export interface CacheEntry<T> {
+    key: string;
+    value: T;
+}
+/**
+ * Generic interface for a local or remote Cache.
+ * @typeParam T - the type of the cache entries' values
+ */
+export interface Cache<T = unknown> {
+    /**
+     * Gets an item from the Cache.
+     *
+     * @param key - the key of the desired entry for which to fetch its value
+     * @returns a Promise of the entry's value, or undefined if not found / expired.
+     */
+    get: (key: string) => Promise<T | undefined>;
+    /**
+     * Sets an item in the Cache.
+     *
+     * @param key - the key of the new entry
+     * @param value - the value of the new entry
+     * @param ttl - the time in milliseconds until the entry expires
+     * @returns an empty Promise that resolves when the entry has been set
+     */
+    set: (key: string, value: T, ttl: number) => Promise<void>;
+    /**
+     * Sets a list of items in the Cache.
+     *
+     * @param entries - a list of cache entries
+     * @param ttl - the time in milliseconds until the entries expire
+     * @returns an empty Promise that resolves when all entries have been set
+     */
+    setMany: (entries: CacheEntry<T>[], ttl: number) => Promise<void>;
+    /**
+     * Deletes the specified item from the Cache
+     *
+     * @param key - the key of the entry to be deleted
+     * @returns an empty Promise that resolves when the entry has been deleted
+     */
+    delete: (key: string) => Promise<void>;
+}
+export declare const calculateCacheKey: ({ adapterEndpoint, adapterConfig, }: {
+    adapterEndpoint: AdapterEndpoint;
+    adapterConfig: AdapterConfig;
+}, data: unknown) => string;
+export declare const calculateFeedId: (adapterEndpoint: AdapterEndpoint, data: unknown) => string;
+/**
+ * Calculates a unique key from the provided data.
+ *
+ * @param data - the request data/body, i.e. the adapter input params
+ * @param paramNames - the keys from adapter endpoint input parameters
+ * @returns the calculated unique key
+ *
+ * @example
+ * ```
+ * calculateKey({ base: 'ETH', quote: 'BTC' }, ['base','quote'])
+ * // equals `|base:eth|quote:btc`
+ * ```
+ */
+export declare const calculateKey: (data: unknown, paramNames: string[]) => string;
+/**
+ * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
+ * amount of retries is exceeded, it returns undefined instead.
+ *
+ * @param cache - a Cache instance
+ * @param key - the key generated from an AdapterRequest that corresponds to the desired AdapterResponse
+ * @param retry - current retry, only for internal use
+ * @returns the AdapterResponse if found, else undefined
+ */
+export declare const pollResponseFromCache: (cache: Cache<AdapterResponse>, key: string, options: {
+    maxRetries: number;
+    sleep: number;
+}, retry?: number) => Promise<AdapterResponse | undefined>;
+/**
+ * Given a Cache instance in the adapter dependencies, builds a middleware function that will perform
+ * a get from said Cache and return that if found; otherwise it'll continue the middleware chain.
+ *
+ * @param adapter - an initialized adapter
+ * @returns the cache middleware function
+ */
+export declare const buildCacheMiddleware: AdapterMiddlewareBuilder;

package/package/cache/index.js

@@ -0,0 +1,169 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 });
+exports.buildCacheMiddleware = exports.pollResponseFromCache = exports.calculateKey = exports.calculateFeedId = exports.calculateCacheKey = void 0;
+const util_1 = require("../util");
+const cacheMetrics = __importStar(require("./metrics"));
+__exportStar(require("./local"), exports);
+__exportStar(require("./redis"), exports);
+const logger = (0, util_1.makeLogger)('Cache');
+// Uses calculateKey to generate a unique key from the endpoint name, data, and input parameters
+const calculateCacheKey = ({ adapterEndpoint, adapterConfig, }, data) => {
+    const paramNames = Object.keys(adapterEndpoint.inputParameters);
+    if (paramNames.length === 0) {
+        logger.trace(`Using default cache key ${adapterConfig.DEFAULT_CACHE_KEY}`);
+        return adapterConfig.DEFAULT_CACHE_KEY;
+    }
+    return `${adapterEndpoint.name}-${(0, exports.calculateKey)(data, paramNames)}`;
+};
+exports.calculateCacheKey = calculateCacheKey;
+const calculateFeedId = (adapterEndpoint, data) => {
+    const paramNames = Object.keys(adapterEndpoint.inputParameters);
+    if (paramNames.length === 0) {
+        logger.trace(`Cannot generate Feed ID without input parameters`);
+        return 'N/A';
+    }
+    return (0, exports.calculateKey)(data, paramNames);
+};
+exports.calculateFeedId = calculateFeedId;
+/**
+ * Calculates a unique key from the provided data.
+ *
+ * @param data - the request data/body, i.e. the adapter input params
+ * @param paramNames - the keys from adapter endpoint input parameters
+ * @returns the calculated unique key
+ *
+ * @example
+ * ```
+ * calculateKey({ base: 'ETH', quote: 'BTC' }, ['base','quote'])
+ * // equals `|base:eth|quote:btc`
+ * ```
+ */
+const calculateKey = (data, paramNames) => {
+    if (data && typeof data !== 'object') {
+        throw new Error('Data to calculate cache key should be an object');
+    }
+    const params = data;
+    let cacheKey = ''; // TODO: Maybe there's a faster String Builder
+    for (const paramName of paramNames) {
+        // Ignore overrides param when generating cache keys
+        // TODO: expand support for ignoring `includes` and `tokenOverrides` params when generating keys
+        if (paramName === 'overrides') {
+            continue;
+        }
+        const param = params[paramName];
+        if (param === undefined) {
+            continue;
+        }
+        cacheKey += `|${paramName}:`;
+        switch (typeof param) {
+            case 'string':
+                cacheKey += param.toLowerCase();
+                break;
+            case 'number':
+            case 'boolean':
+                cacheKey += param.toString();
+                break;
+            case 'object':
+                // TODO: Implement object sorting for deterministic cache key generation
+                cacheKey += JSON.stringify(param);
+        }
+    }
+    // TODO: Check max size, potential issue
+    logger.trace(`Generated cache key for request: "${cacheKey}"`);
+    return cacheKey;
+};
+exports.calculateKey = calculateKey;
+// Calculate the amount of time the non-expired entry has been in the cache
+const calculateStaleness = (expirationTimestamp, ttl) => {
+    if (expirationTimestamp) {
+        const createTimestamp = expirationTimestamp - ttl;
+        return (Date.now() - createTimestamp) / 1000;
+    }
+    else {
+        // If expirationTimestamp is not available, staleness cannot be calculated
+        // Defaults to ttl for metrics purposes
+        return ttl;
+    }
+};
+/**
+ * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
+ * amount of retries is exceeded, it returns undefined instead.
+ *
+ * @param cache - a Cache instance
+ * @param key - the key generated from an AdapterRequest that corresponds to the desired AdapterResponse
+ * @param retry - current retry, only for internal use
+ * @returns the AdapterResponse if found, else undefined
+ */
+const pollResponseFromCache = async (cache, key, options, retry = 0) => {
+    if (retry > options.maxRetries) {
+        // Ideally this shouldn't happen often (p99 of reqs should be found in the cache)
+        logger.info('Exceeded max cache polling retries');
+        return undefined;
+    }
+    logger.trace('Getting response from cache...');
+    const response = await cache.get(key);
+    if (response) {
+        logger.trace('Got response from cache');
+        return response;
+    }
+    if (options.maxRetries === 0) {
+        logger.debug(`Response not found, retries disabled`);
+        return undefined;
+    }
+    logger.debug(`Response not found, sleeping ${options.sleep} milliseconds...`);
+    await (0, util_1.sleep)(options.sleep);
+    return (0, exports.pollResponseFromCache)(cache, key, options, retry + 1);
+};
+exports.pollResponseFromCache = pollResponseFromCache;
+/**
+ * Given a Cache instance in the adapter dependencies, builds a middleware function that will perform
+ * a get from said Cache and return that if found; otherwise it'll continue the middleware chain.
+ *
+ * @param adapter - an initialized adapter
+ * @returns the cache middleware function
+ */
+const buildCacheMiddleware = (adapter) => async (req, res) => {
+    const response = await adapter.dependencies.cache.get(req.requestContext.cacheKey);
+    if (response) {
+        logger.debug('Found response from cache, sending that');
+        if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
+            const label = cacheMetrics.cacheMetricsLabel(req.requestContext.cacheKey, req.requestContext.meta?.metrics?.feedId || 'N/A', adapter.config.CACHE_TYPE);
+            // Record cache staleness and cache get count and value
+            const staleness = calculateStaleness(response.maxAge, adapter.config.CACHE_MAX_AGE);
+            cacheMetrics.cacheGet(label, response.result, staleness);
+            req.requestContext.meta = {
+                ...req.requestContext.meta,
+                metrics: { ...req.requestContext.meta?.metrics, cacheHit: true },
+            };
+        }
+        return res.send(response);
+    }
+    logger.debug('Did not find response in cache, moving to next middleware');
+};
+exports.buildCacheMiddleware = buildCacheMiddleware;

package/package/cache/local.d.ts

@@ -0,0 +1,23 @@
+import { Cache, CacheEntry } from './index';
+/**
+ * Type for a value stored in a LocalCache entry.
+ *
+ * @typeParam T - the type for the entry's value
+ */
+export interface LocalCacheEntry<T> {
+    expirationTimestamp: number;
+    value: T;
+}
+/**
+ * Local implementation of a Cache. It uses a simple js Object, storing entries with both
+ * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
+ *
+ * @typeParam T - the type for the entries' values
+ */
+export declare class LocalCache<T = unknown> implements Cache<T> {
+    store: Record<string, LocalCacheEntry<T>>;
+    get(key: string): Promise<T | undefined>;
+    delete(key: string): Promise<void>;
+    set(key: string, value: T, ttl: number): Promise<void>;
+    setMany(entries: CacheEntry<T>[], ttl: number): Promise<void>;
+}

package/package/cache/local.js

@@ -0,0 +1,83 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalCache = void 0;
+const util_1 = require("../util");
+const cacheMetrics = __importStar(require("./metrics"));
+const logger = (0, util_1.makeLogger)('LocalCache');
+/**
+ * Local implementation of a Cache. It uses a simple js Object, storing entries with both
+ * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
+ *
+ * @typeParam T - the type for the entries' values
+ */
+class LocalCache {
+    constructor() {
+        this.store = {};
+    }
+    async get(key) {
+        logger.trace(`Getting key ${key}`);
+        const entry = this.store[key];
+        if (!entry) {
+            logger.debug(`No entry in local cache for key "${key}", returning undefined`);
+            return undefined;
+        }
+        const expired = entry.expirationTimestamp <= Date.now();
+        if (expired) {
+            logger.debug('Entry in local cache expired, deleting and returning undefined');
+            this.delete(key);
+            return undefined;
+        }
+        else {
+            logger.debug('Found valid entry in local cache, returning value');
+            return entry.value;
+        }
+    }
+    async delete(key) {
+        logger.trace(`Deleting key ${key}`);
+        delete this.store[key]; // Deletes are slower than ignoring or setting null, fyi
+    }
+    async set(key, value, ttl) {
+        logger.trace(`Setting key ${key} with ttl ${ttl}`);
+        this.store[key] = {
+            value,
+            expirationTimestamp: Date.now() + ttl,
+        };
+        // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
+        const feedId = value.meta?.metrics?.feedId;
+        if (feedId) {
+            // Record cache set count, max age, and staleness (set to 0 for cache set)
+            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Local);
+            cacheMetrics.cacheSet(label, ttl);
+        }
+    }
+    async setMany(entries, ttl) {
+        logger.trace(`Setting a bunch of keys with ttl ${ttl}`);
+        for (const { key, value } of entries) {
+            this.set(key, value, ttl);
+        }
+    }
+}
+exports.LocalCache = LocalCache;

package/package/cache/metrics.d.ts

@@ -0,0 +1,27 @@
+import * as client from 'prom-client';
+interface CacheMetricsLabels {
+    participant_id: string;
+    feed_id: string;
+    cache_type: string;
+}
+export declare const cacheGet: (label: CacheMetricsLabels, value: unknown, staleness: number) => void;
+export declare const cacheSet: (label: CacheMetricsLabels, maxAge: number) => void;
+export declare const cacheMetricsLabel: (cacheKey: string, feedId: string, cacheType: string) => {
+    participant_id: string;
+    feed_id: string;
+    cache_type: string;
+};
+export declare enum CacheTypes {
+    Redis = "redis",
+    Local = "local"
+}
+export declare enum CMD_SENT_STATUS {
+    TIMEOUT = "TIMEOUT",
+    FAIL = "FAIL",
+    SUCCESS = "SUCCESS"
+}
+export declare const redisConnectionsOpen: client.Counter<string>;
+export declare const redisRetriesCount: client.Counter<string>;
+export declare const redisCommandsSentCount: client.Counter<"status" | "function_name">;
+export declare const cacheWarmerCount: client.Gauge<"isBatched">;
+export {};

package/package/cache/metrics.js

@@ -0,0 +1,120 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheWarmerCount = exports.redisCommandsSentCount = exports.redisRetriesCount = exports.redisConnectionsOpen = exports.CMD_SENT_STATUS = exports.CacheTypes = exports.cacheMetricsLabel = exports.cacheSet = exports.cacheGet = void 0;
+const client = __importStar(require("prom-client"));
+const cacheGet = (label, value, staleness) => {
+    if (typeof value === 'number' || typeof value === 'string') {
+        const parsedValue = Number(value);
+        if (!Number.isNaN(parsedValue) && Number.isFinite(parsedValue)) {
+            cacheDataGetValues.labels(label).set(parsedValue);
+        }
+    }
+    cacheDataGetCount.labels(label).inc();
+    cacheDataStalenessSeconds.labels(label).set(staleness);
+};
+exports.cacheGet = cacheGet;
+const cacheSet = (label, maxAge) => {
+    cacheDataSetCount.labels(label).inc();
+    cacheDataMaxAge.labels(label).set(maxAge);
+    cacheDataStalenessSeconds.labels(label).set(0);
+};
+exports.cacheSet = cacheSet;
+const cacheMetricsLabel = (cacheKey, feedId, cacheType) => ({
+    participant_id: cacheKey,
+    feed_id: feedId,
+    cache_type: cacheType,
+});
+exports.cacheMetricsLabel = cacheMetricsLabel;
+var CacheTypes;
+(function (CacheTypes) {
+    CacheTypes["Redis"] = "redis";
+    CacheTypes["Local"] = "local";
+})(CacheTypes = exports.CacheTypes || (exports.CacheTypes = {}));
+var CMD_SENT_STATUS;
+(function (CMD_SENT_STATUS) {
+    CMD_SENT_STATUS["TIMEOUT"] = "TIMEOUT";
+    CMD_SENT_STATUS["FAIL"] = "FAIL";
+    CMD_SENT_STATUS["SUCCESS"] = "SUCCESS";
+})(CMD_SENT_STATUS = exports.CMD_SENT_STATUS || (exports.CMD_SENT_STATUS = {}));
+const baseLabels = [
+    'feed_id',
+    'participant_id',
+    'cache_type',
+    'is_from_ws',
+    'experimental',
+];
+// Skipping this metrics for v3
+// const cache_execution_duration_seconds = new client.Histogram({
+//   name: 'cache_execution_duration_seconds',
+//   help: 'A histogram bucket of the distribution of cache execution durations',
+//   labelNames: [...baseLabels, 'cache_hit'] as const,
+//   buckets: [0.01, 0.1, 1, 10],
+// })
+const cacheDataGetCount = new client.Counter({
+    name: 'cache_data_get_count',
+    help: 'A counter that increments every time a value is fetched from the cache',
+    labelNames: baseLabels,
+});
+const cacheDataGetValues = new client.Gauge({
+    name: 'cache_data_get_values',
+    help: 'A gauge keeping track of values being fetched from cache',
+    labelNames: baseLabels,
+});
+const cacheDataMaxAge = new client.Gauge({
+    name: 'cache_data_max_age',
+    help: 'A gauge tracking the max age of stored values in the cache',
+    labelNames: baseLabels,
+});
+const cacheDataSetCount = new client.Counter({
+    name: 'cache_data_set_count',
+    help: 'A counter that increments every time a value is set to the cache',
+    labelNames: [...baseLabels, 'status_code'],
+});
+const cacheDataStalenessSeconds = new client.Gauge({
+    name: 'cache_data_staleness_seconds',
+    help: 'Observes the staleness of the data returned',
+    labelNames: baseLabels,
+});
+// Redis Metrics
+exports.redisConnectionsOpen = new client.Counter({
+    name: 'redis_connections_open',
+    help: 'The number of redis connections that are open',
+});
+exports.redisRetriesCount = new client.Counter({
+    name: 'redis_retries_count',
+    help: 'The number of retries that have been made to establish a redis connection',
+});
+exports.redisCommandsSentCount = new client.Counter({
+    name: 'redis_commands_sent_count',
+    help: 'The number of redis commands sent',
+    labelNames: ['status', 'function_name'],
+});
+// Cache Warmer Metrics
+exports.cacheWarmerCount = new client.Gauge({
+    name: 'cache_warmer_get_count',
+    help: 'The number of cache warmers running',
+    labelNames: ['isBatched'],
+});

package/package/cache/redis.d.ts

@@ -0,0 +1,16 @@
+import Redis from 'ioredis';
+import { Cache, CacheEntry } from './index';
+/**
+ * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
+ * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
+ *
+ * @typeParam T - the type for the entries' values
+ */
+export declare class RedisCache<T = unknown> implements Cache<T> {
+    private client;
+    constructor(client: Redis);
+    get(key: string): Promise<T | undefined>;
+    delete(key: string): Promise<void>;
+    set(key: string, value: T, ttl: number): Promise<void>;
+    setMany(entries: CacheEntry<T>[], ttl: number): Promise<void>;
+}