@keychat-io/keychat-openclaw 0.1.10 → 0.1.13

package/README.md

@@ -29,17 +29,22 @@ This clones the repo, downloads the binary, registers the plugin, and restarts t
 
 ### Security Warnings
 
-During installation, OpenClaw's security scanner may show two warnings. Both are expected:
+During installation, OpenClaw's security scanner may show three warnings. All are expected:
 
 | Warning | Reason |
 |---------|--------|
 | Shell command execution (bridge-client.ts) | Keychat's Signal Protocol and MLS Protocol encryption are implemented in Rust. The plugin spawns a Rust sidecar process to bridge between Node.js and the native crypto layer. |
 | Shell command execution (keychain.ts) | Agent identity mnemonics are stored in the OS keychain (macOS Keychain / Linux libsecret) rather than plain files, which is the more secure option. |
+| Shell command execution (notify.ts) | After startup, the plugin notifies the agent so it can proactively send the Keychat ID and QR code to the user on their active channel (Telegram, webchat, etc). |
 
 Source code is fully open: [github.com/keychat-io/keychat-openclaw](https://github.com/keychat-io/keychat-openclaw)
 
 ### Upgrade
 
+**Easiest way:** Just tell your agent "upgrade keychat" in any chat. The agent will handle it and reconnect automatically.
+
+Or manually:
+
 If you installed via **Option A**:
 
 ```bash

package/index.ts

@@ -41,21 +41,35 @@ const plugin = {
               ],
             };
           }
-          const result = contacts.map((c) => ({
-            accountId: c.accountId,
-            npub: c.npub,
-            contactUrl: c.contactUrl,
-            qrCodePath: c.qrCodePath,
-            qrExists: existsSync(c.qrCodePath),
-          }));
+          const { generateQRDataUrl } = await import("./src/qrcode.js");
+          const results = [];
+          const contentParts: Array<{ type: "text"; text: string } | { type: "image"; data: string; mimeType: string }> = [];
+
+          for (const c of contacts) {
+            const qrDataUrl = await generateQRDataUrl(c.npub);
+            results.push({
+              accountId: c.accountId,
+              npub: c.npub,
+              contactUrl: c.contactUrl,
+            });
+            contentParts.push({
+              type: "text" as const,
+              text: `Account: ${c.accountId}\nnpub: ${c.npub}\nContact: ${c.contactUrl}`,
+            });
+            if (qrDataUrl) {
+              // Extract base64 from data URL: "data:image/png;base64,..."
+              const base64 = qrDataUrl.replace(/^data:image\/png;base64,/, "");
+              contentParts.push({
+                type: "image" as const,
+                data: base64,
+                mimeType: "image/png",
+              });
+            }
+          }
+
           return {
             details: null,
-            content: [
-              {
-                type: "text" as const,
-                text: JSON.stringify(result, null, 2),
-              },
-            ],
+            content: contentParts,
           };
         },
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keychat-io/keychat-openclaw",
-  "version": "0.1.10",
+  "version": "0.1.13",
   "description": "Keychat — E2E encrypted chat + Lightning wallet for OpenClaw agents",
   "license": "AGPL-3.0",
   "repository": {
@@ -17,7 +17,6 @@
     "zod": "^4.3.6"
   },
   "openclaw": {
-    "id": "keychat",
     "extensions": [
       "./index.ts"
     ],

package/src/channel.ts

@@ -826,11 +826,25 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
         `═══════════════════════════════════════════════════\n`,
       );
 
-      // Log agent readiness (visible in gateway logs)
-      ctx.log?.info?.(
-        `[${account.accountId}] Agent "${displayName}" is online. ` +
-        `Use keychat_identity tool to get contact link and QR code.`,
-      );
+      // Notify agent on first install only (not on every restart)
+      const { KEYCHAT_DIR } = await import("./paths.js");
+      const notifiedMarker = join(KEYCHAT_DIR, `.notified-${account.accountId}`);
+      if (!existsSync(notifiedMarker)) {
+        try {
+          const { sendSystemEvent } = await import("./notify.js");
+          await sendSystemEvent(
+            `[Keychat Plugin] Agent "${displayName}" (account: ${account.accountId}) is online and ready.\n` +
+            `Use the keychat_identity tool to get the agent's Keychat ID, contact link, and QR code.\n` +
+            `Then send the contact info to the user on their active channel using the message tool.\n` +
+            `The user can open the link or scan the QR code in Keychat app to add this agent as a contact.`,
+          );
+          // Mark as notified so we don't repeat on restart
+          const { writeFileSync } = await import("node:fs");
+          writeFileSync(notifiedMarker, new Date().toISOString());
+        } catch {
+          ctx.log?.warn?.(`[${account.accountId}] Failed to send system event notification`);
+        }
+      }
 
       ctx.setStatus({
         accountId: account.accountId,

package/src/notify.ts

@@ -0,0 +1,15 @@
+/**
+ * System event notification helper.
+ * Isolated to keep child_process out of channel.ts (avoids scanner warnings there).
+ */
+
+export async function sendSystemEvent(text: string, timeoutMs = 10_000): Promise<void> {
+  const { execFile } = await import("node:child_process");
+  const { promisify } = await import("node:util");
+  const execFileAsync = promisify(execFile);
+  await execFileAsync("openclaw", [
+    "system", "event",
+    "--text", text,
+    "--mode", "now",
+  ], { timeout: timeoutMs });
+}