create-message-kit 1.1.7-beta.2 → 1.1.7-beta.20

package/index.js

@@ -32,8 +32,8 @@ Powered by XMTP`;
 
     const { templateType, displayName, destDir } = await gatherProjectInfo();
 
-    // Replace dot files
-    //replaceDotfiles(destDir);
+    // Add package.json
+    addPackagejson(destDir, displayName);
 
     // Create .gitignore
     createGitignore(destDir);
@@ -44,9 +44,6 @@ Powered by XMTP`;
     // Create tsconfig.json file
     createTsconfig(destDir);
 
-    // Replace package.json properties
-    updatePackageJson(destDir, displayName);
-
     // Wrap up
     log.success(`Project launched in ${pc.red(destDir)}!`);
 
@@ -63,6 +60,31 @@ Powered by XMTP`;
 
 program.parse(process.argv);
 
+async function addPackagejson(destDir, name) {
+  // Create package.json based on the template
+  const packageTemplate = {
+    name: name,
+    private: true,
+    type: "module",
+    scripts: {
+      build: "tsc",
+      dev: "tsc -w & sleep 1 && node --watch dist/index.js",
+      start: "node dist/index.js",
+      postinstall: "tsc",
+    },
+    dependencies: {
+      "@xmtp/message-kit": "workspace:*",
+    },
+    engines: {
+      node: ">=20",
+    },
+  };
+
+  fs.writeJsonSync(resolve(destDir, "package.json"), packageTemplate, {
+    spaces: 2,
+  });
+}
+
 async function gatherProjectInfo() {
   const templateOptions = [
     { value: "gm", label: "GM" },
@@ -151,22 +173,6 @@ function createTsconfig(destDir) {
     spaces: 2,
   });
 }
-function replaceDotfiles(destDir) {
-  for (const file of fs.readdirSync(destDir)) {
-    if (!file.startsWith("_")) continue;
-    fs.renameSync(
-      resolve(destDir, file),
-      resolve(destDir, `.${file.slice(1)}`),
-    );
-  }
-}
-
-function updatePackageJson(destDir, name) {
-  const pkgJson = fs.readJsonSync(resolve(destDir, "package.json"));
-  pkgJson.name = name;
-  updateDependenciesToLatest(pkgJson);
-  fs.writeJsonSync(resolve(destDir, "package.json"), pkgJson, { spaces: 2 });
-}
 
 function logNextSteps(name) {
   log.message("Next steps:");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.1.7-beta.2",
+  "version": "1.1.7-beta.20",
   "license": "MIT",
   "type": "module",
   "main": "index.js",

package/templates/agent/src/handler/ens.ts

@@ -1,7 +1,7 @@
 import { HandlerContext, SkillResponse } from "@xmtp/message-kit";
-import { getUserInfo, clearInfoCache, isOnXMTP } from "../lib/resolver.js";
+import { getUserInfo, clearInfoCache, isOnXMTP } from "@xmtp/message-kit";
 import { isAddress } from "viem";
-import { clearMemory } from "../lib/gpt.js";
+import { clearMemory } from "@xmtp/message-kit";
 
 export const frameUrl = "https://ens.steer.fun/";
 export const ensUrl = "https://app.ens.domains/";
@@ -9,18 +9,19 @@ export const baseTxUrl = "https://base-tx-frame.vercel.app";
 
 export async function handleEns(
   context: HandlerContext,
-): Promise<SkillResponse> {
+): Promise<SkillResponse | undefined> {
   const {
     message: {
-      content: { command, params, sender },
+      sender,
+      content: { skill, params },
     },
-    skill,
   } = context;
-  if (command == "reset") {
+
+  if (skill == "reset") {
     clearMemory();
     return { code: 200, message: "Conversation reset." };
-  } else if (command == "renew") {
-    // Destructure and validate parameters for the ens command
+  } else if (skill == "renew") {
+    // Destructure and validate parameters for the ens
     const { domain } = params;
     // Check if the user holds the domain
     if (!domain) {
@@ -43,8 +44,8 @@ export async function handleEns(
     // Generate URL for the ens
     let url_ens = frameUrl + "frames/manage?name=" + domain;
     return { code: 200, message: `${url_ens}` };
-  } else if (command == "register") {
-    // Destructure and validate parameters for the ens command
+  } else if (skill == "register") {
+    // Destructure and validate parameters for the ens
     const { domain } = params;
 
     if (!domain) {
@@ -56,7 +57,7 @@ export async function handleEns(
     // Generate URL for the ens
     let url_ens = ensUrl + domain;
     return { code: 200, message: `${url_ens}` };
-  } else if (command == "info") {
+  } else if (skill == "info") {
     const { domain } = params;
 
     const data = await getUserInfo(domain);
@@ -87,19 +88,13 @@ export async function handleEns(
     }
     message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
     message = message.trim();
-    if (
-      await isOnXMTP(
-        context.v2client,
-        data?.ensInfo?.ens,
-        data?.ensInfo?.address,
-      )
-    ) {
+    if (await isOnXMTP(context.client, context.v2client, sender?.address)) {
       await context.send(
         `Ah, this domains is in XMTP, you can message it directly: https://converse.xyz/dm/${domain}`,
       );
     }
     return { code: 200, message };
-  } else if (command == "check") {
+  } else if (skill == "check") {
     const { domain } = params;
 
     if (!domain) {
@@ -118,13 +113,13 @@ export async function handleEns(
       };
     } else {
       let message = `Looks like ${domain} is already registered!`;
-      await skill("/cool " + domain);
+      await context.executeSkill("/cool " + domain);
       return {
         code: 404,
         message,
       };
     }
-  } else if (command == "tip") {
+  } else if (skill == "tip") {
     const { address } = params;
     if (!address) {
       return {
@@ -141,7 +136,7 @@ export async function handleEns(
       code: 200,
       message: txUrl,
     };
-  } else if (command == "cool") {
+  } else if (skill == "cool") {
     const { domain } = params;
     //What about these cool alternatives?\
     return {
@@ -149,7 +144,7 @@ export async function handleEns(
       message: `${generateCoolAlternatives(domain)}`,
     };
   } else {
-    return { code: 400, message: "Command not found." };
+    return { code: 400, message: "Skill not found." };
   }
 }
 

package/templates/agent/src/index.ts

@@ -1,26 +1,18 @@
 import { run, HandlerContext } from "@xmtp/message-kit";
-import { textGeneration, processMultilineResponse } from "./lib/gpt.js";
+import { textGeneration, processMultilineResponse } from "@xmtp/message-kit";
 import { agent_prompt } from "./prompt.js";
-import { getUserInfo } from "./lib/resolver.js";
+import { getUserInfo } from "@xmtp/message-kit";
 
 run(async (context: HandlerContext) => {
-  /*All the skills are handled through the skills file*/
-  /* If its just text, it will be handled by the ensAgent*/
-  /* If its a group message, it will be handled by the groupAgent*/
-  if (!process?.env?.OPEN_AI_API_KEY) {
-    console.warn("No OPEN_AI_API_KEY found in .env");
-    return;
-  }
-
   const {
     message: {
-      content: { content, params },
+      content: { text, params },
       sender,
     },
   } = context;
 
   try {
-    let userPrompt = params?.prompt ?? content;
+    let userPrompt = params?.prompt ?? text;
     const userInfo = await getUserInfo(sender.address);
     if (!userInfo) {
       console.log("User info not found");

package/templates/agent/src/prompt.ts

@@ -1,52 +1,51 @@
 import { skills } from "./skills.js";
-import { UserInfo, PROMPT_USER_CONTENT } from "./lib/resolver.js";
-import { PROMPT_RULES, PROMPT_SKILLS_AND_EXAMPLES } from "./lib/gpt.js";
+import {
+  UserInfo,
+  PROMPT_USER_CONTENT,
+  PROMPT_RULES,
+  PROMPT_SKILLS_AND_EXAMPLES,
+  PROMPT_REPLACE_VARIABLES,
+} from "@xmtp/message-kit";
 
 export async function agent_prompt(userInfo: UserInfo) {
-  let { address, ensDomain, converseUsername, preferredName } = userInfo;
+  let systemPrompt =
+    PROMPT_RULES +
+    PROMPT_USER_CONTENT(userInfo) +
+    PROMPT_SKILLS_AND_EXAMPLES(skills, "@ens");
 
-  //Update the name of the agent with predefined prompt
-  let systemPrompt = PROMPT_RULES.replace("{NAME}", skills?.[0]?.tag ?? "@ens");
-
-  //Add user context to the prompt
-  systemPrompt += PROMPT_USER_CONTENT(userInfo);
-
-  //Add skills and examples to the prompt
-  systemPrompt += PROMPT_SKILLS_AND_EXAMPLES(skills, "@ens");
-
-  systemPrompt += `
+  let fineTunning = `
 
 ## Example responses:
 
 1. Check if the user does not have a ENS domain
-  Hey ${preferredName}! it looks like you don't have a ENS domain yet! \n\Let me start by checking your Converse username with the .eth suffix\n/check ${converseUsername}.eth
+  Hey {PREFERRED_NAME}! it looks like you don't have a ENS domain yet! \n\Let me start by checking your Converse username with the .eth suffix\n/check {CONVERSE_USERNAME}.eth
 
 2. If the user has a ENS domain
-  Hello ${preferredName} ! I'll help you get your ENS domain.\n Let's start by checking your ENS domain ${ensDomain}. Give me a moment.\n/check ${ensDomain}
+  Hello  {PREFERRED_NAME} ! I'll help you get your ENS domain.\n Let's start by checking your ENS domain  {ENS_DOMAIN}. Give me a moment.\n/check  {ENS_DOMAIN}
 
 3. Check if the ENS domain is available
-  Hello! I'll help you get your domain.\n Let's start by checking your ENS domain ${ensDomain}. Give me a moment.\n/check ${ensDomain}
+  Hello! I'll help you get your domain.\n Let's start by checking your ENS domain  {ENS_DOMAIN}. Give me a moment.\n/check  {ENS_DOMAIN}
 
 4. If the ENS domain is available,
-  Looks like ${ensDomain} is available! Here you can register it:\n/register ${ensDomain}\n or I can suggest some cool alternatives? Le me know!
+  Looks like  {ENS_DOMAIN} is available! Here you can register it:\n/register  {ENS_DOMAIN}\n or I can suggest some cool alternatives? Le me know!
 
 5. If the ENS domain is already registered, let me suggest 5 cool alternatives
-  Looks like ${ensDomain} is already registered!\n What about these cool alternatives?\n/cool ${ensDomain}
+  Looks like  {ENS_DOMAIN} is already registered!\n What about these cool alternatives?\n/cool  {ENS_DOMAIN}
 
 6. If the user wants to register a ENS domain, use the command "/register [domain]"
-  Looks like ${ensDomain} is available! Let me help you register it\n/register ${ensDomain} 
+  Looks like  {ENS_DOMAIN} is available! Let me help you register it\n/register  {ENS_DOMAIN} 
   
 7. If the user wants to directly to tip to the ENS domain owner, use directly the command "/tip [domain]", this will return a url but a button to send the tip 
-  Here is the url to send the tip:\n/tip ${ensDomain}
+  Here is the url to send the tip:\n/tip  {ENS_DOMAIN}
 
 8. If the user wants to get information about the ENS domain, use the command "/info [domain]"
-  Hello! I'll help you get info about ${ensDomain}.\n Give me a moment.\n/info ${ensDomain}  
+  Hello! I'll help you get info about  {ENS_DOMAIN}.\n Give me a moment.\n/info  {ENS_DOMAIN}  
 
 9. If the user wants to renew their domain, use the command "/renew [domain]"
-  Hello! I'll help you get your ENS domain.\n Let's start by checking your ENS domain ${ensDomain}. Give me a moment.\n/renew ${ensDomain} 
+  Hello! I'll help you get your ENS domain.\n Let's start by checking your ENS domain  {ENS_DOMAIN}. Give me a moment.\n/renew  {ENS_DOMAIN} 
 
 10. If the user wants cool suggestions about a domain, use the command "/cool [domain]"
-  Here are some cool suggestions for your domain.\n/cool ${ensDomain}
+  Here are some cool suggestions for your domain.\n/cool  {ENS_DOMAIN}
 
 ## Most common bugs
 
@@ -54,5 +53,16 @@ export async function agent_prompt(userInfo: UserInfo) {
   But you forgot to add the command at the end of the message.
   You should have said something like: "Looks like vitalik.eth is registered! What about these cool alternatives?\n/cool vitalik.eth
 `;
+
+  // Add the fine tuning to the system prompt
+  systemPrompt += fineTunning;
+
+  // Replace the variables in the system prompt
+  systemPrompt = PROMPT_REPLACE_VARIABLES(
+    systemPrompt,
+    userInfo?.address ?? "",
+    userInfo,
+    "@ens",
+  );
   return systemPrompt;
 }

package/templates/agent/src/skills.ts

@@ -8,7 +8,7 @@ export const skills: SkillGroup[] = [
     description: "Register ENS domains.",
     skills: [
       {
-        command: "/register [domain]",
+        skill: "/register [domain]",
         triggers: ["/register"],
         handler: handleEns,
         description:
@@ -21,8 +21,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/exists",
-        adminOnly: true,
+        skill: "/exists",
         examples: ["/exists"],
         handler: handleEns,
         triggers: ["/exists"],
@@ -34,7 +33,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/info [domain]",
+        skill: "/info [domain]",
         triggers: ["/info"],
         handler: handleEns,
         description:
@@ -47,7 +46,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/renew [domain]",
+        skill: "/renew [domain]",
         triggers: ["/renew"],
         handler: handleEns,
         description:
@@ -60,7 +59,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/check [domain]",
+        skill: "/check [domain]",
         triggers: ["/check"],
         handler: handleEns,
         examples: ["/check vitalik.eth", "/check fabri.base.eth"],
@@ -72,7 +71,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/cool [domain]",
+        skill: "/cool [domain]",
         triggers: ["/cool"],
         examples: ["/cool vitalik.eth"],
         handler: handleEns,
@@ -84,7 +83,7 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/reset",
+        skill: "/reset",
         triggers: ["/reset"],
         examples: ["/reset"],
         handler: handleEns,
@@ -92,7 +91,7 @@ export const skills: SkillGroup[] = [
         params: {},
       },
       {
-        command: "/tip [address]",
+        skill: "/tip [address]",
         description: "Show a URL for tipping a domain owner.",
         triggers: ["/tip"],
         handler: handleEns,

package/templates/gm/src/index.ts

@@ -1,9 +1,14 @@
 import { run, HandlerContext } from "@xmtp/message-kit";
+import { skills } from "./skills.js";
+run(
+  async (context: HandlerContext) => {
+    // Get the message and the address from the sender
+    const { content, sender } = context.message;
 
-run(async (context: HandlerContext) => {
-  // Get the message and the address from the sender
-  const { content, sender } = context.message;
-
-  // To reply, just call `reply` on the HandlerContext
-  await context.send(`gm`);
-});
+    // To reply, just call `reply` on the HandlerContext
+    await context.send(`gm`);
+  },
+  {
+    skills: skills,
+  },
+);

package/templates/gm/src/skills.ts

@@ -0,0 +1,29 @@
+import type { SkillGroup } from "@xmtp/message-kit";
+
+export const skills: SkillGroup[] = [
+  {
+    name: "Group bot",
+    tag: "@bot",
+    description: "Group bot for tipping and transactions.",
+    skills: [
+      {
+        skill: "/tip [usernames] [amount] [token]",
+        triggers: ["/tip"],
+        examples: ["/tip @vitalik 10 usdc"],
+        description: "Tip users in a specified token.",
+        handler: undefined,
+        params: {
+          username: {
+            default: "",
+            plural: true,
+            type: "username",
+          },
+          amount: {
+            default: 10,
+            type: "number",
+          },
+        },
+      },
+    ],
+  },
+];

package/templates/group/.env.example

@@ -1,3 +1,2 @@
 KEY= # the private key of the bot wallet 
-OPEN_AI_API_KEY= # openai api key
-STACK_API_KEY= # stack api key
+OPEN_AI_API_KEY= # openai api key

package/templates/group/src/handler/agent.ts

@@ -1,68 +1,31 @@
-import { HandlerContext, AbstractedMember } from "@xmtp/message-kit";
-import { textGeneration } from "../lib/gpt.js";
-
-export async function handler(context: HandlerContext) {
-  if (!process?.env?.OPEN_AI_API_KEY) {
-    console.warn("No OPEN_AI_API_KEY found in .env");
-    return;
-  }
+import { run, HandlerContext } from "@xmtp/message-kit";
+import { textGeneration, processMultilineResponse } from "@xmtp/message-kit";
+import { agent_prompt } from "../prompt.js";
+import { getUserInfo } from "@xmtp/message-kit";
 
+run(async (context: HandlerContext) => {
   const {
     message: {
+      content: { text, params },
       sender,
-      content: { content, params },
     },
-    skill,
   } = context;
 
-  const systemPrompt = generateSystemPrompt(context);
   try {
-    let userPrompt = params?.prompt ?? content;
-
+    let userPrompt = params?.prompt ?? text;
+    const userInfo = await getUserInfo(sender.address);
+    if (!userInfo) {
+      console.log("User info not found");
+      return;
+    }
     const { reply } = await textGeneration(
       sender.address,
       userPrompt,
-      systemPrompt,
+      await agent_prompt(userInfo),
     );
-    skill(reply);
+    await processMultilineResponse(sender.address, reply, context);
   } catch (error) {
     console.error("Error during OpenAI call:", error);
-    await context.reply("An error occurred while processing your request.");
+    await context.send("An error occurred while processing your request.");
   }
-}
-
-function generateSystemPrompt(context: HandlerContext) {
-  const {
-    members,
-    skills,
-    message: { sender },
-  } = context;
-
-  const systemPrompt = `
-  ### Context
-  
-  You are a helpful bot agent that lives inside a web3 messaging group that helps interpret user requests and execute commands.
-  #### Users
-   ${JSON.stringify(
-     members?.map((member: AbstractedMember) => ({
-       ...member,
-       username: `@${member.accountAddresses[0]}`,
-     })),
-   )}\n
-  #### Commands
-  ${JSON.stringify(skills)}\n
-  The message was sent by @${sender?.address}
-  
-  ### Examples
-  prompt /agent tip alix and bo
-  reply /tip @alix @bo 10
-
-  Important:
-  - If a user asks jokes, make jokes about web3 devs\n
-  - If the user asks about performing an action and you can think of a command that would help, answer directly with the command and nothing else. 
-  - Populate the command with the correct or random values. Always return skills with real values only, using usernames with @ and excluding addresses.\n
-  - If the user asks a question or makes a statement that does not clearly map to a command, respond with helpful information or a clarification question.\n
-  - If the user is grateful, respond asking for a tip in a playful manner.
-  `;
-  return systemPrompt;
-}
+});

package/templates/group/src/handler/game.ts

@@ -1,14 +1,13 @@
 import { HandlerContext } from "@xmtp/message-kit";
 
-// Handler function to process game-related commands
+// Handler function to process game-related
 export async function handler(context: HandlerContext) {
   const {
     message: {
-      content: { command, params },
+      content: { skill, params, text },
     },
   } = context;
-  if (!command) {
-    const { content: text } = context?.message?.content;
+  if (!skill) {
     if (text === "🔎" || text === "🔍") {
       // Send the URL for the requested game
       context.reply("https://framedl.xyz/");
@@ -36,7 +35,7 @@ export async function handler(context: HandlerContext) {
     default:
       // Inform the user about unrecognized skills and provide available options
       context.send(
-        "Command not recognized. Available games: wordle, slot, or help.",
+        "Skill not recognized. Available games: wordle, slot, or help.",
       );
   }
 }

package/templates/group/src/handler/{group.ts → helpers.ts}

@@ -3,22 +3,26 @@ import { HandlerContext } from "@xmtp/message-kit";
 export async function handler(context: HandlerContext) {
   const {
     skills,
-    group,
     message: {
-      content: { command },
+      content: { skill },
     },
+    group,
   } = context;
 
-  if (command == "help") {
+  if (skill == "help") {
     const intro =
       "Available experiences:\n" +
       skills
         ?.flatMap((app) => app.skills)
-        .map((skill) => `${skill.command} - ${skill.description}`)
+        .map((skill) => `${skill.skill} - ${skill.description}`)
         .join("\n") +
       "\nUse these skills to interact with specific apps.";
     context.send(intro);
-  } else if (command == "id") {
-    context.send(context.group?.id);
+  } else if (skill == "id") {
+    if (!group?.id) {
+      context.send("This skill only works in group chats.");
+      return;
+    }
+    context.send(group?.id);
   }
 }