solana-messenger-sdk 1.5.3 → 1.5.5

package/README.md

@@ -89,6 +89,105 @@ const conn = new Connection(rpcUrl);
 const sig = await conn.sendRawTransaction(signedTxBytes);
 ```
 
+### Deployment Patterns
+
+#### 1. Client-Side with Privy (True E2E Encryption)
+
+Users hold their own encryption key B on-device. Server never sees plaintext. Maximum privacy. Privy handles wallet key A — user never manages raw keys.
+
+```
+Browser (Client)                     Solana
+├── Privy embedded wallet (A)        ├── EncryptionRegistry (pubkey B)
+├── Encryption key B (localStorage)  ├── Messages (encrypted)
+├── SDK: encrypt → sign → send       └── Channels, Servers...
+└── SDK: read → decrypt → display
+```
+
+```typescript
+import { usePrivy, useWallets } from "@privy-io/react-auth";
+import { SolanaMessenger } from "solana-messenger-sdk";
+
+// On first login: generate encryption keypair, store in localStorage
+function getOrCreateEncryptionKey(userId: string): Uint8Array {
+  const key = `enc_keypair_${userId}`;
+  const stored = localStorage.getItem(key);
+  if (stored) return new Uint8Array(JSON.parse(stored));
+  const kp = SolanaMessenger.generateEncryptionKeypair();
+  localStorage.setItem(key, JSON.stringify(Array.from(kp.secretKey)));
+  return kp.secretKey;
+}
+
+// Create messenger with Privy signer + local encryption key
+const { wallets } = useWallets();
+const solWallet = wallets.find(w => w.walletClientType === "privy" && w.chainType === "solana");
+
+const messenger = new SolanaMessenger({
+  apiKey: HELIUS_API_KEY,
+  walletAddress: solWallet.address,
+  signer: async (tx) => {
+    // Sign with Privy embedded wallet
+    return await solWallet.signTransaction(tx);
+  },
+  encryptionKeypair: getOrCreateEncryptionKey(user.id),
+});
+await messenger.init();
+
+// Now send/read — Privy signs txs, encryption stays client-side
+await messenger.send(recipient, "truly private message");
+```
+
+> ✅ **Best privacy:** Privy holds wallet key A (signs txs) but never sees encryption key B. Your server never sees plaintext. Only the user's browser can decrypt messages.
+
+#### 2. Server-Managed (Slack/Discord Model)
+
+Server holds both keys per user. Handles all encryption/decryption, pushes plaintext to clients. Users trust the platform.
+
+```
+Server (Vercel, etc.)                Solana
+├── Per-user wallet key A (Privy)    ├── EncryptionRegistry (pubkey B)
+├── Per-user encryption key B (DB)   ├── Messages (encrypted)
+├── SDK: encrypt → sign → send       └── Channels, Servers...
+└── SDK: read → decrypt → push to client via WS/API
+```
+
+```typescript
+// First-time user setup
+const kp = SolanaMessenger.generateEncryptionKeypair();
+await db.users.update(userId, {
+  encryptionSecret: Buffer.from(kp.secretKey).toString("base64"),
+});
+
+// Per-request: create messenger for this user
+const messenger = new SolanaMessenger({
+  apiKey: process.env.HELIUS_API_KEY!,
+  walletAddress: user.walletAddress,
+  signer: async (tx) => await privy.signTransaction(user.id, tx),
+  encryptionKeypair: Buffer.from(user.encryptionSecret, "base64"),
+});
+await messenger.init();
+
+// Send on behalf of user
+await messenger.send(recipient, "hello from server");
+
+// Read, decrypt, push to client
+const messages = await messenger.read({ since: lastSeen });
+ws.send(JSON.stringify(messages)); // plaintext to client
+```
+
+> ⚠️ **Trust tradeoff:** In this model, the server can read all messages. E2E encryption protects data on-chain and in transit, but not from the platform operator. This is the same model as Slack, Discord, and most chat platforms.
+
+#### 3. Relayer Only (Gasless Transactions)
+
+Server just pays gas. Users handle their own encryption client-side. Server never sees keys or plaintext.
+
+```typescript
+// Relayer endpoint — no SDK, no keys
+app.post("/relay", async (req, res) => {
+  const sig = await conn.sendRawTransaction(req.body.signedTx);
+  res.json({ signature: sig });
+});
+```
+
 ## API
 
 ### Direct Messages

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solana-messenger-sdk",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "TypeScript SDK for Solana Messenger — encrypted agent-to-agent messaging",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",