create-message-kit 1.2.14 → 1.2.15

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.14";
+const defVersion = "1.2.15";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -95,31 +95,31 @@ async function updatePackagejson(destDir, templateType) {
 }
 
 async function gatherProjectInfo() {
-  const templateOptions = [
-    {
-      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 templateOptions = fs
+    .readJsonSync(resolve(__dirname, "./templates.json"))
+    .filter(
+      (template) =>
+        template.href.includes("ens") || template.href.includes("simple"),
+    );
 
   const templateType = await select({
     message: "Select the type of template to initialize:",
-    options: templateOptions,
+    options: templateOptions.map(({ title, description, href }) => ({
+      value: href,
+      label: `${title} - ${description}`,
+    })),
   });
 
   if (isCancel(templateType)) {
     process.exit(0);
   }
 
-  const templateDir = resolve(__dirname, `./templates/${templateType}`);
+  // Fix: Use templates directory with the selected href
+  const templateDir = resolve(__dirname, `./${templateType}`);
 
   // Ensure the template directory exists
   if (!fs.existsSync(templateDir)) {
-    console.error("Template directory does not exist.");
+    log.error(`Template directory not found: ${templateDir}`);
     process.exit(1);
   }
 
@@ -141,7 +141,7 @@ async function gatherProjectInfo() {
   // Copy template files
   fs.copySync(templateDir, destDir);
 
-  return { templateType, displayName, destDir, templateDir };
+  return { templateType: templateType, displayName, destDir, templateDir };
 }
 
 function createTsconfig(destDir) {

package/package.json

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

package/templates/coinbase-agent/.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/coinbase-agent/.env.example

@@ -0,0 +1,4 @@
+KEY= # 0x... the private key of the app (with the 0x prefix)
+TEST_ENCRYPTION_KEY= # a different private key for encryption
+OPEN_AI_API_KEY= # sk-proj-...
+REDIS_CONNECTION_STRING= # redis://default:...@...:...

package/templates/coinbase-agent/.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/coinbase-agent/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "coinbase-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.6.0",
+    "@xmtp/message-kit": "workspace:*",
+    "axios": "^1.7.7"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/coinbase-agent/src/index.ts

@@ -0,0 +1,31 @@
+import { registerSkill as swapSkill } from "./skills/swap.js";
+import { registerSkill as mintSkill } from "./skills/mint.js";
+import { registerSkill as dripSkill } from "./skills/drip.js";
+import { registerSkill as paySkill } from "./skills/pay.js";
+import { run, XMTPContext, agentReply, Agent } from "@xmtp/message-kit";
+import { replaceVariables } from "@xmtp/message-kit";
+import { systemPrompt } from "./prompt.js";
+
+export const frameUrl = "https://ens.steer.fun/";
+export const baseUrl = "https://base-tx-frame.vercel.app/transaction";
+export const ensUrl = "https://app.ens.domains/";
+
+export const agent: Agent = {
+  name: "Swap Bot",
+  tag: "@base",
+  description: "Swap bot for base.",
+  skills: [...swapSkill, ...mintSkill, ...dripSkill, ...paySkill],
+};
+
+run(
+  async (context: XMTPContext) => {
+    const {
+      message: { sender },
+      agent,
+    } = context;
+
+    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
+    await agentReply(context, prompt);
+  },
+  { agent }
+);

package/templates/coinbase-agent/src/plugins/learnweb3.ts

@@ -0,0 +1,96 @@
+import axios from "axios";
+
+export const SUPPORTED_NETWORKS = [
+  "arbitrum_goerli",
+  "arbitrum_sepolia",
+  "base_goerli",
+  "base_sepolia",
+  "base_sepolia_usdc",
+  "celo_alfajores",
+  "fantom_testnet",
+  "goerli",
+  "holesky",
+  "linea_goerli",
+  "linea_sepolia",
+  "manta_testnet",
+  "mode_sepolia",
+  "morph_sepolia",
+  "optimism_goerli",
+  "optimism_sepolia",
+  "polygon_amoy",
+  "polygon_mumbai",
+  "polygon_zkevm",
+  "scroll_sepolia",
+  "sepolia",
+  "taiko_jolnir",
+  "zksync_sepolia",
+  "zora_sepolia",
+] as const;
+
+export const CLAIM_EVERY = 24 * 60 * 60 * 1000; // 24 hours
+
+export const ONE_DAY = 24 * 60 * 60 * 1000; // 24 hours
+
+export const FIVE_MINUTES = 5 * 60 * 1000; // 5 minutes
+
+export const EVM_TOKENS = ["ETH", "MATIC", "USDC", "CELO", "BERA"];
+
+export interface Network {
+  networkId: string;
+  networkName: string;
+  networkLogo: string;
+  tokenName: string;
+  dripAmount: number;
+  address: string;
+  isERC20: boolean;
+  erc20Address?: string;
+  erc20Decimals?: number;
+  isActive: boolean;
+  balance: string;
+}
+export interface DripTokensResponse {
+  ok: boolean;
+  error?: string;
+  value?: string;
+}
+
+export class LearnWeb3Client {
+  public BASE_URL = "https://learnweb3.io/api/faucet";
+  private apiKey = process.env.LEARN_WEB3_API_KEY;
+  constructor() {
+    if (!process.env.LEARN_WEB3_API_KEY) {
+      throw new Error("Please set the LEARN_WEB3_API_KEY environment variable");
+    }
+    this.apiKey = process.env.LEARN_WEB3_API_KEY;
+  }
+
+  async getNetworks(onlyEvm = true): Promise<Network[]> {
+    const response = await axios(`${this.BASE_URL}/networks`);
+    const data: Network[] = response.data;
+    if (onlyEvm) {
+      return data.filter(
+        (network) =>
+          EVM_TOKENS.some((t) =>
+            network.tokenName.toLowerCase().includes(t.toLowerCase()),
+          ) && network.isActive,
+      );
+    }
+    return data.filter((network) => network.isActive);
+  }
+
+  async dripTokens(
+    networkId: string,
+    recipientAddress: string,
+  ): Promise<DripTokensResponse> {
+    const response = await axios.post(
+      `${this.BASE_URL}/drip`,
+      { networkId, recipientAddress },
+      {
+        headers: {
+          authorization: `Bearer ${this.apiKey}`,
+        },
+      },
+    );
+    return response.data;
+  }
+}

package/templates/coinbase-agent/src/plugins/redis.ts

@@ -0,0 +1,15 @@
+import { createClient } from "@redis/client";
+import { RedisClientType } from "@redis/client";
+
+export const getRedisClient = async () => {
+  const client = createClient({
+    url: process.env.REDIS_CONNECTION_STRING,
+  });
+
+  client.on("error", (err) => {
+    console.error("Redis client error:", err);
+  });
+
+  await client.connect();
+  return client as RedisClientType;
+};

package/templates/coinbase-agent/src/prompt.ts

@@ -0,0 +1,64 @@
+export const systemPrompt = `
+Your are helpful and playful agent called {agent_name} that lives inside a web3 messaging app called Converse.
+
+{rules}
+
+{user_context}
+
+{skills}
+
+## Response Scenarios:
+
+1. When user wants to swap tokens:
+  Hey {PREFERRED_NAME! I can help you swap tokens on Base.
+  Let me help you swap 10 USDC to ETH
+  /swap 10 usdc eth
+
+2. When user wants to swap a specific amount:
+  Sure! I'll help you swap 5 DEGEN to DAI
+  /swap 5 degen dai
+
+3. When user wants to pay a specific token:
+  I'll help you pay 1 USDC to 0x123...
+  /pay 1 {TOKEN} 0x123456789...
+  *This will return a url to pay
+
+4. If the user wants to pay a eth domain:
+  I'll help you pay 1 USDC to vitalik.eth
+  Be aware that this only works on mobile with a installed wallet on Base network
+  /pay 1 vitalik.eth
+  *This will return a url to pay
+
+5. If the user wants to pay a username:
+  I'll help you pay 1 USDC to @fabri
+  Be aware that this only works on mobile with a installed wallet on Base network
+  /pay 1 @fabri
+  *This will return a url to pay
+
+6. When user asks about supported tokens:
+  I can help you swap or pay these tokens on Base (ETH, USDC, DAI, DEGEN):
+  Just let me know the amount and which tokens you'd like to swap or send!
+
+7. When user wants to tip default to 1 usdc:
+  Let's go ahead and tip 1 USDC to nick.eth
+  /pay 1 usdc 0x123456789...
+
+8. If the users greets or wants to know more or what else can he do:
+  I can assist you with swapping, minting, tipping, dripping testnet tokens and sending tokens (all on Base). Just let me know what you need help with!.
+
+9. If the user wants to mint they can specify the collection and token id or a Url from Coinbase Wallet URL or Zora URL:
+  I'll help you mint the token with id 1 from collection 0x123456789...
+  /mint 0x123456789... 1
+  I'll help you mint the token from this url
+  /url_mint https://wallet.coinbase.com/nft/mint/eip155:1:erc721:0x123456789...
+  I'll help you mint the token from this url
+  /url_mint https://zora.co/collect/base/0x123456789/1...
+
+10. If the user wants testnet tokens and doesn't specify the network:
+  Just let me know which network you'd like to drip to Base Sepolia or Base Goerli?
+
+11. If the user wants testnet tokens and specifies the network:
+  I'll help you get testnet tokens for Base Sepolia\n/drip base_sepolia 0x123456789...
+
+{issues}
+`;

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;
+}