Feat/DF-20745 proof of reserves token balance

.changeset/swift-forks-learn.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/proof-of-reserves-adapter': minor
+---
+
+Added token-balance indexer

packages/composites/proof-of-reserves/README.md

@@ -47,6 +47,7 @@ At least one of each of the following categories must be set as an environment v
    |           |    `POR_INDEXER_ADAPTER_URL`     | The location of a Proof-of-Reserves Indexer external adapter |         |             |
    |           |      `SOCHAIN_ADAPTER_URL`       |          The location of a SoChain external adapter          |         |             |
    |           |   `STADER_BALANCE_ADAPTER_URL`   |      The location of a Stader Balance external adapter       |         |             |
+   |           |   `TOKEN_BALANCE_ADAPTER_URL`    |       The location of a Token Balance external adapter       |         |             |
 
 ## Running
 
@@ -58,7 +59,7 @@ See the [Composite Adapter README](../README.md) for more information on how to
 | :-------: | :--------------------------------: | :--------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------: |
 |    ✅     |             `protocol`             |                                 The protocol external adapter to use                                 | `celsius_address_list`, `chain_reserve_wallet`, `coinbase_prime`, `coinbase_prime_eth` `gemini`,`moonbeam_address_list`, `multi_address_list`, `ignition_address_list`, `list`, `por_address_list`, `renvm`, `stader_address_list`, `swell_address_list`, `wbtc`, `wrapped` |             |
 |           |         `protocolEndpoint`         |                      Optional endpoint for the protocol external adapter to use                      |                                                                                                                                                                                                                                                                             |             |
-|    ✅     |             `indexer`              |                                 The indexer external adapter to use                                  |             `ada_balance`, `amberdata`, `avalanche_platform`, `bitcoin_json_rpc`, `blockchain_com`. `blockchair`, `blockcypher`, `btc_com`, `cryptoapis`, `eth_balance`, `eth_beacon`, `lotus`, `polkadot_balance`, `por_indexer`, `sochain`, `stader_balance`              |             |
+|    ✅     |             `indexer`              |                                 The indexer external adapter to use                                  |     `ada_balance`, `amberdata`, `avalanche_platform`, `bitcoin_json_rpc`, `blockchain_com`. `blockchair`, `blockcypher`, `btc_com`, `cryptoapis`, `eth_balance`, `eth_beacon`, `lotus`, `polkadot_balance`, `por_indexer`, `sochain`, `stader_balance`, `token_balance`     |             |
 |           |          `confirmations`           | The number of confirmations required for a transaction to be counted when getting an address balance |                                                                                                                                                                                                                                                                             |      6      |
 |           |            `addresses`             |           An array of addresses to get the balance from, when "protocol" is set to `list`            |                                                                                                                                                                                                                                                                             |             |
 |           |     `disableAddressValidation`     |               if this parameter is set to `true` address validation will be turned off               |                                                                                                                               `true`, `false`                                                                                                                               |   `false`   |

packages/composites/proof-of-reserves/package.json

@@ -61,6 +61,7 @@
     "@chainlink/stader-address-list-adapter": "workspace:*",
     "@chainlink/stader-balance-adapter": "workspace:*",
     "@chainlink/swell-address-list-adapter": "workspace:*",
+    "@chainlink/token-balance-adapter": "workspace:*",
     "@chainlink/wbtc-address-set-adapter": "workspace:*",
     "@chainlink/wrapped-adapter": "workspace:*",
     "decimal.js": "^10.3.1",

packages/composites/proof-of-reserves/schemas/env.json

@@ -95,6 +95,9 @@
         },
         {
           "required": ["POR_INDEXER_ADAPTER_URL"]
+        },
+        {
+          "required": ["TOKEN_BALANCE_ADAPTER_URL"]
         }
       ]
     }

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

@@ -7,6 +7,7 @@ type AddressObject = {
   address: string
   network?: string
   chainId?: string
+  wallets?: string[]
 }
 
 const indexerToNetwork: Record<string, string> = {
@@ -16,6 +17,7 @@ const indexerToNetwork: Record<string, string> = {
   avalanche_platform: 'avalanche',
   bitcoin_json_rpc: 'bitcoin',
   lotus: 'filecoin',
+  token_balance: 'multi-evm',
 }
 
 export const getValidAddresses = (
@@ -46,7 +48,7 @@ export const validateAddresses = (
 ): AddressObject[] => {
   const validatedAddresses: AddressObject[] = []
   for (const addressObj of addresses) {
-    const { address, network, chainId } = addressObj
+    const { address, network, chainId, wallets } = addressObj
     let validatedAddress: string | undefined = undefined
     let validationNetwork = network || indexerToNetwork[indexer]
     // If the indexer is eth_beacon, override the validationNetwork as it might contain a different value (goerli, ethereum, mainnet...)
@@ -75,6 +77,15 @@ export const validateAddresses = (
       case 'avalanche-fuji':
         validatedAddress = getValidAvalancheAddress(id, address)
         break
+      case 'multi-evm':
+        if (wallets && wallets.length) {
+          const validWallets = wallets
+            .map((wallet) => getValidEvmAddress(id, wallet))
+            .filter(Boolean) as string[]
+          addressObj.wallets = validWallets
+          validatedAddresses.push(addressObj)
+        }
+        break
       default:
         Logger.debug(
           `JobId ${id}: There is no address validation procedure defined for the "${network}" network.`,

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

@@ -25,6 +25,7 @@
 import { adapter as ethBeacon } from '@chainlink/eth-beacon-adapter'
 import { adapter as lotus } from '@chainlink/lotus-adapter'
 import { adapter as porIndexer } from '@chainlink/por-indexer-adapter'
+import { adapter as tokenBalance } from '@chainlink/token-balance-adapter'
 
 // TODO: type
 export const adaptersV2: v2AdapterImplementation[] = [
@@ -47,6 +48,7 @@
   avalanchePlatform,
   lotus,
   porIndexer,
+  tokenBalance,
 ]
 
 // Get balances for address set
@@ -66,6 +68,9 @@
     case porIndexer.name:
       next = buildPorIndexerRequest(input, confirmations)
       break
+    case tokenBalance.name:
+      next = buildTokenBalanceRequest(input, confirmations)
+      break
     case ethBeacon.name:
       next = {
         id: input.jobRunID,
@@ -135,3 +140,14 @@
     },
   }
 }
+
+function buildTokenBalanceRequest(input: AdapterResponse, minConfirmations: number) {
+  return {
+    id: input.jobRunID,
+    data: {
+      endpoint: 'evm',
+      addresses: input.data.result,
+      minConfirmations,
+    },
+  }
+}

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

@@ -5,6 +5,7 @@
 import { adapter as bitcoinPorIndexer } from '@chainlink/por-indexer-adapter'
 import * as adaBalance from '@chainlink/ada-balance-adapter'
 import { adapter as lotus } from '@chainlink/lotus-adapter'
+import { adapter as tokenBalance } from '@chainlink/token-balance-adapter'
 import { ethers } from 'ethers'
 
 const returnParsedUnits = (jobRunID: string, result: string, units: number) => {
@@ -35,6 +36,7 @@
       return returnParsedUnits(input.jobRunID, input.data.result as string, 8)
     case lotus.name:
     case adaBalance.NAME:
+    case tokenBalance.name:
       // TODO: type makeExecute response
       return returnParsedUnits(input.jobRunID, input.data.result as string, 0)
   }

packages/composites/proof-of-reserves/test-payload.js

@@ -13,6 +13,7 @@ const indexerEnvironmentVariables = [
   { envKey: 'BTC_COM_ADAPTER_URL', value: 'btc_com' },
   { envKey: 'CRYPTOAPIS_ADAPTER_URL', value: 'cryptoapis' },
   { envKey: 'POR_INDEXER_ADAPTER_URL', value: 'por_indexer' },
+  { envKey: 'TOKEN_BALANCE_ADAPTER_URL', value: 'token_balance' },
   { envKey: 'SOCHAIN_ADAPTER_URL', value: 'sochain' },
 ]
 

packages/composites/proof-of-reserves/test/integration/adapter.test.ts

@@ -20,6 +20,7 @@ describe('execute', () => {
     CACHE_ENABLED: 'false',
     ETH_BALANCE_ADAPTER_URL: 'https://eth-balance-adapter.com',
     POR_INDEXER_ADAPTER_URL: 'https://por-indexer-adapter.com',
+    TOKEN_BALANCE_ADAPTER_URL: 'https://token-balance-adapter.com',
     GEMINI_ADAPTER_URL: 'https://gemini-adapter.com',
     LOTUS_ADAPTER_URL: 'https://lotus-adapter.com',
   }

yarn.lock

@@ -5133,6 +5133,7 @@ __metadata:
     "@chainlink/stader-address-list-adapter": "workspace:*"
     "@chainlink/stader-balance-adapter": "workspace:*"
     "@chainlink/swell-address-list-adapter": "workspace:*"
+    "@chainlink/token-balance-adapter": "workspace:*"
     "@chainlink/wbtc-address-set-adapter": "workspace:*"
     "@chainlink/wrapped-adapter": "workspace:*"
     "@types/jest": "npm:27.5.2"
@@ -5704,7 +5705,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@chainlink/token-balance-adapter@workspace:packages/sources/token-balance":
+"@chainlink/token-balance-adapter@workspace:*, @chainlink/token-balance-adapter@workspace:packages/sources/token-balance":
   version: 0.0.0-use.local
   resolution: "@chainlink/token-balance-adapter@workspace:packages/sources/token-balance"
   dependencies: