@chainlink/external-adapter-framework 0.0.6 → 0.0.8

package/package/validation/input-params.d.ts

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

package/package/validation/input-params.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseInputParameters = void 0;
+exports.baseInputParameters = {
+    endpoint: {
+        description: 'The External Adapter "endpoint" name to use.',
+        required: false,
+        type: 'string',
+    },
+    resultPath: {
+        description: 'The path to key into the API response the retrieve the result',
+        required: false,
+        // Type: 'string', TODO: Once multiple types are supported this could be string or array of strings
+    },
+    overrides: {
+        description: 'Override the mapping of token symbols to another token symbol',
+        required: false,
+        // Type: 'string', TODO: Once complex types are supported this could be { [adapter: string]: { [token: string]: string } }
+    },
+    tokenOverrides: {
+        description: 'Override the mapping of token symbols to smart contract address',
+        required: false,
+        // Type: 'string', TODO: Once complex types are supported this could be { [network: string]: { [token: string]: string } }
+    },
+    includes: {
+        description: 'Override the array of includes that holds additional input parameters when matching a pair of symbols',
+        required: false,
+        // Type: 'string', TODO: Once complex types are supported this could be { from: string, to: string, includes: [{ from: string, to: string, adapters: string[], inverse: boolean, tokens: boolean }] } }[]
+    },
+};

package/package/validation/override-functions.d.ts

@@ -0,0 +1,3 @@
+import { InitializedAdapter } from '../adapter';
+import { AdapterRequest } from '../util/request';
+export declare const performSymbolOverrides: (adapter: InitializedAdapter, req: AdapterRequest) => void;

package/package/validation/override-functions.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performSymbolOverrides = void 0;
+const performSymbolOverrides = (adapter, req) => {
+    let adapterOverrides = {};
+    if (req.requestContext.data &&
+        req.requestContext.data['overrides'] &&
+        req.requestContext.data['overrides'][adapter.name]) {
+        adapterOverrides = req.requestContext.data['overrides'][adapter.name];
+    }
+    if (!Array.isArray(req.requestContext.data['base'])) {
+        // Perform overrides specified in the request payload
+        req.requestContext.data['base'] =
+            adapterOverrides[req.requestContext.data['base']] ?? req.requestContext.data['base'];
+        // Perform hardcoded overrides
+        if (adapter.overrides) {
+            req.requestContext.data['base'] =
+                adapter.overrides[req.requestContext.data['base']] ??
+                    req.requestContext.data['base'];
+        }
+        return;
+    }
+    let requestedSymbols = req.requestContext.data['base'];
+    for (let i = 0; i < requestedSymbols.length; i++) {
+        const symbol = requestedSymbols[i];
+        // Perform overrides specified in the request payload
+        let overriddenSymbol = adapterOverrides[symbol.toUpperCase()] ?? adapterOverrides[symbol.toLowerCase()];
+        // Perform hardcoded overrides
+        if (adapter.overrides) {
+            overriddenSymbol =
+                adapter.overrides[symbol.toUpperCase()] ??
+                    adapter.overrides[symbol.toLowerCase()] ??
+                    overriddenSymbol;
+        }
+        requestedSymbols[i] = overriddenSymbol ?? requestedSymbols[i];
+    }
+    requestedSymbols = requestedSymbols.length > 1 ? requestedSymbols : requestedSymbols[1];
+    req.requestContext.data['base'] = requestedSymbols;
+};
+exports.performSymbolOverrides = performSymbolOverrides;

package/package/validation/preset-tokens.json

@@ -0,0 +1,23 @@
+{
+    "ethereum": {
+        "LINK": "0x514910771af9ca656af840dff83e8264ecf986ca",
+        "WETH": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+        "ETH": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+        "stETH": "0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84",
+        "DIGG": "0x798d1be841a82a273720ce31c822c61a67a601c3",
+        "WBTC": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599",
+        "RAI": "0x03ab458634910aad20ef5f1c8ee96f1d6ac54919",
+        "RGT": "0xD291E7a03283640FDc51b121aC401383A46cC623",
+        "RARI": "0xFca59Cd816aB1eaD66534D82bc21E7515cE441CF",
+        "SFI": "0xb753428af26e81097e7fd17f40c88aaa3e04902c",
+        "LDO": "0x5a98fcbea516cf06857215779fd812ca3bef1b32",
+        "VSP": "0x1b40183EFB4Dd766f11bDa7A7c3AD8982e998421",
+        "USDC": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        "USDT": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+        "DAI": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
+        "FRAX": "0x853d955aCEf822Db058eb8505911ED77F175b99e",
+        "BOND": "0x0391d2021f89dc339f60fff84546ea23e337750f",
+        "FEI": "0x956f47f50a910163d8bf957cf5846d573e7f87ca",
+        "TRIBE": "0xc7283b66Eb1EB5FB86327f08e1B5816b0720212B"
+    }
+}

package/package/validation/validator.d.ts

@@ -0,0 +1,47 @@
+import { AdapterError, AdapterErrorResponse } from './error';
+import { InputParameters, Override } from './input-params';
+export declare type OverrideType = 'overrides' | 'tokenOverrides' | 'includes';
+declare type InputType = {
+    id?: string;
+    data?: any;
+};
+export interface ValidatorOptions {
+    shouldThrowError?: boolean;
+    includes?: any[];
+    overrides?: any;
+}
+export declare type IncludePair = {
+    from: string;
+    to: string;
+    adapters?: string[];
+    inverse?: boolean;
+    tokens?: boolean;
+};
+export declare type Includes = {
+    from: string;
+    to: string;
+    includes: IncludePair[];
+};
+export declare class Validator {
+    input: InputType;
+    inputConfigs: InputParameters;
+    inputOptions: Record<string, any[]>;
+    validatorOptions: ValidatorOptions;
+    validated: any;
+    error: AdapterError | undefined;
+    errored: AdapterErrorResponse | undefined;
+    constructor(input?: InputType, inputConfigs?: {}, inputOptions?: {}, validatorOptions?: ValidatorOptions);
+    validateInput(): void;
+    validateOverrides(path: 'overrides' | 'tokenOverrides', preset: Record<string, any>): void;
+    checkDuplicateInputParams(inputConfig: InputParameters): void;
+    validateIncludeOverrides(): void;
+    parseError(error: unknown): void;
+    formatOverride: (param: any) => Override;
+    formatIncludeOverrides: (param: any) => Override;
+    throwInvalid: (message: string) => void;
+    validateObjectParam(key: string, shouldThrowError?: boolean): void;
+    validateOptionalParam(param: any, key: string, options: any[]): void;
+    validateRequiredParam(param: any, key: string, options: any[]): void;
+    getUsedKey(key: string, keyArray: string[]): string | undefined;
+}
+export {};

package/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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {

package/rate-limiting/background/fixed-frequency.d.ts

@@ -0,0 +1,10 @@
+import { AdapterRateLimitTier, BackgroundExecuteRateLimiter } from '..';
+import { AdapterEndpoint } from '../../adapter';
+export declare const DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
+export declare class FixedFrequencyRateLimiter implements BackgroundExecuteRateLimiter {
+    msBetweenRequestsMap: {
+        [endpointName: string]: number;
+    };
+    initialize(endpoints: AdapterEndpoint[], limits?: AdapterRateLimitTier): this;
+    msUntilNextExecution(endpointName: string): number;
+}

package/rate-limiting/background/fixed-frequency.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FixedFrequencyRateLimiter = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = void 0;
+const __1 = require("..");
+const util_1 = require("../../util");
+const logger = (0, util_1.makeLogger)('FixedFrequencyRateLimiter');
+exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
+class FixedFrequencyRateLimiter {
+    constructor() {
+        this.msBetweenRequestsMap = {};
+    }
+    initialize(endpoints, limits) {
+        // Translate the hourly limit into reqs per minute
+        let sharedMsBetweenRequests = 1000 / (0, __1.consolidateTierLimits)(limits);
+        // If there is no limit set, we use some reasonable number
+        if (!limits?.rateLimit1h && !limits?.rateLimit1m && !limits?.rateLimit1s) {
+            // 5s period for all seems good
+            sharedMsBetweenRequests = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS;
+        }
+        logger.debug('Using fixed frequency batch rate limiting');
+        for (const endpoint of endpoints) {
+            // TODO: See if we can remove this runtime check
+            if (endpoint.rateLimiting?.allocationPercentage == null) {
+                throw new Error(`Allocation percentage for endpoint "${endpoint.name}" is null`);
+            }
+            // TODO: Implement different strategy where this is not fixed, but rather divided based on whether all warmers are active
+            this.msBetweenRequestsMap[endpoint.name] =
+                (sharedMsBetweenRequests / endpoint.rateLimiting?.allocationPercentage) * 100;
+            logger.debug(`Endpoint [${endpoint.name}]: ${this.msBetweenRequestsMap[endpoint.name] / 1000}s between requests`);
+        }
+        return this;
+    }
+    msUntilNextExecution(endpointName) {
+        return this.msBetweenRequestsMap[endpointName];
+    }
+}
+exports.FixedFrequencyRateLimiter = FixedFrequencyRateLimiter;

package/rate-limiting/index.d.ts

@@ -0,0 +1,54 @@
+import { AdapterEndpoint } from '../adapter';
+export * from './request/simple-counting';
+export * from './background/fixed-frequency';
+export interface AdapterRateLimitTier {
+    rateLimit1s?: number;
+    rateLimit1m?: number;
+    rateLimit1h?: number;
+    note?: string;
+}
+/**
+ * Common interface for all RateLimiter classes to implement
+ */
+export interface RateLimiter {
+    /**
+     * Method to ensure all RateLimiters can be initialized in the same manner.
+     *
+     * @param limits - settings for how much throughput to allow for the Adapter
+     * @param endpoints - list of adapter endpoints
+     */
+    initialize(endpoints: AdapterEndpoint[], limits: AdapterRateLimitTier): this;
+}
+/**
+ * RequestRateLimiters perform checks agains imminent outbound requests for any transport.
+ */
+export interface RequestRateLimiter extends RateLimiter {
+    /**
+     * This method will check using whatever strategy is implemented to determine if
+     * this request can be processed. If so, it returns true; if not, returns false.
+     */
+    isUnderLimits(): boolean;
+}
+/**
+ * BackgroundExecuteFrequencyRateLimiters will implement custom logic to calculate
+ * the period of time to wait between background executions for a transport.
+ */
+export interface BackgroundExecuteRateLimiter extends RateLimiter {
+    msUntilNextExecution(endpointName: string): number;
+}
+/**
+ * This method will convert all possible settings for a rate limit tier and
+ * convert them all to requests per second, returning the lowest one
+ *
+ * @param limits - the rate limit tier set for the adapter
+ * @returns the most restrictive of the set options, in requests per second
+ */
+export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier | undefined) => number;
+/**
+ * Validates rate limiting tiers specified for the adapter, and returns the one to use.
+ *
+ * @param tiers - the adapter config listing the different available API tiers
+ * @param selectedTier - chosen API tier from settings, if present
+ * @returns the specified API tier, or a default one if none are specified
+ */
+export declare const getRateLimitingTier: (tiers?: Record<string, AdapterRateLimitTier> | undefined, selectedTier?: string | undefined) => AdapterRateLimitTier | undefined;

package/rate-limiting/index.js

@@ -0,0 +1,63 @@
+"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 __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.getRateLimitingTier = exports.consolidateTierLimits = void 0;
+__exportStar(require("./request/simple-counting"), exports);
+__exportStar(require("./background/fixed-frequency"), exports);
+/**
+ * This method will convert all possible settings for a rate limit tier and
+ * convert them all to requests per second, returning the lowest one
+ *
+ * @param limits - the rate limit tier set for the adapter
+ * @returns the most restrictive of the set options, in requests per second
+ */
+const consolidateTierLimits = (limits) => {
+    const perHourLimit = (limits?.rateLimit1h || Infinity) / (60 * 60);
+    const perMinuteLimit = (limits?.rateLimit1m || Infinity) / 60;
+    const perSecondLimit = limits?.rateLimit1s || Infinity;
+    return Math.min(perHourLimit, perMinuteLimit, perSecondLimit);
+};
+exports.consolidateTierLimits = consolidateTierLimits;
+/**
+ * Validates rate limiting tiers specified for the adapter, and returns the one to use.
+ *
+ * @param tiers - the adapter config listing the different available API tiers
+ * @param selectedTier - chosen API tier from settings, if present
+ * @returns the specified API tier, or a default one if none are specified
+ */
+const getRateLimitingTier = (tiers, selectedTier) => {
+    if (!tiers) {
+        return;
+    }
+    // Check that if the tiers object is defined, it has values
+    if (Object.values(tiers).length === 0) {
+        throw new Error(`The tiers object is defined, but has no entries`);
+    }
+    // Check that the tier set in the AdapterConfig is a valid one
+    if (selectedTier && !tiers[selectedTier]) {
+        const validTiersString = Object.keys(tiers)
+            .map((t) => `"${t}"`)
+            .join(', ');
+        throw new Error(`The selected rate limit tier "${selectedTier}" is not valid (can be one of ${validTiersString})`);
+    }
+    if (!selectedTier) {
+        // Sort the tiers by most to least restrictive
+        const sortedTiers = Object.values(tiers).sort((t1, t2) => (0, exports.consolidateTierLimits)(t1) - (0, exports.consolidateTierLimits)(t2));
+        return sortedTiers[0];
+    }
+    return tiers[selectedTier];
+};
+exports.getRateLimitingTier = getRateLimitingTier;

package/rate-limiting/metrics.d.ts

@@ -0,0 +1,3 @@
+import * as client from 'prom-client';
+export declare const retrieveCost: <ProviderResponseBody>(data: ProviderResponseBody) => number;
+export declare const rateLimitCreditsSpentTotal: client.Counter<"feed_id" | "participant_id">;