create-message-kit 1.1.9-beta.2 → 1.1.9-beta.4

package/index.js

@@ -51,7 +51,7 @@ Powered by XMTP`;
     log.success(`Project launched in ${pc.red(destDir)}!`);
 
     // Add package.json
-    addPackagejson(destDir, displayName, pkgManager);
+    updatePackagejson(destDir, templateType);
 
     // Create README.md file
     createReadme(destDir, templateType, displayName, pkgManager);
@@ -64,39 +64,14 @@ Powered by XMTP`;
 
 program.parse(process.argv);
 
-async function addPackagejson(destDir, name, pkgManager) {
+async function updatePackagejson(destDir, templateType) {
   // Create package.json based on the template
-  let packageTemplate = {
-    name: name,
-    private: true,
-    type: "module",
-    scripts: {
-      build: "tsc",
-      dev: "tsc -w & sleep 1 && node --watch dist/index.js",
-      start: "node dist/index.js",
-      postinstall: "tsc",
-    },
-    dependencies: {
-      "@xmtp/message-kit": "latest",
-    },
-    devDependencies: {
-      "@types/node": "latest",
-      typescript: "latest",
-    },
-    engines: {
-      node: ">=20",
-    },
-  };
-
-  if (pkgManager.includes("yarn")) {
-    packageTemplate.packageManager = `yarn@4.5.1`;
-  }
+  const templateDir = resolve(__dirname, `./templates/${templateType}`);
+  const packageTemplate = fs.readJsonSync(`${templateDir}/package.json`);
 
-  // Add .yarnrc.yml just in caseto disable PnP mode
-  fs.writeFileSync(
-    resolve(destDir, ".yarnrc.yml"),
-    "nodeLinker: node-modules\n",
-  );
+  packageTemplate.dependencies["@xmtp/message-kit"] = "latest";
+  //Add for yarn in general
+  packageTemplate.packageManager = `yarn@4.5.1`;
 
   fs.writeJsonSync(resolve(destDir, "package.json"), packageTemplate, {
     spaces: 2,
@@ -106,8 +81,9 @@ async function addPackagejson(destDir, name, pkgManager) {
 async function gatherProjectInfo() {
   const templateOptions = [
     { value: "gpt", label: "Simple Gpt" },
-    { value: "agent", label: "Agent" },
-    { value: "group", label: "Group" },
+    { value: "agent", label: "ENS Agent" },
+    { value: "group", label: "Group bot" },
+    { value: "gated", label: "Gated Group" },
   ];
 
   const templateType = await select({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-message-kit",
-  "version": "1.1.9-beta.2",
+  "version": "1.1.9-beta.4",
   "license": "MIT",
   "type": "module",
   "main": "index.js",

package/templates/agent/.yarnrc.yml

@@ -0,0 +1,4 @@
+compressionLevel: mixed
+enableGlobalCache: false
+enableTelemetry: false
+nodeLinker: node-modules

package/templates/agent/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "agent",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && node --watch dist/index.js",
+    "postinstall": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/agent/src/index.ts

@@ -1,4 +1,9 @@
-import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+import {
+  run,
+  agentReply,
+  replaceVariables,
+  XMTPContext,
+} from "@xmtp/message-kit";
 import { systemPrompt } from "./prompt.js";
 import { registerSkill as checkSkill } from "./handlers/check.js";
 import { registerSkill as coolSkill } from "./handlers/cool.js";
@@ -31,16 +36,16 @@ export const skills = [
 ];
 
 run(
-  async (context) => {
+  async (context: XMTPContext) => {
     const {
       message: { sender },
-      runConfig,
+      skills,
     } = context;
 
     let prompt = await replaceVariables(
       systemPrompt,
       sender.address,
-      runConfig?.skills,
+      skills,
       "@ens",
     );
     fs.writeFileSync("example_prompt.md", prompt);

package/templates/agent/src/prompt.ts

@@ -48,5 +48,5 @@ Your are helpful and playful agent called {agent_name} that lives inside a web3
     /cool [domain]
   
 ## Most common bugs
-1. Sometimes you will say something like: "Looks like vitalik.eth is registered! What about these cool alternatives?" But you forgot to add the command at the end of the message.
+1. Some times you will say something like: "Looks like vitalik.eth is registered! What about these cool alternatives?" But you forgot to add the command at the end of the message.
 `;

package/templates/gated/.env.example

@@ -0,0 +1,3 @@
+KEY= # the private key of the bot wallet
+PORT= # the port of the server
+ALCHEMY_API_KEY= # the alchemy api key

package/templates/gated/.yarnrc.yml

@@ -0,0 +1,4 @@
+compressionLevel: mixed
+enableGlobalCache: false
+enableTelemetry: false
+nodeLinker: node-modules

package/templates/gated/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "gated",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && node --watch dist/index.js",
+    "postinstall": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*",
+    "alchemy-sdk": "^3.4.3",
+    "express": "^4.19.2"
+  },
+  "devDependencies": {
+    "@types/express": "^4",
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/gated/src/index.ts

@@ -0,0 +1,64 @@
+import { run, xmtpClient, XMTPContext } from "@xmtp/message-kit";
+import { Client } from "@xmtp/node-sdk";
+import { startServer } from "./lib/gated.js";
+import { verifiedRequest } from "./lib/nft.js";
+const { client } = await xmtpClient({ hideInitLogMessage: true });
+startServer(client, verifiedRequest);
+
+run(async (context: XMTPContext) => {
+  const {
+    message: {
+      sender,
+      content: { skill },
+    },
+    client,
+    group,
+  } = context;
+
+  if (skill == "id") {
+    console.log(group?.id);
+  } else if (skill === "create") {
+    await context.send("Creating group...");
+    const group = await createGroup(
+      client,
+      sender.address,
+      client.accountAddress,
+    );
+
+    await context.send(
+      `Group created!\n- ID: ${group.id}\n- Group Frame URL: https://converse.xyz/group/${group.id}: \n- This url will deelink to the group inside Converse\n- Once in the other group you can share the invite with your friends.`,
+    );
+    return;
+  } else {
+    await context.send(
+      "👋 Welcome to the Gated Bot Group!\nTo get started, type /create to set up a new group. 🚀\nThis example will check if the user has a particular nft and add them to the group if they do.\nOnce your group is created, you'll receive a unique Group ID and URL.\nShare the URL with friends to invite them to join your group!",
+    );
+  }
+});
+
+async function createGroup(
+  client: Client,
+  senderAddress: string,
+  clientAddress: string,
+) {
+  let senderInboxId = "";
+  const group = await client?.conversations.newConversation([
+    senderAddress,
+    clientAddress,
+  ]);
+  const members = await group.members();
+  const senderMember = members.find((member) =>
+    member.accountAddresses.includes(senderAddress.toLowerCase()),
+  );
+  if (senderMember) {
+    const senderInboxId = senderMember.inboxId;
+    console.log("Sender's inboxId:", senderInboxId);
+  } else {
+    console.log("Sender not found in members list");
+  }
+  await group.addSuperAdmin(senderInboxId);
+  console.log("Sender is superAdmin", await group.isSuperAdmin(senderInboxId));
+  await group.send(`Welcome to the new group!`);
+  await group.send(`You are now the admin of this group as well as the bot`);
+  return group;
+}

package/templates/gated/src/lib/gated.ts

@@ -0,0 +1,51 @@
+// Import necessary modules
+import express from "express";
+import { Client } from "@xmtp/node-sdk";
+
+export function startServer(
+  client: Client,
+  verifiedRequest: (walletAddress: string, groupId: string) => Promise<boolean>,
+) {
+  async function addWalletToGroup(
+    walletAddress: string,
+    groupId: string,
+  ): Promise<string> {
+    const conversation =
+      await client.conversations.getConversationById(groupId);
+    const verified = await verifiedRequest(walletAddress, groupId);
+    if (!verified) {
+      console.log("User cant be added to the group");
+      return "not verified";
+    } else {
+      try {
+        await conversation?.addMembers([walletAddress]);
+        console.log(`Added wallet address: ${walletAddress} to the group`);
+        return "success";
+      } catch (error: any) {
+        console.log(error.message);
+        return "error";
+      }
+    }
+  }
+
+  // Endpoint to add wallet address to a group from an external source
+  const app = express();
+  app.use(express.json());
+  app.post("/add-wallet", async (req, res) => {
+    try {
+      const { walletAddress, groupId } = req.body;
+      const result = await addWalletToGroup(walletAddress, groupId);
+      res.status(200).send(result);
+    } catch (error: any) {
+      res.status(400).send(error.message);
+    }
+  });
+  // Start the server
+  const PORT = process.env.PORT || 3000;
+  const url = process.env.URL || `http://localhost:${PORT}`;
+  app.listen(PORT, () => {
+    console.warn(
+      `Use this endpoint to add a wallet to a group indicated by the groupId\n${url}/add-wallet <body: {walletAddress, groupId}>`,
+    );
+  });
+}

package/templates/gated/src/lib/nft.ts

@@ -0,0 +1,37 @@
+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 verifiedRequest(
+  walletAddress: string,
+  groupId: string
+): Promise<boolean> {
+  console.log("new-request", {
+    groupId,
+    walletAddress,
+  });
+
+  const alchemy = new Alchemy(settings);
+  try {
+    const nfts = await alchemy.nft.getNftsForOwner(walletAddress);
+    const collectionSlug = "XMTPeople"; // The slug for the collection
+
+    const ownsNft = nfts.ownedNfts.some(
+      (nft: any) =>
+        nft.contract.name.toLowerCase() === collectionSlug.toLowerCase()
+    );
+    console.log(
+      `NFTs owned on ${Network.BASE_MAINNET}:`,
+      nfts.ownedNfts.length
+    );
+    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/gated/src/skills.ts

@@ -0,0 +1,24 @@
+import type { SkillGroup } from "@xmtp/message-kit";
+
+export const skills: SkillGroup[] = [
+  {
+    name: "Group Id",
+    description: "Create and get group id.",
+    skills: [
+      {
+        skill: "/create",
+        examples: ["/create"],
+        adminOnly: true,
+        params: {},
+        description: "Create a new group.",
+      },
+      {
+        skill: "/id",
+        examples: ["/id"],
+        adminOnly: true,
+        params: {},
+        description: "Get group id.",
+      },
+    ],
+  },
+];

package/templates/gpt/.yarnrc.yml

@@ -0,0 +1,4 @@
+compressionLevel: mixed
+enableGlobalCache: false
+enableTelemetry: false
+nodeLinker: node-modules

package/templates/gpt/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "gpt",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && node --watch dist/index.js",
+    "postinstall": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/gpt/src/index.ts

@@ -1,18 +1,17 @@
-import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+import {
+  run,
+  agentReply,
+  replaceVariables,
+  XMTPContext,
+} from "@xmtp/message-kit";
 
 import { systemPrompt } from "./prompt.js";
 
-run(async (context) => {
+run(async (context: XMTPContext) => {
   const {
     message: { sender },
-    runConfig,
   } = context;
 
-  let prompt = await replaceVariables(
-    systemPrompt,
-    sender.address,
-    runConfig?.skills,
-    "@bot",
-  );
+  let prompt = await replaceVariables(systemPrompt, sender.address, [], "@bot");
   await agentReply(context, prompt);
 });

package/templates/group/.yarnrc.yml

@@ -0,0 +1,4 @@
+compressionLevel: mixed
+enableGlobalCache: false
+enableTelemetry: false
+nodeLinker: node-modules

package/templates/group/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "group",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w & sleep 1 && node --watch dist/index.js",
+    "postinstall": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "@xmtp/message-kit": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/group/src/handlers/helpers.ts

@@ -25,13 +25,13 @@ export async function handleHelp(context: XMTPContext) {
       content: { skill },
     },
     group,
-    runConfig,
+    skills,
   } = context;
 
   if (skill == "help") {
     const intro =
       "Available experiences:\n" +
-      runConfig?.skills
+      skills
         ?.flatMap((app) => app.skills)
         .map((skill) => `${skill.skill} - ${skill.description}`)
         .join("\n") +

package/templates/group/src/handlers/tipping.ts

@@ -1,5 +1,4 @@
-import { XMTPContext, AbstractedMember } from "@xmtp/message-kit";
-import { getUserInfo } from "@xmtp/message-kit";
+import { getUserInfo, AbstractedMember, XMTPContext } from "@xmtp/message-kit";
 import type { skillAction } from "@xmtp/message-kit";
 
 export const registerSkill: skillAction[] = [

package/templates/group/src/index.ts

@@ -1,4 +1,9 @@
-import { run, agentReply, replaceVariables } from "@xmtp/message-kit";
+import {
+  run,
+  agentReply,
+  XMTPContext,
+  replaceVariables,
+} from "@xmtp/message-kit";
 import { registerSkill as tippingSkill } from "./handlers/tipping.js";
 import { registerSkill as paymentSkill } from "./handlers/payment.js";
 import { registerSkill as gameSkill } from "./handlers/game.js";
@@ -15,16 +20,16 @@ export const skills = [
 ];
 
 run(
-  async (context) => {
+  async (context: XMTPContext) => {
     const {
       message: { sender },
-      runConfig,
+      skills,
     } = context;
 
     let prompt = await replaceVariables(
       systemPrompt,
       sender.address,
-      runConfig?.skills,
+      skills,
       "@bot",
     );
     await agentReply(context, prompt);