@chainlink/external-adapter-framework 0.0.12 → 0.0.14

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

@@ -0,0 +1,2 @@
+import { AdapterEndpoint } from '../../adapter';
+export declare const restEndpoint: AdapterEndpoint;

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

@@ -1,7 +1,6 @@
 "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 = {
@@ -43,9 +42,9 @@ const restEndpointTransport = new transports_1.RestTransport({
         coalescing: true,
     },
 });
-exports.restEndpoint = new adapter_1.AdapterEndpoint({
+exports.restEndpoint = {
     name: 'rest',
     aliases: ['qwe'],
     transport: restEndpointTransport,
     inputParameters,
-});
+};

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

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter;

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

@@ -1,11 +1,10 @@
 "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 = new adapter_1.Adapter({
+exports.adapter = {
     name: 'ncfx',
     endpoints: [websocket_1.webSocketEndpoint],
     customSettings: config_1.customSettings,
-});
+};

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

@@ -32,16 +32,5 @@ export declare const websocketTransport: WebSocketTransport<AdapterRequestParams
         readonly required: true;
     };
 }>;
-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 declare const webSocketEndpoint: AdapterEndpoint;
 export {};

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

@@ -1,7 +1,6 @@
 "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 = {
@@ -66,8 +65,8 @@ exports.websocketTransport = new websocket_1.WebSocketTransport({
         }),
     },
 });
-exports.webSocketEndpoint = new adapter_1.AdapterEndpoint({
+exports.webSocketEndpoint = {
     name: 'websocket',
     transport: exports.websocketTransport,
     inputParameters: exports.inputParameters,
-});
+};

package/package.json

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

package/{dist/src/rate-limiting → rate-limiting}/background/fixed-frequency.d.ts

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

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

@@ -1,5 +1,4 @@
 import { AdapterEndpoint } from '../adapter';
-import { SettingsMap } from '../config';
 export * from './request/simple-counting';
 export * from './background/fixed-frequency';
 export interface AdapterRateLimitTier {
@@ -18,7 +17,7 @@ export interface RateLimiter {
      * @param limits - settings for how much throughput to allow for the Adapter
      * @param endpoints - list of adapter endpoints
      */
-    initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits: AdapterRateLimitTier): this;
+    initialize(endpoints: AdapterEndpoint[], limits: AdapterRateLimitTier): this;
 }
 /**
  * RequestRateLimiters perform checks agains imminent outbound requests for any transport.

package/{dist/src/rate-limiting → rate-limiting}/request/simple-counting.d.ts

@@ -1,6 +1,5 @@
 import { AdapterRateLimitTier, RateLimiter } from '..';
 import { AdapterEndpoint } from '../../adapter';
-import { SettingsMap } from '../../config';
 /**
  * This rate limiter is the simplest stateful option.
  * On startup, it'll compare the different thresholds for each tier, calculate them all
@@ -16,6 +15,6 @@ export declare class SimpleCountingRateLimiter implements RateLimiter {
     requestsThisMinute: number;
     perSecondLimit: number;
     perMinuteLimit: number;
-    initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits?: AdapterRateLimitTier): this;
+    initialize(endpoints: AdapterEndpoint[], limits?: AdapterRateLimitTier): this;
     isUnderLimits(): boolean;
 }

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

@@ -1,5 +1,5 @@
 import { FastifyReply } from 'fastify';
-import { AdapterContext, AdapterDependencies, Adapter } from '../adapter';
+import { AdapterContext, AdapterDependencies, InitializedAdapter } from '../adapter';
 import { CacheEntry } from '../cache';
 import { AdapterConfig, SettingsMap } from '../config';
 import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
@@ -67,4 +67,4 @@ export declare const buildCacheEntriesFromResults: <Params, CustomSettings exten
  * @param adapter - main adapter object, already initialized
  * @returns the transport handler middleware function
  */
-export declare const buildTransportHandler: (adapter: Adapter) => (req: AdapterRequest, reply: FastifyReply) => Promise<never>;
+export declare const buildTransportHandler: (adapter: InitializedAdapter) => (req: AdapterRequest, reply: FastifyReply) => Promise<never>;

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

@@ -1,6 +1,5 @@
 import * as client from 'prom-client';
 import { AdapterContext } from '../adapter';
-import { SettingsMap } from '../config';
 export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
     provider_status_code: number | undefined;
     method: string;
@@ -14,7 +13,7 @@ export declare const messageSubsLabels: (feed_id: string, cache_key: string) =>
     feed_id: string;
     subscription_key: string;
 };
-export declare const recordWsMessageMetrics: <AdapterParams, CustomSettings extends SettingsMap>(context: AdapterContext<CustomSettings>, subscribes: AdapterParams[], unsubscrices: AdapterParams[]) => void;
+export declare const recordWsMessageMetrics: <AdapterParams>(context: AdapterContext, subscribes: AdapterParams[], unsubscrices: AdapterParams[]) => void;
 export declare const wsConnectionActive: client.Gauge<"url">;
 export declare const wsConnectionErrors: client.Counter<"message" | "url">;
 export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "connection_url" | "subscription_key">;

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

@@ -1,11 +1,12 @@
 import WebSocket from 'ws';
 import { AdapterContext, AdapterDependencies } from '../adapter';
 import { Cache } from '../cache';
-import { AdapterConfig, SettingsMap } from '../config';
+import { SettingsMap } from '../config';
 import { BackgroundExecuteRateLimiter } from '../rate-limiting';
 import { SubscriptionSet } from '../util';
 import { AdapterRequest, ProviderResult } from '../util/request';
 import { Transport } from './';
+export declare const DEFAULT_WS_TTL = 10000;
 declare type WebSocketClass = new (url: string, protocols?: string | string[] | undefined) => WebSocket;
 export declare class WebSocketClassProvider {
     static ctor: WebSocketClass;
@@ -71,7 +72,7 @@ export declare class WebSocketTransport<AdapterParams, ProviderDataMessage, Cust
     constructor(config: WebSocketTransportConfig<AdapterParams, ProviderDataMessage, CustomSettings>);
     initialize(dependencies: AdapterDependencies): Promise<void>;
     hasBeenSetUp(req: AdapterRequest<AdapterParams>): Promise<boolean>;
-    setup(req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>): Promise<void>;
+    setup(req: AdapterRequest<AdapterParams>): Promise<void>;
     serializeMessage(payload: unknown): string;
     deserializeMessage(data: WebSocket.Data): ProviderDataMessage;
     establishWsConnection(context: AdapterContext<CustomSettings>): Promise<unknown>;

package/{dist/src/transports → transports}/websocket.js

@@ -26,11 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebSocketTransport = exports.WebSocketClassProvider = void 0;
+exports.WebSocketTransport = exports.WebSocketClassProvider = exports.DEFAULT_WS_TTL = void 0;
 const ws_1 = __importDefault(require("ws"));
 const util_1 = require("../util");
 const _1 = require("./");
 const transportMetrics = __importStar(require("./metrics"));
+// TODO: Config
+exports.DEFAULT_WS_TTL = 10000;
 const logger = (0, util_1.makeLogger)('WebSocketTransport');
 class WebSocketClassProvider {
     static set(ctor) {
@@ -64,9 +66,9 @@ class WebSocketTransport {
     async hasBeenSetUp(req) {
         return !!(await this.subscriptionSet.get(req.requestContext.cacheKey));
     }
-    async setup(req, config) {
+    async setup(req) {
         logger.debug(`Adding entry to subscription set: [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
-        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WS_SUBSCRIPTION_TTL);
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, exports.DEFAULT_WS_TTL);
     }
     // TODO: Maybe we don't do this, and leave the preparation on the adapter's side?
     // TODO: Maybe we store adapter params pre-prepared? That would be more efficient
@@ -82,7 +84,7 @@ class WebSocketTransport {
             const ctor = WebSocketClassProvider.get();
             this.wsConnection = new ctor(this.config.url);
             this.wsConnection.addEventListener('open', async (event) => {
-                logger.debug(`Opened websocket connection. (event type ${event.type})`);
+                logger.debug(`Opened websocket connection.`);
                 await this.config.handlers.open(this.wsConnection, context);
                 logger.debug('Successfully executed connection opened handler');
                 // Record active ws connections by incrementing count on open

package/{dist/src/util → util}/request.d.ts

@@ -1,5 +1,5 @@
 import { FastifyReply, FastifyRequest, HookHandlerDoneFunction } from 'fastify';
-import { Adapter } from '../adapter';
+import { InitializedAdapter } from '../adapter';
 import { AdapterError } from '../validation/error';
 declare module 'fastify' {
     interface FastifyRequest {
@@ -54,4 +54,4 @@ export declare type AdapterResponse<T = unknown> = {
     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;
+export declare type AdapterMiddlewareBuilder = (adapter: InitializedAdapter) => Middleware;

package/{dist/src/validation → validation}/error.d.ts

@@ -18,9 +18,9 @@ export declare class AdapterError extends Error {
     jobRunID: string;
     status: string;
     statusCode: number;
-    cause: unknown;
+    cause: any;
     url?: string;
-    errorResponse: unknown;
+    errorResponse: any;
     feedID?: string;
     providerStatusCode?: number;
     metricsLabel?: HttpRequestType;

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/.c8rc.json

@@ -1,3 +0,0 @@
-{
-  "reporter": ["lcov", "text"]
-}

package/.eslintignore

@@ -1,9 +0,0 @@
-# don't ever lint node_modules
-node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
-dist
-# don't lint coverage output
-coverage
-
-.yarn
-.vscode

package/.eslintrc.js

@@ -1,96 +0,0 @@
-// https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc'],
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
-  rules: {
-    'tsdoc/syntax': 'warn',
-
-    // Problems
-    'array-callback-return': [
-      'error',
-      {
-        allowImplicit: false,
-        checkForEach: true,
-      },
-    ],
-    'no-constant-binary-expression': 'error',
-    'no-constructor-return': 'error',
-    'no-duplicate-imports': 'error',
-    'no-promise-executor-return': 'error',
-    'no-self-compare': 'error',
-    'no-template-curly-in-string': 'error',
-    'no-unmodified-loop-condition': 'error',
-    'no-unreachable-loop': 'error',
-    'no-unused-private-class-members': 'error',
-    'require-atomic-updates': 'error',
-
-    // Suggestions
-    'capitalized-comments': ['error', 'always', { ignoreConsecutiveComments: true }],
-    complexity: ['error', 25], // TODO: Should be lower (15?), but validator has complex methods
-    curly: 'error',
-    'default-case-last': 'error',
-    'default-param-last': 'error',
-    eqeqeq: ['error', 'smart'],
-    'func-names': 'error',
-    'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-    'grouped-accessor-pairs': ['error', 'getBeforeSet'],
-    'max-depth': ['error', 4], // TODO: Should be lower (3), but validator has complex methods
-    'max-nested-callbacks': ['error', 2],
-    'max-params': ['error', 4], // TODO: Should be lower (3), but validator has complex methods,
-    'new-cap': ['error', { newIsCapExceptions: ['ctor'] }],
-    'no-caller': 'error',
-    'no-confusing-arrow': [
-      'error',
-      {
-        allowParens: true,
-      },
-    ],
-    'no-console': ['warn'], // We want this to debug, but the check workflow should accept no warns
-    'no-div-regex': 'error',
-    'no-eval': 'error',
-    'no-extend-native': 'error',
-    'no-extra-bind': 'error',
-    'no-extra-label': 'error',
-    'no-extra-semi': 'error',
-    'no-floating-decimal': 'error',
-    'no-implied-eval': 'error',
-    'no-invalid-this': 'error',
-    'no-labels': 'error',
-    'no-lonely-if': 'error',
-    'no-multi-assign': 'error',
-    'no-multi-str': 'error',
-    'no-nested-ternary': 'error',
-    'no-new': 'error',
-    'no-new-func': 'error',
-    'no-new-object': 'error',
-    'no-new-wrappers': 'error',
-    'no-param-reassign': 'error',
-    'no-proto': 'error',
-    'no-return-assign': 'error',
-    'no-return-await': 'error',
-    'no-sequences': 'error',
-    'no-shadow': 'off',
-    '@typescript-eslint/no-shadow': 'error', // https://stackoverflow.com/questions/63961803/eslint-says-all-enums-in-typescript-app-are-already-declared-in-the-upper-scope
-    'no-unneeded-ternary': 'error',
-    'no-useless-call': 'error',
-    'no-useless-computed-key': 'error',
-    'no-useless-concat': 'error',
-    'no-useless-rename': 'error',
-    'no-var': 'error',
-    'operator-assignment': ['error', 'always'],
-    'prefer-arrow-callback': 'error',
-    'prefer-const': 'error',
-    'prefer-exponentiation-operator': 'error',
-    'prefer-object-spread': 'error',
-    'prefer-promise-reject-errors': 'error',
-    'prefer-regex-literals': 'error',
-    'prefer-rest-params': 'error',
-    'prefer-spread': 'error',
-    'prefer-template': 'error',
-    'spaced-comment': ['error', 'always'],
-    'symbol-description': 'error',
-    yoda: 'error',
-  },
-}