create-message-kit 1.2.11 → 1.2.13

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.11";
+const defVersion = "1.2.13";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -96,9 +96,14 @@ async function updatePackagejson(destDir, templateType) {
 
 async function gatherProjectInfo() {
   const templateOptions = [
-    { value: "gpt", label: "Simple Gpt" },
-    { value: "agent", label: "ENS Agent" },
-    { value: "experimental", label: "Experimental" },
+    {
+      value: "simple",
+      label: "Simple Agent: A starter template for building an agent",
+    },
+    {
+      value: "ens",
+      label: "ENS Agent: An example of an agent using ENS skills",
+    },
   ];
 
   const templateType = await select({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.2.11",
+  "version": "1.2.13",
   "license": "MIT",
   "type": "module",
   "main": "index.js",

package/templates/{agent → ens}/.cursorrules

@@ -12,7 +12,7 @@ import type { Skill } from "@xmtp/message-kit";
 // Define Skill
 export const checkDomain: Skill[] = [
   {
-    skill: "/check [domain]",
+    skill: "check",
     handler: handler,
     examples: ["/check vitalik.eth", "/check fabri.base.eth"],
     description: "Check if a domain is available.",
@@ -61,7 +61,7 @@ import type { Skill } from "@xmtp/message-kit";
 // Define Skill
 export const paymentRequest: Skill[] = [
   {
-    skill: "/pay [amount] [token] [username] [address]",
+    skill: "pay",
     examples: [
       "/pay 10 vitalik.eth",
       "/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03",
@@ -115,7 +115,7 @@ export async function handler(context: XMTPContext) {
 
 ## Types
 
-import { XMTPContext } from "../lib/xmtp.js";
+import { XMTPContext } from "../plugins/xmtp.js";
 import { ClientOptions, GroupMember } from "@xmtp/node-sdk";
 import { ContentTypeId } from "@xmtp/content-type-primitives";
 
@@ -223,3 +223,68 @@ export interface AbstractedMember {
 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/{agent → ens}/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "agent",
+  "name": "ens-agent",
   "private": true,
   "type": "module",
   "scripts": {

package/templates/{agent → ens}/src/prompt.ts

@@ -1,5 +1,5 @@
 export const systemPrompt = `
-Your are helpful and playful ens agent called {agent_name} that lives inside a messaging app called Converse.
+Your are a helpful and playful ens agent called {agent_name} that lives inside a messaging app called Converse.
 
 {rules}
 

package/templates/{agent → ens}/src/skills/check.ts

@@ -6,7 +6,7 @@ const ensUrl = "https://app.ens.domains/";
 // [!region define]
 export const checkDomain: Skill[] = [
   {
-    skill: "/check [domain]",
+    skill: "check",
     handler: handler,
     examples: ["/check vitalik.eth", "/check fabri.base.eth"],
     description: "Check if a domain is available.",

package/templates/{agent → ens}/src/skills/cool.ts

@@ -4,7 +4,7 @@ import type { Skill } from "@xmtp/message-kit";
 
 export const cool: Skill[] = [
   {
-    skill: "/cool [domain]",
+    skill: "cool",
     examples: ["/cool vitalik.eth"],
     handler: handler,
     description: "Get cool alternatives for a .eth domain.",

package/templates/{agent → ens}/src/skills/info.ts

@@ -4,7 +4,7 @@ import type { Skill } from "@xmtp/message-kit";
 
 export const info: Skill[] = [
   {
-    skill: "/info [domain]",
+    skill: "info",
     handler: handler,
     description:
       "Get detailed information about an ENS domain including owner, expiry date, and resolver.",

package/templates/{agent → ens}/src/skills/pay.ts

@@ -3,7 +3,7 @@ import type { Skill } from "@xmtp/message-kit";
 
 export const pay: Skill[] = [
   {
-    skill: "/pay [amount] [token] [username] [address]",
+    skill: "pay",
     examples: [
       "/pay 10 vitalik.eth",
       "/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03",

package/templates/{agent → ens}/src/skills/register.ts

@@ -5,7 +5,7 @@ import type { Skill } from "@xmtp/message-kit";
 
 export const register: Skill[] = [
   {
-    skill: "/register [domain]",
+    skill: "register",
     handler: handler,
     description:
       "Register a new ENS domain. Returns a URL to complete the registration process.",

package/templates/{agent → ens}/src/skills/renew.ts

@@ -6,7 +6,7 @@ const frameUrl = "https://ens.steer.fun/";
 
 export const renew: Skill[] = [
   {
-    skill: "/renew [domain]",
+    skill: "renew",
     handler: handler,
     description:
       "Extend the registration period of your ENS domain. Returns a URL to complete the renewal.",

package/templates/{agent → ens}/src/skills/reset.ts

@@ -5,11 +5,10 @@ import type { Skill } from "@xmtp/message-kit";
 
 export const reset: Skill[] = [
   {
-    skill: "/reset",
+    skill: "reset",
     examples: ["/reset"],
     handler: handler,
     description: "Reset the conversation clearing memory and usernames cache.",
-    params: {},
   },
 ];
 export async function handler(context: XMTPContext) {

package/templates/{experimental → simple}/.cursorrules

@@ -12,7 +12,7 @@ import type { Skill } from "@xmtp/message-kit";
 // Define Skill
 export const checkDomain: Skill[] = [
   {
-    skill: "/check [domain]",
+    skill: "check",
     handler: handler,
     examples: ["/check vitalik.eth", "/check fabri.base.eth"],
     description: "Check if a domain is available.",
@@ -61,7 +61,7 @@ import type { Skill } from "@xmtp/message-kit";
 // Define Skill
 export const paymentRequest: Skill[] = [
   {
-    skill: "/pay [amount] [token] [username] [address]",
+    skill: "pay",
     examples: [
       "/pay 10 vitalik.eth",
       "/pay 1 usdc to 0xC60E6Bb79322392761BFe3081E302aEB79B30B03",
@@ -115,7 +115,7 @@ export async function handler(context: XMTPContext) {
 
 ## Types
 
-import { XMTPContext } from "../lib/xmtp.js";
+import { XMTPContext } from "../plugins/xmtp.js";
 import { ClientOptions, GroupMember } from "@xmtp/node-sdk";
 import { ContentTypeId } from "@xmtp/content-type-primitives";
 
@@ -223,3 +223,68 @@ export interface AbstractedMember {
 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/{gpt → simple}/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "gpt",
+  "name": "simple-agent",
   "private": true,
   "type": "module",
   "scripts": {

package/templates/experimental/.env.example

@@ -1,6 +0,0 @@
-OPENAI_API_KEY= # the API key for OpenAI
-TEST_ENCRYPTION_KEY= # the encryption key for the test wallet
-KEY= # the private key of the wallet
-RESEND_API_KEY= # the API key for Resend
-FRAMEDL_API_KEY= # the API key for Framedl
-ALCHEMY_SDK= # the API key for Alchemy

package/templates/experimental/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "experimental",
-  "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": {
-    "@xmtp/message-kit": "workspace:*",
-    "alchemy-sdk": "^3.0.0",
-    "ethers": "^6.0.0",
-    "express": "^4.19.2",
-    "node-fetch": "^3.3.2",
-    "resend": "^4.0.1"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.20",
-    "@types/node": "^20.14.2",
-    "typescript": "^5.4.5"
-  },
-  "engines": {
-    "node": ">=20"
-  }
-}

package/templates/experimental/src/index.ts

@@ -1,52 +0,0 @@
-import {
-  run,
-  agentReply,
-  replaceVariables,
-  XMTPContext,
-  Agent,
-  xmtpClient,
-} from "@xmtp/message-kit";
-import fs from "fs";
-import { systemPrompt } from "./prompt.js";
-import { token } from "./skills/token.js";
-import { todo } from "./skills/todo.js";
-import { gated, startGatedGroupServer } from "./skills/gated.js";
-import { broadcast } from "./skills/broadcast.js";
-import { wordle } from "./skills/wordle.js";
-
-export const agent: Agent = {
-  name: "Experimental Agent",
-  tag: "@bot",
-  description: "An experimental agent with a lot of skills.",
-  skills: [
-    ...token,
-    ...(process?.env?.RESEND_API_KEY ? todo : []),
-    ...(process?.env?.ALCHEMY_SDK ? gated : []),
-    ...broadcast,
-    ...wordle,
-  ],
-};
-
-// [!region gated]
-const { client } = await xmtpClient({
-  hideInitLogMessage: true,
-});
-
-startGatedGroupServer(client);
-// [!endregion gated]
-
-run(
-  async (context: XMTPContext) => {
-    const {
-      message: { sender },
-      agent,
-    } = 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, experimental: true },
-);

package/templates/experimental/src/lib/alchemy.ts

@@ -1,31 +0,0 @@
-import { Alchemy, Network } from "alchemy-sdk";
-
-const settings = {
-  apiKey: process.env.ALCHEMY_API_KEY, // Replace with your Alchemy API key
-  network: Network.BASE_MAINNET, // Use the appropriate network
-};
-
-export async function checkNft(
-  walletAddress: string,
-  collectionSlug: string,
-): Promise<boolean> {
-  const alchemy = new Alchemy(settings);
-  try {
-    const nfts = await alchemy.nft.getNftsForOwner(walletAddress);
-
-    const ownsNft = nfts.ownedNfts.some(
-      (nft: any) =>
-        nft.contract.name.toLowerCase() === collectionSlug.toLowerCase(),
-    );
-    // console.log(
-    //   `NFTs owned on ${Network.BASE_MAINNET}:`,
-    //   nfts.ownedNfts.length,
-    // );
-    console.log("is the nft owned: ", ownsNft);
-    return ownsNft as boolean;
-  } catch (error) {
-    console.error("Error fetching NFTs from Alchemy:", error);
-  }
-
-  return false;
-}

package/templates/experimental/src/lib/minilog.ts

@@ -1,26 +0,0 @@
-import fetch from "node-fetch";
-
-export async function sendLog(title: string, description: string) {
-  const response = await fetch("https://api.minilog.dev/v1/logs/testlog", {
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json",
-      Authorization: "Bearer pthsm38sccpux5acriqish7isz5inet7q73ef7br",
-    },
-    body: JSON.stringify({
-      application: "myapp-1",
-      severity: "DEBUG",
-      data: title,
-      metadata: {
-        title,
-        description,
-      },
-    }),
-  });
-  console.log(response);
-  if (!response.ok) {
-    console.error("Failed to send log:", response.statusText);
-  } else {
-    console.log("Log sent successfully");
-  }
-}

package/templates/experimental/src/lib/usdc.ts

@@ -1,99 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { generatePrivateKey } from "viem/accounts";
-import { ethers } from "ethers";
-
-// Define the Base network RPC URL
-const baseRpcUrl = "https://mainnet.base.org";
-
-// Create a provider
-const provider = new ethers.JsonRpcProvider(baseRpcUrl);
-
-// USDC contract address on Base (replace with actual address)
-const usdcAddress = "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913"; // Replace with the correct USDC contract address
-
-// ERC-20 ABI (balanceOf and transfer functions)
-const erc20Abi = [
-  "function balanceOf(address owner) view returns (uint256)",
-  "function transfer(address to, uint256 amount) returns (bool)",
-];
-
-export class USDCWallet {
-  walletDir: string;
-  senderAddress: string;
-  privateKey: string;
-  agentAddress: string;
-  usdcContract: ethers.Contract;
-  wallet: ethers.Wallet;
-
-  constructor(senderAddress: string) {
-    this.senderAddress = senderAddress;
-    this.walletDir = path.join(process.cwd(), `./.data/usdcwallets`);
-    if (!fs.existsSync(this.walletDir)) {
-      fs.mkdirSync(this.walletDir, { recursive: true });
-      console.warn("USDC wallet created and saved successfully.");
-    }
-
-    const walletFilePath = path.join(this.walletDir, `${senderAddress}.usdc`);
-
-    if (fs.existsSync(walletFilePath)) {
-      const walletData = fs.readFileSync(walletFilePath, "utf8");
-      this.privateKey = walletData.match(/KEY=(.+)/)?.[1]?.trim() ?? "";
-    } else {
-      this.privateKey = generatePrivateKey();
-      let usdcWallet = new ethers.Wallet(this.privateKey, provider);
-      const walletData = `KEY=${this.privateKey}\nADDRESS=${usdcWallet.address}`;
-      fs.writeFileSync(walletFilePath, walletData);
-    }
-
-    // Initialize wallet and USDC contract
-    this.wallet = new ethers.Wallet(this.privateKey, provider);
-    this.agentAddress = this.wallet.address;
-    this.usdcContract = new ethers.Contract(usdcAddress, erc20Abi, this.wallet);
-  }
-
-  async checkBalances(): Promise<{ usdc: number; eth: number }> {
-    try {
-      // Check USDC balance
-      console.log(this.agentAddress);
-      const usdcBalance = await this.usdcContract.balanceOf(this.agentAddress);
-      const formattedUsdcBalance = ethers.formatUnits(usdcBalance, 6); // USDC has 6 decimals
-      console.warn(`USDC Balance: ${formattedUsdcBalance}`);
-
-      // Check ETH balance
-      const ethBalance = await provider.getBalance(this.agentAddress);
-      const formattedEthBalance = ethers.formatUnits(ethBalance, 18);
-      console.warn(`ETH Balance: ${formattedEthBalance}`);
-
-      return {
-        usdc: parseFloat(formattedUsdcBalance),
-        eth: parseFloat(formattedEthBalance),
-      };
-    } catch (error) {
-      console.error("Error fetching balances:", error);
-      return { usdc: 0, eth: 0 };
-    }
-  }
-  async transferUsdc(to: string, amount: number) {
-    if (!ethers.isAddress(to)) {
-      throw new Error("Invalid recipient address");
-    } else if (typeof amount !== "number" || amount <= 0) {
-      throw new Error("Invalid transfer amount");
-    }
-    try {
-      const amountInWei = ethers.parseUnits(amount.toString(), 6); // USDC has 6 decimals
-      const adminAgent = new USDCWallet(to);
-      const tx = await this.usdcContract.transfer(
-        adminAgent.agentAddress,
-        amountInWei,
-      );
-      const receipt = await tx.wait();
-      if (receipt.status !== 1) {
-        throw new Error("Transaction failed or was reverted");
-      }
-    } catch (error) {
-      console.warn(`Transferred ${amount} USDC to ${to}.`);
-      throw error;
-    }
-  }
-}