create-message-kit 1.2.21 → 1.2.23

package/README.md

@@ -9,13 +9,10 @@ bun create message-kit
 ```
 
 ```bash
-npx create-message-kit
+npx create-message-kit@latest
 ```
 
 ```bash
 yarn create message-kit
-```
-
-```bash [npm]
-npm init message-kit
+// use yarn create message-kit@latest in yarn > v2
 ```

package/index.js

@@ -7,7 +7,7 @@ import { default as fs } from "fs-extra";
 import { isCancel } from "@clack/prompts";
 import { detect } from "detect-package-manager";
 import pc from "picocolors";
-const defVersion = "1.2.21";
+const defVersion = "1.2.23";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -140,6 +140,11 @@ async function gatherProjectInfo() {
   const name = kebabcase(displayName);
   const destDir = resolve(process.cwd(), name);
 
+  // Remove existing directory if it exists
+  if (fs.existsSync(destDir)) {
+    fs.removeSync(destDir);
+  }
+
   // Copy template files
   fs.copySync(templateDir, destDir);
 
@@ -214,8 +219,7 @@ async function detectPackageManager() {
 
     const userAgent = process.env.npm_config_user_agent;
 
-    // Check if running through npm init
-    if (userAgent?.startsWith("npm")) {
+    if (userAgent?.startsWith("npm") || userAgent?.startsWith("npx")) {
       return "npm";
     }
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "create-message-kit",
-  "version": "1.2.21",
+  "version": "1.2.23",
   "license": "MIT",
   "type": "module",
   "main": "index.js",
   "module": "index.js",
   "bin": "index.js",
   "files": [
-    "index.js",
+    "templates.json",
     "templates/**/*"
   ],
   "scripts": {

package/templates/coinbase-agent/src/index.ts

@@ -14,11 +14,8 @@ export const agent: Agent = {
   name: "Swap Bot",
   tag: "@base",
   description: "Swap bot for base.",
-  skills: [...swapSkill, ...mintSkill, ...dripSkill, ...paySkill],
-};
-
-run(
-  async (context: XMTPContext) => {
+  skills: [swapSkill, mintSkill, dripSkill, paySkill],
+  onMessage: async (context: XMTPContext) => {
     const {
       message: { sender },
       agent,
@@ -27,5 +24,6 @@ run(
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
     await agentReply(context, prompt);
   },
-  { agent }
-);
+};
+
+run(agent);

package/templates/ens/src/index.ts

@@ -13,41 +13,21 @@ import { register } from "./skills/register.js";
 import { renew } from "./skills/renew.js";
 import { pay } from "./skills/pay.js";
 import { reset } from "./skills/reset.js";
-import fs from "fs";
 
-// [!region skills]
 export const agent: Agent = {
   name: "Ens Agent",
   tag: "@bot",
   description: "A ens agent with a lot of skills.",
-  skills: [
-    ...checkDomain,
-    ...cool,
-    ...info,
-    ...register,
-    ...renew,
-    ...reset,
-    ...pay,
-  ],
-};
-// [!endregion skills]
-
-// [!region run1]
-run(
-  async (context: XMTPContext) => {
+  skills: [checkDomain, cool, info, register, renew, reset, pay],
+  onMessage: async (context: XMTPContext) => {
     const {
       message: { sender },
       agent,
     } = context;
 
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    // [!endregion run1]
-    //This is only used for to update the docs.
-    fs.writeFileSync("example_prompt.md", prompt);
-    // [!region run2]
     await agentReply(context, prompt);
   },
-  { agent },
-);
+};
 
-// [!endregion run2]
+run(agent);

package/templates/ens/src/skills/info.ts

@@ -48,9 +48,12 @@ export async function handler(context: XMTPContext) {
   message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
   message = message.trim();
 
-  if (
-    await context.isOnXMTP(context.client, context.v2client, sender?.address)
-  ) {
+  const { v2, v3 } = await context.isOnXMTP(
+    context.client,
+    context.v2client,
+    sender?.address,
+  );
+  if (v2 || v3) {
     await context.send(
       `Ah, this domains is in XMTP, you can message it directly`,
     );

package/templates/faucet/src/index.ts

@@ -7,33 +7,22 @@ import {
 } from "@xmtp/message-kit";
 import { systemPrompt } from "./prompt.js";
 import { faucet } from "./skills/faucet.js";
-import fs from "fs";
 
 // [!region skills]
 export const agent: Agent = {
   name: "Faucet Agent",
   tag: "@bot",
   description: "A faucet delivery agent.",
-  skills: [...faucet],
-};
-// [!endregion skills]
-
-// [!region run1]
-run(
-  async (context: XMTPContext) => {
+  skills: [faucet],
+  onMessage: async (context: XMTPContext) => {
     const {
       message: { sender },
       agent,
     } = context;
 
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    // [!endregion run1]
-    //This is only used for to update the docs.
-    fs.writeFileSync("example_prompt.md", prompt);
-    // [!region run2]
+
     await agentReply(context, prompt);
   },
-  { agent },
-);
-
-// [!endregion run2]
+};
+run(agent);

package/templates/gated-group/src/index.ts

@@ -12,6 +12,6 @@ export const agent: Agent = {
   name: "Gated Group Creator Agent",
   tag: "@bot",
   description: "A gated group creator agent.",
-  skills: [...gated],
+  skills: [gated],
 };
-run(async (context: XMTPContext) => {}, { agent });
+run(agent);

package/templates/gm/src/index.ts

@@ -1,8 +1,16 @@
-import { run } from "@xmtp/message-kit";
+import { run, Agent } from "@xmtp/message-kit";
 
-run(async (context) => {
-  const { group } = context;
-  if (!group) {
-    await context.send(`gm`);
-  }
-});
+const agent: Agent = {
+  name: "Gm Bot",
+  tag: "@bot",
+  description: "Gm bot.",
+  skills: [],
+  onMessage: async (context) => {
+    const { group } = context;
+    if (!group) {
+      await context.send(`gm`);
+    }
+  },
+};
+
+run(agent);

package/templates/hackathon-store/.env.example

@@ -0,0 +1,6 @@
+TEST_ENCRYPTION_KEY= # test encryption key
+KEY= # key of xmtp bot     
+NOTION_API_KEY= # notion api key
+NOTION_PAGE_ID= # notion page id
+OPENAI_API_KEY= # openai api key
+REDIS_CONNECTION_STRING= # redis connection string

package/templates/{thegeneralstore → hackathon-store}/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "thegeneralstore",
+  "name": "hackathon-store",
   "private": true,
   "type": "module",
   "scripts": {
@@ -14,10 +14,6 @@
     "axios": "^1.7.7",
     "lowdb": "^7.0.1"
   },
-  "devDependencies": {
-    "@types/node": "^20.14.2",
-    "typescript": "^5.4.5"
-  },
   "engines": {
     "node": ">=20"
   }

package/templates/hackathon-store/src/index.ts

@@ -0,0 +1,47 @@
+import {
+  agentReply,
+  XMTPContext,
+  replaceVariables,
+  run,
+} from "@xmtp/message-kit";
+import { downloadPage } from "./plugins/notion.js";
+import fs from "fs";
+import { Agent } from "@xmtp/message-kit";
+setupFiles();
+
+const agent: Agent = {
+  name: "Hackathon Store",
+  tag: "@store",
+  description: "Hackathon Store",
+  skills: [],
+  onMessage: async (context: XMTPContext) => {
+    const {
+      message: {
+        sender,
+        content: { skill },
+      },
+      agent,
+    } = context;
+
+    if (skill === "update") {
+      const page = await downloadPage();
+      fs.writeFileSync("src/prompt.md", page);
+      await context.reply("Notion DB updated");
+    }
+
+    let systemPrompt = await getPrompt();
+    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
+    await agentReply(context, prompt);
+  },
+};
+
+run(agent);
+
+async function getPrompt() {
+  return fs.readFileSync("src/prompt.md", "utf8");
+}
+async function setupFiles() {
+  const page = await downloadPage();
+  fs.writeFileSync("src/prompt.md", page);
+  console.log("Notion DB updated");
+}

package/templates/{thegeneralstore → hackathon-store}/src/plugins/notion.ts

@@ -58,32 +58,3 @@ export async function downloadPage() {
     .join("\n");
   return markdown;
 }
-export async function downloadPoapTable() {
-  const response = await notion.databases.query({
-    database_id: poapsID as string,
-  });
-
-  const poapTable = response.results.map((page: any) => {
-    const url = page.properties.Url.url;
-    const address = page.properties.Address.title[0]?.plain_text;
-    const id = page.id;
-    return { url, address, id };
-  });
-  return poapTable as { url: string; address: string; id: string }[];
-}
-export async function updatePoapAddress(dbRowId: string, address: string) {
-  await notion.pages.update({
-    page_id: dbRowId as string,
-    properties: {
-      Address: {
-        type: "title",
-        title: [
-          {
-            type: "text",
-            text: { content: address },
-          },
-        ],
-      },
-    },
-  });
-}

package/templates/hackathon-store/src/prompt.md

@@ -0,0 +1,27 @@
+You are a helpful agent that lives inside a messaging app. You manage the general store from XMTP that delivers goodies, POAPs and testnet funds.
+
+{rules}
+
+{user_context}
+
+{skills}
+
+### Goodies
+- When greeted for the first time, give the full menu.
+- The user can select the option by number or name
+- Once the option is selected confirm the order
+## Response Scenarios:
+- Welcome message:
+Welcome to The General Store powered by ENS + XMTP, where web3 builders can get supplies, anytime, day or night.
+Below is our menu. Let us know the number of the item you want, and it's yours. If it's a digital good, our bot will deliver those items right to your wallet.
+- Chewing Gum
+- TicTacs
+- Deodorant
+- RedBull
+- Toothbrush
+- Toothpaste
+- XMTP Swag
+- Testnet funds
+- POAP
+- Delivering goodies
+Let me get your TicTacs... Your order is confirmed. Enjoy!

package/templates/playground/src/index.ts

@@ -15,11 +15,8 @@ export const agent: Agent = {
   name: "Playground Agent",
   tag: "@bot",
   description: "A playground agent with a lot of skills.",
-  skills: [...web, ...cryptoPrice, ...search],
-};
-
-run(
-  async (context: XMTPContext) => {
+  skills: [web, cryptoPrice, search],
+  onMessage: async (context: XMTPContext) => {
     const {
       message: {
         sender,
@@ -29,9 +26,13 @@ run(
     } = context;
 
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    //This is only used for to update the docs.
+    // This is only used for to update the docs.
     fs.writeFileSync("example_prompt.md", prompt);
     await agentReply(context, prompt);
   },
-  { agent, experimental: true },
-);
+  config: {
+    experimental: true,
+  },
+};
+
+run(agent);

package/templates/playground/src/vibes/chill.ts

@@ -0,0 +1,9 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const chill: Vibe = {
+  name: "Chill",
+  description:
+    "A relaxed and easy-going personality, embodying the essence of tranquility and serenity. This vibe exudes a sense of calmness that soothes the soul and invites a peaceful atmosphere.",
+  tone: "calm and composed, like a gentle breeze on a warm summer day",
+  style: "laid-back, with an effortless grace that flows like a serene river",
+};

package/templates/playground/src/vibes/friendly.ts

@@ -0,0 +1,9 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const friendly: Vibe = {
+  name: "Friendly",
+  description:
+    "A warm and welcoming personality, radiating kindness and empathy. This vibe is like a comforting embrace, making everyone feel at home and valued.",
+  tone: "cheerful and uplifting, like the first rays of sunshine after a storm",
+  style: "approachable and open-hearted, with a smile that lights up the room",
+};

package/templates/playground/src/vibes/inquisitive.ts

@@ -0,0 +1,10 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const inquisitive: Vibe = {
+  name: "Inquisitive",
+  description:
+    "A curious and questioning nature, driven by an insatiable thirst for knowledge. This vibe is like a detective on a quest for truth, always seeking to uncover the mysteries of the world.",
+  tone: "curious and probing, like a cat exploring a new territory",
+  style:
+    "engaging and thought-provoking, with a knack for sparking lively discussions",
+};

package/templates/playground/src/vibes/playful.ts

@@ -0,0 +1,10 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const playful: Vibe = {
+  name: "Playful",
+  description:
+    "A fun and light-hearted character, full of whimsy and joy. This vibe is like a child at play, bringing laughter and spontaneity to every moment.",
+  tone: "jovial and exuberant, like a carnival in full swing",
+  style:
+    "casual and carefree, with a dash of mischief and a twinkle in the eye",
+};

package/templates/playground/src/vibes/professional.ts

@@ -0,0 +1,9 @@
+import { Vibe } from "@xmtp/message-kit";
+
+export const professional: Vibe = {
+  name: "Professional",
+  description:
+    "A formal and business-like demeanor, exuding confidence and competence. This vibe is like a seasoned diplomat, navigating complex situations with poise and precision.",
+  tone: "serious and authoritative, like a judge delivering a verdict",
+  style: "polished and refined, with an air of sophistication and elegance",
+};

package/templates/simple/src/index.ts

@@ -5,7 +5,6 @@ import {
   XMTPContext,
   Agent,
 } from "@xmtp/message-kit";
-
 import { systemPrompt } from "./prompt.js";
 
 export const agent: Agent = {
@@ -13,13 +12,15 @@ export const agent: Agent = {
   tag: "@bot",
   description: "Use GPT to generate text responses.",
   skills: [],
-};
+  onMessage: async (context: XMTPContext) => {
+    const {
+      message: { sender },
+      agent,
+    } = context;
 
-run(async (context: XMTPContext) => {
-  const {
-    message: { sender },
-  } = context;
+    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
+    await agentReply(context, prompt);
+  },
+};
 
-  let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-  await agentReply(context, prompt);
-});
+run(agent);

package/templates/toss/.env.example

@@ -2,5 +2,6 @@ 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_APP_ID= # the app id for Coinbase
 COINBASE_API_KEY_NAME= # the API key name for Coinbase
 COINBASE_API_KEY_PRIVATE_KEY= # the private key for Coinbase

package/templates/toss/src/index.ts

@@ -8,25 +8,22 @@ import {
 
 import { systemPrompt } from "./prompt.js";
 import { toss } from "./skills/toss.js";
-import fs from "fs";
+import { waas } from "./skills/waas.js";
 
 export const agent: Agent = {
   name: "Toss Bot",
   tag: "@toss",
   description: "Create a coin toss.",
-  skills: [...toss],
-};
-
-run(
-  async (context: XMTPContext) => {
+  skills: [toss, waas],
+  onMessage: 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 },
-);
+};
+
+run(agent);

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

@@ -22,52 +22,12 @@ export const toss: Skill[] = [
       },
     },
   },
-  {
-    skill: "create",
-    description: "Create an agent wallet.",
-    handler: handleDM,
-    examples: ["/create"],
-  },
-  {
-    skill: "fund",
-    description: "Fund your account.",
-    handler: handleDM,
-    examples: ["/fund 10"],
-    params: {
-      amount: {
-        type: "number",
-      },
-    },
-  },
-  {
-    skill: "withdraw",
-    description: "Withdraw funds from your account.",
-    handler: handleDM,
-    examples: ["/withdraw 10"],
-    params: {
-      amount: {
-        type: "number",
-      },
-    },
-  },
-  {
-    skill: "help",
-    description: "Get help with tossing.",
-    handler: handleDM,
-    examples: ["/help"],
-  },
   {
     skill: "cancel",
     description: "Cancel a toss.",
     handler: handleCancelToss,
     examples: ["/cancel"],
   },
-  {
-    skill: "balance",
-    description: "Check your balance.",
-    handler: handleDM,
-    examples: ["/balance"],
-  },
   {
     skill: "join",
     description: "Join a toss.",
@@ -356,77 +316,3 @@ export async function handleTossStatus(context: XMTPContext) {
   if (!tossData) return;
   await context.reply(await generateTossStatusMessage(tossData));
 }
-
-export async function handleDM(context: XMTPContext) {
-  const {
-    message: {
-      content: {
-        skill,
-        params: { amount },
-      },
-      sender,
-    },
-    group,
-    walletService,
-  } = context;
-  if (group && skill == "help") {
-    await context.reply("Check your DM's");
-    await context.sendTo(DM_HELP_MESSAGE, [sender.address]);
-    return;
-  }
-  if (skill === "help") {
-    await context.send(DM_HELP_MESSAGE);
-  } else if (skill === "create") {
-    const walletExist = await walletService.getWallet(sender.address);
-    if (walletExist) {
-      await context.reply("You already have an agent wallet.");
-      return;
-    }
-    await walletService.createWallet(sender.address);
-  } else if (skill === "balance") {
-    const userWallet = await walletService.getWallet(sender.address);
-
-    context.sendTo(
-      `Your agent wallet for address is ${sender.address}\nBalance: $${await walletService.checkBalance(sender.address)}`,
-      [sender.address],
-    );
-  } else if (skill === "fund") {
-    const balance = await walletService.checkBalance(sender.address);
-    if (balance === 10) {
-      await context.reply("You have maxed out your funds.");
-      return;
-    } else if (amount) {
-      if (amount + balance <= 10) {
-        return walletService.requestFunds(Number(amount));
-      } else {
-        await context.send("Wrong amount. Max 10 USDC.");
-        return;
-      }
-    }
-    await context.reply(
-      `You have $${balance} in your account. You can fund up to $${10 - balance} more.`,
-    );
-    const options = Array.from({ length: Math.floor(10 - balance) }, (_, i) =>
-      (i + 1).toString(),
-    );
-    const response = await context.awaitResponse(
-      `Please specify the amount of USDC to prefund (1 to ${10 - balance}):`,
-      options,
-    );
-    return walletService.requestFunds(Number(response));
-  } else if (skill === "withdraw") {
-    const balance = await walletService.checkBalance(sender.address);
-    if (balance === 0) {
-      await context.reply("You have no funds to withdraw.");
-      return;
-    }
-    const options = Array.from({ length: Math.floor(balance) }, (_, i) =>
-      (i + 1).toString(),
-    );
-    const response = await context.awaitResponse(
-      `Please specify the amount of USDC to withdraw (1 to ${balance}):`,
-      options,
-    );
-    await walletService.withdrawFunds(Number(response));
-  }
-}