Merge pull request #349 from forta-network/forta-1339-js-bot-health-c…

…heck

js bot health check

cli/commands/run/server/agent.controller.d.ts

@@ -1,11 +1,12 @@
 import { GetAgentHandlers } from "../../../utils/get.agent.handlers";
 
-export = AgentController
+export = AgentController;
 
 declare class AgentController {
-  constructor(getAgentHandlers: GetAgentHandlers)
-  Initialize(call: any, callback: any): void
-  EvaluateBlock(call: any, callback: any): void
-  EvaluateTx(call: any, callback: any): void
-  EvaluateAlert(call: any, callback: any): void
-}
+  constructor(getAgentHandlers: GetAgentHandlers);
+  Initialize(call: any, callback: any): void;
+  EvaluateBlock(call: any, callback: any): void;
+  EvaluateTx(call: any, callback: any): void;
+  EvaluateAlert(call: any, callback: any): void;
+  HealthCheck(call: any, callback: any): void;
+}

cli/commands/run/server/agent.controller.js

@@ -20,6 +20,31 @@ module.exports = class AgentController {
     this.initializeResponse = {};
   }
 
+  async HealthCheck(call, callback) {
+    let errors = [];
+    let status = "SUCCESS";
+
+    if (this.healthCheck) {
+      try {
+        const response = await this.healthCheck();
+        if (response && response.length > 0) {
+          status = "ERROR";
+          errors = response.map((r) => ({ message: r }));
+        }
+      } catch (e) {
+        console.log(`${new Date().toISOString()}    healthCheck`);
+        console.log(e);
+        status = "ERROR";
+        errors = [{ message: e.message }];
+      }
+    }
+
+    callback(null, {
+      status,
+      errors,
+    });
+  }
+
   async Initialize(call, callback) {
     let status = "SUCCESS";
 
@@ -35,7 +60,7 @@ module.exports = class AgentController {
     }
 
     callback(null, {
-      status: status,
+      status,
       alertConfig: this.initializeResponse
         ? this.initializeResponse.alertConfig
         : undefined,
@@ -152,6 +177,7 @@ module.exports = class AgentController {
       this.handleBlock = agentHandlers.handleBlock;
       this.handleTransaction = agentHandlers.handleTransaction;
       this.handleAlert = agentHandlers.handleAlert;
+      this.healthCheck = agentHandlers.healthCheck;
     } catch (e) {
       console.log(e);
     }

cli/commands/run/server/agent.proto

@@ -12,6 +12,7 @@ service Agent {
   rpc EvaluateTx (EvaluateTxRequest) returns (EvaluateTxResponse) {}
   rpc EvaluateBlock (EvaluateBlockRequest) returns (EvaluateBlockResponse) {}
   rpc EvaluateAlert (EvaluateAlertRequest) returns (EvaluateAlertResponse) {}
+  rpc HealthCheck (HealthCheckRequest) returns (HealthCheckResponse) {}
 }
 
 message Error {
@@ -24,9 +25,23 @@ enum ResponseStatus {
   SUCCESS = 2;
 }
 
+message HealthCheckRequest {}
+
+message HealthCheckResponse {
+  enum ResponseStatus {
+    UNKNOWN = 0;
+    ERROR = 1;
+    SUCCESS = 2;
+  }
+
+  ResponseStatus status = 1;
+  repeated Error errors = 2;
+}
+
 message InitializeRequest {
   string agentId = 1;
   string proxyHost = 2;
+  int32 shardId = 3;
 }
 
 message InitializeResponse {
@@ -50,16 +65,20 @@ message CombinerBotSubscription {
 message EvaluateTxRequest {
   string requestId = 1;
   TransactionEvent event = 2;
+  int32 shardId = 3;
 }
 
 message EvaluateBlockRequest {
   string requestId = 1;
   BlockEvent event = 2;
+  int32 shardId = 3;
 }
 
 message EvaluateAlertRequest {
   string requestId = 1;
   AlertEvent event = 2;
+  string targetBotId = 3;
+  int32 shardId = 4;
 }
 
 message EvaluateTxResponse {
@@ -122,6 +141,7 @@ message BlockEvent {
     repeated string transactions = 18;
     string transactionsRoot = 19;
     repeated string uncles = 20;
+    string baseFeePerGas = 21;
   }
 
   EventType type = 1;
@@ -147,6 +167,7 @@ message TransactionEvent {
     string blockHash = 1;
     string blockNumber = 2;
     string blockTimestamp = 3;
+    string baseFeePerGas = 4;
   }
 
   message EthTransaction {
@@ -162,6 +183,8 @@ message TransactionEvent {
     string to = 10;
     string hash = 11;
     string from = 12;
+    string maxFeePerGas = 13;
+    string maxPriorityFeePerGas = 14;
   }
 
   message Log {
@@ -273,16 +296,16 @@ message AlertEvent {
 
     message SourceAlertEvent {
       string botId = 1;
-      string alertHash = 2;
+      string hash = 2;
       string timestamp = 3;
-      string chainId = 4;
+      uint64 chainId = 4;
     }
 
     message Source {
       string transactionHash = 1;
       Bot bot = 2;
       Block block = 3;
-      SourceAlertEvent sourceEvent = 4;
+      SourceAlertEvent sourceAlert = 4;
     }
 
     message Label {

cli/commands/run/server/alert.proto

@@ -18,6 +18,7 @@ enum AlertType {
   BLOCK = 2;
   PRIVATE = 3;
   COMBINATION = 4;
+  API = 5;
 }
 
 message AgentInfo {
@@ -162,4 +163,16 @@ message Finding {
   repeated string relatedAlerts = 13;
   string uniqueKey = 14;
   Source source = 15;
+  string timestamp = 16;
+}
+
+message APIAlert {
+  message APIAlertAgent {
+    string id = 1;
+  }
+  string id = 1;
+  AlertType type = 2;
+  Finding finding = 3;
+  APIAlertAgent agent = 4;
+  string timestamp = 5;
 }

cli/utils/get.agent.handlers.ts

@@ -1,10 +1,11 @@
-import { HandleBlock, HandleTransaction, HandleAlert, Initialize, InitializeResponse } from "../../sdk"
+import { HandleBlock, HandleTransaction, HandleAlert, Initialize, InitializeResponse, HealthCheck } from "../../sdk"
 import { assertExists, assertIsNonEmptyString } from "."
 import { GetPythonAgentHandlers } from './get.python.agent.handlers'
 
 type AgentHandlers = { 
   initialize?: Initialize,
   initializeResponse?: InitializeResponse | void,
+  healthCheck?: HealthCheck,
   handleTransaction?: HandleTransaction,
   handleBlock?: HandleBlock,
   handleAlert?: HandleAlert,

sdk/handlers.ts

@@ -5,6 +5,7 @@ import { InitializeResponse } from "./initialize.response"
 import { TransactionEvent } from "./transaction.event"
 
 export type Initialize = () => Promise<InitializeResponse | void>
+export type HealthCheck = () => Promise<string[] | void>
 export type HandleTransaction = (txEvent: TransactionEvent) => Promise<Finding[]>
 export type HandleBlock = (blockEvent: BlockEvent) => Promise<Finding[]>
 export type HandleAlert = (alertEvent: AlertEvent) => Promise<Finding[]>

sdk/index.ts

@@ -59,6 +59,7 @@ import {
   HandleTransaction,
   HandleBlock,
   HandleAlert,
+  HealthCheck
 } from "./handlers";
 
 interface DiContainer {
@@ -77,6 +78,7 @@ export {
   HandleTransaction,
   HandleBlock,
   HandleAlert,
+  HealthCheck,
   Finding,
   FindingSeverity,
   FindingType,