push

Author: humanagent

README.md

@@ -21,9 +21,10 @@ To run your XMTP agent, you must create a `.env` file with the following variabl
 ```tsx
 WALLET_KEY= # the private key of the wallet
 ENCRYPTION_KEY= # encryption key for the local database
+XMTP_ENV= # local, dev, production
 ```
 
-You can generate random keys with the following command:
+You can generate random xmtp keys with the following command:
 
 ```tsx
 yarn gen:keys <name>
@@ -125,18 +126,11 @@ Interact with the XMTP network using [xmtp.chat](https://xmtp.chat), the officia
 
 ## Examples
 
-- [gm](/examples/gm/): A simple agent that replies to all text messages with "gm".
+- [gm](/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
 
 > See all the available [examples](/examples/).
-
-### Integrations
-
-Examples integrating XMTP with external libraries from the ecosystem
-
-- [grok](/integrations/grok/): Integrate your agent with the Grok API
-- [gaia](/integrations/gaia/): Integrate with the Gaia API
-- [coinbase-langchain](/integrations/coinbase-langchain/): Agent that uses a CDP for gassless USDC on base
-
-> See all the available [integrations](/integrations/).

integrations/README.md examples/README.md

@@ -1,6 +1,6 @@
-# How to contribute an XMTP integration
+# How to contribute an XMTP example
 
-This guide explains how to help develop or improve an integration using the XMTP protocol.
+This guide explains how to help develop or improve an example using the XMTP protocol.
 
 ## Prerequisites
 
@@ -28,15 +28,15 @@ This guide explains how to help develop or improve an integration using the XMTP
    Make a new branch for your changes.
 
    ```bash
-   git checkout -b integration/your-integration-name
+   git checkout -b example/your-example-name
    ```
 
 4. **Install dependencies**
 
-   Go to the integration directory and install packages.
+   Go to the example directory and install packages.
 
    ```bash
-   cd integrations/your-integration
+   cd examples/your-example
    yarn
    ```
 
@@ -46,7 +46,7 @@ This guide explains how to help develop or improve an integration using the XMTP
 
 6. **Test changes**
 
-   Run the integration to check your changes.
+   Run the example to check your changes.
 
    ```bash
    yarn dev
@@ -58,15 +58,15 @@ This guide explains how to help develop or improve an integration using the XMTP
 
    ```bash
    git add .
-   git commit -m "Add integration: description of your integration"
+   git commit -m "Add example: description of your example"
    ```
 
 8. **Push changes**
 
    Send your changes to your forked repository.
 
    ```bash
-   git push origin integration/your-integration-name
+   git push origin example/your-example-name
    ```
 
 ## Submit a Pull Request

integrations/coinbase-langchain/.env.example examples/coinbase-langchain/.env.example

@@ -7,7 +7,7 @@ A DeFi agent built using Langchain and powered by CDP SDK, operating over the XM
 - Process blockchain payments using natural language commands
 - Advanced language processing using LangChain and OpenAI
 - User-specific wallet management with flexible storage options (Redis or local file)
-- XMTP messaging integration for secure, decentralized chat interactions
+- XMTP messaging for secure, decentralized chat interactions
 - Powered by CDP SDK for reliable blockchain operations and Langchain for AI Agent
 
 ## Prerequisites
@@ -26,7 +26,7 @@ Follow these steps to get your x agent up and running:
 
    ```bash
    git clone https://github.com/ephemeraHQ/xmtp-agent-examples.git
-   cd integrations/coinbase-langchain
+   cd examples/coinbase-langchain
    ```
 
 2. **Install dependencies**:

integrations/coinbase-langchain/README.md examples/coinbase-langchain/README.md

@@ -0,0 +1,26 @@
+{
+  "name": "coinbase-langchain",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx  src/index.ts",
+    "gen:keys": "tsx ../../scripts/generateKeys.ts",
+    "lint": "cd ../.. && yarn eslint examples/coinbase-langchain"
+  },
+  "dependencies": {
+    "@coinbase/agentkit": "^0.2.0",
+    "@coinbase/agentkit-langchain": "^0.2.0",
+    "@langchain/core": "^0.3.20",
+    "@langchain/langgraph": "^0.2.24",
+    "@langchain/openai": "^0.3.14",
+    "@redis/client": "^1.6.0",
+    "@xmtp/node-sdk": "1.0.0",
+    "redis": "^4.7.0"
+  },
+  "devDependencies": {
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.3"
+  }
+}

examples/coinbase-langchain/package.json

@@ -7,6 +7,7 @@ import {
 } from "@coinbase/coinbase-sdk";
 import { isAddress } from "viem";
 import { getWalletData, saveWalletData } from "./storage";
+import type { XMTPUser } from "./types";
 
 const coinbaseApiKeyName = process.env.CDP_API_KEY_NAME;
 let coinbaseApiKeyPrivateKey = process.env.CDP_API_KEY_PRIVATE_KEY;
@@ -92,11 +93,11 @@ export class WalletService {
   private inboxId: string;
   private sdkInitialized: boolean;
 
-  constructor(inboxId: string, address: string) {
+  constructor(xmtpUser: XMTPUser) {
     this.sdkInitialized = initializeCoinbaseSDK();
     this.walletStorage = new WalletStorage();
-    this.humanAddress = address;
-    this.inboxId = inboxId;
+    this.humanAddress = xmtpUser.address;
+    this.inboxId = xmtpUser.inboxId;
     console.log(
       "WalletService initialized with sender address",
       this.humanAddress,

integrations/coinbase-langchain/src/cdp.ts examples/coinbase-langchain/src/cdp.ts

@@ -1,8 +1,9 @@
-import type { Conversation, DecodedMessage } from "@xmtp/node-sdk";
 import "dotenv/config";
+import type { Conversation, DecodedMessage } from "@xmtp/node-sdk";
 import { getAddressOfMember } from "@/helpers";
 import { initializeAgent, processMessage } from "./langchain";
 import { initializeStorage as initStorage } from "./storage";
+import type { XMTPUser } from "./types";
 import { initializeXmtpClient, startMessageListener } from "./xmtp";
 
 /**
@@ -51,8 +52,12 @@ async function handleMessage(
     console.log("Unable to find address, skipping");
     return;
   }
+  const xmtpUser: XMTPUser = {
+    inboxId,
+    address,
+  };
   // Initialize or get the agent for this user
-  const { agent, config } = await initializeAgent(inboxId, address);
+  const { agent, config } = await initializeAgent(xmtpUser);
 
   // Process the message with the agent
   const response = await processMessage(

integrations/coinbase-langchain/src/index.ts examples/coinbase-langchain/src/index.ts

@@ -5,40 +5,19 @@ import { createReactAgent } from "@langchain/langgraph/prebuilt";
 import { ChatOpenAI } from "@langchain/openai";
 import { z } from "zod";
 import { WalletService } from "./cdp";
-
-const memoryStore: Record<string, MemorySaver> = {};
-const agentStore: Record<string, Agent> = {};
-
-interface AgentConfig {
-  configurable: {
-    thread_id: string;
-  };
-}
-
-type Agent = ReturnType<typeof createReactAgent>;
-
-// Define transfer result structure
-interface TransferData {
-  model?: {
-    sponsored_send?: {
-      transaction_link?: string;
-    };
-  };
-  transactionLink?: string;
-}
-
-// Define chunk structure for agent stream
-interface AgentChunk {
-  agent?: {
-    messages?: Array<{
-      content?: string;
-    }>;
-  };
-}
-
-function createWalletTools(inboxId: string, address: string) {
+import {
+  agentStore,
+  memoryStore,
+  type Agent,
+  type AgentChunk,
+  type AgentConfig,
+  type TransferData,
+  type XMTPUser,
+} from "./types";
+
+function createWalletTools(xmtpUser: XMTPUser) {
   // Create a properly typed WalletService instance
-  const walletService = new WalletService(inboxId, address);
+  const walletService = new WalletService(xmtpUser);
 
   const getBalanceTool = new DynamicStructuredTool({
     name: "get_wallet_balance",
@@ -47,10 +26,10 @@ function createWalletTools(inboxId: string, address: string) {
     schema: z.object({}),
     func: async () => {
       try {
-        console.log(`Checking balance for fixed inboxId: ${inboxId}`);
-        const result = await walletService.checkBalance(inboxId);
+        console.log(`Checking balance for fixed inboxId: ${xmtpUser.inboxId}`);
+        const result = await walletService.checkBalance(xmtpUser.inboxId);
         if (!result.address) {
-          return `No wallet found for user ${inboxId}`;
+          return `No wallet found for user ${xmtpUser.inboxId}`;
         }
         return `Wallet address: ${result.address}\nUSDC Balance: ${result.balance} USDC`;
       } catch (error: unknown) {
@@ -75,11 +54,13 @@ function createWalletTools(inboxId: string, address: string) {
           return `Error: Invalid amount ${amount}`;
         }
 
-        console.log(`Transferring from ${address} to: ${recipientAddress}`);
+        console.log(
+          `Transferring from ${xmtpUser.address} to: ${recipientAddress}`,
+        );
 
         const result = await walletService.transfer(
-          inboxId,
-          address,
+          xmtpUser.inboxId,
+          xmtpUser.address,
           recipientAddress,
           numericAmount,
         );
@@ -111,50 +92,49 @@ function createWalletTools(inboxId: string, address: string) {
 
 /**
  * Initialize the agent with LangChain and Coinbase SDK
- * @param userId - The user's identifier (XMTP address)
+ * @param inboxId - The user's identifier (XMTP address)
  * @returns Agent executor and config
  */
 export async function initializeAgent(
-  inboxId: string,
-  address: string,
+  xmtpUser: XMTPUser,
 ): Promise<{ agent: Agent; config: AgentConfig }> {
   try {
     // Check if we already have an agent for this user
-    if (inboxId in agentStore) {
-      console.log(`Using existing agent for user: ${inboxId}`);
+    if (xmtpUser.inboxId in agentStore) {
+      console.log(`Using existing agent for user: ${xmtpUser.inboxId}`);
       const agentConfig = {
-        configurable: { thread_id: inboxId },
+        configurable: { thread_id: xmtpUser.inboxId },
       };
-      return { agent: agentStore[inboxId], config: agentConfig };
+      return { agent: agentStore[xmtpUser.inboxId], config: agentConfig };
     }
 
     console.log(
-      `Creating new agent for user with inboxId: ${inboxId} and address: ${address}`,
+      `Creating new agent for user with inboxId: ${xmtpUser.inboxId} and address: ${xmtpUser.address}`,
     );
 
     const llm = new ChatOpenAI({
       model: "gpt-4o-mini",
     });
 
-    const tools = createWalletTools(inboxId, address);
+    const tools = createWalletTools(xmtpUser);
 
-    if (!(inboxId in memoryStore)) {
-      console.log(`Creating new memory store for user: ${inboxId}`);
-      memoryStore[inboxId] = new MemorySaver();
+    if (!(xmtpUser.inboxId in memoryStore)) {
+      console.log(`Creating new memory store for user: ${xmtpUser.inboxId}`);
+      memoryStore[xmtpUser.inboxId] = new MemorySaver();
     } else {
-      console.log(`Using existing memory store for user: ${inboxId}`);
+      console.log(`Using existing memory store for user: ${xmtpUser.inboxId}`);
     }
 
     const agentConfig: AgentConfig = {
-      configurable: { thread_id: inboxId },
+      configurable: { thread_id: xmtpUser.inboxId },
     };
 
     // Make sure we await the agent creation
     const agent = await Promise.resolve(
       createReactAgent({
         llm,
         tools,
-        checkpointSaver: memoryStore[inboxId],
+        checkpointSaver: memoryStore[xmtpUser.inboxId],
         messageModifier: `
         You are a DeFi Agent that assists users with sending payments to any wallet address using natural language instructions.
 
@@ -180,7 +160,7 @@ export async function initializeAgent(
     );
 
     // Store the agent for future use
-    agentStore[inboxId] = agent;
+    agentStore[xmtpUser.inboxId] = agent;
 
     return { agent, config: agentConfig };
   } catch (error: unknown) {

integrations/coinbase-langchain/src/langchain.ts examples/coinbase-langchain/src/langchain.ts

@@ -0,0 +1,36 @@
+import type { MemorySaver } from "@langchain/langgraph";
+import type { createReactAgent } from "@langchain/langgraph/prebuilt";
+
+export const memoryStore: Record<string, MemorySaver> = {};
+export const agentStore: Record<string, Agent> = {};
+
+export type XMTPUser = {
+  inboxId: string;
+  address: string;
+};
+export interface AgentConfig {
+  configurable: {
+    thread_id: string;
+  };
+}
+
+export type Agent = ReturnType<typeof createReactAgent>;
+
+// Define transfer result structure
+export interface TransferData {
+  model?: {
+    sponsored_send?: {
+      transaction_link?: string;
+    };
+  };
+  transactionLink?: string;
+}
+
+// Define chunk structure for agent stream
+export interface AgentChunk {
+  agent?: {
+    messages?: Array<{
+      content?: string;
+    }>;
+  };
+}

integrations/coinbase-langchain/src/storage.ts examples/coinbase-langchain/src/storage.ts

@@ -1,4 +1,3 @@
-import { IdentifierKind } from "@xmtp/node-bindings";
 import {
   Client,
   type Conversation,