elwood lwba endpoint (#3061)

karen-stepanyan · alecgard · web-flow · commit 3dbbc533d069 · 2023-11-01T13:51:13.000Z
* update elwood to handle lwba

* elwood LWBA endpoint

* Soak test for LWBA

* update readme

---------

Co-authored-by: Alec Gard &lt;alec.gard@chainlinklabs.com&gt;
diff --git a/.changeset/lucky-rocks-sneeze.md b/.changeset/lucky-rocks-sneeze.md
@@ -0,0 +1,5 @@
+---
+'@chainlink/elwood-adapter': patch
+---
+
+Convert crypto to lwba endpoint
diff --git a/packages/sources/elwood/README.md b/packages/sources/elwood/README.md
@@ -6,11 +6,11 @@ This document was generated automatically. Please see [README Generator](../../s
 
 ## Environment Variables
 
-| Required? |      Name       |            Description            |  Type  | Options |                  Default                   |
-| :-------: | :-------------: | :-------------------------------: | :----: | :-----: | :----------------------------------------: |
-|    ✅     |     API_KEY     |              API key              | string |         |                                            |
-|           | WS_API_ENDPOINT | The websocket url for coinmetrics | string |         |  `wss://api.chk.elwood.systems/v1/stream`  |
-|           |  API_ENDPOINT   |    The API url for coinmetrics    | string |         | `https://api.chk.elwood.systems/v1/stream` |
+| Required? |      Name       |         Description          |  Type  | Options |                  Default                   |
+| :-------: | :-------------: | :--------------------------: | :----: | :-----: | :----------------------------------------: |
+|    ✅     |     API_KEY     |           API key            | string |         |                                            |
+|           | WS_API_ENDPOINT | The websocket url for elwood | string |         |  `wss://api.chk.elwood.systems/v1/stream`  |
+|           |  API_ENDPOINT   |    The API url for elwood    | string |         | `https://api.chk.elwood.systems/v1/stream` |
 
 ---
 
@@ -22,13 +22,13 @@ There are no rate limits for this adapter.
 
 ## Input Parameters
 
-| Required? |   Name   |     Description     |  Type  |                       Options                       | Default  |
-| :-------: | :------: | :-----------------: | :----: | :-------------------------------------------------: | :------: |
-|           | endpoint | The endpoint to use | string | [crypto](#price-endpoint), [price](#price-endpoint) | `crypto` |
+| Required? |   Name   |     Description     |  Type  |                                                                      Options                                                                       | Default |
+| :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------: | :-----: |
+|           | endpoint | The endpoint to use | string | [crypto-lwba](#price-endpoint), [crypto](#price-endpoint), [crypto_lwba](#price-endpoint), [cryptolwba](#price-endpoint), [price](#price-endpoint) | `price` |
 
 ## Price Endpoint
 
-Supported names for this endpoint are: `crypto`, `price`.
+Supported names for this endpoint are: `crypto`, `crypto-lwba`, `crypto_lwba`, `cryptolwba`, `price`.
 
 ### Input Params
 
diff --git a/packages/sources/elwood/src/config/index.ts b/packages/sources/elwood/src/config/index.ts
@@ -8,12 +8,12 @@ export const config = new AdapterConfig({
     sensitive: true,
   },
   WS_API_ENDPOINT: {
-    description: 'The websocket url for coinmetrics',
+    description: 'The websocket url for elwood',
     type: 'string',
     default: 'wss://api.chk.elwood.systems/v1/stream',
   },
   API_ENDPOINT: {
-    description: 'The API url for coinmetrics',
+    description: 'The API url for elwood',
     type: 'string',
     default: 'https://api.chk.elwood.systems/v1/stream',
   },
diff --git a/packages/sources/elwood/src/endpoint/crypto.ts b/packages/sources/elwood/src/endpoint/crypto.ts
@@ -1,5 +1,7 @@
 import {
   CryptoPriceEndpoint,
+  DEFAULT_LWBA_ALIASES,
+  LwbaResponseDataFields,
   priceEndpointInputParametersDefinition,
 } from '@chainlink/external-adapter-framework/adapter'
 import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
@@ -14,15 +16,17 @@ const inputParameters = new InputParameters(priceEndpointInputParametersDefiniti
   },
 ])
 
+type OmitResultFromLwba = Omit<LwbaResponseDataFields, 'Result'>
+
 export type BaseEndpointTypes = {
   Parameters: typeof inputParameters.definition
   Settings: typeof config.settings
-  Response: SingleNumberResultResponse
+  Response: OmitResultFromLwba & SingleNumberResultResponse
 }
 
 export const cryptoEndpoint = new CryptoPriceEndpoint({
   name: 'price',
-  aliases: ['crypto'],
+  aliases: ['crypto', ...DEFAULT_LWBA_ALIASES],
   inputParameters,
   transport,
 })
diff --git a/packages/sources/elwood/src/index.ts b/packages/sources/elwood/src/index.ts
@@ -5,7 +5,7 @@ import { config } from './config'
 
 export const adapter = new PriceAdapter({
   name: 'ELWOOD',
-  defaultEndpoint: 'crypto',
+  defaultEndpoint: cryptoEndpoint.name,
   config,
   endpoints: [cryptoEndpoint],
 })
diff --git a/packages/sources/elwood/src/transport/crypto.ts b/packages/sources/elwood/src/transport/crypto.ts
@@ -19,6 +19,8 @@ export type PriceResponse = {
   type: 'Index'
   data: {
     price: string
+    bid: string
+    ask: string
     symbol: string
     timestamp: string
   }
@@ -76,8 +78,8 @@ export const transport: WebSocketTransport<WsTransportTypes> =
               return
             }
 
-            const value = Number(message.data.price)
-            if (value < 0) {
+            const result = Number(message.data.price)
+            if (result < 0) {
               logger.warn(`Got invalid price "${message.data.price}" in WS message of type Index`)
               return
             }
@@ -89,8 +91,13 @@ export const transport: WebSocketTransport<WsTransportTypes> =
                   quote,
                 },
                 response: {
-                  result: value,
-                  data: { result: value },
+                  result,
+                  data: {
+                    result,
+                    bid: Number(message.data.bid),
+                    ask: Number(message.data.ask),
+                    mid: result,
+                  },
                   timestamps: {
                     providerIndicatedTimeUnixMs: new Date(message.data.timestamp).getTime(),
                   },
diff --git a/packages/sources/elwood/test-payload.json b/packages/sources/elwood/test-payload.json
@@ -1,6 +1,13 @@
 {
- "requests": [{
-  "from": "LINK",
-  "to": "USD"
- }]
-}
+  "requests": [
+    {
+      "from": "LINK",
+      "to": "USD"
+    },
+    {
+      "from": "ETH",
+      "to": "USD",
+      "endpoint": "crypto-lwba"
+    }
+  ]
+}
diff --git a/packages/sources/elwood/test/integration/__snapshots__/adapter.test.ts.snap b/packages/sources/elwood/test/integration/__snapshots__/adapter.test.ts.snap
@@ -14,6 +14,9 @@ exports[`websocket price endpoint should return cached subscribe error 1`] = `
 exports[`websocket price endpoint should return success 1`] = `
 {
   "data": {
+    "ask": 10002,
+    "bid": 10001,
+    "mid": 10000,
     "result": 10000,
   },
   "result": 10000,
diff --git a/packages/sources/elwood/test/integration/fixtures.ts b/packages/sources/elwood/test/integration/fixtures.ts
@@ -58,6 +58,8 @@ export const mockWebSocketServer = (URL: string) => {
               type: 'Index',
               data: {
                 price: '10000',
+                bid: '10001',
+                ask: '10002',
                 symbol: 'ETH-USD',
                 timestamp: '2022-11-08T04:18:18.736534617Z',
               },
