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

package/templates/group/src/{handler → handlers}/helpers.ts

@@ -1,18 +1,37 @@
-import { HandlerContext } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
 
-export async function handler(context: HandlerContext) {
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/help",
+    examples: ["/help"],
+    handler: handleHelp,
+    description: "Get help with the bot.",
+    params: {},
+  },
+  {
+    skill: "/id",
+    examples: ["/id"],
+    handler: handleHelp,
+    description: "Get the group ID.",
+    params: {},
+  },
+];
+
+export async function handleHelp(context: XMTPContext) {
   const {
-    skills,
     message: {
       content: { skill },
     },
     group,
+    runConfig,
   } = context;
 
   if (skill == "help") {
     const intro =
       "Available experiences:\n" +
-      skills
+      runConfig?.skills
         ?.flatMap((app) => app.skills)
         .map((skill) => `${skill.skill} - ${skill.description}`)
         .join("\n") +

package/templates/group/src/handlers/payment.ts

@@ -0,0 +1,51 @@
+import { getUserInfo, XMTPContext } from "@xmtp/message-kit";
+import type { skillAction } from "@xmtp/message-kit";
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/pay [amount] [token] [username]",
+    examples: ["/pay 10 usdc vitalik.eth", "/pay 1 @alix"],
+    description:
+      "Send a specified amount of a cryptocurrency to a destination address.",
+    handler: handlePay,
+    params: {
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
+      },
+      username: {
+        default: "",
+        type: "username",
+      },
+    },
+  },
+];
+
+export async function handlePay(context: XMTPContext) {
+  const {
+    message: {
+      content: { params },
+    },
+  } = context;
+  const txpayUrl = "https://txpay.vercel.app";
+
+  const { amount: amountSend, token: tokenSend, username } = params;
+  let senderInfo = await getUserInfo(username);
+  if (!amountSend || !tokenSend || !senderInfo) {
+    context.reply(
+      "Missing required parameters. Please provide amount, token, and username.",
+    );
+    return {
+      code: 400,
+      message:
+        "Missing required parameters. Please provide amount, token, and username.",
+    };
+  }
+
+  let sendUrl = `${txpayUrl}/?&amount=${amountSend}&token=${tokenSend}&receiver=${senderInfo.address}`;
+  await context.send(`${sendUrl}`);
+}

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

@@ -0,0 +1,61 @@
+import { XMTPContext, AbstractedMember } from "@xmtp/message-kit";
+import { getUserInfo } from "@xmtp/message-kit";
+import type { skillAction } from "@xmtp/message-kit";
+
+export const registerSkill: skillAction[] = [
+  {
+    skill: "/tip [usernames] [amount] [token]",
+    examples: ["/tip @vitalik 10 usdc"],
+    description: "Tip users in a specified token.",
+    handler: handleTipping,
+    params: {
+      username: {
+        default: "",
+        plural: true,
+        type: "username",
+      },
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"],
+      },
+    },
+  },
+];
+
+export async function handleTipping(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        skill,
+        params: { amount, username },
+      },
+      sender,
+    },
+  } = context;
+  let receivers: AbstractedMember[] = [];
+
+  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.");
+  }
+  const receiverAddresses = receivers.map((receiver) => receiver.address);
+
+  context.sendTo(
+    `You received ${amount} tokens from ${sender.address}.`,
+    receiverAddresses,
+  );
+
+  // Notify sender of the transaction details
+  context.sendTo(
+    `You sent ${amount * receiverAddresses.length} tokens in total.`,
+    [sender.address],
+  );
+}

package/templates/group/src/index.ts

@@ -1,31 +1,33 @@
-import { run, HandlerContext } from "@xmtp/message-kit";
-import { textGeneration, processMultilineResponse } from "@xmtp/message-kit";
-import { agent_prompt } from "./prompt.js";
-import { getUserInfo } from "@xmtp/message-kit";
+import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+import { registerSkill as tippingSkill } from "./handlers/tipping.js";
+import { registerSkill as paymentSkill } from "./handlers/payment.js";
+import { registerSkill as gameSkill } from "./handlers/game.js";
+import { registerSkill as helperSkill } from "./handlers/helpers.js";
+import { systemPrompt } from "./prompt.js";
 
-run(async (context: HandlerContext) => {
-  const {
-    message: {
-      content: { text, params },
-      sender,
-    },
-  } = context;
+export const skills = [
+  {
+    name: "Group bot",
+    tag: "@bot",
+    description: "Group agent for tipping payments, games and more.",
+    skills: [...tippingSkill, ...paymentSkill, ...gameSkill, ...helperSkill],
+  },
+];
 
-  try {
-    let userPrompt = params?.prompt ?? text;
-    const userInfo = await getUserInfo(sender.address);
-    if (!userInfo) {
-      console.log("User info not found");
-      return;
-    }
-    const { reply } = await textGeneration(
+run(
+  async (context) => {
+    const {
+      message: { sender },
+      runConfig,
+    } = context;
+
+    let prompt = await replaceVariables(
+      systemPrompt,
       sender.address,
-      userPrompt,
-      await agent_prompt(userInfo),
+      runConfig?.skills,
+      "@bot",
     );
-    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.");
-  }
-});
+    await agentReply(context, prompt);
+  },
+  { skills },
+);

package/templates/group/src/prompt.ts

@@ -1,45 +1,33 @@
-import { skills } from "./skills.js";
-import {
-  UserInfo,
-  PROMPT_USER_CONTENT,
-  PROMPT_RULES,
-  PROMPT_SKILLS_AND_EXAMPLES,
-  PROMPT_REPLACE_VARIABLES,
-} from "@xmtp/message-kit";
-
-export async function agent_prompt(userInfo: UserInfo) {
-  let systemPrompt =
-    PROMPT_RULES +
-    PROMPT_USER_CONTENT(userInfo) +
-    PROMPT_SKILLS_AND_EXAMPLES(skills, "@bot");
-
-  let fineTunedPrompt = `
-## Example response
-
-1. If user wants to play a game, use the skill 'game' and specify the game type.
-  Hey! Sure let's do that.\n/game wordle
+export const systemPrompt = `
+{persona}
+
+{rules}
+
+{user_context}
+
+{skills}
+
+## Response Scenarios
+
+1. If the user wants to play a game suggest direcly a game like wordle:
+  Let's play wordle!
+  /game wordle
   
 2. When user wants to pay a specific token:
-  I'll help you pay 1 USDC to 0x123...\n/pay 1 {TOKE}} 0x123456789...
+  I'll help you pay 1 USDC to 0x123...
+  /pay 1 [token] 0x123456789...
   *This will return a url to pay
 
 3. If the user wants to pay a eth domain:
-  I'll help you pay 1 USDC to vitalik.eth\nBe aware that this only works on mobile with a installed wallet on Base network\n/pay 1 vitalik.eth
+  I'll help you pay 1 USDC to vitalik.eth
+  Be aware that this only works on mobile with a installed wallet on Base network
+  /pay 1 vitalik.eth
   *This will return a url to pay
 
 4. If the user wants to pay a username:
-  I'll help you pay 1 USDC to @fabri\nBe aware that this only works on mobile with a installed wallet on Base network\n/pay 1 @fabri
+  I'll help you pay 1 USDC to @fabri
+  Be aware that this only works on mobile with a installed wallet on Base network
+  /pay 1 @fabri
   *This will return a url to pay
-  `;
-
-  systemPrompt += fineTunedPrompt;
-  // Replace the variables in the system prompt
-  systemPrompt = PROMPT_REPLACE_VARIABLES(
-    systemPrompt,
-    userInfo?.address ?? "",
-    userInfo,
-    "@bot",
-  );
-  console.log(systemPrompt);
-  return systemPrompt;
-}
+
+`;

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

@@ -1,175 +0,0 @@
-import { HandlerContext, SkillResponse } from "@xmtp/message-kit";
-import { getUserInfo, clearInfoCache, isOnXMTP } from "@xmtp/message-kit";
-import { isAddress } from "viem";
-import { clearMemory } from "@xmtp/message-kit";
-
-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,
-): Promise<SkillResponse | undefined> {
-  const {
-    message: {
-      sender,
-      content: { skill, params },
-    },
-  } = context;
-
-  if (skill == "reset") {
-    clearMemory();
-    return { code: 200, message: "Conversation reset." };
-  } else if (skill == "renew") {
-    // Destructure and validate parameters for the ens
-    const { domain } = params;
-    // Check if the user holds the domain
-    if (!domain) {
-      return {
-        code: 400,
-        message: "Missing required parameters. Please provide domain.",
-      };
-    }
-
-    const data = await getUserInfo(domain);
-
-    if (!data?.address || data?.address !== sender?.address) {
-      return {
-        code: 403,
-        message:
-          "Looks like this domain is not registered to you. Only the owner can renew it.",
-      };
-    }
-
-    // Generate URL for the ens
-    let url_ens = frameUrl + "frames/manage?name=" + domain;
-    return { code: 200, message: `${url_ens}` };
-  } else if (skill == "register") {
-    // Destructure and validate parameters for the ens
-    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 (skill == "info") {
-    const { domain } = params;
-
-    const data = await getUserInfo(domain);
-    if (!data?.ensDomain) {
-      return {
-        code: 404,
-        message: "Domain not found.",
-      };
-    }
-
-    const formattedData = {
-      Address: data?.address,
-      "Avatar URL": data?.ensInfo?.avatar,
-      Description: data?.ensInfo?.description,
-      ENS: data?.ensDomain,
-      "Primary ENS": data?.ensInfo?.ens_primary,
-      GitHub: data?.ensInfo?.github,
-      Resolver: data?.ensInfo?.resolverAddress,
-      Twitter: data?.ensInfo?.twitter,
-      URL: `${ensUrl}${domain}`,
-    };
-
-    let message = "Domain information:\n\n";
-    for (const [key, value] of Object.entries(formattedData)) {
-      if (value) {
-        message += `${key}: ${value}\n`;
-      }
-    }
-    message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
-    message = message.trim();
-    if (await isOnXMTP(context.client, context.v2client, sender?.address)) {
-      await context.send(
-        `Ah, this domains is in XMTP, you can message it directly: https://converse.xyz/dm/${domain}`,
-      );
-    }
-    return { code: 200, message };
-  } else if (skill == "check") {
-    const { domain } = params;
-
-    if (!domain) {
-      return {
-        code: 400,
-        message: "Please provide a domain name to check.",
-      };
-    }
-
-    const data = await getUserInfo(domain);
-    if (!data?.address) {
-      let message = `Looks like ${domain} is available! Here you can register it: ${ensUrl}${domain} or would you like to see some cool alternatives?`;
-      return {
-        code: 200,
-        message,
-      };
-    } else {
-      let message = `Looks like ${domain} is already registered!`;
-      await context.executeSkill("/cool " + domain);
-      return {
-        code: 404,
-        message,
-      };
-    }
-  } else if (skill == "tip") {
-    const { address } = params;
-    if (!address) {
-      return {
-        code: 400,
-        message: "Please provide an address to tip.",
-      };
-    }
-    const data = await getUserInfo(address);
-    let txUrl = `${baseTxUrl}/transaction/?transaction_type=send&buttonName=Tip%20${data?.ensDomain ?? ""}&amount=1&token=USDC&receiver=${
-      isAddress(address) ? address : data?.address
-    }`;
-    console.log(txUrl);
-    return {
-      code: 200,
-      message: txUrl,
-    };
-  } else if (skill == "cool") {
-    const { domain } = params;
-    //What about these cool alternatives?\
-    return {
-      code: 200,
-      message: `${generateCoolAlternatives(domain)}`,
-    };
-  } else {
-    return { code: 400, message: "Skill not found." };
-  }
-}
-
-export const generateCoolAlternatives = (domain: string) => {
-  const suffixes = ["lfg", "cool", "degen", "moon", "base", "gm"];
-  const alternatives = [];
-  for (let i = 0; i < 5; i++) {
-    const randomPosition = Math.random() < 0.5;
-    const baseDomain = domain.replace(/\.eth$/, ""); // Remove any existing .eth suffix
-    alternatives.push(
-      randomPosition
-        ? `${suffixes[i]}${baseDomain}.eth`
-        : `${baseDomain}${suffixes[i]}.eth`,
-    );
-  }
-
-  const cool_alternativesFormat = alternatives
-    .map(
-      (alternative: string, index: number) => `${index + 1}. ${alternative} ✨`,
-    )
-    .join("\n");
-  return cool_alternativesFormat;
-};
-
-export async function clear() {
-  clearMemory();
-  clearInfoCache();
-}

package/templates/agent/src/skills.ts

@@ -1,107 +0,0 @@
-import { handleEns } from "./handler/ens.js";
-import type { SkillGroup } from "@xmtp/message-kit";
-
-export const skills: SkillGroup[] = [
-  {
-    name: "Ens Domain Bot",
-    tag: "@ens",
-    description: "Register ENS domains.",
-    skills: [
-      {
-        skill: "/register [domain]",
-        triggers: ["/register"],
-        handler: handleEns,
-        description:
-          "Register a new ENS domain. Returns a URL to complete the registration process.",
-        examples: ["/register vitalik.eth"],
-        params: {
-          domain: {
-            type: "string",
-          },
-        },
-      },
-      {
-        skill: "/exists",
-        examples: ["/exists"],
-        handler: handleEns,
-        triggers: ["/exists"],
-        description: "Check if an address is onboarded.",
-        params: {
-          address: {
-            type: "address",
-          },
-        },
-      },
-      {
-        skill: "/info [domain]",
-        triggers: ["/info"],
-        handler: handleEns,
-        description:
-          "Get detailed information about an ENS domain including owner, expiry date, and resolver.",
-        examples: ["/info nick.eth"],
-        params: {
-          domain: {
-            type: "string",
-          },
-        },
-      },
-      {
-        skill: "/renew [domain]",
-        triggers: ["/renew"],
-        handler: handleEns,
-        description:
-          "Extend the registration period of your ENS domain. Returns a URL to complete the renewal.",
-        examples: ["/renew fabri.base.eth"],
-        params: {
-          domain: {
-            type: "string",
-          },
-        },
-      },
-      {
-        skill: "/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",
-          },
-        },
-      },
-      {
-        skill: "/cool [domain]",
-        triggers: ["/cool"],
-        examples: ["/cool vitalik.eth"],
-        handler: handleEns,
-        description: "Get cool alternatives for a .eth domain.",
-        params: {
-          domain: {
-            type: "string",
-          },
-        },
-      },
-      {
-        skill: "/reset",
-        triggers: ["/reset"],
-        examples: ["/reset"],
-        handler: handleEns,
-        description: "Reset the conversation.",
-        params: {},
-      },
-      {
-        skill: "/tip [address]",
-        description: "Show a URL for tipping a domain owner.",
-        triggers: ["/tip"],
-        handler: handleEns,
-        examples: ["/tip 0x1234567890123456789012345678901234567890"],
-        params: {
-          address: {
-            type: "string",
-          },
-        },
-      },
-    ],
-  },
-];

package/templates/gm/.env.example

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

package/templates/gm/src/index.ts

@@ -1,5 +0,0 @@
-import { run, HandlerContext } from "@xmtp/message-kit";
-
-run(async (context: HandlerContext) => {
-  context.send("gm");
-});

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

@@ -1,29 +0,0 @@
-import { getUserInfo, HandlerContext } from "@xmtp/message-kit";
-
-export async function handler(context: HandlerContext) {
-  const {
-    message: {
-      content: { skill, params },
-    },
-  } = context;
-  const baseUrl = "https://txpay.vercel.app";
-
-  if (skill === "pay") {
-    const { amount: amountSend, token: tokenSend, username } = params; // [!code hl] // [!code focus]
-    console.log("username", username);
-    let senderInfo = await getUserInfo(username);
-    if (!amountSend || !tokenSend || !senderInfo) {
-      context.reply(
-        "Missing required parameters. Please provide amount, token, and username.",
-      );
-      return {
-        code: 400,
-        message:
-          "Missing required parameters. Please provide amount, token, and username.",
-      };
-    }
-
-    let sendUrl = `${baseUrl}/?&amount=${amountSend}&token=${tokenSend}&receiver=${senderInfo.address}`;
-    await context.send(`${sendUrl}`);
-  }
-}

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

@@ -1,40 +0,0 @@
-import {
-  HandlerContext,
-  AbstractedMember,
-  SkillResponse,
-} from "@xmtp/message-kit";
-import { getUserInfo } from "@xmtp/message-kit";
-
-export async function handler(context: HandlerContext) {
-  const {
-    message: {
-      content: {
-        skill,
-        params: { amount, username },
-      },
-      sender,
-    },
-  } = context;
-  let receivers: AbstractedMember[] = [];
-
-  if (skill === "tip") {
-    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.");
-  }
-  const receiverAddresses = receivers.map((receiver) => receiver.address);
-
-  context.sendTo(
-    `You received ${amount} tokens from ${sender.address}.`,
-    receiverAddresses,
-  );
-
-  // Notify sender of the transaction details
-  context.sendTo(
-    `You sent ${amount * receiverAddresses.length} tokens in total.`,
-    [sender.address],
-  );
-}