create-message-kit 1.2.23 → 1.2.25

package/templates/toss/package.json

@@ -1,21 +0,0 @@
-{
-  "name": "toss",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc -w & sleep 1 && NODE_NO_WARNINGS=1 node --watch dist/index.js",
-    "start": "node dist/index.js"
-  },
-  "dependencies": {
-    "@redis/client": "^1.6.0",
-    "@xmtp/message-kit": "workspace:*"
-  },
-  "devDependencies": {
-    "@types/node": "^20.14.2",
-    "typescript": "^5.4.5"
-  },
-  "engines": {
-    "node": ">=20"
-  }
-}

package/templates/toss/src/index.ts

@@ -1,29 +0,0 @@
-import {
-  run,
-  agentReply,
-  replaceVariables,
-  XMTPContext,
-  Agent,
-} from "@xmtp/message-kit";
-
-import { systemPrompt } from "./prompt.js";
-import { toss } from "./skills/toss.js";
-import { waas } from "./skills/waas.js";
-
-export const agent: Agent = {
-  name: "Toss Bot",
-  tag: "@toss",
-  description: "Create a coin toss.",
-  skills: [toss, waas],
-  onMessage: async (context: XMTPContext) => {
-    const {
-      message: { sender },
-    } = context;
-
-    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-
-    await agentReply(context, prompt);
-  },
-};
-
-run(agent);

package/templates/toss/src/plugins/helpers.ts

@@ -1,174 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import { getRedisClient } from "./redis.js";
-
-interface Participant {
-  response: string;
-  name: string;
-  address: string;
-}
-export interface TossData {
-  group_id: string;
-  admin_name: string;
-  admin_address: string;
-  options: string;
-  toss_id: string;
-  amount: number;
-  created_at: string;
-  end_time: string;
-  description: string;
-  participants: Participant[];
-}
-export async function checkTossCorrect(
-  context: XMTPContext,
-): Promise<TossData | undefined> {
-  const {
-    message: {
-      content: { previousMsg },
-    },
-    group,
-  } = context;
-
-  if (!group) {
-    await context.reply("This command can only be used in a group.");
-    return undefined;
-  } else if (!previousMsg) {
-    await context.reply("You must reply to a toss.");
-    return undefined;
-  }
-
-  let toss_id = extractTossId(previousMsg);
-  if (!toss_id) {
-    await context.reply(
-      "Invalid toss ID. Be sure you are replying to a original toss.",
-    );
-    return undefined;
-  }
-  const tossDBClient = await getRedisClient();
-  const tossDataString = await tossDBClient.get(`toss:${toss_id}`);
-  let tossData = tossDataString ? JSON.parse(tossDataString) : null;
-
-  if (typeof tossData === "string") {
-    tossData = JSON.parse(tossData) as TossData;
-  }
-
-  if (!tossData) {
-    await context.reply("Toss not found");
-    return undefined;
-  } else if (tossData.status === "closed") {
-    await context.reply("Toss has already ended.");
-    return undefined;
-  } else if (tossData.group_id.toLowerCase() !== group.id.toLowerCase()) {
-    await context.reply("This toss is not in this group.");
-    return undefined;
-  }
-
-  return { ...tossData, toss_id };
-}
-
-export function extractTossId(message: string): string | null {
-  try {
-    const match = message.match(/ID:\s*(\d+)/);
-    return match ? match[1].toString() : null;
-  } catch (error) {
-    return null;
-  }
-}
-
-export async function extractWinners(
-  participants: Participant[],
-  option: string,
-): Promise<{
-  winners: Participant[];
-  losers: Participant[];
-}> {
-  let winners: Participant[] = [];
-  let losers: Participant[] = [];
-
-  await Promise.all(
-    participants.map(async (participant) => {
-      if (participant.response.toLowerCase() === option.toLowerCase()) {
-        winners.push(participant);
-      } else {
-        losers.push(participant);
-      }
-    }),
-  );
-  return { winners, losers };
-}
-
-export function generateTossMessage(tossData: TossData): string {
-  return `Here is your toss!\n
-🪙  ${tossData.description.toUpperCase()}? - ${tossData.options.toUpperCase()} - $${tossData.amount}\n
-- ID: ${tossData.toss_id}
-- Judge: ${tossData.admin_name}
-- Ends on: ${tossData.end_time}
-
-How to toss:\n- The creator of the toss is one who can end or settle the toss. \n- The pool will be split evenly with the winners. \n- Remember, with great power comes great responsibility 💪
-
-\n🛠️ Reply with:
-@toss <option>
-@toss end <option> - only the judge can end the toss
-@toss cancel - only the creator can cancel the toss
-@toss status - check the status of the toss
-@toss help - for managing your toss via DMs`;
-}
-
-export function generateEndTossMessage(
-  winners: { name: string; address: string }[],
-  losers: { name: string; address: string }[],
-  prize: number,
-): string {
-  if (!winners.length) {
-    return `The toss has been closed and no winners were found.`;
-  }
-  let message = `🏆 Winners have been rewarded! 🏆\n\n🎉 Winners: \n${winners
-    .map((winner) => `- ${winner.name} - $${prize} 💰\n`)
-    .join("")}`;
-  if (losers.length > 0) {
-    message += `\n😢 Losers: \n${losers
-      .map((loser) => `- ${loser.name} 😢\n`)
-      .join("")}`;
-  }
-  return (
-    message +
-    `\nThe pool has been distributed among the winners. The toss has been closed now.`
-  );
-}
-
-export async function generateTossStatusMessage(
-  tossData: TossData,
-): Promise<string> {
-  const participants = tossData.participants;
-  return `Here are the details:
-- Amount: $${tossData.amount}
-- Description: ${tossData.description}
-- Judge: ${tossData.admin_name}
-- End Time: ${tossData.end_time}
-
-📊 Status:
-    👥 Participants:\n${participants
-      ?.map(
-        (participant: any) =>
-          `- ${participant.name ?? participant.address} - ${participant.response}\n`,
-      )
-      .join("")}
-🏦 Pool: $${(tossData?.participants?.length || 0) * tossData.amount}
-📋 Options:
-${tossData.options
-  .split(",")
-  .map((option: string) => {
-    const voteCount = participants?.filter(
-      (participant: any) =>
-        participant.response.toLowerCase() === option.toLowerCase(),
-    ).length;
-    return `\t- ${option}: ${voteCount} votes`;
-  })
-  .join("\n")} `;
-}
-
-export const DM_HELP_MESSAGE = `Welcome to @toss! I'm your friendly neighbourhood toss bot.
-/fund [amount] - You can fund your account with 
-/balance - Check your balance
-/withdraw [amount] - You can withdraw funds to your wallet
-/create - Create an agent wallet
-/help - Get help with tossing`;

package/templates/toss/src/plugins/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;
-};

package/templates/toss/src/prompt.ts

@@ -1,54 +0,0 @@
-export const systemPrompt = `You are a helpful agent, friendly toss master named @toss, always ready to flip the odds!
-{rules}
-
-## Game rules
-- The token is always USDC. Ignore other tokens and default to usdc. Don't mention the token in the command.
-- Infer the name of the toss from the prompt if it's not provided. It should be a short sentence summarizing the event, never mention the options.
-- Tosses must always have two options. If options are not provided, assume "Yes" and "No."
-- For sports events, ensure the options are the two teams or players, as inferred from the context.
-- If the user provides unclear or incomplete information, infer and generate the correct toss format based on context.
-- Maximum toss amount is 10. Default to 10 if nothing is provided. Minimum is 0.00 and its valid.
-- Don't mention options in the toss name.
-- Remove all emojis from the options.
-- If toss is correct. Don't return anything else than the command. Ever.
-- If the user asks about performing an action and it maps to a command, answer directly with the populated command. Always return commands with real values only.
-- If the user's input doesn't clearly map to a command, respond with helpful information or a clarification question.
-- Date needs to be formatted in UTC and in the future.
-
-{user_context}
-
-{skills}
-
-## Examples scenarios
-
-1. @toss will it rain tomorrow? yes,no 10
-  - /toss 'will it rain tomorrow' 'yes,no' 10 24h from now
-2. @toss race to the end Fabri vs John? fabri,john 10
-  - /toss 'race to the end' 'fabri,john' 10
-3. @toss will it rain tomorrow for 10 (keep the toss for 1 week), judge is @fabri
-  - /toss 'will it rain tomorrow' 'yes,no' 10 '24 hours from now' @fabri
-4. @toss will the stock price of company X go up tomorrow? yes,no 5
-  - /toss 'will the stock price of company x go up tomorrow' 'yes,no' 5
-5. @toss who will win the match? team A vs team B 10
-  - /toss 'who will win the match' 'team a,team b' 10
-6. will the project be completed on time? yes,no 0
-  - /toss 'will the project be completed on time' 'yes,no' 0
-7. @toss will the meeting be rescheduled? yes,no 2
-  - /toss 'will the meeting be rescheduled' 'yes,no' 2
-8. will the product launch be successful? yes,no 7
-  - /toss 'will the product launch be successful' 'yes,no' 7
-9. @toss will the team meet the deadline? yes,no 3
-  - /toss 'will the team meet the deadline' 'yes,no' 3
-10. will the event be postponed? yes,no 1
-  - /toss 'will the event be postponed' 'yes,no' 1
-11. @toss yes
-  - /join yes
-12. @toss no
-  - /join no
-13. @toss status
-  - /status
-14. @toss end yes
-  - /end yes
-
-{issues}
-`;

package/templates/toss/src/skills/toss.ts

@@ -1,318 +0,0 @@
-import { Skill, XMTPContext, getUserInfo } from "@xmtp/message-kit";
-import { getRedisClient } from "../plugins/redis.js";
-import {
-  checkTossCorrect,
-  extractWinners,
-  TossData,
-  generateTossMessage,
-  generateEndTossMessage,
-  generateTossStatusMessage,
-  DM_HELP_MESSAGE,
-} from "../plugins/helpers.js";
-
-export const toss: Skill[] = [
-  {
-    skill: "end",
-    description: "End a toss.",
-    handler: handleEndToss,
-    examples: ["/end yes", "/end no"],
-    params: {
-      option: {
-        type: "string",
-      },
-    },
-  },
-  {
-    skill: "cancel",
-    description: "Cancel a toss.",
-    handler: handleCancelToss,
-    examples: ["/cancel"],
-  },
-  {
-    skill: "join",
-    description: "Join a toss.",
-    params: {
-      response: {
-        type: "string",
-      },
-    },
-    handler: handleJoinToss,
-    examples: ["/join yes", "/join no"],
-  },
-  {
-    skill: "status",
-    description: "Check the status of the toss.",
-    handler: handleTossStatus,
-    examples: ["/status"],
-  },
-  {
-    skill: "toss",
-    description:
-      "Create a toss with a description, options, amount and judge(optional).",
-    handler: handleTossCreation,
-    examples: [
-      "/toss 'Shane vs John at pickeball' 'Yes,No' 10",
-      "/toss 'Will argentina win the world cup' 'Yes,No' 10",
-      "/toss 'Race to the end' 'Fabri,John' 10 @fabri",
-      "/toss 'Will argentina win the world cup' 'Yes,No' 5 '27 Oct 2023 23:59:59 GMT'",
-      "/toss 'Will the niks win on sunday?' 'Yes,No' 10 vitalik.eth '27 Oct 2023 23:59:59 GMT'",
-      "/toss 'Will it rain tomorrow' 'Yes,No' 0",
-    ],
-    params: {
-      description: {
-        type: "quoted",
-      },
-      options: {
-        default: "Yes, No",
-        type: "quoted",
-      },
-      amount: {
-        type: "number",
-      },
-      judge: {
-        type: "username",
-        optional: true,
-      },
-      endTime: {
-        type: "quoted",
-        optional: true,
-      },
-    },
-  },
-];
-
-export async function handleTossCreation(context: XMTPContext) {
-  const {
-    message: {
-      content: { params },
-      sender,
-    },
-    walletService,
-    group,
-  } = context;
-  if (!group) {
-    await context.reply("This command can only be used in a group.");
-    return;
-  }
-
-  const tossDBClient = await getRedisClient();
-  if (params.description && params.options && !isNaN(Number(params.amount))) {
-    const keys = await tossDBClient.keys("*");
-    let tossId = keys.length + 1;
-    const isCreated = await walletService.createWallet(
-      tossId + ":" + sender.address,
-    );
-    if (!isCreated) {
-      await context.reply("Failed to create toss wallet");
-      return;
-    }
-
-    let tossData: TossData = {
-      toss_id: tossId.toString(),
-      description: params.description,
-      options: params.options,
-      amount: params.amount,
-      group_id: group.id,
-      admin_name:
-        (await getUserInfo(params.judge ?? sender.address))?.preferredName ??
-        "",
-      admin_address: params.judge ?? sender.address,
-      created_at: new Date().toLocaleString(),
-      end_time: params.endTime
-        ? new Date(params.endTime).toLocaleString()
-        : new Date(Date.now() + 24 * 60 * 60 * 1000).toLocaleString(),
-      participants: [],
-    };
-    await tossDBClient.set("toss:" + tossId, JSON.stringify(tossData));
-    if (tossId !== undefined) {
-      await context.send(generateTossMessage(tossData));
-    } else {
-      await context.reply(
-        `An error occurred while creating the toss. ${tossId}`,
-      );
-    }
-  }
-}
-
-export async function handleJoinToss(context: XMTPContext) {
-  const tossData = await checkTossCorrect(context);
-  if (!tossData) {
-    return;
-  }
-
-  const { toss_id, participants, amount, admin_address } = tossData;
-
-  const {
-    message: {
-      sender,
-      content: {
-        params: { response },
-      },
-    },
-    walletService,
-  } = context;
-
-  const tossDBClient = await getRedisClient();
-  if (participants?.some((p) => p.address === sender.address)) {
-    await context.reply("You have already joined this toss.");
-    return;
-  }
-  //Create wallet for sender
-  await walletService.createWallet(sender.address);
-  const balance = await walletService.checkBalance(sender.address);
-  if (balance < amount) return walletService.requestFunds(amount);
-
-  try {
-    let tempWalletID = toss_id + ":" + admin_address;
-    await walletService.transfer(sender.address, tempWalletID, amount);
-    const participant = {
-      address: sender.address,
-      response: response,
-      name:
-        (await context.getUserInfo(sender.address))?.preferredName ??
-        sender.address,
-    };
-    participants.push(participant);
-
-    await tossDBClient.set(
-      `toss:${toss_id}`,
-      JSON.stringify({ ...tossData, participants }),
-    );
-
-    await context.reply("Successfully joined the toss!");
-    await context.sendTo(
-      `Your balance was deducted by $${amount}. Now is $${balance - amount}. You can check your balance with /balance`,
-      [sender.address],
-    );
-    await context.executeSkill(`/status ${toss_id}`);
-  } catch (error) {
-    console.error(error);
-    await context.reply("Failed to process your entry. Please try again.");
-  }
-}
-
-export async function handleEndToss(context: XMTPContext) {
-  const tossData = await checkTossCorrect(context);
-  if (!tossData) return;
-  const { toss_id, admin_address, options, participants } = tossData;
-
-  const {
-    message: {
-      sender,
-      content: {
-        params: { option },
-      },
-    },
-    walletService,
-  } = context;
-
-  const tossDBClient = await getRedisClient();
-  if (participants?.length === 0) {
-    await context.reply("No participants for this toss.");
-    return;
-  } else if (admin_address.toLowerCase() !== sender.address.toLowerCase()) {
-    await context.reply("Only the admin can cancel the toss.");
-    return;
-  }
-
-  let tempWalletID = toss_id + ":" + admin_address;
-  const balance = await walletService.checkBalance(tempWalletID);
-  const fundsNeeded = tossData.amount * participants?.length;
-  if (balance < fundsNeeded) {
-    await context.reply(
-      `Toss wallet does not have enough funds ${fundsNeeded}, has ${balance}`,
-    );
-    return;
-  }
-
-  //Winners
-
-  const { winners, losers } = await extractWinners(participants, option);
-
-  const prize =
-    (tossData.amount * (participants?.length ?? 0)) / (winners.length ?? 1);
-
-  try {
-    for (const winner of winners) {
-      await walletService.transfer(tempWalletID, winner.address, prize);
-      await tossDBClient.set(
-        `toss:${toss_id}`,
-        JSON.stringify({ ...tossData, status: "closed" }),
-      );
-    }
-    // Clean up
-    //await walletService.deleteTempWallet(tossWalletRedis, tossId.toString());
-    if (winners.length > 0) {
-      await context.reply(generateEndTossMessage(winners, losers, prize));
-    }
-
-    await context.sendTo(
-      `You received $${prize} from the toss! Check your balance with /balance`,
-      winners.map((w) => w.address),
-    );
-  } catch (error) {
-    await context.reply(`Failed to send prize to ${winners.length} winners`);
-  }
-}
-
-export async function handleCancelToss(context: XMTPContext) {
-  const tossData = await checkTossCorrect(context);
-  if (!tossData) return;
-
-  const { toss_id, admin_address, participants, amount } = tossData;
-
-  const {
-    message: { sender },
-    walletService,
-  } = context;
-
-  const tossDBClient = await getRedisClient();
-  if (participants?.length === 0) {
-    await context.reply("No participants for this toss.");
-    return;
-  } else if (admin_address.toLowerCase() !== sender.address.toLowerCase()) {
-    await context.reply("Only the admin can cancel the toss.");
-    return;
-  }
-
-  let tempWalletID = toss_id + ":" + admin_address;
-  const balance = await walletService.checkBalance(tempWalletID);
-  const fundsNeeded = tossData.amount * participants?.length;
-  if (balance < fundsNeeded) {
-    await context.reply(
-      `Toss wallet does not have enough funds ${fundsNeeded}, has ${balance}`,
-    );
-    return;
-  }
-  for (const participant of participants) {
-    try {
-      await walletService.transfer(tempWalletID, participant.address, amount);
-    } catch (error) {
-      console.error(
-        `Failed to send prize to ${participant.address} agent wallet:`,
-        error,
-      );
-      await context.reply(
-        `Failed to send prize to ${participant.address} agent wallet`,
-      );
-    }
-  }
-
-  // Clean up
-  //await walletService.deleteTempWallet(tossWalletRedis, tossId.toString());
-
-  await tossDBClient.set(
-    `toss:${toss_id}`,
-    JSON.stringify({ ...tossData, status: "cancelled" }),
-  );
-
-  await context.reply(
-    `Toss cancelled successfully.\nFunds distributed to participants:\n
-    ${participants?.map((p) => `${p.name} - $${amount}`).join("\n")}`,
-  );
-}
-export async function handleTossStatus(context: XMTPContext) {
-  const tossData = await checkTossCorrect(context);
-  if (!tossData) return;
-  await context.reply(await generateTossStatusMessage(tossData));
-}