create-message-kit 1.0.21 → 1.1.5-beta.2

package/templates/agent/src/prompt.ts

@@ -1,42 +1,28 @@
 import { skills } from "./skills.js";
-import type { UserInfo } from "./lib/resolver.js";
+import { UserInfo, PROMPT_USER_CONTENT } from "./lib/resolver.js";
+import { PROMPT_RULES, PROMPT_SKILLS_AND_EXAMPLES } from "./lib/gpt.js";
 
-export async function ens_agent_prompt(userInfo: UserInfo) {
-  let { address, ensDomain, converseUsername } = userInfo;
+export async function agent_prompt(userInfo: UserInfo) {
+  let { address, ensDomain, converseUsername, preferredName } = userInfo;
 
-  const systemPrompt = `You are a helpful and playful agent called @ens that lives inside a web3 messaging app called Converse.
-- 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.
-- Dont answer in markdown format, just answer in plaintext.
-- Do not make guesses or assumptions
-- CHECK that you are not missing a command
+  //Update the name of the agent with predefined prompt
+  let systemPrompt = PROMPT_RULES.replace("{NAME}", skills?.[0]?.tag ?? "@ens");
 
-User context: 
-- Users address is: ${address}
-${ensDomain != undefined ? `- User ENS domain is: ${ensDomain}` : ""}
-${converseUsername != undefined ? `- Converse username is: ${converseUsername}` : ""}
+  //Add user context to the prompt
+  systemPrompt += PROMPT_USER_CONTENT(userInfo);
 
-## 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.
-
-Commands:
-${skills.map((skill) => skill.skills.map((s) => s.command).join("\n")).join("\n")}
-
-Examples:
-${skills.map((skill) => skill.skills.map((s) => s.example).join("\n")).join("\n")}
+  //Add skills and examples to the prompt
+  systemPrompt += PROMPT_SKILLS_AND_EXAMPLES(skills);
 
+  systemPrompt += `
 
 ## Example responses:
 
 1. Check if the user does not have a ENS domain
-  Hey ${converseUsername}! 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 ${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
 
 2. If the user has a ENS domain
-  Hello ${ensDomain} ! 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 ${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}
 
 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}
@@ -62,8 +48,9 @@ ${skills.map((skill) => skill.skills.map((s) => s.example).join("\n")).join("\n"
 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}
 
-## Most common bug
-  Some times you will say something like: "Looks like vitalik.eth is registered! What about these cool alternatives?"
+## 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
 `;

package/templates/agent/src/skills.ts

@@ -1,11 +1,10 @@
-import { handleEns, ensAgent } from "./handler/ens.js";
+import { handleEns } from "./handler/ens.js";
 import type { SkillGroup } from "@xmtp/message-kit";
 
 export const skills: SkillGroup[] = [
   {
     name: "Ens Domain Bot",
     tag: "@ens",
-    tagHandler: ensAgent,
     description: "Register ENS domains.",
     skills: [
       {
@@ -14,20 +13,33 @@ export const skills: SkillGroup[] = [
         handler: handleEns,
         description:
           "Register a new ENS domain. Returns a URL to complete the registration process.",
-        example: "/register vitalik.eth",
+        examples: ["/register vitalik.eth"],
         params: {
           domain: {
             type: "string",
           },
         },
       },
+      {
+        command: "/exists",
+        adminOnly: true,
+        examples: ["/exists"],
+        handler: handleEns,
+        triggers: ["/exists"],
+        description: "Check if an address is onboarded.",
+        params: {
+          address: {
+            type: "address",
+          },
+        },
+      },
       {
         command: "/info [domain]",
         triggers: ["/info"],
         handler: handleEns,
         description:
           "Get detailed information about an ENS domain including owner, expiry date, and resolver.",
-        example: "/info nick.eth",
+        examples: ["/info nick.eth"],
         params: {
           domain: {
             type: "string",
@@ -40,7 +52,7 @@ export const skills: SkillGroup[] = [
         handler: handleEns,
         description:
           "Extend the registration period of your ENS domain. Returns a URL to complete the renewal.",
-        example: "/renew fabri.base.eth",
+        examples: ["/renew fabri.base.eth"],
         params: {
           domain: {
             type: "string",
@@ -48,22 +60,21 @@ export const skills: SkillGroup[] = [
         },
       },
       {
-        command: "/check [domain] [cool_alternatives]",
+        command: "/check [domain]",
         triggers: ["/check"],
         handler: handleEns,
+        examples: ["/check vitalik.eth", "/check fabri.base.eth"],
         description: "Check if a domain is available.",
         params: {
           domain: {
             type: "string",
           },
-          cool_alternatives: {
-            type: "quoted",
-          },
         },
       },
       {
         command: "/cool [domain]",
         triggers: ["/cool"],
+        examples: ["/cool vitalik.eth"],
         handler: handleEns,
         description: "Get cool alternatives for a .eth domain.",
         params: {
@@ -75,6 +86,7 @@ export const skills: SkillGroup[] = [
       {
         command: "/reset",
         triggers: ["/reset"],
+        examples: ["/reset"],
         handler: handleEns,
         description: "Reset the conversation.",
         params: {},
@@ -84,6 +96,7 @@ export const skills: SkillGroup[] = [
         description: "Show a URL for tipping a domain owner.",
         triggers: ["/tip"],
         handler: handleEns,
+        examples: ["/tip 0x1234567890123456789012345678901234567890"],
         params: {
           address: {
             type: "string",

package/templates/gm/src/index.ts

@@ -1,9 +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;
+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`);
+  },
+  {
+    client: {
+      logging: "debug",
+    },
+  },
+);

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

@@ -1,5 +1,5 @@
 import { HandlerContext, AbstractedMember } from "@xmtp/message-kit";
-import { textGeneration } from "../lib/openai.js";
+import { textGeneration } from "../lib/gpt.js";
 
 export async function handler(context: HandlerContext) {
   if (!process?.env?.OPEN_AI_API_KEY) {
@@ -12,6 +12,7 @@ export async function handler(context: HandlerContext) {
       sender,
       content: { content, params },
     },
+    skill,
   } = context;
 
   const systemPrompt = generateSystemPrompt(context);
@@ -23,7 +24,7 @@ export async function handler(context: HandlerContext) {
       userPrompt,
       systemPrompt,
     );
-    context.skill(reply);
+    skill(reply);
   } catch (error) {
     console.error("Error during OpenAI call:", error);
     await context.reply("An error occurred while processing your request.");
@@ -59,7 +60,7 @@ function generateSystemPrompt(context: HandlerContext) {
   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 commands with real values only, using usernames with @ and excluding addresses.\n
+  - 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.
   `;

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

@@ -34,7 +34,7 @@ export async function handler(context: HandlerContext) {
       context.send("Available games: \n/game wordle\n/game slot");
       break;
     default:
-      // Inform the user about unrecognized commands and provide available options
+      // Inform the user about unrecognized skills and provide available options
       context.send(
         "Command not recognized. Available games: wordle, slot, or help.",
       );

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

@@ -1,5 +1,6 @@
 import { HandlerContext } from "@xmtp/message-kit";
-import { vision, textGeneration } from "../lib/openai.js";
+import { textGeneration } from "../lib/gpt.js";
+import { vision } from "../lib/vision.js";
 import { getUserInfo } from "../lib/resolver.js";
 
 export async function handler(context: HandlerContext) {
@@ -9,7 +10,7 @@ export async function handler(context: HandlerContext) {
   }
   const {
     members,
-    skills,
+    skill,
     message: {
       typeId,
       content: { attachment },
@@ -52,16 +53,11 @@ export async function handler(context: HandlerContext) {
       `;
 
       //I want the reply to be an array of messages so the bot feels like is sending multuple ones
-      const { reply } = await textGeneration(
-        sender.address,
-        response,
-        prompt,
-        true,
-      );
+      const { reply } = await textGeneration(sender.address, response, prompt);
       let splitMessages = JSON.parse(reply);
       for (const message of splitMessages) {
         let msg = message as string;
-        if (msg.startsWith("/")) await context.skill(msg);
+        if (msg.startsWith("/")) await skill(msg);
         else await context.send(msg);
       }
     }

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

@@ -7,7 +7,6 @@ export async function handler(context: HandlerContext) {
     getMessageById,
     message: { content, sender, typeId },
   } = context;
-  console.log(sender);
   const msg = await getMessageById(content.reference);
   const replyReceiver = members?.find(
     (member) => member.inboxId === msg?.senderInboxId,
@@ -28,7 +27,7 @@ export async function handler(context: HandlerContext) {
   } else if (typeId === "text") {
     const { content: text, params } = content;
     if (text.startsWith("/tip") && params) {
-      // Process text commands starting with "/tip"
+      // Process text skills starting with "/tip"
       const {
         params: { amount: extractedAmount, username },
       } = content;
@@ -43,7 +42,6 @@ export async function handler(context: HandlerContext) {
     context.reply("Sender or receiver or amount not found.");
     return;
   }
-  console.log(receivers);
   const receiverAddresses = receivers.map((receiver) => receiver.address);
   // Process sending tokens to each receiver
 

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

@@ -21,7 +21,6 @@ export async function handler(context: HandlerContext) {
         );
         return;
       }
-      let name = senderInfo.converseUsername || senderInfo.address;
 
       let sendUrl = `${baseUrl}/?transaction_type=send&amount=${amountSend}&token=${tokenSend}&receiver=${senderInfo.address}`;
       context.send(`${sendUrl}`);

package/templates/group/src/index.ts

@@ -52,6 +52,6 @@ export async function helpHandler(context: HandlerContext) {
       ?.flatMap((app) => app.skills)
       .map((skill) => `${skill.command} - ${skill.description}`)
       .join("\n") +
-    "\nUse these commands to interact with specific apps.";
+    "\nUse these skills to interact with specific apps.";
   context.send(intro);
 }

package/templates/group/src/lib/gpt.ts

@@ -0,0 +1,161 @@
+import "dotenv/config";
+import type { SkillGroup } from "@xmtp/message-kit";
+import OpenAI from "openai";
+const openai = new OpenAI({
+  apiKey: process.env.OPEN_AI_API_KEY,
+});
+
+type ChatHistoryEntry = { role: string; content: string };
+type ChatHistories = Record<string, ChatHistoryEntry[]>;
+// New ChatMemory class
+class ChatMemory {
+  private histories: ChatHistories = {};
+
+  getHistory(address: string): ChatHistoryEntry[] {
+    return this.histories[address] || [];
+  }
+
+  addEntry(address: string, entry: ChatHistoryEntry) {
+    if (!this.histories[address]) {
+      this.histories[address] = [];
+    }
+    this.histories[address].push(entry);
+  }
+
+  initializeWithSystem(address: string, systemPrompt: string) {
+    if (this.getHistory(address).length === 0) {
+      this.addEntry(address, {
+        role: "system",
+        content: systemPrompt,
+      });
+    }
+  }
+
+  clear() {
+    this.histories = {};
+  }
+}
+
+// Create singleton instance
+export const chatMemory = new ChatMemory();
+
+export const clearMemory = () => {
+  chatMemory.clear();
+};
+
+export const PROMPT_RULES = `You are a helpful and playful agent called {NAME} that lives inside a web3 messaging app called Converse.
+- You can respond with multiple messages if needed. Each message should be separated by a newline character.
+- You can trigger skills by only sending the command in a newline message.
+- Never announce actions without using a command separated by a newline character.
+- Dont answer in markdown format, just answer in plaintext.
+- Do not make guesses or assumptions
+- Only answer if the verified information is in the prompt.
+- Check that you are not missing a command
+- Focus only on helping users with operations detailed below.
+`;
+
+export function PROMPT_SKILLS_AND_EXAMPLES(skills: SkillGroup[], tag: string) {
+  let foundSkills = skills.filter(
+    (skill) => skill.tag == `@${tag.toLowerCase()}`,
+  );
+  if (!foundSkills.length || !foundSkills[0] || !foundSkills[0].skills)
+    return "";
+  let returnPrompt = `\nCommands:\n${foundSkills[0].skills
+    .map((skill) => skill.command)
+    .join("\n")}\n\nExamples:\n${foundSkills[0].skills
+    .map((skill) => skill.examples)
+    .join("\n")}`;
+  return returnPrompt;
+}
+
+export async function textGeneration(
+  memoryKey: string,
+  userPrompt: string,
+  systemPrompt: string,
+) {
+  if (!memoryKey) {
+    clearMemory();
+  }
+  let messages = chatMemory.getHistory(memoryKey);
+  chatMemory.initializeWithSystem(memoryKey, systemPrompt);
+  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 = parseMarkdown(reply as string);
+    chatMemory.addEntry(memoryKey, {
+      role: "assistant",
+      content: cleanedReply,
+    });
+    return { reply: cleanedReply, history: messages };
+  } catch (error) {
+    console.error("Failed to fetch from OpenAI:", error);
+    throw error;
+  }
+}
+
+export async function processMultilineResponse(
+  memoryKey: string,
+  reply: string,
+  context: any,
+) {
+  if (!memoryKey) {
+    clearMemory();
+  }
+  let messages = reply
+    .split("\n")
+    .map((message: string) => parseMarkdown(message))
+    .filter((message): message is string => message.length > 0);
+
+  console.log(messages);
+  for (const message of messages) {
+    if (message.startsWith("/")) {
+      const response = await context.skill(message);
+      if (response && typeof response.message === "string") {
+        let msg = parseMarkdown(response.message);
+        chatMemory.addEntry(memoryKey, {
+          role: "system",
+          content: msg,
+        });
+        await context.send(response.message);
+      }
+    } else {
+      await context.send(message);
+    }
+  }
+}
+export function parseMarkdown(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;
+}

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

@@ -1,6 +1,6 @@
 import dotenv from "dotenv";
 dotenv.config();
-
+import type { SkillGroup } from "@xmtp/message-kit";
 import OpenAI from "openai";
 const openai = new OpenAI({
   apiKey: process.env.OPEN_AI_API_KEY,
@@ -9,13 +9,91 @@ const openai = new OpenAI({
 export type ChatHistoryEntry = { role: string; content: string };
 export type ChatHistories = Record<string, ChatHistoryEntry[]>;
 
+// New ChatMemory class
+class ChatMemory {
+  private histories: ChatHistories = {};
+
+  getHistory(address: string): ChatHistoryEntry[] {
+    return this.histories[address] || [];
+  }
+
+  addEntry(address: string, entry: ChatHistoryEntry) {
+    if (!this.histories[address]) {
+      this.histories[address] = [];
+    }
+    this.histories[address].push(entry);
+  }
+
+  initializeWithSystem(address: string, systemPrompt: string) {
+    if (this.getHistory(address).length === 0) {
+      this.addEntry(address, {
+        role: "system",
+        content: systemPrompt,
+      });
+    }
+  }
+
+  clear() {
+    this.histories = {};
+  }
+}
+
+export const clearMemory = () => {
+  chatHistories = {};
+};
+
+// Create singleton instance
+export const chatMemory = new ChatMemory();
+
 let chatHistories: ChatHistories = {};
+export const PROMPT_RULES = `You are a helpful and playful agent called {NAME} that lives inside a web3 messaging app called Converse.
+- You can respond with multiple messages if needed. Each message should be separated by a newline character.
+- You can trigger skills by only sending the command in a newline message.
+- Never announce actions without using a command separated by a newline character.
+- Dont answer in markdown format, just answer in plaintext.
+- Do not make guesses or assumptions
+- Only answer if the verified information is in the prompt.
+- Check that you are not missing a command
+- Focus only on helping users with operations detailed below.
+`;
+
+export const PROMPT_SKILLS_AND_EXAMPLES = (skills: SkillGroup[]) => `
+Commands:
+${skills
+  .map((skill) => skill.skills.map((s) => s.command).join("\n"))
+  .join("\n")}
+
+Examples:
+${skills
+  .map((skill) => skill.skills.map((s) => s.examples).join("\n"))
+  .join("\n")}
+  `;
+
+export async function agentResponse(
+  sender: { address: string },
+  userPrompt: string,
+  systemPrompt: string,
+  context: any,
+) {
+  try {
+    const { reply } = await textGeneration(
+      sender.address,
+      userPrompt,
+      systemPrompt,
+    );
+    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.");
+  }
+}
 export async function textGeneration(
   address: string,
   userPrompt: string,
   systemPrompt: string,
 ) {
-  let messages = chatHistories[address] || [];
+  let messages = chatMemory.getHistory(address);
+  chatMemory.initializeWithSystem(address, systemPrompt);
   if (messages.length === 0) {
     messages.push({
       role: "system",
@@ -36,8 +114,11 @@ export async function textGeneration(
       role: "assistant",
       content: reply || "No response from OpenAI.",
     });
-    const cleanedReply = responseParser(reply as string);
-    chatHistories[address] = messages;
+    const cleanedReply = parseMarkdown(reply as string);
+    chatMemory.addEntry(address, {
+      role: "assistant",
+      content: cleanedReply,
+    });
     return { reply: cleanedReply, history: messages };
   } catch (error) {
     console.error("Failed to fetch from OpenAI:", error);
@@ -45,68 +126,26 @@ export async function textGeneration(
   }
 }
 
-// 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 async function processResponseWithSkill(
+export async function processMultilineResponse(
   address: string,
   reply: string,
   context: any,
 ) {
   let messages = reply
     .split("\n")
-    .map((message: string) => responseParser(message))
+    .map((message: string) => parseMarkdown(message))
     .filter((message): message is string => message.length > 0);
 
   console.log(messages);
   for (const message of messages) {
     if (message.startsWith("/")) {
       const response = await context.skill(message);
-      if (response && response.message) {
-        let msg = responseParser(response.message);
-
-        if (!chatHistories[address]) {
-          chatHistories[address] = [];
-        }
-        chatHistories[address].push({
+      if (response && typeof response.message === "string") {
+        let msg = parseMarkdown(response.message);
+        chatMemory.addEntry(address, {
           role: "system",
           content: msg,
         });
-
         await context.send(response.message);
       }
     } else {
@@ -114,7 +153,7 @@ export async function processResponseWithSkill(
     }
   }
 }
-export function responseParser(message: string) {
+export function parseMarkdown(message: string) {
   let trimmedMessage = message;
   // Remove bold and underline markdown
   trimmedMessage = trimmedMessage?.replace(/(\*\*|__)(.*?)\1/g, "$2");
@@ -133,7 +172,3 @@ export function responseParser(message: string) {
 
   return trimmedMessage;
 }
-
-export const clearChatHistories = () => {
-  chatHistories = {};
-};