@chainlink/external-adapter-framework 0.0.15 → 0.0.17

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 (186) hide show
  1. package/adapter.js +128 -0
  2. package/background-executor.js +45 -0
  3. package/cache/factory.js +58 -0
  4. package/cache/index.js +173 -0
  5. package/cache/local.js +83 -0
  6. package/cache/metrics.js +120 -0
  7. package/cache/redis.js +100 -0
  8. package/chainlink-external-adapter-framework-v0.0.6.tgz +0 -0
  9. package/config/index.js +366 -0
  10. package/config/provider-limits.js +74 -0
  11. package/examples/bank-frick/accounts.js +192 -0
  12. package/examples/bank-frick/config/index.js +54 -0
  13. package/examples/bank-frick/index.js +15 -0
  14. package/examples/bank-frick/util.js +39 -0
  15. package/examples/coingecko/batch-warming.js +53 -0
  16. package/examples/coingecko/index.js +11 -0
  17. package/examples/coingecko/rest.js +51 -0
  18. package/examples/coingecko/src/config/index.js +13 -0
  19. package/examples/coingecko/src/config/overrides.json +10826 -0
  20. package/examples/coingecko/src/cryptoUtils.js +41 -0
  21. package/examples/coingecko/src/endpoint/coins.js +33 -0
  22. package/examples/coingecko/src/endpoint/crypto-marketcap.js +46 -0
  23. package/examples/coingecko/src/endpoint/crypto-volume.js +46 -0
  24. package/examples/coingecko/src/endpoint/crypto.js +47 -0
  25. package/examples/coingecko/src/endpoint/dominance.js +26 -0
  26. package/examples/coingecko/src/endpoint/global-marketcap.js +26 -0
  27. package/examples/coingecko/src/endpoint/index.js +15 -0
  28. package/examples/coingecko/src/globalUtils.js +48 -0
  29. package/examples/coingecko/src/index.js +14 -0
  30. package/examples/coingecko/test/e2e/adapter.test.js +262 -0
  31. package/examples/coingecko/test/integration/adapter.test.js +264 -0
  32. package/examples/coingecko/test/integration/capturedRequests.json +1 -0
  33. package/examples/coingecko/test/integration/fixtures.js +41 -0
  34. package/examples/coingecko-old/batch-warming.js +53 -0
  35. package/examples/coingecko-old/index.js +11 -0
  36. package/examples/coingecko-old/rest.js +51 -0
  37. package/examples/ncfx/config/index.js +15 -0
  38. package/examples/ncfx/index.js +11 -0
  39. package/examples/ncfx/websocket.js +73 -0
  40. package/index.js +127 -0
  41. package/metrics/constants.js +25 -0
  42. package/metrics/index.js +122 -0
  43. package/metrics/util.js +9 -0
  44. package/package.json +5 -15
  45. package/rate-limiting/background/fixed-frequency.js +35 -0
  46. package/rate-limiting/index.js +84 -0
  47. package/rate-limiting/metrics.js +44 -0
  48. package/rate-limiting/request/simple-counting.js +62 -0
  49. package/test.js +6 -0
  50. package/transports/batch-warming.js +101 -0
  51. package/transports/index.js +87 -0
  52. package/transports/metrics.js +105 -0
  53. package/transports/rest.js +138 -0
  54. package/transports/util.js +86 -0
  55. package/transports/websocket.js +166 -0
  56. package/util/index.js +35 -0
  57. package/util/logger.js +62 -0
  58. package/util/recordRequests.js +45 -0
  59. package/util/request.js +2 -0
  60. package/util/subscription-set/expiring-sorted-set.js +47 -0
  61. package/util/subscription-set/subscription-set.js +19 -0
  62. package/util/test-payload-loader.js +83 -0
  63. package/validation/error.js +79 -0
  64. package/validation/index.js +91 -0
  65. package/validation/input-params.js +30 -0
  66. package/validation/override-functions.js +40 -0
  67. package/validation/overrideFunctions.js +40 -0
  68. package/validation/preset-tokens.json +23 -0
  69. package/validation/validator.js +303 -0
  70. package/.c8rc.json +0 -3
  71. package/.eslintignore +0 -10
  72. package/.eslintrc.js +0 -96
  73. package/.github/README.MD +0 -42
  74. package/.github/actions/setup/action.yaml +0 -13
  75. package/.github/workflows/label.yaml +0 -39
  76. package/.github/workflows/main.yaml +0 -39
  77. package/.github/workflows/publish.yaml +0 -17
  78. package/.prettierignore +0 -13
  79. package/.yarnrc +0 -0
  80. package/README.md +0 -103
  81. package/dist/examples/coingecko/test/e2e/adapter.test.ts.js +0 -82953
  82. package/dist/examples/coingecko/test/integration/adapter.test.ts.js +0 -91672
  83. package/dist/main.js +0 -72703
  84. package/docker-compose.yaml +0 -35
  85. package/env.sh +0 -54
  86. package/env2.sh +0 -55
  87. package/jest.config.js +0 -5
  88. package/publish.sh +0 -0
  89. package/src/adapter.ts +0 -263
  90. package/src/background-executor.ts +0 -52
  91. package/src/cache/factory.ts +0 -26
  92. package/src/cache/index.ts +0 -258
  93. package/src/cache/local.ts +0 -73
  94. package/src/cache/metrics.ts +0 -112
  95. package/src/cache/redis.ts +0 -93
  96. package/src/config/index.ts +0 -517
  97. package/src/config/provider-limits.ts +0 -127
  98. package/src/examples/bank-frick/README.MD +0 -10
  99. package/src/examples/bank-frick/accounts.ts +0 -246
  100. package/src/examples/bank-frick/config/index.ts +0 -53
  101. package/src/examples/bank-frick/index.ts +0 -13
  102. package/src/examples/bank-frick/types.d.ts +0 -38
  103. package/src/examples/bank-frick/util.ts +0 -55
  104. package/src/examples/coingecko/src/config/index.ts +0 -12
  105. package/src/examples/coingecko/src/config/overrides.json +0 -10826
  106. package/src/examples/coingecko/src/cryptoUtils.ts +0 -88
  107. package/src/examples/coingecko/src/endpoint/coins.ts +0 -54
  108. package/src/examples/coingecko/src/endpoint/crypto-marketcap.ts +0 -66
  109. package/src/examples/coingecko/src/endpoint/crypto-volume.ts +0 -66
  110. package/src/examples/coingecko/src/endpoint/crypto.ts +0 -63
  111. package/src/examples/coingecko/src/endpoint/dominance.ts +0 -40
  112. package/src/examples/coingecko/src/endpoint/global-marketcap.ts +0 -40
  113. package/src/examples/coingecko/src/endpoint/index.ts +0 -6
  114. package/src/examples/coingecko/src/globalUtils.ts +0 -78
  115. package/src/examples/coingecko/src/index.ts +0 -17
  116. package/src/examples/coingecko/test/e2e/adapter.test.ts +0 -278
  117. package/src/examples/coingecko/test/integration/__snapshots__/adapter.test.ts.snap +0 -15
  118. package/src/examples/coingecko/test/integration/adapter.test.ts +0 -281
  119. package/src/examples/coingecko/test/integration/capturedRequests.json +0 -1
  120. package/src/examples/coingecko/test/integration/fixtures.ts +0 -42
  121. package/src/examples/coingecko-old/batch-warming.ts +0 -79
  122. package/src/examples/coingecko-old/index.ts +0 -9
  123. package/src/examples/coingecko-old/rest.ts +0 -77
  124. package/src/examples/ncfx/config/index.ts +0 -12
  125. package/src/examples/ncfx/index.ts +0 -9
  126. package/src/examples/ncfx/websocket.ts +0 -99
  127. package/src/index.ts +0 -149
  128. package/src/metrics/constants.ts +0 -23
  129. package/src/metrics/index.ts +0 -115
  130. package/src/metrics/util.ts +0 -18
  131. package/src/rate-limiting/background/fixed-frequency.ts +0 -45
  132. package/src/rate-limiting/index.ts +0 -100
  133. package/src/rate-limiting/metrics.ts +0 -18
  134. package/src/rate-limiting/request/simple-counting.ts +0 -76
  135. package/src/transports/batch-warming.ts +0 -127
  136. package/src/transports/index.ts +0 -152
  137. package/src/transports/metrics.ts +0 -95
  138. package/src/transports/rest.ts +0 -168
  139. package/src/transports/util.ts +0 -63
  140. package/src/transports/websocket.ts +0 -245
  141. package/src/util/index.ts +0 -23
  142. package/src/util/logger.ts +0 -69
  143. package/src/util/recordRequests.ts +0 -47
  144. package/src/util/request.ts +0 -117
  145. package/src/util/subscription-set/expiring-sorted-set.ts +0 -54
  146. package/src/util/subscription-set/subscription-set.ts +0 -35
  147. package/src/util/test-payload-loader.ts +0 -87
  148. package/src/validation/error.ts +0 -116
  149. package/src/validation/index.ts +0 -110
  150. package/src/validation/input-params.ts +0 -45
  151. package/src/validation/override-functions.ts +0 -44
  152. package/src/validation/overrideFunctions.ts +0 -44
  153. package/src/validation/preset-tokens.json +0 -23
  154. package/src/validation/validator.ts +0 -384
  155. package/test/adapter.test.ts +0 -27
  156. package/test/background-executor.test.ts +0 -108
  157. package/test/cache/cache-key.test.ts +0 -114
  158. package/test/cache/helper.ts +0 -100
  159. package/test/cache/local.test.ts +0 -54
  160. package/test/cache/redis.test.ts +0 -89
  161. package/test/correlation.test.ts +0 -114
  162. package/test/index.test.ts +0 -37
  163. package/test/metrics/feed-id.test.ts +0 -38
  164. package/test/metrics/helper.ts +0 -14
  165. package/test/metrics/labels.test.ts +0 -36
  166. package/test/metrics/metrics.test.ts +0 -267
  167. package/test/metrics/redis-metrics.test.ts +0 -113
  168. package/test/metrics/warmer-metrics.test.ts +0 -193
  169. package/test/metrics/ws-metrics.test.ts +0 -225
  170. package/test/rate-limit-config.test.ts +0 -242
  171. package/test/smoke/smoke.test.ts +0 -166
  172. package/test/smoke/test-payload-fail.json +0 -3
  173. package/test/smoke/test-payload.js +0 -22
  174. package/test/smoke/test-payload.json +0 -7
  175. package/test/transports/batch.test.ts +0 -466
  176. package/test/transports/rest.test.ts +0 -242
  177. package/test/transports/websocket.test.ts +0 -183
  178. package/test/tsconfig.json +0 -5
  179. package/test/util.ts +0 -77
  180. package/test/validation.test.ts +0 -178
  181. package/test.sh +0 -20
  182. package/test2.sh +0 -2
  183. package/tsconfig.json +0 -28
  184. package/typedoc.json +0 -6
  185. package/webpack.config.js +0 -57
  186. package/yarn-error.log +0 -3778
@@ -0,0 +1,264 @@
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
+ /* eslint-disable max-nested-callbacks */
7
+ const index_1 = require("../../src/index");
8
+ const __1 = require("../../../..");
9
+ const supertest_1 = __importDefault(require("supertest"));
10
+ const fixtures_1 = require("./fixtures");
11
+ let adapterServer;
12
+ function sleep(ms) {
13
+ // eslint-disable-next-line
14
+ return new Promise((resolve) => setTimeout(resolve, ms));
15
+ }
16
+ describe('execute', () => {
17
+ const id = '1';
18
+ let req;
19
+ jest.setTimeout(10000);
20
+ const successfulRequests = {
21
+ crypto: {
22
+ id,
23
+ data: {
24
+ base: 'ETH',
25
+ quote: 'USD',
26
+ },
27
+ },
28
+ cryptoWithCoinid: {
29
+ id,
30
+ data: {
31
+ coinid: 'bitcoin',
32
+ quote: 'USD',
33
+ },
34
+ },
35
+ cryptoWithOverride: {
36
+ id,
37
+ data: {
38
+ base: 'BTC',
39
+ quote: 'EUR',
40
+ overrides: {
41
+ coingecko: {
42
+ BTC: 'solana',
43
+ },
44
+ },
45
+ },
46
+ },
47
+ coins: {
48
+ id,
49
+ endpoint: 'coins',
50
+ },
51
+ marketcap: {
52
+ id,
53
+ endpoint: 'marketcap',
54
+ data: {
55
+ base: 'ETH',
56
+ quote: 'USD',
57
+ },
58
+ },
59
+ volume: {
60
+ id,
61
+ endpoint: 'volume',
62
+ data: {
63
+ base: 'ETH',
64
+ quote: 'USD',
65
+ },
66
+ },
67
+ globalmarketcap: {
68
+ id,
69
+ endpoint: 'globalmarketcap',
70
+ data: {
71
+ market: 'ETH',
72
+ },
73
+ },
74
+ dominance: {
75
+ id,
76
+ endpoint: 'dominance',
77
+ data: {
78
+ market: 'ETH',
79
+ },
80
+ },
81
+ };
82
+ const errorRequests = {
83
+ cryptoWithBadSymbol: {
84
+ id,
85
+ data: {
86
+ base: 'ZWXK',
87
+ quote: 'USD',
88
+ },
89
+ },
90
+ cryptoWithBadOverride: {
91
+ id,
92
+ data: {
93
+ base: 'LINK',
94
+ quote: 'USD',
95
+ overrides: {
96
+ coingecko: {
97
+ LINK: 'badtokenid',
98
+ },
99
+ },
100
+ },
101
+ },
102
+ dominanceWithBadSymbol: {
103
+ id,
104
+ endpoint: 'dominance',
105
+ data: {
106
+ market: 'ZWXK',
107
+ },
108
+ },
109
+ };
110
+ beforeAll(async () => {
111
+ try {
112
+ adapterServer = await (0, __1.expose)(index_1.adapter);
113
+ req = (0, supertest_1.default)('localhost:8080');
114
+ }
115
+ catch {
116
+ throw new Error('Could not start server when running CoinGecko e2e tests');
117
+ }
118
+ if (!adapterServer) {
119
+ throw new Error('Could not start server when running CoinGecko e2e tests');
120
+ }
121
+ (0, fixtures_1.createMocks)();
122
+ // Send inital requests to warm the cache
123
+ const pendingRequests = [];
124
+ for (const reqData of Object.values(successfulRequests)) {
125
+ pendingRequests.push(req.post('/').send(reqData));
126
+ }
127
+ for (const reqData of Object.values(errorRequests)) {
128
+ pendingRequests.push(req.post('/').send(reqData));
129
+ }
130
+ // Wait for all the pending requests to be complete
131
+ Promise.all(pendingRequests);
132
+ // Sleep while the cache is filled
133
+ await sleep(5000);
134
+ });
135
+ afterAll((done) => {
136
+ if (adapterServer) {
137
+ adapterServer.close(done());
138
+ }
139
+ });
140
+ describe('crypto api', () => {
141
+ it('should return success', async () => {
142
+ // Send inital request to warm cache
143
+ const response = await req
144
+ .post('/')
145
+ .send(successfulRequests.crypto)
146
+ .set('Accept', '*/*')
147
+ .set('Content-Type', 'application/json')
148
+ .expect(200);
149
+ expect(response.body.result).toMatchSnapshot();
150
+ });
151
+ it('should return success with coinid', async () => {
152
+ const response = await req
153
+ .post('/')
154
+ .send(successfulRequests.cryptoWithCoinid)
155
+ .set('Accept', '*/*')
156
+ .set('Content-Type', 'application/json')
157
+ .expect('Content-Type', /json/)
158
+ .expect(200);
159
+ expect(response.body.result).toMatchSnapshot();
160
+ });
161
+ it('should return error message for bad symbol', async () => {
162
+ await req
163
+ .post('/')
164
+ .send(errorRequests.cryptoWithBadSymbol)
165
+ .set('Accept', '*/*')
166
+ .set('Content-Type', 'application/json')
167
+ .expect(504);
168
+ });
169
+ it('should return success with override', async () => {
170
+ const response = await req
171
+ .post('/')
172
+ .send(successfulRequests.cryptoWithOverride)
173
+ .set('Accept', '*/*')
174
+ .set('Content-Type', 'application/json')
175
+ .expect('Content-Type', /json/)
176
+ .expect(200);
177
+ expect(response.body.result).toMatchSnapshot();
178
+ });
179
+ it('should return 504 for bad override', async () => {
180
+ const response = await req
181
+ .post('/')
182
+ .send(errorRequests.cryptoWithBadOverride)
183
+ .set('Accept', '*/*')
184
+ .set('Content-Type', 'application/json')
185
+ .expect(504);
186
+ expect(typeof response.body.result === 'string');
187
+ });
188
+ it('should return 504 for bad symbol', async () => {
189
+ await req
190
+ .post('/')
191
+ .send(errorRequests.cryptoWithBadSymbol)
192
+ .set('Accept', '*/*')
193
+ .set('Content-Type', 'application/json')
194
+ .expect(504);
195
+ });
196
+ });
197
+ describe('coins api', () => {
198
+ it('should return success', async () => {
199
+ await req
200
+ .post('/')
201
+ .send(successfulRequests.coins)
202
+ .set('Accept', '*/*')
203
+ .set('Content-Type', 'application/json')
204
+ .expect('Content-Type', /json/)
205
+ .expect(200);
206
+ });
207
+ });
208
+ describe('volume api', () => {
209
+ it('should return success', async () => {
210
+ const response = await req
211
+ .post('/')
212
+ .send(successfulRequests.volume)
213
+ .set('Accept', '*/*')
214
+ .set('Content-Type', 'application/json')
215
+ .expect('Content-Type', /json/)
216
+ .expect(200);
217
+ expect(response.body.result).toMatchSnapshot();
218
+ });
219
+ });
220
+ describe('marketcap api', () => {
221
+ it('should return success', async () => {
222
+ const response = await req
223
+ .post('/')
224
+ .send(successfulRequests.marketcap)
225
+ .set('Accept', '*/*')
226
+ .set('Content-Type', 'application/json')
227
+ .expect('Content-Type', /json/)
228
+ .expect(200);
229
+ expect(response.body.result).toMatchSnapshot();
230
+ });
231
+ });
232
+ describe('globalmarketcap api', () => {
233
+ it('should return success', async () => {
234
+ const response = await req
235
+ .post('/')
236
+ .send(successfulRequests.globalmarketcap)
237
+ .set('Accept', '*/*')
238
+ .set('Content-Type', 'application/json')
239
+ .expect('Content-Type', /json/)
240
+ .expect(200);
241
+ expect(response.body.result).toMatchSnapshot();
242
+ });
243
+ });
244
+ describe('dominance api', () => {
245
+ it('should return success', async () => {
246
+ const response = await req
247
+ .post('/')
248
+ .send(successfulRequests.dominance)
249
+ .set('Accept', '*/*')
250
+ .set('Content-Type', 'application/json')
251
+ .expect('Content-Type', /json/)
252
+ .expect(200);
253
+ expect(response.body.result).toMatchSnapshot();
254
+ });
255
+ it('should return 504 for bad symbol', async () => {
256
+ await req
257
+ .post('/')
258
+ .send(errorRequests.dominanceWithBadSymbol)
259
+ .set('Accept', '*/*')
260
+ .set('Content-Type', 'application/json')
261
+ .expect(504);
262
+ });
263
+ });
264
+ });