Coinbase cbBTC por address list (#3693)

* Coinbase cbBTC por address list

* changeset

* Test cases

* changeset

* add input params

* prettier

* update test case

* add chainID

* fix test

---------

Co-authored-by: mmcallister-cll <[email protected]>
Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>

Author: 3 people

.changeset/four-bees-battle.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/por-address-list-adapter': minor
+---
+
+Coinbase PoR

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

@@ -24,6 +24,11 @@ export const config = new AdapterConfig({
     type: 'number',
     default: 10_000,
   },
+  COINBASE_CBBTC_API_ENDPOINT: {
+    description: 'An API endpoint for Coinbase cbBTC native BTC wallet address',
+    type: 'string',
+    default: 'https://coinbase.com/cbbtc/proof-of-reserves.json',
+  },
   BEDROCK_UNIBTC_API_ENDPOINT: {
     description: 'An API endpoint for Bedrock uniBTC native BTC wallet address',
     type: 'string',

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

@@ -0,0 +1,43 @@
+import { PoRAddress } from '@chainlink/external-adapter-framework/adapter/por'
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { coinbaseHttpTransport } from '../transport/coinbaseBTC'
+
+export const inputParameters = new InputParameters(
+  {
+    network: {
+      description: 'The network name to associate with the addresses',
+      type: 'string',
+      required: true,
+    },
+    chainId: {
+      description: 'The chain ID to associate with the addresses',
+      type: 'string',
+      required: true,
+    },
+  },
+  [
+    {
+      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: 'coinbaseBtcAddress',
+  transport: coinbaseHttpTransport,
+  inputParameters,
+})

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

@@ -1,4 +1,5 @@
 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'

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

@@ -1,13 +1,13 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { PoRAdapter } from '@chainlink/external-adapter-framework/adapter/por'
 import { config } from './config'
-import { address, solvBTC, bedrockBTC, multichainAddress } from './endpoint'
+import { address, solvBTC, bedrockBTC, coinbaseBTC, multichainAddress } from './endpoint'
 
 export const adapter = new PoRAdapter({
   defaultEndpoint: address.name,
   name: 'POR_ADDRESS_LIST',
   config,
-  endpoints: [address, solvBTC, bedrockBTC, multichainAddress],
+  endpoints: [address, solvBTC, bedrockBTC, coinbaseBTC, multichainAddress],
   rateLimiting: {
     tiers: {
       default: {

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

@@ -0,0 +1,120 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { TypeFromDefinition } from '@chainlink/external-adapter-framework/validation/input-params'
+import { BaseEndpointTypes } from '../endpoint/coinbaseCBBTC'
+
+interface ResponseSchema {
+  schema: string
+  lastUpdatedAt: string
+  reservesTotal: {
+    amount: string
+    currency: {
+      name: string
+    }
+    network: {
+      name: string
+    }
+  }
+  reserveAddresses: {
+    address: string
+    balance: {
+      amount: string
+      currency: {
+        name: string
+      }
+      network: {
+        name: string
+      }
+    }
+  }[]
+  wrappedAssetsByNetwork: {
+    amount: string
+    currency: {
+      name: string
+      address: string
+    }
+    network: {
+      name: string
+      chainId: string
+    }
+  }[]
+  wrappedAssetsTotal: {
+    amount: string
+    currency: {
+      name: string
+    }
+  }
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+export const coinbaseHttpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      return {
+        params: [param],
+        request: {
+          baseURL: config.COINBASE_CBBTC_API_ENDPOINT,
+        },
+      }
+    })
+  },
+
+  parseResponse: (params, response) => {
+    if (!response.data) {
+      return [
+        {
+          params: params[0],
+          response: {
+            errorMessage: `The data provider didn't return any data for coinbaseBTC`,
+            statusCode: 502,
+          },
+        },
+      ]
+    }
+
+    const addresses = getAddresses(params[0].network, params[0].chainId, response.data)
+
+    if (addresses.length == 0) {
+      return [
+        {
+          params: params[0],
+          response: {
+            errorMessage: `The data provider didn't return any address for coinbaseBTC`,
+            statusCode: 502,
+          },
+        },
+      ]
+    }
+
+    return [
+      {
+        params: params[0],
+        response: {
+          result: null,
+          data: {
+            result: addresses,
+          },
+        },
+      },
+    ]
+  },
+})
+
+const getAddresses = (
+  network_name: TypeFromDefinition<BaseEndpointTypes['Parameters']>['network'],
+  chain_id: TypeFromDefinition<BaseEndpointTypes['Parameters']>['chainId'],
+  data: ResponseSchema,
+) => {
+  return data.reserveAddresses
+    .map((d) => ({
+      address: d.address,
+      network: network_name,
+      chainId: chain_id,
+    }))
+    .sort()
+}

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

@@ -139,6 +139,41 @@ exports[`execute apiAddress endpoint bedrock vault should return success 1`] = `
 }
 `;
 
+exports[`execute apiAddress endpoint coinbase BTC should return success 1`] = `
+{
+  "data": {
+    "result": [
+      {
+        "address": "bc1qkqu7akp4lf3vmkde5l4ydp596wp8fm93m9yptd",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+      {
+        "address": "1xT8bWnZzS339nQLnrdqBW6yz8Nt5KjLC",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+      {
+        "address": "1FprAosJemf7TDvLGaTHbUWms3Z1uLUwJS",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+      {
+        "address": "1CgpdCJAkEQrzgqRh4C2EkyKsGCZxDFPEa",
+        "chainId": "mainnet",
+        "network": "bitcoin",
+      },
+    ],
+  },
+  "result": null,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
 exports[`execute apiAddress endpoint solv should return success 1`] = `
 {
   "data": {

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

@@ -4,7 +4,11 @@ import {
 } from '@chainlink/external-adapter-framework/util/testing-utils'
 import * as nock from 'nock'
 import { ethers } from 'ethers'
-import { mockBedRockResponseSuccess, mockSolvResponseSuccess } from './fixtures-api'
+import {
+  mockBedRockResponseSuccess,
+  mockCoinbaseResponseSuccess,
+  mockSolvResponseSuccess,
+} from './fixtures-api'
 
 const mockExpectedAddresses = [
   '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
@@ -57,6 +61,7 @@ describe('execute', () => {
     oldEnv = JSON.parse(JSON.stringify(process.env))
     process.env.RPC_URL = process.env.RPC_URL ?? 'http://localhost:8545'
     process.env.BEDROCK_UNIBTC_API_ENDPOINT = 'http://bedrock'
+    process.env.COINBASE_CBBTC_API_ENDPOINT = 'http://coinbase'
     process.env.SOLVBTC_API_ENDPOINT = 'http://solv'
     process.env.BACKGROUND_EXECUTE_MS = '0'
     process.env.RATE_LIMIT_CAPACITY_SECOND = '500'
@@ -133,5 +138,17 @@ describe('execute', () => {
       expect(response.statusCode).toBe(200)
       expect(response.json()).toMatchSnapshot()
     })
+
+    it('coinbase BTC should return success', async () => {
+      const data = {
+        endpoint: 'coinbaseBtcAddress',
+        network: 'bitcoin',
+        chainId: 'mainnet',
+      }
+      mockCoinbaseResponseSuccess()
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
   })
 })