create-message-kit 1.0.14 → 1.0.16

package/index.js

@@ -19,7 +19,16 @@ program
   .name("byob")
   .description("CLI to initialize projects")
   .action(async () => {
-    intro(pc.red(`Welcome to MessageKit CLI v${version}!`));
+    log.message(`\x1b[38;2;250;105;119m\
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+███╗   ███╗███████╗███████╗███████╗ █████╗  ██████╗ ███████╗██╗  ██╗██╗████████╗
+████╗ ████║██╔════╝██╔════╝██╔════╝██╔══██╗██╔════╝ ██╔════╝██║ ██╔╝██║╚══██╔══╝
+██╔████╔██║█████╗  ███████╗███████╗███████║██║  ███╗█████╗  █████╔╝ ██║   ██║   
+██║╚██╔╝██║██╔══╝  ╚════██║╚════██║██╔══██║██║   ██║██╔══╝  ██╔═██╗ ██║   ██║   
+██║ ╚═╝ ██║███████╗███████║███████║██║  ██║╚██████╔╝███████╗██║  ██╗██║   ██║   
+╚═╝     ╚═╝╚══════╝╚══════╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝   ╚═╝   
+Powered by XMTP \x1b[0m`);
 
     const { templateType, displayName, destDir } = await gatherProjectInfo();
 
@@ -47,7 +56,7 @@ program
     createReadme(destDir, templateType, displayName, pkgManager);
 
     // Log next steps
-    logNextSteps(displayName, pkgManager);
+    logNextSteps(displayName);
 
     outro(pc.red("Made with ❤️  by Ephemera"));
   });
@@ -57,7 +66,7 @@ program.parse(process.argv);
 async function gatherProjectInfo() {
   const templateOptions = [
     { value: "gm", label: "GM" },
-    { value: "one-to-one", label: "One-to-One" },
+    { value: "agent", label: "Agent" },
     { value: "group", label: "Group" },
   ];
 
@@ -70,7 +79,7 @@ async function gatherProjectInfo() {
     process.exit(0);
   }
 
-  const templateDir = resolve(__dirname, `./examples/${templateType}`);
+  const templateDir = resolve(__dirname, `./templates/${templateType}`);
 
   // Ensure the template directory exists
   if (!fs.existsSync(templateDir)) {
@@ -159,7 +168,7 @@ function updatePackageJson(destDir, name) {
   fs.writeJsonSync(resolve(destDir, "package.json"), pkgJson, { spaces: 2 });
 }
 
-function logNextSteps(name, pkgManager) {
+function logNextSteps(name) {
   log.message("Next steps:");
   log.step(`1. ${pc.red(`cd ./${name}`)} - Navigate to project`);
   log.step(`2. ${pc.red(`code .`)} - Open with your favorite editor`);
@@ -224,7 +233,7 @@ function createReadme(destDir, templateType, projectName, packageManager) {
 
   const readmeContent = `# ${projectName}
 
-This project is powered by the [MessageKit](https://messagekit.ephemerahq.com/) 
+This project is powered by [MessageKit](https://messagekit.ephemerahq.com/) 
 
 ## Setup
 
@@ -256,7 +265,7 @@ ${packageManager === "npm" ? "npm run" : packageManager} dev
 
 5. Enjoy!
 ---
-Made with ❤️ by [Ephemera](https://ephemerahq.com)
+Made with ❤️ by [XMTP](https://xmtp.org)
 `;
 
   fs.writeFileSync(resolve(destDir, "README.md"), readmeContent.trim());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "license": "MIT",
   "type": "module",
   "main": "index.js",
@@ -8,7 +8,7 @@
   "bin": "index.js",
   "files": [
     "index.js",
-    "examples/**/*"
+    "templates/**/*"
   ],
   "scripts": {
     "clean": "rm -rf .turbo && rm -rf node_modules",

package/templates/agent/.env.example

@@ -0,0 +1,2 @@
+KEY= # the private key of the wallet
+OPEN_AI_API_KEY= # sk-proj-...

package/{examples/one-to-one → templates/agent}/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "one-to-one",
+  "name": "agent",
   "private": true,
   "type": "module",
   "scripts": {
@@ -8,13 +8,11 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
-    "@redis/client": "^1.5.16",
     "@xmtp/message-kit": "workspace:*",
-    "node-cron": "^3.0.3"
+    "openai": "^4.65.0"
   },
   "devDependencies": {
     "@types/node": "^20.14.2",
-    "@types/node-cron": "^3.0.11",
     "nodemon": "^3.1.3",
     "typescript": "^5.4.5"
   },

package/templates/agent/src/commands.ts

@@ -0,0 +1,69 @@
+import type { CommandGroup } from "@xmtp/message-kit";
+import { ensAgent, handleEns } from "./handler/ens.js";
+
+export const commands: CommandGroup[] = [
+  {
+    name: "Ens Domain Bot",
+    description: "Register ENS domains.",
+    commands: [
+      {
+        command: "/register [domain]",
+        triggers: ["/register", "@ensbot"],
+        handler: handleEns,
+        description: "Register a domain.",
+        params: {
+          domain: {
+            type: "string",
+          },
+        },
+      },
+      {
+        command: "/info [domain]",
+        triggers: ["/info", "@ensbot"],
+        handler: handleEns,
+        description: "Get information about a domain.",
+        params: {
+          domain: {
+            type: "string",
+          },
+        },
+      },
+      {
+        command: "/renew [domain]",
+        triggers: ["/renew", "@ensbot"],
+        handler: handleEns,
+        description: "Renew a domain.",
+        params: {
+          domain: {
+            type: "string",
+          },
+        },
+      },
+      {
+        command: "/check [domain] [cool_alternatives]",
+        triggers: ["/check"],
+        handler: handleEns,
+        description: "Check if a domain is available.",
+        params: {
+          domain: {
+            type: "string",
+          },
+          cool_alternatives: {
+            type: "quoted",
+          },
+        },
+      },
+      {
+        command: "/tip [address]",
+        description: "Show a URL for tipping a domain owner.",
+        triggers: ["/tip"],
+        handler: ensAgent,
+        params: {
+          address: {
+            type: "address",
+          },
+        },
+      },
+    ],
+  },
+];

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

@@ -0,0 +1,247 @@
+import { HandlerContext } from "@xmtp/message-kit";
+import { Client } from "@xmtp/xmtp-js";
+import { getUserInfo, getInfoCache, isOnXMTP } from "../lib/resolver.js";
+import { textGeneration, responseParser } from "../lib/openai.js";
+import { ens_agent_prompt } from "../prompt.js";
+import type {
+  ensDomain,
+  converseUsername,
+  tipAddress,
+  chatHistories,
+  tipDomain,
+} from "../lib/types.js";
+import { frameUrl, ensUrl, baseTxUrl, InfoCache } from "../lib/types.js";
+
+let tipAddress: tipAddress = {};
+let tipDomain: tipDomain = {};
+let ensDomain: ensDomain = {};
+let infoCache: InfoCache = {};
+let converseUsername: converseUsername = {};
+let chatHistories: chatHistories = {};
+
+// URL for the send transaction
+export async function handleEns(context: HandlerContext) {
+  const {
+    message: {
+      content: { command, params, sender },
+    },
+  } = context;
+
+  if (command == "renew") {
+    // Destructure and validate parameters for the ens command
+    const { domain } = params;
+    // Check if the user holds the domain
+    if (!domain) {
+      context.reply("Missing required parameters. Please provide domain.");
+      return;
+    }
+
+    const { infoCache: retrievedInfoCache } = await getInfoCache(
+      domain,
+      infoCache,
+    );
+    infoCache = retrievedInfoCache;
+    let data = infoCache[domain].info;
+
+    if (data?.address !== sender?.address) {
+      return {
+        code: 403,
+        message: "You do not hold this domain. 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}` };
+  } else if (command == "register") {
+    // Destructure and validate parameters for the ens command
+    const { domain } = params;
+
+    if (!domain) {
+      return {
+        code: 400,
+        message: "Missing required parameters. Please provide domain.",
+      };
+    }
+    // Generate URL for the ens
+    let url_ens = ensUrl + domain;
+    return { code: 200, message: `${url_ens}` };
+  } else if (command == "info") {
+    const { domain } = params;
+
+    const { infoCache: retrievedInfoCache } = await getInfoCache(
+      domain,
+      infoCache,
+    );
+    infoCache = retrievedInfoCache;
+    let data = infoCache[domain].info;
+
+    const formattedData = {
+      Address: data?.address,
+      "Avatar URL": data?.avatar_url,
+      Description: data?.description,
+      ENS: data?.ens,
+      "Primary ENS": data?.ens_primary,
+      GitHub: data?.github,
+      Resolver: data?.resolverAddress,
+      Twitter: data?.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.v2client, data?.ens, data?.address)) {
+      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") {
+    console.log(params);
+    const { domain, cool_alternatives } = params;
+
+    const cool_alternativesFormat = cool_alternatives
+      ?.split(",")
+      .map(
+        (alternative: string, index: number) =>
+          `${index + 1}. ${alternative} ✨`,
+      )
+      .join("\n");
+
+    if (!domain) {
+      return {
+        code: 400,
+        message: "Please provide a domain name to check.",
+      };
+    }
+    const { infoCache: retrievedInfoCache } = await getInfoCache(
+      domain,
+      infoCache,
+    );
+    infoCache = retrievedInfoCache;
+    let data = infoCache?.[domain]?.info;
+    if (!data?.address) {
+      let message = `Looks like ${domain} is available! Do you want to register it? ${ensUrl}${domain}`;
+      return {
+        code: 200,
+        message,
+      };
+    } else {
+      let message = `Looks like ${domain} is already registered! What about these cool alternatives?\n\n${cool_alternativesFormat}`;
+      return {
+        code: 404,
+        message,
+      };
+    }
+  } else if (command == "tip") {
+    // Destructure and validate parameters for the send command
+    const { address } = params;
+
+    const { infoCache: retrievedInfoCache } = await getInfoCache(
+      address,
+      infoCache,
+    );
+    infoCache = retrievedInfoCache;
+    let data = infoCache[address].info;
+
+    tipAddress[sender.address] = data?.address;
+    tipDomain[sender.address] = data?.ens;
+
+    if (!address || !tipAddress[sender.address]) {
+      context.reply("Missing required parameters. Please provide address.");
+      return;
+    }
+    let txUrl = `${baseTxUrl}/transaction/?transaction_type=send&buttonName=Tip%20${tipDomain[sender.address]}&amount=1&token=USDC&receiver=${tipAddress[sender.address]}`;
+    // Generate URL for the send transaction
+    context.send(`Here is the url to send the tip:\n${txUrl}`);
+  } else if (command == "cool") {
+    return;
+  }
+}
+
+export async function clearChatHistory() {
+  chatHistories = {};
+}
+
+async function processResponseWithIntent(
+  reply: string,
+  context: any,
+  senderAddress: string,
+) {
+  let messages = reply
+    .split("\n")
+    .map((message: string) => responseParser(message))
+    .filter((message): message is string => message.length > 0);
+
+  console.log(messages);
+  for (const message of messages) {
+    if (message.startsWith("/")) {
+      const response = await context.intent(message);
+      if (response && response.message) {
+        let msg = responseParser(response.message);
+
+        chatHistories[senderAddress].push({
+          role: "system",
+          content: msg,
+        });
+
+        await context.send(response.message);
+      }
+    } else {
+      await context.send(message);
+    }
+  }
+}
+
+export async function ensAgent(context: HandlerContext) {
+  if (!process?.env?.OPEN_AI_API_KEY) {
+    console.warn("No OPEN_AI_API_KEY found in .env");
+    return;
+  }
+
+  const {
+    message: {
+      content: { content, params },
+      sender,
+    },
+    group,
+  } = context;
+
+  try {
+    let userPrompt = params?.prompt ?? content;
+    const { converseUsername: newConverseUsername, ensDomain: newEnsDomain } =
+      await getUserInfo(
+        sender.address,
+        ensDomain[sender.address],
+        converseUsername[sender.address],
+      );
+
+    ensDomain[sender.address] = newEnsDomain;
+    converseUsername[sender.address] = newConverseUsername;
+    let txUrl = `${baseTxUrl}/transaction/?transaction_type=send&buttonName=Tip%20${tipDomain[sender.address]}&amount=1&token=USDC&receiver=${tipAddress[sender.address]}`;
+
+    const { reply, history } = await textGeneration(
+      userPrompt,
+      await ens_agent_prompt(
+        sender.address,
+        ensDomain[sender.address],
+        converseUsername[sender.address],
+        tipAddress[sender.address],
+        txUrl,
+      ),
+      chatHistories[sender.address],
+    );
+    if (!group) chatHistories[sender.address] = history; // Update chat history for the user
+
+    await processResponseWithIntent(reply, context, sender.address);
+  } catch (error) {
+    console.error("Error during OpenAI call:", error);
+    await context.send("An error occurred while processing your request.");
+  }
+}

package/templates/agent/src/index.ts

@@ -0,0 +1,6 @@
+import { run, HandlerContext } from "@xmtp/message-kit";
+import { ensAgent } from "./handler/ens.js";
+
+run(async (context: HandlerContext) => {
+  await ensAgent(context);
+});

package/templates/agent/src/lib/openai.ts

@@ -0,0 +1,125 @@
+import dotenv from "dotenv";
+dotenv.config();
+
+import OpenAI from "openai";
+const openai = new OpenAI({
+  apiKey: process.env.OPEN_AI_API_KEY,
+});
+
+export async function textGeneration(
+  userPrompt: string,
+  systemPrompt: string,
+  chatHistory?: any[],
+) {
+  let messages = chatHistory ? [...chatHistory] : []; // Start with existing chat history
+  if (messages.length === 0) {
+    messages.push({
+      role: "system",
+      content: systemPrompt,
+    });
+  }
+  messages.push({
+    role: "user",
+    content: userPrompt,
+  });
+  try {
+    const response = await openai.chat.completions.create({
+      model: "gpt-4o",
+      messages: messages as any,
+    });
+    const reply = response.choices[0].message.content;
+    messages.push({
+      role: "assistant",
+      content: reply || "No response from OpenAI.",
+    });
+    const cleanedReply = responseParser(reply as string);
+
+    return { reply: cleanedReply, history: messages };
+  } catch (error) {
+    console.error("Failed to fetch from OpenAI:", error);
+    throw error;
+  }
+}
+
+// New method to interpret an image
+export async function vision(imageData: Uint8Array, systemPrompt: string) {
+  const base64Image = Buffer.from(imageData).toString("base64");
+  const dataUrl = `data:image/jpeg;base64,${base64Image}`;
+
+  // Create a new thread for each vision request
+  const visionMessages = [
+    {
+      role: "system",
+      content: systemPrompt,
+    },
+    {
+      role: "user",
+      content: [
+        { type: "text", text: systemPrompt },
+        {
+          type: "image_url",
+          image_url: {
+            url: dataUrl,
+          },
+        },
+      ],
+    },
+  ];
+
+  try {
+    const response = await openai.chat.completions.create({
+      model: "gpt-4o",
+      messages: visionMessages as any,
+    });
+    return response.choices[0].message.content;
+  } catch (error) {
+    console.error("Failed to interpret image with OpenAI:", error);
+    throw error;
+  }
+}
+
+export function responseParser(message: string) {
+  let trimmedMessage = message;
+  // Remove bold and underline markdown
+  trimmedMessage = trimmedMessage?.replace(/(\*\*|__)(.*?)\1/g, "$2");
+  // Remove markdown links, keeping only the URL
+  trimmedMessage = trimmedMessage?.replace(/\[([^\]]+)\]\(([^)]+)\)/g, "$2");
+  // Remove markdown headers
+  trimmedMessage = trimmedMessage?.replace(/^#+\s*(.*)$/gm, "$1");
+  // Remove inline code formatting
+  trimmedMessage = trimmedMessage?.replace(/`([^`]+)`/g, "$1");
+  // Remove single backticks at the start or end of the message
+  trimmedMessage = trimmedMessage?.replace(/^`|`$/g, "");
+  // Remove leading and trailing whitespace
+  trimmedMessage = trimmedMessage?.replace(/^\s+|\s+$/g, "");
+  // Remove any remaining leading or trailing whitespace
+  trimmedMessage = trimmedMessage.trim();
+  return trimmedMessage;
+}
+
+// UNTESTED, recursive response parser
+export function responseParser2(message: string | string[]): string | string[] {
+  // If message is an array, process each item individually
+  if (Array.isArray(message)) {
+    return message
+      .map((item) => responseParser(item))
+      .flat() // Flatten nested arrays
+      .filter((item: string) => item.length > 0)
+      .filter((item: string) => item !== "`");
+  }
+  let trimmedMessage = message;
+  // Remove bold and underline markdown
+  trimmedMessage = trimmedMessage?.replace(/(\*\*|__)(.*?)\1/g, "$2");
+  // Remove markdown links, keeping only the URL
+  trimmedMessage = trimmedMessage?.replace(/\[([^\]]+)\]\(([^)]+)\)/g, "$2");
+  // Remove markdown headers
+  trimmedMessage = trimmedMessage?.replace(/^#+\s*(.*)$/gm, "$1");
+  // Remove inline code formatting
+  trimmedMessage = trimmedMessage?.replace(/(`{1,3})(.*?)\1/g, "$2");
+  // Remove leading and trailing whitespace
+  trimmedMessage = trimmedMessage?.replace(/`/g, ""); // Remove single backticks
+  // Remove any remaining leading or trailing whitespace
+  trimmedMessage = trimmedMessage?.trim();
+
+  return trimmedMessage;
+}

package/templates/agent/src/lib/resolver.ts

@@ -0,0 +1,82 @@
+import type { EnsData } from "./types.js";
+import { endpointURL } from "./types.js";
+import { Client } from "@xmtp/xmtp-js";
+import { InfoCache } from "./types.js";
+
+export async function getUserInfo(
+  address: string,
+  ensDomain: string | undefined,
+  converseUsername: string | undefined,
+) {
+  if (!ensDomain) {
+    const response = await fetch(`https://ensdata.net/${address}`);
+    const data: EnsData = (await response.json()) as EnsData;
+    ensDomain = data?.ens;
+  }
+  if (!converseUsername) {
+    const response = await fetch(`${endpointURL}/profile/${address}`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Accept: "application/json",
+      },
+      body: JSON.stringify({ address: address }),
+    });
+    const data = (await response.json()) as { name: string };
+    converseUsername = data?.name;
+    converseUsername = converseUsername.replace(".converse.xyz", "");
+  }
+  console.log("User info fetched for", {
+    address,
+    converseUsername,
+    ensDomain,
+  });
+  return { converseUsername: converseUsername, ensDomain: ensDomain };
+}
+
+export const getInfoCache = async (
+  key: string, // This can be either domain or address
+  infoCache: InfoCache,
+): Promise<{ domain: string; info: EnsData; infoCache: InfoCache }> => {
+  if (infoCache[key]) {
+    let data = {
+      domain: key,
+      info: infoCache[key].info,
+      infoCache: infoCache,
+    };
+    return data;
+  }
+  try {
+    const response = await fetch(`https://ensdata.net/${key}`);
+    const data: EnsData = (await response.json()) as EnsData;
+
+    // Assuming the data contains both domain and address
+    const domain = data?.ens;
+    const address = data?.address;
+
+    // Store data in cache by both domain and address
+    if (domain) infoCache[domain as string] = { info: data };
+    if (address) infoCache[address as string] = { info: data };
+
+    return { info: data, infoCache: infoCache, domain: domain as string };
+  } catch (error) {
+    console.error(error);
+    return { info: {}, infoCache: infoCache, domain: "" };
+  }
+};
+export const generateCoolAlternatives = (domain: string) => {
+  const suffixes = ["lfg", "cool", "degen", "moon", "base", "gm"];
+  const alternatives = suffixes.map((suffix) => {
+    const randomPosition = Math.random() < 0.5;
+    return randomPosition ? `${suffix}${domain}.eth` : `${domain}${suffix}.eth`;
+  });
+  return alternatives.join(",");
+};
+export const isOnXMTP = async (
+  client: Client,
+  domain: string | undefined,
+  address: string | undefined,
+) => {
+  if (domain == "fabri.eth") return false;
+  if (address) return (await client.canMessage([address])).length > 0;
+};

package/templates/agent/src/lib/types.ts

@@ -0,0 +1,33 @@
+export type chatHistories = Record<string, any[]>;
+export type ensDomain = Record<string, string | undefined>;
+export type converseUsername = Record<string, string | undefined>;
+export type tipAddress = Record<string, string | undefined>;
+export type tipDomain = Record<string, string | undefined>;
+
+export type InfoCache = {
+  [key: string]: { info: EnsData };
+};
+export const frameUrl = "https://ens.steer.fun/";
+export const ensUrl = "https://app.ens.domains/";
+export const baseTxUrl = "https://base-tx-frame.vercel.app";
+export const endpointURL =
+  "https://converse-website-git-endpoit-ephemerahq.vercel.app";
+
+export interface EnsData {
+  address?: string;
+  avatar?: string;
+  avatar_small?: string;
+  converse?: string;
+  avatar_url?: string;
+  contentHash?: string;
+  description?: string;
+  ens?: string;
+  ens_primary?: string;
+  github?: string;
+  resolverAddress?: string;
+  twitter?: string;
+  url?: string;
+  wallets?: {
+    eth?: string;
+  };
+}

package/templates/agent/src/prompt.ts

@@ -0,0 +1,93 @@
+import { generateCoolAlternatives } from "./lib/resolver.js";
+export async function ens_agent_prompt(
+  address: string,
+  domain?: string,
+  name?: string,
+  converseUsername?: string,
+  tipAddress?: string,
+  txUrl?: string,
+) {
+  const userName = domain ?? name ?? "";
+  const commonAlternatives = generateCoolAlternatives(userName);
+  const systemPrompt = `You are a helpful and playful agent that lives inside a web3 messaging app.
+- You can respond with multiple messages if needed. Each message should be separated by a newline character.
+- You can trigger commands by only sending the command in a newline message.
+- Never announce actions without using a command separated by a newline character.
+- Only provide answers based on verified information.
+- Do not make guesses or assumptions
+- CHECK that you are not missing a command
+
+User context: 
+- Users address is: ${address}
+${domain != undefined ? `- User ENS domain is: ${domain}` : "- User ENS domain: None"}
+${name != undefined ? `- User name is: ${name}` : "- User name: None"}
+
+## Task
+- Start by fetch their domain from or Convese 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.
+- Use "/check [domain] [cool_alternatives]" to see if a domain is available and offer cool alternatives
+- To check the information about the domain by using the command "/info [domain]".
+- To register a domain use the command "/register [domain]".
+- To trigger renewal: "/renew [domain]".
+- To tip the domain owner: "/tip [address]".
+
+Commands:
+- /info [domain]: Get information about a domain
+- /check [domain] [cool_alternatives]: Check if a domain is available and send cool alternatives
+- /register [domain]: Register a domain
+- /renew [domain]: Renew a domain
+- /tip [address]: Tip the domain owner
+
+Examples:
+- /check ${userName} "${commonAlternatives}"
+- /info nick.eth
+- /register vitalik.eth 
+- /renew fabri.base.eth
+- /tip 0xf0EA7663233F99D0c12370671abBb6Cca980a490
+
+## Example response:
+
+1. Check if the user does not have a ENS domain
+  Hey ${name}! it looks like you don't have a ENS domain yet! \n\nCan you give me another name so I can suggest some cool domain alternatives for you or i can use your ${converseUsername} username? 🤔
+
+2. If the user has a ENS domain
+  Hello ${domain} ! I'll help you get your ENS domain.\n Let's start by checking your ENS domain ${domain}. Give me a moment.\n/check ${domain} "${commonAlternatives}" 
+
+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 ${domain}. Give me a moment.\n/check ${domain} "${commonAlternatives}" 
+
+4. If the ENS domain is available,
+  Looks like ${domain} is available! Would you like to register it?\n/register ${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 ${domain} is already registered!\n What about these cool alternatives\n/check ${domain} "${commonAlternatives}" 
+
+6. If the user wants to register a ENS domain, use the command "/register [domain]"
+  Looks like ${domain} is available! Let me help you register it\n/register ${domain} 
+  
+7. If the user wants to tip the ENS domain owner, use the command "/tip [address]", this will return a url to send the tip
+  Looks like ${domain} is already registered!\n Would you like to tip the owner for getting there first 🤣?\n/tip ${tipAddress} 
+
+8. When sending a tip, the url will be returned in the message.
+  Here is the url to send the tip:\n${txUrl} 
+
+9. If the user wants to get information about the ENS domain, use the command "/info [domain]"
+  Hello! I'll help you get info about ${domain}.\n Give me a moment.\n/info ${domain}  
+
+10. 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 ${domain}. Give me a moment.\n/renew ${domain} 
+
+11. If the user wants to directly to tip the ENS domain owner, use the command "/tip [address]", this will return a url to send the tip 
+  Here is the url to send the tip:\n${txUrl}  
+
+12. If the user wants cool suggestions about a domain, use the command "/cool [domain]"
+  Here are some cool suggestions for ${domain}: "${commonAlternatives}"
+
+## Most common bug
+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/check vitalik.eth "${commonAlternatives}"
+`;
+  return systemPrompt;
+}

package/templates/gm/.env.example

@@ -0,0 +1 @@
+KEY= # the private key of the bot wallet 

package/{examples → templates}/gm/package.json

@@ -11,6 +11,7 @@
     "@xmtp/message-kit": "workspace:*"
   },
   "devDependencies": {
+    "@types/node": "^20.14.2",
     "nodemon": "^3.1.3",
     "typescript": "^5.4.5"
   },

package/templates/gm/src/commands.ts

@@ -0,0 +1,18 @@
+import { handler as handlerAll } from "./handler.js";
+import type { CommandGroup } from "@xmtp/message-kit";
+
+export const commands: CommandGroup[] = [
+  {
+    name: "Gm Commands",
+    description: "Commands to send a gm.",
+    commands: [
+      {
+        command: "/gm",
+        triggers: ["/gm"],
+        description: "Send a gm.",
+        handler: handlerAll,
+        params: {},
+      },
+    ],
+  },
+];

package/templates/gm/src/handler.ts

@@ -0,0 +1,6 @@
+import type { HandlerContext } from "@xmtp/message-kit";
+
+export const handler = async (context: HandlerContext) => {
+  await context.send("gm2");
+  await context.intent("/gm3");
+};

package/templates/gm/src/index.ts

@@ -0,0 +1,16 @@
+import { run, HandlerContext } from "@xmtp/message-kit";
+
+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`);
+  },
+  {
+    memberChange: true,
+    attachments: true,
+    experimental: true,
+  },
+);

package/templates/group/.env.example

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

package/{examples → templates}/group/package.json

@@ -13,6 +13,7 @@
     "openai": "^4.52.0"
   },
   "devDependencies": {
+    "@types/node": "^20.14.2",
     "nodemon": "^3.1.3",
     "typescript": "^5.4.5"
   },

package/{examples → templates}/group/src/commands.ts

@@ -4,15 +4,16 @@ import { handler as agent } from "./handler/agent.js";
 import { handler as transaction } from "./handler/transaction.js";
 import { handler as games } from "./handler/game.js";
 import { handler as loyalty } from "./handler/loyalty.js";
+import { helpHandler } from "./index.js";
 
 export const commands: CommandGroup[] = [
   {
     name: "Tipping",
     description: "Tip tokens via emoji, replies or command.",
-    triggers: ["/tip", "🎩", "@tip"],
     commands: [
       {
         command: "/tip [@users] [amount] [token]",
+        triggers: ["/tip", "🎩", "@tip"],
         description: "Tip users in a specified token.",
         handler: tipping,
         params: {
@@ -30,11 +31,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Transactions",
-    triggers: ["@send", "/send", "@swap", "/swap", "/show"],
     description: "Multipurpose transaction frame built onbase.",
     commands: [
       {
         command: "/send [amount] [token] [@username]",
+        triggers: ["@send", "/send"],
         description:
           "Send a specified amount of a cryptocurrency to a destination address.",
         handler: transaction,
@@ -56,6 +57,7 @@ export const commands: CommandGroup[] = [
       },
       {
         command: "/swap [amount] [token_from] [token_to]",
+        triggers: ["@swap", "/swap"],
         description: "Exchange one type of cryptocurrency for another.",
         handler: transaction,
         params: {
@@ -77,6 +79,7 @@ export const commands: CommandGroup[] = [
       },
       {
         command: "/show",
+        triggers: ["/show"],
         handler: transaction,
         description: "Show the whole frame.",
         params: {},
@@ -85,11 +88,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Games",
-    triggers: ["/game", "@game", "🔎", "🔍"],
     description: "Provides various gaming experiences.",
     commands: [
       {
         command: "/game [game]",
+        triggers: ["/game", "@game", "🔎", "🔍"],
         handler: games,
         description: "Play a game.",
         params: {
@@ -104,17 +107,19 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Loyalty",
-    triggers: ["/points", "@points", "/leaderboard", "@leaderboard"],
     description: "Manage group members and metadata.",
     commands: [
       {
         command: "/points",
+        triggers: ["/points", "@points"],
         handler: loyalty,
         description: "Check your points.",
         params: {},
       },
       {
         command: "/leaderboard",
+        triggers: ["/leaderboard", "@leaderboard"],
+        adminOnly: true,
         handler: loyalty,
         description: "Check the points of a user.",
         params: {},
@@ -123,11 +128,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Agent",
-    triggers: ["/agent", "@agent", "@bot"],
     description: "Manage agent commands.",
     commands: [
       {
         command: "/agent [prompt]",
+        triggers: ["/agent", "@agent", "@bot"],
         handler: agent,
         description: "Manage agent commands.",
         params: {
@@ -139,22 +144,14 @@ export const commands: CommandGroup[] = [
       },
     ],
   },
-  {
-    name: "Split Payments",
-    image: true,
-    triggers: [],
-    description: "Split payments between users.",
-    commands: [],
-  },
   {
     name: "Help",
-    triggers: ["/help"],
-
-    description: "Get help    with the bot.",
+    description: "Get help with the bot.",
     commands: [
       {
         command: "/help",
-        handler: undefined,
+        triggers: ["/help"],
+        handler: helpHandler,
         description: "Get help with the bot.",
         params: {},
       },

package/{examples → templates}/group/src/handler/agent.ts

@@ -3,7 +3,7 @@ import { textGeneration } from "../lib/openai.js";
 
 export async function handler(context: HandlerContext) {
   if (!process?.env?.OPEN_AI_API_KEY) {
-    console.log("No OPEN_AI_API_KEY found in .env");
+    console.warn("No OPEN_AI_API_KEY found in .env");
     return;
   }
 
@@ -14,6 +14,7 @@ export async function handler(context: HandlerContext) {
   } = context;
 
   const systemPrompt = generateSystemPrompt(context);
+  console.log("systemPrompt", systemPrompt);
   try {
     let userPrompt = params?.prompt ?? content;
     console.log("userPrompt", userPrompt);

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

@@ -17,8 +17,8 @@ export async function handler(context: HandlerContext) {
   }
   // URLs for each game type
   const gameUrls: { [key: string]: string } = {
-    wordle: "https://framedl.xyz/",
-    slot: "https://slot-machine-frame.vercel.app/",
+    wordle: "https://framedl.xyz",
+    slot: "https://slot-machine-frame.vercel.app",
   };
   // Respond with the appropriate game URL or an error message
   switch (params.game) {

package/{examples → templates}/group/src/handler/splitpayment.ts

@@ -3,7 +3,7 @@ import { vision, textGeneration } from "../lib/openai.js";
 
 export async function handler(context: HandlerContext) {
   if (!process?.env?.OPEN_AI_API_KEY) {
-    console.log("No OPEN_AI_API_KEY found in .env");
+    console.warn("No OPEN_AI_API_KEY found in .env");
     return;
   }
   const {

package/{examples → templates}/group/src/handler/transaction.ts

@@ -7,7 +7,7 @@ export async function handler(context: HandlerContext) {
       content: { command, params },
     },
   } = context;
-  const baseUrl = "https://base-frame-lyart.vercel.app/transaction";
+  const baseUrl = "https://base-tx-frame.vercel.app/transaction";
 
   switch (command) {
     case "send":

package/{examples → templates}/group/src/index.ts

@@ -15,9 +15,6 @@ run(async (context: HandlerContext) => {
     case "remoteStaticAttachment":
       handleAttachment(context);
       break;
-    case "text":
-      handleTextMessage(context);
-      break;
   }
 });
 async function handleReply(context: HandlerContext) {
@@ -35,8 +32,7 @@ async function handleReply(context: HandlerContext) {
     version,
     v2client.address,
   );
-  console.log(chain);
-  handleTextMessage(context);
+  //await context.intent(chain);
 }
 
 // Handle attachment messages
@@ -44,18 +40,7 @@ async function handleAttachment(context: HandlerContext) {
   await splitpayment(context);
 }
 
-// Handle text messages
-async function handleTextMessage(context: HandlerContext) {
-  const {
-    content: { content: text },
-  } = context.message;
-  if (text.includes("/help")) {
-    await helpHandler(context);
-  } else if (text.startsWith("@agent")) {
-    await agent(context);
-  } else await context.intent(text);
-}
-async function helpHandler(context: HandlerContext) {
+export async function helpHandler(context: HandlerContext) {
   const { commands = [] } = context;
   const intro =
     "Available experiences:\n" +

package/{examples → templates}/group/src/lib/openai.ts

@@ -1,5 +1,4 @@
 import dotenv from "dotenv";
-import { response } from "express";
 dotenv.config();
 
 import OpenAI from "openai";

package/examples/gm/.env.example

@@ -1 +0,0 @@
-KEY= # 0x... the private key of the bot wallet (with the 0x prefix)

package/examples/gm/src/index.ts

@@ -1,9 +0,0 @@
-import { run, HandlerContext } from "@xmtp/message-kit";
-
-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`);
-});

package/examples/group/.env.example

@@ -1,3 +0,0 @@
-KEY= # 0x... the private key of the bot wallet (with the 0x prefix)
-OPEN_AI_API_KEY= # openai api key
-STACK_API_KEY= # stack api key

package/examples/one-to-one/.env.example

@@ -1,2 +0,0 @@
-KEY= # 0x... the private key of the bot wallet (with the 0x prefix)
-REDIS_CONNECTION_STRING= # redis db connection string

package/examples/one-to-one/src/index.ts

@@ -1,72 +0,0 @@
-import { getRedisClient } from "./lib/redis.js";
-import { run, HandlerContext } from "@xmtp/message-kit";
-import { startCron } from "./lib/cron.js";
-import { RedisClientType } from "@redis/client";
-
-//Tracks conversation steps
-const inMemoryCacheStep = new Map<string, number>();
-
-//List of words to stop or unsubscribe.
-const stopWords = ["stop", "unsubscribe", "cancel", "list"];
-
-const redisClient: RedisClientType = await getRedisClient();
-
-let clientInitialized = false;
-run(async (context: HandlerContext) => {
-  const {
-    v2client,
-    message: {
-      content: { content: text },
-      typeId,
-      sender,
-    },
-  } = context;
-
-  if (!clientInitialized) {
-    startCron(redisClient, v2client);
-    clientInitialized = true;
-  }
-  if (typeId !== "text") {
-    /* If the input is not text do nothing */
-    return;
-  }
-
-  const lowerContent = text?.toLowerCase();
-
-  //Handles unsubscribe and resets step
-  if (stopWords.some((word) => lowerContent.includes(word))) {
-    inMemoryCacheStep.set(sender.address, 0);
-    await redisClient.del(sender.address);
-    await context.reply(
-      "You are now unsubscribed. You will no longer receive updates!.",
-    );
-    return;
-  }
-
-  const cacheStep = inMemoryCacheStep.get(sender.address) || 0;
-  let message = "";
-  if (cacheStep === 0) {
-    message = "Welcome! Choose an option:\n1. Info\n2. Subscribe";
-    // Move to the next step
-    inMemoryCacheStep.set(sender.address, cacheStep + 1);
-  } else if (cacheStep === 1) {
-    if (text === "1") {
-      message = "Here is the info.";
-    } else if (text === "2") {
-      await redisClient.set(sender.address, "subscribed"); //test
-      message =
-        "You are now subscribed. You will receive updates.\n\ntype 'stop' to unsubscribe";
-      //reset the app to the initial step
-      inMemoryCacheStep.set(sender.address, 0);
-    } else {
-      message = "Invalid option. Please choose 1 for Info or 2 to Subscribe.";
-      // Keep the same step to allow for re-entry
-    }
-  } else {
-    message = "Invalid option. Please start again.";
-    inMemoryCacheStep.set(sender.address, 0);
-  }
-
-  //Send the message
-  await context.reply(message);
-});

package/examples/one-to-one/src/lib/cron.ts

@@ -1,34 +0,0 @@
-import cron from "node-cron";
-import { Client } from "@xmtp/xmtp-js";
-import { RedisClientType } from "@redis/client";
-
-export async function startCron(
-  redisClient: RedisClientType,
-  v2client: Client,
-) {
-  console.log("Starting daily cron");
-  const conversations = await v2client.conversations.list();
-  cron.schedule(
-    "0 0 * * *", // Daily or every 5 seconds in debug mode
-    async () => {
-      const keys = await redisClient.keys("*");
-      console.log(`Running daily task. ${keys.length} subscribers.`);
-      for (const address of keys) {
-        const subscriptionStatus = await redisClient.get(address);
-        if (subscriptionStatus === "subscribed") {
-          console.log(`Sending daily update to ${address}`);
-          // Logic to send daily updates to each subscriber
-          const targetConversation = conversations.find(
-            (conv) => conv.peerAddress === address,
-          );
-          if (targetConversation)
-            await targetConversation.send("Here is your daily update!");
-        }
-      }
-    },
-    {
-      scheduled: true,
-      timezone: "UTC",
-    },
-  );
-}

package/examples/one-to-one/src/lib/redis.ts

@@ -1,15 +0,0 @@
-import { createClient } from "@redis/client";
-import { RedisClientType } from "@redis/client";
-
-export const getRedisClient = async () => {
-  const client = createClient({
-    url: process.env.REDIS_CONNECTION_STRING,
-  });
-
-  client.on("error", (err) => {
-    console.error("Redis client error:", err);
-  });
-
-  await client.connect();
-  return client as RedisClientType;
-};