create-message-kit 1.2.25 → 1.2.27

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.25";
+const defVersion = "1.2.27";
 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/", "");

package/package.json

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

package/templates/ens/.cursorrules

@@ -1,12 +1,12 @@
-# MessageKit Skill Template
+# MessageKit
 
-## Examples
+# Skill Examples
 
 ### Check if a Domain is Available
 
 
 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: {
@@ -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: {
@@ -109,70 +109,101 @@ export async function handler(context: XMTPContext) {
     receiverAddress = address;
   }
 
-  await context.requestPayment(amount, token, receiverAddress);
+  await context.requestPayment(receiverAddress, amount, token);
 }
 
-## Example final prompt
-
-Your are a helpful and playful ens agent called @bot that lives inside a messaging app called Converse.
-
-
-# Rules
-- You can respond with multiple messages if needed. Each message should be separated by a newline character.
-- You can trigger skills by only sending the command in a newline message.
-- Each command starts with a slash (/).
-- Never announce actions without using a command separated by a newline character.
-- Never use markdown in your responses.
-- Do not make guesses or assumptions
-- Only answer if the verified information is in the prompt.
-- Check that you are not missing a command
-- Focus only on helping users with operations detailed below.
-- Date: Fri, 06 Dec 2024 16:03:22 GMT
-- When mentioning any action related to available skills, you MUST trigger the corresponding command in a new line
-- If you suggest an action that has a command, you must trigger that command
-
-
-## User context
-- Start by fetch their domain from or Converse username
-- Call the user by their name or domain, in case they have one
-- Ask for a name (if they don't have one) so you can suggest domains.
-- Message sent date: 2024-12-06T16:03:36.582Z
-- Users address is: 0x40f08f0f853d1c42c61815652b7ccd5a50f0be09
-- Users name is: ArizonaOregon
-- Converse username is: ArizonaOregon
-
-## Commands
-/check [domain] - Check if a domain is available.
-/cool [domain] - Get cool alternatives for a .eth domain.
-/info [domain] - Get detailed information about an ENS domain including owner, expiry date, and resolver.
-/register [domain] - Register a new ENS domain. Returns a URL to complete the registration process.
-/renew [domain] - Extend the registration period of your ENS domain. Returns a URL to complete the renewal.
-/reset  - Reset the conversation clearing memory and usernames cache.
-/pay [amount] [token] [username] [address] - Send a specified amount of a cryptocurrency to a destination address. 
-When tipping, you can asume its 1 usdc.
-
-## Examples
-/check vitalik.eth
-/check fabri.base.eth
-/cool vitalik.eth
-/info nick.eth
-/register vitalik.eth
-/renew fabri.base.eth
-/reset
-/pay 10 vitalik.eth
-/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03
-
-## Scenarios
-1. Missing commands in responses
-   **Issue**: Sometimes responses are sent without the required command.
-   **Example**:
-   Incorrect:
-   > "Looks like vitalik.eth is registered! What about these cool alternatives?"
-   Correct:
-   > "Looks like vitalik.eth is registered! What about these cool alternatives?
-   > /cool vitalik.eth"
-
-   Incorrect:
-   > Here is a summary of your TODOs. I will now send it via email.
-   Correct:
-   > /todo
+
+# 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/ens/src/index.ts

@@ -1,19 +1,16 @@
 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";
 import { register } from "./skills/register.js";
 import { renew } from "./skills/renew.js";
 import { pay } from "./skills/pay.js";
-import { reset } from "./skills/reset.js";
 
 export const agent: Agent = {
   name: "Ens Agent",
   tag: "@bot",
   description: "A ens agent with a lot of skills.",
-  skills: [checkDomain, cool, info, register, renew, reset, pay],
-  systemPrompt: systemPrompt,
+  skills: [checkDomain, cool, info, register, renew, pay],
 };
 
 run(agent);

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

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

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,14 +1,21 @@
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
+// [!region define]
 export const info: Skill[] = [
   {
     skill: "info",
     handler: handler,
     description:
       "Get detailed information about an ENS domain including owner, expiry date, and resolver.",
-    examples: ["/info nick.eth"],
+    examples: [
+      "/info humanagent.eth",
+      "/info fabri.base.eth",
+      "/info @fabri",
+      "/info fabri.converse.xyz",
+      "/info vitalik.eth",
+    ],
     params: {
       domain: {
         type: "string",
@@ -16,8 +23,10 @@ export const info: Skill[] = [
     },
   },
 ];
+// [!endregion define]
 
-export async function handler(context: XMTPContext) {
+// [!region handle]
+export async function handler(context: Context) {
   const {
     message: {
       sender,
@@ -28,15 +37,17 @@ export async function handler(context: XMTPContext) {
   } = context;
 
   const data = await context.getUserInfo(domain);
-  if (!data?.ensDomain) {
+  if (!data?.address) {
     return {
       code: 404,
       message: "Domain not found.",
     };
   }
-  console.log(data);
-  let message = `Domain information:\n\n`;
-  message += `URL: https://app.ens.domains/${data?.ensDomain}\n`;
+  let message = `Information:\n\n`;
+  if (data?.ensDomain)
+    message += `URL: https://app.ens.domains/${data?.ensDomain}\n`;
+  if (data?.converseUsername)
+    message += `Converse: https://converse.xyz/dm/${data?.converseUsername}\n`;
   if (data?.address) message += `Address: ${data?.address}\n`;
   if (data?.ensInfo?.avatar) message += `Avatar: ${data?.ensInfo?.avatar}\n`;
   if (data?.ensInfo?.description)
@@ -47,18 +58,6 @@ export async function handler(context: XMTPContext) {
   if (data?.ensInfo?.twitter) message += `Twitter: ${data?.ensInfo?.twitter}\n`;
   message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
   message = message.trim();
-
-  const { v2, v3 } = await context.isOnXMTP(
-    context.client,
-    context.v2client,
-    sender?.address,
-  );
-  if (v2 || v3) {
-    await context.send(
-      `Ah, this domains is in XMTP, you can message it directly`,
-    );
-    await context.sendConverseDmFrame(domain);
-  }
-
   return { code: 200, message };
 }
+// [!endregion handle]

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

@@ -1,4 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
 export const pay: Skill[] = [
@@ -31,11 +31,24 @@ export const pay: Skill[] = [
       },
     },
   },
+  {
+    skill: "tip",
+    examples: ["/tip vitalik.eth"],
+    description: "Send 1 usdc.",
+    handler: handler,
+    params: {
+      username: {
+        default: "",
+        type: "username",
+      },
+    },
+  },
 ];
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       content: {
+        skill,
         params: { amount, token, username, address },
       },
     },
@@ -48,6 +61,10 @@ export async function handler(context: XMTPContext) {
     //Prioritize address over username
     receiverAddress = address;
   }
-
-  await context.requestPayment(amount, token, receiverAddress);
+  if (skill === "tip") {
+    let tipAmount = 1;
+    await context.requestPayment(receiverAddress, tipAmount);
+  } else if (skill === "pay") {
+    await context.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,4 +1,4 @@
-import { XMTPContext } from "@xmtp/message-kit";
+import { Context } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
@@ -19,7 +19,7 @@ export const renew: Skill[] = [
   },
 ];
 
-export async function handler(context: XMTPContext) {
+export async function handler(context: Context) {
   const {
     message: {
       sender,

package/templates/simple/.cursorrules

@@ -1,12 +1,12 @@
-# MessageKit Skill Template
+# MessageKit
 
-## Examples
+# Skill Examples
 
 ### Check if a Domain is Available
 
 
 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: {
@@ -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: {
@@ -109,70 +109,101 @@ export async function handler(context: XMTPContext) {
     receiverAddress = address;
   }
 
-  await context.requestPayment(amount, token, receiverAddress);
+  await context.requestPayment(receiverAddress, amount, token);
 }
 
-## Example final prompt
-
-Your are a helpful and playful ens agent called @bot that lives inside a messaging app called Converse.
-
-
-# Rules
-- You can respond with multiple messages if needed. Each message should be separated by a newline character.
-- You can trigger skills by only sending the command in a newline message.
-- Each command starts with a slash (/).
-- Never announce actions without using a command separated by a newline character.
-- Never use markdown in your responses.
-- Do not make guesses or assumptions
-- Only answer if the verified information is in the prompt.
-- Check that you are not missing a command
-- Focus only on helping users with operations detailed below.
-- Date: Fri, 06 Dec 2024 16:03:22 GMT
-- When mentioning any action related to available skills, you MUST trigger the corresponding command in a new line
-- If you suggest an action that has a command, you must trigger that command
-
-
-## User context
-- Start by fetch their domain from or Converse username
-- Call the user by their name or domain, in case they have one
-- Ask for a name (if they don't have one) so you can suggest domains.
-- Message sent date: 2024-12-06T16:03:36.582Z
-- Users address is: 0x40f08f0f853d1c42c61815652b7ccd5a50f0be09
-- Users name is: ArizonaOregon
-- Converse username is: ArizonaOregon
-
-## Commands
-/check [domain] - Check if a domain is available.
-/cool [domain] - Get cool alternatives for a .eth domain.
-/info [domain] - Get detailed information about an ENS domain including owner, expiry date, and resolver.
-/register [domain] - Register a new ENS domain. Returns a URL to complete the registration process.
-/renew [domain] - Extend the registration period of your ENS domain. Returns a URL to complete the renewal.
-/reset  - Reset the conversation clearing memory and usernames cache.
-/pay [amount] [token] [username] [address] - Send a specified amount of a cryptocurrency to a destination address. 
-When tipping, you can asume its 1 usdc.
-
-## Examples
-/check vitalik.eth
-/check fabri.base.eth
-/cool vitalik.eth
-/info nick.eth
-/register vitalik.eth
-/renew fabri.base.eth
-/reset
-/pay 10 vitalik.eth
-/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03
-
-## Scenarios
-1. Missing commands in responses
-   **Issue**: Sometimes responses are sent without the required command.
-   **Example**:
-   Incorrect:
-   > "Looks like vitalik.eth is registered! What about these cool alternatives?"
-   Correct:
-   > "Looks like vitalik.eth is registered! What about these cool alternatives?
-   > /cool vitalik.eth"
-
-   Incorrect:
-   > Here is a summary of your TODOs. I will now send it via email.
-   Correct:
-   > /todo
+
+# 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/simple/src/index.ts

@@ -1,25 +1,16 @@
-import {
-  run,
-  agentReply,
-  replaceVariables,
-  XMTPContext,
-  Agent,
-} from "@xmtp/message-kit";
-import { systemPrompt } from "./prompt.js";
+// [!region index]
+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 },
-      agent,
-    } = context;
-
-    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    await agentReply(context, prompt);
+  tag: "@bot",
+  onMessage: async (context: Context) => {
+    // [!endregion index]
+    await agentReply(context);
+    // [!region final]
   },
 };
 
 run(agent);
+// [!endregion final]

package/templates/ens/src/prompt.ts

@@ -1,11 +0,0 @@
-export const systemPrompt = `
-{vibe}
-
-{rules}
-
-{user_context}
-
-{skills}
-
-{issues}
-`;

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

@@ -1,25 +0,0 @@
-import { clearInfoCache, clearMemory } from "@xmtp/message-kit";
-import { XMTPContext } from "@xmtp/message-kit";
-
-import type { Skill } from "@xmtp/message-kit";
-
-export const reset: Skill[] = [
-  {
-    skill: "reset",
-    examples: ["/reset"],
-    handler: handler,
-    description: "Reset the conversation clearing memory and usernames cache.",
-  },
-];
-export async function handler(context: XMTPContext) {
-  const {
-    message: { sender },
-  } = context;
-  try {
-    clearMemory(sender.address);
-    clearInfoCache(sender.address);
-    return { code: 200, message: "Memory and usernames cache cleared." };
-  } catch (error) {
-    return { code: 500, message: "Error clearing memory and usernames cache." };
-  }
-}

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

@@ -1 +0,0 @@
- 

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}
-`;