create-message-kit 1.1.11 → 1.2.0

package/index.js

@@ -85,7 +85,6 @@ async function gatherProjectInfo() {
   const templateOptions = [
     { value: "agent", label: "Web3 Agent" },
     { value: "gpt", label: "Simple Gpt" },
-    { value: "group", label: "Group bot" },
     { value: "gated", label: "Gated Group" },
   ];
 

package/package.json

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

package/templates/agent/package.json

@@ -8,7 +8,8 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
-    "@xmtp/message-kit": "workspace:*"
+    "@xmtp/message-kit": "workspace:*",
+    "resend": "^4.0.1"
   },
   "devDependencies": {
     "@types/node": "^20.14.2",

package/templates/agent/src/handlers/game.ts

@@ -35,23 +35,24 @@ export async function handler(context: XMTPContext) {
     wordle: "https://framedl.xyz",
     slot: "https://slot-machine-frame.vercel.app",
   };
-  // Respond with the appropriate game URL or an error message
+  let returnText = "";
   switch (params.game) {
     case "wordle":
     case "slot":
       // Retrieve the URL for the requested game using a simplified variable assignment
       const gameUrl = gameUrls[params.game];
       // Send the URL for the requested game
-      context.send(gameUrl);
+      returnText = gameUrl;
       break;
 
     case "help":
-      context.send("Available games: \n/game wordle\n/game slot");
+      returnText = "Available games: \n/game wordle\n/game slot";
       break;
     default:
       // Inform the user about unrecognized skills and provide available options
-      context.send(
-        "Skill not recognized. Available games: wordle, slot, or help.",
-      );
+      returnText =
+        "Skill not recognized. Available games: wordle, slot, or help.";
+      break;
   }
+  return { code: 200, message: returnText };
 }

package/templates/agent/src/handlers/info.ts

@@ -35,13 +35,17 @@ export async function handler(context: XMTPContext) {
       message: "Domain not found.",
     };
   }
+  console.log(data);
   let message = `Domain information:\n\n`;
-  message += `Address: ${data?.address}\n`;
-  message += `Avatar URL: ${data?.ensInfo?.avatar}\n`;
-  message += `Description: ${data?.ensInfo?.description}\n`;
-  message += `ENS: ${data?.ensDomain}\n`;
-  message += `Primary ENS: ${data?.ensInfo?.ens_primary}\n`;
-  message += `GitHub: ${data?.ensInfo?.github}\n`;
+  message += `URL: https://app.ens.domains/${data?.ensDomain}\n`;
+  if (data?.address) message += `Address: ${data?.address}\n`;
+  if (data?.ensInfo?.avatar) message += `Avatar: ${data?.ensInfo?.avatar}\n`;
+  if (data?.ensInfo?.description)
+    message += `Description: ${data?.ensInfo?.description}\n`;
+  if (data?.ensInfo?.ens_primary)
+    message += `Primary ENS: ${data?.ensInfo?.ens_primary}\n`;
+  if (data?.ensInfo?.github) message += `GitHub: ${data?.ensInfo?.github}\n`;
+  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();
 

package/templates/agent/src/handlers/pay.ts

@@ -6,7 +6,7 @@ export const registerSkill: Skill[] = [
     skill: "/pay [amount] [token] [username]",
     examples: ["/pay 10 vitalik.eth"],
     description:
-      "Send a specified amount of a cryptocurrency to a destination address.",
+      "Send a specified amount of a cryptocurrency to a destination address. \nWhen tipping, you can asume its 1 usdc.",
     handler: handler,
     params: {
       amount: {

package/templates/agent/src/handlers/register.ts

@@ -35,6 +35,6 @@ export async function handler(context: XMTPContext) {
   }
   // Generate URL for the ens
   let url_ens = ensUrl + domain;
-  context.send(`${url_ens}`);
   return { code: 200, message: `${url_ens}` };
 }
+

package/templates/agent/src/handlers/todo.ts

@@ -0,0 +1,58 @@
+import { Resend } from 'resend';
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+const resend = new Resend(process.env.RESEND_API_KEY); // Replace with your Resend API key
+
+export const registerSkill: Skill[] = [
+  {
+    skill: "/todo",
+    handler: handler,
+    examples: ["/todo"],
+    description: "Send a list of TODOs via email. Receives no parameters.",
+    params: {},
+  },
+];
+
+export async function handler(context: XMTPContext) {
+  const {
+    message: {
+      content: { reply },
+    },
+  } = context;
+
+  let email = "";
+
+  while (true) {
+    const emailResponse = await context.awaitResponse("Please provide your email address to receive the TODO summary:");
+    email = emailResponse;
+  
+    // Basic email validation
+    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    if (!emailRegex.test(email)) {
+      await context.send("Invalid email format. Please try again with a valid email address.");
+      continue;
+    }
+    break;
+  }
+
+  try {
+    let content={
+      from: 'onboarding@resend.dev',
+      to: email,
+      subject: 'Your TODO Summary from Converse',
+      html: `
+        <h1>Your TODO Summary</h1>
+        <p>${reply}</p>
+      `
+    }
+    console.log(content);
+    const response = await resend.emails.send(content);
+    console.log(response);
+
+    await context.send(`✅ Summary sent successfully to ${email}`);
+  } catch (error) {
+    await context.send("❌ Failed to send email. Please try again later.");
+    console.error('Error sending email:', error);
+  }
+}

package/templates/agent/src/index.ts

@@ -15,11 +15,11 @@ import { registerSkill as paySkill } from "./handlers/pay.js";
 import { registerSkill as resetSkill } from "./handlers/reset.js";
 import { registerSkill as tokenSkill } from "./handlers/token.js";
 import { registerSkill as gameSkill } from "./handlers/game.js";
+import { registerSkill as todoSkill } from "./handlers/todo.js";
 import fs from "fs";
 
 export const frameUrl = "https://ens.steer.fun/";
 export const ensUrl = "https://app.ens.domains/";
-export const txpayUrl = "https://txpay.vercel.app";
 
 // [!region skills]
 export const agent: Agent = {
@@ -36,11 +36,12 @@ export const agent: Agent = {
     ...paySkill,
     ...tokenSkill,
     ...gameSkill,
+    ...todoSkill,
   ],
 };
 // [!endregion skills]
 
-// [!region run]
+// [!region run1]
 run(
   async (context: XMTPContext) => {
     const {
@@ -49,11 +50,13 @@ run(
     } = context;
 
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-
+    // [!region run1]
+    //This is only used for to update the docs.
     fs.writeFileSync("example_prompt.md", prompt);
+    // [!region run2]
     await agentReply(context, prompt);
   },
   { agent },
 );
 
-// [!endregion run]
+// [!endregion run2]

package/templates/agent/src/prompt.ts

@@ -7,46 +7,14 @@ Your are helpful and playful web3 agent called {agent_name} that lives inside a
 
 {skills}
 
-## Response Scenarios:
-
-1. When greeting or when the user asks for an ENS domain, check if the user does not have an ENS domain:
-   Hey {name}! It looks like you don't have an ENS domain yet! 
-   Let me start by checking your Converse username with the .eth suffix
-   /check localdev6.eth
-2. If the user has an ENS domain:
-   I'll help you get your ENS domain.
-   Let's start by checking your ENS domain. Give me a moment.
-   /check [domain]
-3. Check if the ENS domain is available:
-   Hello! I'll help you get your domain.
-   Let's start by checking your ENS domain. Give me a moment.
-   /check [domain]
-4. If the ENS domain is available:
-   Looks like [domain] is available! Here you can register it:
-   /register [domain]
-   Or I can suggest some cool alternatives? Let me know!
-5. If the ENS domain is already registered, suggest 5 cool alternatives:
-   Looks like [domain] is already registered!
-   What about these cool alternatives?
-   /cool [domain]
-6. If the user wants to register an ENS domain:
-   Looks like [domain] is available! Let me help you register it.
-   /register [domain]
-7. If the user wants to directly tip the ENS domain owner:
-   Here is the URL to send the tip:
-   /pay 1 usdc [address]
-8. If the user wants to get information about the ENS domain:
-   Hello! I'll help you get info about [domain].
-   Give me a moment.
-   /info [domain]
-9. If the user wants to renew their domain:
-   Hello! I'll help you get your ENS domain.
-   Let's start by checking your ENS domain. Give me a moment.
-   /renew [domain]
-10. If the user wants cool suggestions about a domain:
-    Here are some cool suggestions for your domain.
-    /cool [domain]
-  
-## Most common bugs
-1. Some times you will say something like: "Looks like vitalik.eth is registered! What about these cool alternatives?" But you forgot to add the command at the end of the message.
+## Common Issues
+1. Missing commands in responses
+   **Issue**: Sometimes responses about registered domains 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"
 `;

package/templates/gated/src/skills.ts

@@ -2,6 +2,7 @@ import type { Agent } from "@xmtp/message-kit";
 
 export const agent: Agent = {
   name: "Group Id",
+  tag: "@bot",
   description: "Create and get group id.",
   skills: [
     {

package/templates/gpt/src/index.ts

@@ -19,6 +19,6 @@ run(async (context: XMTPContext) => {
     message: { sender },
   } = context;
 
-  let prompt = await replaceVariables(systemPrompt, sender.address, skills);
+  let prompt = await replaceVariables(systemPrompt, sender.address, agent);
   await agentReply(context, prompt);
 });

package/templates/group/.env.example

@@ -1,2 +0,0 @@
-KEY= # the private key of the agent wallet 
-OPENAI_API_KEY= # openai api key

package/templates/group/.yarnrc.yml

@@ -1,4 +0,0 @@
-compressionLevel: mixed
-enableGlobalCache: false
-enableTelemetry: false
-nodeLinker: node-modules

package/templates/group/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "group",
-  "private": true,
-  "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/group/src/handlers/game.ts

@@ -1,57 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import type { Skill } from "@xmtp/message-kit";
-
-export const registerSkill: Skill[] = [
-  {
-    skill: "/game [game]",
-    handler: handler,
-    description: "Play a game.",
-    examples: ["/game wordle", "/game slot", "/game help"],
-    params: {
-      game: {
-        default: "",
-        type: "string",
-        values: ["wordle", "slot", "help"],
-      },
-    },
-  },
-];
-
-export async function handler(context: XMTPContext) {
-  const {
-    message: {
-      content: { skill, params, text },
-    },
-  } = context;
-  if (!skill) {
-    if (text === "🔎" || text === "🔍") {
-      // Send the URL for the requested game
-      context.reply("https://framedl.xyz/");
-    }
-    return;
-  }
-  // URLs for each game type
-  const gameUrls: { [key: string]: string } = {
-    wordle: "https://framedl.xyz",
-    slot: "https://slot-machine-frame.vercel.app",
-  };
-  // Respond with the appropriate game URL or an error message
-  switch (params.game) {
-    case "wordle":
-    case "slot":
-      // Retrieve the URL for the requested game using a simplified variable assignment
-      const gameUrl = gameUrls[params.game];
-      // Send the URL for the requested game
-      context.send(gameUrl);
-      break;
-
-    case "help":
-      context.send("Available games: \n/game wordle\n/game slot");
-      break;
-    default:
-      // Inform the user about unrecognized skills and provide available options
-      context.send(
-        "Skill not recognized. Available games: wordle, slot, or help.",
-      );
-  }
-}

package/templates/group/src/handlers/helpers.ts

@@ -1,46 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-
-import type { Skill } from "@xmtp/message-kit";
-
-export const registerSkill: Skill[] = [
-  {
-    skill: "/help",
-    examples: ["/help"],
-    handler: handleHelp,
-    description: "Get help with the bot.",
-    params: {},
-  },
-  {
-    skill: "/id",
-    examples: ["/id"],
-    handler: handleHelp,
-    description: "Get the group ID.",
-    params: {},
-  },
-];
-
-export async function handleHelp(context: XMTPContext) {
-  const {
-    message: {
-      content: { skill },
-    },
-    group,
-    agent,
-  } = context;
-
-  if (skill == "help") {
-    const intro =
-      "Available experiences:\n" +
-      agent?.skills
-        .map((skill) => `${skill.skill} - ${skill.description}`)
-        .join("\n") +
-      "\nUse these skills to interact with specific apps.";
-    context.send(intro);
-  } else if (skill == "id") {
-    if (!group?.id) {
-      context.send("This skill only works in group chats.");
-      return;
-    }
-    context.send(group?.id);
-  }
-}

package/templates/group/src/handlers/pay.ts

@@ -1,38 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import type { Skill } from "@xmtp/message-kit";
-
-export const registerSkill: Skill[] = [
-  {
-    skill: "/pay [amount] [token] [username]",
-    examples: ["/pay 10 vitalik.eth"],
-    description:
-      "Send a specified amount of a cryptocurrency to a destination address.",
-    handler: handler,
-    params: {
-      amount: {
-        default: 10,
-        type: "number",
-      },
-      token: {
-        default: "usdc",
-        type: "string",
-        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
-      },
-      username: {
-        default: "",
-        type: "username",
-      },
-    },
-  },
-];
-export async function handler(context: XMTPContext) {
-  const {
-    message: {
-      content: {
-        params: { address },
-      },
-    },
-  } = context;
-
-  await context.requestPayment(1, "USDC", address);
-}

package/templates/group/src/handlers/tipping.ts

@@ -1,60 +0,0 @@
-import { getUserInfo, AbstractedMember, XMTPContext } from "@xmtp/message-kit";
-import type { Skill } from "@xmtp/message-kit";
-
-export const registerSkill: Skill[] = [
-  {
-    skill: "/tip [usernames] [amount] [token]",
-    examples: ["/tip @vitalik 10 usdc"],
-    description: "Tip users in a specified token.",
-    handler: handleTipping,
-    params: {
-      username: {
-        default: "",
-        plural: true,
-        type: "username",
-      },
-      amount: {
-        default: 10,
-        type: "number",
-      },
-      token: {
-        default: "usdc",
-        type: "string",
-        values: ["eth", "dai", "usdc", "degen"],
-      },
-    },
-  },
-];
-
-export async function handleTipping(context: XMTPContext) {
-  const {
-    message: {
-      content: {
-        skill,
-        params: { amount, username },
-      },
-      sender,
-    },
-  } = context;
-  let receivers: AbstractedMember[] = [];
-
-  receivers = await Promise.all(
-    username.map((username: string) => getUserInfo(username)),
-  );
-
-  if (!sender || receivers.length === 0 || amount === 0) {
-    context.reply("Sender or receiver or amount not found.");
-  }
-  const receiverAddresses = receivers.map((receiver) => receiver.address);
-
-  context.sendTo(
-    `You received ${amount} tokens from ${sender.address}.`,
-    receiverAddresses,
-  );
-
-  // Notify sender of the transaction details
-  context.sendTo(
-    `You sent ${amount * receiverAddresses.length} tokens in total.`,
-    [sender.address],
-  );
-}

package/templates/group/src/index.ts

@@ -1,32 +0,0 @@
-import {
-  run,
-  agentReply,
-  XMTPContext,
-  replaceVariables,
-  Agent,
-} from "@xmtp/message-kit";
-import { registerSkill as tippingSkill } from "./handlers/tipping.js";
-import { registerSkill as paymentSkill } from "./handlers/pay.js";
-import { registerSkill as gameSkill } from "./handlers/game.js";
-import { registerSkill as helperSkill } from "./handlers/helpers.js";
-import { systemPrompt } from "./prompt.js";
-
-export const agent: Agent = {
-  name: "Group bot",
-  tag: "@bot",
-  description: "Group agent for tipping payments, games and more.",
-  skills: [...tippingSkill, ...paymentSkill, ...gameSkill, ...helperSkill],
-};
-
-run(
-  async (context: XMTPContext) => {
-    const {
-      message: { sender },
-      agent,
-    } = context;
-
-    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    await agentReply(context, prompt);
-  },
-  { agent },
-);

package/templates/group/src/prompt.ts

@@ -1,33 +0,0 @@
-export const systemPrompt = `
-{persona}
-
-{rules}
-
-{user_context}
-
-{skills}
-
-## Response Scenarios
-
-1. If the user wants to play a game suggest direcly a game like wordle:
-  Let's play wordle!
-  /game wordle
-  
-2. When user wants to pay a specific token:
-  I'll help you pay 1 USDC to 0x123...
-  /pay 1 [token] 0x123456789...
-  *This will return a url to pay
-
-3. If the user wants to pay a eth domain:
-  I'll help you pay 1 USDC to vitalik.eth
-  Be aware that this only works on mobile with a installed wallet on Base network
-  /pay 1 vitalik.eth
-  *This will return a url to pay
-
-4. If the user wants to pay a username:
-  I'll help you pay 1 USDC to @fabri
-  Be aware that this only works on mobile with a installed wallet on Base network
-  /pay 1 @fabri
-  *This will return a url to pay
-
-`;