fix: improve notifications

Author: doomsower

src/services/Scanner.ts

@@ -23,7 +23,7 @@ import { DI } from "../di.js";
 import { type ILogger, Logger } from "../log/index.js";
 import type Client from "./Client.js";
 import type { ILiquidatorService } from "./liquidate/index.js";
-import type { INotifier } from "./notifier/index.js";
+import { type INotifier, ZeroHFAccountsMessage } from "./notifier/index.js";
 
 const RESTAKING_CMS: Partial<Record<NetworkType, Address>> = {
   Mainnet:
@@ -406,10 +406,7 @@ export class Scanner {
     }
     this.#lastZeroHFNotification = now;
     this.log.debug("notifying on zero HF accounts");
-    this.notifier.alert({
-      plain: `found ${count} accounts with HF=0, bad tokens: ${badTokens}`,
-      markdown: `found ${count} accounts with HF=0, bad tokens: ${badTokens}`,
-    });
+    this.notifier.alert(new ZeroHFAccountsMessage(count, badTokens));
   }
 
   public get lastUpdated(): bigint {

src/services/notifier/messages.ts

@@ -3,7 +3,7 @@ import { etherscanUrl, formatBN } from "@gearbox-protocol/sdk";
 import type { OptimisticResult } from "@gearbox-protocol/types/optimist";
 import type { Markdown } from "@vlad-yakovlev/telegram-md";
 import { md } from "@vlad-yakovlev/telegram-md";
-import type { Address, TransactionReceipt } from "viem";
+import type { Address, BaseError, TransactionReceipt } from "viem";
 
 import type { Config } from "../../config/index.js";
 import { DI } from "../../di.js";
@@ -320,6 +320,80 @@ Error: ${md.inlineCode(this.#error)}`,
   }
 }
 
+export class ProviderRotationSuccessMessage
+  extends BaseMessage
+  implements INotifierMessage
+{
+  #oldT: string;
+  #newT: string;
+  #reason: string;
+
+  constructor(oldT: string, newT: string, reason?: BaseError) {
+    super({});
+    this.#oldT = oldT;
+    this.#newT = newT;
+    this.#reason = reason ? `: ${reason.shortMessage} ${reason.details}` : "";
+  }
+
+  public get plain(): string {
+    return `[${this.network}] rotated rpc provider from ${this.#oldT} to ${this.#newT}${this.#reason}`;
+  }
+
+  public get markdown(): string {
+    return md.build(
+      md`[${this.network}] rotated rpc provider from ${md.bold(this.#oldT)} to ${md.bold(this.#newT)}${this.#reason}`,
+    );
+  }
+}
+
+export class ProviderRotationErrorMessage
+  extends BaseMessage
+  implements INotifierMessage
+{
+  #oldT: string;
+  #reason: string;
+
+  constructor(oldT: string, reason?: BaseError) {
+    super({});
+    this.#oldT = oldT;
+    this.#reason = reason ? `: ${reason.shortMessage} ${reason.details}` : "";
+  }
+
+  public get plain(): string {
+    return `[${this.network}] failed to rotate rpc provider from ${this.#oldT}${this.#reason}`;
+  }
+
+  public get markdown(): string {
+    return md.build(
+      md`[${this.network}] failed to rotate rpc provider from ${md.bold(this.#oldT)}${this.#reason}`,
+    );
+  }
+}
+
+export class ZeroHFAccountsMessage
+  extends BaseMessage
+  implements INotifierMessage
+{
+  #count: number;
+  #badTokens: string;
+
+  constructor(count: number, badTokens: string) {
+    super({});
+    this.#count = count;
+    this.#badTokens = badTokens;
+  }
+
+  public get plain(): string {
+    return `[${this.network}] found ${this.#count} accounts with HF=0, bad tokens: ${this.#badTokens}`;
+  }
+
+  public get markdown(): string {
+    return md.build(
+      md`[${this.network}] found ${this.#count} accounts with HF=0, bad tokens: ${this.#badTokens}`,
+    );
+  }
+}
+
 function callsPlain(calls?: string[]): string {
   return calls ? calls.map(c => ` ➤ ${c}`).join("\n") : "-";
 }

src/utils/createTransport.ts

@@ -3,10 +3,13 @@ import {
   type ProviderConfig,
   RevolverTransport,
 } from "@gearbox-protocol/sdk/dev";
-import { md } from "@vlad-yakovlev/telegram-md";
 import type { Transport } from "viem";
 import type { CommonSchema } from "../config/common.js";
-import type { INotifier } from "../services/notifier/index.js";
+import {
+  type INotifier,
+  ProviderRotationErrorMessage,
+  ProviderRotationSuccessMessage,
+} from "../services/notifier/index.js";
 
 export function createTransport(
   config: CommonSchema,
@@ -75,24 +78,10 @@ export function createTransport(
     retryCount: config.optimistic ? 3 : undefined,
     logger: logger?.child?.({ name: "transport" }),
     onRotateSuccess: (oldT, newT, reason) => {
-      const reasonS = reason
-        ? `: ${reason.shortMessage} ${reason.details}`
-        : "";
-      notifier.alert({
-        plain: `Rotated rpc provider from ${oldT} to ${newT}${reasonS}`,
-        markdown:
-          md`Rotated rpc provider from ${md.bold(oldT)} to ${md.bold(newT)}${reasonS}`.toString(),
-      });
+      notifier.notify(new ProviderRotationSuccessMessage(oldT, newT, reason));
     },
     onRotateFailed: (oldT, reason) => {
-      const reasonS = reason
-        ? `: ${reason.shortMessage} ${reason.details}`
-        : "";
-      notifier.alert({
-        plain: `Failed to rotate rpc provider from ${oldT}${reasonS}`,
-        markdown:
-          md`Failed to rotate rpc provider from ${md.bold(oldT)}${reasonS}`.toString(),
-      });
+      notifier.alert(new ProviderRotationErrorMessage(oldT, reason));
     },
   });
 }