Monorepo tweaks

README.md

@@ -39,11 +39,12 @@ yarn gen:keys <name>
 These are the steps to initialize the XMTP listener and send messages.
 
 ```tsx
-import { Client, type XmtpEnv, type Signer } from “@xmtp/node-sdk”;
+// import the xmtp sdk
+import { Client, type XmtpEnv, type Signer } from "@xmtp/node-sdk";
 // encryption key, must be consistent across runs
 const encryptionKey: Uint8Array = ...;
 const signer: Signer = ...;
-const env: XmtpEnv = “dev”;
+const env: XmtpEnv = "dev";
 
 async function main() {
   const client = await Client.create(signer, encryptionKey, { env });
@@ -54,8 +55,7 @@ async function main() {
    if (message?.senderInboxId === client.inboxId ) {
       continue;
     }
-    const conversation = client.conversations.getConversationById(message.conversationId,
-    );
+    const conversation = client.conversations.getConversationById(message.conversationId);
     // send a message from the agent
     await conversation.send("gm");
   }
@@ -65,13 +65,14 @@ main().catch(console.error);
 
 ## Examples
 
-- [gm](/gm/): A simple agent that replies to all text messages with "gm".
+- [gm](/examples/gm/): A simple agent that replies to all text messages with "gm".
 - [gpt](/examples/gpt/): An example using GPT API's to answer messages.
 - [gated-group](/examples/gated-group/): Add members to a group that hold a certain NFT.
-- [grok](/examples/grok/): Integrate your agent with the Grok API
-- [gaia](/examples/gaia/): Integrate with the Gaia API
 - [coinbase-langchain](/examples/coinbase-langchain/): Agent that uses a CDP for gassless USDC on base
 - [cointoss](/examples/cointoss/): Enabling group cointosses with friends inside a group chat
+- [gaia](/examples/gaia/): Integrate with the Gaia API
+
+See all the examples [here](/examples).
 
 ## Development
 

examples/coinbase-langchain/README.md

@@ -9,7 +9,7 @@ A DeFi agent built using Langchain and powered by CDP SDK, operating over the XM
 - Node.js (v20+)
 - [OpenAI](https://platform.openai.com/) API key
 - [Coinbase Developer Platform](https://portal.cdp.coinbase.com) (CDP) API credentials
-- [USDC Faucet](https://portal.cdp.coinbase.com/products/faucet)
+- [USDC Faucet](https://faucet.circle.com/)
 
 ### Environment variables
 

examples/cointoss/README.md

@@ -9,7 +9,7 @@ A coin toss agent built using CDP AgentKit that operates over the XMTP messaging
 - Node.js (v20+)
 - [OpenAI](https://platform.openai.com/) API key
 - [Coinbase Developer Platform](https://portal.cdp.coinbase.com) (CDP) API credentials
-- [USDC Faucet](https://portal.cdp.coinbase.com/products/faucet)
+- [USDC Faucet](https://faucet.circle.com/)
 
 ### Environment variables
 

examples/gm/README.md

@@ -0,0 +1,24 @@
+## GM agent
+
+This agent replies `gm`
+
+> Try XMTP using [xmtp.chat](https://xmtp.chat) and sending a message to `gm.xmtp.eth`
+
+![](./screenshot.png)
+
+[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/template/UCyz5b)
+
+## Run the agent
+
+```bash
+# git clone repo
+git clone https://github.com/ephemeraHQ/xmtp-agent-examples.git
+# go to the folder
+cd xmtp-agent-examples
+# install packages
+yarn
+# generate random xmtp keys (optional)
+yarn gen:keys
+# run the example
+yarn dev
+```

examples/gm/index.ts

@@ -0,0 +1,81 @@
+import "dotenv/config";
+import {
+  createSigner,
+  getAddressOfMember,
+  getEncryptionKeyFromHex,
+} from "@helpers";
+import { Client, type XmtpEnv } from "@xmtp/node-sdk";
+
+/* Get the wallet key associated to the public key of
+ * the agent and the encryption key for the local db
+ * that stores your agent's messages */
+const { WALLET_KEY, ENCRYPTION_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");
+}
+
+/* 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 local, dev or production */
+const env: XmtpEnv = process.env.XMTP_ENV as XmtpEnv;
+
+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();
+
+  const identifier = await signer.getIdentifier();
+  const address = identifier.identifier;
+  console.log(
+    `Agent initialized on ${address}\nSend a message on http://xmtp.chat/dm/${address}?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"
+    ) {
+      continue;
+    }
+
+    console.log(
+      `Received message: ${message.content as string} by ${message.senderInboxId}`,
+    );
+
+    /* Get the conversation by id */
+    const conversation = client.conversations.getDmByInboxId(
+      message.senderInboxId,
+    );
+
+    if (!conversation) {
+      console.log("Unable to find conversation, skipping");
+      continue;
+    }
+    const members = await conversation.members();
+
+    const address = getAddressOfMember(members, message.senderInboxId);
+    console.log(`Sending "gm" response to ${address}...`);
+    /* Send a message to the conversation */
+    await conversation.send("gm");
+
+    console.log("Waiting for messages...");
+  }
+}
+
+main().catch(console.error);

package.json

@@ -11,12 +11,12 @@
     "build:examples": "yarn workspaces foreach --all --include \"examples/*\" run build",
     "clean": "rimraf node_modules && yarn clean:dbs",
     "clean:dbs": "rimraf *.db3* ||:",
-    "dev": "tsx --watch gm/index.ts",
+    "dev": "tsx --watch examples/gm/index.ts",
     "format": "prettier -w .",
     "format:check": "prettier -c .",
     "gen:keys": "tsx scripts/generateKeys.ts",
     "lint": "eslint .",
-    "start": "tsx gm/index.ts",
+    "start": "tsx examples/gm/index.ts",
     "typecheck": "tsc"
   },
   "dependencies": {