@chainlink/external-adapter-framework 0.0.12 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. package/.eslintignore +1 -0
  2. package/.github/README.MD +35 -10
  3. package/.github/workflows/label.yaml +39 -0
  4. package/.github/workflows/publish.yaml +0 -3
  5. package/dist/examples/coingecko/test/e2e/adapter.test.ts.js +82953 -0
  6. package/dist/examples/coingecko/test/integration/adapter.test.ts.js +91672 -0
  7. package/dist/main.js +72703 -0
  8. package/jest.config.js +5 -0
  9. package/package.json +14 -3
  10. package/src/config/provider-limits.ts +14 -17
  11. package/src/examples/coingecko/src/config/index.ts +12 -0
  12. package/src/examples/coingecko/src/config/overrides.json +10826 -0
  13. package/src/examples/coingecko/src/cryptoUtils.ts +88 -0
  14. package/src/examples/coingecko/src/endpoint/coins.ts +54 -0
  15. package/src/examples/coingecko/src/endpoint/crypto-marketcap.ts +66 -0
  16. package/src/examples/coingecko/src/endpoint/crypto-volume.ts +66 -0
  17. package/src/examples/coingecko/src/endpoint/crypto.ts +63 -0
  18. package/src/examples/coingecko/src/endpoint/dominance.ts +40 -0
  19. package/src/examples/coingecko/src/endpoint/global-marketcap.ts +40 -0
  20. package/src/examples/coingecko/src/endpoint/index.ts +6 -0
  21. package/src/examples/coingecko/src/globalUtils.ts +78 -0
  22. package/src/examples/coingecko/src/index.ts +17 -0
  23. package/src/examples/coingecko/test/e2e/adapter.test.ts +278 -0
  24. package/src/examples/coingecko/test/integration/__snapshots__/adapter.test.ts.snap +15 -0
  25. package/src/examples/coingecko/test/integration/adapter.test.ts +281 -0
  26. package/src/examples/coingecko/test/integration/capturedRequests.json +1 -0
  27. package/src/examples/coingecko/test/integration/fixtures.ts +42 -0
  28. package/src/examples/{coingecko → coingecko-old}/batch-warming.ts +1 -0
  29. package/src/examples/{coingecko → coingecko-old}/index.ts +0 -0
  30. package/src/examples/{coingecko → coingecko-old}/rest.ts +0 -0
  31. package/src/transports/batch-warming.ts +7 -2
  32. package/src/transports/rest.ts +5 -1
  33. package/src/util/index.ts +1 -0
  34. package/src/util/recordRequests.ts +47 -0
  35. package/src/validation/overrideFunctions.ts +44 -0
  36. package/test/metrics/warmer-metrics.test.ts +1 -0
  37. package/test/{smoke.test.ts → smoke/smoke.test.ts} +13 -13
  38. package/{test-payload-fail.json → test/smoke/test-payload-fail.json} +0 -0
  39. package/{test-payload.js → test/smoke/test-payload.js} +0 -0
  40. package/{test-payload.json → test/smoke/test-payload.json} +0 -0
  41. package/test/transports/batch.test.ts +1 -0
  42. package/tsconfig.json +4 -1
  43. package/webpack.config.js +39 -5
  44. package/yarn-error.log +3778 -0
  45. package/dist/src/adapter.d.ts +0 -135
  46. package/dist/src/adapter.js +0 -145
  47. package/dist/src/background-executor.d.ts +0 -11
  48. package/dist/src/background-executor.js +0 -45
  49. package/dist/src/cache/factory.d.ts +0 -6
  50. package/dist/src/cache/factory.js +0 -55
  51. package/dist/src/cache/index.d.ts +0 -94
  52. package/dist/src/cache/index.js +0 -173
  53. package/dist/src/cache/local.d.ts +0 -23
  54. package/dist/src/cache/local.js +0 -83
  55. package/dist/src/cache/metrics.d.ts +0 -27
  56. package/dist/src/cache/metrics.js +0 -120
  57. package/dist/src/cache/redis.d.ts +0 -16
  58. package/dist/src/cache/redis.js +0 -100
  59. package/dist/src/chainlink-external-adapter-framework-0.0.6.tgz +0 -0
  60. package/dist/src/config/index.d.ts +0 -214
  61. package/dist/src/config/index.js +0 -380
  62. package/dist/src/config/provider-limits.d.ts +0 -31
  63. package/dist/src/config/provider-limits.js +0 -75
  64. package/dist/src/examples/bank-frick/accounts.d.ts +0 -39
  65. package/dist/src/examples/bank-frick/accounts.js +0 -192
  66. package/dist/src/examples/bank-frick/config/index.d.ts +0 -4
  67. package/dist/src/examples/bank-frick/config/index.js +0 -54
  68. package/dist/src/examples/bank-frick/index.d.ts +0 -2
  69. package/dist/src/examples/bank-frick/index.js +0 -15
  70. package/dist/src/examples/bank-frick/util.d.ts +0 -4
  71. package/dist/src/examples/bank-frick/util.js +0 -39
  72. package/dist/src/examples/coingecko/batch-warming.d.ts +0 -7
  73. package/dist/src/examples/coingecko/batch-warming.js +0 -53
  74. package/dist/src/examples/coingecko/index.d.ts +0 -2
  75. package/dist/src/examples/coingecko/index.js +0 -11
  76. package/dist/src/examples/coingecko/rest.d.ts +0 -12
  77. package/dist/src/examples/coingecko/rest.js +0 -51
  78. package/dist/src/examples/ncfx/config/index.d.ts +0 -12
  79. package/dist/src/examples/ncfx/config/index.js +0 -15
  80. package/dist/src/examples/ncfx/index.d.ts +0 -13
  81. package/dist/src/examples/ncfx/index.js +0 -11
  82. package/dist/src/examples/ncfx/websocket.d.ts +0 -47
  83. package/dist/src/examples/ncfx/websocket.js +0 -73
  84. package/dist/src/index.d.ts +0 -11
  85. package/dist/src/index.js +0 -128
  86. package/dist/src/metrics/constants.d.ts +0 -16
  87. package/dist/src/metrics/constants.js +0 -25
  88. package/dist/src/metrics/index.d.ts +0 -15
  89. package/dist/src/metrics/index.js +0 -122
  90. package/dist/src/metrics/util.d.ts +0 -7
  91. package/dist/src/metrics/util.js +0 -9
  92. package/dist/src/package/adapter.d.ts +0 -88
  93. package/dist/src/package/adapter.js +0 -112
  94. package/dist/src/package/background-executor.d.ts +0 -11
  95. package/dist/src/package/background-executor.js +0 -45
  96. package/dist/src/package/cache/factory.d.ts +0 -6
  97. package/dist/src/package/cache/factory.js +0 -57
  98. package/dist/src/package/cache/index.d.ts +0 -90
  99. package/dist/src/package/cache/index.js +0 -169
  100. package/dist/src/package/cache/local.d.ts +0 -23
  101. package/dist/src/package/cache/local.js +0 -83
  102. package/dist/src/package/cache/metrics.d.ts +0 -27
  103. package/dist/src/package/cache/metrics.js +0 -120
  104. package/dist/src/package/cache/redis.d.ts +0 -16
  105. package/dist/src/package/cache/redis.js +0 -100
  106. package/dist/src/package/config/index.d.ts +0 -195
  107. package/dist/src/package/config/index.js +0 -365
  108. package/dist/src/package/config/provider-limits.d.ts +0 -31
  109. package/dist/src/package/config/provider-limits.js +0 -76
  110. package/dist/src/package/examples/coingecko/batch-warming.d.ts +0 -2
  111. package/dist/src/package/examples/coingecko/batch-warming.js +0 -52
  112. package/dist/src/package/examples/coingecko/index.d.ts +0 -2
  113. package/dist/src/package/examples/coingecko/index.js +0 -10
  114. package/dist/src/package/examples/coingecko/rest.d.ts +0 -2
  115. package/dist/src/package/examples/coingecko/rest.js +0 -50
  116. package/dist/src/package/examples/ncfx/config/index.d.ts +0 -12
  117. package/dist/src/package/examples/ncfx/config/index.js +0 -15
  118. package/dist/src/package/examples/ncfx/index.d.ts +0 -2
  119. package/dist/src/package/examples/ncfx/index.js +0 -10
  120. package/dist/src/package/examples/ncfx/websocket.d.ts +0 -36
  121. package/dist/src/package/examples/ncfx/websocket.js +0 -72
  122. package/dist/src/package/index.d.ts +0 -12
  123. package/dist/src/package/index.js +0 -92
  124. package/dist/src/package/metrics/constants.d.ts +0 -16
  125. package/dist/src/package/metrics/constants.js +0 -25
  126. package/dist/src/package/metrics/index.d.ts +0 -15
  127. package/dist/src/package/metrics/index.js +0 -123
  128. package/dist/src/package/metrics/util.d.ts +0 -3
  129. package/dist/src/package/metrics/util.js +0 -9
  130. package/dist/src/package/package.json +0 -72
  131. package/dist/src/package/rate-limiting/background/fixed-frequency.d.ts +0 -10
  132. package/dist/src/package/rate-limiting/background/fixed-frequency.js +0 -37
  133. package/dist/src/package/rate-limiting/index.d.ts +0 -54
  134. package/dist/src/package/rate-limiting/index.js +0 -63
  135. package/dist/src/package/rate-limiting/metrics.d.ts +0 -3
  136. package/dist/src/package/rate-limiting/metrics.js +0 -44
  137. package/dist/src/package/rate-limiting/request/simple-counting.d.ts +0 -20
  138. package/dist/src/package/rate-limiting/request/simple-counting.js +0 -62
  139. package/dist/src/package/test.d.ts +0 -1
  140. package/dist/src/package/test.js +0 -6
  141. package/dist/src/package/transports/batch-warming.d.ts +0 -34
  142. package/dist/src/package/transports/batch-warming.js +0 -101
  143. package/dist/src/package/transports/index.d.ts +0 -87
  144. package/dist/src/package/transports/index.js +0 -87
  145. package/dist/src/package/transports/metrics.d.ts +0 -21
  146. package/dist/src/package/transports/metrics.js +0 -105
  147. package/dist/src/package/transports/rest.d.ts +0 -43
  148. package/dist/src/package/transports/rest.js +0 -129
  149. package/dist/src/package/transports/util.d.ts +0 -8
  150. package/dist/src/package/transports/util.js +0 -85
  151. package/dist/src/package/transports/websocket.d.ts +0 -80
  152. package/dist/src/package/transports/websocket.js +0 -169
  153. package/dist/src/package/util/expiring-sorted-set.d.ts +0 -21
  154. package/dist/src/package/util/expiring-sorted-set.js +0 -47
  155. package/dist/src/package/util/index.d.ts +0 -11
  156. package/dist/src/package/util/index.js +0 -35
  157. package/dist/src/package/util/logger.d.ts +0 -42
  158. package/dist/src/package/util/logger.js +0 -62
  159. package/dist/src/package/util/request.d.ts +0 -55
  160. package/dist/src/package/util/request.js +0 -2
  161. package/dist/src/package/validation/error.d.ts +0 -50
  162. package/dist/src/package/validation/error.js +0 -79
  163. package/dist/src/package/validation/index.d.ts +0 -5
  164. package/dist/src/package/validation/index.js +0 -86
  165. package/dist/src/package/validation/input-params.d.ts +0 -15
  166. package/dist/src/package/validation/input-params.js +0 -30
  167. package/dist/src/package/validation/override-functions.d.ts +0 -3
  168. package/dist/src/package/validation/override-functions.js +0 -40
  169. package/dist/src/package/validation/preset-tokens.json +0 -23
  170. package/dist/src/package/validation/validator.d.ts +0 -47
  171. package/dist/src/package/validation/validator.js +0 -303
  172. package/dist/src/package.json +0 -72
  173. package/dist/src/rate-limiting/background/fixed-frequency.d.ts +0 -11
  174. package/dist/src/rate-limiting/background/fixed-frequency.js +0 -35
  175. package/dist/src/rate-limiting/index.d.ts +0 -55
  176. package/dist/src/rate-limiting/index.js +0 -63
  177. package/dist/src/rate-limiting/metrics.d.ts +0 -3
  178. package/dist/src/rate-limiting/metrics.js +0 -44
  179. package/dist/src/rate-limiting/request/simple-counting.d.ts +0 -21
  180. package/dist/src/rate-limiting/request/simple-counting.js +0 -62
  181. package/dist/src/test.d.ts +0 -1
  182. package/dist/src/test.js +0 -6
  183. package/dist/src/transports/batch-warming.d.ts +0 -35
  184. package/dist/src/transports/batch-warming.js +0 -101
  185. package/dist/src/transports/index.d.ts +0 -70
  186. package/dist/src/transports/index.js +0 -87
  187. package/dist/src/transports/metrics.d.ts +0 -22
  188. package/dist/src/transports/metrics.js +0 -105
  189. package/dist/src/transports/rest.d.ts +0 -44
  190. package/dist/src/transports/rest.js +0 -131
  191. package/dist/src/transports/util.d.ts +0 -8
  192. package/dist/src/transports/util.js +0 -85
  193. package/dist/src/transports/websocket.d.ts +0 -80
  194. package/dist/src/transports/websocket.js +0 -166
  195. package/dist/src/util/expiring-sorted-set.d.ts +0 -21
  196. package/dist/src/util/expiring-sorted-set.js +0 -47
  197. package/dist/src/util/index.d.ts +0 -12
  198. package/dist/src/util/index.js +0 -35
  199. package/dist/src/util/logger.d.ts +0 -42
  200. package/dist/src/util/logger.js +0 -62
  201. package/dist/src/util/request.d.ts +0 -57
  202. package/dist/src/util/request.js +0 -2
  203. package/dist/src/util/subscription-set/expiring-sorted-set.d.ts +0 -22
  204. package/dist/src/util/subscription-set/expiring-sorted-set.js +0 -47
  205. package/dist/src/util/subscription-set/subscription-set.d.ts +0 -18
  206. package/dist/src/util/subscription-set/subscription-set.js +0 -19
  207. package/dist/src/util/test-payload-loader.d.ts +0 -25
  208. package/dist/src/util/test-payload-loader.js +0 -83
  209. package/dist/src/validation/error.d.ts +0 -50
  210. package/dist/src/validation/error.js +0 -79
  211. package/dist/src/validation/index.d.ts +0 -5
  212. package/dist/src/validation/index.js +0 -91
  213. package/dist/src/validation/input-params.d.ts +0 -15
  214. package/dist/src/validation/input-params.js +0 -30
  215. package/dist/src/validation/override-functions.d.ts +0 -3
  216. package/dist/src/validation/override-functions.js +0 -40
  217. package/dist/src/validation/preset-tokens.json +0 -23
  218. package/dist/src/validation/validator.d.ts +0 -47
  219. package/dist/src/validation/validator.js +0 -303
  220. package/src/test.ts +0 -5
@@ -1,62 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.loggingContextMiddleware = exports.makeLogger = exports.asyncLocalStorage = void 0;
7
- const pino_1 = __importDefault(require("pino"));
8
- const config_1 = require("../config");
9
- const crypto_1 = require("crypto");
10
- const node_async_hooks_1 = require("node:async_hooks");
11
- exports.asyncLocalStorage = new node_async_hooks_1.AsyncLocalStorage();
12
- const debugTransport = {
13
- target: 'pino-pretty',
14
- options: {
15
- levelFirst: true,
16
- levelLabel: 'level',
17
- ignore: 'layer,pid,hostname',
18
- messageFormat: '[{correlationId}][{layer}] {msg}',
19
- translateTime: 'yyyy-mm-dd HH:MM:ss.l',
20
- },
21
- };
22
- // Base logger, shouldn't be used because we want layers to be specified
23
- const baseLogger = (0, pino_1.default)({
24
- level: process.env['LOG_LEVEL']?.toLowerCase() || config_1.BaseSettings.LOG_LEVEL.default,
25
- mixin() {
26
- if (process.env['CORRELATION_ID_ENABLED'] === 'true') {
27
- const store = exports.asyncLocalStorage.getStore();
28
- if (store) {
29
- return store;
30
- }
31
- }
32
- return {};
33
- },
34
- transport: process.env['DEBUG'] === 'true' ? debugTransport : undefined,
35
- });
36
- /**
37
- * Instead of using a global logger instance, we want to force using a child logger
38
- * with a specific layer set in it, so that we can filter logs by where they're output from.
39
- *
40
- * Details on what each log level represents:
41
- * "trace": Forensic debugging of issues on a local machine.
42
- * "debug": Detailed logging level to get more context from users on their environments.
43
- * "info": High-level informational messages, to describe at a glance the high level state of the system.
44
- * "warn": A mild error occurred that might require non-urgent action.
45
- * "error": An unexpected error occurred during the regular operation of a well-maintained EA.
46
- * "fatal": The EA encountered an unrecoverable problem and had to exit.
47
- *
48
- * Full reference this is based on can be found at
49
- * https://github.com/smartcontractkit/documentation/blob/main/docs/Node%20Operators/configuration-variables.md#log_level
50
- *
51
- * @param layer - the layer name to include in the logs (e.g. "SomeMiddleware", "RedisCache", etc.)
52
- * @returns a layer specific logger
53
- */
54
- const makeLogger = (layer) => baseLogger.child({ layer });
55
- exports.makeLogger = makeLogger;
56
- const loggingContextMiddleware = (req, res, done) => {
57
- const correlationId = req.headers['x-correlation-id'] || (0, crypto_1.randomUUID)();
58
- exports.asyncLocalStorage.run({ correlationId: correlationId }, () => {
59
- done();
60
- });
61
- };
62
- exports.loggingContextMiddleware = loggingContextMiddleware;
@@ -1,57 +0,0 @@
1
- import { FastifyReply, FastifyRequest, HookHandlerDoneFunction } from 'fastify';
2
- import { Adapter } from '../adapter';
3
- import { AdapterError } from '../validation/error';
4
- declare module 'fastify' {
5
- interface FastifyRequest {
6
- requestContext: AdapterRequestContext;
7
- }
8
- }
9
- export interface AdapterRequestBody<T = AdapterRequestData> {
10
- endpoint?: string;
11
- data: T;
12
- id?: string;
13
- }
14
- export declare type AdapterRequestContext<T = AdapterRequestData> = {
15
- id: string;
16
- endpointName: string;
17
- cacheKey: string;
18
- data: T;
19
- meta?: AdapterRequestMeta;
20
- };
21
- export declare type AdapterRouteGeneric<T = AdapterRequestData> = {
22
- Body: AdapterRequestBody<T>;
23
- };
24
- export declare type AdapterRequest<T = AdapterRequestData> = FastifyRequest<AdapterRouteGeneric<T>> & {
25
- requestContext: AdapterRequestContext<T>;
26
- };
27
- /**
28
- * Meta info that pertains to exposing metrics
29
- */
30
- export interface AdapterRequestMeta {
31
- metrics?: AdapterMetricsMeta;
32
- error?: AdapterError | Error;
33
- }
34
- /**
35
- * Meta info that pertains to exposing metrics
36
- */
37
- export interface AdapterMetricsMeta {
38
- feedId?: string;
39
- cacheHit?: boolean;
40
- }
41
- export declare type AdapterRequestData = Record<string, unknown> & {
42
- endpoint?: string;
43
- };
44
- export interface ProviderResult<Params> {
45
- params: Params;
46
- value: unknown;
47
- }
48
- export declare type AdapterResponse<T = unknown> = {
49
- statusCode: number;
50
- data: T;
51
- result: unknown;
52
- maxAge?: number;
53
- meta?: AdapterRequestMeta;
54
- providerStatusCode?: number;
55
- };
56
- export declare type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
57
- export declare type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,22 +0,0 @@
1
- import { SubscriptionSet } from './subscription-set';
2
- /**
3
- * An object describing an entry in the expiring sorted set.
4
- * @typeParam T - the type of the entry's value
5
- */
6
- interface ExpiringSortedSetEntry<T> {
7
- value: T;
8
- expirationTimestamp: number;
9
- }
10
- /**
11
- * This class implements a set of unique items, each of which has an expiration timestamp.
12
- * On reads, items that have expired will be deleted from the set and not returned.
13
- *
14
- * @typeParam T - the type of the set entries' values
15
- */
16
- export declare class ExpiringSortedSet<T> implements SubscriptionSet<T> {
17
- map: Map<string, ExpiringSortedSetEntry<T>>;
18
- add(key: string, value: T, ttl: number): void;
19
- get(key: string): T | undefined;
20
- getAll(): T[];
21
- }
22
- export {};
@@ -1,47 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ExpiringSortedSet = void 0;
4
- /**
5
- * This class implements a set of unique items, each of which has an expiration timestamp.
6
- * On reads, items that have expired will be deleted from the set and not returned.
7
- *
8
- * @typeParam T - the type of the set entries' values
9
- */
10
- class ExpiringSortedSet {
11
- constructor() {
12
- this.map = new Map();
13
- }
14
- add(key, value, ttl) {
15
- this.map.set(key, {
16
- value,
17
- expirationTimestamp: Date.now() + ttl,
18
- });
19
- }
20
- get(key) {
21
- const entry = this.map.get(key);
22
- if (!entry) {
23
- return;
24
- }
25
- else if (entry.expirationTimestamp < Date.now()) {
26
- return entry.value;
27
- }
28
- else {
29
- this.map.delete(key);
30
- }
31
- }
32
- getAll() {
33
- const results = [];
34
- const now = Date.now();
35
- // Since we're iterating, might as well prune here
36
- for (const [key, entry] of this.map.entries()) {
37
- if (entry.expirationTimestamp < now) {
38
- this.map.delete(key); // In theory, this shouldn't happen frequently for feeds
39
- }
40
- else {
41
- results.push(entry.value);
42
- }
43
- }
44
- return results;
45
- }
46
- }
47
- exports.ExpiringSortedSet = ExpiringSortedSet;
@@ -1,18 +0,0 @@
1
- import { PromiseOrValue } from '..';
2
- import { AdapterConfig } from '../../config';
3
- /**
4
- * Set to hold items to subscribe to from a provider (regardless of protocol)
5
- */
6
- export interface SubscriptionSet<T> {
7
- /** Add a new subscription to the set */
8
- add(key: string, value: T, ttl: number): PromiseOrValue<void>;
9
- /** Get a specific subscription from the set */
10
- get(key: string): PromiseOrValue<T | undefined>;
11
- /** Get all subscriptions from the set as a list */
12
- getAll(): PromiseOrValue<T[]>;
13
- }
14
- export declare class SubscriptionSetFactory {
15
- private cacheType;
16
- constructor(config: AdapterConfig);
17
- buildSet<T>(): SubscriptionSet<T>;
18
- }
@@ -1,19 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SubscriptionSetFactory = void 0;
4
- const expiring_sorted_set_1 = require("./expiring-sorted-set");
5
- class SubscriptionSetFactory {
6
- constructor(config) {
7
- this.cacheType = config.CACHE_TYPE;
8
- }
9
- buildSet() {
10
- switch (this.cacheType) {
11
- case 'local':
12
- return new expiring_sorted_set_1.ExpiringSortedSet();
13
- case 'redis':
14
- // TODO: Implement redis set
15
- return new expiring_sorted_set_1.ExpiringSortedSet();
16
- }
17
- }
18
- }
19
- exports.SubscriptionSetFactory = SubscriptionSetFactory;
@@ -1,25 +0,0 @@
1
- import { AdapterRequestData } from './request';
2
- /**
3
- * The test payload read in from filesystem
4
- */
5
- export interface Payload {
6
- requests: Array<AdapterRequestData>;
7
- }
8
- /**
9
- * Test payload with discriminated union so we can tell when we should just do
10
- * a simple liveness check rather than a sample request
11
- */
12
- declare type TestPayload = (Payload & {
13
- isDefault: false;
14
- }) | {
15
- isDefault: true;
16
- };
17
- /**
18
- * Load in a JSON file containing a test payload for the current adapter,
19
- * used in healthchecks to make sample requests
20
- *
21
- * @param fileName - name of file that contains the test payload data for the smoke endpoint
22
- * @returns the parsed payload with individual requests
23
- */
24
- export declare function loadTestPayload(fileName?: string): TestPayload;
25
- export {};
@@ -1,83 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.loadTestPayload = void 0;
7
- const ajv_1 = __importDefault(require("ajv"));
8
- const fs_1 = __importDefault(require("fs"));
9
- const path_1 = __importDefault(require("path"));
10
- const logger_1 = require("./logger");
11
- const logger = (0, logger_1.makeLogger)('TestPayloadLoader');
12
- /**
13
- * Load in a JSON file containing a test payload for the current adapter,
14
- * used in healthchecks to make sample requests
15
- *
16
- * @param fileName - name of file that contains the test payload data for the smoke endpoint
17
- * @returns the parsed payload with individual requests
18
- */
19
- function loadTestPayload(fileName) {
20
- const ajv = new ajv_1.default();
21
- const schema = {
22
- type: 'object',
23
- required: ['requests'],
24
- properties: {
25
- requests: {
26
- type: 'array',
27
- items: {
28
- type: 'object',
29
- required: [],
30
- },
31
- },
32
- },
33
- };
34
- const validate = ajv.compile(schema);
35
- try {
36
- const payload = resolvePayload(fileName);
37
- if (!validate(payload) || !payload?.requests) {
38
- throw Error(JSON.stringify(validate?.errors || 'Could not validate schema for test payload'));
39
- }
40
- return { ...payload, isDefault: false };
41
- }
42
- catch (e) {
43
- logger.warn(`Could not load payload: ${e.message}`);
44
- logger.warn('Falling back to default empty payload');
45
- return { isDefault: true };
46
- }
47
- }
48
- exports.loadTestPayload = loadTestPayload;
49
- function resolvePayload(fileName) {
50
- try {
51
- let payload = null;
52
- // Find test payload by specified name, fallback to default names if not found
53
- if (fileName && fs_1.default.existsSync(path_1.default.join(process.cwd(), fileName))) {
54
- payload = require(path_1.default.join(process.cwd(), fileName));
55
- }
56
- else if (fileName && fs_1.default.existsSync(`./${fileName}`)) {
57
- payload = require(`./${fileName}`);
58
- }
59
- // Search for test payload js first if no filename specified or found
60
- else if (fs_1.default.existsSync(path_1.default.resolve('.', 'test-payload.js'))) {
61
- payload = require(path_1.default.join(process.cwd(), 'test-payload.js'));
62
- }
63
- else if (fs_1.default.existsSync(`./test-payload.js`)) {
64
- payload = require(`./test-payload.js`);
65
- }
66
- // Search for test payload json second if no filename specified or found
67
- else if (fs_1.default.existsSync(path_1.default.join(process.cwd(), 'test-payload.json'))) {
68
- payload = require(path_1.default.join(process.cwd(), 'test-payload.json'));
69
- }
70
- else if (fs_1.default.existsSync(`./test-payload.json`)) {
71
- payload = require(`./test-payload.json`);
72
- }
73
- if (typeof payload === 'string') {
74
- return JSON.parse(payload);
75
- }
76
- else {
77
- return payload;
78
- }
79
- }
80
- catch {
81
- return null;
82
- }
83
- }
@@ -1,50 +0,0 @@
1
- import { HttpRequestType } from '../metrics/constants';
2
- declare type ErrorBasic = {
3
- name: string;
4
- message: string;
5
- };
6
- declare type ErrorFull = ErrorBasic & {
7
- stack: string;
8
- cause: string;
9
- };
10
- export declare type AdapterErrorResponse = {
11
- jobRunID: string;
12
- status: string;
13
- statusCode: number;
14
- providerStatusCode?: number;
15
- error: ErrorBasic | ErrorFull;
16
- };
17
- export declare class AdapterError extends Error {
18
- jobRunID: string;
19
- status: string;
20
- statusCode: number;
21
- cause: unknown;
22
- url?: string;
23
- errorResponse: unknown;
24
- feedID?: string;
25
- providerStatusCode?: number;
26
- metricsLabel?: HttpRequestType;
27
- name: string;
28
- message: string;
29
- constructor({ jobRunID, status, statusCode, name, message, cause, url, errorResponse, feedID, providerStatusCode, metricsLabel, }: Partial<AdapterError>);
30
- toJSONResponse(): AdapterErrorResponse;
31
- }
32
- export declare class AdapterInputError extends AdapterError {
33
- constructor(input: Partial<AdapterError>);
34
- }
35
- export declare class AdapterRateLimitError extends AdapterError {
36
- constructor(input: Partial<AdapterError>);
37
- }
38
- export declare class AdapterTimeoutError extends AdapterError {
39
- constructor(input: Partial<AdapterError>);
40
- }
41
- export declare class AdapterDataProviderError extends AdapterError {
42
- constructor(input: Partial<AdapterError>);
43
- }
44
- export declare class AdapterConnectionError extends AdapterError {
45
- constructor(input: Partial<AdapterError>);
46
- }
47
- export declare class AdapterCustomError extends AdapterError {
48
- constructor(input: Partial<AdapterError>);
49
- }
50
- export {};
@@ -1,79 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AdapterCustomError = exports.AdapterConnectionError = exports.AdapterDataProviderError = exports.AdapterTimeoutError = exports.AdapterRateLimitError = exports.AdapterInputError = exports.AdapterError = void 0;
4
- const constants_1 = require("../metrics/constants");
5
- class AdapterError extends Error {
6
- constructor({ jobRunID = '1', status = 'errored', statusCode = 500, name = 'AdapterError', message = 'An error occurred.', cause, url, errorResponse, feedID, providerStatusCode, metricsLabel = constants_1.HttpRequestType.ADAPTER_ERROR, }) {
7
- super(message);
8
- this.jobRunID = jobRunID;
9
- this.status = status;
10
- this.statusCode = statusCode;
11
- this.name = name;
12
- this.message = message;
13
- this.cause = cause;
14
- if (url) {
15
- this.url = url;
16
- }
17
- if (feedID) {
18
- this.feedID = feedID;
19
- }
20
- this.errorResponse = errorResponse;
21
- this.providerStatusCode = providerStatusCode;
22
- this.metricsLabel = metricsLabel;
23
- }
24
- toJSONResponse() {
25
- const showDebugInfo = process.env['NODE_ENV'] === 'development' || process.env['DEBUG'] === 'true';
26
- const errorBasic = {
27
- name: this.name,
28
- message: this.message,
29
- url: this.url,
30
- errorResponse: this.errorResponse,
31
- feedID: this.feedID,
32
- };
33
- const errorFull = { ...errorBasic, stack: this.stack, cause: this.cause };
34
- return {
35
- jobRunID: this.jobRunID,
36
- status: this.status,
37
- statusCode: this.statusCode,
38
- providerStatusCode: this.providerStatusCode,
39
- error: showDebugInfo ? errorFull : errorBasic,
40
- };
41
- }
42
- }
43
- exports.AdapterError = AdapterError;
44
- class AdapterInputError extends AdapterError {
45
- constructor(input) {
46
- super({ ...input, metricsLabel: constants_1.HttpRequestType.INPUT_ERROR });
47
- }
48
- }
49
- exports.AdapterInputError = AdapterInputError;
50
- class AdapterRateLimitError extends AdapterError {
51
- constructor(input) {
52
- super({ ...input, metricsLabel: constants_1.HttpRequestType.RATE_LIMIT_ERROR });
53
- }
54
- }
55
- exports.AdapterRateLimitError = AdapterRateLimitError;
56
- class AdapterTimeoutError extends AdapterError {
57
- constructor(input) {
58
- super({ ...input, metricsLabel: constants_1.HttpRequestType.TIMEOUT_ERROR });
59
- }
60
- }
61
- exports.AdapterTimeoutError = AdapterTimeoutError;
62
- class AdapterDataProviderError extends AdapterError {
63
- constructor(input) {
64
- super({ ...input, metricsLabel: constants_1.HttpRequestType.DP_ERROR });
65
- }
66
- }
67
- exports.AdapterDataProviderError = AdapterDataProviderError;
68
- class AdapterConnectionError extends AdapterError {
69
- constructor(input) {
70
- super({ ...input, metricsLabel: constants_1.HttpRequestType.CONNECTION_ERROR });
71
- }
72
- }
73
- exports.AdapterConnectionError = AdapterConnectionError;
74
- class AdapterCustomError extends AdapterError {
75
- constructor(input) {
76
- super({ ...input, metricsLabel: constants_1.HttpRequestType.CUSTOM_ERROR });
77
- }
78
- }
79
- exports.AdapterCustomError = AdapterCustomError;
@@ -1,5 +0,0 @@
1
- import { FastifyReply, FastifyRequest } from 'fastify';
2
- import { AdapterMiddlewareBuilder } from '../util/request';
3
- export { InputParameters } from './input-params';
4
- export declare const validatorMiddleware: AdapterMiddlewareBuilder;
5
- export declare const errorCatchingMiddleware: (err: Error, req: FastifyRequest, res: FastifyReply) => void;
@@ -1,91 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.errorCatchingMiddleware = exports.validatorMiddleware = void 0;
4
- const cache_1 = require("../cache");
5
- const util_1 = require("../metrics/util");
6
- const util_2 = require("../util");
7
- const error_1 = require("./error");
8
- const validator_1 = require("./validator");
9
- const override_functions_1 = require("./override-functions");
10
- const errorCatcherLogger = (0, util_2.makeLogger)('ErrorCatchingMiddleware');
11
- const validatorMiddleware = (adapter) => (req, reply, done) => {
12
- if (req.headers['content-type'] !== 'application/json') {
13
- throw new error_1.AdapterInputError({
14
- message: 'Content type not "application/json", returning 400',
15
- statusCode: 400,
16
- });
17
- }
18
- if (!req.body) {
19
- throw new error_1.AdapterInputError({
20
- message: 'Body not present in adapter request, returning 400',
21
- statusCode: 400,
22
- });
23
- }
24
- // Make endpoints case insensitive
25
- const endpointParam = req.body.endpoint?.toLowerCase() ||
26
- req.body.data?.endpoint?.toLowerCase() ||
27
- adapter.defaultEndpoint;
28
- if (!endpointParam) {
29
- throw new error_1.AdapterInputError({
30
- message: `Request body does not specify an endpoint, and there is no default endpoint configured for this adapter.`,
31
- statusCode: 400,
32
- });
33
- }
34
- const endpoint = adapter.endpointsMap[endpointParam];
35
- if (!endpoint) {
36
- throw new error_1.AdapterInputError({
37
- message: `Adapter does not have a "${endpointParam}" endpoint.`,
38
- statusCode: 404,
39
- });
40
- }
41
- // Validate data using validator from v2
42
- // TODO: See if we want to change this whole thing
43
- const validator = new validator_1.Validator(req.body, endpoint.inputParameters);
44
- req.requestContext = {
45
- id: req.body.id || '1',
46
- cacheKey: '',
47
- data: validator.validated.data,
48
- endpointName: endpoint.name,
49
- };
50
- if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
51
- // Add metrics meta which includes feedId to the request
52
- // Perform prior to overrides to maintain consistent Feed IDs across adapters
53
- const metrics = (0, util_1.getMetricsMeta)({
54
- adapterEndpoint: endpoint,
55
- adapterConfig: adapter.config,
56
- }, validator.validated.data);
57
- req.requestContext = { ...req.requestContext, meta: { metrics } };
58
- }
59
- // TODO: Support `includes` and `tokenOverrides` overrides as needed
60
- const requestParams = req.requestContext.data ?? {};
61
- if (requestParams['tokenOverrides']) {
62
- throw new Error('Token overrides not yet supported');
63
- }
64
- if (requestParams['includes']) {
65
- throw new Error('Includes not yet supported');
66
- }
67
- // Swaps the 'base' parameter if any overrides are found in the request or the adapter configuration
68
- // Supports 'base' input as string or string[]
69
- (0, override_functions_1.performSymbolOverrides)(adapter, req);
70
- req.requestContext.cacheKey = (0, cache_1.calculateCacheKey)({
71
- adapterEndpoint: endpoint,
72
- adapterConfig: adapter.config,
73
- }, req.requestContext.data);
74
- done();
75
- };
76
- exports.validatorMiddleware = validatorMiddleware;
77
- const errorCatchingMiddleware = (err, req, res) => {
78
- // Add adapter or generic error to request meta for metrics use
79
- req.requestContext.meta = { ...req.requestContext.meta, error: err };
80
- if (err instanceof error_1.AdapterError) {
81
- // We want to log these as warn, because although they are to be expected, NOPs should
82
- // Only use "correct" job specs and therefore not hit adapters with invalid requests.
83
- errorCatcherLogger.warn(err);
84
- res.status(err.statusCode).send(err.toJSONResponse());
85
- }
86
- else {
87
- errorCatcherLogger.error(err);
88
- res.status(200).send('There was an unexpected error in the adapter.');
89
- }
90
- };
91
- exports.errorCatchingMiddleware = errorCatchingMiddleware;
@@ -1,15 +0,0 @@
1
- export declare type Override = Map<string, Map<string, string>>;
2
- export declare type InputParameter = {
3
- aliases?: string[];
4
- description?: string;
5
- type?: 'bigint' | 'boolean' | 'array' | 'number' | 'object' | 'string';
6
- required?: boolean;
7
- options?: unknown[];
8
- default?: unknown;
9
- dependsOn?: string[];
10
- exclusive?: string[];
11
- };
12
- export declare type InputParameters = {
13
- [name: string]: InputParameter | boolean | string[];
14
- };
15
- export declare const baseInputParameters: InputParameters;
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.baseInputParameters = void 0;
4
- exports.baseInputParameters = {
5
- endpoint: {
6
- description: 'The External Adapter "endpoint" name to use.',
7
- required: false,
8
- type: 'string',
9
- },
10
- resultPath: {
11
- description: 'The path to key into the API response the retrieve the result',
12
- required: false,
13
- // Type: 'string', TODO: Once multiple types are supported this could be string or array of strings
14
- },
15
- overrides: {
16
- description: 'Override the mapping of token symbols to another token symbol',
17
- required: false,
18
- // Type: 'string', TODO: Once complex types are supported this could be { [adapter: string]: { [token: string]: string } }
19
- },
20
- tokenOverrides: {
21
- description: 'Override the mapping of token symbols to smart contract address',
22
- required: false,
23
- // Type: 'string', TODO: Once complex types are supported this could be { [network: string]: { [token: string]: string } }
24
- },
25
- includes: {
26
- description: 'Override the array of includes that holds additional input parameters when matching a pair of symbols',
27
- required: false,
28
- // Type: 'string', TODO: Once complex types are supported this could be { from: string, to: string, includes: [{ from: string, to: string, adapters: string[], inverse: boolean, tokens: boolean }] } }[]
29
- },
30
- };
@@ -1,3 +0,0 @@
1
- import { Adapter } from '../adapter';
2
- import { AdapterRequest } from '../util/request';
3
- export declare const performSymbolOverrides: (adapter: Adapter, req: AdapterRequest) => void;
@@ -1,40 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.performSymbolOverrides = void 0;
4
- const performSymbolOverrides = (adapter, req) => {
5
- let adapterOverrides = {};
6
- if (req.requestContext.data &&
7
- req.requestContext.data['overrides'] &&
8
- req.requestContext.data['overrides'][adapter.name]) {
9
- adapterOverrides = req.requestContext.data['overrides'][adapter.name];
10
- }
11
- if (!Array.isArray(req.requestContext.data['base'])) {
12
- // Perform overrides specified in the request payload
13
- req.requestContext.data['base'] =
14
- adapterOverrides[req.requestContext.data['base']] ?? req.requestContext.data['base'];
15
- // Perform hardcoded overrides
16
- if (adapter.overrides) {
17
- req.requestContext.data['base'] =
18
- adapter.overrides[req.requestContext.data['base']] ??
19
- req.requestContext.data['base'];
20
- }
21
- return;
22
- }
23
- let requestedSymbols = req.requestContext.data['base'];
24
- for (let i = 0; i < requestedSymbols.length; i++) {
25
- const symbol = requestedSymbols[i];
26
- // Perform overrides specified in the request payload
27
- let overriddenSymbol = adapterOverrides[symbol.toUpperCase()] ?? adapterOverrides[symbol.toLowerCase()];
28
- // Perform hardcoded overrides
29
- if (adapter.overrides) {
30
- overriddenSymbol =
31
- adapter.overrides[symbol.toUpperCase()] ??
32
- adapter.overrides[symbol.toLowerCase()] ??
33
- overriddenSymbol;
34
- }
35
- requestedSymbols[i] = overriddenSymbol ?? requestedSymbols[i];
36
- }
37
- requestedSymbols = requestedSymbols.length > 1 ? requestedSymbols : requestedSymbols[1];
38
- req.requestContext.data['base'] = requestedSymbols;
39
- };
40
- exports.performSymbolOverrides = performSymbolOverrides;