@chainlink/external-adapter-framework 0.0.55 → 0.0.57

package/adapter.d.ts

@@ -100,7 +100,7 @@ export declare class AdapterEndpoint<Params, Result, CustomSettings extends Sett
     transport: Transport<Params, Result, CustomSettings>;
     inputParameters: InputParameters;
     rateLimiting?: EndpointRateLimitingConfig | undefined;
-    validator: InputValidator;
+    validator?: InputValidator;
     constructor(params: AdapterEndpointParams<Params, Result, CustomSettings>);
 }
 declare type CustomAdapterSettings = SettingsMap & NegatedAdapterSettings;

package/adapter.js

@@ -192,4 +192,3 @@ class Adapter {
     }
 }
 exports.Adapter = Adapter;
-//# sourceMappingURL=adapter.js.map

package/background-executor.js

@@ -79,4 +79,3 @@ async function callBackgroundExecutes(adapter, apiShutdownPromise) {
     }
 }
 exports.callBackgroundExecutes = callBackgroundExecutes;
-//# sourceMappingURL=background-executor.js.map

package/cache/factory.js

@@ -21,4 +21,3 @@ class CacheFactory {
     }
 }
 exports.CacheFactory = CacheFactory;
-//# sourceMappingURL=factory.js.map

package/cache/index.js

@@ -172,4 +172,3 @@ const buildCacheMiddleware = (adapter) => async (req, res) => {
     logger.debug('Did not find response in cache, moving to next middleware');
 };
 exports.buildCacheMiddleware = buildCacheMiddleware;
-//# sourceMappingURL=index.js.map

package/cache/local.js

@@ -81,4 +81,3 @@ class LocalCache {
     }
 }
 exports.LocalCache = LocalCache;
-//# sourceMappingURL=local.js.map

package/cache/metrics.js

@@ -73,6 +73,9 @@ const baseLabels = [
 //   labelNames: [...baseLabels, 'cache_hit'] as const,
 //   buckets: [0.01, 0.1, 1, 10],
 // })
+if (process.env['METRICS_ENABLED'] === 'false') {
+    client.register.clear();
+}
 const cacheDataGetCount = new client.Counter({
     name: 'cache_data_get_count',
     help: 'A counter that increments every time a value is fetched from the cache',
@@ -118,4 +121,3 @@ exports.cacheWarmerCount = new client.Gauge({
     help: 'The number of cache warmers running',
     labelNames: ['isBatched'],
 });
-//# sourceMappingURL=metrics.js.map

package/cache/redis.js

@@ -98,4 +98,3 @@ class RedisCache {
     }
 }
 exports.RedisCache = RedisCache;
-//# sourceMappingURL=redis.js.map

package/config/index.d.ts

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

package/config/index.js

@@ -342,4 +342,3 @@ const getEnv = (name, config) => {
             return value;
     }
 };
-//# sourceMappingURL=index.js.map

package/config/provider-limits.js

@@ -72,4 +72,3 @@ const calculateRateLimit = (providerLimit) => {
         minute: quota,
     };
 };
-//# sourceMappingURL=provider-limits.js.map

package/examples/bank-frick/accounts.js

@@ -190,4 +190,3 @@ exports.accountsRestEndpoint = new adapter_1.AdapterEndpoint({
     transport: new BankFrickAccountsTransport(),
     inputParameters,
 });
-//# sourceMappingURL=accounts.js.map

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

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

package/examples/bank-frick/config/index.js

@@ -52,4 +52,3 @@ exports.customSettings = {
         },
     },
 };
-//# sourceMappingURL=index.js.map

package/examples/bank-frick/index.js

@@ -13,4 +13,3 @@ exports.adapter = new adapter_1.Adapter({
         API_ENDPOINT: 'https://olbsandbox.bankfrick.li/webapi/v2',
     },
 });
-//# sourceMappingURL=index.js.map

package/examples/bank-frick/util.js

@@ -37,4 +37,3 @@ const generateJWT = async (config, signingAlgorithm = 'rsa-sha512') => {
     return response.data.token;
 };
 exports.generateJWT = generateJWT;
-//# sourceMappingURL=util.js.map

package/examples/coingecko/src/config/index.js

@@ -3,4 +3,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = void 0;
 exports.DEFAULT_API_ENDPOINT = 'https://api.coingecko.com/api/v3';
 exports.PRO_API_ENDPOINT = 'https://pro-api.coingecko.com/api/v3';
-//# sourceMappingURL=index.js.map

package/examples/coingecko/src/crypto-utils.js

@@ -58,4 +58,3 @@ const constructEntry = (res, requestPayload, resultPath) => {
     return entry;
 };
 exports.constructEntry = constructEntry;
-//# sourceMappingURL=crypto-utils.js.map

package/examples/coingecko/src/endpoint/coins.js

@@ -34,4 +34,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: restEndpointTransport,
     inputParameters: exports.inputParameters,
 });
-//# sourceMappingURL=coins.js.map

package/examples/coingecko/src/endpoint/crypto-marketcap.js

@@ -27,4 +27,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters: crypto_utils_1.cryptoInputParams,
 });
-//# sourceMappingURL=crypto-marketcap.js.map

package/examples/coingecko/src/endpoint/crypto-volume.js

@@ -27,4 +27,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters: crypto_utils_1.cryptoInputParams,
 });
-//# sourceMappingURL=crypto-volume.js.map

package/examples/coingecko/src/endpoint/crypto.js

@@ -25,4 +25,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters: crypto_utils_1.cryptoInputParams,
 });
-//# sourceMappingURL=crypto.js.map

package/examples/coingecko/src/endpoint/dominance.js

@@ -25,4 +25,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters: global_utils_1.inputParameters,
 });
-//# sourceMappingURL=dominance.js.map

package/examples/coingecko/src/endpoint/global-marketcap.js

@@ -25,4 +25,3 @@ exports.endpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters: global_utils_1.inputParameters,
 });
-//# sourceMappingURL=global-marketcap.js.map

package/examples/coingecko/src/endpoint/index.js

@@ -13,4 +13,3 @@ var dominance_1 = require("./dominance");
 Object.defineProperty(exports, "dominance", { enumerable: true, get: function () { return dominance_1.endpoint; } });
 var crypto_volume_1 = require("./crypto-volume");
 Object.defineProperty(exports, "cryptoVolume", { enumerable: true, get: function () { return crypto_volume_1.endpoint; } });
-//# sourceMappingURL=index.js.map

package/examples/coingecko/src/global-utils.d.ts

@@ -22,6 +22,6 @@ interface ResultEntry {
     value: number;
     params: AdapterRequestParams;
 }
-export declare const buildGlobalRequestBody: (apiKey?: string | undefined) => AxiosRequestConfig<never>;
+export declare const buildGlobalRequestBody: (apiKey?: string) => AxiosRequestConfig<never>;
 export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: AdapterRequestParams, resultPath: 'total_market_cap' | 'market_cap_percentage') => ResultEntry | undefined;
 export {};

package/examples/coingecko/src/global-utils.js

@@ -44,4 +44,3 @@ const constructEntry = (res, requestPayload, resultPath) => {
     };
 };
 exports.constructEntry = constructEntry;
-//# sourceMappingURL=global-utils.js.map

package/examples/coingecko/src/index.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
 import { Adapter } from '../../../../src/adapter';
 export declare const adapter: Adapter<import("../../../config").SettingsMap>;
-export declare const server: () => Promise<import("fastify").FastifyInstance<import("http").Server, import("http").IncomingMessage, import("http").ServerResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> | undefined>;
+export declare const server: () => Promise<import("fastify").FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> | undefined>;

package/examples/coingecko/src/index.js

@@ -16,4 +16,3 @@ exports.adapter = new adapter_1.Adapter({
 });
 const server = () => (0, __1.expose)(exports.adapter);
 exports.server = server;
-//# sourceMappingURL=index.js.map

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

@@ -51,4 +51,3 @@ exports.batchEndpoint = new adapter_1.AdapterEndpoint({
     transport: batchEndpointTransport,
     inputParameters,
 });
-//# sourceMappingURL=batch-warming.js.map

package/examples/coingecko-old/index.js

@@ -9,4 +9,3 @@ exports.adapter = new adapter_1.Adapter({
     defaultEndpoint: 'batch',
     endpoints: [rest_1.restEndpoint, batch_warming_1.batchEndpoint],
 });
-//# sourceMappingURL=index.js.map

package/examples/coingecko-old/rest.js

@@ -52,4 +52,3 @@ exports.restEndpoint = new adapter_1.AdapterEndpoint({
     transport: restEndpointTransport,
     inputParameters,
 });
-//# sourceMappingURL=rest.js.map

package/examples/genesis/config/index.js

@@ -8,4 +8,3 @@ exports.customSettings = {
         required: true,
     },
 };
-//# sourceMappingURL=index.js.map

package/examples/genesis/index.js

@@ -10,4 +10,3 @@ exports.adapter = new adapter_1.Adapter({
     endpoints: [sseStream_1.sseEndpoint],
     customSettings: config_1.customSettings,
 });
-//# sourceMappingURL=index.js.map

package/examples/genesis/sseStream.js

@@ -139,4 +139,3 @@ exports.sseEndpoint = new adapter_1.AdapterEndpoint({
     transport: exports.sseTransport,
     inputParameters: exports.inputParameters,
 });
-//# sourceMappingURL=sseStream.js.map

package/examples/ncfx/config/index.js

@@ -13,4 +13,3 @@ exports.customSettings = {
         required: true,
     },
 };
-//# sourceMappingURL=index.js.map

package/examples/ncfx/index.js

@@ -9,4 +9,3 @@ exports.adapter = new adapter_1.Adapter({
     endpoints: [websocket_1.webSocketEndpoint],
     customSettings: config_1.customSettings,
 });
-//# sourceMappingURL=index.js.map

package/examples/ncfx/websocket.js

@@ -71,4 +71,3 @@ exports.webSocketEndpoint = new adapter_1.AdapterEndpoint({
     transport: exports.websocketTransport,
     inputParameters: exports.inputParameters,
 });
-//# sourceMappingURL=websocket.js.map

package/index.d.ts

@@ -8,4 +8,4 @@ import { Adapter, AdapterDependencies } from './adapter';
  * @param dependencies - an optional object with adapter dependencies to inject
  * @returns a Promise that resolves to the http.Server listening for connections
  */
-export declare const expose: (adapter: Adapter, dependencies?: Partial<AdapterDependencies> | undefined) => Promise<FastifyInstance | undefined>;
+export declare const expose: (adapter: Adapter, dependencies?: Partial<AdapterDependencies>) => Promise<FastifyInstance | undefined>;

package/index.js

@@ -142,4 +142,3 @@ function buildSmokeEndpoint(app, config) {
         return res.status(200).send('OK');
     });
 }
-//# sourceMappingURL=index.js.map

package/metrics/constants.js

@@ -23,4 +23,3 @@ var HttpRequestType;
 exports.MAX_FEED_ID_LENGTH = 300;
 // We should tune these as we collect data, this is the default bucket distribution that prom comes with
 exports.requestDurationBuckets = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10];
-//# sourceMappingURL=constants.js.map

package/metrics/index.js

@@ -135,4 +135,3 @@ exports.bgExecuteDurationSeconds = new client.Gauge({
     help: 'A histogram bucket of the distribution of background execute durations',
     labelNames: ['endpoint'],
 });
-//# sourceMappingURL=index.js.map

package/metrics/util.js

@@ -7,4 +7,3 @@ const getMetricsMeta = ({ adapterEndpoint, adapterConfig, }, data) => {
     return { feedId };
 };
 exports.getMetricsMeta = getMetricsMeta;
-//# sourceMappingURL=util.js.map

package/package.json

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

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

@@ -33,4 +33,3 @@ class FixedFrequencyRateLimiter {
     }
 }
 exports.FixedFrequencyRateLimiter = FixedFrequencyRateLimiter;
-//# sourceMappingURL=fixed-frequency.js.map

package/rate-limiting/index.d.ts

@@ -44,7 +44,7 @@ export interface BackgroundExecuteRateLimiter extends RateLimiter {
  * @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;
+export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier) => number;
 /**
  * Validates rate limiting tiers specified for the adapter, and returns the one to use.
  *
@@ -52,5 +52,5 @@ export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier | und
  * @param tiers - the adapter config listing the different available API tiers
  * @returns the specified API tier, or a default one if none are specified
  */
-export declare const getRateLimitingTier: (config: AdapterConfig, tiers?: Record<string, AdapterRateLimitTier> | undefined) => AdapterRateLimitTier | undefined;
+export declare const getRateLimitingTier: (config: AdapterConfig, tiers?: Record<string, AdapterRateLimitTier>) => AdapterRateLimitTier | undefined;
 export declare const buildRateLimitTiersFromConfig: (config: AdapterConfig) => AdapterRateLimitTier | undefined;

package/rate-limiting/index.js

@@ -83,4 +83,3 @@ const buildRateLimitTiersFromConfig = (config) => {
     };
 };
 exports.buildRateLimitTiersFromConfig = buildRateLimitTiersFromConfig;
-//# sourceMappingURL=index.js.map

package/rate-limiting/metrics.js

@@ -42,4 +42,3 @@ exports.rateLimitCreditsSpentTotal = new client.Counter({
     help: 'The number of data provider credits the adapter is consuming',
     labelNames: ['participant_id', 'feed_id'],
 });
-//# sourceMappingURL=metrics.js.map

package/rate-limiting/request/simple-counting.js

@@ -60,4 +60,3 @@ class SimpleCountingRateLimiter {
     }
 }
 exports.SimpleCountingRateLimiter = SimpleCountingRateLimiter;
-//# sourceMappingURL=simple-counting.js.map

package/transports/batch-warming.js

@@ -106,4 +106,3 @@ class BatchWarmingTransport {
     }
 }
 exports.BatchWarmingTransport = BatchWarmingTransport;
-//# sourceMappingURL=batch-warming.js.map

package/transports/index.js

@@ -30,6 +30,7 @@ exports.buildTransportHandler = exports.buildCacheEntriesFromResults = void 0;
 const cache_1 = require("../cache");
 const util_1 = require("../util");
 const transportMetrics = __importStar(require("./metrics"));
+const client = __importStar(require("prom-client"));
 __exportStar(require("./batch-warming"), exports);
 __exportStar(require("./rest"), exports);
 __exportStar(require("./websocket"), exports);
@@ -110,4 +111,6 @@ const buildTransportHandler = (adapter) => async (req, reply) => {
     return reply.send();
 };
 exports.buildTransportHandler = buildTransportHandler;
-//# sourceMappingURL=index.js.map
+if (process.env['METRICS_ENABLED'] === 'false') {
+    client.register.clear();
+}

package/transports/metrics.d.ts

@@ -1,7 +1,7 @@
 import * as client from 'prom-client';
 import { AdapterContext } from '../adapter';
 import { SettingsMap } from '../config';
-export declare const dataProviderMetricsLabel: (providerStatusCode?: number | undefined, method?: string) => {
+export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
     provider_status_code: number | undefined;
     method: string;
 };

package/transports/metrics.js

@@ -119,4 +119,3 @@ exports.transportPollingDurationSeconds = new client.Gauge({
     help: 'A histogram bucket of the distribution of transport polling idle time durations',
     labelNames: ['endpoint', 'succeeded'],
 });
-//# sourceMappingURL=metrics.js.map

package/transports/rest.js

@@ -136,4 +136,3 @@ class RestTransport {
     }
 }
 exports.RestTransport = RestTransport;
-//# sourceMappingURL=rest.js.map

package/transports/sse.js

@@ -93,4 +93,3 @@ class SSETransport {
     }
 }
 exports.SSETransport = SSETransport;
-//# sourceMappingURL=sse.js.map

package/transports/util.js

@@ -84,4 +84,3 @@ async function axiosRequest(request, config) {
     return providerResponse;
 }
 exports.axiosRequest = axiosRequest;
-//# sourceMappingURL=util.js.map

package/transports/websocket.js

@@ -165,4 +165,3 @@ class WebSocketTransport {
     }
 }
 exports.WebSocketTransport = WebSocketTransport;
-//# sourceMappingURL=websocket.js.map

package/util/censor/censor-list.js

@@ -10,4 +10,3 @@ class CensorList {
 }
 exports.default = CensorList;
 CensorList.censorList = [];
-//# sourceMappingURL=censor-list.js.map

package/util/index.js

@@ -35,4 +35,3 @@ const isArray = (o) => o !== null && typeof o === 'object' && Array.isArray(o);
 exports.isArray = isArray;
 const isEmpty = (o) => o === undefined || o === null || o === '';
 exports.isEmpty = isEmpty;
-//# sourceMappingURL=index.js.map

package/util/logger.js

@@ -79,4 +79,3 @@ function censor(obj, censorList) {
     });
     return stringified;
 }
-//# sourceMappingURL=logger.js.map

package/util/request.js

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

package/util/subscription-set/expiring-sorted-set.js

@@ -33,4 +33,3 @@ class ExpiringSortedSet {
     }
 }
 exports.ExpiringSortedSet = ExpiringSortedSet;
-//# sourceMappingURL=expiring-sorted-set.js.map

package/util/subscription-set/redis-sorted-set.js

@@ -26,4 +26,3 @@ class RedisSubscriptionSet {
     }
 }
 exports.RedisSubscriptionSet = RedisSubscriptionSet;
-//# sourceMappingURL=redis-sorted-set.js.map

package/util/subscription-set/subscription-set.js

@@ -25,4 +25,3 @@ class SubscriptionSetFactory {
     }
 }
 exports.SubscriptionSetFactory = SubscriptionSetFactory;
-//# sourceMappingURL=subscription-set.js.map

package/util/test-payload-loader.js

@@ -81,4 +81,3 @@ function resolvePayload(fileName) {
         return null;
     }
 }
-//# sourceMappingURL=test-payload-loader.js.map

package/validation/error.js

@@ -77,4 +77,3 @@ class AdapterCustomError extends AdapterError {
     }
 }
 exports.AdapterCustomError = AdapterCustomError;
-//# sourceMappingURL=error.js.map

package/validation/index.js

@@ -40,7 +40,9 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
             statusCode: 404,
         });
     }
-    const validatedData = endpoint.validator.validateInput(req.body?.['data']);
+    const validatedData = endpoint.validator
+        ? endpoint.validator.validateInput(req.body?.['data'])
+        : req.body?.['data'];
     req.requestContext = {
         cacheKey: '',
         data: validatedData,
@@ -90,4 +92,3 @@ const errorCatchingMiddleware = (err, req, res) => {
     }
 };
 exports.errorCatchingMiddleware = errorCatchingMiddleware;
-//# sourceMappingURL=index.js.map

package/validation/input-params.js

@@ -28,4 +28,3 @@ exports.baseInputParameters = {
         // 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 }] } }[]
     },
 };
-//# sourceMappingURL=input-params.js.map

package/validation/input-validator.d.ts

@@ -4,7 +4,7 @@ export declare class InputValidator {
     private readonly inputConfig;
     private aliases;
     constructor(inputConfig: InputParameters);
-    validateInput(input: Record<string, unknown>): NormalizedInput;
+    validateInput(input: any): NormalizedInput;
     private initializeInputs;
     private validateInputParamsSchema;
     private validateRequiredConfig;

package/validation/input-validator.js

@@ -121,4 +121,3 @@ class InputValidator {
     }
 }
 exports.InputValidator = InputValidator;
-//# sourceMappingURL=input-validator.js.map

package/validation/override-functions.js

@@ -38,4 +38,3 @@ const performSymbolOverrides = (adapter, req) => {
     req.requestContext.data['base'] = requestedSymbols;
 };
 exports.performSymbolOverrides = performSymbolOverrides;
-//# sourceMappingURL=override-functions.js.map