@chainlink/external-adapter-framework 0.0.67 → 0.0.69

package/adapter.d.ts

@@ -0,0 +1,156 @@
+import Redis from 'ioredis';
+import type EventSource from 'eventsource';
+import { Cache } from './cache';
+import { AdapterConfig, BaseAdapterConfig, CustomSettingsType, SettingsMap } from './config';
+import { AdapterRateLimitTier, BackgroundExecuteRateLimiter, RequestRateLimiter } from './rate-limiting';
+import { Transport } from './transports';
+import { SubscriptionSetFactory } from './util';
+import { InputParameters } from './validation/input-params';
+import { InputValidator } from './validation/input-validator';
+/**
+ * Dependencies that will be injected into the Adapter on startup
+ */
+export interface AdapterDependencies {
+    /** Specific instance of the Cache the adapter will use (e.g. Local, Redis, etc.) */
+    cache: Cache;
+    /** Shared instance of the request rate limiter */
+    requestRateLimiter: RequestRateLimiter;
+    /** Shared instance of the background execute rate limiter */
+    backgroundExecuteRateLimiter: BackgroundExecuteRateLimiter;
+    /** Factory to create subscription sets based on the specified cache type */
+    subscriptionSetFactory: SubscriptionSetFactory;
+    /** Redis client used for cache and subscription set */
+    redisClient: Redis;
+    /** EventSource to use for listening to server sent events.  A mock EventSource can be provided as a dependency for testing */
+    eventSource: typeof EventSource;
+}
+/**
+ * Context that will be used on background executions of a Transport.
+ * For example, the endpointName used to log statements or generate Cache keys.
+ */
+export interface AdapterContext<CustomSettings extends CustomSettingsType<CustomSettings> = SettingsMap> {
+    /** Endpoint instance within the adapter that the Transport is related to */
+    adapterEndpoint: AdapterEndpoint<unknown, unknown, CustomSettings>;
+    /** Initialized config for the adapter that the Transport can access */
+    adapterConfig: AdapterConfig<CustomSettings>;
+}
+/**
+ * Structure to describe rate limits specs for the Adapter
+ */
+interface AdapterRateLimitingConfig {
+    /** Adapter rate limits, gotten from the specific tier requested */
+    tiers: Record<string, AdapterRateLimitTier>;
+}
+/**
+ * Main structure of an External Adapter
+ */
+export interface AdapterParams<CustomSettings extends SettingsMap> {
+    /** Name of the adapter */
+    name: string;
+    /** If present, the string that will be used for requests with no specified endpoint */
+    defaultEndpoint?: string;
+    /**
+     * List of [[AdapterEndpoint]]s in the adapter. This is purposefully typed any; it's the correct type in this case.
+     *
+     * When you try to create an adapter and you provide an endpoint, if these generics were set to "unknown" instead
+     * what would happen is that Typescript would check if the types match, and would fail to assign unknown to the
+     * specific Params or Result in the transport itself.
+     * We also can't use generics, because if we had more than one transport with different requests (very likely)
+     * then those new types wouldn't match with each other.
+     */
+    endpoints: AdapterEndpoint<any, any, CustomSettings>[];
+    /** Map of overrides to the default config values for an Adapter */
+    envDefaultOverrides?: Partial<BaseAdapterConfig>;
+    /** List of custom env vars for this particular adapter (e.g. RPC_URL) */
+    customSettings?: SettingsMap;
+    /** Configuration relevant to outbound (EA --\> DP) communication rate limiting */
+    rateLimiting?: AdapterRateLimitingConfig;
+    /** Overrides for converting the 'base' parameter that are hardcoded into the adapter. */
+    overrides?: Record<string, string>;
+}
+/**
+ * Structure to describe rate limits specs for a specific adapter endpoint
+ */
+export interface EndpointRateLimitingConfig {
+    /**
+     * How much of the total limit for the adapter will be assigned to this specific endpoint.
+     * Should be a non-zero positive number up to 100.
+     * Endpoints in the same adapter without a specific allocation will divide the remaining limits equally.
+     */
+    allocationPercentage: number;
+}
+/**
+ * Structure to describe a specific endpoint in an [[Adapter]]
+ */
+export interface AdapterEndpointParams<Params, Result, CustomSettings extends SettingsMap> {
+    /** Name that will be used to match input params to this endpoint (case insensitive) */
+    name: string;
+    /** List of alternative endpoint names that will resolve to this same transport (case insensitive) */
+    aliases?: string[];
+    /** Transport that will be used to handle data processing and communication for this endpoint */
+    transport: Transport<Params, Result, CustomSettings>;
+    /** Specification of what the body of a request hitting this endpoint should look like (used for validation) */
+    inputParameters: InputParameters;
+    /** Specific details related to the rate limiting for this endpoint in particular */
+    rateLimiting?: EndpointRateLimitingConfig;
+}
+export declare class AdapterEndpoint<Params, Result, CustomSettings extends SettingsMap> implements AdapterEndpointParams<Params, Result, CustomSettings> {
+    name: string;
+    aliases?: string[] | undefined;
+    transport: Transport<Params, Result, CustomSettings>;
+    inputParameters: InputParameters;
+    rateLimiting?: EndpointRateLimitingConfig | undefined;
+    validator: InputValidator;
+    constructor(params: AdapterEndpointParams<Params, Result, CustomSettings>);
+}
+declare type CustomAdapterSettings = SettingsMap & NegatedAdapterSettings;
+declare type NegatedAdapterSettings = {
+    [K in keyof BaseAdapterConfig]?: never;
+};
+export declare class Adapter<CustomSettings extends CustomAdapterSettings = SettingsMap> implements AdapterParams<CustomSettings> {
+    name: string;
+    defaultEndpoint?: string | undefined;
+    endpoints: AdapterEndpoint<unknown, unknown, CustomSettings>[];
+    envDefaultOverrides?: Partial<BaseAdapterConfig> | undefined;
+    customSettings?: SettingsMap | undefined;
+    rateLimiting?: AdapterRateLimitingConfig | undefined;
+    overrides?: Record<string, string> | undefined;
+    initialized: boolean;
+    /** Object containing alias translations for all endpoints */
+    endpointsMap: Record<string, AdapterEndpoint<unknown, unknown, CustomSettings>>;
+    /** Initialized dependencies that the adapter will use */
+    dependencies: AdapterDependencies;
+    /** Configuration params for various adapter properties */
+    config: AdapterConfig;
+    constructor(params: AdapterParams<CustomSettings>);
+    /**
+     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
+     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
+     */
+    initialize(dependencies?: Partial<AdapterDependencies>): Promise<void>;
+    /**
+     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
+     * i.e. makes them lowercase for now
+     */
+    private normalizeEndpointNames;
+    /**
+     * This function will take an adapter structure and go through each endpoint, calculating
+     * each one's allocation of the total rate limits that are set for the adapter as a whole.
+     *
+     */
+    private calculateRateLimitAllocations;
+    /**
+     * Creates a list of key/value pairs that need to be censored in the logs
+     * using the sensitive flag in the adapter config
+     */
+    private buildCensorList;
+    /**
+     * This function will process dependencies for an adapter, such as caches or rate limiters,
+     * in order to inject them into transports and other relevant places later in the lifecycle.
+     *
+     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
+     * @returns a set of AdapterDependencies all initialized
+     */
+    initializeDependencies(inputDependencies?: Partial<AdapterDependencies>): AdapterDependencies;
+}
+export {};

package/adapter.js

@@ -0,0 +1,200 @@
+"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.Adapter = exports.AdapterEndpoint = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const cache_1 = require("./cache");
+const config_1 = require("./config");
+const rate_limiting_1 = require("./rate-limiting");
+const util_1 = require("./util");
+const censor_list_1 = __importDefault(require("./util/censor/censor-list"));
+const cacheMetrics = __importStar(require("./cache/metrics"));
+const input_validator_1 = require("./validation/input-validator");
+const client = __importStar(require("prom-client"));
+const logger = (0, util_1.makeLogger)('Adapter');
+/**
+ * `prom-client` is shared between v2 and v3 when both are dependencies, resulting in metric collision errors
+ * Clearing metrics on import will wipe v2's existing register so we can replace them with v3's metrics
+ **/
+client.register.clear();
+class AdapterEndpoint {
+    constructor(params) {
+        this.name = params.name;
+        this.aliases = params.aliases;
+        this.transport = params.transport;
+        this.inputParameters = params.inputParameters;
+        this.rateLimiting = params.rateLimiting;
+        this.validator = new input_validator_1.InputValidator(this.inputParameters);
+    }
+}
+exports.AdapterEndpoint = AdapterEndpoint;
+class Adapter {
+    constructor(params) {
+        // After initialization
+        this.initialized = false;
+        /** Object containing alias translations for all endpoints */
+        this.endpointsMap = {};
+        // Copy over params
+        this.name = params.name;
+        this.defaultEndpoint = params.defaultEndpoint?.toLowerCase();
+        this.endpoints = params.endpoints;
+        this.envDefaultOverrides = params.envDefaultOverrides;
+        this.customSettings = params.customSettings;
+        this.rateLimiting = params.rateLimiting;
+        this.overrides = params.overrides;
+        this.config = (0, config_1.buildAdapterConfig)({
+            overrides: this.envDefaultOverrides,
+            customSettings: this.customSettings,
+        });
+        this.normalizeEndpointNames();
+        this.calculateRateLimitAllocations();
+    }
+    /**
+     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
+     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
+     */
+    async initialize(dependencies) {
+        if (this.initialized) {
+            throw new Error('This adapter has already been initialized!');
+        }
+        this.dependencies = this.initializeDependencies(dependencies);
+        for (const endpoint of this.endpoints) {
+            // Add aliases to map to use in validation
+            const aliases = [endpoint.name, ...(endpoint.aliases || [])];
+            for (const alias of aliases) {
+                if (this.endpointsMap[alias]) {
+                    throw new Error(`Duplicate endpoint / alias: "${alias}"`);
+                }
+                this.endpointsMap[alias] = endpoint;
+            }
+            logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
+            await endpoint.transport.initialize(this.dependencies, this.config, endpoint.name);
+        }
+        // Build list of key/values that need to be redacted in logs
+        // Populates the static array in CensorList to use in censor-transport
+        this.buildCensorList();
+        logger.debug('Adapter initialization complete.');
+        this.initialized = true;
+    }
+    /**
+     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
+     * i.e. makes them lowercase for now
+     */
+    normalizeEndpointNames() {
+        for (const endpoint of this.endpoints) {
+            endpoint.name = endpoint.name.toLowerCase();
+            endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase());
+        }
+    }
+    /**
+     * This function will take an adapter structure and go through each endpoint, calculating
+     * each one's allocation of the total rate limits that are set for the adapter as a whole.
+     *
+     */
+    calculateRateLimitAllocations() {
+        const numberOfEndpoints = this.endpoints.length;
+        const endpointsWithExplicitAllocations = this.endpoints.filter((e) => e.rateLimiting);
+        const totalExplicitAllocation = endpointsWithExplicitAllocations
+            .map((e) => e.rateLimiting?.allocationPercentage || 0)
+            .reduce((sum, next) => sum + next, 0);
+        if (totalExplicitAllocation > 100) {
+            throw new Error('The total allocation set for all endpoints summed cannot exceed 100%');
+        }
+        if (totalExplicitAllocation === 100 &&
+            numberOfEndpoints - endpointsWithExplicitAllocations.length > 0) {
+            throw new Error('The explicit allocation is at 100% but there are endpoints with implicit allocation');
+        }
+        const implicitAllocation = 100 - totalExplicitAllocation;
+        logger.debug('Adapter rate limit allocations:');
+        for (const endpoint of this.endpoints) {
+            if (!endpoint.rateLimiting) {
+                endpoint.rateLimiting = {
+                    allocationPercentage: implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
+                };
+            }
+            logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`);
+        }
+    }
+    /**
+     * Creates a list of key/value pairs that need to be censored in the logs
+     * using the sensitive flag in the adapter config
+     */
+    buildCensorList() {
+        const censorList = Object.entries(config_1.BaseSettings)
+            .concat(Object.entries(this.customSettings || {}))
+            .filter(([name, setting]) => setting && setting.type === 'string' && setting.sensitive && this.config[name])
+            .map(([name]) => ({
+            key: name,
+            // Escaping potential special characters in values before creating regex
+            value: new RegExp(
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this.config[name].replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')),
+        }));
+        censor_list_1.default.set(censorList);
+    }
+    /**
+     * This function will process dependencies for an adapter, such as caches or rate limiters,
+     * in order to inject them into transports and other relevant places later in the lifecycle.
+     *
+     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
+     * @returns a set of AdapterDependencies all initialized
+     */
+    initializeDependencies(inputDependencies) {
+        const dependencies = inputDependencies || {};
+        if (!dependencies.redisClient) {
+            if (this.config.CACHE_TYPE === 'redis') {
+                dependencies.redisClient = new ioredis_1.default({
+                    enableAutoPipelining: true,
+                    host: this.config.CACHE_REDIS_HOST,
+                    port: this.config.CACHE_REDIS_PORT,
+                    password: this.config.CACHE_REDIS_PASSWORD,
+                    path: this.config.CACHE_REDIS_PATH,
+                    timeout: this.config.CACHE_REDIS_TIMEOUT,
+                });
+                dependencies.redisClient.on('connect', () => {
+                    cacheMetrics.redisConnectionsOpen.inc();
+                });
+            }
+        }
+        if (!dependencies.cache) {
+            dependencies.cache = cache_1.CacheFactory.buildCache(this.config.CACHE_TYPE, dependencies.redisClient);
+        }
+        const rateLimitingTier = (0, rate_limiting_1.getRateLimitingTier)(this.config, this.rateLimiting?.tiers);
+        if (!dependencies.requestRateLimiter) {
+            dependencies.requestRateLimiter = new rate_limiting_1.SimpleCountingRateLimiter().initialize(this.endpoints, rateLimitingTier);
+        }
+        if (!dependencies.backgroundExecuteRateLimiter) {
+            dependencies.backgroundExecuteRateLimiter = new rate_limiting_1.FixedFrequencyRateLimiter().initialize(this.endpoints, rateLimitingTier);
+        }
+        if (!dependencies.subscriptionSetFactory) {
+            dependencies.subscriptionSetFactory = new util_1.SubscriptionSetFactory(this.config, dependencies.redisClient, this.name);
+        }
+        return dependencies;
+    }
+}
+exports.Adapter = Adapter;

package/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAA2B;AAE3B,mCAA6C;AAC7C,qCAOiB;AACjB,mDAOwB;AAExB,iCAA2D;AAC3D,4EAAsE;AAEtE,8DAA+C;AAC/C,kEAA6D;AAE7D,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,SAAS,CAAC,CAAA;AAkHpC,MAAa,eAAe;IAU1B,YAAY,MAA6D;QACvE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QACjC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAA;QAC7C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC3D,CAAC;CACF;AAlBD,0CAkBC;AAOD,MAAa,OAAO;IAwBlB,YAAY,MAAqC;QAZjD,uBAAuB;QACvB,gBAAW,GAAG,KAAK,CAAA;QAEnB,6DAA6D;QAC7D,iBAAY,GAAsE,EAAE,CAAA;QASlF,mBAAmB;QACnB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,EAAE,WAAW,EAAE,CAAA;QAC5D,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QACjC,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAA;QACrD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAA;QAC3C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QAEjC,IAAI,CAAC,MAAM,GAAG,IAAA,2BAAkB,EAAC;YAC/B,SAAS,EAAE,IAAI,CAAC,mBAAmB;YACnC,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC,CAAA;QAEF,IAAI,CAAC,sBAAsB,EAAE,CAAA;QAC7B,IAAI,CAAC,6BAA6B,EAAE,CAAA;IACtC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,YAA2C;QAC1D,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC9D;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;QAE7D,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,0CAA0C;YAC1C,MAAM,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;YAC5D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;gBAC3B,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,GAAG,CAAC,CAAA;iBAC1D;gBACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;aACpC;YAED,MAAM,CAAC,KAAK,CAAC,wCAAwC,QAAQ,CAAC,IAAI,MAAM,CAAC,CAAA;YACzE,MAAM,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;SACnF;QAED,4DAA4D;QAC5D,sEAAsE;QACtE,IAAI,CAAC,eAAe,EAAE,CAAA;QAEtB,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;IACzB,CAAC;IAED;;;OAGG;IACK,sBAAsB;QAC5B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;YAC3C,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;SACjE;IACH,CAAC;IAED;;;;OAIG;IACK,6BAA6B;QACnC,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;QAC/C,MAAM,gCAAgC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAErF,MAAM,uBAAuB,GAAG,gCAAgC;aAC7D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,oBAAoB,IAAI,CAAC,CAAC;aACrD,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;QAEvC,IAAI,uBAAuB,GAAG,GAAG,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;SACxF;QAED,IACE,uBAAuB,KAAK,GAAG;YAC/B,iBAAiB,GAAG,gCAAgC,CAAC,MAAM,GAAG,CAAC,EAC/D;YACA,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;SACF;QAED,MAAM,kBAAkB,GAAG,GAAG,GAAG,uBAAuB,CAAA;QAExD,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;QAC/C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE;gBAC1B,QAAQ,CAAC,YAAY,GAAG;oBACtB,oBAAoB,EAClB,kBAAkB,GAAG,CAAC,iBAAiB,GAAG,gCAAgC,CAAC,MAAM,CAAC;iBACrF,CAAA;aACF;YAED,MAAM,CAAC,KAAK,CAAC,aAAa,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAA;SAC9F;IACH,CAAC;IAED;;;OAGG;IACK,eAAe;QACrB,MAAM,UAAU,GAAqB,MAAM,CAAC,OAAO,CAAC,qBAA2B,CAAC;aAC7E,MAAM,CAAC,MAAM,CAAC,OAAO,CAAE,IAAI,CAAC,cAA8B,IAAI,EAAE,CAAC,CAAC;aAClE,MAAM,CACL,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAClB,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACjF;aACA,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YAChB,GAAG,EAAE,IAAI;YACT,wEAAwE;YACxE,KAAK,EAAE,IAAI,MAAM;YACf,oEAAoE;YACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAa,CAAC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAC3E;SACF,CAAC,CAAC,CAAA;QACL,qBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB,CAAC,iBAAgD;QACrE,MAAM,YAAY,GAAG,iBAAiB,IAAI,EAAE,CAAA;QAE5C,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;YAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,OAAO,EAAE;gBACtC,YAAY,CAAC,WAAW,GAAG,IAAI,iBAAK,CAAC;oBACnC,oBAAoB,EAAE,IAAI;oBAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB;oBAC1C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,mBAAmB;iBACzC,CAAC,CAAA;gBACF,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;oBAC1C,YAAY,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAA;gBACzC,CAAC,CAAC,CAAA;aACH;SACF;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;YACvB,YAAY,CAAC,KAAK,GAAG,oBAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;SAC/F;QAED,MAAM,gBAAgB,GAAG,IAAA,mCAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnF,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE;YACpC,YAAY,CAAC,kBAAkB,GAAG,IAAI,yCAAyB,EAAE,CAAC,UAAU,CAC1E,IAAI,CAAC,SAAS,EACd,gBAAgB,CACjB,CAAA;SACF;QACD,IAAI,CAAC,YAAY,CAAC,4BAA4B,EAAE;YAC9C,YAAY,CAAC,4BAA4B,GAAG,IAAI,yCAAyB,EAAE,CAAC,UAAU,CACpF,IAAI,CAAC,SAAS,EACd,gBAAgB,CACjB,CAAA;SACF;QACD,IAAI,CAAC,YAAY,CAAC,sBAAsB,EAAE;YACxC,YAAY,CAAC,sBAAsB,GAAG,IAAI,6BAAsB,CAC9D,IAAI,CAAC,MAAM,EACX,YAAY,CAAC,WAAW,EACxB,IAAI,CAAC,IAAI,CACV,CAAA;SACF;QAED,OAAO,YAAmC,CAAA;IAC5C,CAAC;CACF;AA3MD,0BA2MC"}

package/cache/redis.d.ts

@@ -1,14 +1,21 @@
-import Redis from 'ioredis';
+import Redis, { Callback } from 'ioredis';
 import { Cache, CacheEntry } from './index';
+/**
+ *  Common callback for redis commands that logs success/fail and throws on fail
+ *  @param {string} message - message to log on error
+ *  @param {string} functionName - name of the redis function where this callback was used, used for metrics
+ */
 /**
  * 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
+ * @param {boolean} alwaysFail - if true, error callback will always throw an error (used for testing)
  */
 export declare class RedisCache<T = unknown> implements Cache<T> {
     private client;
     constructor(client: Redis);
+    commandCallback(message: string, functionName: string): Callback;
     get(key: string): Promise<T | undefined>;
     delete(key: string): Promise<void>;
     set(key: string, value: T, ttl: number): Promise<void>;

package/cache/redis.js

@@ -25,25 +25,52 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCache = void 0;
 const util_1 = require("../util");
+const metrics_1 = require("./metrics");
 const cacheMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('RedisCache');
+const recordRedisCommandMetric = (status, functionName) => {
+    cacheMetrics.redisCommandsSentCount
+        .labels({ status: cacheMetrics.CMD_SENT_STATUS[status], function_name: functionName })
+        .inc();
+};
+/**
+ *  Common callback for redis commands that logs success/fail and throws on fail
+ *  @param {string} message - message to log on error
+ *  @param {string} functionName - name of the redis function where this callback was used, used for metrics
+ */
 /**
  * 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
+ * @param {boolean} alwaysFail - if true, error callback will always throw an error (used for testing)
  */
 class RedisCache {
     constructor(client) {
         this.client = client;
+        // Global error handler in case one of the commands is missing a callback
+        this.client.on('error', (err) => {
+            logger.error(`Encountered unhandled error in RedisCache: ${err}`);
+            // Record error command sent to Redis
+            recordRedisCommandMetric(metrics_1.CMD_SENT_STATUS.FAIL, 'outermost');
+            throw err;
+        });
+    }
+    commandCallback(message, functionName) {
+        return (err) => {
+            if (err) {
+                logger.error(`${message}: ${err}`);
+                recordRedisCommandMetric(metrics_1.CMD_SENT_STATUS.FAIL, functionName);
+                throw err;
+            }
+            else {
+                recordRedisCommandMetric(metrics_1.CMD_SENT_STATUS.SUCCESS, functionName);
+            }
+        };
     }
     async get(key) {
         logger.trace(`Getting key ${key}`);
-        const value = await this.client.get(key);
-        // Record get command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'get' })
-            .inc();
+        const value = await this.client.get(key, this.commandCallback(`Error getting key "${key}"`, 'get'));
         if (!value) {
             logger.debug(`No entry in redis cache for key "${key}", returning undefined`);
             return undefined;
@@ -52,38 +79,30 @@ class RedisCache {
     }
     async delete(key) {
         logger.trace(`Deleting key ${key}`);
-        await this.client.del(key);
-        // Record delete command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'delete' })
-            .inc();
+        await this.client.del(key, this.commandCallback(`Error deleting key "${key}"`, 'delete'));
     }
     async set(key, value, ttl) {
         logger.trace(`Setting key ${key}`);
-        await this.client.set(key, JSON.stringify(value), 'PX', ttl);
-        // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
+        // 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.Redis);
             cacheMetrics.cacheSet(label, ttl);
         }
-        // Record set command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'set' })
-            .inc();
+        await this.client.set(key, JSON.stringify(value), 'PX', ttl, this.commandCallback(`Error setting key "${key}"`, 'set'));
     }
     async setMany(entries, ttl) {
         logger.trace(`Setting a bunch of keys`);
         // Unfortunately, there's no ttl for mset
         let chain = this.client.multi();
         for (const entry of entries) {
-            chain = chain.set(entry.key, JSON.stringify(entry.value), 'PX', ttl);
+            chain = chain.set(entry.key, JSON.stringify(entry.value), 'PX', ttl, this.commandCallback(`Error setting key "${entry.key}"`, 'setMany'));
         }
-        await chain.exec();
+        await chain.exec(this.commandCallback(`Exec failed`, 'exec')); // TODO Not sure this will be hit since an individual set will throw
         // Loop again, but this time to record these in metrics
         for (const entry of entries) {
-            // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
+            // Only record metrics if feed id is present, otherwise assuming value is not adapter response to record
             const feedId = entry.value.meta?.metrics?.feedId;
             if (feedId) {
                 // Record cache set count, max age, and staleness (set to 0 for cache set)
@@ -92,9 +111,7 @@ class RedisCache {
             }
         }
         // Record setMany command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'exec' })
-            .inc();
+        recordRedisCommandMetric(metrics_1.CMD_SENT_STATUS.SUCCESS, 'exec');
     }
 }
 exports.RedisCache = RedisCache;

package/cache/redis.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kCAAqD;AAErD,wDAAyC;AAEzC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,CAAA;AAEvC;;;;;GAKG;AACH,MAAa,UAAU;IACrB,YAAoB,MAAa;QAAb,WAAM,GAAN,MAAM,CAAO;IAAG,CAAC;IAErC,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAExC,mCAAmC;QACnC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aAC9E,GAAG,EAAE,CAAA;QAER,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,CAAC,KAAK,CAAC,oCAAoC,GAAG,wBAAwB,CAAC,CAAA;YAC7E,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;QACnC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE1B,sCAAsC;QACtC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;aACjF,GAAG,EAAE,CAAA;IACV,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC1C,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAE5D,wGAAwG;QACxG,MAAM,MAAM,GAAI,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;QAC1E,IAAI,MAAM,EAAE;YACV,0EAA0E;YAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACxF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClC;QAED,mCAAmC;QACnC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aAC9E,GAAG,EAAE,CAAA;IACV,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwB,EAAE,GAAW;QACjD,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QACvC,yCAAyC;QACzC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAE/B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;SACrE;QAED,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;QAElB,uDAAuD;QACvD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,wGAAwG;YACxG,MAAM,MAAM,GAAI,KAAK,CAAC,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;YAChF,IAAI,MAAM,EAAE;gBACV,0EAA0E;gBAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAC1C,KAAK,CAAC,GAAG,EACT,MAAM,EACN,YAAY,CAAC,UAAU,CAAC,KAAK,CAC9B,CAAA;gBACD,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;aAClC;SACF;QAED,uCAAuC;QACvC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;aAC/E,GAAG,EAAE,CAAA;IACV,CAAC;CACF;AA/ED,gCA+EC"}
+{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kCAAqD;AAErD,uCAA2C;AAC3C,wDAAyC;AAEzC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,CAAA;AAEvC,MAAM,wBAAwB,GAAG,CAC/B,MAAoC,EACpC,YAAoB,EACd,EAAE;IACR,YAAY,CAAC,sBAAsB;SAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC;SACrF,GAAG,EAAE,CAAA;AACV,CAAC,CAAA;AAED;;;;GAIG;AAEH;;;;;;GAMG;AACH,MAAa,UAAU;IACrB,YAAoB,MAAa;QAAb,WAAM,GAAN,MAAM,CAAO;QAC/B,yEAAyE;QACzE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,8CAA8C,GAAG,EAAE,CAAC,CAAA;YACjE,qCAAqC;YACrC,wBAAwB,CAAC,yBAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;YAC3D,MAAM,GAAG,CAAA;QACX,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,eAAe,CAAC,OAAe,EAAE,YAAoB;QACnD,OAAO,CAAC,GAAG,EAAE,EAAE;YACb,IAAI,GAAG,EAAE;gBACP,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,KAAK,GAAG,EAAE,CAAC,CAAA;gBAClC,wBAAwB,CAAC,yBAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;gBAC5D,MAAM,GAAG,CAAA;aACV;iBAAM;gBACL,wBAAwB,CAAC,yBAAe,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;aAChE;QACH,CAAC,CAAA;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACjC,GAAG,EACH,IAAI,CAAC,eAAe,CAAC,sBAAsB,GAAG,GAAG,EAAE,KAAK,CAAC,CAC1D,CAAA;QAED,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,CAAC,KAAK,CAAC,oCAAoC,GAAG,wBAAwB,CAAC,CAAA;YAC7E,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;QACnC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,uBAAuB,GAAG,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAA;IAC3F,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC1C,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,wGAAwG;QACxG,MAAM,MAAM,GAAI,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;QAC1E,IAAI,MAAM,EAAE;YACV,0EAA0E;YAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACxF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACnB,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,IAAI,EACJ,GAAG,EACH,IAAI,CAAC,eAAe,CAAC,sBAAsB,GAAG,GAAG,EAAE,KAAK,CAAC,CAC1D,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwB,EAAE,GAAW;QACjD,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QAEvC,yCAAyC;QACzC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAC/B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,KAAK,GAAG,KAAK,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,EACT,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAC3B,IAAI,EACJ,GAAG,EACH,IAAI,CAAC,eAAe,CAAC,sBAAsB,KAAK,CAAC,GAAG,GAAG,EAAE,SAAS,CAAC,CACpE,CAAA;SACF;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAA,CAAC,oEAAoE;QAElI,uDAAuD;QACvD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,wGAAwG;YACxG,MAAM,MAAM,GAAI,KAAK,CAAC,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;YAChF,IAAI,MAAM,EAAE;gBACV,0EAA0E;gBAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAC1C,KAAK,CAAC,GAAG,EACT,MAAM,EACN,YAAY,CAAC,UAAU,CAAC,KAAK,CAC9B,CAAA;gBACD,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;aAClC;SACF;QAED,uCAAuC;QACvC,wBAAwB,CAAC,yBAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC3D,CAAC;CACF;AAjGD,gCAiGC"}

package/config/index.d.ts

@@ -191,7 +191,7 @@ export declare const BaseSettings: {
         readonly description: "Maximum amount of characters that the common part of the cache key or feed ID can have";
         readonly type: "number";
         readonly default: 300;
-        readonly validate: (value?: number) => "MAX_COMMON_KEY_SIZE must be a number between 150 and 500" | undefined;
+        readonly validate: (value?: number | undefined) => "MAX_COMMON_KEY_SIZE must be a number between 150 and 500" | undefined;
     };
     readonly REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
         readonly description: "Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter";

package/examples/bank-frick/config/index.d.ts

@@ -6,7 +6,7 @@ export declare const customSettings: {
         readonly type: "number";
         readonly required: false;
         readonly default: 500;
-        readonly validate: (value?: number) => string | undefined;
+        readonly validate: (value?: number | undefined) => string | undefined;
     };
     readonly PRIVATE_KEY: {
         readonly description: "";

package/examples/coingecko/batch-warming.d.ts

@@ -0,0 +1,7 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const batchEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../config").SettingsMap>;
+export {};

package/examples/coingecko/batch-warming.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batchEndpoint = void 0;
+const adapter_1 = require("../../adapter");
+const batch_warming_1 = require("../../transports/batch-warming");
+const DEFAULT_URL = 'https://pro-api.coingecko.com/api/v3';
+const inputParameters = {
+    coinid: {
+        description: 'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
+        required: false,
+    },
+    base: {
+        aliases: ['from', 'coin'],
+        description: 'The symbol or array of symbols of the currency to query',
+        required: true,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
+const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
+    prepareRequest: (params, context) => {
+        return {
+            baseURL: DEFAULT_URL,
+            url: '/simple/price',
+            method: 'GET',
+            params: {
+                ids: [...new Set(params.map((p) => p.base))].join(','),
+                vs_currencies: [...new Set(params.map((p) => p.quote))].join(','),
+                x_cg_pro_api_key: context.adapterConfig.API_KEY,
+            },
+        };
+    },
+    parseResponse: (res) => {
+        const entries = [];
+        for (const [base, entry] of Object.entries(res.data)) {
+            for (const [quote, price] of Object.entries(entry)) {
+                entries.push({
+                    params: { base, quote },
+                    value: price,
+                });
+            }
+        }
+        return entries;
+    },
+});
+exports.batchEndpoint = new adapter_1.AdapterEndpoint({
+    name: 'batch',
+    transport: batchEndpointTransport,
+    inputParameters,
+});
+//# sourceMappingURL=batch-warming.js.map

package/examples/coingecko/batch-warming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-warming.js","sourceRoot":"","sources":["../../../../src/examples/coingecko/batch-warming.ts"],"names":[],"mappings":";;;AACA,2CAA+D;AAC/D,kEAAsE;AAItE,MAAM,WAAW,GAAG,sCAAsC,CAAA;AAO1D,MAAM,eAAe,GAAoB;IACvC,MAAM,EAAE;QACN,WAAW,EACT,8IAA8I;QAChJ,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;QACzB,WAAW,EAAE,yDAAyD;QACtE,QAAQ,EAAE,IAAI;KACf;IACD,KAAK,EAAE;QACL,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC;QACzB,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE,IAAI;KACf;CACF,CAAA;AAYD,MAAM,sBAAsB,GAAG,IAAI,qCAAqB,CAAC;IACvD,cAAc,EAAE,CACd,MAA8B,EAC9B,OAAuB,EACkB,EAAE;QAC3C,OAAO;YACL,OAAO,EAAE,WAAW;YACpB,GAAG,EAAE,eAAe;YACpB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,GAAG,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACtD,aAAa,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACjE,gBAAgB,EAAE,OAAO,CAAC,aAAa,CAAC,OAAO;aAChD;SACF,CAAA;IACH,CAAC;IACD,aAAa,EAAE,CACb,GAAwC,EACA,EAAE;QAC1C,MAAM,OAAO,GAAG,EAA4C,CAAA;QAC5D,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACpD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAClD,OAAO,CAAC,IAAI,CAAC;oBACX,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;oBACvB,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;aACH;SACF;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF,CAAC,CAAA;AAEW,QAAA,aAAa,GAAG,IAAI,yBAAe,CAAC;IAC/C,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,sBAAsB;IACjC,eAAe;CAChB,CAAC,CAAA"}

package/examples/coingecko/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/coingecko/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adapter = void 0;
+const adapter_1 = require("../../adapter");
+const batch_warming_1 = require("./batch-warming");
+const rest_1 = require("./rest");
+exports.adapter = new adapter_1.Adapter({
+    name: 'coingecko',
+    defaultEndpoint: 'batch',
+    endpoints: [rest_1.restEndpoint, batch_warming_1.batchEndpoint],
+});
+//# sourceMappingURL=index.js.map

package/examples/coingecko/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/examples/coingecko/index.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AACvC,mDAA+C;AAC/C,iCAAqC;AAExB,QAAA,OAAO,GAAG,IAAI,iBAAO,CAAC;IACjC,IAAI,EAAE,WAAW;IACjB,eAAe,EAAE,OAAO;IACxB,SAAS,EAAE,CAAC,mBAAY,EAAE,6BAAa,CAAC;CACzC,CAAC,CAAA"}

package/examples/coingecko/rest.d.ts

@@ -0,0 +1,12 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+export declare const restEndpoint: AdapterEndpoint<AdapterRequestParams, ProviderResponseBody, import("../../config").SettingsMap>;
+export {};