@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,303 +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.Validator = void 0;
7
- const error_1 = require("./error");
8
- const input_params_1 = require("./input-params");
9
- const util_1 = require("../util");
10
- const preset_tokens_json_1 = __importDefault(require("./preset-tokens.json"));
11
- // Don't want to get requester in just yet, only copying the static method 'errored'
12
- const requesterErrored = (jobRunID = '1', error = undefined, statusCode = 500, feedID = undefined) => {
13
- if (error instanceof error_1.AdapterError) {
14
- error.jobRunID = jobRunID;
15
- if (feedID) {
16
- error.feedID = feedID;
17
- }
18
- return error.toJSONResponse();
19
- }
20
- if (error instanceof Error) {
21
- return new error_1.AdapterError({
22
- jobRunID,
23
- statusCode,
24
- message: error.message,
25
- cause: error,
26
- feedID,
27
- }).toJSONResponse();
28
- }
29
- return new error_1.AdapterError({ jobRunID, statusCode, message: error, feedID }).toJSONResponse();
30
- };
31
- class Validator {
32
- constructor(input = { id: '1', data: {} }, inputConfigs = {}, inputOptions = {}, validatorOptions = {}) {
33
- // OverrideSymbol = (adapter: string, symbol?: string | string[]): string | string[] => {
34
- // Const defaultSymbol = symbol || this.validated.data.base
35
- // If (!defaultSymbol) this.throwInvalid(`Required parameter not supplied: base`)
36
- // // TODO: Will never be reached, because the presetSymbols are used as default overrides
37
- // If (!this.validated.overrides) return defaultSymbol
38
- // If (!Array.isArray(defaultSymbol))
39
- // Return (
40
- // This.validated.overrides.get(adapter.toLowerCase())?.get(defaultSymbol.toLowerCase()) ||
41
- // DefaultSymbol
42
- // )
43
- // Const multiple: string[] = []
44
- // For (const sym of defaultSymbol) {
45
- // Const overrided = this.validated.overrides.get(adapter.toLowerCase())?.get(sym.toLowerCase())
46
- // If (!overrided) multiple.push(sym)
47
- // Else multiple.push(overrided)
48
- // }
49
- // Return multiple
50
- // }
51
- // OverrideToken = (symbol: string, network = 'ethereum'): string | undefined => {
52
- // Return this.validated.tokenOverrides?.get(network.toLowerCase())?.get(symbol.toLowerCase())
53
- // }
54
- // OverrideIncludes = (from: string, to: string): IncludePair | undefined => {
55
- // // Search through `presetIncludes` to find matching override for adapter and to/from pairing.
56
- // Const pairs = (
57
- // This.validated.includes?.filter(
58
- // (val: string | Includes) => typeof val !== 'string',
59
- // ) as Includes[]
60
- // ).filter(
61
- // (pair) =>
62
- // Pair.from.toLowerCase() === from.toLowerCase() &&
63
- // Pair.to.toLowerCase() === to.toLowerCase(),
64
- // )
65
- // If (!pairs || !pairs[0] || !pairs[0].includes || !pairs[0].includes[0]) {
66
- // Return
67
- // }
68
- // Return pairs[0].includes[0]
69
- // }
70
- // OverrideReverseLookup = (adapter: string, type: OverrideType, symbol: string): string => {
71
- // Const overrides: Map<string, string> | undefined = this.validated?.[type]?.get(
72
- // Adapter.toLowerCase(),
73
- // )
74
- // If (!overrides) return symbol
75
- // Let originalSymbol: string | undefined
76
- // Overrides.forEach((overridden, original) => {
77
- // If (overridden.toLowerCase() === symbol.toLowerCase()) originalSymbol = original
78
- // })
79
- // Return originalSymbol || symbol
80
- // }
81
- this.formatOverride = (param) => {
82
- const _throwInvalid = () => this.throwInvalid(`Parameter supplied with wrong format: "override"`);
83
- if (!(0, util_1.isObject)(param)) {
84
- _throwInvalid();
85
- }
86
- const _isValid = Object.values(param).every(util_1.isObject);
87
- if (!_isValid) {
88
- _throwInvalid();
89
- }
90
- const _keyToLowerCase = (entry) => {
91
- return [entry[0].toLowerCase(), entry[1]];
92
- };
93
- return new Map(Object.entries(param)
94
- .map(_keyToLowerCase)
95
- .map(([key, value]) => [key, new Map(Object.entries(value).map(_keyToLowerCase))]));
96
- };
97
- this.formatIncludeOverrides = (param) => {
98
- const _throwInvalid = () => this.throwInvalid(`Parameter supplied with wrong format: "includes"`);
99
- if (!(0, util_1.isArray)(param)) {
100
- _throwInvalid();
101
- }
102
- const _isValid = Object.values(param).every((val) => (0, util_1.isObject)(val) || typeof val === 'string');
103
- if (!_isValid) {
104
- _throwInvalid();
105
- }
106
- return param;
107
- };
108
- this.throwInvalid = (message) => {
109
- throw new error_1.AdapterError({ jobRunID: this.validated.id, statusCode: 400, message });
110
- };
111
- this.input = { ...input };
112
- if (!this.input.id) {
113
- this.input.id = '1';
114
- } // TODO Please remove these once "no any" strict typing is enabled
115
- if (!this.input.data) {
116
- this.input.data = {};
117
- }
118
- this.inputConfigs = { ...input_params_1.baseInputParameters, ...inputConfigs };
119
- this.inputOptions = { ...inputOptions };
120
- this.validatorOptions = {
121
- shouldThrowError: true,
122
- includes: [],
123
- overrides: {},
124
- ...validatorOptions,
125
- };
126
- this.validated = { id: this.input.id, data: {} };
127
- this.validateInput();
128
- this.validateOverrides('overrides', this.validatorOptions.overrides);
129
- this.validateOverrides('tokenOverrides', preset_tokens_json_1.default);
130
- this.validateIncludeOverrides();
131
- this.checkDuplicateInputParams(inputConfigs);
132
- }
133
- validateInput() {
134
- try {
135
- for (const key in this.inputConfigs) {
136
- this.validateObjectParam(key, this.validatorOptions.shouldThrowError);
137
- }
138
- }
139
- catch (e) {
140
- this.parseError(e);
141
- }
142
- }
143
- validateOverrides(path, preset) {
144
- try {
145
- if (!this.input.data?.[path]) {
146
- this.validated[path] = this.formatOverride(preset);
147
- return;
148
- }
149
- this.validated[path] = this.formatOverride({ ...preset, ...this.input.data[path] });
150
- }
151
- catch (e) {
152
- this.parseError(e);
153
- }
154
- }
155
- checkDuplicateInputParams(inputConfig) {
156
- let aliases = [];
157
- for (const key in inputConfig) {
158
- const param = inputConfig[key];
159
- if (Array.isArray(param)) {
160
- aliases = aliases.concat(param);
161
- }
162
- else if (typeof inputConfig === 'boolean') {
163
- return;
164
- }
165
- else {
166
- aliases.push(key);
167
- if (typeof param === 'object' && 'aliases' in param && Array.isArray(param.aliases)) {
168
- aliases = aliases.concat(param.aliases);
169
- }
170
- }
171
- }
172
- if (aliases.length !== new Set(aliases).size) {
173
- this.throwInvalid('Duplicate Input Aliases');
174
- }
175
- }
176
- validateIncludeOverrides() {
177
- try {
178
- this.validated.includes = this.formatIncludeOverrides([
179
- ...(Array.isArray(this.input.data?.includes) ? this.input.data.includes : []),
180
- ...(this.validatorOptions.includes || []),
181
- ]);
182
- }
183
- catch (e) {
184
- this.parseError(e);
185
- }
186
- }
187
- parseError(error) {
188
- if (!(error instanceof Error)) {
189
- return;
190
- }
191
- const message = 'Error validating input.';
192
- if (error instanceof error_1.AdapterError) {
193
- this.error = error;
194
- }
195
- else {
196
- this.error = new error_1.AdapterError({
197
- jobRunID: this.validated.id,
198
- statusCode: 400,
199
- message,
200
- cause: error,
201
- });
202
- }
203
- this.errored = requesterErrored(this.validated.id, this.error);
204
- if (this.validatorOptions.shouldThrowError) {
205
- throw this.error;
206
- }
207
- }
208
- validateObjectParam(key, shouldThrowError = true) {
209
- const inputConfig = this.inputConfigs[key];
210
- const usedKey = this.getUsedKey(key, inputConfig.aliases ?? []);
211
- const param = usedKey
212
- ? this.input.data[usedKey] ?? inputConfig.default
213
- : inputConfig.default;
214
- if (shouldThrowError) {
215
- const paramIsDefined = !(param === undefined || param === null || param === '');
216
- if (inputConfig.required && !paramIsDefined) {
217
- this.throwInvalid(`Required parameter ${key} must be non-null and non-empty`);
218
- }
219
- if (paramIsDefined) {
220
- if (inputConfig.type) {
221
- const primitiveTypes = ['boolean', 'number', 'bigint', 'string'];
222
- if (![...primitiveTypes, 'array', 'object'].includes(inputConfig.type)) {
223
- this.throwInvalid(`${key} parameter has unrecognized type ${inputConfig.type}`);
224
- }
225
- if (primitiveTypes.includes(inputConfig.type) && typeof param !== inputConfig.type) {
226
- this.throwInvalid(`${key} parameter must be of type ${inputConfig.type}`);
227
- }
228
- if (inputConfig.type === 'array' && (!Array.isArray(param) || param.length === 0)) {
229
- this.throwInvalid(`${key} parameter must be a non-empty array`);
230
- }
231
- if (inputConfig.type === 'object' &&
232
- (!param ||
233
- Array.isArray(param) ||
234
- typeof param !== inputConfig.type ||
235
- Object.keys(param).length === 0)) {
236
- this.throwInvalid(`${key} parameter must be an object with at least one property`);
237
- }
238
- }
239
- // If (inputConfig.options) {
240
- // Const tolcase = (o: any) => (typeof o === 'string' ? o.toLowerCase() : o)
241
- // Const formattedOptions = inputConfig.options.map(tolcase)
242
- // Const formattedParam = tolcase(param)
243
- // If (!formattedOptions.includes(formattedParam))
244
- // This.throwInvalid(
245
- // `${key} parameter '${formattedParam}' is not in the set of available options: ${formattedOptions.join(
246
- // ',',
247
- // )}`,
248
- // )
249
- // }
250
- // For (const dependency of inputConfig.dependsOn ?? []) {
251
- // Const usedDependencyKey = this.getUsedKey(
252
- // Dependency,
253
- // (this.inputConfigs[dependency] as InputParameter).aliases ?? [],
254
- // )
255
- // If (!usedDependencyKey) this.throwInvalid(`${key} dependency ${dependency} not supplied`)
256
- // }
257
- // For (const exclusive of inputConfig.exclusive ?? []) {
258
- // Const usedExclusiveKey = this.getUsedKey(
259
- // Exclusive,
260
- // (this.inputConfigs[exclusive] as InputParameter).aliases ?? [],
261
- // )
262
- // If (usedExclusiveKey)
263
- // This.throwInvalid(`${key} cannot be supplied concurrently with ${exclusive}`)
264
- // }
265
- }
266
- }
267
- this.validated.data[key] = param;
268
- }
269
- validateOptionalParam(param, key, options) {
270
- if (param && options) {
271
- if (!Array.isArray(options)) {
272
- this.throwInvalid(`Parameter options for ${key} must be of an Array type`);
273
- }
274
- if (!options.includes(param)) {
275
- this.throwInvalid(`${param} is not a supported ${key} option. Must be one of ${options}`);
276
- }
277
- }
278
- this.validated.data[key] = param;
279
- }
280
- validateRequiredParam(param, key, options) {
281
- if (typeof param === 'undefined' || param === '') {
282
- this.throwInvalid(`Required parameter not supplied: ${key}`);
283
- }
284
- if (options) {
285
- if (!Array.isArray(options)) {
286
- this.throwInvalid(`Parameter options for ${key} must be of an Array type`);
287
- }
288
- if (!options.includes(param)) {
289
- this.throwInvalid(`${param} is not a supported ${key} option. Must be one of ${options.join(' || ')}`);
290
- }
291
- }
292
- this.validated.data[key] = param;
293
- }
294
- getUsedKey(key, keyArray) {
295
- const comparisonArray = [...keyArray];
296
- if (!comparisonArray.includes(key)) {
297
- comparisonArray.push(key);
298
- }
299
- const inputParamKeys = Object.keys(this.input.data);
300
- return inputParamKeys.find((k) => comparisonArray.includes(k));
301
- }
302
- }
303
- exports.Validator = Validator;
@@ -1,72 +0,0 @@
1
- {
2
- "name": "@chainlink/external-adapter-framework",
3
- "version": "0.0.6",
4
- "main": "dist/index.js",
5
- "license": "MIT",
6
- "dependencies": {
7
- "axios": "^0.27.2",
8
- "fastify": "^3.29.0",
9
- "ioredis": "^5.0.4",
10
- "pino": "^7.9.2",
11
- "prom-client": "13.2.0",
12
- "ts-node": "^10.9.1",
13
- "typescript": "^4.6.3",
14
- "ws": "^8.5.0"
15
- },
16
- "scripts": {
17
- "start": "ts-node src/test.ts",
18
- "generate-docs": "typedoc src/**/*.ts",
19
- "test": "LOG_LEVEL=error EA_PORT=0 c8 ava",
20
- "test-debug": "LOG_LEVEL=trace DEBUG=true EA_PORT=0 c8 ava --verbose",
21
- "build": "tsc",
22
- "lint": "eslint ./src"
23
- },
24
- "devDependencies": {
25
- "@sinonjs/fake-timers": "^9.1.2",
26
- "@types/node": "^18.6.5",
27
- "@types/sinonjs__fake-timers": "^8.1.2",
28
- "@types/ws": "^8.5.3",
29
- "@typescript-eslint/eslint-plugin": "^5.17.0",
30
- "@typescript-eslint/parser": "^5.17.0",
31
- "ava": "^4.2.0",
32
- "c8": "^7.11.2",
33
- "eslint": "^8.14.0",
34
- "eslint-config-prettier": "^8.5.0",
35
- "eslint-plugin-tsdoc": "^0.2.16",
36
- "mock-socket": "^9.1.3",
37
- "nock": "^13.2.4",
38
- "pino-pretty": "^7.6.0",
39
- "prettier": "^2.6.1",
40
- "ts-loader": "^9.3.1",
41
- "typedoc": "^0.22.15",
42
- "webpack": "^5.74.0",
43
- "webpack-cli": "^4.10.0"
44
- },
45
- "prettier": {
46
- "semi": false,
47
- "singleQuote": true,
48
- "printWidth": 100,
49
- "endOfLine": "auto",
50
- "trailingComma": "all",
51
- "arrowParens": "always"
52
- },
53
- "optionalDependencies": {
54
- "bufferutil": "^4.0.6",
55
- "utf-8-validate": "^5.0.9"
56
- },
57
- "ava": {
58
- "files": [
59
- "test/**/*.test.ts"
60
- ],
61
- "extensions": [
62
- "ts"
63
- ],
64
- "require": [
65
- "ts-node/register"
66
- ],
67
- "workerThreads": false,
68
- "environmentVariables": {
69
- "METRICS_ENABLED": "false"
70
- }
71
- }
72
- }
@@ -1,11 +0,0 @@
1
- import { AdapterRateLimitTier, BackgroundExecuteRateLimiter } from '..';
2
- import { AdapterEndpoint } from '../../adapter';
3
- import { SettingsMap } from '../../config';
4
- export declare const DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
5
- export declare class FixedFrequencyRateLimiter implements BackgroundExecuteRateLimiter {
6
- msBetweenRequestsMap: {
7
- [endpointName: string]: number;
8
- };
9
- initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits?: AdapterRateLimitTier): this;
10
- msUntilNextExecution(endpointName: string): number;
11
- }
@@ -1,35 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FixedFrequencyRateLimiter = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = void 0;
4
- const __1 = require("..");
5
- const util_1 = require("../../util");
6
- const logger = (0, util_1.makeLogger)('FixedFrequencyRateLimiter');
7
- exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
8
- class FixedFrequencyRateLimiter {
9
- constructor() {
10
- this.msBetweenRequestsMap = {};
11
- }
12
- initialize(endpoints, limits) {
13
- // Translate the hourly limit into reqs per minute
14
- let sharedMsBetweenRequests = 1000 / (0, __1.consolidateTierLimits)(limits);
15
- // If there is no limit set, we use some reasonable number
16
- if (!limits?.rateLimit1h && !limits?.rateLimit1m && !limits?.rateLimit1s) {
17
- // 5s period for all seems good
18
- sharedMsBetweenRequests = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS;
19
- }
20
- logger.debug('Using fixed frequency batch rate limiting');
21
- for (const endpoint of endpoints) {
22
- if (endpoint.rateLimiting?.allocationPercentage == null) {
23
- throw new Error(`Allocation percentage for endpoint "${endpoint.name}" is null`);
24
- }
25
- this.msBetweenRequestsMap[endpoint.name] =
26
- (sharedMsBetweenRequests / endpoint.rateLimiting?.allocationPercentage) * 100;
27
- logger.debug(`Endpoint [${endpoint.name}]: ${this.msBetweenRequestsMap[endpoint.name] / 1000}s between requests`);
28
- }
29
- return this;
30
- }
31
- msUntilNextExecution(endpointName) {
32
- return this.msBetweenRequestsMap[endpointName];
33
- }
34
- }
35
- exports.FixedFrequencyRateLimiter = FixedFrequencyRateLimiter;
@@ -1,55 +0,0 @@
1
- import { AdapterEndpoint } from '../adapter';
2
- import { SettingsMap } from '../config';
3
- export * from './request/simple-counting';
4
- export * from './background/fixed-frequency';
5
- export interface AdapterRateLimitTier {
6
- rateLimit1s?: number;
7
- rateLimit1m?: number;
8
- rateLimit1h?: number;
9
- note?: string;
10
- }
11
- /**
12
- * Common interface for all RateLimiter classes to implement
13
- */
14
- export interface RateLimiter {
15
- /**
16
- * Method to ensure all RateLimiters can be initialized in the same manner.
17
- *
18
- * @param limits - settings for how much throughput to allow for the Adapter
19
- * @param endpoints - list of adapter endpoints
20
- */
21
- initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits: AdapterRateLimitTier): this;
22
- }
23
- /**
24
- * RequestRateLimiters perform checks agains imminent outbound requests for any transport.
25
- */
26
- export interface RequestRateLimiter extends RateLimiter {
27
- /**
28
- * This method will check using whatever strategy is implemented to determine if
29
- * this request can be processed. If so, it returns true; if not, returns false.
30
- */
31
- isUnderLimits(): boolean;
32
- }
33
- /**
34
- * BackgroundExecuteFrequencyRateLimiters will implement custom logic to calculate
35
- * the period of time to wait between background executions for a transport.
36
- */
37
- export interface BackgroundExecuteRateLimiter extends RateLimiter {
38
- msUntilNextExecution(endpointName: string): number;
39
- }
40
- /**
41
- * This method will convert all possible settings for a rate limit tier and
42
- * convert them all to requests per second, returning the lowest one
43
- *
44
- * @param limits - the rate limit tier set for the adapter
45
- * @returns the most restrictive of the set options, in requests per second
46
- */
47
- export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier) => number;
48
- /**
49
- * Validates rate limiting tiers specified for the adapter, and returns the one to use.
50
- *
51
- * @param tiers - the adapter config listing the different available API tiers
52
- * @param selectedTier - chosen API tier from settings, if present
53
- * @returns the specified API tier, or a default one if none are specified
54
- */
55
- export declare const getRateLimitingTier: (tiers?: Record<string, AdapterRateLimitTier>, selectedTier?: string) => AdapterRateLimitTier | undefined;
@@ -1,63 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.getRateLimitingTier = exports.consolidateTierLimits = void 0;
18
- __exportStar(require("./request/simple-counting"), exports);
19
- __exportStar(require("./background/fixed-frequency"), exports);
20
- /**
21
- * This method will convert all possible settings for a rate limit tier and
22
- * convert them all to requests per second, returning the lowest one
23
- *
24
- * @param limits - the rate limit tier set for the adapter
25
- * @returns the most restrictive of the set options, in requests per second
26
- */
27
- const consolidateTierLimits = (limits) => {
28
- const perHourLimit = (limits?.rateLimit1h || Infinity) / (60 * 60);
29
- const perMinuteLimit = (limits?.rateLimit1m || Infinity) / 60;
30
- const perSecondLimit = limits?.rateLimit1s || Infinity;
31
- return Math.min(perHourLimit, perMinuteLimit, perSecondLimit);
32
- };
33
- exports.consolidateTierLimits = consolidateTierLimits;
34
- /**
35
- * Validates rate limiting tiers specified for the adapter, and returns the one to use.
36
- *
37
- * @param tiers - the adapter config listing the different available API tiers
38
- * @param selectedTier - chosen API tier from settings, if present
39
- * @returns the specified API tier, or a default one if none are specified
40
- */
41
- const getRateLimitingTier = (tiers, selectedTier) => {
42
- if (!tiers) {
43
- return;
44
- }
45
- // Check that if the tiers object is defined, it has values
46
- if (Object.values(tiers).length === 0) {
47
- throw new Error(`The tiers object is defined, but has no entries`);
48
- }
49
- // Check that the tier set in the AdapterConfig is a valid one
50
- if (selectedTier && !tiers[selectedTier]) {
51
- const validTiersString = Object.keys(tiers)
52
- .map((t) => `"${t}"`)
53
- .join(', ');
54
- throw new Error(`The selected rate limit tier "${selectedTier}" is not valid (can be one of ${validTiersString})`);
55
- }
56
- if (!selectedTier) {
57
- // Sort the tiers by most to least restrictive
58
- const sortedTiers = Object.values(tiers).sort((t1, t2) => (0, exports.consolidateTierLimits)(t1) - (0, exports.consolidateTierLimits)(t2));
59
- return sortedTiers[0];
60
- }
61
- return tiers[selectedTier];
62
- };
63
- exports.getRateLimitingTier = getRateLimitingTier;
@@ -1,3 +0,0 @@
1
- import * as client from 'prom-client';
2
- export declare const retrieveCost: <ProviderResponseBody>(data: ProviderResponseBody) => number;
3
- export declare const rateLimitCreditsSpentTotal: client.Counter<"feed_id" | "participant_id">;
@@ -1,44 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.rateLimitCreditsSpentTotal = exports.retrieveCost = void 0;
27
- const client = __importStar(require("prom-client"));
28
- // Retrieve cost field from response if exists
29
- // If not return default cost of 1
30
- const retrieveCost = (data) => {
31
- const cost = data['cost'];
32
- if (typeof cost === 'number' || typeof cost === 'string') {
33
- return Number(cost);
34
- }
35
- else {
36
- return 1;
37
- }
38
- };
39
- exports.retrieveCost = retrieveCost;
40
- exports.rateLimitCreditsSpentTotal = new client.Counter({
41
- name: 'rate_limit_credits_spent_total',
42
- help: 'The number of data provider credits the adapter is consuming',
43
- labelNames: ['participant_id', 'feed_id'],
44
- });
@@ -1,21 +0,0 @@
1
- import { AdapterRateLimitTier, RateLimiter } from '..';
2
- import { AdapterEndpoint } from '../../adapter';
3
- import { SettingsMap } from '../../config';
4
- /**
5
- * This rate limiter is the simplest stateful option.
6
- * On startup, it'll compare the different thresholds for each tier, calculate them all
7
- * in the finest window we'll use (seconds), and use the most restrictive one.
8
- * This is so if the EA were to restart, we don't need to worry about persisting state
9
- * for things like daily quotas. The downside is that this does not work well for bursty
10
- * loads or spikes, in cases where e.g. the per second limit is high but daily quotas low.
11
- */
12
- export declare class SimpleCountingRateLimiter implements RateLimiter {
13
- latestSecondInterval: number;
14
- requestsThisSecond: number;
15
- latestMinuteInterval: number;
16
- requestsThisMinute: number;
17
- perSecondLimit: number;
18
- perMinuteLimit: number;
19
- initialize<Params, Result, CustomSettings extends SettingsMap>(endpoints: AdapterEndpoint<Params, Result, CustomSettings>[], limits?: AdapterRateLimitTier): this;
20
- isUnderLimits(): boolean;
21
- }