@chainlink/external-adapter-framework 0.0.67 → 0.0.69

package/validation/validator.js

@@ -0,0 +1,303 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validator = void 0;
+const error_1 = require("./error");
+const input_params_1 = require("./input-params");
+const util_1 = require("../util");
+const preset_tokens_json_1 = __importDefault(require("./preset-tokens.json"));
+// Don't want to get requester in just yet, only copying the static method 'errored'
+const requesterErrored = (jobRunID = '1', error = undefined, statusCode = 500, feedID = undefined) => {
+    if (error instanceof error_1.AdapterError) {
+        error.jobRunID = jobRunID;
+        if (feedID) {
+            error.feedID = feedID;
+        }
+        return error.toJSONResponse();
+    }
+    if (error instanceof Error) {
+        return new error_1.AdapterError({
+            jobRunID,
+            statusCode,
+            message: error.message,
+            cause: error,
+            feedID,
+        }).toJSONResponse();
+    }
+    return new error_1.AdapterError({ jobRunID, statusCode, message: error, feedID }).toJSONResponse();
+};
+class Validator {
+    constructor(input = { id: '1', data: {} }, inputConfigs = {}, inputOptions = {}, validatorOptions = {}) {
+        // OverrideSymbol = (adapter: string, symbol?: string | string[]): string | string[] => {
+        //   Const defaultSymbol = symbol || this.validated.data.base
+        //   If (!defaultSymbol) this.throwInvalid(`Required parameter not supplied: base`)
+        //   // TODO: Will never be reached, because the presetSymbols are used as default overrides
+        //   If (!this.validated.overrides) return defaultSymbol
+        //   If (!Array.isArray(defaultSymbol))
+        //     Return (
+        //       This.validated.overrides.get(adapter.toLowerCase())?.get(defaultSymbol.toLowerCase()) ||
+        //       DefaultSymbol
+        //     )
+        //   Const multiple: string[] = []
+        //   For (const sym of defaultSymbol) {
+        //     Const overrided = this.validated.overrides.get(adapter.toLowerCase())?.get(sym.toLowerCase())
+        //     If (!overrided) multiple.push(sym)
+        //     Else multiple.push(overrided)
+        //   }
+        //   Return multiple
+        // }
+        // OverrideToken = (symbol: string, network = 'ethereum'): string | undefined => {
+        //   Return this.validated.tokenOverrides?.get(network.toLowerCase())?.get(symbol.toLowerCase())
+        // }
+        // OverrideIncludes = (from: string, to: string): IncludePair | undefined => {
+        //   // Search through `presetIncludes` to find matching override for adapter and to/from pairing.
+        //   Const pairs = (
+        //     This.validated.includes?.filter(
+        //       (val: string | Includes) => typeof val !== 'string',
+        //     ) as Includes[]
+        //   ).filter(
+        //     (pair) =>
+        //       Pair.from.toLowerCase() === from.toLowerCase() &&
+        //       Pair.to.toLowerCase() === to.toLowerCase(),
+        //   )
+        //   If (!pairs || !pairs[0] || !pairs[0].includes || !pairs[0].includes[0]) {
+        //     Return
+        //   }
+        //   Return pairs[0].includes[0]
+        // }
+        // OverrideReverseLookup = (adapter: string, type: OverrideType, symbol: string): string => {
+        //   Const overrides: Map<string, string> | undefined = this.validated?.[type]?.get(
+        //     Adapter.toLowerCase(),
+        //   )
+        //   If (!overrides) return symbol
+        //   Let originalSymbol: string | undefined
+        //   Overrides.forEach((overridden, original) => {
+        //     If (overridden.toLowerCase() === symbol.toLowerCase()) originalSymbol = original
+        //   })
+        //   Return originalSymbol || symbol
+        // }
+        this.formatOverride = (param) => {
+            const _throwInvalid = () => this.throwInvalid(`Parameter supplied with wrong format: "override"`);
+            if (!(0, util_1.isObject)(param)) {
+                _throwInvalid();
+            }
+            const _isValid = Object.values(param).every(util_1.isObject);
+            if (!_isValid) {
+                _throwInvalid();
+            }
+            const _keyToLowerCase = (entry) => {
+                return [entry[0].toLowerCase(), entry[1]];
+            };
+            return new Map(Object.entries(param)
+                .map(_keyToLowerCase)
+                .map(([key, value]) => [key, new Map(Object.entries(value).map(_keyToLowerCase))]));
+        };
+        this.formatIncludeOverrides = (param) => {
+            const _throwInvalid = () => this.throwInvalid(`Parameter supplied with wrong format: "includes"`);
+            if (!(0, util_1.isArray)(param)) {
+                _throwInvalid();
+            }
+            const _isValid = Object.values(param).every((val) => (0, util_1.isObject)(val) || typeof val === 'string');
+            if (!_isValid) {
+                _throwInvalid();
+            }
+            return param;
+        };
+        this.throwInvalid = (message) => {
+            throw new error_1.AdapterError({ jobRunID: this.validated.id, statusCode: 400, message });
+        };
+        this.input = { ...input };
+        if (!this.input.id) {
+            this.input.id = '1';
+        } // TODO Please remove these once "no any" strict typing is enabled
+        if (!this.input.data) {
+            this.input.data = {};
+        }
+        this.inputConfigs = { ...input_params_1.baseInputParameters, ...inputConfigs };
+        this.inputOptions = { ...inputOptions };
+        this.validatorOptions = {
+            shouldThrowError: true,
+            includes: [],
+            overrides: {},
+            ...validatorOptions,
+        };
+        this.validated = { id: this.input.id, data: {} };
+        this.validateInput();
+        this.validateOverrides('overrides', this.validatorOptions.overrides);
+        this.validateOverrides('tokenOverrides', preset_tokens_json_1.default);
+        this.validateIncludeOverrides();
+        this.checkDuplicateInputParams(inputConfigs);
+    }
+    validateInput() {
+        try {
+            for (const key in this.inputConfigs) {
+                this.validateObjectParam(key, this.validatorOptions.shouldThrowError);
+            }
+        }
+        catch (e) {
+            this.parseError(e);
+        }
+    }
+    validateOverrides(path, preset) {
+        try {
+            if (!this.input.data?.[path]) {
+                this.validated[path] = this.formatOverride(preset);
+                return;
+            }
+            this.validated[path] = this.formatOverride({ ...preset, ...this.input.data[path] });
+        }
+        catch (e) {
+            this.parseError(e);
+        }
+    }
+    checkDuplicateInputParams(inputConfig) {
+        let aliases = [];
+        for (const key in inputConfig) {
+            const param = inputConfig[key];
+            if (Array.isArray(param)) {
+                aliases = aliases.concat(param);
+            }
+            else if (typeof inputConfig === 'boolean') {
+                return;
+            }
+            else {
+                aliases.push(key);
+                if (typeof param === 'object' && 'aliases' in param && Array.isArray(param.aliases)) {
+                    aliases = aliases.concat(param.aliases);
+                }
+            }
+        }
+        if (aliases.length !== new Set(aliases).size) {
+            this.throwInvalid('Duplicate Input Aliases');
+        }
+    }
+    validateIncludeOverrides() {
+        try {
+            this.validated.includes = this.formatIncludeOverrides([
+                ...(Array.isArray(this.input.data?.includes) ? this.input.data.includes : []),
+                ...(this.validatorOptions.includes || []),
+            ]);
+        }
+        catch (e) {
+            this.parseError(e);
+        }
+    }
+    parseError(error) {
+        if (!(error instanceof Error)) {
+            return;
+        }
+        const message = 'Error validating input.';
+        if (error instanceof error_1.AdapterError) {
+            this.error = error;
+        }
+        else {
+            this.error = new error_1.AdapterError({
+                jobRunID: this.validated.id,
+                statusCode: 400,
+                message,
+                cause: error,
+            });
+        }
+        this.errored = requesterErrored(this.validated.id, this.error);
+        if (this.validatorOptions.shouldThrowError) {
+            throw this.error;
+        }
+    }
+    validateObjectParam(key, shouldThrowError = true) {
+        const inputConfig = this.inputConfigs[key];
+        const usedKey = this.getUsedKey(key, inputConfig.aliases ?? []);
+        const param = usedKey
+            ? this.input.data[usedKey] ?? inputConfig.default
+            : inputConfig.default;
+        if (shouldThrowError) {
+            const paramIsDefined = !(param === undefined || param === null || param === '');
+            if (inputConfig.required && !paramIsDefined) {
+                this.throwInvalid(`Required parameter ${key} must be non-null and non-empty`);
+            }
+            if (paramIsDefined) {
+                if (inputConfig.type) {
+                    const primitiveTypes = ['boolean', 'number', 'bigint', 'string'];
+                    if (![...primitiveTypes, 'array', 'object'].includes(inputConfig.type)) {
+                        this.throwInvalid(`${key} parameter has unrecognized type ${inputConfig.type}`);
+                    }
+                    if (primitiveTypes.includes(inputConfig.type) && typeof param !== inputConfig.type) {
+                        this.throwInvalid(`${key} parameter must be of type ${inputConfig.type}`);
+                    }
+                    if (inputConfig.type === 'array' && (!Array.isArray(param) || param.length === 0)) {
+                        this.throwInvalid(`${key} parameter must be a non-empty array`);
+                    }
+                    if (inputConfig.type === 'object' &&
+                        (!param ||
+                            Array.isArray(param) ||
+                            typeof param !== inputConfig.type ||
+                            Object.keys(param).length === 0)) {
+                        this.throwInvalid(`${key} parameter must be an object with at least one property`);
+                    }
+                }
+                // If (inputConfig.options) {
+                //   Const tolcase = (o: any) => (typeof o === 'string' ? o.toLowerCase() : o)
+                //   Const formattedOptions = inputConfig.options.map(tolcase)
+                //   Const formattedParam = tolcase(param)
+                //   If (!formattedOptions.includes(formattedParam))
+                //     This.throwInvalid(
+                //       `${key} parameter '${formattedParam}' is not in the set of available options: ${formattedOptions.join(
+                //         ',',
+                //       )}`,
+                //     )
+                // }
+                // For (const dependency of inputConfig.dependsOn ?? []) {
+                //   Const usedDependencyKey = this.getUsedKey(
+                //     Dependency,
+                //     (this.inputConfigs[dependency] as InputParameter).aliases ?? [],
+                //   )
+                //   If (!usedDependencyKey) this.throwInvalid(`${key} dependency ${dependency} not supplied`)
+                // }
+                // For (const exclusive of inputConfig.exclusive ?? []) {
+                //   Const usedExclusiveKey = this.getUsedKey(
+                //     Exclusive,
+                //     (this.inputConfigs[exclusive] as InputParameter).aliases ?? [],
+                //   )
+                //   If (usedExclusiveKey)
+                //     This.throwInvalid(`${key} cannot be supplied concurrently with ${exclusive}`)
+                // }
+            }
+        }
+        this.validated.data[key] = param;
+    }
+    validateOptionalParam(param, key, options) {
+        if (param && options) {
+            if (!Array.isArray(options)) {
+                this.throwInvalid(`Parameter options for ${key} must be of an Array type`);
+            }
+            if (!options.includes(param)) {
+                this.throwInvalid(`${param} is not a supported ${key} option. Must be one of ${options}`);
+            }
+        }
+        this.validated.data[key] = param;
+    }
+    validateRequiredParam(param, key, options) {
+        if (typeof param === 'undefined' || param === '') {
+            this.throwInvalid(`Required parameter not supplied: ${key}`);
+        }
+        if (options) {
+            if (!Array.isArray(options)) {
+                this.throwInvalid(`Parameter options for ${key} must be of an Array type`);
+            }
+            if (!options.includes(param)) {
+                this.throwInvalid(`${param} is not a supported ${key} option. Must be one of ${options.join(' || ')}`);
+            }
+        }
+        this.validated.data[key] = param;
+    }
+    getUsedKey(key, keyArray) {
+        const comparisonArray = [...keyArray];
+        if (!comparisonArray.includes(key)) {
+            comparisonArray.push(key);
+        }
+        const inputParamKeys = Object.keys(this.input.data);
+        return inputParamKeys.find((k) => comparisonArray.includes(k));
+    }
+}
+exports.Validator = Validator;