create-message-kit 1.2.32 → 1.2.35

package/index.js

@@ -7,7 +7,6 @@ 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.32";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -26,13 +25,7 @@ program
       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 = `
 ███╗   ███╗███████╗███████╗███████╗ █████╗  ██████╗ ███████╗██╗  ██╗██╗████████╗
 ████╗ ████║██╔════╝██╔════╝██╔════╝██╔══██╗██╔════╝ ██╔════╝██║ ██╔╝██║╚══██╔══╝

package/package.json

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

package/templates/ens/.cursorrules

@@ -1,209 +0,0 @@
-# MessageKit
-
-# Skill Examples
-
-### Check if a Domain is Available
-
-
-import { ensUrl } from "../index.js";
-import { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { domain },
-      },
-    },
-  } = context;
-
-  const data = await 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 { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { amount, token, username, address },
-      },
-    },
-  } = context;
-  let receiverAddress = address;
-  if (username) {
-    receiverAddress = (await getUserInfo(username))?.address;
-  }
-  if (address) {
-    // Prioritize address over username
-    receiverAddress = address;
-  }
-
-  await context.framekit.requestPayment(receiverAddress, amount, token);
-}
-
-
-# Docs
-
-# Structure
-
-## File structure
-
-Each app consists of the following files:
-
-```
-agent/
-├── src/
-│   └── index.ts
-│   └── prompt.ts # Optional
-│   └── plugins/ # Optional
-│       └── ...
-│   └── skills/ # Optional
-│       └── ...
-│   └── vibes/ # Optional
-│       └── ...
-├── tsconfig.json
-├── package.json
-└── .env
-```
-
-## Agent
-
-This is the main function that runs the listener.
-
-```jsx
-import { Agent, run, Context } from "@xmtp/message-kit";
-
-const agent: Agent = {
-  name: "Agent Name",
-  tag: "@bot",
-  description: "Agent Description",
-  skills: [skill1, skill2],
-  onMessage: async (context: Context) => {
-        /* Logs every message in a conversation.
-        If not declared, the agent will automatically use the defined skills.
-        Alternatively, you can implement your own logic here. */
-    },
-  config: {
-    // Optional parameters
-  },
-};
-//starts the agent
-run(agent);
-```
-
-#### Config parameters
-
-- `privateKey`: the private key of the agent wallet, like any normal wallet private key.
-- `experimental`: experimental features like logging all group messages. Default is `false`.
-- `attachments`: to receive attachments. Default is `false`.
-- `gptModel`: model to be used. Default is `gpt-4o`.
-- `client`: Optional parameters to pass to the XMTP client.
-- `agent`: Custom agent to be used. Default is to create the skills in the `src/skills.ts` file.
-- `hideInitLogMessage`: hide the init log message with messagekit logo and stuff
-- `memberChange`: if true, member changes will be enabled, like adding members to the group
-
-## Skills
-
-Skills are the actions of the agent. They are defined in the `src/skills/your-skill.ts` file.
-
-```tsx
-import { Skill } from "@xmtp/message-kit";
-
-export const checkDomain: Skill[] = [
-  {
-    skill: // name of the skill
-    handler: // function to handle the skill
-    examples: // examples of the skill
-    description: // description of the skill
-    params: // params of the skill
-  },
-];
-```
-
-## Vibes
-
-Vibes are the personalities of the agent. They are defined in the `src/vibes/your-vibe.ts` file.
-
-```tsx
-import { Vibe } from "@xmtp/message-kit";
-
-export const chill: Vibe = {
-  vibe: // name of the vibe
-  description: // description of the vibe
-  tone: // tone of the vibe
-  style: // style of the vibe
-};
-```
-
-> See [Vibes](/community/vibes) for more information.

package/templates/ens/src/index.ts

@@ -1,4 +1,4 @@
-import { run, Agent } from "@xmtp/message-kit";
+import { createAgent } from "@xmtp/message-kit";
 import { checkDomain } from "./skills/check.js";
 import { cool } from "./skills/cool.js";
 import { info } from "./skills/info.js";
@@ -6,11 +6,9 @@ import { register } from "./skills/register.js";
 import { renew } from "./skills/renew.js";
 import { pay } from "./skills/pay.js";
 
-export const agent: Agent = {
+export const agent = createAgent({
   name: "Ens Agent",
   tag: "@bot",
   description: "A ens agent with a lot of skills.",
   skills: [checkDomain, cool, info, register, renew, pay],
-};
-
-run(agent);
+}).run();

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

@@ -1,4 +1,4 @@
-import { Context, getUserInfo, Skill } from "@xmtp/message-kit";
+import { Context, FrameKit, getUserInfo, Skill } from "@xmtp/message-kit";
 
 export const pay: Skill[] = [
   {
@@ -24,10 +24,6 @@ export const pay: Skill[] = [
         default: "",
         type: "username",
       },
-      address: {
-        default: "",
-        type: "address",
-      },
     },
   },
   {
@@ -48,22 +44,17 @@ export async function handler(context: Context) {
     message: {
       content: {
         skill,
-        params: { amount, token, username, address },
+        params: { amount, token, username },
       },
     },
   } = context;
-  let receiverAddress = address;
-  if (username) {
-    receiverAddress = (await getUserInfo(username))?.address;
-  }
-  if (address) {
-    //Prioritize address over username
-    receiverAddress = address;
-  }
+  let receiverAddress = username?.address;
   if (skill === "tip") {
     let tipAmount = 1;
-    await context.framekit.requestPayment(receiverAddress, tipAmount);
+    const url = await FrameKit.requestPayment(receiverAddress, tipAmount);
+    await context.dm(url);
   } else if (skill === "pay") {
-    await context.framekit.requestPayment(receiverAddress, amount, token);
+    const url = await FrameKit.requestPayment(receiverAddress, amount, token);
+    await context.dm(url);
   }
 }

package/templates/paymentagent/.cursorrules

@@ -1,209 +0,0 @@
-# MessageKit
-
-# Skill Examples
-
-### Check if a Domain is Available
-
-
-import { ensUrl } from "../index.js";
-import { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { domain },
-      },
-    },
-  } = context;
-
-  const data = await 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 { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { amount, token, username, address },
-      },
-    },
-  } = context;
-  let receiverAddress = address;
-  if (username) {
-    receiverAddress = (await getUserInfo(username))?.address;
-  }
-  if (address) {
-    // Prioritize address over username
-    receiverAddress = address;
-  }
-
-  await context.framekit.requestPayment(receiverAddress, amount, token);
-}
-
-
-# Docs
-
-# Structure
-
-## File structure
-
-Each app consists of the following files:
-
-```
-agent/
-├── src/
-│   └── index.ts
-│   └── prompt.ts # Optional
-│   └── plugins/ # Optional
-│       └── ...
-│   └── skills/ # Optional
-│       └── ...
-│   └── vibes/ # Optional
-│       └── ...
-├── tsconfig.json
-├── package.json
-└── .env
-```
-
-## Agent
-
-This is the main function that runs the listener.
-
-```jsx
-import { Agent, run, Context } from "@xmtp/message-kit";
-
-const agent: Agent = {
-  name: "Agent Name",
-  tag: "@bot",
-  description: "Agent Description",
-  skills: [skill1, skill2],
-  onMessage: async (context: Context) => {
-        /* Logs every message in a conversation.
-        If not declared, the agent will automatically use the defined skills.
-        Alternatively, you can implement your own logic here. */
-    },
-  config: {
-    // Optional parameters
-  },
-};
-//starts the agent
-run(agent);
-```
-
-#### Config parameters
-
-- `privateKey`: the private key of the agent wallet, like any normal wallet private key.
-- `experimental`: experimental features like logging all group messages. Default is `false`.
-- `attachments`: to receive attachments. Default is `false`.
-- `gptModel`: model to be used. Default is `gpt-4o`.
-- `client`: Optional parameters to pass to the XMTP client.
-- `agent`: Custom agent to be used. Default is to create the skills in the `src/skills.ts` file.
-- `hideInitLogMessage`: hide the init log message with messagekit logo and stuff
-- `memberChange`: if true, member changes will be enabled, like adding members to the group
-
-## Skills
-
-Skills are the actions of the agent. They are defined in the `src/skills/your-skill.ts` file.
-
-```tsx
-import { Skill } from "@xmtp/message-kit";
-
-export const checkDomain: Skill[] = [
-  {
-    skill: // name of the skill
-    handler: // function to handle the skill
-    examples: // examples of the skill
-    description: // description of the skill
-    params: // params of the skill
-  },
-];
-```
-
-## Vibes
-
-Vibes are the personalities of the agent. They are defined in the `src/vibes/your-vibe.ts` file.
-
-```tsx
-import { Vibe } from "@xmtp/message-kit";
-
-export const chill: Vibe = {
-  vibe: // name of the vibe
-  description: // description of the vibe
-  tone: // tone of the vibe
-  style: // style of the vibe
-};
-```
-
-> See [Vibes](/community/vibes) for more information.

package/templates/paymentagent/src/index.ts

@@ -1,7 +1,7 @@
-import { run, Agent, concierge } from "@xmtp/message-kit";
+import { concierge, createAgent } from "@xmtp/message-kit";
 import { degen } from "./vibes/degen.js";
 
-const agent: Agent = {
+export const agent = createAgent({
   name: "Human Agent",
   tag: "@bot",
   description: "An agent that performs payments and transfers in usdc. .",
@@ -12,6 +12,4 @@ const agent: Agent = {
   config: {
     walletService: true,
   },
-};
-
-run(agent);
+}).run();

package/templates/simple/.cursorrules

@@ -1,209 +0,0 @@
-# MessageKit
-
-# Skill Examples
-
-### Check if a Domain is Available
-
-
-import { ensUrl } from "../index.js";
-import { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { domain },
-      },
-    },
-  } = context;
-
-  const data = await 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 { Context } 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: Context) {
-  const {
-    message: {
-      content: {
-        params: { amount, token, username, address },
-      },
-    },
-  } = context;
-  let receiverAddress = address;
-  if (username) {
-    receiverAddress = (await getUserInfo(username))?.address;
-  }
-  if (address) {
-    // Prioritize address over username
-    receiverAddress = address;
-  }
-
-  await context.framekit.requestPayment(receiverAddress, amount, token);
-}
-
-
-# Docs
-
-# Structure
-
-## File structure
-
-Each app consists of the following files:
-
-```
-agent/
-├── src/
-│   └── index.ts
-│   └── prompt.ts # Optional
-│   └── plugins/ # Optional
-│       └── ...
-│   └── skills/ # Optional
-│       └── ...
-│   └── vibes/ # Optional
-│       └── ...
-├── tsconfig.json
-├── package.json
-└── .env
-```
-
-## Agent
-
-This is the main function that runs the listener.
-
-```jsx
-import { Agent, run, Context } from "@xmtp/message-kit";
-
-const agent: Agent = {
-  name: "Agent Name",
-  tag: "@bot",
-  description: "Agent Description",
-  skills: [skill1, skill2],
-  onMessage: async (context: Context) => {
-        /* Logs every message in a conversation.
-        If not declared, the agent will automatically use the defined skills.
-        Alternatively, you can implement your own logic here. */
-    },
-  config: {
-    // Optional parameters
-  },
-};
-//starts the agent
-run(agent);
-```
-
-#### Config parameters
-
-- `privateKey`: the private key of the agent wallet, like any normal wallet private key.
-- `experimental`: experimental features like logging all group messages. Default is `false`.
-- `attachments`: to receive attachments. Default is `false`.
-- `gptModel`: model to be used. Default is `gpt-4o`.
-- `client`: Optional parameters to pass to the XMTP client.
-- `agent`: Custom agent to be used. Default is to create the skills in the `src/skills.ts` file.
-- `hideInitLogMessage`: hide the init log message with messagekit logo and stuff
-- `memberChange`: if true, member changes will be enabled, like adding members to the group
-
-## Skills
-
-Skills are the actions of the agent. They are defined in the `src/skills/your-skill.ts` file.
-
-```tsx
-import { Skill } from "@xmtp/message-kit";
-
-export const checkDomain: Skill[] = [
-  {
-    skill: // name of the skill
-    handler: // function to handle the skill
-    examples: // examples of the skill
-    description: // description of the skill
-    params: // params of the skill
-  },
-];
-```
-
-## Vibes
-
-Vibes are the personalities of the agent. They are defined in the `src/vibes/your-vibe.ts` file.
-
-```tsx
-import { Vibe } from "@xmtp/message-kit";
-
-export const chill: Vibe = {
-  vibe: // name of the vibe
-  description: // description of the vibe
-  tone: // tone of the vibe
-  style: // style of the vibe
-};
-```
-
-> See [Vibes](/community/vibes) for more information.

package/templates/simple/src/index.ts

@@ -1,7 +1,7 @@
 // [!region index]
-import { run, agentReply, Context, Agent } from "@xmtp/message-kit";
+import { agentReply, Context, createAgent } from "@xmtp/message-kit";
 
-export const agent: Agent = {
+export const agent = createAgent({
   name: "GPT Bot",
   description: "Use GPT to generate text responses.",
   tag: "@bot",
@@ -10,7 +10,5 @@ export const agent: Agent = {
     await agentReply(context);
     // [!region final]
   },
-};
-
-run(agent);
+}).run();
 // [!endregion final]