@chainlink/external-adapter-framework 2.9.0 → 2.11.0

package/README.md

@@ -1,7 +1,7 @@
 # EA Framework v3
 
 [![NPM version](https://img.shields.io/npm/v/@chainlink/external-adapter-framework.svg?style=flat)](https://www.npmjs.com/package/@chainlink/external-adapter-framework)
-![Coverage](https://img.shields.io/badge/coverage-99.14%25-green)
+![Coverage](https://img.shields.io/badge/coverage-99.15%25-green)
 
 Framework to create External adapters, microservices that serve as middleware to facilitate connections between Chainlink Nodes and Data Providers (DP).
 

package/adapter/market-status.d.ts

@@ -1,17 +1,6 @@
 import { TransportGenerics } from '../transports';
-import { InputParametersDefinition } from '../validation/input-params';
 import { AdapterEndpoint } from './endpoint';
-/**
- * Type for the base input parameter config that any [[MarketStatusEndpoint]] must extend
- */
-export type MarketStatusEndpointInputParametersDefinition = InputParametersDefinition & {
-    market: {
-        aliases: readonly [];
-        type: 'string';
-        description: 'The name of the market';
-        required: boolean;
-    };
-};
+import { AdapterEndpointParams } from './types';
 /**
  * Base input parameter config that any [[MarketStatusEndpoint]] must extend
  */
@@ -22,23 +11,43 @@ export declare const marketStatusEndpointInputParametersDefinition: {
         readonly description: "The name of the market";
         readonly required: true;
     };
+    readonly type: {
+        readonly type: "string";
+        readonly description: "Type of the market status";
+        readonly options: readonly ["regular", "24/5"];
+        readonly default: "regular";
+    };
+    readonly weekend: {
+        readonly type: "string";
+        readonly description: "DHH-DHH:TZ, 520-020:America/New_York means Fri 20:00 to Sun 20:00 Eastern Time Zone";
+    };
 };
 export declare enum MarketStatus {
     UNKNOWN = 0,
     CLOSED = 1,
     OPEN = 2
 }
+export declare enum TwentyfourFiveMarketStatus {
+    UNKNOWN = 0,
+    PRE_MARKET = 1,
+    REGULAR = 2,
+    POST_MARKET = 3,
+    OVERNIGHT = 4,
+    WEEKEND = 5
+}
+type AggregatedMarketStatus = MarketStatus | TwentyfourFiveMarketStatus;
 export type MarketStatusResultResponse = {
-    Result: MarketStatus;
+    Result: AggregatedMarketStatus;
     Data: {
-        result: MarketStatus;
+        result: AggregatedMarketStatus;
+        statusString: string;
     };
 };
 /**
  * Helper type structure that contains the different types passed to the generic parameters of a PriceEndpoint
  */
 export type MarketStatusEndpointGenerics = TransportGenerics & {
-    Parameters: MarketStatusEndpointInputParametersDefinition;
+    Parameters: typeof marketStatusEndpointInputParametersDefinition;
     Response: MarketStatusResultResponse;
 };
 /**
@@ -46,4 +55,6 @@ export type MarketStatusEndpointGenerics = TransportGenerics & {
  * Data Feeds, its InputParameters must extend the basic ones (base).
  */
 export declare class MarketStatusEndpoint<T extends MarketStatusEndpointGenerics> extends AdapterEndpoint<T> {
+    constructor(params: AdapterEndpointParams<T>);
 }
+export {};

package/adapter/market-status.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarketStatusEndpoint = exports.MarketStatus = exports.marketStatusEndpointInputParametersDefinition = void 0;
+exports.MarketStatusEndpoint = exports.TwentyfourFiveMarketStatus = exports.MarketStatus = exports.marketStatusEndpointInputParametersDefinition = void 0;
 const endpoint_1 = require("./endpoint");
+const market_status_1 = require("../validation/market-status");
+const error_1 = require("../validation/error");
 /**
  * Base input parameter config that any [[MarketStatusEndpoint]] must extend
  */
@@ -12,6 +14,16 @@ exports.marketStatusEndpointInputParametersDefinition = {
         description: 'The name of the market',
         required: true,
     },
+    type: {
+        type: 'string',
+        description: 'Type of the market status',
+        options: ['regular', '24/5'],
+        default: 'regular',
+    },
+    weekend: {
+        type: 'string',
+        description: 'DHH-DHH:TZ, 520-020:America/New_York means Fri 20:00 to Sun 20:00 Eastern Time Zone',
+    },
 };
 var MarketStatus;
 (function (MarketStatus) {
@@ -19,11 +31,36 @@ var MarketStatus;
     MarketStatus[MarketStatus["CLOSED"] = 1] = "CLOSED";
     MarketStatus[MarketStatus["OPEN"] = 2] = "OPEN";
 })(MarketStatus || (exports.MarketStatus = MarketStatus = {}));
+var TwentyfourFiveMarketStatus;
+(function (TwentyfourFiveMarketStatus) {
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["UNKNOWN"] = 0] = "UNKNOWN";
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["PRE_MARKET"] = 1] = "PRE_MARKET";
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["REGULAR"] = 2] = "REGULAR";
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["POST_MARKET"] = 3] = "POST_MARKET";
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["OVERNIGHT"] = 4] = "OVERNIGHT";
+    TwentyfourFiveMarketStatus[TwentyfourFiveMarketStatus["WEEKEND"] = 5] = "WEEKEND";
+})(TwentyfourFiveMarketStatus || (exports.TwentyfourFiveMarketStatus = TwentyfourFiveMarketStatus = {}));
 /**
  * A MarketStatusEndpoint is a specific type of AdapterEndpoint. Meant to comply with standard practices for
  * Data Feeds, its InputParameters must extend the basic ones (base).
  */
 class MarketStatusEndpoint extends endpoint_1.AdapterEndpoint {
+    constructor(params) {
+        params.customInputValidation = (req, _adapterSettings) => {
+            const data = req.requestContext.data;
+            if (data['type'] === '24/5') {
+                (0, market_status_1.parseWeekendString)(data['weekend']);
+            }
+            if (data['type'] === 'regular' && data['weekend']) {
+                throw new error_1.AdapterInputError({
+                    statusCode: 400,
+                    message: '[Param: weekend] must be empty when [Param: type] is regular',
+                });
+            }
+            return undefined;
+        };
+        super(params);
+    }
 }
 exports.MarketStatusEndpoint = MarketStatusEndpoint;
 //# sourceMappingURL=market-status.js.map

package/adapter/market-status.js.map

@@ -1 +1 @@
-{"version":3,"file":"market-status.js","sourceRoot":"","sources":["../../../src/adapter/market-status.ts"],"names":[],"mappings":";;;AAEA,yCAA4C;AAc5C;;GAEG;AACU,QAAA,6CAA6C,GAAG;IAC3D,MAAM,EAAE;QACN,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wBAAwB;QACrC,QAAQ,EAAE,IAAI;KACf;CAC+D,CAAA;AAElE,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qDAAW,CAAA;IACX,mDAAU,CAAA;IACV,+CAAQ,CAAA;AACV,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAiBD;;;GAGG;AACH,MAAa,oBAEX,SAAQ,0BAAkB;CAAG;AAF/B,oDAE+B"}
+{"version":3,"file":"market-status.js","sourceRoot":"","sources":["../../../src/adapter/market-status.ts"],"names":[],"mappings":";;;AACA,yCAA4C;AAE5C,+DAAgE;AAChE,+CAAuD;AAEvD;;GAEG;AACU,QAAA,6CAA6C,GAAG;IAC3D,MAAM,EAAE;QACN,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wBAAwB;QACrC,QAAQ,EAAE,IAAI;KACf;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,2BAA2B;QACxC,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;QAC5B,OAAO,EAAE,SAAS;KACnB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,qFAAqF;KACxF;CACO,CAAA;AAEV,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qDAAW,CAAA;IACX,mDAAU,CAAA;IACV,+CAAQ,CAAA;AACV,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAED,IAAY,0BAOX;AAPD,WAAY,0BAA0B;IACpC,iFAAW,CAAA;IACX,uFAAc,CAAA;IACd,iFAAW,CAAA;IACX,yFAAe,CAAA;IACf,qFAAa,CAAA;IACb,iFAAW,CAAA;AACb,CAAC,EAPW,0BAA0B,0CAA1B,0BAA0B,QAOrC;AAoBD;;;GAGG;AACH,MAAa,oBAEX,SAAQ,0BAAkB;IAC1B,YAAY,MAAgC;QAC1C,MAAM,CAAC,qBAAqB,GAAG,CAAC,GAAG,EAAE,gBAAgB,EAAE,EAAE;YACvD,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,IAA8B,CAAA;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,MAAM,EAAE,CAAC;gBAC5B,IAAA,kCAAkB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;YACrC,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,yBAAiB,CAAC;oBAC1B,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,8DAA8D;iBACxE,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC,CAAA;QACD,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;CACF;AAnBD,oDAmBC"}

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "main": "dist/index.js",
   "license": "MIT",
   "repository": "git://github.com/smartcontractkit/ea-framework-js.git",
   "dependencies": {
     "ajv": "8.17.1",
-    "axios": "1.13.1",
+    "axios": "1.13.2",
     "eventsource": "4.0.0",
-    "fastify": "5.6.1",
+    "fastify": "5.6.2",
     "ioredis": "5.8.2",
     "mock-socket": "9.3.1",
     "pino": "10.1.0",
     "pino-pretty": "13.1.2",
     "prom-client": "15.1.3",
     "redlock": "5.0.0-beta.2",
-    "ws": "8.18.3"
+    "ws": "8.18.3",
+    "@date-fns/tz": "1.4.1"
   },
   "scripts": {
     "build": "rm -rf dist/src && mkdir -p ./dist/src && cp package.json dist/src && cp README.md dist/src && tsc && yarn pre-build-generator",
@@ -40,12 +41,12 @@
     "@types/node": "24.10.0",
     "@types/sinonjs__fake-timers": "15.0.1",
     "@types/ws": "8.18.1",
-    "@typescript-eslint/eslint-plugin": "8.46.2",
-    "@typescript-eslint/parser": "8.46.2",
+    "@typescript-eslint/eslint-plugin": "8.46.3",
+    "@typescript-eslint/parser": "8.46.3",
     "ava": "6.4.1",
     "axios-mock-adapter": "2.1.0",
     "c8": "10.1.3",
-    "eslint": "9.39.0",
+    "eslint": "9.39.1",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-tsdoc": "0.4.0",
     "mocksse": "1.0.4",

package/validation/market-status.d.ts

@@ -0,0 +1,6 @@
+export declare const parseWeekendString: (weekend?: string) => {
+    start: string;
+    end: string;
+    tz: string;
+};
+export declare const isWeekendNow: (weekend?: string) => boolean;

package/validation/market-status.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWeekendNow = exports.parseWeekendString = void 0;
+const error_1 = require("../validation/error");
+const tz_1 = require("@date-fns/tz");
+const parseWeekendString = (weekend) => {
+    const dayHour = /[0-6](0\d|1\d|2[0-3])/;
+    const timezonePattern = /[^\s]+/;
+    const regex = new RegExp(`^(${dayHour.source})-(${dayHour.source}):(${timezonePattern.source})$`);
+    const match = weekend?.match(regex);
+    if (!match) {
+        throw new error_1.AdapterInputError({
+            statusCode: 400,
+            message: '[Param: weekend] does not match format of DHH-DHH:TZ',
+        });
+    }
+    const result = {
+        start: match[1],
+        end: match[3],
+        tz: match[5],
+    };
+    try {
+        // eslint-disable-next-line new-cap
+        Intl.DateTimeFormat(undefined, { timeZone: result.tz });
+    }
+    catch (error) {
+        throw new error_1.AdapterInputError({
+            statusCode: 400,
+            message: `timezone ${result.tz} in [Param: weekend] is not valid: ${error}`,
+        });
+    }
+    return result;
+};
+exports.parseWeekendString = parseWeekendString;
+const isWeekendNow = (weekend) => {
+    const parsed = (0, exports.parseWeekendString)(weekend);
+    const startDay = Number(parsed.start[0]);
+    const startHour = Number(parsed.start.slice(1));
+    const endDay = Number(parsed.end[0]);
+    const endHour = Number(parsed.end.slice(1));
+    const nowDay = tz_1.TZDate.tz(parsed.tz).getDay();
+    const nowHour = tz_1.TZDate.tz(parsed.tz).getHours();
+    // Case 1: weekend does NOT wrap around the week
+    if (startDay < endDay || (startDay === endDay && startHour < endHour)) {
+        if (nowDay < startDay || nowDay > endDay) {
+            return false;
+        }
+        else if (nowDay === startDay && nowHour < startHour) {
+            return false;
+        }
+        else if (nowDay === endDay && nowHour >= endHour) {
+            return false;
+        }
+        return true;
+    }
+    // Case 2: weekend wraps around (e.g. Fri → Sun)
+    if (nowDay > startDay || nowDay < endDay) {
+        return true;
+    }
+    else if (nowDay === startDay && nowHour >= startHour) {
+        return true;
+    }
+    else if (nowDay === endDay && nowHour < endHour) {
+        return true;
+    }
+    return false;
+};
+exports.isWeekendNow = isWeekendNow;
+//# sourceMappingURL=market-status.js.map

package/validation/market-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"market-status.js","sourceRoot":"","sources":["../../../src/validation/market-status.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AACvD,qCAAqC;AAE9B,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAE,EAAE;IACrD,MAAM,OAAO,GAAG,uBAAuB,CAAA;IACvC,MAAM,eAAe,GAAG,QAAQ,CAAA;IAChC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,MAAM,OAAO,CAAC,MAAM,MAAM,eAAe,CAAC,MAAM,IAAI,CAAC,CAAA;IAEjG,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IACnC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,yBAAiB,CAAC;YAC1B,UAAU,EAAE,GAAG;YACf,OAAO,EAAE,sDAAsD;SAChE,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACf,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACb,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;KACb,CAAA;IAED,IAAI,CAAC;QACH,mCAAmC;QACnC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,yBAAiB,CAAC;YAC1B,UAAU,EAAE,GAAG;YACf,OAAO,EAAE,YAAY,MAAM,CAAC,EAAE,sCAAsC,KAAK,EAAE;SAC5E,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AA9BY,QAAA,kBAAkB,sBA8B9B;AAEM,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAE,EAAE;IAC/C,MAAM,MAAM,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAA;IAE1C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACpC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3C,MAAM,MAAM,GAAG,WAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;IAC5C,MAAM,OAAO,GAAG,WAAM,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;IAE/C,gDAAgD;IAChD,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,KAAK,MAAM,IAAI,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;QACtE,IAAI,MAAM,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;YACzC,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,IAAI,MAAM,KAAK,QAAQ,IAAI,OAAO,GAAG,SAAS,EAAE,CAAC;YACtD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,IAAI,MAAM,KAAK,MAAM,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,gDAAgD;IAChD,IAAI,MAAM,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;QACvD,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,MAAM,KAAK,MAAM,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;QAClD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAhCY,QAAA,YAAY,gBAgCxB"}