create-message-kit 1.2.14 → 1.2.16

package/templates/coinbase-agent/src/skills/drip.ts

@@ -0,0 +1,83 @@
+import { XMTPContext, clearMemory } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+import { getRedisClient } from "../plugins/redis.js";
+import { LearnWeb3Client, Network } from "../plugins/learnweb3.js";
+
+export const registerSkill: Skill[] = [
+  {
+    skill: "/drip [network] [address]",
+    handler: handler,
+    examples: [
+      "/drip base_sepolia 0x123456789",
+      "/drip base_goerli 0x123456789",
+    ],
+    description:
+      "Drip a default amount of testnet tokens to a specified address.",
+    params: {
+      network: {
+        default: "base_sepolia",
+        type: "string",
+        values: ["base_sepolia", "base_goerli"],
+      },
+      address: {
+        default: "",
+        type: "address",
+      },
+    },
+  },
+];
+
+export async function handler(context: XMTPContext) {
+  const {
+    message: {
+      content: { params },
+      sender,
+    },
+  } = context;
+
+  const { network } = params;
+  if (!network) {
+    await context.send("Invalid network. Please select a valid option.");
+    return;
+  }
+  context.send("Fetching testnet tokens...");
+  const redisClient = await getRedisClient();
+
+  const learnWeb3Client = new LearnWeb3Client();
+  // Fetch supported networks from Redis cache or API
+  let supportedNetworks: Network[];
+  const cachedSupportedNetworksData =
+    await redisClient.get("supported-networks");
+  supportedNetworks = JSON.parse(
+    cachedSupportedNetworksData!,
+  ).supportedNetworks;
+  await context.send(
+    "Your testnet tokens are being processed. Please wait a moment for the transaction to process.",
+  );
+  const selectedNetwork = supportedNetworks.find(
+    (n) => n.networkId.toLowerCase() === network.toLowerCase(),
+  );
+  if (!selectedNetwork) {
+    await context.send(
+      "The network currently does not have funds provided by web3 api's\nTry again later...",
+    );
+    return;
+  }
+  const result = await learnWeb3Client.dripTokens(
+    selectedNetwork!.networkId,
+    sender.address,
+  );
+
+  if (!result.ok) {
+    await context.send(
+      `❌ Sorry, there was an error processing your request:\n\n"${result.error!}"`,
+    );
+    return;
+  }
+
+  await context.send("Here's your transaction receipt:");
+  await context.sendReceipt(result.value!);
+  // Clear any in-memory cache or state related to the prompt
+  clearMemory();
+  return;
+}

package/templates/coinbase-agent/src/skills/mint.ts

@@ -0,0 +1,99 @@
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+import { baseUrl } from "../index.js";
+
+export const registerSkill: Skill[] = [
+  {
+    skill: "/mint [collection] [token_id] [url]",
+    examples: [
+      "/mint 0x73a333cb82862d4f66f0154229755b184fb4f5b0 1",
+      "/mint https://zora.co/collect/base/0x123456789/1...",
+    ],
+
+    handler: handler,
+    description: "Mint a specific token from a collection.",
+    params: {
+      collection: {
+        default: "0x73a333cb82862d4f66f0154229755b184fb4f5b0",
+        type: "string",
+      },
+      token_id: {
+        default: "1",
+        type: "number",
+      },
+      url: {
+        type: "url",
+      },
+    },
+  },
+];
+export async function handler(context: XMTPContext) {
+  const {
+    message: {
+      content: { params },
+    },
+  } = context;
+
+  if (params.url) {
+    const MINT_URL = "https://xmtp-mintiaml.vercel.app";
+    const { url } = context.message.content.params;
+
+    const urlPatterns = [
+      {
+        pattern: /https?:\/\/zora\.co\/collect\/([^:]+):([^/]+)\/(\d+)/,
+        transform: (chain: string, address: string, tokenId: string) =>
+          `${MINT_URL}/${chain}/${address}/${tokenId}`,
+      },
+      {
+        pattern:
+          /https?:\/\/wallet\.coinbase\.com\/nft\/mint\/eip155:(\d+):erc721:([^:]+)/,
+        transform: (chain: string, address: string) =>
+          `${MINT_URL}/eip155/${chain}/erc721/${address}`,
+      },
+      {
+        pattern:
+          /https?:\/\/wallet\.coinbase\.com\/nft\/mint\/eip155:(\d+):erc1155:([^:]+):(\d+)/,
+        transform: (chain: string, address: string, tokenId: string) =>
+          `${MINT_URL}/eip155/${chain}/erc1155/${address}/${tokenId}`,
+      },
+    ];
+    //https://wallet.coinbase.com/nft/mint/eip155:8453:erc1155:0x9a83e7b27b8a9b68e8dc665a0049f2f004287a20:1
+    //https://wallet.coinbase.com/nft/mint/eip155:8453:erc721:0x2a8e46E78BA9667c661326820801695dcf1c403E
+    //https://zora.co/collect/base:0xa902601ece8b81d906b7deceb67f5badcbdff7df/1
+
+    //https://xmtp-mintiaml.vercel.app/eip155/8453/erc721/0xf16755b43eE1a458161f0faE5a9124729f4f6B1B
+    let parsedUrl = null;
+    for (const { pattern, transform } of urlPatterns) {
+      const match = url.match(pattern);
+
+      if (match) {
+        parsedUrl = transform(match[1], match[2], match[3]);
+        break;
+      }
+    }
+    if (parsedUrl) {
+      await context.send("Here is your Mint Frame URL: ");
+      await context.send(parsedUrl);
+      return;
+    } else {
+      await context.send(
+        "Error: Unable to parse the provided URL. Please ensure you're sending a valid Zora or Coinbase Wallet URL.",
+      );
+      return;
+    }
+  } else {
+    const { collection, token_id } = params;
+    console.log(collection, token_id);
+    if (!collection || !token_id) {
+      context.reply(
+        "Missing required parameters. Please provide collection and token_id.",
+      );
+      return;
+    }
+    let mintUrl = `${baseUrl}/?transaction_type=mint&collection=${collection}&token_id=${token_id}`;
+    return {
+      code: 200,
+      message: mintUrl,
+    };
+  }
+}

package/templates/coinbase-agent/src/skills/pay.ts

@@ -0,0 +1,35 @@
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+
+export const registerSkill: Skill[] = [
+  {
+    skill: "/pay [amount] [token] [username]",
+    examples: ["/pay 10 vitalik.eth"],
+    description:
+      "Send a specified amount of a cryptocurrency to a destination address.",
+    handler: handler,
+    params: {
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
+      },
+      username: {
+        default: "",
+        type: "username",
+      },
+    },
+  },
+];
+
+export async function handler(context: XMTPContext) {
+  const { params } = context.message.content;
+
+  const { amount: amountSend, token: tokenSend, username } = params;
+
+  await context.requestPayment(amountSend, tokenSend, username);
+}

package/templates/coinbase-agent/src/skills/swap.ts

@@ -0,0 +1,52 @@
+import { XMTPContext } from "@xmtp/message-kit";
+import type { Skill } from "@xmtp/message-kit";
+import { baseUrl } from "../index.js";
+
+export const registerSkill: Skill[] = [
+  {
+    skill: "/swap [amount] [token_from] [token_to]",
+    examples: ["/swap 10 usdc eth", "/swap 1 dai usdc"],
+    handler: handler,
+    description: "Exchange one type of cryptocurrency for another.",
+    params: {
+      amount: {
+        default: 10,
+        type: "number",
+      },
+      token_from: {
+        default: "usdc",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokens
+      },
+      token_to: {
+        default: "eth",
+        type: "string",
+        values: ["eth", "dai", "usdc", "degen"], // Accepted tokenss
+      },
+    },
+  },
+];
+
+export async function handler(context: XMTPContext) {
+  // Destructure and validate parameters for the swap command
+  const {
+    message: {
+      content: { params },
+    },
+  } = context;
+
+  const { amount, token_from, token_to } = params;
+
+  if (!amount || !token_from || !token_to) {
+    context.reply(
+      "Missing required parameters. Please provide amount, token_from, and token_to."
+    );
+    return;
+  }
+
+  let swapUrl = `${baseUrl}/?transaction_type=swap&token_from=${token_from}&token_to=${token_to}&amount=${amount}`;
+  return {
+    code: 200,
+    message: swapUrl,
+  };
+}

package/templates/ens/.env.example

@@ -1,2 +1,3 @@
 KEY= # the private key of the wallet
+TEST_ENCRYPTION_KEY= # a different private key for encryption
 OPENAI_API_KEY= # sk-proj-...

package/templates/ens/.yarnrc.yml

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

package/templates/ens/src/index.ts

@@ -41,7 +41,7 @@ run(
     } = context;
 
     let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    // [!region run1]
+    // [!endregion run1]
     //This is only used for to update the docs.
     fs.writeFileSync("example_prompt.md", prompt);
     // [!region run2]

package/templates/ens/src/prompt.ts

@@ -7,18 +7,5 @@ Your are a helpful and playful ens agent called {agent_name} that lives inside a
 
 {skills}
 
-## 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
+{issues}
 `;

package/templates/faucet/.cursorrules

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

@@ -0,0 +1,5 @@
+KEY= # The private key for the bot
+TEST_ENCRYPTION_KEY= # The private key for the test app (with the 0x prefix)
+LEARN_WEB3_API_KEY= # Your LearnWeb3 API key
+REDIS_CONNECTION_STRING= # Redis connection string for caching 
+FRAME_BASE_URL= # Base URL for the frame application

package/templates/faucet/.yarnrc.yml

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

package/templates/faucet/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "faucet-agent",
+  "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": {
+    "@redis/client": "^1.5.14",
+    "@xmtp/message-kit": "workspace:*",
+    "axios": "^1.6.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/faucet/src/index.ts

@@ -0,0 +1,39 @@
+import {
+  run,
+  agentReply,
+  replaceVariables,
+  XMTPContext,
+  Agent,
+} 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) => {
+    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]