Add virtune-token endpoint to por-address-list (#3996)

* Add virtune-token endpoint to por-address-list

* virtune-token test changes

* Copy integration test

* Changes to integration test

Author: dskloetc

.changeset/famous-yaks-smoke.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/por-address-list-adapter': minor
+---
+
+Add virtune-token endpoint compatible with token-balance

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

@@ -5,4 +5,5 @@ 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 virtuneToken } from './virtune-token'
 export { endpoint as zeusBtcAddress } from './zeusBTC'

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

@@ -0,0 +1,59 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { PoRTokenAddress } from '@chainlink/external-adapter-framework/adapter/por'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { virtuneTokenTransport } from '../transport/virtune-token'
+
+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,
+    },
+    contractAddress: {
+      description: 'The contract address of the token, to pass be included in the response',
+      type: 'string',
+      default: '',
+    },
+  },
+  [
+    {
+      accountId: 'VIRBTC',
+      network: 'ethereum',
+      chainId: '1',
+      contractAddress: '0x514910771af9ca656af840dff83e8264ecf986ca',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Result: null
+    Data: {
+      result: PoRTokenAddress[]
+    }
+  }
+  Settings: typeof config.settings
+}
+
+// This endpoint is similar to the virtune endpoint but returns a response in a
+// format that proof-of-reserves can pass on to token-balance.
+export const endpoint = new AdapterEndpoint({
+  name: 'virtune-token',
+  transport: virtuneTokenTransport,
+  inputParameters,
+})

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

@@ -44,6 +44,9 @@ export type BaseEndpointTypes = {
   Settings: typeof config.settings
 }
 
+// This endpoint is similar to the virtune-token endpoint but returns a
+// response in a format that proof-of-reserves can pass on to por-indexer or
+// ethereum-cl-indexer.
 export const endpoint = new AdapterEndpoint({
   name: 'virtune',
   transport: virtuneTransport,

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

@@ -9,6 +9,7 @@ import {
   openedenAddress,
   solvBTC,
   virtune,
+  virtuneToken,
   zeusBtcAddress,
 } from './endpoint'
 
@@ -24,6 +25,7 @@ export const adapter = new PoRAdapter({
     multichainAddress,
     openedenAddress,
     virtune,
+    virtuneToken,
     zeusBtcAddress,
   ],
   rateLimiting: {

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

@@ -0,0 +1,53 @@
+import { PoRTokenAddress } from '@chainlink/external-adapter-framework/adapter/por'
+import {
+  HttpTransport,
+  HttpTransportConfig,
+} from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/virtune-token'
+import { createVirtuneTransportConfig, ResponseSchema, VirtuneParams } from './virtune-utils'
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+type Params = VirtuneParams<HttpTransportTypes>
+
+const getUrl = (params: Params): string => {
+  return params.accountId
+}
+
+const getAddresses = ({
+  data,
+  params,
+}: {
+  data: ResponseSchema
+  params: Params
+}): PoRTokenAddress[] => {
+  const { network, chainId, contractAddress } = params
+  const wallets = data.result.flatMap((r) => r.wallets.map((w) => w.address))
+  if (wallets.length === 0) {
+    return []
+  }
+  return [
+    {
+      chainId,
+      network,
+      contractAddress,
+      wallets,
+    },
+  ]
+}
+
+const transportConfig: HttpTransportConfig<HttpTransportTypes> =
+  createVirtuneTransportConfig<HttpTransportTypes>(getUrl, getAddresses)
+
+// Exported for testing
+export class VirtuneTokenTransport extends HttpTransport<HttpTransportTypes> {
+  constructor() {
+    super(transportConfig)
+  }
+}
+
+export const virtuneTokenTransport = new VirtuneTokenTransport()

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

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

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

@@ -0,0 +1,56 @@
+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-token',
+        accountId: 'VIRBTC',
+        network: 'bitcoin',
+        chainId: 'mainnet',
+        contractAddress: '0x514910771af9ca656af840dff83e8264ecf986ca',
+      }
+
+      mockVirtuneResponseSuccess()
+
+      const response = await testAdapter.request(data)
+
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
+})