[L2EP] Add Scroll Health Check Endpoint (#3331)

* [L2EP] Add Scroll Health Check Endpoint

* add in test fixtures

* [L2EP] Add response processing func

* chore: update type

* refactor: process response func

* Set Optimism to undefined

Author: KodeyThomas

.changeset/pink-snails-trade.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/layer2-sequencer-health-adapter': minor
+---
+
+Adds Scroll Healthcheck endpoint

packages/sources/layer2-sequencer-health/README.md

@@ -24,7 +24,7 @@ Adapter that checks the Layer 2 Sequencer status
 |           |         `METIS_CHAIN_ID`          |                             The chain id to connect to Metis                              |         |                               1088                               |
 |           |           `METIS_DELTA`           |   Maximum time in milliseconds from last seen block to consider Metis sequencer healthy   |         |                         600000 (10 min)                          |
 |           |       `SCROLL_RPC_ENDPOINT`       |                                    Scroll RPC Endpoint                                    |         |                      https://rpc.scroll.io                       |
-|           |     `SCROLL_HEALTH_ENDPOINT`      |                                  Scroll Health Endpoint                                   |         |                                                                  |
+|           |     `SCROLL_HEALTH_ENDPOINT`      |                                  Scroll Health Endpoint                                   |         |           https://venus.scroll.io/v1/sequencer/status            |
 |           |         `SCROLL_CHAIN_ID`         |                             The chain id to connect to Scroll                             |         |                              534352                              |
 |           |          `SCROLL_DELTA`           |  Maximum time in milliseconds from last seen block to consider Scroll sequencer healthy   |         |                          120000 (2 min)                          |
 |           |     `STARKWARE_RPC_ENDPOINT`      |                                  Starkware RPC Endpoint                                   |         |           https://starknet-mainnet.public.blastapi.io            |

packages/sources/layer2-sequencer-health/schemas/env.json

@@ -98,7 +98,7 @@
     },
     "SCROLL_HEALTH_ENDPOINT": {
       "type": "string",
-      "default": ""
+      "default": "https://venus.scroll.io/v1/sequencer/status"
     },
     "SCROLL_CHAIN_ID": {
       "required": false,

packages/sources/layer2-sequencer-health/src/config/index.ts

@@ -95,36 +95,53 @@ export const CHAIN_DELTA: Record<Networks, number> = {
 }
 
 const DEFAULT_METIS_HEALTH_ENDPOINT = 'https://andromeda-healthy.metisdevops.link/health'
-export const HEALTH_ENDPOINTS: Record<
+const DEFAULT_SCROLL_HEALTH_ENDPOINT = 'https://venus.scroll.io/v1/sequencer/status'
+
+export type HeathEndpoints = Record<
   Networks,
-  { endpoint: string | undefined; responsePath: string[] }
-> = {
+  {
+    endpoint: string | undefined
+    responsePath: string[]
+    processResponse: (data: unknown) => boolean | undefined
+  }
+>
+
+export const HEALTH_ENDPOINTS: HeathEndpoints = {
   [Networks.Arbitrum]: {
     endpoint: util.getEnv('ARBITRUM_HEALTH_ENDPOINT'),
     responsePath: [],
+    processResponse: () => undefined,
   },
   [Networks.Optimism]: {
     endpoint: util.getEnv('OPTIMISM_HEALTH_ENDPOINT'),
     responsePath: ['healthy'],
+    processResponse: () => undefined,
   },
   [Networks.Base]: {
     endpoint: util.getEnv('BASE_HEALTH_ENDPOINT'),
     responsePath: [],
+    processResponse: () => undefined,
   },
   [Networks.Metis]: {
     endpoint: util.getEnv('METIS_HEALTH_ENDPOINT') || DEFAULT_METIS_HEALTH_ENDPOINT,
     responsePath: ['healthy'],
+    processResponse: (data: unknown) => defaultProcessResponse(data, Networks.Metis),
   },
   [Networks.Scroll]: {
-    endpoint: util.getEnv('SCROLL_HEALTH_ENDPOINT'),
-    responsePath: [],
+    endpoint: util.getEnv('SCROLL_HEALTH_ENDPOINT') || DEFAULT_SCROLL_HEALTH_ENDPOINT,
+    responsePath: ['data', 'health'],
+    processResponse: (data: unknown) => Requester.getResult(data, ['data', 'health']) == 1,
   },
   [Networks.Starkware]: {
     endpoint: util.getEnv('STARKWARE_HEALTH_ENDPOINT'),
     responsePath: [],
+    processResponse: () => undefined,
   },
 }
 
+const defaultProcessResponse = (data: unknown, network: Networks) =>
+  !!Requester.getResult(data, HEALTH_ENDPOINTS[network]?.responsePath)
+
 export interface ExtendedConfig extends Config {
   deltaBlocks: number
   deltaChain: Record<Networks, number>

packages/sources/layer2-sequencer-health/src/network.ts

@@ -45,7 +45,10 @@ export const checkSequencerHealth: NetworkHealthCheck = async (
   const response = await Requester.request({
     url: HEALTH_ENDPOINTS[network]?.endpoint,
   })
-  const isHealthy = !!Requester.getResult(response.data, HEALTH_ENDPOINTS[network]?.responsePath)
+
+  // If the network has a custom response processing function, use it
+  const isHealthy = HEALTH_ENDPOINTS[network].processResponse(response.data)
+
   Logger.info(
     `[${network}] Health endpoint for network ${network} returned a ${
       isHealthy ? 'healthy' : 'unhealthy'

packages/sources/layer2-sequencer-health/test/integration/fixtures.ts

@@ -15,6 +15,20 @@ export const mockResponseSuccessHealth = (): void => {
       'Vary',
       'Origin',
     ])
+
+  nock('https://venus.scroll.io/v1/sequencer/status')
+    .get('')
+    .query(() => true)
+    .reply(200, () => ({ errcode: 0, errmsg: '', data: { health: 1 } }), [
+      'Content-Type',
+      'application/json',
+      'Connection',
+      'close',
+      'Vary',
+      'Accept-Encoding',
+      'Vary',
+      'Origin',
+    ])
 }
 
 export const mockResponseSuccessBlock = (): void => {
@@ -106,6 +120,20 @@ export const mockResponseFailureHealth = (): void => {
       'Vary',
       'Origin',
     ])
+
+  nock('https://venus.scroll.io/v1/sequencer/status')
+    .get('')
+    .query(() => true)
+    .reply(200, () => ({ errcode: 1, errmsg: 'Mock Error Message', data: { health: 2 } }), [
+      'Content-Type',
+      'application/json',
+      'Connection',
+      'close',
+      'Vary',
+      'Accept-Encoding',
+      'Vary',
+      'Origin',
+    ])
 }
 
 export const mockResponseFailureBlock = (): void => {

packages/sources/layer2-sequencer-health/test/integration/onchainSuccess.test.ts

@@ -203,6 +203,7 @@ describe('execute', () => {
   describe('scroll network', () => {
     it('should return success when all methods succeed', async () => {
       mockResponseSuccessBlock()
+      mockResponseSuccessHealth()
 
       const data: AdapterRequest = {
         id,
@@ -216,6 +217,7 @@ describe('execute', () => {
 
     it('should return transaction submission is successful', async () => {
       mockResponseFailureBlock()
+      mockResponseSuccessHealth()
 
       const data: AdapterRequest = {
         id,
@@ -230,6 +232,7 @@ describe('execute', () => {
 
     it('should return failure if tx not required even if it would be successful', async () => {
       mockResponseFailureBlock()
+      mockResponseFailureHealth()
 
       const data: AdapterRequest = {
         id,