Added EURR endpoint to the-network-firm adapter (#2951)

Author: amit-momin

.changeset/thick-cobras-complain.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/the-network-firm-adapter': minor
+---
+
+Added EURR endpoint

packages/sources/the-network-firm/src/endpoint/eurr.ts

@@ -0,0 +1,16 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
+import { config } from '../config'
+import { httpTransport } from '../transport/eurr'
+import { EmptyInputParameters } from '@chainlink/external-adapter-framework/validation/input-params'
+
+export type BaseEndpointTypes = {
+  Parameters: EmptyInputParameters
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'eurr',
+  transport: httpTransport,
+})

packages/sources/the-network-firm/src/endpoint/index.ts

@@ -1,4 +1,5 @@
+export { endpoint as backed } from './backed'
+export { endpoint as eurr } from './eurr'
 export { endpoint as mco2 } from './mco2'
 export { endpoint as stbt } from './stbt'
-export { endpoint as backed } from './backed'
 export { endpoint as usdr } from './usdr'

packages/sources/the-network-firm/src/index.ts

@@ -1,17 +1,17 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { Adapter } from '@chainlink/external-adapter-framework/adapter'
 import { config } from './config'
-import { backed, mco2, stbt, usdr } from './endpoint'
+import { backed, eurr, mco2, stbt, usdr } from './endpoint'
 
 export const adapter = new Adapter({
   defaultEndpoint: mco2.name,
   name: 'THE_NETWORK_FIRM',
   config,
-  endpoints: [mco2, stbt, backed, usdr],
+  endpoints: [backed, eurr, mco2, stbt, usdr],
   rateLimiting: {
     tiers: {
       default: {
-        rateLimit1m: 6,
+        rateLimit1m: 30,
       },
     },
   },

packages/sources/the-network-firm/src/transport/eurr.ts

@@ -0,0 +1,79 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/eurr'
+
+export interface ResponseSchema {
+  accountName: string
+  totalReserve: number
+  totalToken: number
+  timestamp: string
+  ripcord: boolean
+  ripcordDetails: string[]
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) => {
+    return {
+      params: params,
+      request: {
+        baseURL: config.API_ENDPOINT,
+        url: '/EURR',
+      },
+    }
+  },
+  parseResponse: (params, response) => {
+    // Return error if ripcord indicator true
+    if (response.data.ripcord) {
+      const message = `Ripcord indicator true. Details: ${response.data.ripcordDetails.join(', ')}`
+      return [
+        {
+          params: params[0],
+          response: {
+            errorMessage: message,
+            statusCode: 502,
+            timestamps: {
+              providerIndicatedTimeUnixMs: new Date(response.data.timestamp).getTime(),
+            },
+          },
+        },
+      ]
+    }
+
+    const result = response.data.totalReserve
+
+    if (typeof response.data.totalReserve === 'undefined') {
+      return [
+        {
+          params: params[0],
+          response: {
+            errorMessage: `Response missing totalReserve`,
+            statusCode: 502,
+            timestamps: {
+              providerIndicatedTimeUnixMs: new Date(response.data.timestamp).getTime(),
+            },
+          },
+        },
+      ]
+    }
+
+    return [
+      {
+        params: params[0],
+        response: {
+          result,
+          data: {
+            result,
+          },
+          timestamps: {
+            providerIndicatedTimeUnixMs: new Date(response.data.timestamp).getTime(),
+          },
+        },
+      },
+    ]
+  },
+})

packages/sources/the-network-firm/test-payload.json

@@ -9,6 +9,9 @@
    },
    {
       "endpoint": "usdr"
+   },
+   {
+      "endpoint": "eurr"
    }
 ]
 }

packages/sources/the-network-firm/test/integration/__snapshots__/adapter.test.ts.snap

@@ -27,6 +27,21 @@ exports[`execute backed endpoint should return success 1`] = `
 }
 `;
 
+exports[`execute eurr endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 10000000,
+  },
+  "result": 10000000,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1692617659477,
+  },
+}
+`;
+
 exports[`execute mco2 endpoint should return success 1`] = `
 {
   "data": {

packages/sources/the-network-firm/test/integration/__snapshots__/ripcord.test.ts.snap

@@ -12,6 +12,18 @@ exports[`execute backed endpoint when ripcord true should return error 1`] = `
 }
 `;
 
+exports[`execute eurr endpoint when ripcord true  should return error 1`] = `
+{
+  "errorMessage": "Ripcord indicator true. Details: Balances",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1692617659477,
+  },
+}
+`;
+
 exports[`execute stbt endpoint when ripcord true  should return error 1`] = `
 {
   "errorMessage": "Ripcord indicator true. Details: Balances",

packages/sources/the-network-firm/test/integration/adapter.test.ts

@@ -5,6 +5,7 @@ import {
 import * as nock from 'nock'
 import {
   mockBackedResponseSuccess,
+  mockEurrResponseSuccess,
   mockMCO2Response,
   mockSTBTResponseSuccess,
   mockUSDRResponseSuccess,
@@ -93,4 +94,17 @@ describe('execute', () => {
       expect(response.json()).toMatchSnapshot()
     })
   })
+
+  describe('eurr endpoint', () => {
+    it('should return success', async () => {
+      const data = {
+        endpoint: 'eurr',
+      }
+      mockEurrResponseSuccess()
+
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
 })

packages/sources/the-network-firm/test/integration/fixtures.ts

@@ -169,3 +169,33 @@ export const mockUSDRResponseFailure = (): nock.Scope =>
       ripcordDetails: ['Balances'],
     })
     .persist()
+
+export const mockEurrResponseSuccess = (): nock.Scope =>
+  nock('https://api.oracle-services.ledgerlens.io/v1/chainlink/proof-of-reserves/', {
+    encodedQueryParams: true,
+  })
+    .get('/EURR')
+    .reply(200, {
+      accountName: 'EURR',
+      totalReserve: 10000000,
+      totalToken: 10000000,
+      timestamp: '2023-08-21T11:34:19.477Z',
+      ripcord: false,
+      ripcordDetails: [],
+    })
+    .persist()
+
+export const mockEurrResponseFailure = (): nock.Scope =>
+  nock('https://api.oracle-services.ledgerlens.io/v1/chainlink/proof-of-reserves/', {
+    encodedQueryParams: true,
+  })
+    .get('/EURR')
+    .reply(200, {
+      accountName: 'EURR',
+      totalReserve: 10000000,
+      totalToken: 10000000,
+      timestamp: '2023-08-21T11:34:19.477Z',
+      ripcord: true,
+      ripcordDetails: ['Balances'],
+    })
+    .persist()

packages/sources/the-network-firm/test/integration/ripcord.test.ts

@@ -5,6 +5,7 @@ import {
 import * as nock from 'nock'
 import {
   mockBackedResponseFailure,
+  mockEurrResponseFailure,
   mockSTBTResponseFailure,
   mockUSDRResponseFailure,
 } from './fixtures'
@@ -72,4 +73,16 @@ describe('execute', () => {
       expect(response.json()).toMatchSnapshot()
     })
   })
+
+  describe('eurr endpoint when ripcord true ', () => {
+    it('should return error', async () => {
+      const data = {
+        endpoint: 'eurr',
+      }
+      mockEurrResponseFailure()
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(502)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
 })