GPT Readme (#16)

* readme

* polished readme

* fix copy

Author: humanagent

.env.example

@@ -1,2 +1,5 @@
 WALLET_KEY= # the private key of the wallet
-ENCRYPTION_KEY= # a second random 32 bytes encryption key for local db encryption
+ENCRYPTION_KEY= # a second random 32 bytes encryption key for local db encryption
+
+# GPT agent example
+OPENAI_API_KEY= # the API key for the OpenAI API

environment.d.ts

@@ -3,6 +3,7 @@ declare global {
     interface ProcessEnv {
       WALLET_KEY: `0x${string}` | undefined;
       ENCRYPTION_KEY: string | undefined;
+      OPENAI_API_KEY: string | undefined;
     }
   }
 }

examples/gpt/README.md

@@ -0,0 +1,123 @@
+# GPT agent example
+
+This example uses the [OpenAI](https://openai.com) API for GPT-based responses and [XMTP](https://xmtp.org) for secure messaging. You can test your agent on [xmtp.chat](https://xmtp.chat) or any other XMTP-compatible client.
+
+## Environment variables
+
+Add the following keys to a `.env` file:
+
+```bash
+WALLET_KEY= # the private key of the wallet
+ENCRYPTION_KEY= # a second random 32 bytes encryption key for local db encryption
+OPENAI_API_KEY= # the API key for the OpenAI API
+```
+
+You can generate random keys with the following command:
+
+```bash
+yarn gen:keys
+```
+
+> [!WARNING]
+> Running the `gen:keys` script will overwrite the existing `.env` file.
+
+## Usage
+
+```tsx
+import { ContentTypeText } from "@xmtp/content-type-text";
+import { Client, type XmtpEnv } from "@xmtp/node-sdk";
+import OpenAI from "openai";
+import { createSigner, getEncryptionKeyFromHex } from "@/helpers";
+
+const { WALLET_KEY, ENCRYPTION_KEY, OPENAI_API_KEY } = process.env;
+
+if (!WALLET_KEY) {
+  throw new Error("WALLET_KEY must be set");
+}
+
+if (!ENCRYPTION_KEY) {
+  throw new Error("ENCRYPTION_KEY must be set");
+}
+
+if (!OPENAI_API_KEY) {
+  throw new Error("OPENAI_API_KEY must be set");
+}
+
+const signer = createSigner(WALLET_KEY);
+const encryptionKey = getEncryptionKeyFromHex(ENCRYPTION_KEY);
+const openai = new OpenAI({ apiKey: OPENAI_API_KEY });
+
+const env: XmtpEnv = "dev";
+
+async function main() {
+  console.log(`Creating client on the '${env}' network...`);
+  const client = await Client.create(signer, encryptionKey, {
+    env,
+  });
+
+  console.log("Syncing conversations...");
+  await client.conversations.sync();
+
+  console.log(
+    `Agent initialized on ${client.accountAddress}\nSend a message on http://xmtp.chat/dm/${client.accountAddress}`,
+  );
+
+  console.log("Waiting for messages...");
+  const stream = client.conversations.streamAllMessages();
+
+  for await (const message of await stream) {
+    if (
+      !message ||
+      !message.contentType ||
+      !ContentTypeText.sameAs(message.contentType)
+    ) {
+      console.log("Invalid message, skipping", message);
+      continue;
+    }
+
+    // Ignore own messages
+    if (message.senderInboxId === client.inboxId) {
+      continue;
+    }
+
+    console.log(
+      `Received message: ${message.content as string} by ${message.senderInboxId}`,
+    );
+
+    const conversation = client.conversations.getConversationById(
+      message.conversationId,
+    );
+
+    if (!conversation) {
+      console.log("Unable to find conversation, skipping");
+      continue;
+    }
+
+    try {
+      const completion = await openai.chat.completions.create({
+        messages: [{ role: "user", content: message.content as string }],
+        model: "gpt-3.5-turbo",
+      });
+
+      const response =
+        completion.choices[0]?.message?.content ||
+        "I'm not sure how to respond to that.";
+      console.log(`Sending AI response: ${response}`);
+      await conversation.send(response);
+    } catch (error) {
+      console.error("Error getting AI response:", error);
+      await conversation.send(
+        "Sorry, I encountered an error processing your message.",
+      );
+    }
+
+    console.log("Waiting for messages...");
+  }
+}
+
+main().catch(console.error);
+```
+
+Run the agent and send a test message from [xmtp.chat](https://xmtp.chat).
+
+Enjoy your GPT-powered XMTP agent!