DF-21712 Remove birc endpoint from cfbenchmarks (#4096)

Author: cll-gg

.changeset/spotty-pumpkins-decide.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/cfbenchmarks-adapter': minor
+---
+
+Remove unused birc endpoint from cfbenchmarks

packages/sources/cfbenchmarks/README.md

@@ -26,9 +26,9 @@ There are no rate limits for this adapter.
 
 ## Input Parameters
 
-| Required? |   Name   |     Description     |  Type  |                                                                                                          Options                                                                                                           | Default  |
-| :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
-|           | endpoint | The endpoint to use | string | [birc](#birc-endpoint), [crypto-lwba](#crypto-lwba-endpoint), [crypto](#crypto-endpoint), [crypto_lwba](#crypto-lwba-endpoint), [cryptolwba](#crypto-lwba-endpoint), [price](#crypto-endpoint), [values](#crypto-endpoint) | `crypto` |
+| Required? |   Name   |     Description     |  Type  |                                                                                              Options                                                                                               | Default  |
+| :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
+|           | endpoint | The endpoint to use | string | [crypto-lwba](#crypto-lwba-endpoint), [crypto](#crypto-endpoint), [crypto_lwba](#crypto-lwba-endpoint), [cryptolwba](#crypto-lwba-endpoint), [price](#crypto-endpoint), [values](#crypto-endpoint) | `crypto` |
 
 ## Crypto Endpoint
 
@@ -59,31 +59,6 @@ Request:
 
 ---
 
-## Birc Endpoint
-
-`birc` is the only supported name for this endpoint.
-
-### Input Params
-
-| Required? | Name  | Aliases |                  Description                  |  Type  |                        Options                         | Default | Depends On | Not Valid With |
-| :-------: | :---: | :-----: | :-------------------------------------------: | :----: | :----------------------------------------------------: | :-----: | :--------: | :------------: |
-|    ✅     | tenor |         | The tenor value to pull from the API response | string | `1M`, `1W`, `2M`, `2W`, `3M`, `3W`, `4M`, `5M`, `SIRB` |         |            |                |
-
-### Example
-
-Request:
-
-```json
-{
-  "data": {
-    "endpoint": "birc",
-    "tenor": "SIRB"
-  }
-}
-```
-
----
-
 ## Crypto-lwba Endpoint
 
 Supported names for this endpoint are: `crypto-lwba`, `crypto_lwba`, `cryptolwba`.

packages/sources/cfbenchmarks/src/endpoint/birc.ts

@@ -1,3 +1,2 @@
 export { endpoint as crypto } from './crypto'
-export { endpoint as birc } from './birc'
 export { endpoint as cryptolwba } from './crypto-lwba'

packages/sources/cfbenchmarks/src/endpoint/index.ts

@@ -1,11 +1,11 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { PriceAdapter } from '@chainlink/external-adapter-framework/adapter'
 import { config } from './config'
-import { birc, crypto, cryptolwba } from './endpoint'
+import { crypto, cryptolwba } from './endpoint'
 
 export const adapter = new PriceAdapter({
   name: 'CFBENCHMARKS',
-  endpoints: [crypto, birc, cryptolwba],
+  endpoints: [crypto, cryptolwba],
   defaultEndpoint: crypto.name,
   config,
 })

packages/sources/cfbenchmarks/src/index.ts

@@ -1,20 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`execute birc endpoint should return success 1`] = `
-{
-  "data": {
-    "result": 0.0947,
-  },
-  "result": 0.0947,
-  "statusCode": 200,
-  "timestamps": {
-    "providerDataReceivedUnixMs": 1641035471111,
-    "providerDataRequestedUnixMs": 1641035471111,
-    "providerIndicatedTimeUnixMs": 1677226637446,
-  },
-}
-`;
-
 exports[`execute crypto endpoint should return success 1`] = `
 {
   "data": {

packages/sources/cfbenchmarks/src/transport/birc.ts

@@ -1,9 +1,9 @@
-import { mockBircResponseSuccess, mockResponseSuccess } from './fixtures'
 import {
   TestAdapter,
   setEnvVariables,
 } from '@chainlink/external-adapter-framework/util/testing-utils'
 import * as nock from 'nock'
+import { mockResponseSuccess } from './fixtures'
 
 describe('execute', () => {
   let spy: jest.SpyInstance
@@ -32,19 +32,6 @@ describe('execute', () => {
     spy.mockRestore()
   })
 
-  describe('birc endpoint', () => {
-    it('should return success', async () => {
-      const data = {
-        endpoint: 'birc',
-        tenor: 'SIRB',
-      }
-      mockBircResponseSuccess()
-      const response = await testAdapter.request(data)
-      expect(response.statusCode).toBe(200)
-      expect(response.json()).toMatchSnapshot()
-    })
-  })
-
   describe('crypto endpoint', () => {
     it('should return success', async () => {
       const data = {

packages/sources/cfbenchmarks/src/transport/utils.ts

@@ -1,5 +1,5 @@
-import nock from 'nock'
 import { MockWebsocketServer } from '@chainlink/external-adapter-framework/util/testing-utils'
+import nock from 'nock'
 
 export const mockResponseSuccess = (): nock.Scope =>
   nock('https://www.cfbenchmarks.com/api')
@@ -13,47 +13,6 @@ export const mockResponseSuccess = (): nock.Scope =>
     })
     .persist()
 
-export const mockBircResponseSuccess = (): nock.Scope => {
-  const currentDayIsoString = new Date().toISOString()
-  const currentDayTimestampMs = new Date(currentDayIsoString).getTime()
-  return nock('https://www.cfbenchmarks.com/api')
-    .get('/v1/curves?id=BIRC')
-    .reply(200, {
-      serverTime: '2023-02-24T08:17:17.446Z',
-      payload: [
-        {
-          tenors: {
-            SIRB: '0.0986',
-            '1W': '0.0077',
-            '2W': '0.0186',
-            '3W': '0.0219',
-            '1M': '0.0168',
-            '2M': '0.0099',
-            '3M': '0.0097',
-            '4M': '0.0078',
-            '5M': '0.0059',
-          },
-          time: currentDayTimestampMs,
-        },
-        {
-          tenors: {
-            SIRB: '0.0947',
-            '1W': '0.0367',
-            '2W': '0.0185',
-            '3W': '0.0229',
-            '1M': '0.0274',
-            '2M': '0.0297',
-            '3M': '0.0275',
-            '4M': '0.0253',
-            '5M': '0.0000',
-          },
-          time: currentDayTimestampMs,
-        },
-      ],
-    })
-    .persist()
-}
-
 export const mockWebSocketServer = (URL: string): MockWebsocketServer => {
   const mockWsServer = new MockWebsocketServer(URL, { mock: false })
   mockWsServer.on('connection', (socket) => {