@keychat-io/keychat-openclaw 0.1.8 → 0.1.10

package/README.md

@@ -13,11 +13,11 @@ Your agent becomes a full Keychat citizen: it can receive friend requests, estab
 ### Option A: OpenClaw plugin (recommended)
 
 ```bash
-openclaw plugins install @keychat-io/keychat
+openclaw plugins install @keychat-io/keychat-openclaw
 openclaw gateway restart
 ```
 
-The bridge binary is auto-downloaded on first start. Supported platforms: macOS (ARM/x64), Linux (x64/ARM64).
+Supported platforms: macOS (ARM/x64), Linux (x64/ARM64).
 
 ### Option B: Shell script
 
@@ -40,31 +40,26 @@ Source code is fully open: [github.com/keychat-io/keychat-openclaw](https://gith
 
 ### Upgrade
 
+If you installed via **Option A**:
+
 ```bash
-# npm plugin
-openclaw plugins install @keychat-io/keychat@latest
+openclaw plugins install @keychat-io/keychat-openclaw@latest
 openclaw gateway restart
+```
 
-# shell script (re-run the same command)
+If you installed via **Option B**:
+
+```bash
 curl -fsSL https://raw.githubusercontent.com/keychat-io/keychat-openclaw/main/scripts/install.sh | bash
 ```
 
 ### Connect
 
-1. Run `openclaw status` to find your agent's **npub**
+1. Run `openclaw status` — your agent's **npub** and **QR code** will be displayed
 2. Open the [Keychat app](https://keychat.io) → tap **Add Contact** on the home page
-3. Paste the agent's npub and confirm
+3. Scan the QR code, or paste the npub
 4. The agent will automatically accept the friend request and establish an encrypted session
 
-You can also scan the QR code instead of pasting the npub:
-
-```bash
-# View QR code in terminal
-chafa ~/.openclaw/keychat/qr-default.png
-# or generate from npub
-qrencode -t ANSIUTF8 "https://www.keychat.io/u/?k=YOUR_NPUB"
-```
-
 ## Configuration
 
 All options go under `channels.keychat` in your OpenClaw config:

package/docs/setup-guide.md

@@ -11,7 +11,7 @@ Step-by-step instructions to get your OpenClaw agent communicating via Keychat.
 ## Step 1: Install the Plugin
 
 ```bash
-openclaw plugins install @keychat-io/keychat
+openclaw plugins install @keychat-io/keychat-openclaw
 ```
 
 This auto-downloads the pre-compiled Rust sidecar binary for your platform. No Rust toolchain needed.

package/package.json

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

package/src/channel.ts

@@ -714,7 +714,7 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
       ctx.log?.info(`[${account.accountId}] Bridge sidecar started`);
 
       // 2. Initialize Signal Protocol DB
-      const dbPath = `~/.openclaw/keychat/signal-${account.accountId}.db`;
+      const dbPath = `~/.openclaw/keychat-signal-${account.accountId}.db`;
       await bridge.init(dbPath);
       ctx.log?.info(`[${account.accountId}] Signal DB initialized`);
 
@@ -797,14 +797,19 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
       const contactUrl = `https://www.keychat.io/u/?k=${info.pubkey_npub}`;
       const qrPath = qrCodePath(account.accountId);
 
-      // Generate QR code (best-effort)
-      let qrSaved = false;
+      // Generate QR codes (best-effort)
+      let qrTerminal = "";
+      try {
+        const { generateQRTerminal } = await import("./qrcode.js");
+        qrTerminal = await generateQRTerminal(contactUrl);
+      } catch { /* qrcode not installed, skip */ }
+
+      // Also save PNG for sharing (best-effort)
       try {
         mkdirSync(WORKSPACE_KEYCHAT_DIR, { recursive: true });
         const QRCode = await import("qrcode");
         await QRCode.toFile(qrPath, contactUrl, { width: 256 });
-        qrSaved = true;
-      } catch { /* qrcode not installed, skip */ }
+      } catch { /* skip */ }
 
       const cfg = runtime.config.loadConfig();
       const displayName = resolveDisplayName(cfg, account.accountId, account.name);
@@ -817,7 +822,7 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
         `\n` +
         `  📱 Add contact (tap or scan):\n` +
         `  ${contactUrl}\n` +
-        (qrSaved ? `\n  🖼️  QR code: ${qrPath}\n` : ``) +
+        (qrTerminal ? `\n${qrTerminal}\n` : ``) +
         `═══════════════════════════════════════════════════\n`,
       );
 
@@ -840,8 +845,10 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
       activeBridges.set(account.accountId, bridge);
 
       // 7. Restore peer sessions and receiving addresses from DB
+      console.log(`[keychat] [${account.accountId}] Step 7: restoring peer sessions...`);
       try {
         const { mappings } = await bridge.getPeerMappings();
+        console.log(`[keychat] [${account.accountId}] Step 7: getPeerMappings returned ${mappings.length} mapping(s)`);
         if (mappings.length > 0) {
           ctx.log?.info(`[${account.accountId}] Restored ${mappings.length} peer mapping(s) from DB`);
           for (const m of mappings) {
@@ -871,7 +878,9 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
         }
 
         // Restore address-to-peer mappings from DB and populate peerSubscribedAddresses
+        console.log(`[keychat] [${account.accountId}] Step 7b: getting address mappings...`);
         const { mappings: addrMappings } = await bridge.getAddressMappings();
+        console.log(`[keychat] [${account.accountId}] Step 7b: getAddressMappings returned ${addrMappings.length} mapping(s)`);
         if (addrMappings.length > 0) {
           for (const am of addrMappings) {
             getAddressToPeer(account.accountId).set(am.address, am.peer_nostr_pubkey);
@@ -935,6 +944,7 @@ export const keychatPlugin: ChannelPlugin<ResolvedKeychatAccount> = {
         }
       } catch (err) {
         ctx.log?.error(`[${account.accountId}] Failed to restore sessions from DB: ${err}`);
+        console.error(`[keychat] [${account.accountId}] Failed to restore sessions from DB:`, err);
       }
 
       // 8. Restore groups from DB

package/src/paths.ts

@@ -19,7 +19,7 @@ export const WORKSPACE_KEYCHAT_DIR = join(HOME, ".openclaw", "workspace", "keych
 
 /** Signal DB path for a given account */
 export function signalDbPath(accountId: string): string {
-  return join(KEYCHAT_DIR, `signal-${accountId}.db`);
+  return join(HOME, ".openclaw", `keychat-signal-${accountId}.db`);
 }
 
 /** QR code image path for a given account */

package/src/qrcode-types.d.ts

@@ -1,4 +1,5 @@
 declare module "qrcode" {
   export function toDataURL(text: string, options?: Record<string, unknown>): Promise<string>;
   export function toFile(path: string, text: string, options?: Record<string, unknown>): Promise<void>;
+  export function toString(text: string, options?: Record<string, unknown>): Promise<string>;
 }

package/src/qrcode.ts

@@ -7,3 +7,17 @@ export async function generateQRDataUrl(npub: string): Promise<string> {
     return ""; // QR code generation not available
   }
 }
+
+/**
+ * Generate a QR code as Unicode block characters for terminal display.
+ * Uses half-block characters (▀▄█ ) so each text row encodes 2 pixel rows.
+ * Can be scanned by phone camera directly from the screen.
+ */
+export async function generateQRTerminal(url: string): Promise<string> {
+  try {
+    const QRCode = await import("qrcode");
+    return await QRCode.toString(url, { type: "terminal", small: true });
+  } catch {
+    return ""; // qrcode not installed
+  }
+}