feat: add descriptor/name to safe addresses

Author: bernacodesido

config.example.yaml

@@ -3,7 +3,7 @@ telegramChannelId: "-1111"
 slackBotToken: "xxxx"
 slackChannelId: "C1111"
 safeAddresses:
-  - "eth:0x11111"
+  - "desc: eth:0x11111"
 signers:
   "0x22222": "alice"
   "0x33333": "bob"

src/SafeWatcher.ts

@@ -24,6 +24,7 @@ interface SafeWatcherOptions {
 class SafeWatcher {
   readonly #prefix: string;
   readonly #safe: Address;
+  readonly #name: string;
   readonly #notificationSender?: INotificationSender;
   readonly #logger: Logger;
   readonly #api: ISafeAPI;
@@ -33,10 +34,11 @@ class SafeWatcher {
   #interval?: NodeJS.Timeout;
 
   constructor(opts: SafeWatcherOptions) {
-    const [prefix, address] = parsePrefixedAddress(opts.safe);
+    const [prefix, address, name] = parsePrefixedAddress(opts.safe);
     this.#logger = logger.child({ chain: prefix, address });
     this.#prefix = prefix;
     this.#safe = address;
+    this.#name = name;
     this.#notificationSender = opts.notifier;
     this.#signers = opts.signers ?? {};
     this.#api = new SafeApiWrapper(opts.safe, opts.api);
@@ -125,6 +127,7 @@ class SafeWatcher {
 
     await this.#notificationSender?.notify({
       type: isMalicious ? "malicious" : "created",
+      name: this.#name,
       chainPrefix: this.#prefix,
       safe: this.#safe,
       tx: detailed,
@@ -153,6 +156,7 @@ class SafeWatcher {
 
     await this.#notificationSender?.notify({
       type: tx.isExecuted ? "executed" : "updated",
+      name: this.#name,
       chainPrefix: this.#prefix,
       safe: this.#safe,
       tx: detailed,

src/config/parsePrefixedAddress.ts

@@ -5,10 +5,10 @@ import type { PrefixedAddress } from "./schema.js";
 
 export function parsePrefixedAddress(
   addr: PrefixedAddress,
-): [prefix: string, address: Address] {
-  const [prefix, address] = addr.split(":");
+): [prefix: string, address: Address, name: string] {
+  const [name, prefix, address] = addr.split(":");
   if (!isAddress(address)) {
     throw new Error(`invalid prefixed safe address '${addr}'`);
   }
-  return [prefix, address];
+  return [prefix, address, name];
 }

src/config/schema.ts

@@ -3,10 +3,10 @@ import { z } from "zod";
 
 import { SafeAPIMode } from "../safe/schema.js";
 
-export type PrefixedAddress = `${string}:0x${string}`;
+export type PrefixedAddress = `${string}: ${string}:0x${string}`;
 
 export const PrefixedAddress = z.string().transform((val, ctx) => {
-  const regex = /^[a-zA-Z0-9]+:0x[a-fA-F0-9]{40}$/;
+  const regex = /^[a-zA-Z0-9]+: [a-zA-Z0-9]+:0x[a-fA-F0-9]{40}$/;
 
   if (!regex.test(val)) {
     ctx.addIssue({

src/types.ts

@@ -5,6 +5,7 @@ import type { ListedSafeTx, SafeTx, Signer } from "./safe/index.js";
 export type EventType = "created" | "updated" | "executed" | "malicious";
 
 export interface Event {
+  name: string;
   chainPrefix: string;
   safe: Address;
   type: EventType;