create-message-kit 1.0.16 → 1.0.17

package/templates/agent/src/prompt.ts

@@ -1,93 +1,81 @@
-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.
+  const systemPrompt = `You are a helpful and playful agent 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
 
 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"}
+${domain != undefined ? `- User ENS domain is: ${domain}` : ""}
+${name != undefined ? `- Converse username is: ${name}` : ""}
 
 ## 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
+- "/info [domain]": To get information about a domain use this command.
+- "/check [domain]": To check to see if a domain is available use this command.
+- "/register [domain]": To register a domain use this command. This will return a url pointing to the registration page.
+- "/renew [domain]": To trigger renewal of a domain use this command. This will return a url with a button to renew the domain.
+- "/tip [address]": To tip a domain or address use this command. This will return a url with a button to send the tip
+- "/cool [domain]": To get cool alternatives for a .eth domain use this command.
 
 Examples:
-- /check ${userName} "${commonAlternatives}"
+- /check ${domain}
 - /info nick.eth
 - /register vitalik.eth 
 - /renew fabri.base.eth
 - /tip 0xf0EA7663233F99D0c12370671abBb6Cca980a490
+- /cool vitalik.eth
 
 ## 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? 🤔
+  Hey ${name}! it looks like you don't have a ENS domain yet! \n\Let me start by checking your Converse username ${converseUsername}.eth\n/check ${converseUsername}.eth
 
 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}" 
+  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}
 
 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}" 
+  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}
 
 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 🤔
+  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}" 
+  Looks like ${domain} is already registered!\n What about these cool alternatives?\n/cool ${domain}
 
 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} 
+7. If the user wants to directly to tip to the ENS domain owner, use directly the command "/tip [domain]", this will return a url but a button to send the tip 
+  Here is the url to send the tip:\n/tip ${domain}
 
-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]"
+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 ${domain}.\n Give me a moment.\n/info ${domain}  
 
-10. If the user wants to renew their domain, use the command "/renew [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 ${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}"
+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 ${domain}
 
 ## 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}"
+You should have said something like: "Looks like vitalik.eth is registered! What about these cool alternatives?\n/cool vitalik.eth
 `;
   return systemPrompt;
 }

package/templates/agent/src/{commands.ts → skills.ts}

@@ -1,16 +1,18 @@
-import type { CommandGroup } from "@xmtp/message-kit";
-import { ensAgent, handleEns } from "./handler/ens.js";
+import type { SkillGroup } from "@xmtp/message-kit";
+import { handleEns } from "./handler/ens.js";
 
-export const commands: CommandGroup[] = [
+export const skills: SkillGroup[] = [
   {
     name: "Ens Domain Bot",
     description: "Register ENS domains.",
-    commands: [
+    skills: [
       {
         command: "/register [domain]",
         triggers: ["/register", "@ensbot"],
         handler: handleEns,
-        description: "Register a domain.",
+        description:
+          "Register a new ENS domain. Returns a URL to complete the registration process.",
+        example: "/register vitalik.eth",
         params: {
           domain: {
             type: "string",
@@ -21,7 +23,9 @@ export const commands: CommandGroup[] = [
         command: "/info [domain]",
         triggers: ["/info", "@ensbot"],
         handler: handleEns,
-        description: "Get information about a domain.",
+        description:
+          "Get detailed information about an ENS domain including owner, expiry date, and resolver.",
+        example: "/info nick.eth",
         params: {
           domain: {
             type: "string",
@@ -32,7 +36,9 @@ export const commands: CommandGroup[] = [
         command: "/renew [domain]",
         triggers: ["/renew", "@ensbot"],
         handler: handleEns,
-        description: "Renew a domain.",
+        description:
+          "Extend the registration period of your ENS domain. Returns a URL to complete the renewal.",
+        example: "/renew fabri.base.eth",
         params: {
           domain: {
             type: "string",
@@ -53,14 +59,32 @@ export const commands: CommandGroup[] = [
           },
         },
       },
+      {
+        command: "/cool [domain]",
+        triggers: ["/cool"],
+        handler: handleEns,
+        description: "Get cool alternatives for a .eth domain.",
+        params: {
+          domain: {
+            type: "string",
+          },
+        },
+      },
+      {
+        command: "/reset",
+        triggers: ["/reset"],
+        handler: handleEns,
+        description: "Reset the conversation.",
+        params: {},
+      },
       {
         command: "/tip [address]",
         description: "Show a URL for tipping a domain owner.",
         triggers: ["/tip"],
-        handler: ensAgent,
+        handler: handleEns,
         params: {
           address: {
-            type: "address",
+            type: "string",
           },
         },
       },

package/templates/gm/src/index.ts

@@ -1,16 +1,9 @@
 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`);
-  },
-  {
-    memberChange: true,
-    attachments: true,
-    experimental: true,
-  },
-);
+  // To reply, just call `reply` on the HandlerContext
+  await context.send(`gm`);
+});

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

@@ -1,4 +1,4 @@
-import { HandlerContext, User } from "@xmtp/message-kit";
+import { HandlerContext, AbstractedMember } from "@xmtp/message-kit";
 import { textGeneration } from "../lib/openai.js";
 
 export async function handler(context: HandlerContext) {
@@ -9,19 +9,21 @@ export async function handler(context: HandlerContext) {
 
   const {
     message: {
+      sender,
       content: { content, params },
     },
   } = context;
 
   const systemPrompt = generateSystemPrompt(context);
-  console.log("systemPrompt", systemPrompt);
   try {
     let userPrompt = params?.prompt ?? content;
-    console.log("userPrompt", userPrompt);
 
-    const { reply } = await textGeneration(userPrompt, systemPrompt);
-    console.log("intent:", reply);
-    context.intent(reply);
+    const { reply } = await textGeneration(
+      sender.address,
+      userPrompt,
+      systemPrompt,
+    );
+    context.skill(reply);
   } catch (error) {
     console.error("Error during OpenAI call:", error);
     await context.reply("An error occurred while processing your request.");
@@ -31,7 +33,7 @@ export async function handler(context: HandlerContext) {
 function generateSystemPrompt(context: HandlerContext) {
   const {
     members,
-    commands,
+    skills,
     message: { sender },
   } = context;
 
@@ -40,10 +42,15 @@ function generateSystemPrompt(context: HandlerContext) {
   
   You are a helpful bot agent that lives inside a web3 messaging group that helps interpret user requests and execute commands.
   #### Users
-   ${JSON.stringify(members?.map((member: User) => ({ ...member, username: `@${member.username}` })))}\n 
+   ${JSON.stringify(
+     members?.map((member: AbstractedMember) => ({
+       ...member,
+       username: `@${member.accountAddresses[0]}`,
+     })),
+   )}\n
   #### Commands
-  ${JSON.stringify(commands)}\n
-  The message was sent by @${sender?.username}
+  ${JSON.stringify(skills)}\n
+  The message was sent by @${sender?.address}
   
   ### Examples
   prompt /agent tip alix and bo

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

@@ -1,4 +1,4 @@
-import { HandlerContext, User } from "@xmtp/message-kit";
+import { HandlerContext, AbstractedMember } from "@xmtp/message-kit";
 import { getStackClient } from "../lib/stack.js";
 
 export async function handler(context: HandlerContext, fake?: boolean) {
@@ -6,15 +6,8 @@ export async function handler(context: HandlerContext, fake?: boolean) {
   const {
     members,
     group,
-    getMessageById,
-    message: {
-      content,
-      content: { command },
-      sender,
-      typeId,
-    },
+    message: { sender, typeId, content },
   } = context;
-  console.log(command);
   if (typeId === "text" && group) {
     const { command } = content;
     if (command === "points") {
@@ -40,14 +33,13 @@ export async function handler(context: HandlerContext, fake?: boolean) {
   } else if (typeId === "group_updated" && group) {
     const { initiatedByInboxId, addedInboxes } = content;
     const adminAddress = members?.find(
-      (member: User) => member.inboxId === initiatedByInboxId,
+      (member: AbstractedMember) => member.inboxId === initiatedByInboxId,
     );
     if (addedInboxes && addedInboxes.length > 0) {
       //if add someone to the group
       await stack?.track("referral", {
         points: 10,
         account: adminAddress?.address ?? "",
-        uniqueId: adminAddress?.username ?? "",
       });
     }
   }

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 { getUserInfo } from "../lib/resolver.js";
 
 export async function handler(context: HandlerContext) {
   if (!process?.env?.OPEN_AI_API_KEY) {
@@ -8,7 +9,7 @@ export async function handler(context: HandlerContext) {
   }
   const {
     members,
-    commands,
+    skills,
     message: {
       typeId,
       content: { attachment },
@@ -16,8 +17,12 @@ export async function handler(context: HandlerContext) {
     },
   } = context;
 
+  if (!members) {
+    return;
+  }
+  let senderInfo = await getUserInfo(sender.address);
   if (attachment && typeId === "remoteStaticAttachment") {
-    const { data, filename, mimeType } = attachment;
+    const { data } = attachment;
     const response = await vision(
       data,
       "This image is the bill of a restaurant dinner. Return the total. If you can't find the total, return 'undefined'.",
@@ -31,9 +36,6 @@ export async function handler(context: HandlerContext) {
     }
     if (response) {
       const prompt = `You a split wise agent that splits the bill between the members of this group except for the sender and bot.\n
-      These are the users of the group: ${JSON.stringify(members?.map((member) => ({ ...member, username: `@${member.username}` })))}\n 
-      This group app has many commands available: ${JSON.stringify(commands)}\n
-      
 
       ## Instructions:
       When you receive the totals you should split the bill between the members of the group and send to each one a transaction frame
@@ -44,18 +46,23 @@ export async function handler(context: HandlerContext) {
       Example:
       [  
         "This are the details: Total: $49.52. Tip (20%): $9.90",
-        "All users owe X USDC to @${sender?.username}. Pay here:",
-        "/send @${sender?.username} $9.90"
+        "All users owe X USDC to @${senderInfo?.converseUsername}. Pay here:",
+        "/send @${senderInfo?.converseUsername} $9.90"
       ]
       `;
 
       //I want the reply to be an array of messages so the bot feels like is sending multuple ones
-      const { reply } = await textGeneration(response, prompt);
+      const { reply } = await textGeneration(
+        sender.address,
+        response,
+        prompt,
+        true,
+      );
       let splitMessages = JSON.parse(reply);
       for (const message of splitMessages) {
         let msg = message as string;
-        if (msg.startsWith("/")) await context.intent(msg);
-        else await context.reply(msg);
+        if (msg.startsWith("/")) await context.skill(msg);
+        else await context.send(msg);
       }
     }
   }

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

@@ -1,4 +1,5 @@
-import { HandlerContext, User } from "@xmtp/message-kit";
+import { HandlerContext, AbstractedMember } from "@xmtp/message-kit";
+import { getUserInfo } from "../lib/resolver.js";
 
 export async function handler(context: HandlerContext) {
   const {
@@ -6,16 +7,15 @@ 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,
   );
   let amount: number = 0,
-    receivers: User[] = [];
+    receivers: AbstractedMember[] = [];
   // Handle different types of messages
   if (typeId === "reply" && replyReceiver) {
-    // Process reply messages/
-    //ha
     const { content: reply } = content;
 
     if (reply.includes("degen")) {
@@ -31,18 +31,22 @@ export async function handler(context: HandlerContext) {
       // Process text commands starting with "/tip"
       const {
         params: { amount: extractedAmount, username },
-        content: text,
       } = content;
       amount = extractedAmount || 10; // Default amount if not specified
-      receivers = username; // Extract receiver from parameters
+
+      receivers = await Promise.all(
+        username.map((username: string) => getUserInfo(username)),
+      );
     }
   }
   if (!sender || receivers.length === 0 || amount === 0) {
     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
+
   context.sendTo(
     `You received ${amount} tokens from ${sender.address}.`,
     receiverAddresses,

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

@@ -1,4 +1,5 @@
 import { HandlerContext } from "@xmtp/message-kit";
+import { getUserInfo } from "../lib/resolver.js";
 
 // Main handler function for processing commands
 export async function handler(context: HandlerContext) {
@@ -13,20 +14,17 @@ export async function handler(context: HandlerContext) {
     case "send":
       // Destructure and validate parameters for the send command
       const { amount: amountSend, token: tokenSend, username } = params; // [!code hl] // [!code focus]
-
-      if (!amountSend || !tokenSend || !username) {
+      let senderInfo = await getUserInfo(username);
+      if (!amountSend || !tokenSend || !senderInfo) {
         context.reply(
           "Missing required parameters. Please provide amount, token, and username.",
         );
         return;
       }
-      // Generate URL for the send transaction
-      let url_send = generateFrameURL(baseUrl, "send", {
-        amount: amountSend,
-        token: tokenSend,
-        receiver: username[0]?.address,
-      });
-      context.reply(`${url_send}`);
+      let name = senderInfo.converseUsername || senderInfo.address;
+
+      let sendUrl = `${baseUrl}/?transaction_type=send&amount=${amountSend}&token=${tokenSend}&receiver=${senderInfo.address}`;
+      context.send(`${sendUrl}`);
       break;
     case "swap":
       // Destructure and validate parameters for the swap command
@@ -38,13 +36,9 @@ export async function handler(context: HandlerContext) {
         );
         return;
       }
-      // Generate URL for the swap transaction
-      let url_swap = generateFrameURL(baseUrl, "swap", {
-        amount,
-        token_from,
-        token_to,
-      });
-      context.reply(`${url_swap}`);
+
+      let swapUrl = `${baseUrl}/?transaction_type=swap&token_from=${token_from}&token_to=${token_to}&amount=${amount}`;
+      context.send(`${swapUrl}`);
       break;
     case "show": // [!code hl] // [!code focus]
       // Show the base URL without the transaction path
@@ -55,26 +49,3 @@ export async function handler(context: HandlerContext) {
       context.reply("Unknown command. Use help to see all available commands.");
   }
 }
-
-// Function to generate a URL with query parameters for transactions
-function generateFrameURL(
-  baseUrl: string,
-  transaction_type: string,
-  params: { [key: string]: string | number | string[] | undefined },
-) {
-  // Filter out undefined parameters
-  let filteredParams: {
-    [key: string]: string | number | string[] | undefined;
-  } = {};
-
-  for (const key in params) {
-    if (params[key] !== undefined) {
-      filteredParams[key] = params[key];
-    }
-  }
-  let queryParams = new URLSearchParams({
-    transaction_type,
-    ...filteredParams,
-  }).toString();
-  return `${baseUrl}?${queryParams}`;
-}

package/templates/group/src/index.ts

@@ -1,22 +1,26 @@
 import { run, HandlerContext } from "@xmtp/message-kit";
-import { handler as tipping } from "./handler/tipping.js";
-import { handler as agent } from "./handler/agent.js";
 import { handler as splitpayment } from "./handler/splitpayment.js";
 
 // Main function to run the app
-run(async (context: HandlerContext) => {
-  const {
-    message: { typeId },
-  } = context;
-  switch (typeId) {
-    case "reply":
-      handleReply(context);
-      break;
-    case "remoteStaticAttachment":
-      handleAttachment(context);
-      break;
-  }
-});
+run(
+  async (context: HandlerContext) => {
+    const {
+      message: { typeId },
+    } = context;
+    switch (typeId) {
+      case "reply":
+        handleReply(context);
+        break;
+      case "remoteStaticAttachment":
+        handleAttachment(context);
+        break;
+    }
+    if (!context.group) {
+      context.send("This is a group bot, add this address to a group");
+    }
+  },
+  { attachments: true },
+);
 async function handleReply(context: HandlerContext) {
   const {
     v2client,
@@ -32,7 +36,7 @@ async function handleReply(context: HandlerContext) {
     version,
     v2client.address,
   );
-  //await context.intent(chain);
+  //await context.skill(chain);
 }
 
 // Handle attachment messages
@@ -41,12 +45,12 @@ async function handleAttachment(context: HandlerContext) {
 }
 
 export async function helpHandler(context: HandlerContext) {
-  const { commands = [] } = context;
+  const { skills } = context;
   const intro =
     "Available experiences:\n" +
-    commands
-      .flatMap((app) => app.commands)
-      .map((command) => `${command.command} - ${command.description}`)
+    skills
+      ?.flatMap((app) => app.skills)
+      .map((skill) => `${skill.command} - ${skill.description}`)
       .join("\n") +
     "\nUse these commands to interact with specific apps.";
   context.send(intro);

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

@@ -6,12 +6,17 @@ const openai = new OpenAI({
   apiKey: process.env.OPEN_AI_API_KEY,
 });
 
+export type ChatHistoryEntry = { role: string; content: string };
+export type ChatHistories = Record<string, ChatHistoryEntry[]>;
+
+let chatHistories: ChatHistories = {};
 export async function textGeneration(
+  address: string,
   userPrompt: string,
   systemPrompt: string,
-  chatHistory?: any[],
+  isGroup: boolean = false,
 ) {
-  let messages = chatHistory ? [...chatHistory] : []; // Start with existing chat history
+  let messages = chatHistories[address] || [];
   if (messages.length === 0) {
     messages.push({
       role: "system",
@@ -33,7 +38,7 @@ export async function textGeneration(
       content: reply || "No response from OpenAI.",
     });
     const cleanedReply = responseParser(reply as string);
-
+    if (!isGroup) chatHistories[address] = messages;
     return { reply: cleanedReply, history: messages };
   } catch (error) {
     console.error("Failed to fetch from OpenAI:", error);
@@ -78,6 +83,35 @@ export async function vision(imageData: Uint8Array, systemPrompt: string) {
   }
 }
 
+export async function processResponseWithskill(
+  address: string,
+  reply: string,
+  context: any,
+) {
+  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.skill(message);
+      if (response && response.message) {
+        let msg = responseParser(response.message);
+
+        chatHistories[address].push({
+          role: "system",
+          content: msg,
+        });
+
+        await context.send(response.message);
+      }
+    } else {
+      await context.send(message);
+    }
+  }
+}
 export function responseParser(message: string) {
   let trimmedMessage = message;
   // Remove bold and underline markdown
@@ -94,5 +128,10 @@ export function responseParser(message: string) {
   trimmedMessage = trimmedMessage?.replace(/^\s+|\s+$/g, "");
   // Remove any remaining leading or trailing whitespace
   trimmedMessage = trimmedMessage.trim();
+
   return trimmedMessage;
 }
+
+export const clearChatHistories = () => {
+  chatHistories = {};
+};