@chainlink/external-adapter-framework 0.32.0 → 0.33.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)
 
 > **Warning**
 > This framework is in a Beta state, and under active development. While many of the features from version 2 are present, they have not been tested extensively enough to mark this as production ready. You can find v2 in the [External Adapters Monorepo](https://github.com/smartcontractkit/external-adapters-js)

package/adapter/index.d.ts

@@ -2,3 +2,4 @@ export * from './basic';
 export * from './price';
 export * from './endpoint';
 export * from './types';
+export * from './lwba';

package/adapter/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./basic"), exports);
 __exportStar(require("./price"), exports);
 __exportStar(require("./endpoint"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./lwba"), 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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,0CAAuB;AACvB,6CAA0B;AAC1B,0CAAuB;AACvB,yCAAsB"}

package/adapter/lwba.d.ts

@@ -0,0 +1,47 @@
+import { TransportGenerics } from '../transports';
+import { AdapterEndpoint } from './endpoint';
+import { AdapterEndpointParams, PriceEndpointInputParametersDefinition } from './index';
+/**
+ * Type for the base input parameter config that any [[LwbaEndpoint]] must extend
+ */
+export type LwbaEndpointInputParametersDefinition = PriceEndpointInputParametersDefinition;
+/**
+ * Base input parameter config that any [[LwbaEndpoint]] must extend
+ */
+export declare const lwbaEndpointInputParametersDefinition: {
+    readonly base: {
+        readonly aliases: readonly ["from", "coin"];
+        readonly type: "string";
+        readonly description: "The symbol of symbols of the currency to query";
+        readonly required: true;
+    };
+    readonly quote: {
+        readonly aliases: readonly ["to", "market"];
+        readonly type: "string";
+        readonly description: "The symbol of the currency to convert to";
+        readonly required: true;
+    };
+};
+export type LwbaResponseDataFields = {
+    Result: null;
+    Data: {
+        mid: number;
+        bid: number;
+        ask: number;
+    };
+};
+/**
+ * Helper type structure that contains the different types passed to the generic parameters of a PriceEndpoint
+ */
+export type LwbaEndpointGenerics = TransportGenerics & {
+    Parameters: LwbaEndpointInputParametersDefinition;
+    Response: LwbaResponseDataFields;
+};
+export declare const DEFAULT_LWBA_ALIASES: string[];
+/**
+ * An LwbaEndpoint is a specific type of AdapterEndpoint. Meant to comply with standard practices for
+ * LWBA (lightweight bid/ask) Data Feeds, its InputParameters must extend the basic ones (base/quote).
+ */
+export declare class LwbaEndpoint<T extends LwbaEndpointGenerics> extends AdapterEndpoint<T> {
+    constructor(params: AdapterEndpointParams<T>);
+}

package/adapter/lwba.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LwbaEndpoint = exports.DEFAULT_LWBA_ALIASES = exports.lwbaEndpointInputParametersDefinition = void 0;
+const endpoint_1 = require("./endpoint");
+/**
+ * Base input parameter config that any [[LwbaEndpoint]] must extend
+ */
+exports.lwbaEndpointInputParametersDefinition = {
+    base: {
+        aliases: ['from', 'coin'],
+        type: 'string',
+        description: 'The symbol of symbols of the currency to query',
+        required: true,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        type: 'string',
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
+exports.DEFAULT_LWBA_ALIASES = ['crypto-lwba', 'crypto_lwba', 'cryptolwba'];
+/**
+ * An LwbaEndpoint is a specific type of AdapterEndpoint. Meant to comply with standard practices for
+ * LWBA (lightweight bid/ask) Data Feeds, its InputParameters must extend the basic ones (base/quote).
+ */
+class LwbaEndpoint extends endpoint_1.AdapterEndpoint {
+    constructor(params) {
+        if (!params.aliases) {
+            params.aliases = [];
+        }
+        for (const alias of exports.DEFAULT_LWBA_ALIASES) {
+            if (params.name !== alias && !params.aliases.includes(alias)) {
+                params.aliases.push(alias);
+            }
+        }
+        super(params);
+    }
+}
+exports.LwbaEndpoint = LwbaEndpoint;
+//# sourceMappingURL=lwba.js.map

package/adapter/lwba.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lwba.js","sourceRoot":"","sources":["../../../src/adapter/lwba.ts"],"names":[],"mappings":";;;AACA,yCAA4C;AAQ5C;;GAEG;AACU,QAAA,qCAAqC,GAAG;IACnD,IAAI,EAAE;QACJ,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;QACzB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,gDAAgD;QAC7D,QAAQ,EAAE,IAAI;KACf;IACD,KAAK,EAAE;QACL,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC;QACzB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE,IAAI;KACf;CACuD,CAAA;AAmB7C,QAAA,oBAAoB,GAAG,CAAC,aAAa,EAAE,aAAa,EAAE,YAAY,CAAC,CAAA;AAEhF;;;GAGG;AACH,MAAa,YAA6C,SAAQ,0BAAkB;IAClF,YAAY,MAAgC;QAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAA;SACpB;QACD,KAAK,MAAM,KAAK,IAAI,4BAAoB,EAAE;YACxC,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC5D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;aAC3B;SACF;QAED,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;CACF;AAbD,oCAaC"}

package/adapter/por.js

@@ -53,7 +53,13 @@ class PoRAdapter extends basic_1.Adapter {
         // PoR requests take longer to process than normal feeds, that's why by default we set
         // BACKGROUND_EXECUTE_TIMEOUT to the highest value
         if (!params.config) {
-            params.config = new config_1.AdapterConfig({}, { envDefaultOverrides: { BACKGROUND_EXECUTE_TIMEOUT: 180000, API_TIMEOUT: 60000 } });
+            params.config = new config_1.AdapterConfig({}, {
+                envDefaultOverrides: {
+                    BACKGROUND_EXECUTE_TIMEOUT: 180000,
+                    API_TIMEOUT: 60000,
+                    CACHE_MAX_AGE: 360000,
+                },
+            });
         }
         else {
             params.config.options = {
@@ -62,6 +68,7 @@ class PoRAdapter extends basic_1.Adapter {
                     ...(params.config.options?.envDefaultOverrides || {}),
                     BACKGROUND_EXECUTE_TIMEOUT: params.config.options?.envDefaultOverrides?.BACKGROUND_EXECUTE_TIMEOUT ?? 180000,
                     API_TIMEOUT: params.config.options?.envDefaultOverrides?.API_TIMEOUT ?? 60000,
+                    CACHE_MAX_AGE: params.config.options?.envDefaultOverrides?.CACHE_MAX_AGE ?? 360000,
                 },
             };
         }

package/adapter/por.js.map

@@ -1 +1 @@
-{"version":3,"file":"por.js","sourceRoot":"","sources":["../../../src/adapter/por.ts"],"names":[],"mappings":";;;AACA,yCAA4C;AAC5C,sCAAgE;AAChE,mCAAiC;AAIjC,wCAAoC;AAsBpC;;;GAGG;AACH,MAAa,kBAAyD,SAAQ,0BAAkB;CAAG;AAAnG,gDAAmG;AAgCnG;;GAEG;AACU,QAAA,2CAA2C,GAAG;IACzD,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,KAAK,EAAE,IAAI;QACX,IAAI,EAAE;YACJ,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,kCAAkC;gBAC/C,QAAQ,EAAE,IAAI;aACf;SACF;QACD,WAAW,EACT,mGAAmG;QACrG,QAAQ,EAAE,IAAI;KACf;CAC6D,CAAA;AAUhE;;;GAGG;AACH,MAAa,kBAAyD,SAAQ,0BAAkB;CAAG;AAAnG,gDAAmG;AAenG;;;GAGG;AACH,MAAa,uBAEX,SAAQ,0BAAkB;CAAG;AAF/B,0DAE+B;AAE/B;;;GAGG;AACH,MAAa,UAA4C,SAAQ,eAAU;IACzE,YAAY,MAAwB;QAClC,sFAAsF;QACtF,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,MAAM,CAAC,MAAM,GAAG,IAAI,sBAAa,CAC/B,EAAE,EACF,EAAE,mBAAmB,EAAE,EAAE,0BAA0B,EAAE,MAAO,EAAE,WAAW,EAAE,KAAM,EAAE,EAAE,CAClE,CAAA;SACtB;aAAM;YACL,MAAM,CAAC,MAAM,CAAC,OAAO,GAAG;gBACtB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;gBAChC,mBAAmB,EAAE;oBACnB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,IAAI,EAAE,CAAC;oBACrD,0BAA0B,EACxB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,IAAI,MAAO;oBACnF,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,WAAW,IAAI,KAAM;iBAC/E;aACF,CAAA;SACF;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAC1C,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,YAAY,kBAAkB;YAC/B,CAAC,YAAY,uBAAuB;YACpC,CAAC,YAAY,kBAAkB,CAClC,CAAA;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;QAED,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,GAAyC,EACzC,SAA2B;QAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;QAEvF,IAAI,QAAQ,YAAY,kBAAkB,EAAE;YAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,IAA4C,CAAA;YAC5E,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAC3D,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,CAAA;gBACjE,iBAAO;qBACJ,GAAG,CAAC,yBAAyB,CAAC;qBAC9B,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;qBAC3B,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;aAC9B;SACF;QACD,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IAC5C,CAAC;CACF;AAnDD,gCAmDC"}
+{"version":3,"file":"por.js","sourceRoot":"","sources":["../../../src/adapter/por.ts"],"names":[],"mappings":";;;AACA,yCAA4C;AAC5C,sCAAgE;AAChE,mCAAiC;AAIjC,wCAAoC;AAsBpC;;;GAGG;AACH,MAAa,kBAAyD,SAAQ,0BAAkB;CAAG;AAAnG,gDAAmG;AAgCnG;;GAEG;AACU,QAAA,2CAA2C,GAAG;IACzD,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,KAAK,EAAE,IAAI;QACX,IAAI,EAAE;YACJ,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,kCAAkC;gBAC/C,QAAQ,EAAE,IAAI;aACf;SACF;QACD,WAAW,EACT,mGAAmG;QACrG,QAAQ,EAAE,IAAI;KACf;CAC6D,CAAA;AAUhE;;;GAGG;AACH,MAAa,kBAAyD,SAAQ,0BAAkB;CAAG;AAAnG,gDAAmG;AAenG;;;GAGG;AACH,MAAa,uBAEX,SAAQ,0BAAkB;CAAG;AAF/B,0DAE+B;AAE/B;;;GAGG;AACH,MAAa,UAA4C,SAAQ,eAAU;IACzE,YAAY,MAAwB;QAClC,sFAAsF;QACtF,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,MAAM,CAAC,MAAM,GAAG,IAAI,sBAAa,CAC/B,EAAE,EACF;gBACE,mBAAmB,EAAE;oBACnB,0BAA0B,EAAE,MAAO;oBACnC,WAAW,EAAE,KAAM;oBACnB,aAAa,EAAE,MAAO;iBACvB;aACF,CACkB,CAAA;SACtB;aAAM;YACL,MAAM,CAAC,MAAM,CAAC,OAAO,GAAG;gBACtB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;gBAChC,mBAAmB,EAAE;oBACnB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,IAAI,EAAE,CAAC;oBACrD,0BAA0B,EACxB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,IAAI,MAAO;oBACnF,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,WAAW,IAAI,KAAM;oBAC9E,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,aAAa,IAAI,MAAO;iBACpF;aACF,CAAA;SACF;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAC1C,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,YAAY,kBAAkB;YAC/B,CAAC,YAAY,uBAAuB;YACpC,CAAC,YAAY,kBAAkB,CAClC,CAAA;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;SAC7F;QAED,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,GAAyC,EACzC,SAA2B;QAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;QAEvF,IAAI,QAAQ,YAAY,kBAAkB,EAAE;YAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,IAA4C,CAAA;YAC5E,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAC3D,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,CAAA;gBACjE,iBAAO;qBACJ,GAAG,CAAC,yBAAyB,CAAC;qBAC9B,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;qBAC3B,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;aAC9B;SACF;QACD,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IAC5C,CAAC;CACF;AA1DD,gCA0DC"}

package/package.json

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