create-message-kit 1.2.23 → 1.2.25

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

@@ -1,47 +0,0 @@
-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/hackathon-store/src/plugins/notion.ts

@@ -1,60 +0,0 @@
-import { Client } from "@notionhq/client";
-
-const notion = new Client({
-  auth: process.env.NOTION_API_KEY,
-});
-const poapsID = process.env.NOTION_POAP_DB;
-const pageId = process.env.NOTION_PAGE_ID;
-
-export async function updateDB() {
-  await notion.pages.update({
-    page_id: pageId as string,
-    properties: {
-      RSVP: {
-        type: "select",
-        select: {
-          name: "No",
-        },
-      },
-    },
-  });
-}
-export async function downloadPage() {
-  const blocks = await notion.blocks.children.list({
-    block_id: pageId as string,
-  });
-  const markdown = blocks.results
-    .map((block: any) => {
-      switch (block.type) {
-        case "paragraph":
-          return block.paragraph.rich_text
-            .map((text: any) => text.plain_text)
-            .join("");
-        case "heading_1":
-          return `# ${block.heading_1.rich_text
-            .map((text: any) => text.plain_text)
-            .join("")}`;
-        case "heading_2":
-          return `## ${block.heading_2.rich_text
-            .map((text: any) => text.plain_text)
-            .join("")}`;
-        case "heading_3":
-          return `### ${block.heading_3.rich_text
-            .map((text: any) => text.plain_text)
-            .join("")}`;
-        case "bulleted_list_item":
-          return `- ${block.bulleted_list_item.rich_text
-            .map((text: any) => text.plain_text)
-            .join("")}`;
-        case "numbered_list_item":
-          return `- ${block.numbered_list_item.rich_text
-            .map((text: any) => text.plain_text)
-            .join("")}`;
-        // Add more cases for other block types as needed
-        default:
-          return "";
-      }
-    })
-    .join("\n");
-  return markdown;
-}

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

@@ -1,27 +0,0 @@
-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/.cursorrules

@@ -1,290 +0,0 @@
-# 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/playground/.env.example

@@ -1,6 +0,0 @@
-OPENAI_API_KEY= # the API key for OpenAI
-TEST_ENCRYPTION_KEY= # a different private key for encryption
-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/playground/.yarnrc.yml

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

package/templates/playground/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "playground",
-  "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/playground/src/index.ts

@@ -1,38 +0,0 @@
-import {
-  run,
-  agentReply,
-  replaceVariables,
-  XMTPContext,
-  Agent,
-  xmtpClient,
-} from "@xmtp/message-kit";
-import fs from "fs";
-import { systemPrompt } from "./prompt.js";
-import { web } from "./skills/web.js";
-import { cryptoPrice } from "./skills/cryptoPrice.js";
-import { search } from "./skills/search.js";
-export const agent: Agent = {
-  name: "Playground Agent",
-  tag: "@bot",
-  description: "A playground agent with a lot of skills.",
-  skills: [web, cryptoPrice, search],
-  onMessage: async (context: XMTPContext) => {
-    const {
-      message: {
-        sender,
-        content: { text },
-      },
-      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);
-  },
-  config: {
-    experimental: true,
-  },
-};
-
-run(agent);

package/templates/playground/src/plugins/alchemy.ts

@@ -1,27 +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("is the nft owned: ", ownsNft);
-    return ownsNft as boolean;
-  } catch (error) {
-    console.error("Error fetching NFTs from Alchemy:", error);
-  }
-
-  return false;
-}

package/templates/playground/src/plugins/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/playground/src/plugins/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;
-    }
-  }
-}