create-message-kit 1.2.26 → 1.2.29

package/index.js

@@ -7,7 +7,7 @@ import { default as fs } from "fs-extra";
 import { isCancel } from "@clack/prompts";
 import { detect } from "detect-package-manager";
 import pc from "picocolors";
-const defVersion = "1.2.26";
+const defVersion = "1.2.29";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -49,6 +49,8 @@ Powered by XMTP`;
       // Create .gitignore
       createGitignore(destDir);
 
+      // Create .data directory
+      createDataDir(destDir);
       // Create .env file
       createEnvFile(destDir);
 
@@ -77,6 +79,12 @@ Powered by XMTP`;
 
 program.parse(process.argv);
 
+async function createDataDir(destDir) {
+  if (!fs.existsSync(resolve(destDir, ".data"))) {
+    fs.mkdirSync(resolve(destDir, ".data"));
+  }
+}
+
 async function updatePackagejson(destDir, templateType) {
   // Remove 'templates/' prefix if it exists in templateType
   const cleanTemplatePath = templateType.replace("templates/", "");
@@ -105,6 +113,10 @@ async function gatherProjectInfo() {
       value: "templates/ens",
       label: "ENS - Template with ENS integration",
     },
+    {
+      value: "templates/paymentagent",
+      label: "Payment Agent - Template for funding an agent wallet",
+    },
   ];
 
   const templateType = await select({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.2.26",
+  "version": "1.2.29",
   "license": "MIT",
   "type": "module",
   "main": "index.js",

package/templates/ens/.cursorrules

@@ -6,7 +6,7 @@
 
 
 import { ensUrl } from "../index.js";
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
 // Define Skill
@@ -25,7 +25,7 @@ export const checkDomain: Skill[] = [
 ];
 
 // Handler Implementation
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -34,7 +34,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await context.getUserInfo(domain);
+  const data = await getUserInfo(domain);
 
   if (!data?.address) {
     let message = `Looks like ${domain} is available! Here you can register it: ${ensUrl}${domain} or would you like to see some cool alternatives?`;
@@ -55,7 +55,7 @@ export async function handler(context: XMTPContext) {
 ### Generate a payment request
 
 
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
 // Define Skill
@@ -92,7 +92,7 @@ export const paymentRequest: Skill[] = [
 ];
 
 // Handler Implementation
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -102,14 +102,14 @@ export async function handler(context: XMTPContext) {
   } = context;
   let receiverAddress = address;
   if (username) {
-    receiverAddress = (await context.getUserInfo(username))?.address;
+    receiverAddress = (await getUserInfo(username))?.address;
   }
   if (address) {
     // Prioritize address over username
     receiverAddress = address;
   }
 
-  await context.requestPayment(receiverAddress, amount, token);
+  await context.framekit.requestPayment(receiverAddress, amount, token);
 }
 
 
@@ -125,12 +125,12 @@ Each app consists of the following files:
 agent/
 ├── src/
 │   └── index.ts
-│   └── prompt.ts
-│   └── plugins/
+│   └── prompt.ts # Optional
+│   └── plugins/ # Optional
 │       └── ...
-│   └── skills/
+│   └── skills/ # Optional
 │       └── ...
-│   └── vibes/
+│   └── vibes/ # Optional
 │       └── ...
 ├── tsconfig.json
 ├── package.json
@@ -142,14 +142,14 @@ agent/
 This is the main function that runs the listener.
 
 ```jsx
-import { Agent, run, XMTPContext } from "@xmtp/message-kit";
+import { Agent, run, Context } from "@xmtp/message-kit";
 
 const agent: Agent = {
   name: "Agent Name",
   tag: "@bot",
   description: "Agent Description",
   skills: [skill1, skill2],
-  onMessage: async (context: XMTPContext) => {
+  onMessage: async (context: Context) => {
         /* Logs every message in a conversation.
         If not declared, the agent will automatically use the defined skills.
         Alternatively, you can implement your own logic here. */

package/templates/ens/src/index.ts

@@ -1,5 +1,4 @@
 import { run, Agent } from "@xmtp/message-kit";
-import { systemPrompt } from "./prompt.js";
 import { checkDomain } from "./skills/check.js";
 import { cool } from "./skills/cool.js";
 import { info } from "./skills/info.js";
@@ -12,7 +11,6 @@ export const agent: Agent = {
   tag: "@bot",
   description: "A ens agent with a lot of skills.",
   skills: [checkDomain, cool, info, register, renew, pay],
-  systemPrompt: systemPrompt,
 };
 
 run(agent);

package/templates/ens/src/skills/check.ts

@@ -1,5 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import type { Skill } from "@xmtp/message-kit";
+import { Context, getUserInfo, Skill } from "@xmtp/message-kit";
 
 const ensUrl = "https://app.ens.domains/";
 
@@ -20,7 +19,7 @@ export const checkDomain: Skill[] = [
 // [!endregion define]
 
 // [!region handle]
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -29,7 +28,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await context.getUserInfo(domain);
+  const data = await getUserInfo(domain);
 
   if (!data?.address) {
     let message = `Looks like ${domain} is available! Here you can register it: ${ensUrl}${domain} or would you like to see some cool alternatives?`;

package/templates/ens/src/skills/cool.ts

@@ -1,4 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
@@ -15,7 +15,7 @@ export const cool: Skill[] = [
     },
   },
 ];
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {

package/templates/ens/src/skills/info.ts

@@ -1,6 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
-
-import type { Skill } from "@xmtp/message-kit";
+import { Context, getUserInfo, Skill } from "@xmtp/message-kit";
 
 // [!region define]
 export const info: Skill[] = [
@@ -26,7 +24,7 @@ export const info: Skill[] = [
 // [!endregion define]
 
 // [!region handle]
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       sender,
@@ -36,7 +34,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await context.getUserInfo(domain);
+  const data = await getUserInfo(domain);
   if (!data?.address) {
     return {
       code: 404,

package/templates/ens/src/skills/pay.ts

@@ -1,5 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import type { Skill } from "@xmtp/message-kit";
+import { Context, getUserInfo, Skill } from "@xmtp/message-kit";
 
 export const pay: Skill[] = [
   {
@@ -44,7 +43,7 @@ export const pay: Skill[] = [
     },
   },
 ];
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -55,7 +54,7 @@ export async function handler(context: XMTPContext) {
   } = context;
   let receiverAddress = address;
   if (username) {
-    receiverAddress = (await context.getUserInfo(username))?.address;
+    receiverAddress = (await getUserInfo(username))?.address;
   }
   if (address) {
     //Prioritize address over username
@@ -63,10 +62,8 @@ export async function handler(context: XMTPContext) {
   }
   if (skill === "tip") {
     let tipAmount = 1;
-    await context.send("Sure, here is the tip link: ");
-    await context.requestPayment(receiverAddress, tipAmount);
+    await context.framekit.requestPayment(receiverAddress, tipAmount);
   } else if (skill === "pay") {
-    await context.send("Sure, here is the payment link: ");
-    await context.requestPayment(receiverAddress, amount, token);
+    await context.framekit.requestPayment(receiverAddress, amount, token);
   }
 }

package/templates/ens/src/skills/register.ts

@@ -1,4 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 
 const ensUrl = "https://app.ens.domains/";
 import type { Skill } from "@xmtp/message-kit";
@@ -18,7 +18,7 @@ export const register: Skill[] = [
   },
 ];
 
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {

package/templates/ens/src/skills/renew.ts

@@ -1,6 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
-
-import type { Skill } from "@xmtp/message-kit";
+import { Context, getUserInfo, Skill } from "@xmtp/message-kit";
 
 const frameUrl = "https://ens.steer.fun/";
 
@@ -19,7 +17,7 @@ export const renew: Skill[] = [
   },
 ];
 
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       sender,
@@ -37,7 +35,7 @@ export async function handler(context: XMTPContext) {
     };
   }
 
-  const data = await context.getUserInfo(domain);
+  const data = await getUserInfo(domain);
 
   if (!data?.address || data?.address !== sender?.address) {
     return {

package/templates/paymentagent/.cursorrules

@@ -0,0 +1,209 @@
+# MessageKit
+
+# Skill Examples
+
+### Check if a Domain is Available
+
+
+import { ensUrl } from "../index.js";
+import { Context } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+// Define Skill
+export const checkDomain: Skill[] = [
+  {
+    skill: "check",
+    handler: handler,
+    examples: ["/check vitalik.eth", "/check fabri.base.eth"],
+    description: "Check if a domain is available.",
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+
+// Handler Implementation
+export async function handler(context: Context) {
+  const {
+    message: {
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+
+  const data = await getUserInfo(domain);
+
+  if (!data?.address) {
+    let message = `Looks like ${domain} is available! Here you can register it: ${ensUrl}${domain} or would you like to see some cool alternatives?`;
+    return {
+      code: 200,
+      message,
+    };
+  } else {
+    let message = `Looks like ${domain} is already registered!`;
+    await context.executeSkill("/cool " + domain);
+    return {
+      code: 404,
+      message,
+    };
+  }
+}
+
+### Generate a payment request
+
+
+import { Context } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+// Define Skill
+export const paymentRequest: Skill[] = [
+  {
+    skill: "pay",
+    examples: [
+      "/pay 10 vitalik.eth",
+      "/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03",
+    ],
+    description:
+      "Send a specified amount of a cryptocurrency to a destination address. \nWhen tipping, you can assume it's 1 USDC.",
+    handler: handler,
+    params: {
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
+      },
+      username: {
+        default: "",
+        type: "username",
+      },
+      address: {
+        default: "",
+        type: "address",
+      },
+    },
+  },
+];
+
+// Handler Implementation
+export async function handler(context: Context) {
+  const {
+    message: {
+      content: {
+        params: { amount, token, username, address },
+      },
+    },
+  } = context;
+  let receiverAddress = address;
+  if (username) {
+    receiverAddress = (await getUserInfo(username))?.address;
+  }
+  if (address) {
+    // Prioritize address over username
+    receiverAddress = address;
+  }
+
+  await context.framekit.requestPayment(receiverAddress, amount, token);
+}
+
+
+# Docs
+
+# Structure
+
+## File structure
+
+Each app consists of the following files:
+
+```
+agent/
+├── src/
+│   └── index.ts
+│   └── prompt.ts # Optional
+│   └── plugins/ # Optional
+│       └── ...
+│   └── skills/ # Optional
+│       └── ...
+│   └── vibes/ # Optional
+│       └── ...
+├── tsconfig.json
+├── package.json
+└── .env
+```
+
+## Agent
+
+This is the main function that runs the listener.
+
+```jsx
+import { Agent, run, Context } from "@xmtp/message-kit";
+
+const agent: Agent = {
+  name: "Agent Name",
+  tag: "@bot",
+  description: "Agent Description",
+  skills: [skill1, skill2],
+  onMessage: async (context: Context) => {
+        /* Logs every message in a conversation.
+        If not declared, the agent will automatically use the defined skills.
+        Alternatively, you can implement your own logic here. */
+    },
+  config: {
+    // Optional parameters
+  },
+};
+//starts the agent
+run(agent);
+```
+
+#### Config parameters
+
+- `privateKey`: the private key of the agent wallet, like any normal wallet private key.
+- `experimental`: experimental features like logging all group messages. Default is `false`.
+- `attachments`: to receive attachments. Default is `false`.
+- `gptModel`: model to be used. Default is `gpt-4o`.
+- `client`: Optional parameters to pass to the XMTP client.
+- `agent`: Custom agent to be used. Default is to create the skills in the `src/skills.ts` file.
+- `hideInitLogMessage`: hide the init log message with messagekit logo and stuff
+- `memberChange`: if true, member changes will be enabled, like adding members to the group
+
+## Skills
+
+Skills are the actions of the agent. They are defined in the `src/skills/your-skill.ts` file.
+
+```tsx
+import { Skill } from "@xmtp/message-kit";
+
+export const checkDomain: Skill[] = [
+  {
+    skill: // name of the skill
+    handler: // function to handle the skill
+    examples: // examples of the skill
+    description: // description of the skill
+    params: // params of the skill
+  },
+];
+```
+
+## Vibes
+
+Vibes are the personalities of the agent. They are defined in the `src/vibes/your-vibe.ts` file.
+
+```tsx
+import { Vibe } from "@xmtp/message-kit";
+
+export const chill: Vibe = {
+  vibe: // name of the vibe
+  description: // description of the vibe
+  tone: // tone of the vibe
+  style: // style of the vibe
+};
+```
+
+> See [Vibes](/community/vibes) for more information.

package/templates/paymentagent/.env.example

@@ -0,0 +1,2 @@
+KEY= # the private key of the agent wallet
+TEST_ENCRYPTION_KEY= # a different private key for encryption

package/templates/paymentagent/.yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableTelemetry: false
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.5.1.cjs

package/templates/paymentagent/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "paymentagent",
+  "private": true,
+  "description": "A human agent for managing your funds",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && NODE_NO_WARNINGS=1 node --watch dist/index.js",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/paymentagent/src/index.ts

@@ -0,0 +1,19 @@
+import { run, Agent, concierge } from "@xmtp/message-kit";
+import { degen } from "./vibes/degen.js";
+import { systemPrompt } from "./prompt.js";
+
+const agent: Agent = {
+  name: "Human Agent",
+  tag: "@bot",
+  description: "An agent that performs payments and transfers in usdc. .",
+  intro:
+    "You are a helpful agent called {agent_name} that helps people with their agent wallets. You can help them fund their wallets, check their balance and making transfers. All in usdc.",
+  vibe: degen,
+  systemPrompt,
+  skills: [concierge],
+  config: {
+    walletService: true,
+  },
+};
+
+run(agent);

package/templates/{ens → paymentagent}/src/prompt.ts

@@ -1,4 +1,5 @@
-export const systemPrompt = `
+export const systemPrompt = `{intro}
+
 {vibe}
 
 {rules}
@@ -6,6 +7,4 @@ export const systemPrompt = `
 {user_context}
 
 {skills}
-
-{issues}
 `;

package/templates/paymentagent/src/vibes/degen.ts

@@ -0,0 +1,10 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const degen: Vibe = {
+  vibe: "Degen",
+  description:
+    "A high-energy, risk-embracing personality from the crypto trading world. This vibe combines technical knowledge with meme culture, FOMO-driven enthusiasm, and an 'apes together strong' mentality. Always bullish, never sleeping, and ready to APE into the next big thing.",
+  tone: "enthusiastic and bold, like a trader who just discovered a 100x gem at 3AM",
+  style:
+    "casual and meme-heavy, peppered with crypto slang like 'gm', 'wagmi', and 'probably nothing', while maintaining genuine helpfulness",
+};

package/templates/simple/.cursorrules

@@ -6,7 +6,7 @@
 
 
 import { ensUrl } from "../index.js";
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
 // Define Skill
@@ -25,7 +25,7 @@ export const checkDomain: Skill[] = [
 ];
 
 // Handler Implementation
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -34,7 +34,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await context.getUserInfo(domain);
+  const data = await getUserInfo(domain);
 
   if (!data?.address) {
     let message = `Looks like ${domain} is available! Here you can register it: ${ensUrl}${domain} or would you like to see some cool alternatives?`;
@@ -55,7 +55,7 @@ export async function handler(context: XMTPContext) {
 ### Generate a payment request
 
 
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
 // Define Skill
@@ -92,7 +92,7 @@ export const paymentRequest: Skill[] = [
 ];
 
 // Handler Implementation
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
@@ -102,14 +102,14 @@ export async function handler(context: XMTPContext) {
   } = context;
   let receiverAddress = address;
   if (username) {
-    receiverAddress = (await context.getUserInfo(username))?.address;
+    receiverAddress = (await getUserInfo(username))?.address;
   }
   if (address) {
     // Prioritize address over username
     receiverAddress = address;
   }
 
-  await context.requestPayment(receiverAddress, amount, token);
+  await context.framekit.requestPayment(receiverAddress, amount, token);
 }
 
 
@@ -125,12 +125,12 @@ Each app consists of the following files:
 agent/
 ├── src/
 │   └── index.ts
-│   └── prompt.ts
-│   └── plugins/
+│   └── prompt.ts # Optional
+│   └── plugins/ # Optional
 │       └── ...
-│   └── skills/
+│   └── skills/ # Optional
 │       └── ...
-│   └── vibes/
+│   └── vibes/ # Optional
 │       └── ...
 ├── tsconfig.json
 ├── package.json
@@ -142,14 +142,14 @@ agent/
 This is the main function that runs the listener.
 
 ```jsx
-import { Agent, run, XMTPContext } from "@xmtp/message-kit";
+import { Agent, run, Context } from "@xmtp/message-kit";
 
 const agent: Agent = {
   name: "Agent Name",
   tag: "@bot",
   description: "Agent Description",
   skills: [skill1, skill2],
-  onMessage: async (context: XMTPContext) => {
+  onMessage: async (context: Context) => {
         /* Logs every message in a conversation.
         If not declared, the agent will automatically use the defined skills.
         Alternatively, you can implement your own logic here. */

package/templates/simple/src/index.ts

@@ -1,30 +1,13 @@
 // [!region index]
-import {
-  run,
-  agentReply,
-  parsePrompt,
-  XMTPContext,
-  Agent,
-} from "@xmtp/message-kit";
-import { systemPrompt } from "./prompt.js";
+import { run, agentReply, Context, Agent } from "@xmtp/message-kit";
 
 export const agent: Agent = {
   name: "GPT Bot",
-  tag: "@bot",
   description: "Use GPT to generate text responses.",
-  onMessage: async (context: XMTPContext) => {
-    const {
-      message: {
-        sender,
-        content: { text },
-      },
-      agent,
-    } = context;
+  tag: "@bot",
+  onMessage: async (context: Context) => {
     // [!endregion index]
-
-    let prompt = await parsePrompt(systemPrompt, sender.address, agent);
-    await agentReply(context, prompt);
-
+    await agentReply(context);
     // [!region final]
   },
 };

package/templates/simple/src/prompt.ts

@@ -1,9 +0,0 @@
-export const systemPrompt = `
-You are a helpful and playful agent called {agent_name} that lives inside a web3 messaging app called Converse.
-
-{rules}
-
-{user_context}
-
-{issues}
-`;