create-message-kit 1.2.3 → 1.2.7

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.7";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -19,13 +19,21 @@ program
   .name("message-kit")
   .description("CLI to initialize projects")
   .action(async () => {
-    // Add Yarn 4 check at the start of the action
-    const pkgManager = await detectPackageManager();
-
-    log.info(pc.cyan(`pkgManager detected: ${pkgManager}`));
-
-    log.info(pc.cyan(`Welcome to MessageKit CLI v${version}!`));
-    const coolLogo = `
+    try {
+      // Add Yarn 4 check at the start of the action
+      const pkgManager = await detectPackageManager();
+
+      log.info(pc.cyan(`pkgManager detected: ${pkgManager}`));
+
+      log.info(pc.cyan(`Welcome to MessageKit CLI v${version}!`));
+      if (version !== defVersion) {
+        log.warn(
+          pc.red(
+            "You are using a version of the CLI that is not compatible with the latest MessageKit. Please update to the latest version.",
+          ),
+        );
+      }
+      const coolLogo = `
 ███╗   ███╗███████╗███████╗███████╗ █████╗  ██████╗ ███████╗██╗  ██╗██╗████████╗
 ████╗ ████║██╔════╝██╔════╝██╔════╝██╔══██╗██╔════╝ ██╔════╝██║ ██╔╝██║╚══██╔══╝
 ██╔████╔██║█████╗  ███████╗███████╗███████║██║  ███╗█████╗  █████╔╝ ██║   ██║   
@@ -34,32 +42,37 @@ program
 ╚═╝     ╚═╝╚══════╝╚══════╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝   ╚═╝   
 Powered by XMTP`;
 
-    log.info(pc.red(coolLogo));
+      log.info(pc.red(coolLogo));
 
-    const { templateType, displayName, destDir } = await gatherProjectInfo();
+      const { templateType, displayName, destDir } = await gatherProjectInfo();
 
-    // Create .gitignore
-    createGitignore(destDir);
+      // Create .gitignore
+      createGitignore(destDir);
 
-    // Create .env file
-    createEnvFile(destDir);
+      // Create .env file
+      createEnvFile(destDir);
 
-    // Create tsconfig.json file
-    createTsconfig(destDir);
+      // Create tsconfig.json file
+      createTsconfig(destDir);
 
-    // Wrap up
-    log.success(`Project launched in ${pc.red(destDir)}!`);
+      // Wrap up
+      log.success(`Project launched in ${pc.red(destDir)}!`);
 
-    // Add package.json
-    updatePackagejson(destDir, templateType);
+      // Add package.json
+      updatePackagejson(destDir, templateType);
 
-    // Create README.md file
-    createReadme(destDir, templateType, displayName, pkgManager);
+      // Create README.md file
+      createReadme(destDir, templateType, displayName, pkgManager);
 
-    // Log next steps
-    logNextSteps(displayName);
+      // Log next steps
+      logNextSteps(displayName);
 
-    outro(pc.red("Made with ❤️  by Ephemera"));
+      outro(pc.red("Made with ❤️  by Ephemera"));
+    } catch (error) {
+      log.error(pc.red("An error occurred while creating your project:"));
+      log.error(error.message);
+      process.exit(1);
+    }
   });
 
 program.parse(process.argv);
@@ -83,9 +96,9 @@ async function updatePackagejson(destDir, templateType) {
 
 async function gatherProjectInfo() {
   const templateOptions = [
-    { value: "agent", label: "Web3 Agent" },
     { value: "gpt", label: "Simple Gpt" },
-    { value: "gated", label: "Gated Group" },
+    { value: "agent", label: "ENS Agent" },
+    { value: "experimental", label: "Experimental" },
   ];
 
   const templateType = await select({

package/package.json

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

package/templates/agent/.cursorrules

@@ -0,0 +1,227 @@
+# MessageKit Skill Template
+
+## Examples
+
+### Check if a Domain is Available
+
+```typescript
+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 [domain]",
+    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
+
+```typescript
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+// Define Skill
+export const paymentRequest: Skill[] = [
+  {
+    skill: "/pay [amount] [token] [username] [address]",
+    examples: [
+      "/pay 10 vitalik.eth",
+      "/pay 1 usdc to 0xc9925662D36DE3e1bF0fD64e779B2e5F0Aead964",
+    ],
+    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
+
+```typescript
+import { XMTPContext } from "../lib/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[]>;
+```

package/templates/agent/src/index.ts

@@ -6,37 +6,30 @@ import {
   Agent,
 } from "@xmtp/message-kit";
 import { systemPrompt } from "./prompt.js";
-import { registerSkill as checkSkill } from "./handlers/check.js";
-import { registerSkill as coolSkill } from "./handlers/cool.js";
-import { registerSkill as infoSkill } from "./handlers/info.js";
-import { registerSkill as registerSkill } from "./handlers/register.js";
-import { registerSkill as renewSkill } from "./handlers/renew.js";
-import { registerSkill as paySkill } from "./handlers/pay.js";
-import { registerSkill as resetSkill } from "./handlers/reset.js";
-import { registerSkill as tokenSkill } from "./handlers/token.js";
-import { registerSkill as gameSkill } from "./handlers/game.js";
-import { registerSkill as todoSkill } from "./handlers/todo.js";
+import { checkDomain } from "./skills/check.js";
+import { cool } from "./skills/cool.js";
+import { info } from "./skills/info.js";
+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 { game } from "./skills/game.js";
 import fs from "fs";
 
-export const frameUrl = "https://ens.steer.fun/";
-export const ensUrl = "https://app.ens.domains/";
-
 // [!region skills]
 export const agent: Agent = {
-  name: "Web3 Agent",
+  name: "Ens Agent",
   tag: "@bot",
-  description: "A web3 agent with a lot of skills.",
+  description: "A ens agent with a lot of skills.",
   skills: [
-    ...checkSkill,
-    ...coolSkill,
-    ...infoSkill,
-    ...registerSkill,
-    ...renewSkill,
-    ...resetSkill,
-    ...paySkill,
-    ...tokenSkill,
-    ...gameSkill,
-    ...todoSkill,
+    ...checkDomain,
+    ...cool,
+    ...info,
+    ...register,
+    ...renew,
+    ...reset,
+    ...pay,
+    ...game,
   ],
 };
 // [!endregion skills]
@@ -56,7 +49,7 @@ run(
     // [!region run2]
     await agentReply(context, prompt);
   },
-  { agent},
+  { agent },
 );
 
 // [!endregion run2]

package/templates/agent/src/prompt.ts

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

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

@@ -1,9 +1,10 @@
-import { ensUrl } from "../index.js";
-import { XMTPContext, getUserInfo } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
+const ensUrl = "https://app.ens.domains/";
+
 // [!region define]
-export const registerSkill: Skill[] = [
+export const checkDomain: Skill[] = [
   {
     skill: "/check [domain]",
     handler: handler,
@@ -28,7 +29,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await getUserInfo(domain);
+  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?`;

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

@@ -2,7 +2,7 @@ import { XMTPContext } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+export const cool: Skill[] = [
   {
     skill: "/cool [domain]",
     examples: ["/cool vitalik.eth"],

package/templates/agent/src/{handlers → skills}/game.ts

@@ -1,7 +1,7 @@
 import { XMTPContext } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+export const game: Skill[] = [
   {
     skill: "/game [game]",
     handler: handler,

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

@@ -1,9 +1,8 @@
-import { ensUrl } from "../index.js";
-import { XMTPContext, getUserInfo, isOnXMTP } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+export const info: Skill[] = [
   {
     skill: "/info [domain]",
     handler: handler,
@@ -28,7 +27,7 @@ export async function handler(context: XMTPContext) {
     },
   } = context;
 
-  const data = await getUserInfo(domain);
+  const data = await context.getUserInfo(domain);
   if (!data?.ensDomain) {
     return {
       code: 404,
@@ -49,7 +48,9 @@ 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 isOnXMTP(context.client, context.v2client, sender?.address)) {
+  if (
+    await context.isOnXMTP(context.client, context.v2client, sender?.address)
+  ) {
     await context.send(
       `Ah, this domains is in XMTP, you can message it directly`,
     );

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

@@ -1,10 +1,13 @@
 import { XMTPContext } from "@xmtp/message-kit";
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+export const pay: Skill[] = [
   {
-    skill: "/pay [amount] [token] [username]",
-    examples: ["/pay 10 vitalik.eth"],
+    skill: "/pay [amount] [token] [username] [address]",
+    examples: [
+      "/pay 10 vitalik.eth",
+      "/pay 1 usdc to 0xc9925662D36DE3e1bF0fD64e779B2e5F0Aead964",
+    ],
     description:
       "Send a specified amount of a cryptocurrency to a destination address. \nWhen tipping, you can asume its 1 usdc.",
     handler: handler,
@@ -22,6 +25,10 @@ export const registerSkill: Skill[] = [
         default: "",
         type: "username",
       },
+      address: {
+        default: "",
+        type: "address",
+      },
     },
   },
 ];
@@ -29,10 +36,18 @@ export async function handler(context: XMTPContext) {
   const {
     message: {
       content: {
-        params: { address },
+        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(1, "USDC", address);
+  await context.requestPayment(amount, token, receiverAddress);
 }

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

@@ -1,9 +1,9 @@
-import { ensUrl } from "../index.js";
 import { XMTPContext } from "@xmtp/message-kit";
 
+const ensUrl = "https://app.ens.domains/";
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+export const register: Skill[] = [
   {
     skill: "/register [domain]",
     handler: handler,
@@ -37,4 +37,3 @@ export async function handler(context: XMTPContext) {
   let url_ens = ensUrl + domain;
   return { code: 200, message: `${url_ens}` };
 }
-

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

@@ -1,9 +1,10 @@
-import { frameUrl } from "../index.js";
-import { getUserInfo, XMTPContext } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
 
 import type { Skill } from "@xmtp/message-kit";
 
-export const registerSkill: Skill[] = [
+const frameUrl = "https://ens.steer.fun/";
+
+export const renew: Skill[] = [
   {
     skill: "/renew [domain]",
     handler: handler,
@@ -36,7 +37,7 @@ export async function handler(context: XMTPContext) {
     };
   }
 
-  const data = await getUserInfo(domain);
+  const data = await context.getUserInfo(domain);
 
   if (!data?.address || data?.address !== sender?.address) {
     return {

package/templates/agent/src/skills/reset.ts

@@ -0,0 +1,26 @@
+import { clearInfoCache, clearMemory } from "@xmtp/message-kit";
+import { XMTPContext } from "@xmtp/message-kit";
+
+import type { Skill } from "@xmtp/message-kit";
+
+export const reset: Skill[] = [
+  {
+    skill: "/reset",
+    examples: ["/reset"],
+    handler: handler,
+    description: "Reset the conversation clearing memory and usernames cache.",
+    params: {},
+  },
+];
+export async function handler(context: XMTPContext) {
+  const {
+    message: { sender },
+  } = context;
+  try {
+    clearMemory(sender.address);
+    clearInfoCache(sender.address);
+    return { code: 200, message: "Memory and usernames cache cleared." };
+  } catch (error) {
+    return { code: 500, message: "Error clearing memory and usernames cache." };
+  }
+}