@semaphore-protocol/cli 3.0.0-beta.8 → 3.1.0

package/dist/index.js

@@ -2,7 +2,7 @@
 
 /**
  * @module @semaphore-protocol/cli
- * @version 3.0.0-beta.8
+ * @version 3.1.0
  * @file A command line tool to set up your Semaphore project and get group data.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -18,8 +18,41 @@ import { readFileSync, existsSync, renameSync } from 'fs';
 import logSymbols from 'log-symbols';
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';
+import inquirer from 'inquirer';
+import axios from 'axios';
+import boxen from 'boxen';
+import { execSync } from 'child_process';
+import { lt } from 'semver';
 import ora from 'ora';
 
+const cliRegistryURL = "https://registry.npmjs.org/-/package/@semaphore-protocol/cli/dist-tags";
+/**
+ * Checks the registry directly via the API, if that fails, tries the slower `npm view [package] version` command.
+ * This is important for users in environments where direct access to npm is blocked by a firewall, and packages are
+ * provided exclusively via a private registry.
+ * @param currentVersion The current version of the CLI.
+ */
+async function checkLatestVersion(currentVersion) {
+    let latestVersion;
+    try {
+        const { data } = await axios.get(cliRegistryURL);
+        latestVersion = data.latest;
+    }
+    catch {
+        try {
+            latestVersion = execSync("npm view @semaphore-protocol/cli version").toString().trim();
+        }
+        catch {
+            latestVersion = null;
+        }
+    }
+    if (latestVersion && lt(currentVersion, latestVersion)) {
+        console.info("\n");
+        console.info(boxen(chalk.white(`Update available ${chalk.gray(currentVersion)} -> ${chalk.green(latestVersion)} \n\n You are currently using @semaphore-protocol/cli ${chalk.gray(currentVersion)} which is behind the latest release ${chalk.green(latestVersion)} \n\n Run ${chalk.cyan("npm install -g @semaphore-protocol/cli@latest")} to get the latest version`), { padding: 1, borderColor: "yellow", textAlignment: "center" }));
+        console.info("");
+    }
+}
+
 class Spinner {
     constructor(text) {
         this.text = text;
@@ -33,12 +66,13 @@ class Spinner {
     }
     stop() {
         this.ora.stop();
-        process.stdout.cursorTo(0);
+        process.stdout.moveCursor(0, -1);
     }
 }
 
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`;
 const { description, version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"));
+const supportedNetworks = ["goerli", "arbitrum"];
 program
     .name("semaphore")
     .description(description)
@@ -55,9 +89,19 @@ program
 program
     .command("create")
     .description("Create a Semaphore project with a supported template.")
-    .argument("<project-directory>", "Directory of the project.")
+    .argument("[project-directory]", "Directory of the project.")
     // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
+    .allowExcessArguments(false)
     .action(async (projectDirectory) => {
+    if (!projectDirectory) {
+        const { projectName } = await inquirer.prompt({
+            name: "projectName",
+            type: "input",
+            message: "What is your project name?",
+            default: "my-app"
+        });
+        projectDirectory = projectName;
+    }
     const currentDirectory = process.cwd();
     const spinner = new Spinner(`Creating your project in ${chalk.green(`./${projectDirectory}`)}`);
     const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`;
@@ -66,10 +110,11 @@ program
         return;
     }
     spinner.start();
+    await checkLatestVersion(version);
     await download(templateURL, currentDirectory, { extract: true });
     renameSync(`${currentDirectory}/package`, `${currentDirectory}/${projectDirectory}`);
     spinner.stop();
-    console.info(` ${logSymbols.success}`, `Your project is ready!\n`);
+    console.info(`\n ${logSymbols.success}`, `Your project is ready!\n`);
     console.info(` Please, install your dependencies by running:\n`);
     console.info(`   ${chalk.cyan("cd")} ${projectDirectory}`);
     console.info(`   ${chalk.cyan("npm i")}\n`);
@@ -85,9 +130,20 @@ program
 program
     .command("get-groups")
     .description("Get the list of groups from a supported network (goerli or arbitrum).")
-    .option("-n, --network <network-name>", "Supported Ethereum network.", "goerli")
+    .option("-n, --network <network-name>", "Supported Ethereum network.")
+    .allowExcessArguments(false)
     .action(async ({ network }) => {
-    if (!["goerli", "arbitrum"].includes(network)) {
+    if (!network) {
+        const { selectedNetwork } = await inquirer.prompt({
+            name: "selectedNetwork",
+            type: "list",
+            message: "Select one of our supported networks:",
+            default: supportedNetworks[0],
+            choices: supportedNetworks
+        });
+        network = selectedNetwork;
+    }
+    if (!supportedNetworks.includes(network)) {
         console.info(`\n ${logSymbols.error}`, `error: the network '${network}' is not supported\n`);
         return;
     }
@@ -98,26 +154,79 @@ program
         const groups = await subgraph.getGroups();
         spinner.stop();
         if (groups.length === 0) {
-            console.info(` ${logSymbols.error}`, "error: there are no groups in this network\n");
+            console.info(`\n ${logSymbols.info}`, "info: there are no groups in this network\n");
             return;
         }
-        const content = `${groups.map(({ id }) => ` - ${id}`).join("\n")}`;
+        const content = `\n${groups.map(({ id }) => ` - ${id}`).join("\n")}`;
         console.info(`${content}\n`);
     }
     catch (error) {
         spinner.stop();
-        console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
+        console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
     }
 });
 program
     .command("get-group")
     .description("Get the data of a group from a supported network (Goerli or Arbitrum).")
-    .argument("<group-id>", "Identifier of the group.")
-    .option("-n, --network <network-name>", "Supported Ethereum network.", "goerli")
-    .option("--members", "Show group members.")
-    .option("--signals", "Show group signals.")
+    .argument("[group-id]", "Identifier of the group.")
+    .option("-n, --network <network-name>", "Supported Ethereum network.")
+    .option("-m, --members", "Show group members.")
+    .option("-s, --signals", "Show group signals.")
+    .allowExcessArguments(false)
     .action(async (groupId, { network, members, signals }) => {
-    if (!["goerli", "arbitrum"].includes(network)) {
+    if (!network) {
+        const { selectedNetwork } = await inquirer.prompt({
+            name: "selectedNetwork",
+            type: "list",
+            message: "Select one of our supported networks:",
+            default: supportedNetworks[0],
+            choices: supportedNetworks
+        });
+        network = selectedNetwork;
+    }
+    if (!groupId) {
+        const subgraphGroups = new Subgraph(network);
+        const spinnerGroups = new Spinner("Fetching groups");
+        spinnerGroups.start();
+        try {
+            const groups = await subgraphGroups.getGroups();
+            spinnerGroups.stop();
+            if (groups.length === 0) {
+                console.info(`\n ${logSymbols.info}`, "info: there are no groups in this network\n");
+                return;
+            }
+            const groupIds = groups.map(({ id }) => id);
+            const { selectedGroupId } = await inquirer.prompt({
+                name: "selectedGroupId",
+                type: "list",
+                message: "Select one of the following existing group ids:",
+                choices: groupIds
+            });
+            groupId = selectedGroupId;
+        }
+        catch (error) {
+            spinnerGroups.stop();
+            console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
+            return;
+        }
+    }
+    if (!members && !signals) {
+        const { showMembers } = await inquirer.prompt({
+            name: "showMembers",
+            type: "confirm",
+            message: "Do you want to show members?",
+            default: false
+        });
+        members = showMembers;
+        const { showSignals } = await inquirer.prompt({
+            name: "showSignals",
+            type: "confirm",
+            message: "Do you want to show signals?",
+            default: false
+        });
+        signals = showSignals;
+    }
+    if (!supportedNetworks.includes(network)) {
         console.info(`\n ${logSymbols.error}`, `error: the network '${network}' is not supported\n`);
         return;
     }
@@ -128,7 +237,7 @@ program
         const group = await subgraph.getGroup(groupId, { members, verifiedProofs: signals });
         spinner.stop();
         if (!group) {
-            console.info(` ${logSymbols.error}`, "error: the group does not exist\n");
+            console.info(`\n ${logSymbols.error}`, "error: the group does not exist\n");
             return;
         }
         let content = ` ${chalk.bold("Id")}: ${group.id}\n`;
@@ -148,11 +257,11 @@ program
                 .map(({ signal }) => `   - ${signal}`)
                 .join("\n")}`;
         }
-        console.info(`${content}\n`);
+        console.info(`\n${content}\n`);
     }
     catch (error) {
         spinner.stop();
-        console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
+        console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
     }
 });
-program.parse();
+program.parse(process.argv);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@semaphore-protocol/cli",
     "type": "module",
-    "version": "3.0.0-beta.8",
+    "version": "3.1.0",
     "description": "A command line tool to set up your Semaphore project and get group data.",
     "license": "MIT",
     "bin": {
@@ -34,18 +34,23 @@
     "devDependencies": {
         "@types/clear": "^0.1.2",
         "@types/figlet": "^1.5.5",
+        "@types/semver": "^7.3.13",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.31.2",
         "ts-node": "^10.9.1",
         "typedoc": "^0.22.11"
     },
     "dependencies": {
-        "@semaphore-protocol/subgraph": "3.0.0-beta.8",
+        "@semaphore-protocol/subgraph": "3.1.0",
+        "axios": "^1.3.2",
+        "boxen": "^7.0.1",
         "chalk": "^5.1.2",
         "commander": "^9.4.1",
         "download": "^8.0.0",
         "figlet": "^1.5.2",
+        "inquirer": "^9.1.4",
         "log-symbols": "^5.1.0",
-        "ora": "^6.1.2"
+        "ora": "^6.1.2",
+        "semver": "^7.3.8"
     }
 }

package/src/checkLatestVersion.ts

@@ -0,0 +1,48 @@
+import axios from "axios"
+import boxen from "boxen"
+import chalk from "chalk"
+import { execSync } from "child_process"
+import { lt as semverLt } from "semver"
+
+const cliRegistryURL = "https://registry.npmjs.org/-/package/@semaphore-protocol/cli/dist-tags"
+
+/**
+ * Checks the registry directly via the API, if that fails, tries the slower `npm view [package] version` command.
+ * This is important for users in environments where direct access to npm is blocked by a firewall, and packages are
+ * provided exclusively via a private registry.
+ * @param currentVersion The current version of the CLI.
+ */
+export default async function checkLatestVersion(currentVersion: string) {
+    let latestVersion: string
+
+    try {
+        const { data } = await axios.get(cliRegistryURL)
+
+        latestVersion = data.latest
+    } catch {
+        try {
+            latestVersion = execSync("npm view @semaphore-protocol/cli version").toString().trim()
+        } catch {
+            latestVersion = null
+        }
+    }
+
+    if (latestVersion && semverLt(currentVersion, latestVersion)) {
+        console.info("\n")
+        console.info(
+            boxen(
+                chalk.white(
+                    `Update available ${chalk.gray(currentVersion)} -> ${chalk.green(
+                        latestVersion
+                    )} \n\n You are currently using @semaphore-protocol/cli ${chalk.gray(
+                        currentVersion
+                    )} which is behind the latest release ${chalk.green(latestVersion)} \n\n Run ${chalk.cyan(
+                        "npm install -g @semaphore-protocol/cli@latest"
+                    )} to get the latest version`
+                ),
+                { padding: 1, borderColor: "yellow", textAlignment: "center" }
+            )
+        )
+        console.info("")
+    }
+}

package/src/index.ts

@@ -7,11 +7,15 @@ import { existsSync, readFileSync, renameSync } from "fs"
 import logSymbols from "log-symbols"
 import { dirname } from "path"
 import { fileURLToPath } from "url"
+import inquirer from "inquirer"
+import checkLatestVersion from "./checkLatestVersion.js"
 import Spinner from "./spinner.js"
 
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
 const { description, version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"))
 
+const supportedNetworks = ["goerli", "arbitrum"]
+
 program
     .name("semaphore")
     .description(description)
@@ -29,9 +33,20 @@ program
 program
     .command("create")
     .description("Create a Semaphore project with a supported template.")
-    .argument("<project-directory>", "Directory of the project.")
+    .argument("[project-directory]", "Directory of the project.")
     // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
+    .allowExcessArguments(false)
     .action(async (projectDirectory) => {
+        if (!projectDirectory) {
+            const { projectName } = await inquirer.prompt({
+                name: "projectName",
+                type: "input",
+                message: "What is your project name?",
+                default: "my-app"
+            })
+            projectDirectory = projectName
+        }
+
         const currentDirectory = process.cwd()
         const spinner = new Spinner(`Creating your project in ${chalk.green(`./${projectDirectory}`)}`)
         const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`
@@ -43,13 +58,15 @@ program
 
         spinner.start()
 
+        await checkLatestVersion(version)
+
         await download(templateURL, currentDirectory, { extract: true })
 
         renameSync(`${currentDirectory}/package`, `${currentDirectory}/${projectDirectory}`)
 
         spinner.stop()
 
-        console.info(` ${logSymbols.success}`, `Your project is ready!\n`)
+        console.info(`\n ${logSymbols.success}`, `Your project is ready!\n`)
         console.info(` Please, install your dependencies by running:\n`)
         console.info(`   ${chalk.cyan("cd")} ${projectDirectory}`)
         console.info(`   ${chalk.cyan("npm i")}\n`)
@@ -72,9 +89,21 @@ program
 program
     .command("get-groups")
     .description("Get the list of groups from a supported network (goerli or arbitrum).")
-    .option("-n, --network <network-name>", "Supported Ethereum network.", "goerli")
+    .option("-n, --network <network-name>", "Supported Ethereum network.")
+    .allowExcessArguments(false)
     .action(async ({ network }) => {
-        if (!["goerli", "arbitrum"].includes(network)) {
+        if (!network) {
+            const { selectedNetwork } = await inquirer.prompt({
+                name: "selectedNetwork",
+                type: "list",
+                message: "Select one of our supported networks:",
+                default: supportedNetworks[0],
+                choices: supportedNetworks
+            })
+            network = selectedNetwork
+        }
+
+        if (!supportedNetworks.includes(network)) {
             console.info(`\n ${logSymbols.error}`, `error: the network '${network}' is not supported\n`)
             return
         }
@@ -90,29 +119,91 @@ program
             spinner.stop()
 
             if (groups.length === 0) {
-                console.info(` ${logSymbols.error}`, "error: there are no groups in this network\n")
+                console.info(`\n ${logSymbols.info}`, "info: there are no groups in this network\n")
                 return
             }
 
-            const content = `${groups.map(({ id }: any) => ` - ${id}`).join("\n")}`
+            const content = `\n${groups.map(({ id }: any) => ` - ${id}`).join("\n")}`
 
             console.info(`${content}\n`)
         } catch (error) {
             spinner.stop()
 
-            console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
+            console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
         }
     })
 
 program
     .command("get-group")
     .description("Get the data of a group from a supported network (Goerli or Arbitrum).")
-    .argument("<group-id>", "Identifier of the group.")
-    .option("-n, --network <network-name>", "Supported Ethereum network.", "goerli")
-    .option("--members", "Show group members.")
-    .option("--signals", "Show group signals.")
+    .argument("[group-id]", "Identifier of the group.")
+    .option("-n, --network <network-name>", "Supported Ethereum network.")
+    .option("-m, --members", "Show group members.")
+    .option("-s, --signals", "Show group signals.")
+    .allowExcessArguments(false)
     .action(async (groupId, { network, members, signals }) => {
-        if (!["goerli", "arbitrum"].includes(network)) {
+        if (!network) {
+            const { selectedNetwork } = await inquirer.prompt({
+                name: "selectedNetwork",
+                type: "list",
+                message: "Select one of our supported networks:",
+                default: supportedNetworks[0],
+                choices: supportedNetworks
+            })
+            network = selectedNetwork
+        }
+
+        if (!groupId) {
+            const subgraphGroups = new Subgraph(network)
+            const spinnerGroups = new Spinner("Fetching groups")
+            spinnerGroups.start()
+            try {
+                const groups = await subgraphGroups.getGroups()
+
+                spinnerGroups.stop()
+
+                if (groups.length === 0) {
+                    console.info(`\n ${logSymbols.info}`, "info: there are no groups in this network\n")
+                    return
+                }
+
+                const groupIds = groups.map(({ id }: any) => id)
+
+                const { selectedGroupId } = await inquirer.prompt({
+                    name: "selectedGroupId",
+                    type: "list",
+                    message: "Select one of the following existing group ids:",
+                    choices: groupIds
+                })
+                groupId = selectedGroupId
+            } catch (error) {
+                spinnerGroups.stop()
+                console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
+                return
+            }
+        }
+
+        if (!members && !signals) {
+            const { showMembers } = await inquirer.prompt({
+                name: "showMembers",
+                type: "confirm",
+                message: "Do you want to show members?",
+                default: false
+            })
+
+            members = showMembers
+
+            const { showSignals } = await inquirer.prompt({
+                name: "showSignals",
+                type: "confirm",
+                message: "Do you want to show signals?",
+                default: false
+            })
+
+            signals = showSignals
+        }
+
+        if (!supportedNetworks.includes(network)) {
             console.info(`\n ${logSymbols.error}`, `error: the network '${network}' is not supported\n`)
             return
         }
@@ -128,7 +219,7 @@ program
             spinner.stop()
 
             if (!group) {
-                console.info(` ${logSymbols.error}`, "error: the group does not exist\n")
+                console.info(`\n ${logSymbols.error}`, "error: the group does not exist\n")
 
                 return
             }
@@ -153,12 +244,12 @@ program
                     .join("\n")}`
             }
 
-            console.info(`${content}\n`)
+            console.info(`\n${content}\n`)
         } catch (error) {
             spinner.stop()
 
-            console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
+            console.info(`\n ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
         }
     })
 
-program.parse()
+program.parse(process.argv)

package/src/spinner.ts

@@ -20,6 +20,6 @@ export default class Spinner {
     stop() {
         this.ora.stop()
 
-        process.stdout.cursorTo(0)
+        process.stdout.moveCursor(0, -1)
     }
 }