Feat/df 21516 uranium (#3926)

mmcallister-cll · web-flow · commit 229ac4c78777 · 2025-07-07T18:54:35.000-04:00
* DF-21516 the-network-firm uranium endpoint

* add comment

* add changeset
diff --git a/.changeset/lazy-coats-shave.md b/.changeset/lazy-coats-shave.md
@@ -0,0 +1,5 @@
+---
+'@chainlink/the-network-firm-adapter': minor
+---
+
+Add uranium endpoint
diff --git a/packages/sources/the-network-firm/src/config/index.ts b/packages/sources/the-network-firm/src/config/index.ts
@@ -18,4 +18,11 @@ export const config = new AdapterConfig({
     sensitive: true,
     default: '',
   },
+  URANIUM_API_KEY: {
+    description: 'API key used for uranium endpoint',
+    type: 'string',
+    required: false,
+    sensitive: true,
+    default: '',
+  },
 })
diff --git a/packages/sources/the-network-firm/src/endpoint/emgemx.ts b/packages/sources/the-network-firm/src/endpoint/emgemx.ts
@@ -1,20 +1,8 @@
-import {
-  PoRProviderEndpoint,
-  PoRProviderResponse,
-} from '@chainlink/external-adapter-framework/adapter/por'
-import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { PoRProviderEndpoint } from '@chainlink/external-adapter-framework/adapter/por'
 import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
-import { config } from '../config'
+import { inputParameters } from '../transport/common'
 import { httpTransport } from '../transport/emgemx'
 
-export const inputParameters = new InputParameters({})
-
-export type BaseEndpointTypes = {
-  Parameters: typeof inputParameters.definition
-  Response: PoRProviderResponse
-  Settings: typeof config.settings
-}
-
 export const endpoint = new PoRProviderEndpoint({
   name: 'emgemx',
   transport: httpTransport,
diff --git a/packages/sources/the-network-firm/src/endpoint/index.ts b/packages/sources/the-network-firm/src/endpoint/index.ts
@@ -4,4 +4,5 @@ export { endpoint as eurr } from './eurr'
 export { endpoint as gift } from './gift'
 export { endpoint as mco2 } from './mco2'
 export { endpoint as stbt } from './stbt'
+export { endpoint as uranium } from './uranium'
 export { endpoint as usdr } from './usdr'
diff --git a/packages/sources/the-network-firm/src/endpoint/uranium.ts b/packages/sources/the-network-firm/src/endpoint/uranium.ts
@@ -0,0 +1,19 @@
+import { PoRProviderEndpoint } from '@chainlink/external-adapter-framework/adapter/por'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+import { inputParameters } from '../transport/common'
+import { httpTransport } from '../transport/uranium'
+
+export const endpoint = new PoRProviderEndpoint({
+  name: 'uranium',
+  transport: httpTransport,
+  inputParameters,
+  customInputValidation: (_, adapterSettings): AdapterInputError | undefined => {
+    if (!adapterSettings.URANIUM_API_KEY) {
+      throw new AdapterInputError({
+        statusCode: 500,
+        message: 'missing URANIUM_API_KEY env var',
+      })
+    }
+    return
+  },
+})
diff --git a/packages/sources/the-network-firm/src/index.ts b/packages/sources/the-network-firm/src/index.ts
@@ -1,13 +1,13 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { PoRAdapter } from '@chainlink/external-adapter-framework/adapter/por'
 import { config } from './config'
-import { backed, emgemx, eurr, gift, mco2, stbt, usdr } from './endpoint'
+import { backed, emgemx, eurr, gift, mco2, stbt, uranium, usdr } from './endpoint'
 
 export const adapter = new PoRAdapter({
   defaultEndpoint: mco2.name,
   name: 'THE_NETWORK_FIRM',
   config,
-  endpoints: [backed, eurr, gift, mco2, stbt, usdr, emgemx],
+  endpoints: [backed, emgemx, eurr, gift, mco2, stbt, uranium, usdr],
   rateLimiting: {
     tiers: {
       default: {
diff --git a/packages/sources/the-network-firm/src/transport/common.ts b/packages/sources/the-network-firm/src/transport/common.ts
@@ -0,0 +1,46 @@
+import { PoRProviderResponse } from '@chainlink/external-adapter-framework/adapter/por'
+import { ProviderRequestConfig } from '@chainlink/external-adapter-framework/transports'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { TypeFromDefinition } from '@chainlink/external-adapter-framework/validation/input-params'
+import { config } from '../config'
+
+export const inputParameters = new InputParameters({})
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: PoRProviderResponse
+  Settings: typeof config.settings
+}
+
+export interface ResponseSchema {
+  totalReserve: string
+  totalToken: string
+  ripcord: boolean
+  ripcordDetails: string[]
+  timestamp: string
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+export function prepareRequests(
+  params: TypeFromDefinition<BaseEndpointTypes['Parameters']>[],
+  baseURL: string,
+  url: string,
+  apikey: string,
+): ProviderRequestConfig<HttpTransportTypes> {
+  return {
+    params,
+    request: {
+      baseURL,
+      url,
+      headers: {
+        apikey,
+      },
+    },
+  }
+}
diff --git a/packages/sources/the-network-firm/src/transport/emgemx.ts b/packages/sources/the-network-firm/src/transport/emgemx.ts
@@ -1,34 +1,9 @@
 import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
-import { BaseEndpointTypes } from '../endpoint/emgemx'
-
-export interface ResponseSchema {
-  totalReserve: string
-  totalToken: string
-  ripcord: boolean
-  ripcordDetails: string[]
-  timestamp: string
-}
-
-export type HttpTransportTypes = BaseEndpointTypes & {
-  Provider: {
-    RequestBody: never
-    ResponseBody: ResponseSchema
-  }
-}
+import { HttpTransportTypes, prepareRequests } from './common'
 
 export const httpTransport = new HttpTransport<HttpTransportTypes>({
-  prepareRequests: (params, config) => {
-    return {
-      params,
-      request: {
-        baseURL: config.ALT_API_ENDPOINT,
-        url: '/emgemx-tdfkf3',
-        headers: {
-          apikey: config.EMGEMX_API_KEY,
-        },
-      },
-    }
-  },
+  prepareRequests: (params, config) =>
+    prepareRequests(params, config.ALT_API_ENDPOINT, '/emgemx-tdfkf3', config.EMGEMX_API_KEY),
   parseResponse: (params, response) => {
     return params.map((param) => {
       const timestamps = {
diff --git a/packages/sources/the-network-firm/src/transport/uranium.ts b/packages/sources/the-network-firm/src/transport/uranium.ts
@@ -0,0 +1,56 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { makeLogger } from '@chainlink/external-adapter-framework/util'
+import { HttpTransportTypes, prepareRequests } from './common'
+
+const logger = makeLogger('UraniumHTTPTransport')
+
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) =>
+    prepareRequests(
+      params,
+      config.ALT_API_ENDPOINT,
+      '/uranium-digital-qohmmjqaf4jk',
+      config.URANIUM_API_KEY,
+    ),
+  parseResponse: (params, response) => {
+    return params.map((param) => {
+      const timestamps = {
+        providerIndicatedTimeUnixMs: new Date(response.data.timestamp).getTime(),
+      }
+
+      const reserve = response.data.totalReserve
+      const supply = response.data.totalToken
+
+      if (!response.data || isNaN(Number(reserve)) || isNaN(Number(supply))) {
+        return {
+          params: param,
+          response: {
+            errorMessage:
+              'Response is missing response fields (expected: totalReserve & totalToken)',
+            ripcord: response.data.ripcord ?? undefined,
+            statusCode: 502,
+            timestamps,
+          },
+        }
+      }
+
+      if (response.data.ripcord) {
+        logger.debug(`Ripcord indicator true. Details: ${response.data.ripcordDetails.join(', ')}`)
+      }
+
+      const result = Number(reserve)
+      return {
+        params: param,
+        response: {
+          result,
+          data: {
+            result,
+            ripcord: response.data.ripcord,
+            ripcordAsInt: Number(response.data.ripcord),
+          },
+          timestamps,
+        },
+      }
+    })
+  },
+})
diff --git a/packages/sources/the-network-firm/test/integration/__snapshots__/adapter.test.ts.snap b/packages/sources/the-network-firm/test/integration/__snapshots__/adapter.test.ts.snap
@@ -107,6 +107,36 @@ exports[`execute stbt endpoint should return success 1`] = `
 }
 `;
 
+exports[`execute uranium endpoint should fail 1`] = `
+{
+  "errorMessage": "Response is missing response fields (expected: totalReserve & totalToken)",
+  "ripcord": true,
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1751500917131,
+  },
+}
+`;
+
+exports[`execute uranium endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 1000000,
+    "ripcord": false,
+    "ripcordAsInt": 0,
+  },
+  "result": 1000000,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1751500917131,
+  },
+}
+`;
+
 exports[`execute usdr endpoint should return success 1`] = `
 {
   "data": {
diff --git a/packages/sources/the-network-firm/test/integration/__snapshots__/ripcord.test.ts.snap b/packages/sources/the-network-firm/test/integration/__snapshots__/ripcord.test.ts.snap
@@ -14,7 +14,7 @@ exports[`execute backed endpoint when ripcord true should return error 1`] = `
 }
 `;
 
-exports[`execute emgemx endpoint when ripcord true  should return error 1`] = `
+exports[`execute emgemx endpoint when ripcord true should return error 1`] = `
 {
   "errorMessage": "Ripcord indicator true. Details: Balances",
   "ripcord": true,
@@ -28,7 +28,7 @@ exports[`execute emgemx endpoint when ripcord true  should return error 1`] = `
 }
 `;
 
-exports[`execute eurr 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",
   "ripcord": true,
@@ -42,7 +42,7 @@ exports[`execute eurr endpoint when ripcord true  should return error 1`] = `
 }
 `;
 
-exports[`execute gift endpoint when ripcord true  should return error 1`] = `
+exports[`execute gift endpoint when ripcord true should return error 1`] = `
 {
   "errorMessage": "Ripcord indicator true. Details: Balances",
   "ripcord": true,
@@ -56,7 +56,7 @@ exports[`execute gift endpoint when ripcord true  should return error 1`] = `
 }
 `;
 
-exports[`execute stbt endpoint when ripcord true  should return error 1`] = `
+exports[`execute stbt endpoint when ripcord true should return error 1`] = `
 {
   "errorMessage": "Ripcord indicator true. Details: Balances",
   "ripcord": true,
@@ -70,7 +70,24 @@ exports[`execute stbt endpoint when ripcord true  should return error 1`] = `
 }
 `;
 
-exports[`execute usdr endpoint when ripcord true  should return error 1`] = `
+exports[`execute uranium endpoint when ripcord true should succeed 1`] = `
+{
+  "data": {
+    "result": 1000000,
+    "ripcord": true,
+    "ripcordAsInt": 1,
+  },
+  "result": 1000000,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1751500917131,
+  },
+}
+`;
+
+exports[`execute usdr endpoint when ripcord true should return error 1`] = `
 {
   "errorMessage": "Ripcord indicator true. Details: Balances",
   "ripcord": true,
diff --git a/packages/sources/the-network-firm/test/integration/adapter.test.ts b/packages/sources/the-network-firm/test/integration/adapter.test.ts
@@ -1,6 +1,6 @@
 import {
-  TestAdapter,
   setEnvVariables,
+  TestAdapter,
 } from '@chainlink/external-adapter-framework/util/testing-utils'
 import * as nock from 'nock'
 import {
@@ -10,6 +10,8 @@ import {
   mockGiftResponseSuccess,
   mockMCO2Response,
   mockSTBTResponseSuccess,
+  mockUraniumResponseFailure,
+  mockUraniumResponseSuccess,
   mockUSDRResponseSuccess,
 } from './fixtures'
 
@@ -25,6 +27,7 @@ describe('execute', () => {
 
     process.env.ALT_API_ENDPOINT = 'http://test-endpoint-new'
     process.env.EMGEMX_API_KEY = 'api-key'
+    process.env.URANIUM_API_KEY = 'api-key'
 
     const adapter = (await import('./../../src')).adapter
     adapter.rateLimiting = undefined
@@ -33,6 +36,19 @@ describe('execute', () => {
     })
   })
 
+  afterEach(() => {
+    nock.cleanAll()
+
+    // clear EA cache
+    const keys = testAdapter.mockCache?.cache.keys()
+    if (!keys) {
+      throw new Error('unexpected failure 1')
+    }
+    for (const key of keys) {
+      testAdapter.mockCache?.delete(key)
+    }
+  })
+
   afterAll(async () => {
     setEnvVariables(oldEnv)
     await testAdapter.api.close()
@@ -138,4 +154,27 @@ describe('execute', () => {
       expect(response.json()).toMatchSnapshot()
     })
   })
+
+  describe('uranium endpoint', () => {
+    it('should return success', async () => {
+      const data = {
+        endpoint: 'uranium',
+      }
+      mockUraniumResponseSuccess()
+
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+    it('should fail', async () => {
+      const data = {
+        endpoint: 'uranium',
+      }
+      mockUraniumResponseFailure()
+
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(502)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
 })
diff --git a/packages/sources/the-network-firm/test/integration/fixtures.ts b/packages/sources/the-network-firm/test/integration/fixtures.ts
diff --git a/packages/sources/the-network-firm/test/integration/ripcord.test.ts b/packages/sources/the-network-firm/test/integration/ripcord.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@chainlink/the-network-firm-adapter': minor
 +---
++
 +Add uranium endpoint