fix: self-report status code

Author: doomsower

package.json

@@ -20,7 +20,7 @@
     "pino-pretty": "^13.1.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.899.0",
+    "@aws-sdk/client-s3": "^3.901.0",
     "@biomejs/biome": "^2.2.4",
     "@commander-js/extra-typings": "^14.0.0",
     "@commitlint/cli": "^20.1.0",

src/services/Client.ts

@@ -38,6 +38,7 @@ import { exceptionsAbis } from "../data/index.js";
 import { DI } from "../di.js";
 import { TransactionRevertedError } from "../errors/TransactionRevertedError.js";
 import { type ILogger, Logger } from "../log/index.js";
+import type { StatusCode } from "../utils/index.js";
 import type { INotifier } from "./notifier/index.js";
 import { LowBalanceMessage } from "./notifier/index.js";
 
@@ -65,7 +66,7 @@ export default class Client {
 
   #testClient?: AnvilClient;
 
-  #balance?: { value: bigint; healthy: boolean };
+  #balance?: { value: bigint; status: StatusCode };
 
   public async launch(): Promise<void> {
     const { chainId, network, optimistic, privateKey, pollingInterval } =
@@ -241,7 +242,10 @@ export default class Client {
     const balance = await this.pub.getBalance({ address: this.address });
     this.#balance = {
       value: balance,
-      healthy: !!this.config.minBalance && balance >= this.config.minBalance,
+      status:
+        !this.config.minBalance || balance >= this.config.minBalance
+          ? "healthy"
+          : "alert",
     };
     this.logger.debug(`liquidator balance is ${formatEther(balance)}`);
     if (balance < this.config.minBalance) {
@@ -288,7 +292,7 @@ export default class Client {
     return this.wallet.account.address;
   }
 
-  public get balance(): { value: bigint; healthy: boolean } | undefined {
+  public get balance(): { value: bigint; status: StatusCode } | undefined {
     return this.#balance;
   }
 

src/services/HealthCheckerService.ts

@@ -11,6 +11,7 @@ import type { Config } from "../config/index.js";
 import { DI } from "../di.js";
 import type { ILogger } from "../log/index.js";
 import { Logger } from "../log/index.js";
+import { maxStatusCode, type StatusCode } from "../utils/index.js";
 import version from "../version.js";
 import type Client from "./Client.js";
 import type { Scanner } from "./Scanner.js";
@@ -47,39 +48,10 @@ export default class HealthCheckerService {
     }
 
     const server = createServer(async (req, res) => {
-      const timestamp = Number(this.sdk.timestamp);
-      const now = Math.ceil(Date.now() / 1000);
-      const threshold = this.config.staleBlockThreshold;
       // Routing
       if (req.url === "/") {
         res.writeHead(200, { "Content-Type": "application/json" });
-        res.end(
-          json_stringify({
-            startTime: this.#start,
-            version,
-            network: this.config.network,
-            family: "liquidators",
-            liquidationMode: this.config.liquidationMode,
-            address: this.client.address,
-            balance: this.client.balance,
-            currentBlock: this.sdk.currentBlock,
-            timestamp: {
-              value: timestamp,
-              healthy: !!threshold && now - timestamp <= threshold,
-            },
-            marketsConfigurators:
-              this.sdk.marketRegister.marketConfigurators.map(mc => mc.address),
-            pools: this.sdk.marketRegister.pools.map(p => p.pool.address),
-            creditManagers: this.sdk.marketRegister.creditManagers.map(
-              cm => cm.creditManager.address,
-            ),
-            providers: (
-              this.sdk.provider.publicClient as PublicClient<
-                Transport<"revolver", RevolverTransportValue>
-              >
-            ).transport.statuses(),
-          }),
-        );
+        res.end(json_stringify(this.#healthStatus));
       } else if (req.url === "/metrics") {
         try {
           res.writeHead(200, { "Content-Type": "text/plain" });
@@ -106,6 +78,54 @@ export default class HealthCheckerService {
     this.log.info("launched");
   }
 
+  get #healthStatus() {
+    const timestamp = Number(this.sdk.timestamp);
+    const now = Math.ceil(Date.now() / 1000);
+    const threshold = this.config.staleBlockThreshold;
+    const result = {
+      status: "healthy" as StatusCode,
+      startTime: this.#start,
+      version,
+      network: this.config.network,
+      family: "liquidators",
+      liquidationMode: this.config.liquidationMode,
+      address: this.client.address,
+      balance: this.client.balance,
+      currentBlock: this.sdk.currentBlock,
+      timestamp: {
+        value: timestamp,
+        status: (!!threshold && now - timestamp <= threshold
+          ? "healthy"
+          : "alert") as StatusCode,
+      },
+      marketsConfigurators: this.sdk.marketRegister.marketConfigurators.map(
+        mc => mc.address,
+      ),
+      pools: this.sdk.marketRegister.pools.map(p => p.pool.address),
+      creditManagers: this.sdk.marketRegister.creditManagers.map(
+        cm => cm.creditManager.address,
+      ),
+      liquidatableAccounts: {
+        value: this.scanner.liquidatableAccounts,
+        status: (this.scanner.liquidatableAccounts > 0
+          ? "alert"
+          : "healthy") as StatusCode,
+      },
+      providers: (
+        this.sdk.provider.publicClient as PublicClient<
+          Transport<"revolver", RevolverTransportValue>
+        >
+      ).transport.statuses(),
+    };
+    result.status = maxStatusCode(
+      result.status,
+      result.timestamp.status,
+      result.balance?.status,
+      result.liquidatableAccounts.status,
+    );
+    return result;
+  }
+
   public async stop(): Promise<void> {
     this.log.info("stopping");
     return new Promise(resolve => {

src/services/Scanner.ts

@@ -60,6 +60,7 @@ export class Scanner {
   #minHealthFactor = 0n;
   #unwatch?: () => void;
   #lastZeroHFNotification = 0;
+  #liquidatableAccounts = 0;
 
   public async launch(): Promise<void> {
     await this.liquidatorService.launch();
@@ -208,6 +209,7 @@ export class Scanner {
     this.log.debug(
       `${accounts.length} accounts to ${verb}${blockS}, time: ${time}s`,
     );
+    this.#liquidatableAccounts = accounts.length;
 
     if (this.config.optimistic) {
       await this.liquidatorService.liquidateOptimistic(accounts);
@@ -412,6 +414,10 @@ export class Scanner {
     return this.#lastUpdated;
   }
 
+  public get liquidatableAccounts(): number {
+    return this.#liquidatableAccounts;
+  }
+
   public async stop(): Promise<void> {
     this.#unwatch?.();
     this.log.info("stopped");

src/utils/index.ts

@@ -1,5 +1,6 @@
 export * from "./createTransport.js";
 export * from "./formatters.js";
 export * from "./retry.js";
+export * from "./status.js";
 export * from "./types.js";
 export * from "./typescript.js";

src/utils/status.ts

@@ -0,0 +1,20 @@
+export type StatusCode = "healthy" | "warning" | "alert";
+
+const statusCodeOrder: Record<StatusCode, number> = {
+  healthy: 0,
+  warning: 1,
+  alert: 2,
+};
+
+export function maxStatusCode(
+  ...codes: Array<StatusCode | undefined>
+): StatusCode {
+  let status: StatusCode = "healthy";
+  for (const code of codes) {
+    if (!code) {
+      continue;
+    }
+    status = statusCodeOrder[code] > statusCodeOrder[status] ? code : status;
+  }
+  return status;
+}