@chainlink/external-adapter-framework 0.4.0 → 0.5.1

package/validation/error.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdapterCustomError = exports.AdapterConnectionError = exports.AdapterDataProviderError = exports.AdapterTimeoutError = exports.AdapterRateLimitError = exports.AdapterInputError = exports.AdapterError = void 0;
+const constants_1 = require("../metrics/constants");
+class AdapterError extends Error {
+    constructor({ status = 'errored', statusCode = 500, name = 'AdapterError', message = 'There was an unexpected error in the adapter.', cause, url, errorResponse, feedID, providerStatusCode, metricsLabel = constants_1.HttpRequestType.ADAPTER_ERROR, }) {
+        super(message);
+        this.status = status;
+        this.statusCode = statusCode;
+        this.name = name;
+        this.message = message;
+        this.cause = cause;
+        if (url) {
+            this.url = url;
+        }
+        if (feedID) {
+            this.feedID = feedID;
+        }
+        this.errorResponse = errorResponse;
+        this.providerStatusCode = providerStatusCode;
+        this.metricsLabel = metricsLabel;
+    }
+    toJSONResponse() {
+        const showDebugInfo = process.env['NODE_ENV'] === 'development' || process.env['DEBUG'] === 'true';
+        const errorBasic = {
+            name: this.name,
+            message: this.message,
+            url: this.url,
+            errorResponse: this.errorResponse,
+            feedID: this.feedID,
+        };
+        const errorFull = { ...errorBasic, stack: this.stack, cause: this.cause };
+        return {
+            status: this.status,
+            statusCode: this.statusCode,
+            providerStatusCode: this.providerStatusCode,
+            error: showDebugInfo ? errorFull : errorBasic,
+        };
+    }
+}
+exports.AdapterError = AdapterError;
+class AdapterInputError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.INPUT_ERROR });
+    }
+}
+exports.AdapterInputError = AdapterInputError;
+class AdapterRateLimitError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.RATE_LIMIT_ERROR });
+    }
+}
+exports.AdapterRateLimitError = AdapterRateLimitError;
+class AdapterTimeoutError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.TIMEOUT_ERROR });
+    }
+}
+exports.AdapterTimeoutError = AdapterTimeoutError;
+class AdapterDataProviderError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.DP_ERROR });
+    }
+}
+exports.AdapterDataProviderError = AdapterDataProviderError;
+class AdapterConnectionError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.CONNECTION_ERROR });
+    }
+}
+exports.AdapterConnectionError = AdapterConnectionError;
+class AdapterCustomError extends AdapterError {
+    constructor(input) {
+        super({ ...input, metricsLabel: constants_1.HttpRequestType.CUSTOM_ERROR });
+    }
+}
+exports.AdapterCustomError = AdapterCustomError;
+//# sourceMappingURL=error.js.map

package/validation/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/validation/error.ts"],"names":[],"mappings":";;;AAAA,oDAAsD;AAkBtD,MAAa,YAAa,SAAQ,KAAK;IAarC,YAAY,EACV,MAAM,GAAG,SAAS,EAClB,UAAU,GAAG,GAAG,EAChB,IAAI,GAAG,cAAc,EACrB,OAAO,GAAG,+CAA+C,EACzD,KAAK,EACL,GAAG,EACH,aAAa,EACb,MAAM,EACN,kBAAkB,EAClB,YAAY,GAAG,2BAAe,CAAC,aAAa,GACtB;QACtB,KAAK,CAAC,OAAO,CAAC,CAAA;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;SACf;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;SACrB;QACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,cAAc;QACZ,MAAM,aAAa,GACjB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,MAAM,CAAA;QAC9E,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAA;QACD,MAAM,SAAS,GAAG,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAA;QACzE,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;SAC9C,CAAA;IACH,CAAC;CACF;AA7DD,oCA6DC;AAED,MAAa,iBAAkB,SAAQ,YAAY;IACjD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,WAAW,EAAE,CAAC,CAAA;IAChE,CAAC;CACF;AAJD,8CAIC;AACD,MAAa,qBAAsB,SAAQ,YAAY;IACrD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,gBAAgB,EAAE,CAAC,CAAA;IACrE,CAAC;CACF;AAJD,sDAIC;AACD,MAAa,mBAAoB,SAAQ,YAAY;IACnD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,aAAa,EAAE,CAAC,CAAA;IAClE,CAAC;CACF;AAJD,kDAIC;AACD,MAAa,wBAAyB,SAAQ,YAAY;IACxD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,CAAC;CACF;AAJD,4DAIC;AACD,MAAa,sBAAuB,SAAQ,YAAY;IACtD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,gBAAgB,EAAE,CAAC,CAAA;IACrE,CAAC;CACF;AAJD,wDAIC;AACD,MAAa,kBAAmB,SAAQ,YAAY;IAClD,YAAY,KAA4B;QACtC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,2BAAe,CAAC,YAAY,EAAE,CAAC,CAAA;IACjE,CAAC;CACF;AAJD,gDAIC"}

package/validation/index.d.ts

@@ -0,0 +1,5 @@
+import { FastifyReply, FastifyRequest } from 'fastify';
+import { AdapterMiddlewareBuilder } from '../util/request';
+export { InputParameters } from './input-params';
+export declare const validatorMiddleware: AdapterMiddlewareBuilder;
+export declare const errorCatchingMiddleware: (err: Error, req: FastifyRequest, res: FastifyReply) => void;

package/validation/index.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorCatchingMiddleware = exports.validatorMiddleware = void 0;
+const cache_1 = require("../cache");
+const util_1 = require("../metrics/util");
+const util_2 = require("../util");
+const error_1 = require("./error");
+const errorCatcherLogger = (0, util_2.makeLogger)('ErrorCatchingMiddleware');
+const validatorMiddleware = (adapter) => (req, reply, done) => {
+    if (req.headers['content-type'] !== 'application/json') {
+        throw new error_1.AdapterInputError({
+            message: 'Content type not "application/json", returning 400',
+            statusCode: 400,
+        });
+    }
+    if (!req.body) {
+        throw new error_1.AdapterInputError({
+            message: 'Body not present in adapter request, returning 400',
+            statusCode: 400,
+        });
+    }
+    // We can restrict usage of the raw request body everywhere in the framework
+    // by setting its type to EmptyBody, and we cast here (and only here)
+    const requestBody = req.body;
+    // Make endpoints case insensitive
+    const endpointParam = requestBody.endpoint?.toLowerCase() ||
+        requestBody.data?.endpoint?.toLowerCase() ||
+        adapter.defaultEndpoint;
+    if (!endpointParam) {
+        throw new error_1.AdapterInputError({
+            message: `Request body does not specify an endpoint, and there is no default endpoint configured for this adapter.`,
+            statusCode: 400,
+        });
+    }
+    const endpoint = adapter.endpointsMap[endpointParam];
+    if (!endpoint) {
+        throw new error_1.AdapterInputError({
+            message: `Adapter does not have a "${endpointParam}" endpoint.`,
+            statusCode: 404,
+        });
+    }
+    const validatedData = endpoint.validator.validateInput(req.body?.['data']);
+    req.requestContext = {
+        cacheKey: '',
+        data: validatedData,
+        endpointName: endpoint.name,
+    };
+    if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
+        // Add metrics meta which includes feedId to the request
+        // Perform prior to overrides to maintain consistent Feed IDs across adapters
+        const metrics = (0, util_1.getMetricsMeta)({
+            adapterEndpoint: endpoint,
+            adapterConfig: adapter.config,
+        }, validatedData);
+        req.requestContext = { ...req.requestContext, meta: { metrics } };
+    }
+    // Run any request transforms that might have been defined in the adapter.
+    // This is the last time modifications are supposed to happen to the request.
+    adapter.runRequestTransforms(req);
+    // Now that all the transformations have been applied, all that's left is calculating the cache key
+    if (endpoint.cacheKeyGenerator) {
+        let cacheKey;
+        cacheKey = endpoint.cacheKeyGenerator(req.requestContext.data);
+        if (cacheKey.length > adapter.config.MAX_COMMON_KEY_SIZE) {
+            errorCatcherLogger.warn(`Generated custom cache key for adapter request is bigger than the MAX_COMMON_KEY_SIZE and will be truncated`);
+            cacheKey = cacheKey.slice(0, adapter.config.MAX_COMMON_KEY_SIZE);
+        }
+        req.requestContext.cacheKey = cacheKey;
+    }
+    else {
+        req.requestContext.cacheKey = (0, cache_1.calculateCacheKey)({
+            adapterEndpoint: endpoint,
+            adapterConfig: adapter.config,
+        }, req.requestContext.data);
+    }
+    done();
+};
+exports.validatorMiddleware = validatorMiddleware;
+const errorCatchingMiddleware = (err, req, res) => {
+    // Add adapter or generic error to request meta for metrics use
+    // There's a chance we have no request context if there was an error during input validation
+    if (req.requestContext) {
+        req.requestContext.meta = { ...req.requestContext?.meta, error: err };
+    }
+    // Add the request context to the error so that we can check things like incoming params, endpoint, etc
+    const errorWithContext = {
+        requestContext: req.requestContext,
+        ...err,
+    };
+    if (err instanceof error_1.AdapterError) {
+        // We want to log these as warn, because although they are to be expected, NOPs should
+        // Only use "correct" job specs and therefore not hit adapters with invalid requests.
+        errorCatcherLogger.warn(errorWithContext);
+        res.status(err.statusCode).send(err.toJSONResponse());
+    }
+    else {
+        errorCatcherLogger.error(errorWithContext);
+        res.status(500).send(err.message || 'There was an unexpected error in the adapter.');
+    }
+};
+exports.errorCatchingMiddleware = errorCatchingMiddleware;
+//# sourceMappingURL=index.js.map

package/validation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/validation/index.ts"],"names":[],"mappings":";;;AAEA,oCAA4C;AAC5C,0CAAgD;AAChD,kCAAoC;AAEpC,mCAAyD;AAGzD,MAAM,kBAAkB,GAAG,IAAA,iBAAU,EAAC,yBAAyB,CAAC,CAAA;AAEzD,MAAM,mBAAmB,GAC9B,CAAC,OAAgB,EAAE,EAAE,CACrB,CAAC,GAAmB,EAAE,KAAmB,EAAE,IAA6B,EAAE,EAAE;IAC1E,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE;QACtD,MAAM,IAAI,yBAAiB,CAAC;YAC1B,OAAO,EAAE,oDAAoD;YAC7D,UAAU,EAAE,GAAG;SAChB,CAAC,CAAA;KACH;IAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QACb,MAAM,IAAI,yBAAiB,CAAC;YAC1B,OAAO,EAAE,oDAAoD;YAC7D,UAAU,EAAE,GAAG;SAChB,CAAC,CAAA;KACH;IAED,4EAA4E;IAC5E,qEAAqE;IACrE,MAAM,WAAW,GAAG,GAAG,CAAC,IAAqC,CAAA;IAE7D,kCAAkC;IAClC,MAAM,aAAa,GACjB,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE;QACnC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE;QACzC,OAAO,CAAC,eAAe,CAAA;IACzB,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,yBAAiB,CAAC;YAC1B,OAAO,EAAE,0GAA0G;YACnH,UAAU,EAAE,GAAG;SAChB,CAAC,CAAA;KACH;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;IACpD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,yBAAiB,CAAC;YAC1B,OAAO,EAAE,4BAA4B,aAAa,aAAa;YAC/D,UAAU,EAAE,GAAG;SAChB,CAAC,CAAA;KACH;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;IAE1E,GAAG,CAAC,cAAc,GAAG;QACnB,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,QAAQ,CAAC,IAAI;KAC5B,CAAA;IAED,IAAI,OAAO,CAAC,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,4BAA4B,EAAE;QACjF,wDAAwD;QACxD,6EAA6E;QAC7E,MAAM,OAAO,GAAG,IAAA,qBAAc,EAC5B;YACE,eAAe,EAAE,QAAQ;YACzB,aAAa,EAAE,OAAO,CAAC,MAAM;SAC9B,EACD,aAAa,CACd,CAAA;QACD,GAAG,CAAC,cAAc,GAAG,EAAE,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,CAAA;KAClE;IAED,0EAA0E;IAC1E,6EAA6E;IAC7E,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;IAEjC,mGAAmG;IACnG,IAAI,QAAQ,CAAC,iBAAiB,EAAE;QAC9B,IAAI,QAAQ,CAAA;QACZ,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC9D,IAAI,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE;YACxD,kBAAkB,CAAC,IAAI,CACrB,6GAA6G,CAC9G,CAAA;YACD,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAA;SACjE;QACD,GAAG,CAAC,cAAc,CAAC,QAAQ,GAAG,QAAQ,CAAA;KACvC;SAAM;QACL,GAAG,CAAC,cAAc,CAAC,QAAQ,GAAG,IAAA,yBAAiB,EAC7C;YACE,eAAe,EAAE,QAAQ;YACzB,aAAa,EAAE,OAAO,CAAC,MAAM;SAC9B,EACD,GAAG,CAAC,cAAc,CAAC,IAAI,CACxB,CAAA;KACF;IAED,IAAI,EAAE,CAAA;AACR,CAAC,CAAA;AAxFU,QAAA,mBAAmB,uBAwF7B;AAEI,MAAM,uBAAuB,GAAG,CAAC,GAAU,EAAE,GAAmB,EAAE,GAAiB,EAAE,EAAE;IAC5F,+DAA+D;IAC/D,4FAA4F;IAC5F,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG,EAAE,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;KACtE;IAED,uGAAuG;IACvG,MAAM,gBAAgB,GAAG;QACvB,cAAc,EAAE,GAAG,CAAC,cAAc;QAClC,GAAG,GAAG;KACP,CAAA;IAED,IAAI,GAAG,YAAY,oBAAY,EAAE;QAC/B,sFAAsF;QACtF,qFAAqF;QACrF,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACzC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAA;KACtD;SAAM;QACL,kBAAkB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAC1C,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,+CAA+C,CAAC,CAAA;KACrF;AACH,CAAC,CAAA;AAtBY,QAAA,uBAAuB,2BAsBnC"}

package/validation/input-params.d.ts

@@ -0,0 +1,14 @@
+export declare type Override = Map<string, Map<string, string>>;
+export declare type InputParameter = {
+    aliases?: readonly string[];
+    description?: string;
+    type?: 'bigint' | 'boolean' | 'array' | 'number' | 'object' | 'string';
+    required?: boolean;
+    options?: unknown[];
+    default?: unknown;
+    dependsOn?: readonly string[];
+    exclusive?: readonly string[];
+};
+export declare type InputParameters = {
+    [name: string]: InputParameter;
+};

package/validation/input-params.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=input-params.js.map

package/validation/input-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input-params.js","sourceRoot":"","sources":["../../../src/validation/input-params.ts"],"names":[],"mappings":""}

package/validation/input-validator.d.ts

@@ -0,0 +1,16 @@
+import { InputParameters } from './input-params';
+export declare type NormalizedInput = Record<string, unknown>;
+export declare class InputValidator {
+    private readonly inputConfig;
+    private aliases;
+    constructor(inputConfig: InputParameters);
+    validateInput(input: Record<string, unknown>): NormalizedInput;
+    private initializeInputs;
+    private validateInputParamsSchema;
+    private validateRequiredConfig;
+    private validateOptions;
+    private validateTypes;
+    private validateDeps;
+    private getUsedKey;
+    private throwInvalid;
+}

package/validation/input-validator.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputValidator = void 0;
+const error_1 = require("./error");
+const util_1 = require("../util");
+class InputValidator {
+    constructor(inputConfig) {
+        this.inputConfig = inputConfig;
+        this.aliases = {};
+        this.getUsedKey = (allKeys, input) => allKeys.find((k) => input && !(0, util_1.isEmpty)(input[k])) || '';
+        this.throwInvalid = (message) => {
+            throw new error_1.AdapterInputError({ statusCode: 400, message });
+        };
+        this.inputConfig = { ...inputConfig };
+        this.validateInputParamsSchema();
+    }
+    validateInput(input) {
+        const normalized = this.initializeInputs(input);
+        for (const configKey in this.inputConfig) {
+            this.validateRequiredConfig(configKey, normalized);
+            if (!(0, util_1.isEmpty)(normalized[configKey])) {
+                this.validateTypes(configKey, normalized);
+                this.validateOptions(configKey, normalized);
+                this.validateDeps(configKey, normalized);
+            }
+        }
+        return normalized;
+    }
+    initializeInputs(input) {
+        const normalized = {};
+        for (const paramName in this.inputConfig) {
+            const usedKey = this.getUsedKey(this.aliases[paramName], input);
+            normalized[paramName] =
+                !usedKey || (0, util_1.isEmpty)(input[usedKey]) ? this.inputConfig[paramName].default : input[usedKey];
+        }
+        return normalized;
+    }
+    validateInputParamsSchema() {
+        for (const configKey in this.inputConfig) {
+            const config = this.inputConfig[configKey];
+            if (config.required && config.default) {
+                throw new error_1.AdapterInputError({
+                    statusCode: 400,
+                    message: `${configKey} can't be required and have default value`,
+                });
+            }
+            const aliases = [configKey, ...(config.aliases ?? [])];
+            if (aliases.length !== new Set(aliases).size) {
+                throw new error_1.AdapterInputError({
+                    statusCode: 400,
+                    message: `Duplicate aliases`,
+                });
+            }
+            this.aliases[configKey] = aliases;
+            const deps = [...(config.dependsOn ?? []), ...(config.exclusive ?? [])];
+            if (!deps || !deps.length) {
+                continue;
+            }
+            deps.forEach((inputDepKey) => {
+                if (!this.inputConfig[inputDepKey]) {
+                    throw new error_1.AdapterInputError({
+                        statusCode: 400,
+                        message: `Input dependency/exclusive '${inputDepKey}' is missing in input schema`,
+                    });
+                }
+            });
+        }
+    }
+    validateRequiredConfig(configKey, normalized) {
+        if (!this.inputConfig[configKey].required) {
+            return;
+        }
+        if ((0, util_1.isEmpty)(normalized[configKey])) {
+            this.throwInvalid(`Required parameter ${configKey} must be non-null and non-empty`);
+        }
+    }
+    validateOptions(key, normalized) {
+        if (!this.inputConfig[key].options?.length) {
+            return;
+        }
+        if (!this.inputConfig[key].options?.includes(normalized[key])) {
+            this.throwInvalid(`${key} parameter must be one of following options: ${this.inputConfig[key].options?.join(',')}`);
+        }
+    }
+    validateTypes(key, normalized) {
+        const type = this.inputConfig[key].type;
+        if (!type) {
+            return;
+        }
+        if (['array', 'object'].includes(type)) {
+            if (type === 'array' &&
+                (!Array.isArray(normalized[key]) || normalized[key].length === 0)) {
+                this.throwInvalid(`${key} parameter must be a non-empty array`);
+            }
+            if (type === 'object' &&
+                normalized[key] &&
+                (Object.getPrototypeOf(normalized[key]) !== Object.prototype ||
+                    Object.keys(normalized[key]).length === 0)) {
+                this.throwInvalid(`${key} parameter must be an object with at least one property`);
+            }
+            return;
+        }
+        else if (typeof normalized[key] !== type) {
+            this.throwInvalid(`${key} parameter must be of type ${type}`);
+        }
+    }
+    validateDeps(key, normalized) {
+        for (const dependency of this.inputConfig[key].dependsOn ?? []) {
+            const value = normalized[dependency];
+            if ((0, util_1.isEmpty)(value)) {
+                this.throwInvalid(`${key} dependency ${dependency} not supplied`);
+            }
+        }
+        for (const exclusive of this.inputConfig[key].exclusive ?? []) {
+            const value = normalized[exclusive];
+            if (!(0, util_1.isEmpty)(value)) {
+                this.throwInvalid(`${key} cannot be supplied concurrently with ${exclusive}`);
+            }
+        }
+    }
+}
+exports.InputValidator = InputValidator;
+//# sourceMappingURL=input-validator.js.map

package/validation/input-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input-validator.js","sourceRoot":"","sources":["../../../src/validation/input-validator.ts"],"names":[],"mappings":";;;AACA,mCAA2C;AAC3C,kCAAiC;AAIjC,MAAa,cAAc;IAEzB,YAA6B,WAA4B;QAA5B,gBAAW,GAAX,WAAW,CAAiB;QADjD,YAAO,GAAgC,EAAE,CAAA;QAqIzC,eAAU,GAAG,CAAC,OAAiB,EAAE,KAA8B,EAAU,EAAE,CACjF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAEhD,iBAAY,GAAG,CAAC,OAAe,EAAQ,EAAE;YAC/C,MAAM,IAAI,yBAAiB,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;QAC3D,CAAC,CAAA;QAxIC,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,WAAW,EAAE,CAAA;QACrC,IAAI,CAAC,yBAAyB,EAAE,CAAA;IAClC,CAAC;IAED,aAAa,CAAC,KAA8B;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAE/C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;YAClD,IAAI,CAAC,IAAA,cAAO,EAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE;gBACnC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;gBACzC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;gBAC3C,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;aACzC;SACF;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,gBAAgB,CAAC,KAA8B;QACrD,MAAM,UAAU,GAAoB,EAAE,CAAA;QACtC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAA;YAC/D,UAAU,CAAC,SAAS,CAAC;gBACnB,CAAC,OAAO,IAAI,IAAA,cAAO,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC7F;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,yBAAyB;QAC/B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE;YACxC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;YAC1C,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE;gBACrC,MAAM,IAAI,yBAAiB,CAAC;oBAC1B,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,GAAG,SAAS,2CAA2C;iBACjE,CAAC,CAAA;aACH;YAED,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;YACtD,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE;gBAC5C,MAAM,IAAI,yBAAiB,CAAC;oBAC1B,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,mBAAmB;iBAC7B,CAAC,CAAA;aACH;YAED,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAA;YAEjC,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;YACvE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACzB,SAAQ;aACT;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE;oBAClC,MAAM,IAAI,yBAAiB,CAAC;wBAC1B,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE,+BAA+B,WAAW,8BAA8B;qBAClF,CAAC,CAAA;iBACH;YACH,CAAC,CAAC,CAAA;SACH;IACH,CAAC;IAEO,sBAAsB,CAAC,SAAiB,EAAE,UAA2B;QAC3E,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;YACzC,OAAM;SACP;QAED,IAAI,IAAA,cAAO,EAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,sBAAsB,SAAS,iCAAiC,CAAC,CAAA;SACpF;IACH,CAAC;IAEO,eAAe,CAAC,GAAW,EAAE,UAA2B;QAC9D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE;YAC1C,OAAM;SACP;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;YAC7D,IAAI,CAAC,YAAY,CACf,GAAG,GAAG,gDAAgD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,IAAI,CACvF,GAAG,CACJ,EAAE,CACJ,CAAA;SACF;IACH,CAAC;IAEO,aAAa,CAAC,GAAW,EAAE,UAA2B;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAA;QACvC,IAAI,CAAC,IAAI,EAAE;YACT,OAAM;SACP;QAED,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACtC,IACE,IAAI,KAAK,OAAO;gBAChB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAK,UAAU,CAAC,GAAG,CAAe,CAAC,MAAM,KAAK,CAAC,CAAC,EAChF;gBACA,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,sCAAsC,CAAC,CAAA;aAChE;YACD,IACE,IAAI,KAAK,QAAQ;gBACjB,UAAU,CAAC,GAAG,CAAC;gBACf,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,SAAS;oBAC1D,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAW,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EACtD;gBACA,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,yDAAyD,CAAC,CAAA;aACnF;YACD,OAAM;SACP;aAAM,IAAI,OAAO,UAAU,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,8BAA8B,IAAI,EAAE,CAAC,CAAA;SAC9D;IACH,CAAC;IAEO,YAAY,CAAC,GAAW,EAAE,UAA2B;QAC3D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE;YAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;YACpC,IAAI,IAAA,cAAO,EAAC,KAAK,CAAC,EAAE;gBAClB,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,eAAe,UAAU,eAAe,CAAC,CAAA;aAClE;SACF;QAED,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE;YAC7D,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;YACnC,IAAI,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,EAAE;gBACnB,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,yCAAyC,SAAS,EAAE,CAAC,CAAA;aAC9E;SACF;IACH,CAAC;CAQF;AA5ID,wCA4IC"}

package/README.md

@@ -1,102 +0,0 @@
-# EA Framework v3
-
-External adapters and its core framework serve as middleware to facilitate connections between Chainlink Nodes and Data Providers (DP). Their main purpose is threefold:
-
-- Abstract provider specific details, specifically:
-  - Transport (REST, WebSockets, RPC, SSE, etc.)
-  - Authentication (login flows, keys)
-  - Accept normalized request payloads and translate into the provider's interface (this also includes things like symbols/tickers)
-  - Parse provider responses into the desired data points (e.g. price from crypto endpoint)
-- Make the overall system more efficient by using as few resources (e.g. API credits, networking traffic, CPU usage) as possible to fetch data, achieved by features like:
-  - Caching: since DPs update data at various times and a request to their API incurs a certain latency, EAs keep a cache of values to
-    - Provide responses to the Chainlink Nodes as quickly as possible
-    - Communicate with DPs only when necessary
-  - Cache Warming: in order to make as many of the requests to EAs be fulfilled from the cache, EAs fetch values from DPs asynchronously to keep the local ones fresh.
-  - Batching: the CL Node requests feeds individually, but it's common for DPs to provide batch endpoints to get many data points at once. With Batching, EAs keep track of incoming requests and consolidate them into one batched request.
-  - Rate limiting: the EA framework additionally checks request rates (frequency) to make sure they fall within acceptable limits (like quotas for the DP's API, or adjusting based on the NOP's API tier).
-- Perform off chain computations (think aggregations, indexing, or any sort of data processing)
-
-By providing a framework that gives users easy access to those features, we reduce the complexity required for Nodes to communicate with DPs since by using EAs there is only one standardized way to do so, while at the same time optimizing said communication so it's as resource efficient as possible. It also makes internal and external development easier and faster, by serving as a strict guideline to implement and add new providers.
-
-## Qs
-
-- Store entire response in cache?
-- Check for valid result in adapter response?
-
-## Env vars
-
-These are all existing env vars, marked DONE if they have been ported to this version, or N/A if the new version disregards them altogether.
-
-| Name                                       | State | Comments                                                     |
-| :----------------------------------------- | :---: | :----------------------------------------------------------- |
-| ADAPTER_URL                                |   -   |                                                              |
-| API_ENDPOINT                               |   √   |                                                              |
-| API_KEY                                    |   √   |                                                              |
-| API_TIMEOUT                                |   √   | Sets timeout for axios request                               |
-| API_VERBOSE                                |   √   | Does not return verbose on cache hit                         |
-| BASE_URL                                   |   √   |                                                              |
-| CACHE_ENABLED                              |  N/A  | Cache is integral to this fw, not including this for now     |
-| CACHE_KEY_IGNORED_PROPS                    |  N/A  | Not applicable after feed ID generation logic change         |
-| CACHE_KEY_GROUP                            |  N/A  | Grouping cache data is not needed in v3                      |
-| CACHE_MAX_AGE                              |   √   |                                                              |
-| CACHE_MAX_ITEMS                            |   -   | Should add when replacing obj in local impl with LRU package |
-| CACHE_MIN_AGE                              |   -   | Used for rate limiting                                       |
-| CACHE_REDIS_CONNECTION_TIMEOUT             |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_HOST                           |   √   |                                                              |
-| CACHE_REDIS_MAX_QUEUED_ITEMS               |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_MAX_RECONNECT_COOLDOWN         |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_PASSWORD                       |   √   |                                                              |
-| CACHE_REDIS_PATH                           |   √   |                                                              |
-| CACHE_REDIS_PORT                           |   √   |                                                              |
-| CACHE_REDIS_TIMEOUT                        |   √   |                                                              |
-| CACHE_REDIS_URL                            |   -   | TODO: Redis                                                  |
-| CACHE_TYPE                                 |   √   |                                                              |
-| CACHE_UPDATE_AGE_ON_GET                    |  N/A  | No longer used in EA currently, apparently                   |
-| DATA_PROVIDER_URL                          |   -   | Legacy var same as ADAPTER_URL                               |
-| DEBUG                                      |   √   |                                                              |
-| DEFAULT_WS_HEARTBEAT_INTERVAL              |  N/A  |                                                              |
-| EA_HOST                                    |   √   |                                                              |
-| EA_PORT                                    |   √   |                                                              |
-| ERROR_CAPACITY                             |   -   | Error backoff is not currently in v3                         |
-| EXPERIMENTAL_METRICS_ENABLED               |   √   | Maintaining for backwards compatibility. Defaults to true    |
-| LOG_LEVEL                                  |       |                                                              |
-| METRICS_ENABLED                            |   √   | Defaults to true                                             |
-| METRICS_NAME                               |   √   |                                                              |
-| METRICS_PORT                               |   √   |                                                              |
-| METRICS_USE_BASE_URL                       |   √   |                                                              |
-| NODE_ENV                                   |       |                                                              |
-| npm_package_version                        |       |                                                              |
-| RATE_LIMIT_API_TIER                        |   √   |                                                              |
-| RATE_LIMIT_CAPACITY                        |   √   | Used for per minute rate limit if exists                     |
-| RATE_LIMIT_CAPACITY_MINUTE                 |   √   | Used for per minute rate limit if exists                     |
-| RATE_LIMIT_CAPACITY_SECOND                 |   √   | Used for per second rate limit if exists                     |
-| RATE_LIMIT_ENABLED                         |  N/A  | Rate limit always enabled in v3                              |
-| RECORD                                     |  N/A  | Not needed in v3 config for integration testing              |
-| REQUEST_COALESCING_ENABLED                 |   √   | Overrides transport config option if set                     |
-| REQUEST_COALESCING_ENTROPY_MAX             |       |                                                              |
-| REQUEST_COALESCING_INTERVAL                |       |                                                              |
-| REQUEST_COALESCING_INTERVAL_COEFFICIENT    |       |                                                              |
-| REQUEST_COALESCING_INTERVAL_MAX            |       |                                                              |
-| REQUEST_COALESCING_MAX_RETRIES             |       |                                                              |
-| RETRY                                      |   -   | Retry mechanism not yet part of v3                           |
-| SERVER_RATE_LIMIT_MAX                      |       |                                                              |
-| SERVER_SLOW_DOWN_AFTER_FACTOR              |       |                                                              |
-| SERVER_SLOW_DOWN_DELAY_MS                  |       |                                                              |
-| TIMEOUT                                    |   X   | API_TIMEOUT is used for same purpose                         |
-| WARMUP_ENABLED                             |       |                                                              |
-| WARMUP_INTERVAL                            |       |                                                              |
-| WARMUP_SUBSCRIPTION_TTL                    |       |                                                              |
-| WARMUP_UNHEALTHY_THRESHOLD                 |       |                                                              |
-| WS_API_ENDPOINT                            |       |                                                              |
-| WS_API_KEY                                 |       |                                                              |
-| WS_CONNECTION_KEY                          |  N/A  | Connection key is no longer used for WS in v3                |
-| WS_CONNECTION_LIMIT                        |       |                                                              |
-| WS_CONNECTION_RETRY_DELAY                  |       |                                                              |
-| WS_CONNECTION_RETRY_LIMIT                  |       |                                                              |
-| WS_CONNECTION_TTL                          |       |                                                              |
-| WS_ENABLED                                 |  N/A  | Shouldn't be part of this fw                                 |
-| WS_SUBSCRIPTION_LIMIT                      |       |                                                              |
-| WS_SUBSCRIPTION_PRIORITY_LIST              |       |                                                              |
-| WS_SUBSCRIPTION_TTL                        |       |                                                              |
-| WS_SUBSCRIPTION_UNRESPONSIVE_TTL           |       |                                                              |
-| WS_TIME_UNTIL_HANDLE_NEXT_MESSAGE_OVERRIDE |       |                                                              |