@chainlink/external-adapter-framework 1.2.0 → 1.3.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.17%25-green)
+![Coverage](https://img.shields.io/badge/coverage-99.18%25-green)
 
 Framework to create External adapters, microservices that serve as middleware to facilitate connections between Chainlink Nodes and Data Providers (DP).
 

package/adapter/index.d.ts

@@ -1,5 +1,6 @@
 export * from './basic';
-export * from './price';
 export * from './endpoint';
-export * from './types';
 export * from './lwba';
+export * from './market-status';
+export * from './price';
+export * from './types';

package/adapter/index.js

@@ -15,8 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./basic"), exports);
-__exportStar(require("./price"), exports);
 __exportStar(require("./endpoint"), exports);
-__exportStar(require("./types"), exports);
 __exportStar(require("./lwba"), exports);
+__exportStar(require("./market-status"), exports);
+__exportStar(require("./price"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/adapter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,0CAAuB;AACvB,6CAA0B;AAC1B,0CAAuB;AACvB,yCAAsB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,6CAA0B;AAC1B,yCAAsB;AACtB,kDAA+B;AAC/B,0CAAuB;AACvB,0CAAuB"}

package/adapter/market-status.d.ts

@@ -0,0 +1,49 @@
+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;
+    };
+};
+/**
+ * Base input parameter config that any [[MarketStatusEndpoint]] must extend
+ */
+export declare const marketStatusEndpointInputParametersDefinition: {
+    readonly market: {
+        readonly aliases: readonly [];
+        readonly type: "string";
+        readonly description: "The name of the market";
+        readonly required: true;
+    };
+};
+export declare enum MarketStatus {
+    UNKNOWN = 0,
+    CLOSED = 1,
+    OPEN = 2
+}
+export type MarketStatusResultResponse = {
+    Result: MarketStatus;
+    Data: {
+        result: MarketStatus;
+    };
+};
+/**
+ * Helper type structure that contains the different types passed to the generic parameters of a PriceEndpoint
+ */
+export type MarketStatusEndpointGenerics = TransportGenerics & {
+    Parameters: MarketStatusEndpointInputParametersDefinition;
+    Response: MarketStatusResultResponse;
+};
+/**
+ * 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).
+ */
+export declare class MarketStatusEndpoint<T extends MarketStatusEndpointGenerics> extends AdapterEndpoint<T> {
+}

package/adapter/market-status.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarketStatusEndpoint = exports.MarketStatus = exports.marketStatusEndpointInputParametersDefinition = void 0;
+const endpoint_1 = require("./endpoint");
+/**
+ * Base input parameter config that any [[MarketStatusEndpoint]] must extend
+ */
+exports.marketStatusEndpointInputParametersDefinition = {
+    market: {
+        aliases: [],
+        type: 'string',
+        description: 'The name of the market',
+        required: true,
+    },
+};
+var MarketStatus;
+(function (MarketStatus) {
+    MarketStatus[MarketStatus["UNKNOWN"] = 0] = "UNKNOWN";
+    MarketStatus[MarketStatus["CLOSED"] = 1] = "CLOSED";
+    MarketStatus[MarketStatus["OPEN"] = 2] = "OPEN";
+})(MarketStatus = exports.MarketStatus || (exports.MarketStatus = {}));
+/**
+ * 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 {
+}
+exports.MarketStatusEndpoint = MarketStatusEndpoint;
+//# sourceMappingURL=market-status.js.map

package/adapter/market-status.js.map

@@ -0,0 +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,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAiBD;;;GAGG;AACH,MAAa,oBAEX,SAAQ,0BAAkB;CAAG;AAF/B,oDAE+B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
@@ -14,8 +14,8 @@
     "pino-pretty": "9.1.0",
     "prom-client": "13.2.0",
     "redlock": "5.0.0-beta.2",
-    "yeoman-generator": "3.1.1",
-    "ws": "8.9.0"
+    "ws": "8.9.0",
+    "yeoman-generator": "3.1.1"
   },
   "scripts": {
     "build": "mkdir -p ./dist/src && cp package.json dist/src && cp README.md dist/src && tsc && yarn build-generator",
@@ -39,6 +39,7 @@
     "@types/node": "18.15.13",
     "@types/sinonjs__fake-timers": "8.1.2",
     "@types/ws": "8.5.3",
+    "@types/yeoman-generator": "5.2.11",
     "@typescript-eslint/eslint-plugin": "5.59.0",
     "@typescript-eslint/parser": "5.59.0",
     "ava": "5.2.0",
@@ -52,8 +53,7 @@
     "ts-node": "10.9.1",
     "ts-node-dev": "2.0.0",
     "typedoc": "0.23.21",
-    "typescript": "5.0.4",
-    "@types/yeoman-generator": "5.2.11"
+    "typescript": "5.0.4"
   },
   "prettier": {
     "semi": false,