create-message-kit 1.2.14 → 1.2.16

package/templates/toss/.cursorrules

@@ -0,0 +1,290 @@
+# MessageKit Skill Template
+
+## Examples
+
+### Check if a Domain is Available
+
+
+import { ensUrl } from "../index.js";
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+// Define Skill
+export const checkDomain: Skill[] = [
+  {
+    skill: "check",
+    handler: handler,
+    examples: ["/check vitalik.eth", "/check fabri.base.eth"],
+    description: "Check if a domain is available.",
+    params: {
+      domain: {
+        type: "string",
+      },
+    },
+  },
+];
+
+// Handler Implementation
+export async function handler(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        params: { domain },
+      },
+    },
+  } = context;
+
+  const data = await context.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,
+    };
+  }
+}
+
+### Generate a payment request
+
+
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+// Define Skill
+export const paymentRequest: Skill[] = [
+  {
+    skill: "pay",
+    examples: [
+      "/pay 10 vitalik.eth",
+      "/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03",
+    ],
+    description:
+      "Send a specified amount of a cryptocurrency to a destination address. \nWhen tipping, you can assume it's 1 USDC.",
+    handler: handler,
+    params: {
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
+      },
+      username: {
+        default: "",
+        type: "username",
+      },
+      address: {
+        default: "",
+        type: "address",
+      },
+    },
+  },
+];
+
+// Handler Implementation
+export async function handler(context: XMTPContext) {
+  const {
+    message: {
+      content: {
+        params: { amount, token, username, address },
+      },
+    },
+  } = context;
+  let receiverAddress = address;
+  if (username) {
+    receiverAddress = (await context.getUserInfo(username))?.address;
+  }
+  if (address) {
+    // Prioritize address over username
+    receiverAddress = address;
+  }
+
+  await context.requestPayment(amount, token, receiverAddress);
+}
+
+
+## Types
+
+import { XMTPContext } from "../plugins/xmtp.js";
+import { ClientOptions, GroupMember } from "@xmtp/node-sdk";
+import { ContentTypeId } from "@xmtp/content-type-primitives";
+
+export type MessageAbstracted = {
+  id: string;
+  sent: Date;
+  content: {
+    text?: string | undefined;
+    reply?: string | undefined;
+    previousMsg?: string | undefined;
+    react?: string | undefined;
+    content?: any | undefined;
+    params?: any | undefined;
+    reference?: string | undefined;
+    skill?: string | undefined;
+  };
+  version: "v2" | "v3";
+  sender: AbstractedMember;
+  typeId: string;
+};
+export type GroupAbstracted = {
+  id: string;
+  sync: () => Promise<void>;
+  addMembers: (addresses: string[]) => Promise<void>;
+  addMembersByInboxId: (inboxIds: string[]) => Promise<void>;
+  send: (content: string, contentType?: ContentTypeId) => Promise<string>;
+  isAdmin: (inboxId: string) => boolean;
+  isSuperAdmin: (inboxId: string) => boolean;
+  admins: string[];
+  superAdmins: string[];
+  createdAt: Date;
+  members: GroupMember[];
+};
+export type SkillResponse = {
+  code: number;
+  message: string;
+  data?: any;
+};
+
+export type SkillHandler = (
+  context: XMTPContext,
+) => Promise<SkillResponse | void>;
+
+export type Handler = (context: XMTPContext) => Promise<void>;
+
+export type RunConfig = {
+  // client options from XMTP client
+  client?: ClientOptions;
+  // private key to be used for the client, if not, default from env
+  privateKey?: string;
+  // if true, the init log message with messagekit logo and stuff will be hidden
+  experimental?: boolean;
+  // hide the init log message with messagekit logo and stuff
+  hideInitLogMessage?: boolean;
+  // if true, attachments will be enabled
+  attachments?: boolean;
+  // if true, member changes will be enabled, like adding members to the group
+  memberChange?: boolean;
+  // skills to be used
+  agent?: Agent;
+  // model to be used
+  gptModel?: string;
+};
+export interface SkillParamConfig {
+  default?: string | number | boolean;
+  type:
+    | "number"
+    | "string"
+    | "username"
+    | "quoted"
+    | "address"
+    | "prompt"
+    | "url";
+  plural?: boolean;
+  values?: string[]; // Accepted values for the parameter
+}
+
+export interface Frame {
+  title: string;
+  buttons: { content: string; action: string; target: string }[];
+  image: string;
+}
+export interface Agent {
+  name: string;
+  description: string;
+  tag: string;
+  skills: Skill[];
+}
+export interface Skill {
+  skill: string;
+  handler?: SkillHandler | undefined;
+  adminOnly?: boolean;
+  description: string;
+  examples: string[];
+  params: Record<string, SkillParamConfig>;
+}
+
+export interface AbstractedMember {
+  inboxId: string;
+  address: string;
+  accountAddresses: string[];
+  installationIds?: string[];
+}
+
+export type MetadataValue = string | number | boolean;
+export type Metadata = Record<string, MetadataValue | MetadataValue[]>;
+
+
+## Example final prompt
+
+Your are a helpful and playful ens agent called @bot that lives inside a messaging app called Converse.
+
+
+# Rules
+- 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.
+- Each command starts with a slash (/).
+- Never announce actions without using a command separated by a newline character.
+- Never use markdown in your responses.
+- 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.
+- Date: Fri, 06 Dec 2024 16:03:22 GMT
+- When mentioning any action related to available skills, you MUST trigger the corresponding command in a new line
+- If you suggest an action that has a command, you must trigger that command
+
+
+## User context
+- Start by fetch their domain from or Converse 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.
+- Message sent date: 2024-12-06T16:03:36.582Z
+- Users address is: 0x40f08f0f853d1c42c61815652b7ccd5a50f0be09
+- Users name is: ArizonaOregon
+- Converse username is: ArizonaOregon
+
+## Commands
+/check [domain] - Check if a domain is available.
+/cool [domain] - Get cool alternatives for a .eth domain.
+/info [domain] - Get detailed information about an ENS domain including owner, expiry date, and resolver.
+/register [domain] - Register a new ENS domain. Returns a URL to complete the registration process.
+/renew [domain] - Extend the registration period of your ENS domain. Returns a URL to complete the renewal.
+/reset  - Reset the conversation clearing memory and usernames cache.
+/pay [amount] [token] [username] [address] - Send a specified amount of a cryptocurrency to a destination address. 
+When tipping, you can asume its 1 usdc.
+
+## Examples
+/check vitalik.eth
+/check fabri.base.eth
+/cool vitalik.eth
+/info nick.eth
+/register vitalik.eth
+/renew fabri.base.eth
+/reset
+/pay 10 vitalik.eth
+/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03
+
+## Scenarios
+1. Missing commands in responses
+   **Issue**: Sometimes responses are sent without the required command.
+   **Example**:
+   Incorrect:
+   > "Looks like vitalik.eth is registered! What about these cool alternatives?"
+   Correct:
+   > "Looks like vitalik.eth is registered! What about these cool alternatives?
+   > /cool vitalik.eth"
+
+   Incorrect:
+   > Here is a summary of your TODOs. I will now send it via email.
+   Correct:
+   > /todo

package/templates/toss/.env.example

@@ -0,0 +1,7 @@
+KEY= # the private key of the wallet
+TEST_ENCRYPTION_KEY= # a different private key for encryption
+OPENAI_API_KEY= # the API key for OpenAI
+REDIS_CONNECTION_STRING= # the connection to the toss database in Redis
+COINBASE_API_REDIS_URL= # the API key for OpenAI
+COINBASE_API_KEY_NAME= # the API key name for Coinbase
+COINBASE_API_KEY_PRIVATE_KEY= # the private key for Coinbase

package/templates/toss/.yarnrc.yml

@@ -0,0 +1,9 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableTelemetry: false
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.5.1.cjs

package/templates/toss/package.json

@@ -0,0 +1,21 @@
+{
+  "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

@@ -0,0 +1,33 @@
+import {
+  run,
+  agentReply,
+  replaceVariables,
+  XMTPContext,
+  Agent,
+} from "@xmtp/message-kit";
+
+import { systemPrompt } from "./prompt.js";
+import { toss } from "./skills/toss.js";
+import fs from "fs";
+import { getWalletService } from "./plugins/redis.js";
+const walletServiceDB = await getWalletService();
+export const agent: Agent = {
+  name: "Toss Bot",
+  tag: "@toss",
+  description: "Create a coin toss.",
+  skills: [...toss],
+};
+
+run(
+  async (context: XMTPContext) => {
+    const {
+      message: { sender },
+    } = context;
+
+    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
+    //This is only used for to update the docs.
+    fs.writeFileSync("example_prompt.md", prompt);
+    await agentReply(context, prompt);
+  },
+  { agent, walletServiceDB },
+);

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

@@ -0,0 +1,185 @@
+import { XMTPContext } from "@xmtp/message-kit";
+import { getRedisClient } from "./redis.js";
+
+const tossDBClient = await getRedisClient();
+interface Participant {
+  response: string;
+  name: string;
+  address: string;
+  agent_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;
+  encrypted_participants: string[];
+  participants?: Participant[];
+  toss_wallet_address: string;
+}
+export async function checkTossCorrect(
+  context: XMTPContext,
+): Promise<TossData | undefined> {
+  const {
+    message: {
+      content: { previousMsg },
+    },
+    walletService,
+    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;
+  }
+  let encryptedKey = walletService.encrypt(toss_id);
+  const tossDataString = await tossDBClient.get(`toss:${encryptedKey}`);
+  const hexString = tossDataString?.replace(/"/g, "");
+  let tossData = hexString ? walletService.decrypt(hexString) : null;
+
+  if (typeof tossData === "string") {
+    tossData = JSON.parse(tossData) as TossData;
+  }
+  console.log("tossData", 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;
+  }
+  tossData.participants = [];
+  if (tossData.encrypted_participants?.length) {
+    tossData.participants = tossData.encrypted_participants?.map((p: string) =>
+      walletService.decrypt(p),
+    );
+  }
+  const pool = tossData.amount * (tossData?.participants?.length || 0);
+  return { ...tossData, toss_id, pool };
+}
+
+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

@@ -0,0 +1,78 @@
+import { createClient } from "@redis/client";
+import type { RedisClientType } from "@redis/client";
+
+let redisClient: RedisClientType | null = null;
+
+export const getRedisClient = async () => {
+  if (redisClient?.isOpen) {
+    return redisClient;
+  }
+
+  if (!process.env.REDIS_CONNECTION_STRING) {
+    throw new Error(
+      "REDIS_CONNECTION_STRING not found in environment variables",
+    );
+  }
+  const client = createClient({
+    url: process.env.REDIS_CONNECTION_STRING,
+  });
+
+  client.on("error", (err) => {
+    console.error("Redis client error:", err);
+  });
+
+  await client.connect();
+  redisClient = client as RedisClientType;
+  return client as RedisClientType;
+};
+
+let walletService: RedisClientType | null = null;
+
+export const getWalletService = async (): Promise<RedisClientType> => {
+  if (walletService?.isOpen) {
+    return walletService;
+  }
+
+  if (!process.env.COINBASE_API_REDIS_URL) {
+    throw new Error(
+      "COINBASE_API_REDIS_URL not found in environment variables",
+    );
+  }
+
+  const client = createClient({
+    url: process.env.COINBASE_API_REDIS_URL,
+  });
+
+  client.on("error", (error: Error) => {
+    console.error("Toss wallet Redis client error:", error);
+  });
+
+  client.on("connect", () => {
+    console.log("Connected to Toss Wallet Redis");
+  });
+  await client.connect();
+  walletService = client as RedisClientType;
+  return client as RedisClientType;
+};
+
+export async function updateField(
+  client: RedisClientType,
+  key: string,
+  updateObject: any,
+) {
+  // Check if the key exists
+  const data = await client.get(key);
+
+  let updatedData;
+  if (data) {
+    // If the key exists, parse it and merge the updates
+    const parsedData = JSON.parse(data);
+    updatedData = { ...parsedData, ...updateObject };
+  } else {
+    // If the key doesn't exist, use the updateObject as the initial value
+    updatedData = updateObject;
+  }
+
+  // Save the updated or new data back to Redis
+  await client.set(key, JSON.stringify(updatedData));
+}

package/templates/toss/src/prompt.ts

@@ -0,0 +1,54 @@
+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}
+`;