Make nav-fund-services generic (#4169)

* Make nav-fund-services generic

* Comments

Author: mxiao-cll

.changeset/fuzzy-apes-compare.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/nav-fund-services-adapter': patch
+---
+
+Make EA generic

packages/sources/nav-fund-services/src/config/index.ts

@@ -2,18 +2,6 @@ import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
 
 export const config = new AdapterConfig(
   {
-    API_KEY: {
-      description: 'An API key for Data Provider',
-      type: 'string',
-      required: true,
-      sensitive: true,
-    },
-    SECRET_KEY: {
-      description: 'A key for Data Provider used in hashing the API key',
-      type: 'string',
-      required: true,
-      sensitive: true,
-    },
     API_ENDPOINT: {
       description: 'An API endpoint for Data Provider',
       type: 'string',

packages/sources/nav-fund-services/src/endpoint/nav.ts

@@ -1,14 +1,16 @@
 import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
 import { config } from '../config'
+import { getApiKeys } from '../transport/creds'
 import { navTransport } from '../transport/nav'
 
 export const inputParameters = new InputParameters(
   {
     globalFundID: {
       required: true,
       type: 'number',
-      description: 'The global fund ID',
+      description: 'Used to match API_KEY_${fund} SECRET_KEY_${fund} env variables',
     },
   },
   [
@@ -36,4 +38,8 @@ export const endpoint = new AdapterEndpoint({
   name: 'nav',
   transport: navTransport,
   inputParameters,
+  customInputValidation: (req): AdapterInputError | undefined => {
+    getApiKeys(req.requestContext.data.globalFundID)
+    return
+  },
 })

packages/sources/nav-fund-services/src/transport/creds.ts

@@ -0,0 +1,18 @@
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+
+export const getApiKeys = (globalFundID: number) => {
+  const apiKeyName = `API_KEY_${globalFundID}`
+  const secretKeyName = `SECRET_KEY_${globalFundID}`
+
+  const apiKey = process.env[apiKeyName]
+  const secretKey = process.env[secretKeyName]
+
+  if (!apiKey || !secretKey) {
+    throw new AdapterInputError({
+      statusCode: 400,
+      message: `Missing '${apiKeyName}' or '${secretKeyName}' environment variables.`,
+    })
+  }
+
+  return [apiKey, secretKey]
+}

packages/sources/nav-fund-services/src/transport/nav.ts

@@ -8,6 +8,7 @@ import { SubscriptionTransport } from '@chainlink/external-adapter-framework/tra
 import { AdapterResponse, makeLogger, sleep } from '@chainlink/external-adapter-framework/util'
 import { Requester } from '@chainlink/external-adapter-framework/util/requester'
 import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+import { getApiKeys } from './creds'
 import { clampStartByBusinessDays, parseDateString, toDateString } from './date-utils'
 
 const logger = makeLogger('NavTransport')
@@ -66,11 +67,14 @@ export class NavTransport extends SubscriptionTransport<BaseEndpointTypes> {
   ): Promise<AdapterResponse<BaseEndpointTypes['Response']>> {
     const providerDataRequestedUnixMs = Date.now()
     logger.debug(`Handling request for globalFundID: ${param.globalFundID}`)
+
+    const [apiKey, secret] = getApiKeys(param.globalFundID)
+
     const { FromDate: earliestPossibleFromStr, ToDate: latestPossibleToStr } = await getFundDates({
       globalFundID: param.globalFundID,
       baseURL: this.config.API_ENDPOINT,
-      apiKey: this.config.API_KEY,
-      secret: this.config.SECRET_KEY,
+      apiKey,
+      secret,
       requester: this.requester,
     })
 
@@ -92,8 +96,8 @@ export class NavTransport extends SubscriptionTransport<BaseEndpointTypes> {
       fromDate: toDateString(preferredFrom),
       toDate: toDateString(latestPossibleTo),
       baseURL: this.config.API_ENDPOINT,
-      apiKey: this.config.API_KEY,
-      secret: this.config.SECRET_KEY,
+      apiKey,
+      secret,
       requester: this.requester,
     })
 

packages/sources/nav-fund-services/test/integration/adapter.test.ts

@@ -12,9 +12,9 @@ describe('execute', () => {
 
   beforeAll(async () => {
     oldEnv = JSON.parse(JSON.stringify(process.env))
-    process.env.API_KEY = process.env.API_KEY ?? 'fake-api-key'
-    process.env.SECRET_KEY = 'SOME_SECRET_KEY'
-    process.env.BACKGROUND_EXECUTE_MS = process.env.BACKGROUND_EXECUTE_MS ?? '0'
+    process.env.API_KEY_1234 = 'fake-api-key'
+    process.env.SECRET_KEY_1234 = 'SOME_SECRET_KEY'
+    process.env.BACKGROUND_EXECUTE_MS = '0'
     const mockDate = new Date('2001-01-01T00:00:00.000Z')
     spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
 

packages/sources/nav-fund-services/test/unit/nav.test.ts

@@ -17,12 +17,13 @@ let transport: NavTransport
 // adapter settings stub
 const adapterSettings = makeStub('adapterSettings', {
   API_ENDPOINT: 'https://api.navfund.com',
-  API_KEY: 'apiKey',
-  SECRET_KEY: 'secret',
   BACKGROUND_EXECUTE_MS: 0,
   WARMUP_SUBSCRIPTION_TTL: 10_000,
 } as unknown as BaseEndpointTypes['Settings'])
 
+process.env.API_KEY_123 = 'apiKey'
+process.env.SECRET_KEY_123 = 'secret'
+
 // requester stub that we'll control per‑test
 const requester = makeStub('requester', { request: jest.fn() })
 const responseCache = makeStub('responseCache', { write: jest.fn() })