add validation for cardano testnet, avalanche and beacon addresses (#3021)

Author: karen-stepanyan

.changeset/green-melons-rush.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/proof-of-reserves-adapter': patch
+---
+
+Add validation for cardano testnet, avalanche and ETH beacon addresses

packages/composites/proof-of-reserves/src/utils/addressValidator.ts

@@ -12,6 +12,8 @@ type AddressObject = {
 const indexerToNetwork: Record<string, string> = {
   ada_balance: 'cardano',
   eth_balance: 'ethereum',
+  eth_beacon: 'beacon',
+  avalanche_platform: 'avalanche',
   bitcoin_json_rpc: 'bitcoin',
   lotus: 'filecoin',
 }
@@ -44,9 +46,12 @@ export const validateAddresses = (
 ): AddressObject[] => {
   const validatedAddresses: AddressObject[] = []
   for (const addressObj of addresses) {
-    const { address, network } = addressObj
+    const { address, network, chainId } = addressObj
     let validatedAddress: string | undefined = undefined
-    const validationNetwork = network || indexerToNetwork[indexer]
+    let validationNetwork = network || indexerToNetwork[indexer]
+    // If the indexer is eth_beacon, override the validationNetwork as it might contain a different value (goerli, ethereum, mainnet...)
+    validationNetwork = indexer === 'eth_beacon' ? 'beacon' : validationNetwork
+
     switch (validationNetwork.toLowerCase()) {
       case 'ethereum':
         validatedAddress = getValidEvmAddress(id, address)
@@ -58,11 +63,18 @@ export const validateAddresses = (
         validatedAddress = getValidDogeAddress(id, address)
         break
       case 'cardano':
-        validatedAddress = getValidCardanoAddress(id, address)
+        validatedAddress = getValidCardanoAddress(id, address, chainId)
         break
       case 'filecoin':
         validatedAddress = getValidFilecoinAddress(id, address)
         break
+      case 'beacon':
+        validatedAddress = getValidBeaconValidatorAddress(id, address)
+        break
+      case 'avalanche':
+      case 'avalanche-fuji':
+        validatedAddress = getValidAvalancheAddress(id, address)
+        break
       default:
         Logger.debug(
           `JobId ${id}: There is no address validation procedure defined for the "${network}" network.`,
@@ -138,13 +150,32 @@ const getValidDogeAddress = (id: string, address: string): string | undefined =>
   return
 }
 
-const getValidCardanoAddress = (id: string, address: string): string | undefined => {
-  if (address.slice(0, 4).toLowerCase() === 'addr' && isBech32(address.slice(5).toLowerCase()))
+const getValidCardanoAddress = (
+  id: string,
+  address: string,
+  chain = 'mainnet',
+): string | undefined => {
+  if (chain === 'mainnet') {
+    // Validation for 'shelley' addresses
+    if (address.slice(0, 4).toLowerCase() === 'addr' && isBech32(address.slice(5).toLowerCase())) {
+      return address.toLowerCase()
+    }
+    // Validation for legacy 'byron' addresses
+    if (isBase58(address)) {
+      return address
+    }
+  }
+  // Validation for testnet addresses
+  else if (
+    chain === 'testnet' &&
+    address.slice(0, 10).toLowerCase() === 'addr_test1' &&
+    isBech32(address.slice(10).toLowerCase())
+  ) {
     return address.toLowerCase()
-  if (isBase58(address)) return address
+  }
   Logger.warn(
     { warning: 'Invalid address detected' },
-    `JobId ${id}: The address "${address}" is not a valid Dogecoin address and has been removed.`,
+    `JobId ${id}: The address "${address}" is not a valid Cardano ${chain} address and has been removed.`,
   )
   return
 }
@@ -170,6 +201,53 @@ const getValidFilecoinAddress = (id: string, address: string): string | undefine
   return
 }
 
+const getValidAvalancheAddress = (id: string, address: string): string | undefined => {
+  if (address.substring(0, 2) === '0x') {
+    // Validation for C-chain address
+    return getValidEvmAddress(id, address)
+  }
+
+  // Validation for P nd X chain addresses
+  if (!address.startsWith('X-') && !address.startsWith('P-')) {
+    Logger.warn(
+      { warning: 'Invalid address detected' },
+      `JobId ${id}: The address "${address}" is not a valid Avalanche address and has been removed.`,
+    )
+    return
+  }
+
+  const addressKey = address.substring(2)
+  const addressParts = addressKey.split('1')
+  const [, bech32Part] = [addressParts.shift() as string, addressParts.join('1')]
+  if (!bech32Part.length || !isBech32(bech32Part.toLowerCase())) {
+    Logger.warn(
+      { warning: 'Invalid address detected' },
+      `JobId ${id}: The address "${address}" is not a valid Avalanche address and has been removed.`,
+    )
+    return
+  }
+
+  return address
+}
+
+const getValidBeaconValidatorAddress = (id: string, address: string): string | undefined => {
+  try {
+    const parsedKey = utils.hexlify(address)
+    // Validator address is 48 bytes + '0x' prefix
+    if (parsedKey === '0x'.padEnd(98, '0') || !utils.isHexString(parsedKey, 48)) {
+      throw 'Invalid Address'
+    }
+  } catch (e) {
+    Logger.warn(
+      { warning: 'Invalid address detected' },
+      `JobId ${id}: The address "${address}" is not a valid Beacon validator address and has been removed.`,
+    )
+    return
+  }
+
+  return address
+}
+
 export const filterDuplicates = (id: string, addresses: AddressObject[]): AddressObject[] => {
   const uniqueMap: Record<string, boolean> = {}
   const uniqueAddresses: AddressObject[] = []

packages/composites/proof-of-reserves/test/unit/addressValidator.test.ts

@@ -196,6 +196,35 @@ describe('Validates Cardano addresses', () => {
     ]
     expect(validateAddresses('1', 'cardano', invalidBech32Address)).toEqual([])
   })
+
+  it('Validates testnet addresses', () => {
+    const validTestnetAddress = [
+      {
+        address:
+          'addr_test1qz87tn9yat3xfutzds43tnj8qw457hk3v46w4028rtnx56v89wjwnrwcvlfm2atvcnnclh3x7thwrl7pgnffaw24mgws0dga4m',
+        network: 'cardano',
+        chainId: 'testnet',
+      },
+      {
+        address:
+          'addr_test1qqr585tvlc7ylnqvz8pyqwauzrdu0mxag3m7q56grgmgu7sxu2hyfhlkwuxupa9d5085eunq2qywy7hvmvej456flknswgndm3',
+        network: 'cardano',
+        chainId: 'testnet',
+      },
+    ]
+    expect(validateAddresses('1', 'ada_balance', validTestnetAddress)).toEqual(validTestnetAddress)
+  })
+
+  it('Does not validate invalid testnet addresses', () => {
+    const invalidTestnetAddress = [
+      {
+        address: 'addr_test1vpu5Olrf4xkxv2qpwngf6cjhtw542ayty80v8dyr49rf5eg0yu80w',
+        network: 'cardano',
+        chainId: 'testnet',
+      },
+    ]
+    expect(validateAddresses('1', 'ada_balance', invalidTestnetAddress)).toEqual([])
+  })
 })
 
 describe('Validates Dogecoin addresses', () => {
@@ -278,3 +307,95 @@ describe('Validates Filecoin addresses', () => {
     expect(validateAddresses('1', 'filecoin', invalidAddresses)).toEqual([])
   })
 })
+
+describe('Validates Beacon validator addresses', () => {
+  it('Validates valid address', () => {
+    const validAddresses = [
+      {
+        address:
+          '0x89c1fa47be0aff073afe98720d9524534bd7cd6fdaf065e205cd290766c044eb0c39a5ed7977f7e7f3747ba550e0b0e4',
+        network: 'mainnet',
+        chainId: '1',
+      },
+      {
+        address:
+          '0x8000909f19cc28cd4335da3fe5dd3d84049259217d236a466885877cae255a3d30021aa25b50038ccf377b3e2e538284',
+        network: 'mainnet',
+        chainId: '1',
+      },
+      {
+        address:
+          '0x8000553d719a1b09006c80da3d6efb8227f5184512e89096e56f3b7ee6d29c45e44227415be00cfda05c0b3c85fe3048',
+        network: 'mainnet',
+        chainId: '1',
+      },
+    ]
+    expect(validateAddresses('1', 'eth_beacon', validAddresses)).toEqual(validAddresses)
+  })
+
+  it('Does not validate invalid address', () => {
+    const invalidAddresses = [
+      {
+        address:
+          '0x89c1fa47be0aff073afe98720d9524534bd7cd6fdaf065e20544eb0c39a5ed7977f7e7f3747ba550e0b0e4',
+        network: 'mainnet',
+        chainId: '1',
+      },
+      {
+        address: '1abjxfbp274xpdqcpuaykwkfb43omjotacm2p3za',
+        network: 'mainnet',
+        chainId: '1',
+      },
+    ]
+    expect(validateAddresses('1', 'eth_beacon', invalidAddresses)).toEqual([])
+  })
+})
+
+describe('Validates Avalanche addresses', () => {
+  it('Validates valid address', () => {
+    const validAddresses = [
+      {
+        address: 'P-avax1k9z2fnqu2nwvy23lf3ztgku6jdp22u6etv4ewc',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+      {
+        address: '0x74170Ba6590254c52d7786d3F590316c5BDE66a5',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+      {
+        address: 'X-avax1k9z2fnqu2nwvy23lf3ztgku6jdp22u6etv4ewc',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+      {
+        address: 'P-fuji1vd9sddlllrlk9fvj9lhntpw8t00lmvtnqkl2jt',
+        network: 'avalanche-fuji',
+        chainId: '43113',
+      },
+    ]
+    expect(validateAddresses('1', 'avalanche_platform', validAddresses)).toEqual(validAddresses)
+  })
+
+  it('Does not validate invalid address', () => {
+    const invalidAddresses = [
+      {
+        address: 'P-avax1k9z2fn1u2nwvy23lf3ztgku6jdp22u6etv4ewc',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+      {
+        address: '0x74170Ba6590254c52d73422786d3F590316c5BDE66a5',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+      {
+        address: 'Xdsfsavax1k9z2fnqu2nwvy23lf3ztgku6jdp22u6etv4ewc',
+        network: 'avalanche',
+        chainId: '43114',
+      },
+    ]
+    expect(validateAddresses('1', 'avalanche_platform', invalidAddresses)).toEqual([])
+  })
+})