create-message-kit 1.1.8 → 1.1.9-beta.2

package/index.js

@@ -79,19 +79,25 @@ async function addPackagejson(destDir, name, pkgManager) {
     dependencies: {
       "@xmtp/message-kit": "latest",
     },
+    devDependencies: {
+      "@types/node": "latest",
+      typescript: "latest",
+    },
     engines: {
       node: ">=20",
     },
   };
 
-  if (pkgManager.startsWith("yarn")) {
-    packageTemplate.packageManager = `${pkgManager}`;
-    // Add .yarnrc.yml to disable PnP mode
-    fs.writeFileSync(
-      resolve(destDir, ".yarnrc.yml"),
-      "nodeLinker: node-modules\n",
-    );
+  if (pkgManager.includes("yarn")) {
+    packageTemplate.packageManager = `yarn@4.5.1`;
   }
+
+  // Add .yarnrc.yml just in caseto disable PnP mode
+  fs.writeFileSync(
+    resolve(destDir, ".yarnrc.yml"),
+    "nodeLinker: node-modules\n",
+  );
+
   fs.writeJsonSync(resolve(destDir, "package.json"), packageTemplate, {
     spaces: 2,
   });
@@ -99,7 +105,7 @@ async function addPackagejson(destDir, name, pkgManager) {
 
 async function gatherProjectInfo() {
   const templateOptions = [
-    { value: "gm", label: "GM" },
+    { value: "gpt", label: "Simple Gpt" },
     { value: "agent", label: "Agent" },
     { value: "group", label: "Group" },
   ];
@@ -201,11 +207,27 @@ yarn-error.log*
 
   fs.writeFileSync(resolve(destDir, ".gitignore"), gitignoreContent.trim());
 }
-
 async function detectPackageManager() {
   try {
-    const pkgManager = await detect();
+    // Check if running through bun create
+    if (process.env.BUN_CREATE === "true" || process.env._?.includes("bun")) {
+      return "bun";
+    }
+
     const userAgent = process.env.npm_config_user_agent;
+
+    // Check if running through npm init
+    if (userAgent?.startsWith("npm")) {
+      return "npm";
+    }
+
+    // Check for Bun in process.argv
+    if (process.argv.some((arg) => arg.includes("bun"))) {
+      return "bun";
+    }
+
+    // Fallback to detect for other cases
+    const pkgManager = await detect();
     let version = "";
 
     if (userAgent && pkgManager === "yarn") {
@@ -217,11 +239,9 @@ async function detectPackageManager() {
 
     return pkgManager + version;
   } catch (error) {
-    // Fallback to npm if detection fails
     return "npm";
   }
 }
-
 function kebabcase(str) {
   return str
     .replace(/([a-z])([A-Z])/g, "$1-$2")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.1.8",
+  "version": "1.1.9-beta.2",
   "license": "MIT",
   "type": "module",
   "main": "index.js",
@@ -30,7 +30,7 @@
     "@types/node": "^20.14.2",
     "prettier": "^3.3.1"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.5.1",
   "engines": {
     "node": ">=20"
   },

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

@@ -0,0 +1,43 @@
+import { ensUrl } from "../index.js";
+import { XMTPContext, getUserInfo } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/check [domain]",
+    handler: handleCheck,
+    examples: ["/check vitalik.eth", "/check fabri.base.eth"],
+    description: "Check if a domain is available.",
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+export async function handleCheck(context: XMTPContext) {
+  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,
+    };
+  }
+}

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

@@ -0,0 +1,52 @@
+import { XMTPContext } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/cool [domain]",
+    examples: ["/cool vitalik.eth"],
+    handler: handleCool,
+    description: "Get cool alternatives for a .eth domain.",
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+export async function handleCool(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+  //What about these cool alternatives?\
+  return {
+    code: 200,
+    message: `${generateCoolAlternatives(domain)}`,
+  };
+}
+
+export const generateCoolAlternatives = (domain: string) => {
+  const suffixes = ["lfg", "cool", "degen", "moon", "base", "gm"];
+  const alternatives = [];
+  for (let i = 0; i < 5; i++) {
+    const randomPosition = Math.random() < 0.5;
+    const baseDomain = domain.replace(/\.eth$/, ""); // Remove any existing .eth suffix
+    alternatives.push(
+      randomPosition
+        ? `${suffixes[i]}${baseDomain}.eth`
+        : `${baseDomain}${suffixes[i]}.eth`,
+    );
+  }
+
+  const cool_alternativesFormat = alternatives
+    .map(
+      (alternative: string, index: number) => `${index + 1}. ${alternative} ✨`,
+    )
+    .join("\n");
+  return cool_alternativesFormat;
+};

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

@@ -0,0 +1,65 @@
+import { ensUrl } from "../index.js";
+import { XMTPContext, getUserInfo, isOnXMTP } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/info [domain]",
+    handler: handleInfo,
+    description:
+      "Get detailed information about an ENS domain including owner, expiry date, and resolver.",
+    examples: ["/info nick.eth"],
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+
+export async function handleInfo(context: XMTPContext) {
+  const {
+    message: {
+      sender,
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+
+  const data = await getUserInfo(domain);
+  if (!data?.ensDomain) {
+    return {
+      code: 404,
+      message: "Domain not found.",
+    };
+  }
+
+  const formattedData = {
+    Address: data?.address,
+    "Avatar URL": data?.ensInfo?.avatar,
+    Description: data?.ensInfo?.description,
+    ENS: data?.ensDomain,
+    "Primary ENS": data?.ensInfo?.ens_primary,
+    GitHub: data?.ensInfo?.github,
+    Resolver: data?.ensInfo?.resolverAddress,
+    Twitter: data?.ensInfo?.twitter,
+    URL: `${ensUrl}${domain}`,
+  };
+
+  let message = "Domain information:\n\n";
+  for (const [key, value] of Object.entries(formattedData)) {
+    if (value) {
+      message += `${key}: ${value}\n`;
+    }
+  }
+  message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
+  message = message.trim();
+  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 };
+}

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

@@ -0,0 +1,40 @@
+import { ensUrl } from "../index.js";
+import { XMTPContext } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/register [domain]",
+    handler: handleRegister,
+    description:
+      "Register a new ENS domain. Returns a URL to complete the registration process.",
+    examples: ["/register vitalik.eth"],
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+
+export async function handleRegister(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+
+  if (!domain) {
+    return {
+      code: 400,
+      message: "Missing required parameters. Please provide domain.",
+    };
+  }
+  // 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/renew.ts

@@ -0,0 +1,52 @@
+import { frameUrl } from "../index.js";
+import { getUserInfo, XMTPContext } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/renew [domain]",
+    handler: handleRenew,
+    description:
+      "Extend the registration period of your ENS domain. Returns a URL to complete the renewal.",
+    examples: ["/renew fabri.base.eth"],
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+
+export async function handleRenew(context: XMTPContext) {
+  const {
+    message: {
+      sender,
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+
+  // Check if the user holds the domain
+  if (!domain) {
+    return {
+      code: 400,
+      message: "Missing required parameters. Please provide domain.",
+    };
+  }
+
+  const data = await getUserInfo(domain);
+
+  if (!data?.address || data?.address !== sender?.address) {
+    return {
+      code: 403,
+      message:
+        "Looks like this domain is not registered to you. Only the owner can renew it.",
+    };
+  }
+
+  // Generate URL for the ens
+  let url_ens = frameUrl + "frames/manage?name=" + domain;
+  return { code: 200, message: `${url_ens}` };
+}

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

@@ -0,0 +1,19 @@
+import { clearInfoCache, clearMemory } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/reset",
+    examples: ["/reset"],
+    handler: handleReset,
+    description: "Reset the conversation.",
+    params: {},
+  },
+];
+export async function handleReset(context: XMTPContext) {
+  clearMemory();
+  clearInfoCache();
+  return { code: 200, message: "Conversation reset." };
+}

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

@@ -0,0 +1,42 @@
+import { txpayUrl } from "../index.js";
+import { XMTPContext, getUserInfo } from "@xmtp/message-kit";
+
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/tip [address]",
+    description: "Show a URL for tipping a domain owner.",
+    handler: handleTip,
+    examples: ["/tip 0x1234567890123456789012345678901234567890"],
+    params: {
+      address: {
+        type: "string",
+      },
+    },
+  },
+];
+export async function handleTip(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        params: { address },
+      },
+    },
+  } = context;
+
+  if (!address) {
+    return {
+      code: 400,
+      message: "Please provide an address to tip.",
+    };
+  }
+  const data = await getUserInfo(address);
+
+  let sendUrl = `${txpayUrl}/?&amount=1&token=USDC&receiver=${address}`;
+
+  return {
+    code: 200,
+    message: sendUrl,
+  };
+}

package/templates/agent/src/index.ts

@@ -1,31 +1,50 @@
-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";
+import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+import { systemPrompt } from "./prompt.js";
+import { registerSkill as checkSkill } from "./handlers/check.js";
+import { registerSkill as coolSkill } from "./handlers/cool.js";
+import { registerSkill as infoSkill } from "./handlers/info.js";
+import { registerSkill as registerSkill } from "./handlers/register.js";
+import { registerSkill as renewSkill } from "./handlers/renew.js";
+import { registerSkill as resetSkill } from "./handlers/reset.js";
+import { registerSkill as tipSkill } from "./handlers/tip.js";
+import fs from "fs";
 
-run(async (context: HandlerContext) => {
-  const {
-    message: {
-      content: { text, params },
-      sender,
-    },
-  } = context;
+export const frameUrl = "https://ens.steer.fun/";
+export const ensUrl = "https://app.ens.domains/";
+export const txpayUrl = "https://txpay.vercel.app";
 
-  try {
-    let userPrompt = params?.prompt ?? text;
-    const userInfo = await getUserInfo(sender.address);
-    if (!userInfo) {
-      console.log("User info not found");
-      return;
-    }
-    const { reply } = await textGeneration(
+export const skills = [
+  {
+    name: "Ens Domain Bot",
+    tag: "@ens",
+    description: "Register ENS domains.",
+    skills: [
+      ...checkSkill,
+      ...coolSkill,
+      ...infoSkill,
+      ...registerSkill,
+      ...renewSkill,
+      ...resetSkill,
+      ...tipSkill,
+    ],
+  },
+];
+
+run(
+  async (context) => {
+    const {
+      message: { sender },
+      runConfig,
+    } = context;
+
+    let prompt = await replaceVariables(
+      systemPrompt,
       sender.address,
-      userPrompt,
-      await agent_prompt(userInfo),
+      runConfig?.skills,
+      "@ens",
     );
-    await processMultilineResponse(sender.address, reply, context);
-  } catch (error) {
-    console.error("Error during OpenAI call:", error);
-    await context.send("An error occurred while processing your request.");
-  }
-});
+    fs.writeFileSync("example_prompt.md", prompt);
+    await agentReply(context, prompt);
+  },
+  { skills },
+);

package/templates/agent/src/prompt.ts

@@ -1,69 +1,52 @@
-import { skills } from "./skills.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 systemPrompt =
-    PROMPT_RULES +
-    PROMPT_USER_CONTENT(userInfo) +
-    PROMPT_SKILLS_AND_EXAMPLES(skills, "@ens");
-
-  let fineTunning = `
-
-## Example responses:
-
-1. Check if the user does not have a ENS domain
-  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  {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  {ENS_DOMAIN}. Give me a moment.\n/check  {ENS_DOMAIN}
-
-4. If the ENS domain is available,
-  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  {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  {ENS_DOMAIN} is available! Let me help you register it\n/register  {ENS_DOMAIN} 
+export const systemPrompt = `
+Your are helpful and playful agent called {agent_name} that lives inside a web3 messaging app called Converse.
+
+{rules}
+
+{user_context}
+
+{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:
+   /tip [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]
   
-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  {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  {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  {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  {ENS_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.
-  You should have said something like: "Looks like vitalik.eth is registered! What about these cool alternatives?\n/cool vitalik.eth
+1. Sometimes 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.
 `;
-
-  // 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",
-  );
-  // console.log(systemPrompt);
-  return systemPrompt;
-}

package/templates/gpt/.env.example

@@ -0,0 +1,2 @@
+KEY= # the private key of the agent wallet 
+OPEN_AI_API_KEY= # the API key for OpenAI

package/templates/gpt/src/index.ts

@@ -0,0 +1,18 @@
+import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+
+import { systemPrompt } from "./prompt.js";
+
+run(async (context) => {
+  const {
+    message: { sender },
+    runConfig,
+  } = context;
+
+  let prompt = await replaceVariables(
+    systemPrompt,
+    sender.address,
+    runConfig?.skills,
+    "@bot",
+  );
+  await agentReply(context, prompt);
+});

package/templates/gpt/src/prompt.ts

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

package/templates/group/src/{handler → handlers}/game.ts

@@ -1,7 +1,23 @@
-import { HandlerContext } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
+import type { skillAction } from "@xmtp/message-kit";
 
-// Handler function to process game-related
-export async function handler(context: HandlerContext) {
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/game [game]",
+    handler: handleGames,
+    description: "Play a game.",
+    examples: ["/game wordle", "/game slot", "/game help"],
+    params: {
+      game: {
+        default: "",
+        type: "string",
+        values: ["wordle", "slot", "help"],
+      },
+    },
+  },
+];
+
+export async function handleGames(context: XMTPContext) {
   const {
     message: {
       content: { skill, params, text },