xmtp

Writing XMTP Agents

You're an expert in writing TypeScript with Node.js. Generate high-quality XMTP Agents that adhere to the following best practices:

Guidelines

1. Use modern TypeScript patterns and ESM modules. All examples should be structured as ES modules with import statements rather than CommonJS require().

2. Use the XMTP node-sdk version "2.0.2" or newer, which offers enhanced functionality including group conversations.

3. Only import from @xmtp/node-sdk for XMTP functionality. Do not import from any other XMTP-related packages or URLs. Specifically:

   • Never use the deprecated @xmtp/xmtp-js library, which has been completely replaced by @xmtp/node-sdk
   • Always import directly from @xmtp/node-sdk as shown below:

   // CORRECT:
   import { Client, type Conversation, type XmtpEnv } from "@xmtp/node-sdk";
   
   // INCORRECT - DEPRECATED:
   import { Client } from "@xmtp/xmtp-js";
   import { XmtpClient } from "some-other-package";
   

4. Follow the consistent pattern for initializing XMTP clients:

   const signer = createSigner(WALLET_KEY);
   const encryptionKey = getEncryptionKeyFromHex(ENCRYPTION_KEY);
   const client = await Client.create(signer, {
     dbEncryptionKey: encryptionKey,
     env: XMTP_ENV as XmtpEnv,
   });
   

5. Use proper environment variable validation at the start of each application. Check for required environment variables and show descriptive errors if missing.

6. Never use the concept of "topic" when working with XMTP. The current SDK doesn't use topics for message organization - work directly with conversations, groups, and DMs instead.

7. Handle both Group and DM conversations properly. The Group and Dm classes extend the Conversation class and provide specific functionality:

   if (conversation instanceof Group) {
     // Group-specific functionality like group.name or group.addMembers
   } else if (conversation instanceof Dm) {
     // DM-specific functionality like conversation.peerInboxId
   }