Bitgo Reserve multi client (#3772)

* Bitgo Reserve multi client

* comments

* comment

* Comment

* comments

Author: mxiao-cll

.changeset/chatty-laws-burn.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/bitgo-reserves-adapter': minor
+---
+
+Allow multi client

packages/sources/bitgo-reserves/src/config/index.ts

@@ -2,14 +2,15 @@ import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
 
 export const config = new AdapterConfig({
   API_ENDPOINT: {
-    description: 'An API endpoint for Data Provider',
+    description: 'An API endpoint for Go USD',
     type: 'string',
     default: 'https://reserves.gousd.com/por.json',
   },
   VERIFICATION_PUBKEY: {
     description:
-      'Public RSA key used for verifying data signature. Expected to be formatted as a single line eg: "-----BEGIN PUBLIC KEY-----\\n...contents...\\n-----END PUBLIC KEY-----"',
+      'Public RSA key used for verifying data signature for Go USD. Expected to be formatted as a single line eg: "-----BEGIN PUBLIC KEY-----\\n...contents...\\n-----END PUBLIC KEY-----"',
     type: 'string',
-    required: true,
+    default: '',
   },
+  // You can additionally add ${client}_API_ENDPOINT ${client}_VERIFICATION_PUBKEY to match ${client} in EA input param
 })

packages/sources/bitgo-reserves/src/endpoint/reserves.ts

@@ -2,9 +2,24 @@ import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import { InputParameters } from '@chainlink/external-adapter-framework/validation'
 import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
 import { config } from '../config'
-import { httpTransport } from '../transport/reserves'
+import { httpTransport, getCreds } from '../transport/reserves'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
 
-export const inputParameters = new InputParameters({})
+export const inputParameters = new InputParameters(
+  {
+    client: {
+      description:
+        'Used to match ${client}_API_ENDPOINT ${client}_VERIFICATION_PUBKEY environment variables',
+      type: 'string',
+      default: 'gousd',
+    },
+  },
+  [
+    {
+      client: 'gousd',
+    },
+  ],
+)
 
 export type BaseEndpointTypes = {
   Parameters: typeof inputParameters.definition
@@ -16,4 +31,12 @@ export const endpoint = new AdapterEndpoint({
   name: 'reserves',
   transport: httpTransport,
   inputParameters,
+  customInputValidation: (request, adapterSettings): AdapterInputError | undefined => {
+    getCreds(
+      request.requestContext.data.client,
+      adapterSettings.API_ENDPOINT,
+      adapterSettings.VERIFICATION_PUBKEY,
+    )
+    return
+  },
 })

packages/sources/bitgo-reserves/src/transport/reserves.ts

@@ -5,7 +5,7 @@ import {
 } from '@chainlink/external-adapter-framework/transports'
 import { BaseEndpointTypes } from '../endpoint/reserves'
 import * as crypto from 'crypto'
-import { AdapterSettings } from '@chainlink/external-adapter-framework/config'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
 
 export interface DataSchema {
   totalReserve: string
@@ -29,32 +29,57 @@ export type HttpTransportTypes = BaseEndpointTypes & {
 
 class ReservesHttpTransport extends HttpTransport<HttpTransportTypes> {
   pubkey!: string
+  endpoint!: string
 
   constructor(config: HttpTransportConfig<HttpTransportTypes>) {
     super(config)
   }
 
   override async initialize(
     dependencies: TransportDependencies<HttpTransportTypes>,
-    adapterSettings: AdapterSettings<{
-      API_ENDPOINT: { description: string; type: 'string'; default: string }
-      VERIFICATION_PUBKEY: { description: string; type: 'string'; required: true }
-    }>,
+    adapterSettings: HttpTransportTypes['Settings'],
     endpointName: string,
     transportName: string,
   ): Promise<void> {
     super.initialize(dependencies, adapterSettings, endpointName, transportName)
     this.pubkey = adapterSettings.VERIFICATION_PUBKEY.replace(/\\n/g, '\n')
+    this.endpoint = adapterSettings.API_ENDPOINT
+  }
+}
+
+export const getCreds = (client: string, defaultEndpoint: string, defaultKey: string) => {
+  if (client == 'gousd' && defaultKey.length != 0) {
+    return {
+      endpoint: defaultEndpoint,
+      key: defaultKey,
+    }
+  } else {
+    const apiEndpointName = `${client.toUpperCase()}_API_ENDPOINT`
+    const pubKeyName = `${client.toUpperCase()}_VERIFICATION_PUBKEY`
+    const endpoint = process.env[apiEndpointName]
+    const pubKey = process.env[pubKeyName]
+    if (!endpoint || !pubKey) {
+      throw new AdapterInputError({
+        statusCode: 400,
+        message: `Missing '${apiEndpointName}' or '${pubKeyName}' environment variables.`,
+      })
+    }
+    return {
+      endpoint: endpoint,
+      key: pubKey.replace(/\\n/g, '\n'),
+    }
   }
 }
 
 export const httpTransport = new ReservesHttpTransport({
   prepareRequests: (params, config) => {
     return params.map((param) => {
+      const endpoint = getCreds(param.client, config.API_ENDPOINT, httpTransport.pubkey)
+        .endpoint as string
       return {
         params: [param],
         request: {
-          baseURL: config.API_ENDPOINT,
+          baseURL: endpoint,
         },
       }
     })
@@ -89,7 +114,12 @@ export const httpTransport = new ReservesHttpTransport({
 
     const verifier = crypto.createVerify('sha256')
     verifier.update(payload.data)
-    if (!verifier.verify(httpTransport.pubkey, payload.dataSignature, 'base64')) {
+    const verified = verifier.verify(
+      getCreds(params[0].client, httpTransport.endpoint, httpTransport.pubkey).key,
+      payload.dataSignature,
+      'base64',
+    )
+    if (!verified) {
       return params.map((param) => {
         return {
           params: param,

packages/sources/bitgo-reserves/test/integration/__snapshots__/adapter.test.ts.snap

@@ -1,5 +1,16 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`execute reserves endpoint should return failure for non exist client 1`] = `
+{
+  "error": {
+    "message": "Missing 'C2_API_ENDPOINT' or 'C2_VERIFICATION_PUBKEY' environment variables.",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;
+
 exports[`execute reserves endpoint should return success 1`] = `
 {
   "data": {
@@ -13,4 +24,19 @@ exports[`execute reserves endpoint should return success 1`] = `
     "providerIndicatedTimeUnixMs": 1733793825000,
   },
 }
-`;
+`;
+
+exports[`execute reserves endpoint should return success for multi client 1`] = `
+{
+  "data": {
+    "result": 12345678.91,
+  },
+  "result": 12345678.91,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1733793825000,
+  },
+}
+`;

packages/sources/bitgo-reserves/test/integration/adapter.test.ts

@@ -3,7 +3,7 @@ import {
   setEnvVariables,
 } from '@chainlink/external-adapter-framework/util/testing-utils'
 import * as nock from 'nock'
-import { mockResponseSuccess } from './fixtures'
+import { mockResponseSuccess, mockResponseSuccessC1 } from './fixtures'
 
 describe('execute', () => {
   let spy: jest.SpyInstance
@@ -15,6 +15,9 @@ describe('execute', () => {
     process.env.API_ENDPOINT = 'http://test-endpoint.com'
     process.env.VERIFICATION_PUBKEY = 'test'
 
+    process.env.C1_API_ENDPOINT = 'http://test-endpoint-c1.com'
+    process.env.C1_VERIFICATION_PUBKEY = 'test-c1'
+
     const mockDate = new Date('2001-01-01T11:11:11.111Z')
     spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
 
@@ -49,6 +52,29 @@ describe('execute', () => {
       expect(response.statusCode).toBe(200)
       expect(response.json()).toMatchSnapshot()
     })
+
+    it('should return success for multi client', async () => {
+      const data = {
+        endpoint: 'reserves',
+        client: 'c1',
+      }
+      mockResponseSuccessC1()
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+
+    it('should return failure for non exist client', async () => {
+      const data = {
+        endpoint: 'reserves',
+        client: 'c2',
+      }
+      mockResponseSuccess()
+      mockResponseSuccessC1()
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(400)
+      expect(response.json()).toMatchSnapshot()
+    })
   })
   // Note: issues with mock verifier prevent further tests
 })

packages/sources/bitgo-reserves/test/integration/fixtures.ts

@@ -24,3 +24,28 @@ export const mockResponseSuccess = (): nock.Scope =>
       ],
     )
     .persist()
+
+export const mockResponseSuccessC1 = (): nock.Scope =>
+  nock('http://test-endpoint-c1.com', {
+    encodedQueryParams: true,
+  })
+    .get('/')
+    .reply(
+      200,
+      () => ({
+        data: '{"totalReserve":"12345678.91","cashReserve":"2345678.91","investedReserve":"10000000.01","lastUpdated":"2024-12-10T01:23:45Z"}',
+        dataSignature: 'testsig',
+        lastUpdated: '2024-10-01T01:23:45Z',
+      }),
+      [
+        'Content-Type',
+        'application/json',
+        'Connection',
+        'close',
+        'Vary',
+        'Accept-Encoding',
+        'Vary',
+        'Origin',
+      ],
+    )
+    .persist()