gm comments

Author: humanagent

examples/gm/README.md

@@ -6,7 +6,7 @@ This agent replies `gm`
 
 ![](/media/gm.png)
 
-## Basic usage
+## Overview
 
 ```tsx
 import { Client, type XmtpEnv } from "@xmtp/node-sdk";
@@ -22,26 +22,32 @@ if (!ENCRYPTION_KEY) {
   throw new Error("ENCRYPTION_KEY must be set");
 }
 
+/* Create the signer using viem and parse the encryption key for the local db */
 const signer = createSigner(WALLET_KEY);
 const encryptionKey = getEncryptionKeyFromHex(ENCRYPTION_KEY);
 
+/* Set the environment to dev or production */
 const env: XmtpEnv = "dev";
 
 async function main() {
   console.log(`Creating client on the '${env}' network...`);
+  /* Initialize the xmtp client */
   const client = await Client.create(signer, encryptionKey, { env });
 
   console.log("Syncing conversations...");
+  /* Sync the conversations from the network to update the local db */
   await client.conversations.sync();
 
   console.log(
     `Agent initialized on ${client.accountAddress}\nSend a message on http://xmtp.chat/dm/${client.accountAddress}?env=${env}`,
   );
 
   console.log("Waiting for messages...");
+  /* Stream all messages from the network */
   const stream = client.conversations.streamAllMessages();
 
   for await (const message of await stream) {
+    /* Ignore messages from the same agent or non-text messages */
     if (
       message?.senderInboxId.toLowerCase() === client.inboxId.toLowerCase() ||
       message?.contentType?.typeId !== "text"
@@ -53,6 +59,7 @@ async function main() {
       `Received message: ${message.content as string} by ${message.senderInboxId}`,
     );
 
+    /* Get the conversation by id */
     const conversation = client.conversations.getConversationById(
       message.conversationId,
     );
@@ -63,6 +70,7 @@ async function main() {
     }
 
     console.log(`Sending "gm" response...`);
+    /* Send a message to the conversation */
     await conversation.send("gm");
 
     console.log("Waiting for messages...");

examples/gm/index.ts

@@ -36,7 +36,7 @@ async function main() {
   const stream = client.conversations.streamAllMessages();
 
   for await (const message of await stream) {
-    /* Ignore messages from the same account or non-text messages */
+    /* Ignore messages from the same agent or non-text messages */
     if (
       message?.senderInboxId.toLowerCase() === client.inboxId.toLowerCase() ||
       message?.contentType?.typeId !== "text"