@chainlink/external-adapter-framework 0.0.20 → 0.0.21

package/background-executor.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-import { Server } from 'http';
 import { Adapter } from './adapter';
 /**
  * Very simple background loop that will call the [[Transport.backgroundExecute]] functions in all Transports.
@@ -8,4 +6,4 @@ import { Adapter } from './adapter';
  * @param adapter - an initialized External Adapter
  * @param server - the http server to attach an on close listener to
  */
-export declare function callBackgroundExecutes(adapter: Adapter, server?: Server): Promise<void>;
+export declare function callBackgroundExecutes(adapter: Adapter, apiShutdownPromise?: Promise<void>): Promise<void>;

package/background-executor.js

@@ -10,12 +10,18 @@ const logger = (0, util_1.makeLogger)('BackgroundExecutor');
  * @param adapter - an initialized External Adapter
  * @param server - the http server to attach an on close listener to
  */
-async function callBackgroundExecutes(adapter, server) {
+async function callBackgroundExecutes(adapter, apiShutdownPromise) {
     // Set up variable to check later on to see if we need to stop this background "thread"
     // If no server is provided, the listener won't be set and serverClosed will always be false
     let serverClosed = false;
-    server?.on('close', () => {
+    const timeoutsMap = {};
+    apiShutdownPromise?.then(() => {
         serverClosed = true;
+        for (const endpointName in timeoutsMap) {
+            logger.debug(`Clearing timeout for endpoint "${endpointName}"`);
+            timeoutsMap[endpointName].unref();
+            clearTimeout(timeoutsMap[endpointName]);
+        }
     });
     for (const endpoint of adapter.endpoints) {
         const backgroundExecute = endpoint.transport.backgroundExecute?.bind(endpoint.transport);
@@ -35,8 +41,7 @@ async function callBackgroundExecutes(adapter, server) {
             logger.debug(`Calling background execute for endpoint "${endpoint.name}"`);
             const timeToWait = await backgroundExecute(context);
             logger.debug(`Finished background execute for endpoint "${endpoint.name}", sleeping for ${timeToWait}ms`);
-            await (0, util_1.sleep)(timeToWait);
-            handler();
+            timeoutsMap[endpoint.name] = setTimeout(handler, timeToWait);
         };
         // Start recursive async calls
         handler();

package/config/index.d.ts

@@ -159,7 +159,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/examples/coingecko/src/config/index.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_API_ENDPOINT = "https://api.coingecko.com/api/v3";
+export declare const PRO_API_ENDPOINT = "https://pro-api.coingecko.com/api/v3";

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

@@ -1,13 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customSettings = exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = exports.DEFAULT_ENDPOINT = exports.NAME = void 0;
-exports.NAME = 'COINGECKO';
-exports.DEFAULT_ENDPOINT = 'crypto';
+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';
-exports.customSettings = {
-    API_KEY: {
-        description: 'API key for the CoinGecko API',
-        type: 'string',
-    },
-};

package/examples/coingecko/src/config/overrides.json

@@ -9003,7 +9003,6 @@
         "CRDC": "cardiocoin",
         "$CRDN": "cardence",
         "CEVO": "cardanoevo",
-        "ADA": "binance-peg-cardano",
         "ADA": "cardano",
         "CCM": "car-coin",
         "CARBON": "carboncoin",

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

@@ -0,0 +1,31 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig } from '../../../config';
+import { InputParameters } from '../../../validation';
+export interface CryptoRequestParams {
+    coinid?: string;
+    base?: string;
+    quote: string;
+}
+export declare const cryptoInputParams: InputParameters;
+export interface ProviderRequestBody {
+    ids: string;
+    vs_currencies: string;
+    include_market_cap?: boolean;
+    include_24hr_vol?: boolean;
+}
+export interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+interface ResultEntryWithoutOverrides {
+    value: number;
+    params: {
+        quote: string;
+        base?: string;
+        coinid?: string;
+    };
+}
+export declare const buildBatchedRequestBody: (params: CryptoRequestParams[], config: AdapterConfig) => AxiosRequestConfig<ProviderRequestBody>;
+export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: CryptoRequestParams, resultPath: string) => ResultEntryWithoutOverrides | undefined;
+export {};

package/examples/coingecko/src/cryptoUtils.js

@@ -1,8 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructEntry = exports.buildBatchedRequestBody = void 0;
+exports.constructEntry = exports.buildBatchedRequestBody = exports.cryptoInputParams = void 0;
 const config_1 = require("./config");
 const logger_1 = require("../../../util/logger");
+exports.cryptoInputParams = {
+    coinid: {
+        description: 'The CoinGecko id or to query',
+        type: 'string',
+        required: false,
+    },
+    base: {
+        aliases: ['from', 'coin'],
+        type: 'string',
+        description: 'The symbol of symbols of the currency to query',
+        required: false,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        type: 'string',
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
 const buildBatchedRequestBody = (params, config) => {
     return {
         baseURL: config.API_KEY ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,

package/examples/coingecko/src/endpoint/coins.d.ts

@@ -0,0 +1,9 @@
+import { AdapterEndpoint } from '../../../../../src/adapter';
+import { InputParameters } from '../../../../../src/validation';
+export declare const inputParameters: InputParameters;
+export interface CoinsResponse {
+    id: string;
+    symbol: string;
+    name: string;
+}
+export declare const endpoint: AdapterEndpoint<import("../../../../util/request").AdapterRequestData, CoinsResponse[], import("../../../../config").SettingsMap>;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = exports.inputParameters = void 0;
+const adapter_1 = require("../../../../../src/adapter");
 const transports_1 = require("../../../../../src/transports");
 const config_1 = require("../config");
 exports.inputParameters = {};
@@ -26,8 +27,8 @@ const restEndpointTransport = new transports_1.RestTransport({
         coalescing: true,
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'coins',
     transport: restEndpointTransport,
     inputParameters: exports.inputParameters,
-};
+});

package/examples/coingecko/src/endpoint/crypto-marketcap.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

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

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         const requestBody = (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -38,9 +21,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'marketcap',
     aliases: ['crypto-marketcap'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/crypto-volume.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

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

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         const requestBody = (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -38,9 +21,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'volume',
     aliases: ['crypto-volume'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/crypto.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { CryptoRequestParams } from '../cryptoUtils';
+export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

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

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.inputParameters = void 0;
+exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
-const input_params_1 = require("../../../../validation/input-params");
 const cryptoUtils_1 = require("../cryptoUtils");
-exports.inputParameters = {
-    overrides: input_params_1.baseInputParameters['overrides'],
-    coinid: {
-        description: 'The CoinGecko id or to query',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol of symbols of the currency to query',
-        required: false,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
         return (0, cryptoUtils_1.buildBatchedRequestBody)(params, context.adapterConfig);
@@ -29,9 +12,6 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         const entries = [];
         for (const requestPayload of params) {
             const entry = (0, cryptoUtils_1.constructEntry)(res, requestPayload, requestPayload.quote.toLowerCase());
-            // NOTE: the `entries` array is going to be shorter than the `params` array if one of the params has a bad token.
-            // Is that okay?  I did this to avoid caching an invalid value for transient DP issues.  Just want to make
-            // sure this works within the core framework
             if (entry) {
                 entries.push(entry);
             }
@@ -39,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'crypto',
     aliases: ['crypto-batched', 'batched', 'batch'],
     transport: batchEndpointTransport,
-    inputParameters: exports.inputParameters,
-};
+    inputParameters: cryptoUtils_1.cryptoInputParams,
+});

package/examples/coingecko/src/endpoint/dominance.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { AdapterRequestParams } from '../globalUtils';
+export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

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

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
 const globalUtils_1 = require("../globalUtils");
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
-        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig);
+        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig.API_KEY);
     },
     parseResponse: (params, res) => {
         const entries = [];
@@ -18,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'dominance',
     aliases: ['market_cap_percentage'],
     transport: batchEndpointTransport,
     inputParameters: globalUtils_1.inputParameters,
-};
+});

package/examples/coingecko/src/endpoint/global-marketcap.d.ts

@@ -0,0 +1,3 @@
+import { AdapterEndpoint } from '../../../../adapter';
+import { AdapterRequestParams } from '../globalUtils';
+export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

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

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.endpoint = void 0;
+const adapter_1 = require("../../../../adapter");
 const batch_warming_1 = require("../../../../transports/batch-warming");
 const globalUtils_1 = require("../globalUtils");
 const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
     prepareRequest: (params, context) => {
-        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig);
+        return (0, globalUtils_1.buildGlobalRequestBody)(context.adapterConfig.API_KEY);
     },
     parseResponse: (params, res) => {
         const entries = [];
@@ -18,9 +19,9 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.endpoint = {
+exports.endpoint = new adapter_1.AdapterEndpoint({
     name: 'globalmarketcap',
     aliases: ['total_market_cap'],
     transport: batchEndpointTransport,
     inputParameters: globalUtils_1.inputParameters,
-};
+});

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

@@ -0,0 +1,6 @@
+export { endpoint as coins } from './coins';
+export { endpoint as crypto } from './crypto';
+export { endpoint as cryptoMarketcap } from './crypto-marketcap';
+export { endpoint as globalMarketcap } from './global-marketcap';
+export { endpoint as dominance } from './dominance';
+export { endpoint as cryptoVolume } from './crypto-volume';

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

@@ -0,0 +1,27 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { InputParameters } from '../../../validation';
+export declare const inputParameters: InputParameters;
+export interface AdapterRequestParams {
+    market: string;
+}
+export interface ProviderResponseBody {
+    data: {
+        active_cryptocurrencies: number;
+        upcoming_icos: number;
+        ongoing_icos: number;
+        ended_icos: number;
+        markets: number;
+        total_market_cap: Record<string, number>;
+        total_volume: Record<string, number>;
+        market_cap_percentage: Record<string, number>;
+        market_cap_change_percentage_24h_usd: number;
+        updated_at: number;
+    };
+}
+interface ResultEntry {
+    value: number;
+    params: AdapterRequestParams;
+}
+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/globalUtils.js

@@ -11,15 +11,14 @@ exports.inputParameters = {
         required: true,
     },
 };
-const buildGlobalRequestBody = (config) => {
-    const apiKey = {
-        x_cg_pro_api_key: config.API_KEY,
-    };
+const buildGlobalRequestBody = (apiKey) => {
     return {
-        baseURL: config.API_KEY ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,
+        baseURL: apiKey ? config_1.PRO_API_ENDPOINT : config_1.DEFAULT_API_ENDPOINT,
         url: '/global',
         method: 'GET',
-        params: apiKey,
+        params: {
+            x_cg_pro_api_key: apiKey,
+        },
     };
 };
 exports.buildGlobalRequestBody = buildGlobalRequestBody;
@@ -39,10 +38,9 @@ const constructEntry = (res, requestPayload, resultPath) => {
         logger.warn(`Data for "${requestPayload.market}" not found".`);
         return;
     }
-    const entry = {
+    return {
         params: requestPayload,
         value: result,
     };
-    return entry;
 };
 exports.constructEntry = constructEntry;

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

@@ -0,0 +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("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> | undefined>;

package/examples/coingecko/src/index.js

@@ -3,12 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adapter = void 0;
+exports.server = exports.adapter = void 0;
+const __1 = require("../../..");
+const adapter_1 = require("../../../../src/adapter");
 const overrides_json_1 = __importDefault(require("./config/overrides.json"));
 const endpoint_1 = require("./endpoint");
-exports.adapter = {
+exports.adapter = new adapter_1.Adapter({
     defaultEndpoint: 'crypto',
     name: 'coingecko',
     endpoints: [endpoint_1.crypto, endpoint_1.coins, endpoint_1.cryptoMarketcap, endpoint_1.cryptoVolume, endpoint_1.dominance, endpoint_1.globalMarketcap],
     overrides: overrides_json_1.default['coingecko'],
-};
+});
+const server = () => (0, __1.expose)(exports.adapter);
+exports.server = server;

package/examples/coingecko-old/batch-warming.d.ts

@@ -0,0 +1,7 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const batchEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../config").SettingsMap>;
+export {};

package/examples/coingecko-old/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/coingecko-old/rest.d.ts

@@ -0,0 +1,12 @@
+import { AdapterEndpoint } from '../../adapter';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+interface ProviderResponseBody {
+    [base: string]: {
+        [quote: string]: number;
+    };
+}
+export declare const restEndpoint: AdapterEndpoint<AdapterRequestParams, ProviderResponseBody, import("../../config").SettingsMap>;
+export {};

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Server } from 'http';
+import { FastifyInstance } from 'fastify';
 import { Adapter, AdapterDependencies } from './adapter';
 /**
  * Main function for the framework.
@@ -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<Server | undefined>;
+export declare const expose: (adapter: Adapter, dependencies?: Partial<AdapterDependencies>) => Promise<FastifyInstance | undefined>;

package/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.expose = void 0;
 const fastify_1 = __importDefault(require("fastify"));
 const path_1 = require("path");
+const adapter_1 = require("./adapter");
 const background_executor_1 = require("./background-executor");
 const cache_1 = require("./cache");
 const metrics_1 = require("./metrics");
@@ -24,25 +25,36 @@ const VERSION = process.env['npm_package_version'];
  * @returns a Promise that resolves to the http.Server listening for connections
  */
 const expose = async (adapter, dependencies) => {
+    if (!(adapter instanceof adapter_1.Adapter)) {
+        throw new Error('The adapter has not been initialized as an instance of the Adapter class, exiting.');
+    }
     // Initialize adapter (create dependencies, inject them, build endpoint map, etc.)
     await adapter.initialize(dependencies);
-    let server = undefined;
+    let api = undefined;
     if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
         (0, metrics_1.setupMetricsServer)(adapter.name, adapter.config);
     }
+    // Optional Promise to indicate that the API is shutting down (for us to close background executors)
+    let apiShutdownPromise;
     if (adapter.config.EA_MODE === 'reader' || adapter.config.EA_MODE === 'reader-writer') {
         // Main REST API server to handle incoming requests
-        const app = await buildRestApi(adapter);
+        api = await buildRestApi(adapter);
+        // Add a hook on close to use on the background execution loop to stop it
+        apiShutdownPromise = new Promise((resolve) => {
+            api?.addHook('onClose', async () => resolve());
+        });
         // Start listening for incoming requests
         try {
-            await app.listen(adapter.config.EA_PORT, adapter.config.EA_HOST);
+            await api.listen({
+                port: adapter.config.EA_PORT,
+                host: adapter.config.EA_HOST,
+            });
         }
         catch (err) {
             logger.fatal(`There was an error when starting the EA server: ${err}`);
             process.exit();
         }
-        logger.info(`Listening on port ${app.server.address().port}`);
-        server = app.server;
+        logger.info(`Listening on port ${api.server.address().port}`);
     }
     else {
         logger.info('REST API is disabled; this instance will not process incoming requests.');
@@ -50,12 +62,12 @@ const expose = async (adapter, dependencies) => {
     if (adapter.config.EA_MODE === 'writer' || adapter.config.EA_MODE === 'reader-writer') {
         // Start background loop that will take care of calling any async Transports
         logger.info('Starting background execution loop');
-        (0, background_executor_1.callBackgroundExecutes)(adapter, server);
+        (0, background_executor_1.callBackgroundExecutes)(adapter, apiShutdownPromise);
     }
     else {
         logger.info('Background executor is disabled; this instance will not perform async background executes.');
     }
-    return server;
+    return api;
 };
 exports.expose = expose;
 async function buildRestApi(adapter) {
@@ -66,6 +78,11 @@ async function buildRestApi(adapter) {
     });
     // Use global error handling
     app.setErrorHandler(validation_1.errorCatchingMiddleware);
+    // Always reply with json content
+    app.addHook('preHandler', (_, reply, done) => {
+        reply.headers({ 'content-type': 'application/json; charset=utf-8' });
+        done();
+    });
     const transportHandler = await (0, transports_1.buildTransportHandler)(adapter);
     app.register(async (router) => {
         // Set up "middlewares" (hooks in fastify)

package/metrics/index.js

@@ -46,7 +46,10 @@ function setupMetricsServer(name, config) {
         res.type('txt');
         res.send(await client.register.metrics());
     });
-    metricsApp.listen(metricsPort, eaHost, () => logger.info(`Monitoring listening on port ${metricsPort}!`));
+    metricsApp.listen({
+        port: metricsPort,
+        host: eaHost,
+    }, () => logger.info(`Monitoring listening on port ${metricsPort}!`));
 }
 exports.setupMetricsServer = setupMetricsServer;
 const setupMetrics = (name, config) => {
@@ -64,8 +67,9 @@ exports.setupMetrics = setupMetrics;
  * @returns the cache middleware function
  */
 const buildMetricsMiddleware = (req, res, done) => {
-    const feedId = req.requestContext.meta?.metrics?.feedId || 'N/A';
-    const labels = buildHttpRequestMetricsLabel(feedId, req.requestContext.meta?.error, req.requestContext.meta?.metrics?.cacheHit);
+    // The request context can technically be empty if the input validation failed
+    const feedId = req.requestContext?.meta?.metrics?.feedId || 'N/A';
+    const labels = buildHttpRequestMetricsLabel(feedId, req.requestContext?.meta?.error, req.requestContext?.meta?.metrics?.cacheHit);
     // Record number of requests sent to EA
     exports.httpRequestsTotal.labels(labels).inc();
     // Record response time of request through entire EA

package/package.json

@@ -1,31 +1,36 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
     "axios": "^0.27.2",
-    "fastify": "^3.29.0",
+    "fastify": "^4.5.3",
     "ioredis": "^5.0.4",
     "pino": "^7.9.2",
     "prom-client": "13.2.0",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
     "ts-node": "^10.9.1",
     "typescript": "^4.6.3",
     "ws": "^8.5.0"
   },
   "scripts": {
-    "start": "ts-node src/test.ts",
     "generate-docs": "typedoc src/**/*.ts",
     "test": "LOG_LEVEL=error EA_PORT=0 c8 ava",
     "test-debug": "LOG_LEVEL=trace DEBUG=true EA_PORT=0 c8 ava --verbose",
     "build": "tsc",
     "lint": "eslint ./src && prettier --check ./src/**/*.ts",
-    "dev": "NODE_ENV=develop tsnd --respawn --transpile-only --project tsconfig.json './src/test.ts'"
+    "lint-fix": "eslint --fix ./src && prettier --write ./src/**/*.ts",
+    "dev": "NODE_ENV=develop tsnd --respawn --transpile-only --project tsconfig.json './src/test.ts'",
+    "verify": "yarn lint && yarn build && yarn build -p ./test/tsconfig.json && yarn test"
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "^9.1.2",
+    "@types/jest": "^28.1.7",
     "@types/node": "^18.6.5",
     "@types/sinonjs__fake-timers": "^8.1.2",
+    "@types/supertest": "^2.0.12",
     "@types/ws": "^8.5.3",
     "@typescript-eslint/eslint-plugin": "^5.17.0",
     "@typescript-eslint/parser": "^5.17.0",
@@ -34,6 +39,7 @@
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-tsdoc": "^0.2.16",
+    "jest": "^29.0.3",
     "mock-socket": "^9.1.3",
     "nock": "^13.2.4",
     "pino-pretty": "^7.6.0",

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,4 +52,4 @@ 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;

package/transports/batch-warming.d.ts

@@ -26,7 +26,7 @@ export declare class BatchWarmingTransport<AdapterParams, ProviderRequestBody, P
     WARMER_ACTIVE: boolean;
     constructor(config: {
         prepareRequest: (params: AdapterParams[], context: AdapterContext<CustomSettings>) => AxiosRequestConfig<ProviderRequestBody>;
-        parseResponse: (res: AxiosResponse<ProviderResponseBody>, context: AdapterContext<CustomSettings>) => ProviderResult<AdapterParams>[];
+        parseResponse: (params: AdapterParams[], res: AxiosResponse<ProviderResponseBody>, context: AdapterContext<CustomSettings>) => ProviderResult<AdapterParams>[];
     });
     initialize(dependencies: AdapterDependencies): Promise<void>;
     hasBeenSetUp(req: AdapterRequest<AdapterParams>): Promise<boolean>;

package/transports/batch-warming.js

@@ -83,7 +83,7 @@ class BatchWarmingTransport {
         logger.trace('Sending request to data provider...');
         const providerResponse = await (0, util_2.axiosRequest)(request, context.adapterConfig);
         logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
-        const results = this.config.parseResponse(providerResponse, context);
+        const results = this.config.parseResponse(entries, providerResponse, context);
         const adapterResponses = (0, _1.buildCacheEntriesFromResults)(results, context);
         logger.debug('Setting adapter responses in cache');
         await this.cache.setMany(adapterResponses, context.adapterConfig.CACHE_MAX_AGE);

package/transports/index.d.ts

@@ -60,7 +60,9 @@ export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
  * @param context - context for the Adapter
  * @returns a list of CacheEntries of AdapterResponses
  */
-export declare const buildCacheEntriesFromResults: <Params, CustomSettings extends SettingsMap>(results: ProviderResult<Params>[], context: AdapterContext<CustomSettings>) => CacheEntry<AdapterResponse<null>>[];
+export declare const buildCacheEntriesFromResults: <Params, CustomSettings extends SettingsMap>(results: ProviderResult<Params>[], context: AdapterContext<CustomSettings>) => CacheEntry<AdapterResponse<{
+    result: unknown;
+}>>[];
 /**
  * Takes an Adapter, its configuration, and its dependencies, and it creates an express middleware
  * that will pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)

package/transports/index.js

@@ -34,7 +34,9 @@ const buildCacheEntriesFromResults = (results, context) => results.map((r) => {
         value: {
             result: r.value,
             statusCode: 200,
-            data: null, // TODO: Maybe add data as well?
+            data: {
+                result: r.value,
+            },
         },
     };
     if (context.adapterConfig.METRICS_ENABLED &&

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/util/request.d.ts

@@ -51,7 +51,6 @@ export declare type AdapterResponse<T = unknown> = {
     result: unknown;
     maxAge?: number;
     meta?: AdapterRequestMeta;
-    providerStatusCode?: number;
 };
 export declare type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
 export declare type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;

package/validation/index.js

@@ -39,7 +39,6 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
         });
     }
     // Validate data using validator from v2
-    // TODO: See if we want to change this whole thing
     const validator = new validator_1.Validator(req.body, endpoint.inputParameters);
     req.requestContext = {
         id: req.body.id || '1',
@@ -76,7 +75,10 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
 exports.validatorMiddleware = validatorMiddleware;
 const errorCatchingMiddleware = (err, req, res) => {
     // Add adapter or generic error to request meta for metrics use
-    req.requestContext.meta = { ...req.requestContext.meta, error: err };
+    // 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 };
+    }
     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.