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

package/README.md

@@ -15,3 +15,7 @@ npx create-message-kit@latest
 ```bash
 yarn create message-kit
 ```
+
+```bash [npm]
+npm init message-kit@latest
+```

package/index.js

@@ -14,15 +14,11 @@ const packageJson = JSON.parse(
   fs.readFileSync(resolve(__dirname, "package.json"), "utf8"),
 );
 const version = packageJson.version;
-const pckMessageKitLib = JSON.parse(
-  fs.readFileSync(resolve(__dirname, "../message-kit/package.json"), "utf8"),
-);
-const versionMessageKitLib = pckMessageKitLib.version;
 program
   .name("byob")
   .description("CLI to initialize projects")
   .action(async () => {
-    log.info(pc.cyan(`Welcome to MessageKit v${versionMessageKitLib}!`));
+    log.info(pc.cyan(`Welcome to MessageKit CLI v${version}!`));
     const coolLogo = `
 ███╗   ███╗███████╗███████╗███████╗ █████╗  ██████╗ ███████╗██╗  ██╗██╗████████╗
 ████╗ ████║██╔════╝██╔════╝██╔════╝██╔══██╗██╔════╝ ██╔════╝██║ ██╔╝██║╚══██╔══╝

package/package.json

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

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

@@ -1,23 +1,23 @@
-import { HandlerContext } from "@xmtp/message-kit";
+import { HandlerContext, SkillResponse } from "@xmtp/message-kit";
 import { getUserInfo, clearInfoCache, isOnXMTP } from "../lib/resolver.js";
-import { textGeneration } from "../lib/openai.js";
-import { processResponseWithSkill } from "../lib/openai.js";
 import { isAddress } from "viem";
-import { ens_agent_prompt } from "../prompt.js";
-import { clearChatHistories } from "../lib/openai.js";
+import { clearMemory } from "../lib/gpt.js";
 
 export const frameUrl = "https://ens.steer.fun/";
 export const ensUrl = "https://app.ens.domains/";
 export const baseTxUrl = "https://base-tx-frame.vercel.app";
 
-export async function handleEns(context: HandlerContext) {
+export async function handleEns(
+  context: HandlerContext,
+): Promise<SkillResponse> {
   const {
     message: {
       content: { command, params, sender },
     },
+    skill,
   } = context;
   if (command == "reset") {
-    clear();
+    clearMemory();
     return { code: 200, message: "Conversation reset." };
   } else if (command == "renew") {
     // Destructure and validate parameters for the ens command
@@ -32,7 +32,7 @@ export async function handleEns(context: HandlerContext) {
 
     const data = await getUserInfo(domain);
 
-    if (!data || data?.address !== sender?.address) {
+    if (!data?.address || data?.address !== sender?.address) {
       return {
         code: 403,
         message:
@@ -60,7 +60,7 @@ export async function handleEns(context: HandlerContext) {
     const { domain } = params;
 
     const data = await getUserInfo(domain);
-    if (!data) {
+    if (!data?.ensDomain) {
       return {
         code: 404,
         message: "Domain not found.",
@@ -118,7 +118,7 @@ export async function handleEns(context: HandlerContext) {
       };
     } else {
       let message = `Looks like ${domain} is already registered!`;
-      await context.skill("/cool " + domain);
+      await skill("/cool " + domain);
       return {
         code: 404,
         message,
@@ -148,39 +148,8 @@ export async function handleEns(context: HandlerContext) {
       code: 200,
       message: `${generateCoolAlternatives(domain)}`,
     };
-  }
-}
-
-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 userInfo = await getUserInfo(sender.address);
-    if (!userInfo) {
-      console.log("User info not found");
-      return;
-    }
-    const { reply } = await textGeneration(
-      sender.address,
-      userPrompt,
-      await ens_agent_prompt(userInfo),
-    );
-    await processResponseWithSkill(sender.address, reply, context);
-  } catch (error) {
-    console.error("Error during OpenAI call:", error);
-    await context.send("An error occurred while processing your request.");
+  } else {
+    return { code: 400, message: "Command not found." };
   }
 }
 
@@ -206,6 +175,6 @@ export const generateCoolAlternatives = (domain: string) => {
 };
 
 export async function clear() {
-  clearChatHistories();
+  clearMemory();
   clearInfoCache();
 }

package/templates/agent/src/index.ts

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

package/templates/agent/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/agent/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,9 +114,11 @@ export async function textGeneration(
       role: "assistant",
       content: reply || "No response from OpenAI.",
     });
-    const cleanedReply = responseParser(reply as string);
-    chatHistories[address] = messages;
-    console.log("messages.length", messages.length);
+    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);
@@ -46,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 {
@@ -115,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");
@@ -134,7 +172,3 @@ export function responseParser(message: string) {
 
   return trimmedMessage;
 }
-
-export const clearChatHistories = () => {
-  chatHistories = {};
-};

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

@@ -1,5 +1,6 @@
-import { Client } from "@xmtp/xmtp-js";
+import type { Client } from "@xmtp/xmtp-js";
 import { isAddress } from "viem";
+import type { HandlerContext } from "@xmtp/message-kit";
 
 export const converseEndpointURL =
   "https://converse-website-git-endpoit-ephemerahq.vercel.app";
@@ -16,6 +17,7 @@ export type ConverseProfile = {
 export type UserInfo = {
   ensDomain?: string | undefined;
   address?: string | undefined;
+  preferredName: string | undefined;
   converseUsername?: string | undefined;
   ensInfo?: EnsData | undefined;
   avatar?: string | undefined;
@@ -47,19 +49,20 @@ export const clearInfoCache = () => {
 export const getUserInfo = async (
   key: string,
   clientAddress?: string,
+  context?: HandlerContext,
 ): Promise<UserInfo | null> => {
   let data: UserInfo = infoCache.get(key) || {
     ensDomain: undefined,
     address: undefined,
     converseUsername: undefined,
     ensInfo: undefined,
+    preferredName: undefined,
   };
-  //console.log("Getting user info", key, clientAddress);
   if (isAddress(clientAddress || "")) {
     data.address = clientAddress;
   } else if (isAddress(key || "")) {
     data.address = key;
-  } else if (key.includes(".eth")) {
+  } else if (key?.includes(".eth")) {
     data.ensDomain = key;
   } else if (key == "@user" || key == "@me" || key == "@bot") {
     data.address = clientAddress;
@@ -74,16 +77,15 @@ export const getUserInfo = async (
   } else {
     data.converseUsername = key;
   }
-
+  data.preferredName = data.ensDomain || data.converseUsername || "Friend";
   let keyToUse = data.address || data.ensDomain || data.converseUsername;
   let cacheData = keyToUse && infoCache.get(keyToUse);
-  if (cacheData) {
-    //console.log("Getting user info", keyToUse, cacheData);
-    return cacheData;
-  } else {
-    //console.log("Getting user info", keyToUse, data);
-  }
+  //console.log("Getting user info", { cacheData, keyToUse, data });
+  if (cacheData) return cacheData;
 
+  context?.send(
+    "Hey there! Give me a sec while I fetch info about you first...",
+  );
   if (keyToUse?.includes(".eth")) {
     const response = await fetch(`https://ensdata.net/${keyToUse}`);
     const ensData: EnsData = (await response.json()) as EnsData;
@@ -113,6 +115,8 @@ export const getUserInfo = async (
     data.address = converseData?.address || undefined;
     data.avatar = converseData?.avatar || undefined;
   }
+
+  data.preferredName = data.ensDomain || data.converseUsername || "Friend";
   if (data.address) infoCache.set(data.address, data);
   return data;
 };
@@ -124,3 +128,24 @@ export const isOnXMTP = async (
   if (domain == "fabri.eth") return false;
   if (address) return (await client.canMessage([address])).length > 0;
 };
+
+export const PROMPT_USER_CONTENT = (userInfo: UserInfo) => {
+  let { address, ensDomain, converseUsername, preferredName } = userInfo;
+  let prompt = `
+User context: 
+- 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.
+- Users address is: ${address}`;
+  if (preferredName) prompt += `\n- Users name is: ${preferredName}`;
+  if (ensDomain) prompt += `\n- User ENS domain is: ${ensDomain}`;
+  if (converseUsername)
+    prompt += `\n- Converse username is: ${converseUsername}`;
+
+  prompt = prompt.replace("{ADDRESS}", address || "");
+  prompt = prompt.replace("{ENS_DOMAIN}", ensDomain || "");
+  prompt = prompt.replace("{CONVERSE_USERNAME}", converseUsername || "");
+  prompt = prompt.replace("{PREFERRED_NAME}", preferredName || "");
+
+  return prompt;
+};