@chainlink/external-adapter-framework 0.9.0 → 0.10.0

package/adapter/types.d.ts

@@ -1,12 +1,13 @@
+import type EventSource from 'eventsource';
 import Redis from 'ioredis';
-import { AdapterEndpoint } from './endpoint';
-import { CustomSettingsType, SettingsMap, AdapterConfig, BaseAdapterConfig } from '../config';
-import { RequestRateLimiter, BackgroundExecuteRateLimiter, AdapterRateLimitTier } from '../rate-limiting';
-import { Transport } from '../transports';
-import { SubscriptionSetFactory } from '../util';
-import { InputParameters } from '../validation';
 import { Cache } from '../cache';
-import type EventSource from 'eventsource';
+import { AdapterConfig, BaseAdapterConfig, SettingsMap } from '../config';
+import { AdapterRateLimitTier, BackgroundExecuteRateLimiter, RequestRateLimiter } from '../rate-limiting';
+import { Transport, TransportGenerics } from '../transports';
+import { AdapterRequest, SubscriptionSetFactory } from '../util';
+import { InputParameters } from '../validation';
+import { Adapter } from './basic';
+import { AdapterEndpoint } from './endpoint';
 export declare type CustomAdapterSettings = SettingsMap & NegatedAdapterSettings;
 declare type NegatedAdapterSettings = {
     [K in keyof BaseAdapterConfig]?: never;
@@ -32,11 +33,13 @@ export interface AdapterDependencies {
  * 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>;
+export interface EndpointContext<T extends EndpointGenerics> {
+    /** Endpoint name */
+    endpointName: string;
+    /** Input parameters for this endpoint */
+    inputParameters: InputParameters;
     /** Initialized config for the adapter that the Transport can access */
-    adapterConfig: AdapterConfig<CustomSettings>;
+    adapterConfig: AdapterConfig<T['CustomSettings']>;
 }
 /**
  * Structure to describe rate limits specs for the Adapter
@@ -45,12 +48,24 @@ export interface AdapterRateLimitingConfig {
     /** Adapter rate limits, gotten from the specific tier requested */
     tiers: Record<string, AdapterRateLimitTier>;
 }
+/**
+ * Type to perform arbitrary modifications on an adapter request
+ */
+export declare type RequestTransform = (req: AdapterRequest) => void;
+/**
+ * Map of overrides objects (symbol -\> symbol) per adapter name
+ */
+export declare type Overrides = {
+    [adapterName: string]: {
+        [symbol: string]: string;
+    };
+};
 /**
  * Main structure of an External Adapter
  */
 export interface AdapterParams<CustomSettings extends SettingsMap> {
     /** Name of the adapter */
-    name: string;
+    name: Uppercase<string>;
     /** If present, the string that will be used for requests with no specified endpoint */
     defaultEndpoint?: string;
     /**
@@ -62,7 +77,7 @@ export interface AdapterParams<CustomSettings extends SettingsMap> {
      * 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>[];
+    endpoints: AdapterEndpoint<any>[];
     /** 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) */
@@ -71,6 +86,10 @@ export interface AdapterParams<CustomSettings extends SettingsMap> {
     rateLimiting?: AdapterRateLimitingConfig;
     /** Overrides for converting the 'base' parameter that are hardcoded into the adapter. */
     overrides?: Record<string, string>;
+    /** Transforms that will apply to the request before submitting it through the adapter request flow */
+    requestTransforms?: RequestTransform[];
+    /** Bootstrap function that will run when initializing the adapter */
+    bootstrap?: (adapter: Adapter<CustomSettings>) => Promise<void>;
 }
 /**
  * Structure to describe rate limits specs for a specific adapter endpoint
@@ -83,19 +102,25 @@ export interface EndpointRateLimitingConfig {
      */
     allocationPercentage: number;
 }
+/**
+ * Helper type structure that contains the different types passed to the generic parameters of an AdapterEndpoint
+ */
+export declare type EndpointGenerics = TransportGenerics;
 /**
  * Structure to describe a specific endpoint in an [[Adapter]]
  */
-export interface AdapterEndpointParams<Params, Result, CustomSettings extends SettingsMap> {
+export interface AdapterEndpointParams<T extends EndpointGenerics> {
     /** 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>;
+    transport: Transport<T>;
     /** 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;
+    /** Custom function that generates cache keys */
+    cacheKeyGenerator?: (data: Record<string, unknown>) => string;
 }
 export {};

package/background-executor.js

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.callBackgroundExecutes = void 0;
-const util_1 = require("./util");
 const metrics = __importStar(require("./metrics"));
+const util_1 = require("./util");
 const logger = (0, util_1.makeLogger)('BackgroundExecutor');
 /**
  * Very simple background loop that will call the [[Transport.backgroundExecute]] functions in all Transports.
@@ -47,14 +47,16 @@ async function callBackgroundExecutes(adapter, apiShutdownPromise) {
             clearTimeout(timeoutsMap[endpointName]);
         }
     });
-    for (const endpoint of adapter.endpoints) {
-        const backgroundExecute = endpoint.transport.backgroundExecute?.bind(endpoint.transport);
+    // Checks if an individual transport has a backgroundExecute function, and executes it if it does
+    const callBackgroundExecute = (endpoint, transport) => {
+        const backgroundExecute = transport.backgroundExecute?.bind(transport);
         if (!backgroundExecute) {
             logger.debug(`Endpoint "${endpoint.name}" has no background execute, skipping...`);
-            continue;
+            return;
         }
         const context = {
-            adapterEndpoint: endpoint,
+            endpointName: endpoint.name,
+            inputParameters: endpoint.inputParameters,
             adapterConfig: adapter.config,
         };
         const handler = async () => {
@@ -76,6 +78,20 @@ async function callBackgroundExecutes(adapter, apiShutdownPromise) {
         };
         // Start recursive async calls
         handler();
+    };
+    for (const endpoint of adapter.endpoints) {
+        const { transport } = endpoint;
+        // Check if transport is a MetaTransport by casting and checking a known property (transports)
+        const castMeta = transport;
+        if (castMeta.transports) {
+            logger.debug(`Encountered MetaTransport ${transport.constructor.name}, calling backgroundExecute on all transports`);
+            for (const nestedTransport of Object.values(castMeta.transports)) {
+                callBackgroundExecute(endpoint, nestedTransport);
+            }
+        }
+        else {
+            callBackgroundExecute(endpoint, transport);
+        }
     }
 }
 exports.callBackgroundExecutes = callBackgroundExecutes;

package/background-executor.js.map

@@ -1 +1 @@
-{"version":3,"file":"background-executor.js","sourceRoot":"","sources":["../../src/background-executor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iCAAmC;AACnC,mDAAoC;AAEpC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAE/C;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,OAAgB,EAAE,kBAAkC;IAC/F,uFAAuF;IACvF,4FAA4F;IAC5F,IAAI,YAAY,GAAG,KAAK,CAAA;IACxB,MAAM,WAAW,GAEb,EAAE,CAAA;IAEN,kBAAkB,EAAE,IAAI,CAAC,GAAG,EAAE;QAC5B,YAAY,GAAG,IAAI,CAAA;QACnB,KAAK,MAAM,YAAY,IAAI,WAAW,EAAE;YACtC,MAAM,CAAC,KAAK,CAAC,kCAAkC,YAAY,GAAG,CAAC,CAAA;YAC/D,WAAW,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAA;YACjC,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAA;SACxC;IACH,CAAC,CAAC,CAAA;IAEF,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE;QACxC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QACxF,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,CAAC,KAAK,CAAC,aAAa,QAAQ,CAAC,IAAI,0CAA0C,CAAC,CAAA;YAClF,SAAQ;SACT;QAED,MAAM,OAAO,GAAmB;YAC9B,eAAe,EAAE,QAAQ;YACzB,aAAa,EAAE,OAAO,CAAC,MAAM;SAC9B,CAAA;QAED,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;YACzB,IAAI,YAAY,EAAE;gBAChB,MAAM,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAA;gBAChF,OAAM;aACP;YACD,qDAAqD;YACrD,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;YAEhE,2EAA2E;YAC3E,MAAM,YAAY,GAAG,OAAO,CAAC,wBAAwB;iBAClD,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;iBACnC,UAAU,EAAE,CAAA;YAEf,MAAM,CAAC,KAAK,CAAC,4CAA4C,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAA;YAC1E,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAA;YACnD,MAAM,CAAC,KAAK,CACV,6CAA6C,QAAQ,CAAC,IAAI,mBAAmB,UAAU,IAAI,CAC5F,CAAA;YAED,YAAY,EAAE,CAAA;YACd,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAC9D,CAAC,CAAA;QAED,8BAA8B;QAC9B,OAAO,EAAE,CAAA;KACV;AACH,CAAC;AAvDD,wDAuDC"}
+{"version":3,"file":"background-executor.js","sourceRoot":"","sources":["../../src/background-executor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,mDAAoC;AAEpC,iCAAmC;AAEnC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAE/C;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,OAAgB,EAAE,kBAAkC;IAC/F,uFAAuF;IACvF,4FAA4F;IAC5F,IAAI,YAAY,GAAG,KAAK,CAAA;IACxB,MAAM,WAAW,GAEb,EAAE,CAAA;IAEN,kBAAkB,EAAE,IAAI,CAAC,GAAG,EAAE;QAC5B,YAAY,GAAG,IAAI,CAAA;QACnB,KAAK,MAAM,YAAY,IAAI,WAAW,EAAE;YACtC,MAAM,CAAC,KAAK,CAAC,kCAAkC,YAAY,GAAG,CAAC,CAAA;YAC/D,WAAW,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAA;YACjC,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAA;SACxC;IACH,CAAC,CAAC,CAAA;IAEF,iGAAiG;IACjG,MAAM,qBAAqB,GAAG,CAC5B,QAA2C,EAC3C,SAAuC,EACvC,EAAE;QACF,MAAM,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QACtE,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,CAAC,KAAK,CAAC,aAAa,QAAQ,CAAC,IAAI,0CAA0C,CAAC,CAAA;YAClF,OAAM;SACP;QAED,MAAM,OAAO,GAAsC;YACjD,YAAY,EAAE,QAAQ,CAAC,IAAI;YAC3B,eAAe,EAAE,QAAQ,CAAC,eAAe;YACzC,aAAa,EAAE,OAAO,CAAC,MAAM;SAC9B,CAAA;QAED,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;YACzB,IAAI,YAAY,EAAE;gBAChB,MAAM,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAA;gBAChF,OAAM;aACP;YACD,qDAAqD;YACrD,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;YAEhE,2EAA2E;YAC3E,MAAM,YAAY,GAAG,OAAO,CAAC,wBAAwB;iBAClD,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;iBACnC,UAAU,EAAE,CAAA;YAEf,MAAM,CAAC,KAAK,CAAC,4CAA4C,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAA;YAC1E,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAA;YACnD,MAAM,CAAC,KAAK,CACV,6CAA6C,QAAQ,CAAC,IAAI,mBAAmB,UAAU,IAAI,CAC5F,CAAA;YAED,YAAY,EAAE,CAAA;YACd,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QAC9D,CAAC,CAAA;QAED,8BAA8B;QAC9B,OAAO,EAAE,CAAA;IACX,CAAC,CAAA;IAED,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE;QACxC,MAAM,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAA;QAE9B,8FAA8F;QAC9F,MAAM,QAAQ,GAAG,SAA6C,CAAA;QAC9D,IAAI,QAAQ,CAAC,UAAU,EAAE;YACvB,MAAM,CAAC,KAAK,CACV,6BAA6B,SAAS,CAAC,WAAW,CAAC,IAAI,+CAA+C,CACvG,CAAA;YACD,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;gBAChE,qBAAqB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;aACjD;SACF;aAAM;YACL,qBAAqB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;SAC3C;KACF;AACH,CAAC;AA7ED,wDA6EC"}

package/cache/index.d.ts

@@ -1,9 +1,9 @@
-import { AdapterEndpoint } from '../adapter';
 import { AdapterConfig, SettingsMap } from '../config';
-import { AdapterMiddlewareBuilder, AdapterResponse, sleep } from '../util';
+import { AdapterResponse, sleep } from '../util';
+import { InputParameters } from '../validation/input-params';
+export * from './factory';
 export * from './local';
 export * from './redis';
-export * from './factory';
 /**
  * An object describing an entry in the cache.
  * @typeParam T - the type of the entry's value
@@ -49,13 +49,14 @@ export interface Cache<T = unknown> {
      */
     delete: (key: string) => Promise<void>;
 }
-export declare const calculateCacheKey: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
+export declare const calculateCacheKey: <T extends import("../transports").TransportGenerics>({ endpointName, inputParameters, adapterConfig, }: {
+    inputParameters: InputParameters;
+    endpointName: string;
+    adapterConfig: AdapterConfig<T["CustomSettings"]>;
 }, data: unknown) => string;
-export declare const calculateFeedId: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
+export declare const calculateFeedId: <T extends import("../transports").TransportGenerics>({ inputParameters, adapterConfig, }: {
+    inputParameters: InputParameters;
+    adapterConfig: AdapterConfig<T["CustomSettings"]>;
 }, data: unknown) => string;
 /**
  * Calculates a unique key from the provided data.
@@ -71,6 +72,7 @@ export declare const calculateFeedId: <Params, Result, CustomSettings extends Se
  * ```
  */
 export declare const calculateKey: <CustomSettings extends SettingsMap>(data: unknown, paramNames: string[], adapterConfig: AdapterConfig<CustomSettings>) => string;
+export declare const calculateStaleness: (expirationTimestamp: number | undefined, ttl: number) => number;
 /**
  * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
  * amount of retries is exceeded, it returns undefined instead.
@@ -84,11 +86,3 @@ export declare const pollResponseFromCache: (cache: Cache<AdapterResponse>, key:
     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/cache/index.js

@@ -10,43 +10,30 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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;
+exports.pollResponseFromCache = exports.calculateStaleness = exports.calculateKey = exports.calculateFeedId = exports.calculateCacheKey = void 0;
 const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
+__exportStar(require("./factory"), exports);
 __exportStar(require("./local"), exports);
 __exportStar(require("./redis"), exports);
-__exportStar(require("./factory"), 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);
+const calculateCacheKey = ({ endpointName, inputParameters, adapterConfig, }, data) => {
+    const paramNames = Object.keys(inputParameters);
     if (paramNames.length === 0) {
         logger.trace(`Using default cache key ${adapterConfig.DEFAULT_CACHE_KEY}`);
         return adapterConfig.DEFAULT_CACHE_KEY;
     }
-    const cacheKey = `${adapterEndpoint.name}-${(0, exports.calculateKey)(data, paramNames, adapterConfig)}`;
+    const cacheKey = `${endpointName}-${(0, exports.calculateKey)(data, paramNames, adapterConfig)}`;
     logger.trace(`Generated cache key for request: "${cacheKey}"`);
     return cacheKey;
 };
 exports.calculateCacheKey = calculateCacheKey;
-const calculateFeedId = ({ adapterEndpoint, adapterConfig, }, data) => {
-    const paramNames = Object.keys(adapterEndpoint.inputParameters);
+const calculateFeedId = ({ inputParameters, adapterConfig, }, data) => {
+    const paramNames = Object.keys(inputParameters);
     if (paramNames.length === 0) {
         logger.trace(`Cannot generate Feed ID without input parameters`);
         return 'N/A';
@@ -74,10 +61,6 @@ const calculateKey = (data, paramNames, adapterConfig) => {
     const params = data;
     let cacheKey = '';
     for (const paramName of paramNames) {
-        // Ignore overrides param when generating cache keys
-        if (paramName === 'overrides') {
-            continue;
-        }
         const param = params[paramName];
         if (param === undefined) {
             continue;
@@ -104,7 +87,7 @@ const calculateKey = (data, paramNames, adapterConfig) => {
     return cacheKey;
 };
 exports.calculateKey = calculateKey;
-// Calculate the amount of time the non-expired entry has been in the cache
+// Calculate the amount of time a non-expired entry has been in the cache
 const calculateStaleness = (expirationTimestamp, ttl) => {
     if (expirationTimestamp) {
         const createTimestamp = expirationTimestamp - ttl;
@@ -116,6 +99,7 @@ const calculateStaleness = (expirationTimestamp, ttl) => {
         return ttl;
     }
 };
+exports.calculateStaleness = calculateStaleness;
 /**
  * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
  * amount of retries is exceeded, it returns undefined instead.
@@ -146,30 +130,4 @@ const pollResponseFromCache = async (cache, key, options, retry = 0) => {
     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;
 //# sourceMappingURL=index.js.map

package/cache/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,kCAMgB;AAChB,wDAAyC;AAEzC,0CAAuB;AACvB,0CAAuB;AACvB,4CAAyB;AAEzB,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,OAAO,CAAC,CAAA;AAoDlC,gGAAgG;AACzF,MAAM,iBAAiB,GAAG,CAC/B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAA;IAC/D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,2BAA2B,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAC1E,OAAO,aAAa,CAAC,iBAAiB,CAAA;KACvC;IACD,MAAM,QAAQ,GAAG,GAAG,eAAe,CAAC,IAAI,IAAI,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAA;IAC3F,MAAM,CAAC,KAAK,CAAC,qCAAqC,QAAQ,GAAG,CAAC,CAAA;IAC9D,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAlBY,QAAA,iBAAiB,qBAkB7B;AAEM,MAAM,eAAe,GAAG,CAC7B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAA;IAC/D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,OAAO,KAAK,CAAA;KACb;IACD,OAAO,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,CAAA;AACtD,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B;AAED;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAC1B,IAAa,EACb,UAAoB,EACpB,aAA4C,EACpC,EAAE;IACV,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,MAAM,MAAM,GAAG,IAA+B,CAAA;IAE9C,IAAI,QAAQ,GAAG,EAAE,CAAA;IACjB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAClC,oDAAoD;QACpD,IAAI,SAAS,KAAK,WAAW,EAAE;YAC7B,SAAQ;SACT;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,SAAQ;SACT;QAED,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAA;QAC5B,QAAQ,OAAO,KAAK,EAAE;YACpB,KAAK,QAAQ;gBACX,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA;gBAC/B,MAAK;YACP,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACZ,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAA;gBAC5B,MAAK;YACP,KAAK,QAAQ;gBACX,0EAA0E;gBAC1E,mEAAmE;gBACnE,MAAM,CAAC,KAAK,CACV,aAAa,SAAS,8EAA8E,CACrG,CAAA;SACJ;KACF;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,mBAAmB,EAAE;QACvD,MAAM,CAAC,IAAI,CACT,sGAAsG,CACvG,CAAA;QACD,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;KAChE;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAhDY,QAAA,YAAY,gBAgDxB;AAED,2EAA2E;AAC3E,MAAM,kBAAkB,GAAG,CAAC,mBAAuC,EAAE,GAAW,EAAU,EAAE;IAC1F,IAAI,mBAAmB,EAAE;QACvB,MAAM,eAAe,GAAG,mBAAmB,GAAG,GAAG,CAAA;QACjD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,GAAG,IAAI,CAAA;KAC7C;SAAM;QACL,0EAA0E;QAC1E,uCAAuC;QACvC,OAAO,GAAG,CAAA;KACX;AACH,CAAC,CAAA;AAED;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,KAA6B,EAC7B,GAAW,EACX,OAGC,EACD,KAAK,GAAG,CAAC,EAC6B,EAAE;IACxC,IAAI,KAAK,GAAG,OAAO,CAAC,UAAU,EAAE;QAC9B,iFAAiF;QACjF,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACjD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;IAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACrC,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QACvC,OAAO,QAAQ,CAAA;KAChB;IAED,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,EAAE;QAC5B,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACpD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,OAAO,CAAC,KAAK,kBAAkB,CAAC,CAAA;IAC7E,MAAM,IAAA,YAAK,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE1B,OAAO,IAAA,6BAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;AAC9D,CAAC,CAAA;AA/BY,QAAA,qBAAqB,yBA+BjC;AAED;;;;;;GAMG;AACI,MAAM,oBAAoB,GAC/B,CAAC,OAAgB,EAAE,EAAE,CAAC,KAAK,EAAE,GAAmB,EAAE,GAAiB,EAAE,EAAE;IACrE,MAAM,QAAQ,GAAG,MAAO,OAAO,CAAC,YAAY,CAAC,KAAgC,CAAC,GAAG,CAC/E,GAAG,CAAC,cAAc,CAAC,QAAQ,CAC5B,CAAA;IAED,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACvD,IAAI,OAAO,CAAC,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;YACjF,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAC1C,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EACjD,OAAO,CAAC,MAAM,CAAC,UAAU,CAC1B,CAAA;YAED,uDAAuD;YACvD,MAAM,SAAS,GAAG,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;YACnF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YACxD,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG;gBACxB,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI;gBAC1B,OAAO,EAAE,EAAE,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;aACjE,CAAA;SACF;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;KAC1B;IAED,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAA;AAC3E,CAAC,CAAA;AA3BU,QAAA,oBAAoB,wBA2B9B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,kCAA4D;AAG5D,4CAAyB;AACzB,0CAAuB;AACvB,0CAAuB;AAEvB,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,OAAO,CAAC,CAAA;AAoDlC,gGAAgG;AACzF,MAAM,iBAAiB,GAAG,CAC/B,EACE,YAAY,EACZ,eAAe,EACf,aAAa,GAKd,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC/C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,2BAA2B,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAC1E,OAAO,aAAa,CAAC,iBAAiB,CAAA;KACvC;IACD,MAAM,QAAQ,GAAG,GAAG,YAAY,IAAI,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAA;IACnF,MAAM,CAAC,KAAK,CAAC,qCAAqC,QAAQ,GAAG,CAAC,CAAA;IAC9D,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AApBY,QAAA,iBAAiB,qBAoB7B;AAEM,MAAM,eAAe,GAAG,CAC7B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC/C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,OAAO,KAAK,CAAA;KACb;IACD,OAAO,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,CAAA;AACtD,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B;AAED;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAC1B,IAAa,EACb,UAAoB,EACpB,aAA4C,EACpC,EAAE;IACV,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,MAAM,MAAM,GAAG,IAA+B,CAAA;IAE9C,IAAI,QAAQ,GAAG,EAAE,CAAA;IACjB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,SAAQ;SACT;QAED,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAA;QAC5B,QAAQ,OAAO,KAAK,EAAE;YACpB,KAAK,QAAQ;gBACX,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA;gBAC/B,MAAK;YACP,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACZ,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAA;gBAC5B,MAAK;YACP,KAAK,QAAQ;gBACX,0EAA0E;gBAC1E,mEAAmE;gBACnE,MAAM,CAAC,KAAK,CACV,aAAa,SAAS,8EAA8E,CACrG,CAAA;SACJ;KACF;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,mBAAmB,EAAE;QACvD,MAAM,CAAC,IAAI,CACT,sGAAsG,CACvG,CAAA;QACD,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;KAChE;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AA5CY,QAAA,YAAY,gBA4CxB;AAED,yEAAyE;AAClE,MAAM,kBAAkB,GAAG,CAChC,mBAAuC,EACvC,GAAW,EACH,EAAE;IACV,IAAI,mBAAmB,EAAE;QACvB,MAAM,eAAe,GAAG,mBAAmB,GAAG,GAAG,CAAA;QACjD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,GAAG,IAAI,CAAA;KAC7C;SAAM;QACL,0EAA0E;QAC1E,uCAAuC;QACvC,OAAO,GAAG,CAAA;KACX;AACH,CAAC,CAAA;AAZY,QAAA,kBAAkB,sBAY9B;AAED;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,KAA6B,EAC7B,GAAW,EACX,OAGC,EACD,KAAK,GAAG,CAAC,EAC6B,EAAE;IACxC,IAAI,KAAK,GAAG,OAAO,CAAC,UAAU,EAAE;QAC9B,iFAAiF;QACjF,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACjD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;IAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACrC,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QACvC,OAAO,QAAQ,CAAA;KAChB;IAED,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,EAAE;QAC5B,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACpD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,OAAO,CAAC,KAAK,kBAAkB,CAAC,CAAA;IAC7E,MAAM,IAAA,YAAK,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE1B,OAAO,IAAA,6BAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;AAC9D,CAAC,CAAA;AA/BY,QAAA,qBAAqB,yBA+BjC"}

package/config/index.d.ts

@@ -3,11 +3,6 @@ export declare const BaseSettings: {
         readonly description: "The URL that certain transports use to retrieve data";
         readonly type: "string";
     };
-    readonly API_KEY: {
-        readonly description: "Default setting for an EA key";
-        readonly type: "string";
-        readonly sensitive: true;
-    };
     readonly API_TIMEOUT: {
         readonly description: "The number of milliseconds a request can be pending before returning a timeout error for data provider request";
         readonly type: "number";
@@ -23,16 +18,31 @@ export declare const BaseSettings: {
         readonly type: "string";
         readonly default: "/";
     };
+    readonly BATCH_TRANSPORT_SETUP_VALIDATION: {
+        readonly description: "Flag to toggle batch transport setup validation";
+        readonly type: "boolean";
+        readonly default: false;
+    };
     readonly CACHE_MAX_AGE: {
         readonly description: "Maximum amount of time (in ms) that a response will stay cached";
         readonly type: "number";
         readonly default: 90000;
     };
+    readonly CACHE_REDIS_CONNECTION_TIMEOUT: {
+        readonly description: "Connection timeout for redis client";
+        readonly type: "number";
+        readonly default: 15000;
+    };
     readonly CACHE_REDIS_HOST: {
         readonly description: "Hostname for the Redis instance to be used";
         readonly type: "string";
         readonly default: "127.0.0.1";
     };
+    readonly CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
+        readonly description: "Max cooldown (in ms) before attempting redis reconnection";
+        readonly type: "number";
+        readonly default: 3000;
+    };
     readonly CACHE_REDIS_PASSWORD: {
         readonly description: "The password required for redis auth";
         readonly type: "string";
@@ -52,6 +62,10 @@ export declare const BaseSettings: {
         readonly type: "number";
         readonly default: 500;
     };
+    readonly CACHE_REDIS_URL: {
+        readonly description: "The URL of the Redis server. Format: [redis[s]:]//[[user][:password@]][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]";
+        readonly type: "string";
+    };
     readonly CACHE_TYPE: {
         readonly description: "The type of cache to use throughout the EA";
         readonly type: "enum";
@@ -127,6 +141,11 @@ export declare const BaseSettings: {
         readonly type: "number";
         readonly default: 0;
     };
+    readonly RETRY: {
+        readonly type: "number";
+        readonly description: "Retry count for failed HTTP requests";
+        readonly default: 1;
+    };
     readonly SSE_SUBSCRIPTION_UPDATE_SLEEP: {
         readonly description: "Maximum amount of time (in ms) between each update to the set of subscribed feeds";
         readonly type: "number";
@@ -151,11 +170,6 @@ export declare const BaseSettings: {
         readonly description: "Override the base websocket URL within the EA.";
         readonly type: "string";
     };
-    readonly WS_API_KEY: {
-        readonly description: "The websocket API key to authenticate with";
-        readonly type: "string";
-        readonly sensitive: true;
-    };
     readonly WS_SUBSCRIPTION_TTL: {
         readonly description: "";
         readonly type: "number";
@@ -208,10 +222,13 @@ export declare const BaseSettings: {
         readonly type: "string";
     };
 };
-export declare const buildAdapterConfig: <CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings>({ overrides, customSettings, }: {
+export declare const buildAdapterConfig: <CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings>({ overrides, customSettings, envVarsPrefix, }: {
     overrides?: Partial<BaseAdapterConfig> | undefined;
     customSettings?: SettingsMap | undefined;
+    envVarsPrefix?: string | undefined;
 }) => AdapterConfig<CustomSettings>;
+export declare const validateAdapterConfig: <CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings>(adapterConfig: AdapterConfig<CustomSettings>, customSettings?: SettingsMap) => void;
+export declare const getEnv: (name: string, config: Setting, prefix?: string) => SettingValueType | null;
 declare type SettingValueType = string | number | boolean;
 declare type SettingType<C extends Setting> = C['type'] extends 'string' ? string : C['type'] extends 'number' ? number : C['type'] extends 'boolean' ? boolean : C['type'] extends 'enum' ? C['options'] extends readonly string[] ? C['options'][number] : never : never;
 declare type BaseSettingsType = typeof BaseSettings;

package/config/index.js

@@ -1,7 +1,6 @@
 "use strict";
-// Import { getRandomRequiredEnv, getRandomEnv, getEnv } from '../util'
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildAdapterConfig = exports.BaseSettings = void 0;
+exports.getEnv = exports.validateAdapterConfig = exports.buildAdapterConfig = exports.BaseSettings = void 0;
 exports.BaseSettings = {
     // V2 compat
     // ADAPTER_URL: {
@@ -12,11 +11,6 @@ exports.BaseSettings = {
         description: 'The URL that certain transports use to retrieve data',
         type: 'string',
     },
-    API_KEY: {
-        description: 'Default setting for an EA key',
-        type: 'string',
-        sensitive: true,
-    },
     API_TIMEOUT: {
         description: 'The number of milliseconds a request can be pending before returning a timeout error for data provider request',
         type: 'number',
@@ -32,6 +26,11 @@ exports.BaseSettings = {
         type: 'string',
         default: '/',
     },
+    BATCH_TRANSPORT_SETUP_VALIDATION: {
+        description: 'Flag to toggle batch transport setup validation',
+        type: 'boolean',
+        default: false,
+    },
     CACHE_MAX_AGE: {
         description: 'Maximum amount of time (in ms) that a response will stay cached',
         type: 'number',
@@ -45,10 +44,11 @@ exports.BaseSettings = {
     //   type: 'number',
     //   default: 30000,
     // },
-    // CACHE_REDIS_CONNECTION_TIMEOUT: {
-    //   type: 'number',
-    //   default: 15000,
-    // },
+    CACHE_REDIS_CONNECTION_TIMEOUT: {
+        description: 'Connection timeout for redis client',
+        type: 'number',
+        default: 15000,
+    },
     CACHE_REDIS_HOST: {
         description: 'Hostname for the Redis instance to be used',
         type: 'string',
@@ -59,10 +59,11 @@ exports.BaseSettings = {
     //   type: 'number',
     //   default: 500,
     // },
-    // CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
-    //   type: 'number',
-    //   default: 3000,
-    // },
+    CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
+        description: 'Max cooldown (in ms) before attempting redis reconnection',
+        type: 'number',
+        default: 3000,
+    },
     CACHE_REDIS_PASSWORD: {
         description: 'The password required for redis auth',
         type: 'string',
@@ -82,9 +83,10 @@ exports.BaseSettings = {
         type: 'number',
         default: 500,
     },
-    // CACHE_REDIS_URL: {
-    //   type: 'string',
-    // },
+    CACHE_REDIS_URL: {
+        description: 'The URL of the Redis server. Format: [redis[s]:]//[[user][:password@]][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]',
+        type: 'string',
+    },
     CACHE_TYPE: {
         description: 'The type of cache to use throughout the EA',
         type: 'enum',
@@ -188,10 +190,11 @@ exports.BaseSettings = {
     //   type: 'number',
     //   default: 5,
     // },
-    // RETRY: {
-    //   type: 'boolean',
-    //   default: 1,
-    // },
+    RETRY: {
+        type: 'number',
+        description: 'Retry count for failed HTTP requests',
+        default: 1,
+    },
     SSE_SUBSCRIPTION_UPDATE_SLEEP: {
         description: 'Maximum amount of time (in ms) between each update to the set of subscribed feeds',
         type: 'number',
@@ -220,11 +223,6 @@ exports.BaseSettings = {
         description: 'Override the base websocket URL within the EA.',
         type: 'string',
     },
-    WS_API_KEY: {
-        description: 'The websocket API key to authenticate with',
-        type: 'string',
-        sensitive: true,
-    },
     WS_SUBSCRIPTION_TTL: {
         description: '',
         type: 'number',
@@ -290,12 +288,11 @@ exports.BaseSettings = {
         type: 'string',
     },
 };
-const buildAdapterConfig = ({ overrides = {}, customSettings = {}, }) => {
-    const validationErrors = [];
+const buildAdapterConfig = ({ overrides = {}, customSettings = {}, envVarsPrefix = '', }) => {
     const vars = {};
     // Iterate base adapter env vars
     for (const [key, config] of Object.entries(exports.BaseSettings)) {
-        const value = getEnv(key, config) ?? overrides?.[key] ?? config.default;
+        const value = (0, exports.getEnv)(key, config, envVarsPrefix) ?? overrides?.[key] ?? config.default;
         vars[key] = value;
     }
     // Iterate custom vars
@@ -303,28 +300,47 @@ const buildAdapterConfig = ({ overrides = {}, customSettings = {}, }) => {
         if (exports.BaseSettings[key]) {
             throw new Error(`Custom env var "${key}" declared, but a base framework env var with that name already exists.`);
         }
-        const value = getEnv(key, config) ?? config.default;
-        // Check if a required setting has been provided
-        if (config.required && value === null) {
-            validationErrors.push(`${key}: Value is required, but none was provided`);
-        }
-        else if (config.validate) {
-            // Cast validate to unknown because TS can't select one of multiple variants of the validate function signature
-            const validationRes = config.validate(value);
-            if (validationRes) {
-                validationErrors.push(`${key}: ${validationRes}`);
-            }
-        }
+        const value = (0, exports.getEnv)(key, config, envVarsPrefix) ?? config.default;
         vars[key] = value;
     }
+    return vars;
+};
+exports.buildAdapterConfig = buildAdapterConfig;
+const validateAdapterConfig = (adapterConfig, customSettings = {}) => {
+    const validationErrors = [];
+    Object.entries(exports.BaseSettings)
+        .concat(Object.entries(customSettings || {}))
+        .forEach(([name, setting]) => {
+        validateSetting(name, adapterConfig[name], setting, validationErrors);
+    });
     if (validationErrors.length > 0) {
         throw new Error(`Validation failed for the following variables:\n ${validationErrors.join('\n')}`);
     }
-    return vars;
 };
-exports.buildAdapterConfig = buildAdapterConfig;
-const getEnv = (name, config) => {
-    const value = process.env[name];
+exports.validateAdapterConfig = validateAdapterConfig;
+const validateSetting = (key, value, config, validationErrors) => {
+    // Check if a required setting has been provided
+    if (config.required && (value === null || value === undefined)) {
+        validationErrors.push(`${key}: Value is required, but none was provided`);
+    }
+    else if (config.validate) {
+        // Cast validate to unknown because TS can't select one of multiple variants of the validate function signature
+        const validationRes = config.validate(value);
+        if (validationRes) {
+            validationErrors.push(`${key}: ${validationRes}`);
+        }
+    }
+};
+const getEnvName = (name, prefix = '') => {
+    const envName = prefix ? `${prefix}_${name}` : name;
+    if (!isEnvNameValid(envName)) {
+        throw new Error(`Invalid environment var name: ${envName}. Only '/^[_a-z0-9]+$/i' is supported.`);
+    }
+    return envName;
+};
+const isEnvNameValid = (name) => /^[_a-z0-9]+$/i.test(name);
+const getEnv = (name, config, prefix = '') => {
+    const value = process.env[getEnvName(name, prefix)];
     if (!value) {
         return null;
     }
@@ -342,4 +358,5 @@ const getEnv = (name, config) => {
             return value;
     }
 };
+exports.getEnv = getEnv;
 //# sourceMappingURL=index.js.map