@chainlink/external-adapter-framework 0.0.8 → 0.0.12

package/{package → dist/src}/examples/coingecko/batch-warming.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batchEndpoint = void 0;
+const adapter_1 = require("../../adapter");
 const batch_warming_1 = require("../../transports/batch-warming");
 const DEFAULT_URL = 'https://pro-api.coingecko.com/api/v3';
 const inputParameters = {
@@ -45,8 +46,8 @@ const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
         return entries;
     },
 });
-exports.batchEndpoint = {
+exports.batchEndpoint = new adapter_1.AdapterEndpoint({
     name: 'batch',
     transport: batchEndpointTransport,
     inputParameters,
-};
+});

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

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

package/{package → dist/src}/examples/coingecko/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.adapter = void 0;
+const adapter_1 = require("../../adapter");
 const batch_warming_1 = require("./batch-warming");
 const rest_1 = require("./rest");
-exports.adapter = {
+exports.adapter = new adapter_1.Adapter({
     name: 'coingecko',
     defaultEndpoint: 'batch',
     endpoints: [rest_1.restEndpoint, batch_warming_1.batchEndpoint],
-};
+});

package/dist/src/examples/coingecko/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/{package → dist/src}/examples/coingecko/rest.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.restEndpoint = void 0;
+const adapter_1 = require("../../adapter");
 const transports_1 = require("../../transports");
 const DEFAULT_URL = 'https://api.coingecko.com/api/v3';
 const inputParameters = {
@@ -42,9 +43,9 @@ const restEndpointTransport = new transports_1.RestTransport({
         coalescing: true,
     },
 });
-exports.restEndpoint = {
+exports.restEndpoint = new adapter_1.AdapterEndpoint({
     name: 'rest',
     aliases: ['qwe'],
     transport: restEndpointTransport,
     inputParameters,
-};
+});

package/dist/src/examples/ncfx/index.d.ts

@@ -0,0 +1,13 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter<{
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;

package/{package → dist/src}/examples/ncfx/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.adapter = void 0;
+const adapter_1 = require("../../adapter");
 const config_1 = require("./config");
 const websocket_1 = require("./websocket");
-exports.adapter = {
+exports.adapter = new adapter_1.Adapter({
     name: 'ncfx',
     endpoints: [websocket_1.webSocketEndpoint],
     customSettings: config_1.customSettings,
-};
+});

package/{package → dist/src}/examples/ncfx/websocket.d.ts

@@ -32,5 +32,16 @@ export declare const websocketTransport: WebSocketTransport<AdapterRequestParams
         readonly required: true;
     };
 }>;
-export declare const webSocketEndpoint: AdapterEndpoint;
+export declare const webSocketEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;
 export {};

package/{package → dist/src}/examples/ncfx/websocket.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.webSocketEndpoint = exports.websocketTransport = exports.inputParameters = void 0;
+const adapter_1 = require("../../adapter");
 const websocket_1 = require("../../transports/websocket");
 const util_1 = require("../../util");
 exports.inputParameters = {
@@ -65,8 +66,8 @@ exports.websocketTransport = new websocket_1.WebSocketTransport({
         }),
     },
 });
-exports.webSocketEndpoint = {
+exports.webSocketEndpoint = new adapter_1.AdapterEndpoint({
     name: 'websocket',
     transport: exports.websocketTransport,
     inputParameters: exports.inputParameters,
-};
+});

package/{package → dist/src}/index.d.ts

@@ -1,6 +1,5 @@
 import { Server } from 'http';
-import { Adapter } from './adapter';
-import { AdapterDependencies } from './transports';
+import { Adapter, AdapterDependencies } from './adapter';
 /**
  * Main function for the framework.
  * Initializes config and dependencies, uses those to initialize Transports, and starts listening for requests.
@@ -9,4 +8,4 @@ import { AdapterDependencies } from './transports';
  * @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<Server | undefined>;

package/{package → dist/src}/index.js

@@ -6,13 +6,12 @@ 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 config_1 = require("./config");
 const metrics_1 = require("./metrics");
 const transports_1 = require("./transports");
 const util_1 = require("./util");
+const test_payload_loader_1 = require("./util/test-payload-loader");
 const validation_1 = require("./validation");
 const logger = (0, util_1.makeLogger)('Main');
 const VERSION = process.env['npm_package_version'];
@@ -25,22 +24,18 @@ const VERSION = process.env['npm_package_version'];
  * @returns a Promise that resolves to the http.Server listening for connections
  */
 const expose = async (adapter, dependencies) => {
-    const config = (0, config_1.buildAdapterConfig)({
-        overrides: adapter.envDefaultOverrides,
-        customSettings: adapter.customSettings,
-    });
     // Initialize adapter (create dependencies, inject them, build endpoint map, etc.)
-    const initializedAdapter = await (0, adapter_1.initializeAdapter)(adapter, config, dependencies);
+    await adapter.initialize(dependencies);
     let server = undefined;
-    if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
-        (0, metrics_1.setupMetricsServer)(adapter.name, config);
+    if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
+        (0, metrics_1.setupMetricsServer)(adapter.name, adapter.config);
     }
-    if (config.EA_MODE === 'reader' || config.EA_MODE === 'reader-writer') {
+    if (adapter.config.EA_MODE === 'reader' || adapter.config.EA_MODE === 'reader-writer') {
         // Main REST API server to handle incoming requests
-        const app = await buildRestApi(config, initializedAdapter);
+        const app = await buildRestApi(adapter);
         // Start listening for incoming requests
         try {
-            await app.listen(config.EA_PORT, config.EA_HOST);
+            await app.listen(adapter.config.EA_PORT, adapter.config.EA_HOST);
         }
         catch (err) {
             logger.fatal(`There was an error when starting the EA server: ${err}`);
@@ -52,10 +47,10 @@ const expose = async (adapter, dependencies) => {
     else {
         logger.info('REST API is disabled; this instance will not process incoming requests.');
     }
-    if (config.EA_MODE === 'writer' || config.EA_MODE === 'reader-writer') {
+    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)(initializedAdapter, server);
+        (0, background_executor_1.callBackgroundExecutes)(adapter, server);
     }
     else {
         logger.info('Background executor is disabled; this instance will not perform async background executes.');
@@ -63,7 +58,8 @@ const expose = async (adapter, dependencies) => {
     return server;
 };
 exports.expose = expose;
-async function buildRestApi(config, initializedAdapter) {
+async function buildRestApi(adapter) {
+    const { config } = adapter;
     const app = (0, fastify_1.default)();
     // Add healthcheck endpoint before middlewares to bypass them
     app.get((0, path_1.join)(config.BASE_URL, 'health'), (req, res) => {
@@ -71,11 +67,11 @@ async function buildRestApi(config, initializedAdapter) {
     });
     // Use global error handling
     app.setErrorHandler(validation_1.errorCatchingMiddleware);
-    const transportHandler = await (0, transports_1.buildTransportHandler)(initializedAdapter);
+    const transportHandler = await (0, transports_1.buildTransportHandler)(adapter);
     app.register(async (router) => {
         // Set up "middlewares" (hooks in fastify)
-        router.addHook('preHandler', (0, validation_1.validatorMiddleware)(initializedAdapter));
-        router.addHook('preHandler', (0, cache_1.buildCacheMiddleware)(initializedAdapter));
+        router.addHook('preHandler', (0, validation_1.validatorMiddleware)(adapter));
+        router.addHook('preHandler', (0, cache_1.buildCacheMiddleware)(adapter));
         if (config['CORRELATION_ID_ENABLED']) {
             router.addHook('onRequest', util_1.loggingContextMiddleware);
         }
@@ -83,10 +79,50 @@ async function buildRestApi(config, initializedAdapter) {
             url: config.BASE_URL,
             method: 'POST',
             handler: transportHandler,
-        }); // Pass config maybe? cleaner that multiple instances / dependencies
+        });
         if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
             router.addHook('onResponse', metrics_1.buildMetricsMiddleware);
         }
     });
+    // Add smoke endpoint after middleware which are needed for tests
+    buildSmokeEndpoint(app, config);
     return app;
 }
+/**
+ * Adds the /smoke endpoint to the API for smoke testing the adapter
+ *
+ * @param app - the Fastify instance
+ * @param config - the initialized adapter config
+ */
+function buildSmokeEndpoint(app, config) {
+    const testPayload = (0, test_payload_loader_1.loadTestPayload)(config.SMOKE_TEST_PAYLOAD_FILE_NAME);
+    app.get((0, path_1.join)(config.BASE_URL, 'smoke'), async (_, res) => {
+        if (testPayload.isDefault) {
+            return res.status(200).send('OK');
+        }
+        const errors = [];
+        for (const index in testPayload.requests) {
+            try {
+                const request = { id: index, data: testPayload.requests[index] };
+                // Use Fastify's app inject to pass smoke requests internally
+                const response = await app.inject({
+                    method: 'POST',
+                    url: '/',
+                    payload: request,
+                });
+                const parsedResponse = JSON.parse(response.body);
+                // Throw error if not 2xx status code
+                if (parsedResponse.statusCode < 200 || parsedResponse.statusCode > 299) {
+                    throw Error('Smoke test request failed');
+                }
+            }
+            catch (e) {
+                errors.push(e);
+            }
+        }
+        if (errors.length > 0) {
+            return res.status(500).send(errors);
+        }
+        return res.status(200).send('OK');
+    });
+}

package/{package → dist/src}/metrics/index.js

@@ -86,7 +86,6 @@ const buildHttpRequestMetricsLabel = (feedId, error, cacheHit) => {
     }
     else if (error instanceof Error) {
         // If error present and not instance of generic Error, unexpected failure occurred
-        // TODO: Build label with 500 error and withold dp status? Status sent as 200 in error handler
         labels.type = constants_1.HttpRequestType.ADAPTER_ERROR;
         labels.status_code = 500;
     }

package/dist/src/metrics/util.d.ts

@@ -0,0 +1,7 @@
+import { AdapterMetricsMeta, AdapterRequestData } from '../util';
+import { AdapterEndpoint } from '../adapter';
+import { AdapterConfig, SettingsMap } from '../config';
+export declare const getMetricsMeta: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
+    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
+    adapterConfig: AdapterConfig<CustomSettings>;
+}, data: AdapterRequestData) => AdapterMetricsMeta;

package/{package → dist/src}/metrics/util.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMetricsMeta = void 0;
 const cache_1 = require("../cache");
-const getMetricsMeta = (endpoint, data) => {
-    const feedId = (0, cache_1.calculateFeedId)(endpoint, data);
+const getMetricsMeta = ({ adapterEndpoint, adapterConfig, }, data) => {
+    const feedId = (0, cache_1.calculateFeedId)({ adapterEndpoint, adapterConfig }, data);
     return { feedId };
 };
 exports.getMetricsMeta = getMetricsMeta;

package/{adapter.d.ts → dist/src/package/adapter.d.ts}

@@ -74,7 +74,7 @@ export interface InitializedAdapter extends Adapter {
  * @param rateLimitingConfig - details from the adapter regarding rate limiting
  * @returns a set of AdapterDependencies all initialized
  */
-export declare const initializeDependencies: (adapter: Adapter, config: AdapterConfig, inputDependencies?: Partial<AdapterDependencies> | undefined) => AdapterDependencies;
+export declare const initializeDependencies: (adapter: Adapter, config: AdapterConfig, inputDependencies?: Partial<AdapterDependencies>) => AdapterDependencies;
 /**
  * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
  * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
@@ -84,5 +84,5 @@ export declare const initializeDependencies: (adapter: Adapter, config: AdapterC
  * @param config - configuration variables already processed and validated
  * @returns - the adapter with all transports initialized and aliases map built
  */
-export declare const initializeAdapter: (adapter: Adapter, config: AdapterConfig, dependencies?: Partial<AdapterDependencies> | undefined) => Promise<InitializedAdapter>;
+export declare const initializeAdapter: (adapter: Adapter, config: AdapterConfig, dependencies?: Partial<AdapterDependencies>) => Promise<InitializedAdapter>;
 export {};

package/{package → dist/src/package}/config/provider-limits.js

@@ -42,7 +42,8 @@ const getProviderLimits = (provider, limits, tier, protocol) => {
     return limitsConfig;
 };
 const parseLimits = (limits) => {
-    const _mapObject = (fn) => (o) => Object.fromEntries(Object.entries(o).map(fn));
+    // const _mapObject = (fn: any) => (o: any) => Object.fromEntries(Object.entries(o).map(fn))
+    const _mapObject = (fn) => (o) => Object.fromEntries([]);
     const _formatProtocol = _mapObject((entry) => {
         const [tierName, rest] = entry;
         return [tierName.toLowerCase(), { ...rest }];

package/{index.d.ts → dist/src/package/index.d.ts}

@@ -9,4 +9,4 @@ import { AdapterDependencies } from './transports';
  * @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<Server | undefined>;

package/dist/src/package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@chainlink/external-adapter-framework",
+  "version": "0.0.6",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.27.2",
+    "fastify": "^3.29.0",
+    "ioredis": "^5.0.4",
+    "pino": "^7.9.2",
+    "prom-client": "13.2.0",
+    "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"
+  },
+  "devDependencies": {
+    "@sinonjs/fake-timers": "^9.1.2",
+    "@types/node": "^18.6.5",
+    "@types/sinonjs__fake-timers": "^8.1.2",
+    "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "ava": "^4.2.0",
+    "c8": "^7.11.2",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-tsdoc": "^0.2.16",
+    "mock-socket": "^9.1.3",
+    "nock": "^13.2.4",
+    "pino-pretty": "^7.6.0",
+    "prettier": "^2.6.1",
+    "ts-loader": "^9.3.1",
+    "typedoc": "^0.22.15",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0"
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "printWidth": 100,
+    "endOfLine": "auto",
+    "trailingComma": "all",
+    "arrowParens": "always"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.6",
+    "utf-8-validate": "^5.0.9"
+  },
+  "ava": {
+    "files": [
+      "test/**/*.test.ts"
+    ],
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "workerThreads": false,
+    "environmentVariables": {
+      "METRICS_ENABLED": "false"
+    }
+  }
+}

package/{package → dist/src/package}/rate-limiting/index.d.ts

@@ -43,7 +43,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.
  *
@@ -51,4 +51,4 @@ export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier | und
  * @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;
+export declare const getRateLimitingTier: (tiers?: Record<string, AdapterRateLimitTier>, selectedTier?: string) => AdapterRateLimitTier | undefined;

package/{package → dist/src/package}/transports/metrics.d.ts

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