deploy

Author: humanagent

README.md

@@ -38,6 +38,12 @@ const members = await group.members();
 
 > To learn more about groups, read the [XMTP documentation](https://docs.xmtp.org).
 
+## Keys
+
+By default, your bot will have a new address every time you start it up. That's ideal. If you have a private key, you can encode it to a hex string and set the KEY environment variable. Your bot will then use this key to connect to the network.
+
+Don't know how to create a private key? Here's how to do it with ethers.js:
+
 ## Web inbox
 
 Interact with the XMTP protocol using [xmtp.chat](https://xmtp.chat) the official web inbox for developers using the latest version powered by MLS.
@@ -61,10 +67,16 @@ yarn install
 yarn build
 
 # gm example
+yarn gm
+# or
+cd examples
 cd gm
 yarn dev
 
-# gated grouo
+# gated group example
+yarn gated
+# or
+cd examples
 cd gated-group
 yarn dev
 ```

examples/gated-group/src/groups.ts

@@ -10,6 +10,7 @@ export async function createGroup(
     await client.conversations.sync();
     const conversations = client.conversations.list();
     console.log("Conversations", conversations.length);
+    /* If you have the inboxId you can use group.addMembersByInboxId instead*/
     const group = await client.conversations.newGroup([
       senderAddress,
       clientAddress,

examples/gated-group/src/keys.ts

@@ -1,51 +1,64 @@
 import { getRandomValues } from "node:crypto";
 import * as fs from "node:fs";
 import path from "path";
-import { toHex } from "viem";
-
-export function generateKeys(
-  walletKey?: string,
-  encryptionKey?: string,
-  suffix: string = "",
-) {
-  encryptionKey =
-    encryptionKey ??
-    process.env["ENCRYPTION_KEY" + suffix] ??
-    toHex(getRandomValues(new Uint8Array(32)));
-
-  if (!encryptionKey.startsWith("0x")) {
-    encryptionKey = "0x" + encryptionKey;
-  }
-  walletKey =
-    walletKey ??
-    process.env["WALLET_KEY" + suffix] ??
-    toHex(getRandomValues(new Uint8Array(32)));
+import { toBytes, toHex } from "viem";
+
+class KeyManager {
+  private suffix: string;
 
-  if (!walletKey.startsWith("0x")) {
-    walletKey = "0x" + walletKey;
+  constructor(suffix: string = "") {
+    this.suffix = suffix;
   }
-  return { walletKey, encryptionKey };
-}
 
-export function saveKeys(
-  walletKey: string,
-  encryptionKey: string,
-  suffix: string = "",
-) {
-  const envFilePath = path.resolve(process.cwd(), ".env");
-  const envContent = `\nENCRYPTION_KEY${suffix}=${encryptionKey}\nWALLET_KEY${suffix}=${walletKey}`;
-
-  // Read the existing .env file content
-  let existingEnvContent = "";
-  if (fs.existsSync(envFilePath)) {
-    existingEnvContent = fs.readFileSync(envFilePath, "utf8");
+  generateKeys(
+    walletKey?: string,
+    encryptionKey?: string,
+  ): {
+    walletKey: string;
+    encryptionKey: string;
+    encryptionKeyBytes: Uint8Array;
+  } {
+    encryptionKey =
+      encryptionKey ??
+      process.env["ENCRYPTION_KEY" + this.suffix] ??
+      toHex(getRandomValues(new Uint8Array(32)));
+
+    if (!encryptionKey.startsWith("0x")) {
+      encryptionKey = "0x" + encryptionKey;
+    }
+    const encryptionKeyBytes = new Uint8Array(
+      toBytes(encryptionKey as `0x${string}`),
+    );
+
+    walletKey =
+      walletKey ??
+      process.env["WALLET_KEY" + this.suffix] ??
+      toHex(getRandomValues(new Uint8Array(32)));
+
+    if (!walletKey.startsWith("0x")) {
+      walletKey = "0x" + walletKey;
+    }
+    return { walletKey, encryptionKey, encryptionKeyBytes };
   }
 
-  // Check if the keys already exist
-  if (
-    !existingEnvContent.includes(`ENCRYPTION_KEY${suffix}=`) &&
-    !existingEnvContent.includes(`WALLET_KEY${suffix}=`)
-  ) {
-    fs.appendFileSync(envFilePath, envContent);
+  saveKeys(walletKey: string, encryptionKey: string) {
+    const envFilePath = path.resolve(process.cwd(), ".env");
+    const envContent = `\nENCRYPTION_KEY${this.suffix}=${encryptionKey}\nWALLET_KEY${this.suffix}=${walletKey}`;
+
+    // Read the existing .env file content
+    let existingEnvContent = "";
+    if (fs.existsSync(envFilePath)) {
+      existingEnvContent = fs.readFileSync(envFilePath, "utf8");
+    }
+
+    // Check if the keys already exist
+    if (
+      !existingEnvContent.includes(`ENCRYPTION_KEY${this.suffix}=`) &&
+      !existingEnvContent.includes(`WALLET_KEY${this.suffix}=`)
+    ) {
+      fs.appendFileSync(envFilePath, envContent);
+    }
   }
 }
+
+export default KeyManager;

examples/gated-group/src/xmtp.ts

@@ -6,8 +6,7 @@ import {
   type DecodedMessage,
 } from "@xmtp/node-sdk";
 import dotenv from "dotenv";
-import { toBytes } from "viem";
-import { generateKeys, saveKeys } from "./keys.js";
+import KeyManager from "./keys.js";
 import { createSigner, createUser } from "./viem.js";
 
 dotenv.config();
@@ -25,8 +24,13 @@ export async function createClient({
   options?: ClientOptions;
   streamMessageCallback?: (message: DecodedMessage) => Promise<void>;
 }): Promise<Client> {
-  const { walletKey: clientWalletKey, encryptionKey: clientEncryptionKey } =
-    generateKeys(walletKey, encryptionKey, suffix);
+  const keyManager = new KeyManager(suffix);
+
+  const {
+    walletKey: clientWalletKey,
+    encryptionKey: clientEncryptionKey,
+    encryptionKeyBytes: clientEncryptionKeyBytes,
+  } = keyManager.generateKeys(walletKey, encryptionKey);
 
   const user = createUser(clientWalletKey);
 
@@ -45,14 +49,14 @@ export async function createClient({
 
   const client = await Client.create(
     createSigner(user),
-    new Uint8Array(toBytes(encryptionKey as `0x${string}`)),
+    clientEncryptionKeyBytes,
     clientConfig,
   );
 
   if (streamMessageCallback) {
     void streamMessages(streamMessageCallback, client);
   }
-  saveKeys(clientWalletKey, clientEncryptionKey, suffix);
+  keyManager.saveKeys(clientWalletKey, clientEncryptionKey);
   return client;
 }
 

package.json

@@ -14,6 +14,8 @@
     "examples": "node scripts/examples.js",
     "format": "prettier -w .",
     "format:check": "prettier -c .",
+    "gated": "cd examples/gated-group && yarn dev",
+    "gm": "cd examples/gm && yarn dev",
     "lint": "yarn build && eslint .",
     "publish": "yarn build && changeset publish",
     "test": "FORCE_COLOR=1 turbo run test",