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

package/index.js

@@ -51,7 +51,7 @@ Powered by XMTP`;
     log.success(`Project launched in ${pc.red(destDir)}!`);
 
     // Add package.json
-    addPackagejson(destDir, displayName, pkgManager);
+    updatePackagejson(destDir, templateType);
 
     // Create README.md file
     createReadme(destDir, templateType, displayName, pkgManager);
@@ -64,39 +64,15 @@ Powered by XMTP`;
 
 program.parse(process.argv);
 
-async function addPackagejson(destDir, name, pkgManager) {
+async function updatePackagejson(destDir, templateType) {
   // Create package.json based on the template
-  let 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": "latest",
-    },
-    devDependencies: {
-      "@types/node": "latest",
-      typescript: "latest",
-    },
-    engines: {
-      node: ">=20",
-    },
-  };
-
-  if (pkgManager.includes("yarn")) {
-    //packageTemplate.packageManager = `${pkgManager}`;
-    // Add .yarnrc.yml to disable PnP mode
-  }
+  const templateDir = resolve(__dirname, `./templates/${templateType}`);
+  const packageTemplate = fs.readJsonSync(`${templateDir}/package.json`);
 
-  fs.writeFileSync(
-    resolve(destDir, ".yarnrc.yml"),
-    "nodeLinker: node-modules\n",
-  );
+  packageTemplate.dependencies["@xmtp/message-kit"] = "latest";
+  //Add for yarn in general
+  packageTemplate.scripts.postinstall = "tsc";
+  packageTemplate.packageManager = `yarn@4.5.1`;
 
   fs.writeJsonSync(resolve(destDir, "package.json"), packageTemplate, {
     spaces: 2,
@@ -105,10 +81,10 @@ async function addPackagejson(destDir, name, pkgManager) {
 
 async function gatherProjectInfo() {
   const templateOptions = [
-    { value: "gpt", label: "GPT" },
-    { value: "agent", label: "Agent" },
-    { value: "group", label: "Group" },
-    { value: "ens", label: "Ens Agent Pro" },
+    { value: "gpt", label: "Simple Gpt" },
+    { value: "agent", label: "ENS Agent" },
+    { value: "group", label: "Group bot" },
+    { value: "gated", label: "Gated Group" },
   ];
 
   const templateType = await select({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.1.9",
+  "version": "1.1.10-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/.yarnrc.yml

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

package/templates/agent/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "agent",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 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/agent/src/handlers/check.ts

@@ -0,0 +1,42 @@
+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,29 @@
+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;
+  console.log("tip", address);
+  await context.sendPay(1, "USDC", address);
+}

package/templates/agent/src/index.ts

@@ -1,55 +1,55 @@
-import { run, HandlerContext } from "@xmtp/message-kit";
-import { agentRun } from "@xmtp/message-kit";
-import { skills } from "./skills.js";
-import { defaultPromptTemplate } from "@xmtp/message-kit";
-
-export async function agent_prompt(senderAddress: string) {
-  let fineTuning = `
-## 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} 
-  
-7. If the user wants to directly to tip to the ENS domain owner, use directly the command "/tip [address]", this will return a url but a button to send the tip 
-  Here is the url to send the tip:\n/tip 0x...
-
-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
-`;
-
-  return defaultPromptTemplate(fineTuning, senderAddress, skills, "@ens");
-}
-
-run(async (context: HandlerContext) => {
-  agentRun(context, async (address: string) => {
-    const result = (await agent_prompt(address)) ?? "No response available";
-    return result;
-  });
-});
+import {
+  run,
+  agentReply,
+  replaceVariables,
+  XMTPContext,
+} 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";
+
+export const frameUrl = "https://ens.steer.fun/";
+export const ensUrl = "https://app.ens.domains/";
+export const txpayUrl = "https://txpay.vercel.app";
+
+export const skills = [
+  {
+    name: "Ens Domain Bot",
+    tag: "@ens",
+    description: "Register ENS domains.",
+    skills: [
+      ...checkSkill,
+      ...coolSkill,
+      ...infoSkill,
+      ...registerSkill,
+      ...renewSkill,
+      ...resetSkill,
+      ...tipSkill,
+    ],
+  },
+];
+
+run(
+  async (context: XMTPContext) => {
+    const {
+      message: { sender },
+      skills,
+    } = context;
+
+    let prompt = await replaceVariables(
+      systemPrompt,
+      sender.address,
+      skills,
+      "@ens",
+    );
+    fs.writeFileSync("example_prompt.md", prompt);
+    await agentReply(context, prompt);
+  },
+  { skills },
+);

package/templates/agent/src/prompt.ts

@@ -0,0 +1,52 @@
+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]
+  
+## 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.
+`;

package/templates/gated/.env.example

@@ -0,0 +1,3 @@
+KEY= # the private key of the bot wallet
+PORT= # the port of the server
+ALCHEMY_API_KEY= # the alchemy api key

package/templates/gated/.yarnrc.yml

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

package/templates/gated/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "gated",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && node --watch dist/index.js",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*",
+    "alchemy-sdk": "^3.4.3",
+    "express": "^4.19.2"
+  },
+  "devDependencies": {
+    "@types/express": "^4",
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}