Add optional address filter parameter to virtune endpoints of por-address-list (#4045)

Author: dskloetc

.changeset/few-maps-cover.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/por-address-list-adapter': minor
+---
+
+Add optional address filter parameter to virtune endpoints

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

@@ -21,6 +21,11 @@ export const sharedVirtuneInputParameters = {
     type: 'string',
     required: true,
   },
+  addressPattern: {
+    description: 'Return only addresses matching the given regular expression pattern.',
+    type: 'string',
+    required: false,
+  },
 } as const
 
 export const inputParameters = new InputParameters(
@@ -32,6 +37,7 @@ export const inputParameters = new InputParameters(
       accountId: 'VIRBTC',
       network: 'bitcoin',
       chainId: 'mainnet',
+      addressPattern: '^(?!P-)', // Only addresses that don't start with 'P-'.
     },
   ],
 )

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

@@ -6,6 +6,7 @@ import {
 import { BaseEndpointTypes } from '../endpoint/virtune-token'
 import {
   createVirtuneTransportConfig,
+  filterAddresses,
   getUrl,
   ResponseSchema,
   VirtuneParams,
@@ -42,7 +43,7 @@ const getResultFromAddresses = ({
 }
 
 const transportConfig: HttpTransportConfig<HttpTransportTypes> =
-  createVirtuneTransportConfig<HttpTransportTypes>(getUrl, getResultFromAddresses)
+  createVirtuneTransportConfig<HttpTransportTypes>(getUrl, filterAddresses, getResultFromAddresses)
 
 // Exported for testing
 export class VirtuneTokenTransport extends HttpTransport<HttpTransportTypes> {

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

@@ -7,6 +7,19 @@ export const getUrl = (params: { accountId: string }): string => {
   return params.accountId
 }
 
+export const filterAddresses = ({
+  addresses,
+  params,
+}: {
+  addresses: string[]
+  params: { addressPattern?: string }
+}): string[] => {
+  const { addressPattern } = params
+  if (!addressPattern) return addresses
+  const re = new RegExp(addressPattern)
+  return addresses.filter((address) => re.test(address))
+}
+
 export interface ResponseSchema {
   accountName: string
   result: {
@@ -43,6 +56,16 @@ export const createVirtuneTransportConfig = <T extends VirtuneTransportGenerics>
   // because the compiler doesn't know getUrl satisfies the type until T
   // is instantiated.
   getUrlFromParams: (params: VirtuneParams<T>) => string,
+  // filterAddresses is always assigned to the exported filterAddresses.
+  // It's only a parameter because the compiler doesn't know
+  // filterAddresses satisfies the type until T is instantiated.
+  filterAddresses: ({
+    addresses,
+    params,
+  }: {
+    addresses: string[]
+    params: VirtuneParams<T>
+  }) => string[],
   getResultFromAddresses: (_: {
     params: VirtuneParams<T>
     addresses: string[]
@@ -88,8 +111,10 @@ export const createVirtuneTransportConfig = <T extends VirtuneTransportGenerics>
       ]
     }
 
+    const filteredAddresses = filterAddresses({ addresses, params: param })
+
     const result = getResultFromAddresses({
-      addresses,
+      addresses: filteredAddresses,
       params: param,
     })
 

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

@@ -6,6 +6,7 @@ import {
 import { BaseEndpointTypes } from '../endpoint/virtune'
 import {
   createVirtuneTransportConfig,
+  filterAddresses,
   getUrl,
   ResponseSchema,
   VirtuneParams,
@@ -36,7 +37,7 @@ const getResultFromAddresses = ({
 }
 
 const transportConfig: HttpTransportConfig<HttpTransportTypes> =
-  createVirtuneTransportConfig<HttpTransportTypes>(getUrl, getResultFromAddresses)
+  createVirtuneTransportConfig<HttpTransportTypes>(getUrl, filterAddresses, getResultFromAddresses)
 
 // Exported for testing
 export class VirtuneTransport extends HttpTransport<HttpTransportTypes> {

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

@@ -136,6 +136,67 @@ describe('VirtuneTokenTransport', () => {
     expect(responseCache.write).toHaveBeenCalledTimes(1)
   }
 
+  it('should filter based on address pattern', async () => {
+    const accountId = 'VIRBTC'
+    const network = 'bitcoin'
+    const chainId = 'mainnet'
+    const contractAddress = '0x514910771af9ca656af840dff83e8264ecf986ca'
+    const address1 = 'x-addr1'
+    const address2 = 'y-addr2'
+
+    const params = makeStub('params', {
+      accountId,
+      network,
+      chainId,
+      contractAddress,
+      addressPattern: '^y-',
+    })
+
+    const expectedRequestConfig = {
+      baseURL: adapterSettings.VIRTUNE_API_URL,
+      params: {
+        key: virtuneApiKey,
+      },
+      url: accountId,
+    }
+
+    const response = makeStub('response', {
+      response: {
+        data: {
+          result: [
+            {
+              wallets: [{ address: address1 }, { address: address2 }],
+            },
+          ],
+          cost: undefined,
+        },
+      },
+      timestamps: {},
+    })
+
+    const expectedResponse = {
+      data: {
+        result: [
+          {
+            network,
+            chainId,
+            contractAddress,
+            wallets: [address2],
+          },
+        ],
+      },
+      result: null,
+      timestamps: {},
+    }
+
+    await testTransport({
+      params,
+      expectedRequestConfig,
+      response,
+      expectedResponse,
+    })
+  })
+
   it('should cache a response for a successful request', async () => {
     const accountId = 'VIRBTC'
     const network = 'bitcoin'
@@ -149,6 +210,7 @@ describe('VirtuneTokenTransport', () => {
       network,
       chainId,
       contractAddress,
+      addressPattern: undefined,
     })
 
     const expectedRequestConfig = {

packages/sources/por-address-list/test/unit/virtune.test.ts

@@ -147,6 +147,7 @@ describe('VirtuneTransport', () => {
       accountId,
       network,
       chainId,
+      addressPattern: undefined,
     })
 
     const expectedRequestConfig = {
@@ -190,6 +191,58 @@ describe('VirtuneTransport', () => {
     })
   })
 
+  it('should filter based on address pattern', async () => {
+    const accountId = 'VIRBTC'
+    const network = 'bitcoin'
+    const chainId = 'mainnet'
+    const address1 = 'x-addr1'
+    const address2 = 'y-addr2'
+
+    const params = makeStub('params', {
+      accountId,
+      network,
+      chainId,
+      addressPattern: '^y-',
+    })
+
+    const expectedRequestConfig = {
+      baseURL: adapterSettings.VIRTUNE_API_URL,
+      params: {
+        key: virtuneApiKey,
+      },
+      url: accountId,
+    }
+
+    const response = makeStub('response', {
+      response: {
+        data: {
+          result: [
+            {
+              wallets: [{ address: address1 }, { address: address2 }],
+            },
+          ],
+          cost: undefined,
+        },
+      },
+      timestamps: {},
+    })
+
+    const expectedResponse = {
+      data: {
+        result: [{ address: address2, network, chainId }],
+      },
+      result: null,
+      timestamps: {},
+    }
+
+    await testTransport({
+      params,
+      expectedRequestConfig,
+      response,
+      expectedResponse,
+    })
+  })
+
   it('should cache an error if the response has no data', async () => {
     const accountId = 'VIRBTC'
     const network = 'bitcoin'