@openclaw/nostr 2026.1.29

package/src/types.test.ts

@@ -0,0 +1,161 @@
+import { describe, expect, it } from "vitest";
+import {
+  listNostrAccountIds,
+  resolveDefaultNostrAccountId,
+  resolveNostrAccount,
+} from "./types.js";
+
+const TEST_PRIVATE_KEY = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
+
+describe("listNostrAccountIds", () => {
+  it("returns empty array when not configured", () => {
+    const cfg = { channels: {} };
+    expect(listNostrAccountIds(cfg)).toEqual([]);
+  });
+
+  it("returns empty array when nostr section exists but no privateKey", () => {
+    const cfg = { channels: { nostr: { enabled: true } } };
+    expect(listNostrAccountIds(cfg)).toEqual([]);
+  });
+
+  it("returns default when privateKey is configured", () => {
+    const cfg = {
+      channels: {
+        nostr: { privateKey: TEST_PRIVATE_KEY },
+      },
+    };
+    expect(listNostrAccountIds(cfg)).toEqual(["default"]);
+  });
+});
+
+describe("resolveDefaultNostrAccountId", () => {
+  it("returns default when configured", () => {
+    const cfg = {
+      channels: {
+        nostr: { privateKey: TEST_PRIVATE_KEY },
+      },
+    };
+    expect(resolveDefaultNostrAccountId(cfg)).toBe("default");
+  });
+
+  it("returns default when not configured", () => {
+    const cfg = { channels: {} };
+    expect(resolveDefaultNostrAccountId(cfg)).toBe("default");
+  });
+});
+
+describe("resolveNostrAccount", () => {
+  it("resolves configured account", () => {
+    const cfg = {
+      channels: {
+        nostr: {
+          privateKey: TEST_PRIVATE_KEY,
+          name: "Test Bot",
+          relays: ["wss://test.relay"],
+          dmPolicy: "pairing" as const,
+        },
+      },
+    };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.accountId).toBe("default");
+    expect(account.name).toBe("Test Bot");
+    expect(account.enabled).toBe(true);
+    expect(account.configured).toBe(true);
+    expect(account.privateKey).toBe(TEST_PRIVATE_KEY);
+    expect(account.publicKey).toMatch(/^[0-9a-f]{64}$/);
+    expect(account.relays).toEqual(["wss://test.relay"]);
+  });
+
+  it("resolves unconfigured account with defaults", () => {
+    const cfg = { channels: {} };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.accountId).toBe("default");
+    expect(account.enabled).toBe(true);
+    expect(account.configured).toBe(false);
+    expect(account.privateKey).toBe("");
+    expect(account.publicKey).toBe("");
+    expect(account.relays).toContain("wss://relay.damus.io");
+    expect(account.relays).toContain("wss://nos.lol");
+  });
+
+  it("handles disabled channel", () => {
+    const cfg = {
+      channels: {
+        nostr: {
+          enabled: false,
+          privateKey: TEST_PRIVATE_KEY,
+        },
+      },
+    };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.enabled).toBe(false);
+    expect(account.configured).toBe(true);
+  });
+
+  it("handles custom accountId parameter", () => {
+    const cfg = {
+      channels: {
+        nostr: { privateKey: TEST_PRIVATE_KEY },
+      },
+    };
+    const account = resolveNostrAccount({ cfg, accountId: "custom" });
+
+    expect(account.accountId).toBe("custom");
+  });
+
+  it("handles allowFrom config", () => {
+    const cfg = {
+      channels: {
+        nostr: {
+          privateKey: TEST_PRIVATE_KEY,
+          allowFrom: ["npub1test", "0123456789abcdef"],
+        },
+      },
+    };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.config.allowFrom).toEqual(["npub1test", "0123456789abcdef"]);
+  });
+
+  it("handles invalid private key gracefully", () => {
+    const cfg = {
+      channels: {
+        nostr: {
+          privateKey: "invalid-key",
+        },
+      },
+    };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.configured).toBe(true); // key is present
+    expect(account.publicKey).toBe(""); // but can't derive pubkey
+  });
+
+  it("preserves all config options", () => {
+    const cfg = {
+      channels: {
+        nostr: {
+          privateKey: TEST_PRIVATE_KEY,
+          name: "Bot",
+          enabled: true,
+          relays: ["wss://relay1", "wss://relay2"],
+          dmPolicy: "allowlist" as const,
+          allowFrom: ["pubkey1", "pubkey2"],
+        },
+      },
+    };
+    const account = resolveNostrAccount({ cfg });
+
+    expect(account.config).toEqual({
+      privateKey: TEST_PRIVATE_KEY,
+      name: "Bot",
+      enabled: true,
+      relays: ["wss://relay1", "wss://relay2"],
+      dmPolicy: "allowlist",
+      allowFrom: ["pubkey1", "pubkey2"],
+    });
+  });
+});

package/src/types.ts

@@ -0,0 +1,99 @@
+import type { OpenClawConfig } from "openclaw/plugin-sdk";
+import { getPublicKeyFromPrivate } from "./nostr-bus.js";
+import { DEFAULT_RELAYS } from "./nostr-bus.js";
+import type { NostrProfile } from "./config-schema.js";
+
+export interface NostrAccountConfig {
+  enabled?: boolean;
+  name?: string;
+  privateKey?: string;
+  relays?: string[];
+  dmPolicy?: "pairing" | "allowlist" | "open" | "disabled";
+  allowFrom?: Array<string | number>;
+  profile?: NostrProfile;
+}
+
+export interface ResolvedNostrAccount {
+  accountId: string;
+  name?: string;
+  enabled: boolean;
+  configured: boolean;
+  privateKey: string;
+  publicKey: string;
+  relays: string[];
+  profile?: NostrProfile;
+  config: NostrAccountConfig;
+}
+
+const DEFAULT_ACCOUNT_ID = "default";
+
+/**
+ * List all configured Nostr account IDs
+ */
+export function listNostrAccountIds(cfg: OpenClawConfig): string[] {
+  const nostrCfg = (cfg.channels as Record<string, unknown> | undefined)?.nostr as
+    | NostrAccountConfig
+    | undefined;
+
+  // If privateKey is configured at top level, we have a default account
+  if (nostrCfg?.privateKey) {
+    return [DEFAULT_ACCOUNT_ID];
+  }
+
+  return [];
+}
+
+/**
+ * Get the default account ID
+ */
+export function resolveDefaultNostrAccountId(cfg: OpenClawConfig): string {
+  const ids = listNostrAccountIds(cfg);
+  if (ids.includes(DEFAULT_ACCOUNT_ID)) return DEFAULT_ACCOUNT_ID;
+  return ids[0] ?? DEFAULT_ACCOUNT_ID;
+}
+
+/**
+ * Resolve a Nostr account from config
+ */
+export function resolveNostrAccount(opts: {
+  cfg: OpenClawConfig;
+  accountId?: string | null;
+}): ResolvedNostrAccount {
+  const accountId = opts.accountId ?? DEFAULT_ACCOUNT_ID;
+  const nostrCfg = (opts.cfg.channels as Record<string, unknown> | undefined)?.nostr as
+    | NostrAccountConfig
+    | undefined;
+
+  const baseEnabled = nostrCfg?.enabled !== false;
+  const privateKey = nostrCfg?.privateKey ?? "";
+  const configured = Boolean(privateKey.trim());
+
+  let publicKey = "";
+  if (configured) {
+    try {
+      publicKey = getPublicKeyFromPrivate(privateKey);
+    } catch {
+      // Invalid key - leave publicKey empty, configured will indicate issues
+    }
+  }
+
+  return {
+    accountId,
+    name: nostrCfg?.name?.trim() || undefined,
+    enabled: baseEnabled,
+    configured,
+    privateKey,
+    publicKey,
+    relays: nostrCfg?.relays ?? DEFAULT_RELAYS,
+    profile: nostrCfg?.profile,
+    config: {
+      enabled: nostrCfg?.enabled,
+      name: nostrCfg?.name,
+      privateKey: nostrCfg?.privateKey,
+      relays: nostrCfg?.relays,
+      dmPolicy: nostrCfg?.dmPolicy,
+      allowFrom: nostrCfg?.allowFrom,
+      profile: nostrCfg?.profile,
+    },
+  };
+}

package/test/setup.ts

@@ -0,0 +1,5 @@
+// Test setup file for nostr extension
+import { vi } from "vitest";
+
+// Mock console.error to suppress noise in tests
+vi.spyOn(console, "error").mockImplementation(() => {});