create-message-kit 1.0.15 → 1.0.17

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

@@ -1,23 +1,25 @@
-import type { CommandGroup } from "@xmtp/message-kit";
+import type { SkillGroup } from "@xmtp/message-kit";
 import { handler as tipping } from "./handler/tipping.js";
 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[] = [
+export const skills: SkillGroup[] = [
   {
     name: "Tipping",
     description: "Tip tokens via emoji, replies or command.",
-    triggers: ["/tip", "🎩", "@tip"],
-    commands: [
+    skills: [
       {
-        command: "/tip [@users] [amount] [token]",
+        command: "/tip [@usernames] [amount] [token]",
+        triggers: ["/tip"],
         description: "Tip users in a specified token.",
         handler: tipping,
         params: {
           username: {
             default: "",
+            plural: true,
             type: "username",
           },
           amount: {
@@ -30,11 +32,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Transactions",
-    triggers: ["@send", "/send", "@swap", "/swap", "/show"],
     description: "Multipurpose transaction frame built onbase.",
-    commands: [
+    skills: [
       {
-        command: "/send [amount] [token] [@username]",
+        command: "/send [amount] [token] [username]",
+        triggers: ["/send"],
         description:
           "Send a specified amount of a cryptocurrency to a destination address.",
         handler: transaction,
@@ -56,6 +58,7 @@ export const commands: CommandGroup[] = [
       },
       {
         command: "/swap [amount] [token_from] [token_to]",
+        triggers: ["/swap"],
         description: "Exchange one type of cryptocurrency for another.",
         handler: transaction,
         params: {
@@ -77,6 +80,7 @@ export const commands: CommandGroup[] = [
       },
       {
         command: "/show",
+        triggers: ["/show"],
         handler: transaction,
         description: "Show the whole frame.",
         params: {},
@@ -85,11 +89,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Games",
-    triggers: ["/game", "@game", "🔎", "🔍"],
     description: "Provides various gaming experiences.",
-    commands: [
+    skills: [
       {
         command: "/game [game]",
+        triggers: ["/game", "🔎", "🔍"],
         handler: games,
         description: "Play a game.",
         params: {
@@ -104,17 +108,19 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Loyalty",
-    triggers: ["/points", "@points", "/leaderboard", "@leaderboard"],
     description: "Manage group members and metadata.",
-    commands: [
+    skills: [
       {
         command: "/points",
+        triggers: ["/points"],
         handler: loyalty,
         description: "Check your points.",
         params: {},
       },
       {
         command: "/leaderboard",
+        triggers: ["/leaderboard"],
+        adminOnly: true,
         handler: loyalty,
         description: "Check the points of a user.",
         params: {},
@@ -123,11 +129,11 @@ export const commands: CommandGroup[] = [
   },
   {
     name: "Agent",
-    triggers: ["/agent", "@agent", "@bot"],
     description: "Manage agent commands.",
-    commands: [
+    skills: [
       {
         command: "/agent [prompt]",
+        triggers: ["/agent", "@agent", "@bot"],
         handler: agent,
         description: "Manage agent commands.",
         params: {
@@ -139,22 +145,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.",
-    commands: [
+    description: "Get help with the bot.",
+    skills: [
       {
         command: "/help",
-        handler: undefined,
+        triggers: ["/help"],
+        handler: helpHandler,
         description: "Get help with the bot.",
         params: {},
       },

package/examples/gm/.env.example

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

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/group/src/index.ts

@@ -1,68 +0,0 @@
-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;
-    case "text":
-      handleTextMessage(context);
-      break;
-  }
-});
-async function handleReply(context: HandlerContext) {
-  const {
-    v2client,
-    getReplyChain,
-    version,
-    message: {
-      content: { reference },
-    },
-  } = context;
-
-  const { chain, isSenderInChain } = await getReplyChain(
-    reference,
-    version,
-    v2client.address,
-  );
-  console.log(chain);
-  handleTextMessage(context);
-}
-
-// Handle attachment messages
-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) {
-  const { commands = [] } = context;
-  const intro =
-    "Available experiences:\n" +
-    commands
-      .flatMap((app) => app.commands)
-      .map((command) => `${command.command} - ${command.description}`)
-      .join("\n") +
-    "\nUse these commands to interact with specific apps.";
-  context.send(intro);
-}

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;
-};