create-message-kit 1.2.21 → 1.2.23

package/templates/thegeneralstore/src/index.ts

@@ -1,37 +0,0 @@
-import {
-  agentReply,
-  XMTPContext,
-  replaceVariables,
-  run,
-} from "@xmtp/message-kit";
-import { downloadPage } from "./plugins/notion.js";
-import fs from "fs";
-
-setupFiles();
-
-run(async (context: XMTPContext) => {
-  const {
-    message: { sender },
-    agent,
-  } = context;
-  let systemPrompt = await getPrompt();
-  let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-  await agentReply(context, prompt);
-});
-
-async function getPrompt() {
-  if (fs.existsSync(".data/prompt.md"))
-    return fs.readFileSync(".data/prompt.md", "utf8");
-  else return fs.readFileSync("src/prompt.md", "utf8");
-}
-async function setupFiles() {
-  if (!fs.existsSync(".data/db.json")) {
-    const dbfile = fs.readFileSync("src/data/db.json", "utf8");
-    fs.writeFileSync(".data/db.json", dbfile);
-    console.log("DB file created");
-  }
-
-  const page = await downloadPage();
-  fs.writeFileSync("src/prompt.md", page);
-  console.log("Notion DB updated");
-}

package/templates/thegeneralstore/src/plugins/learnweb3.ts

@@ -1,96 +0,0 @@
-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/thegeneralstore/src/plugins/lowdb.ts

@@ -1,11 +0,0 @@
-import { Low } from "lowdb";
-import { JSONFile } from "lowdb/node";
-
-const adapter = new JSONFile<{
-  poaps: Record<string, string>[]; // URL, Address
-}>(".data/db.json");
-export const db = new Low<{
-  poaps: Record<string, string>[]; // URL, Address
-}>(adapter, {
-  poaps: [],
-});

package/templates/thegeneralstore/src/plugins/redis.ts

@@ -1,15 +0,0 @@
-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/thegeneralstore/src/prompt.md

@@ -1,51 +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
-
-### Testnet funds
-
-- For each user you can deliver testnet funds using the learnweb3 api.
-- Check the available networks triggering the command before showing them.
-- Users can select the desired testnet network for the transfer of funds by number or name.
-
-### Poap Delivery
-
-- For each user you'll deliver only one POAP.
-- Don't forget to use commands to deliver POAPs.
-- Poaps are unique URLs basically
-
-## 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
-  Please reply with the item or number of the item you want
-- Delivering a POAP:
-  You've selected a POAP. I will deliver it to your address:
-  Processing your request now...
-  /poap 0x42AB57335941eb00535e95CbF64D78654Cb0F66A
-- Delivering testnet
-  You've selected Testnet funds. Let me check the available networks for you.
-  Processing your request now...
-  /networks
-- Delivering goodies
-  Let me get your TicTacs... Your order is confirmed. Enjoy!

package/templates/thegeneralstore/src/prompt.ts

@@ -1,3 +0,0 @@
-import systemPromptFromNotion from "./prompt.md";
-//Gets the system prompt from the Notion page
-export const systemPrompt = systemPromptFromNotion;

package/templates/thegeneralstore/src/skills/faucet.ts

@@ -1,114 +0,0 @@
-import { XMTPContext, clearMemory } from "@xmtp/message-kit";
-import { getRedisClient } from "../plugins/redis.js";
-import {
-  FIVE_MINUTES,
-  LearnWeb3Client,
-  Network,
-} from "../plugins/learnweb3.js";
-
-export async function handleFaucet(context: XMTPContext) {
-  const { message } = context;
-  const redisClient = await getRedisClient();
-  const {
-    content: { skill, params },
-    sender,
-  } = message;
-
-  // Initialize LearnWeb3Client
-  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;
-
-  if (skill === "networks") {
-    if (
-      !cachedSupportedNetworksData ||
-      Date.now() >
-        parseInt(JSON.parse(cachedSupportedNetworksData).lastSyncedAt) +
-          FIVE_MINUTES
-    ) {
-      console.log("Cleared cache");
-      const updatedSupportedNetworksData = await learnWeb3Client.getNetworks();
-      await redisClient.set(
-        "supported-networks",
-        JSON.stringify({
-          lastSyncedAt: Date.now(),
-          supportedNetworks: updatedSupportedNetworksData,
-        })
-      );
-      supportedNetworks = updatedSupportedNetworksData;
-    } else {
-      supportedNetworks = JSON.parse(
-        cachedSupportedNetworksData!
-      ).supportedNetworks;
-    }
-
-    supportedNetworks = supportedNetworks.filter(
-      (n) =>
-        !n.networkId.toLowerCase().includes("starknet") &&
-        !n.networkId.toLowerCase().includes("fuel") &&
-        !n.networkId.toLowerCase().includes("mode")
-    );
-
-    const networkList = supportedNetworks.map((n, index) => {
-      return `${index + 1}. ${n.networkId
-        .replace(/_/g, " ")
-        .replace(/\b\w/g, (l) => l.toUpperCase())}`;
-    });
-
-    return {
-      message: `Available networks:\n\n${networkList.join("\n")}`,
-      code: 200,
-    };
-  } else if (skill === "faucet") {
-    const { network } = params;
-    const selectedNetwork = supportedNetworks.find(
-      (n) => n.networkId === network
-    );
-
-    if (!selectedNetwork) {
-      await context.send("Invalid network. Please select a valid option.");
-      return;
-    }
-
-    await context.send(
-      "Your testnet tokens are being processed. Please wait a moment for the transaction to process."
-    );
-
-    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!}"`
-      );
-      // Clear any in-memory cache or state related to the prompt
-      clearMemory();
-      return;
-    }
-
-    await context.send("Here's your transaction receipt:");
-    await context.send(
-      `${process.env.FRAME_BASE_URL}?txLink=${result.value}&networkLogo=${
-        selectedNetwork?.networkLogo
-      }&networkName=${selectedNetwork?.networkName.replaceAll(
-        " ",
-        "-"
-      )}&tokenName=${selectedNetwork?.tokenName}&amount=${
-        selectedNetwork?.dripAmount
-      }`
-    );
-    // Clear any in-memory cache or state related to the prompt
-    clearMemory();
-  } else {
-    await context.send("Unknown skill. Please use 'list' or 'drip'.");
-  }
-}

package/templates/thegeneralstore/src/skills/notion.ts

@@ -1,17 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import { downloadPage } from "../plugins/notion.js";
-import fs from "fs";
-
-export async function handleNotion(context: XMTPContext) {
-  const {
-    message: {
-      content: { skill },
-    },
-  } = context;
-
-  if (skill === "update") {
-    const page = await downloadPage();
-    fs.writeFileSync("src/prompt.md", page);
-    await context.reply("Notion DB updated");
-  }
-}

package/templates/thegeneralstore/src/skills/poap.ts

@@ -1,48 +0,0 @@
-import { XMTPContext } from "@xmtp/message-kit";
-import { db } from "../plugins/lowdb.js";
-await db.read();
-
-export async function handlePoap(context: XMTPContext) {
-  const {
-    message: {
-      content: { skill, params },
-    },
-  } = context;
-
-  if (skill == "list") {
-    const poapTable = db?.data?.poaps;
-    const claimed = poapTable.filter((poap) => poap.Address);
-    return {
-      code: 200,
-      message: `You have claimed ${claimed.length} POAPs out of ${poapTable.length}`,
-    };
-  } else if (skill == "poap") {
-    const { address } = params;
-    await db.read();
-    const poapTable = db?.data?.poaps;
-    const poap = poapTable.find((poap) => poap.Address == address);
-
-    if (!poap) {
-      const emptyPoap = poapTable.find((poap) => !poap.Address);
-      if (emptyPoap) {
-        db?.data?.poaps?.push({ URL: emptyPoap?.URL, Address: address });
-        //?user_address=${address}`
-        return {
-          code: 200,
-          message: `Here is your POAP ${emptyPoap?.URL}`,
-        };
-      } else {
-        return {
-          code: 200,
-          message: "No more POAPs available",
-        };
-      }
-    } else {
-      //?user_address=${address}`
-      return {
-        code: 200,
-        message: `You have already claimed this POAP ${poap?.URL}`,
-      };
-    }
-  }
-}

package/templates/thegeneralstore/src/skills.ts

@@ -1,37 +0,0 @@
-import type { Agent } from "@xmtp/message-kit";
-import { handlePoap } from "./skills/poap.js";
-import { handleFaucet } from "./skills/faucet.js";
-import { handleNotion } from "./skills/notion.js";
-
-export const agent: Agent = {
-  name: "Poap Bot",
-  description: "Get your POAP.",
-  tag: "@store",
-  skills: [
-    {
-      skill: "/poap [address]",
-      handler: handlePoap,
-      examples: ["/poap 0x1234567890123456789012345678901234567890"],
-      description: "Get your POAP.",
-      params: {
-        address: {
-          type: "string",
-        },
-      },
-    },
-    {
-      skill: "/list",
-      handler: handlePoap,
-      examples: ["/list"],
-      description: "List all POAPs.",
-      params: {},
-    },
-    {
-      skill: "/update",
-      handler: handleNotion,
-      examples: ["/update"],
-      description: "Update your Notion prompt.",
-      params: {},
-    },
-  ],
-};