Support Virtune API in por-address-list (#3990)

* Copy transport/zeusBTC.ts

* Support Virtune API in por-address-list

* changeset

* lint

Author: dskloetc

.changeset/cold-apricots-rush.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/por-address-list-adapter': minor
+---
+
+Support Virtune API to get addresses

packages/sources/por-address-list/src/config/index.ts

@@ -69,4 +69,15 @@ export const config = new AdapterConfig({
     type: 'string',
     default: 'https://indexer.zeuslayer.io/api/v2/chainlink/proof-of-reserves',
   },
+  VIRTUNE_API_URL: {
+    description: 'An API endpoint for Virtune address lists',
+    type: 'string',
+    default:
+      'https://proof-of-reserves-chainlink-283003lt.nw.gateway.dev/api/external/proof-of-reserves',
+  },
+  VIRTUNE_API_KEY: {
+    description: 'The API key for Virtune address list API',
+    type: 'string',
+    default: '',
+  },
 })

packages/sources/por-address-list/src/endpoint/index.ts

@@ -1,7 +1,8 @@
 export { endpoint as address } from './address'
-export { endpoint as solvBTC } from './solvBTC'
 export { endpoint as bedrockBTC } from './bedrockBTC'
 export { endpoint as coinbaseBTC } from './coinbaseCBBTC'
 export { endpoint as multichainAddress } from './multichainAddress'
 export { endpoint as openedenAddress } from './openEdenUSDOAddress'
+export { endpoint as solvBTC } from './solvBTC'
+export { endpoint as virtune } from './virtune'
 export { endpoint as zeusBtcAddress } from './zeusBTC'

packages/sources/por-address-list/src/endpoint/virtune.ts

@@ -0,0 +1,51 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { PoRAddress } from '@chainlink/external-adapter-framework/adapter/por'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { virtuneTransport } from '../transport/virtune'
+
+export const inputParameters = new InputParameters(
+  {
+    accountId: {
+      description: 'The account ID to fetch addresses for',
+      type: 'string',
+      required: true,
+    },
+    network: {
+      description:
+        'The network the addresses are on. This is only used to include in the response.',
+      type: 'string',
+      required: true,
+    },
+    chainId: {
+      description:
+        'The chainId of the network the addresses are on. This is only used to include in the response.',
+      type: 'string',
+      required: true,
+    },
+  },
+  [
+    {
+      accountId: 'VIRBTC',
+      network: 'bitcoin',
+      chainId: 'mainnet',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Result: null
+    Data: {
+      result: PoRAddress[]
+    }
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'virtune',
+  transport: virtuneTransport,
+  inputParameters,
+})

packages/sources/por-address-list/src/index.ts

@@ -3,11 +3,12 @@ import { PoRAdapter } from '@chainlink/external-adapter-framework/adapter/por'
 import { config } from './config'
 import {
   address,
-  solvBTC,
   bedrockBTC,
   coinbaseBTC,
   multichainAddress,
   openedenAddress,
+  solvBTC,
+  virtune,
   zeusBtcAddress,
 } from './endpoint'
 
@@ -22,6 +23,7 @@ export const adapter = new PoRAdapter({
     coinbaseBTC,
     multichainAddress,
     openedenAddress,
+    virtune,
     zeusBtcAddress,
   ],
   rateLimiting: {

packages/sources/por-address-list/src/transport/virtune.ts

@@ -0,0 +1,116 @@
+import {
+  HttpTransport,
+  HttpTransportConfig,
+} from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/virtune'
+
+interface ResponseSchema {
+  accountName: string
+  result: {
+    symbol: string
+    totalBalance: string
+    totalBalanceUsd: string
+    wallets: {
+      address: string
+      symbol: string
+      custody: string
+      name: string
+      isStakingWallet: boolean
+    }[]
+  }[]
+  count: number
+  lastUpdatedAt: string
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+const getAddresses = ({
+  data,
+  network,
+  chainId,
+}: {
+  data: ResponseSchema
+  network: string
+  chainId: string
+}) => {
+  return data.result.flatMap((r) =>
+    r.wallets.map((wallet) => ({
+      address: wallet.address,
+      network,
+      chainId,
+    })),
+  )
+}
+
+const transportConfig: HttpTransportConfig<HttpTransportTypes> = {
+  prepareRequests: (params, config) => {
+    return params.map((param) => ({
+      params: [param],
+      request: {
+        baseURL: config.VIRTUNE_API_URL,
+        url: param.accountId,
+        params: {
+          key: config.VIRTUNE_API_KEY,
+        },
+      },
+    }))
+  },
+  parseResponse: (params, response) => {
+    const [param] = params
+    if (!response.data) {
+      return [
+        {
+          params: param,
+          response: {
+            errorMessage: `The data provider didn't return any data for virtune`,
+            statusCode: 502,
+          },
+        },
+      ]
+    }
+
+    const addresses = getAddresses({
+      data: response.data,
+      network: param.network,
+      chainId: param.chainId,
+    })
+
+    if (addresses.length == 0) {
+      return [
+        {
+          params: param,
+          response: {
+            errorMessage: `The data provider didn't return any address for virtune`,
+            statusCode: 502,
+          },
+        },
+      ]
+    }
+
+    return [
+      {
+        params: param,
+        response: {
+          result: null,
+          data: {
+            result: addresses,
+          },
+        },
+      },
+    ]
+  },
+}
+
+// Exported for testing
+export class VirtuneTransport extends HttpTransport<HttpTransportTypes> {
+  constructor() {
+    super(transportConfig)
+  }
+}
+
+export const virtuneTransport = new VirtuneTransport()

packages/sources/por-address-list/test/integration/__snapshots__/adapter-virtune.test.ts.snap

@@ -0,0 +1,26 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`execute virtune should return success 1`] = `
+{
+  "data": {
+    "result": [
+      {
+        "address": "1JSYkxvBJy4wXDskdXfadfTj6Hg9n5r3br",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+      {
+        "address": "17ABiL5ToFwYdjGtVngEXo2Bw4EKN5myTT",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+    ],
+  },
+  "result": null,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;

packages/sources/por-address-list/test/integration/adapter-virtune.test.ts

@@ -0,0 +1,55 @@
+import {
+  TestAdapter,
+  setEnvVariables,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import nock from 'nock'
+import { mockVirtuneResponseSuccess } from './fixtures-api'
+
+describe('execute', () => {
+  let spy: jest.SpyInstance
+  let testAdapter: TestAdapter
+  let oldEnv: NodeJS.ProcessEnv
+
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+    process.env.RPC_URL = process.env.RPC_URL ?? 'http://localhost:8080'
+    process.env.VIRTUNE_API_URL = 'http://virtune'
+    process.env.VIRTUNE_API_KEY = 'virtuneApiKey'
+    process.env.BACKGROUND_EXECUTE_MS = '0'
+
+    const mockDate = new Date('2001-01-01T11:11:11.111Z')
+    spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
+
+    const adapter = (await import('./../../src')).adapter
+    adapter.rateLimiting = undefined
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      testAdapter: {} as TestAdapter<never>,
+    })
+  })
+
+  afterAll(async () => {
+    setEnvVariables(oldEnv)
+    await testAdapter.api.close()
+    nock.restore()
+    nock.cleanAll()
+    spy.mockRestore()
+  })
+
+  describe('virtune', () => {
+    it('should return success', async () => {
+      const data = {
+        endpoint: 'virtune',
+        accountId: 'VIRBTC',
+        network: 'bitcoin',
+        chainId: 'mainnet',
+      }
+
+      mockVirtuneResponseSuccess()
+
+      const response = await testAdapter.request(data)
+
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
+})

packages/sources/por-address-list/test/integration/fixtures-api.ts

@@ -393,3 +393,51 @@ export const mockBaseContractCallResponseSuccess = (): nock.Scope =>
         }
       }
     })
+
+export const mockVirtuneResponseSuccess = (): nock.Scope =>
+  nock('http://virtune', {
+    encodedQueryParams: true,
+  })
+    .get('/VIRBTC?key=virtuneApiKey')
+    .reply(
+      200,
+      () => ({
+        accountName: 'Virtune Bitcoin ETP',
+        result: [
+          {
+            symbol: 'BTC',
+            totalBalance: '123.45678990',
+            totalBalanceUsd: '14567890.12',
+            wallets: [
+              {
+                address: '1JSYkxvBJy4wXDskdXfadfTj6Hg9n5r3br',
+                symbol: 'BTC',
+                custody: 'coinbase',
+                name: 'Collateral',
+                isStakingWallet: false,
+              },
+              {
+                address: '17ABiL5ToFwYdjGtVngEXo2Bw4EKN5myTT',
+                symbol: 'BTC',
+                custody: 'coinbase',
+                name: 'Trading',
+                isStakingWallet: false,
+              },
+            ],
+          },
+        ],
+        count: 2,
+        lastUpdatedAt: '2025-09-03T07:01:44.562+00:00',
+      }),
+      [
+        'Content-Type',
+        'application/json',
+        'Connection',
+        'close',
+        'Vary',
+        'Accept-Encoding',
+        'Vary',
+        'Origin',
+      ],
+    )
+    .persist()