@semaphore-protocol/cli 0.0.1 → 0.2.0

package/README.md

@@ -2,7 +2,7 @@
     <h1 align="center">
         Semaphore CLI
     </h1>
-    <p align="center">A command line tool to set up a Semaphore project.</p>
+    <p align="center">A command line tool to set up your Semaphore project and query groups.</p>
 </p>
 
 <p align="center">

package/dist/index.js

@@ -2,8 +2,8 @@
 
 /**
  * @module @semaphore-protocol/cli
- * @version 0.0.1
- * @file A command line tool to set up a Semaphore project and query groups.
+ * @version 0.2.0
+ * @file A command line tool to set up your Semaphore project and query groups.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli}
@@ -12,55 +12,128 @@
 import { Subgraph } from '@semaphore-protocol/subgraph';
 import chalk from 'chalk';
 import { program } from 'commander';
+import download from 'download';
 import figlet from 'figlet';
-import { readFileSync } from 'fs';
-import ora from 'ora';
+import { readFileSync, existsSync, renameSync } from 'fs';
+import logSymbols from 'log-symbols';
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';
+import ora from 'ora';
+
+class Spinner {
+    constructor(text) {
+        this.text = text;
+    }
+    start() {
+        console.info("");
+        this.ora = ora({
+            text: this.text,
+            indent: 1
+        }).start();
+    }
+    stop() {
+        this.ora.stop();
+        process.stdout.cursorTo(0);
+    }
+}
 
-/* eslint-disable no-console */
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`;
 const { version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"));
 program
     .name("semaphore")
-    .description("A command line tool to set up a Semaphore project and query groups.")
+    .description("A command line tool to set up your Semaphore project and query groups.")
     .version(version, "-v, --version", "Show Semaphore CLI version.")
-    .addHelpText("before", `${figlet.textSync("Semaphore CLI")}\n`)
+    .addHelpText("before", `${figlet.textSync("Semaphore")}\n`)
+    .addHelpText("after", "\r")
     .helpOption(undefined, "Display this help.")
-    .addHelpCommand("help [command]", "Display help for a specific command.");
+    .addHelpCommand("help [command]", "Display help for a specific command.")
+    .configureOutput({
+    outputError: (message) => {
+        console.info(`\n ${logSymbols.error}`, message);
+    }
+});
+program
+    .command("init")
+    .description("Initialize a Semaphore project with a supported template.")
+    .argument("<project-directory>", "Directory of the project.")
+    // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
+    .action(async (projectDirectory) => {
+    // const originalDirectory = process.cwd()
+    const spinner = new Spinner(`Creating '${projectDirectory}' project`);
+    const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`;
+    if (existsSync(projectDirectory)) {
+        console.info(`\n ${logSymbols.error}`, `error: the '${projectDirectory}' folder already exists\n`);
+        return;
+    }
+    spinner.start();
+    await download(templateURL, "./", { extract: true });
+    renameSync("package", projectDirectory);
+    spinner.stop();
+    console.info(` ${logSymbols.success}`, `Your '${projectDirectory}' project is ready!\n`);
+});
+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")
+    .action(async ({ network }) => {
+    const subgraph = new Subgraph(network);
+    const spinner = new Spinner("Fetching groups");
+    spinner.start();
+    try {
+        const groups = await subgraph.getGroups();
+        spinner.stop();
+        if (groups.length === 0) {
+            console.info(` ${logSymbols.error}`, "error: there are no groups in this network\n");
+            return;
+        }
+        const content = `${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");
+    }
+});
 program
     .command("get-group")
-    .description("Get group data from a supported network.")
+    .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.")
-    .usage("<group-id> [options]")
     .action(async (groupId, { network, members, signals }) => {
     const subgraph = new Subgraph(network);
-    const spinner = ora({
-        text: `Fetching group ${groupId}`,
-        spinner: "boxBounce"
-    }).start();
-    const group = await subgraph.getGroup(groupId, { members, verifiedProofs: signals });
-    let content = `\n ${chalk.bold("Id")}: ${group.id}\n`;
-    content += ` ${chalk.bold("Admin")}: ${group.admin}\n`;
-    content += ` ${chalk.bold("Merkle tree")}:\n`;
-    content += `   Root: ${group.merkleTree.root}\n`;
-    content += `   Depth: ${group.merkleTree.depth}\n`;
-    content += `   Zero value: ${group.merkleTree.zeroValue}\n`;
-    content += `   Number of leaves: ${group.merkleTree.numberOfLeaves}`;
-    if (members) {
-        content += `\n\n ${chalk.bold("Members")}: \n${group.members
-            .map((member, i) => `   [${i}] ${member}`)
-            .join("\n")}`;
+    const spinner = new Spinner(`Fetching group ${groupId}`);
+    spinner.start();
+    try {
+        const group = await subgraph.getGroup(groupId, { members, verifiedProofs: signals });
+        spinner.stop();
+        if (!group) {
+            console.info(` ${logSymbols.error}`, "error: the group does not exist\n");
+            return;
+        }
+        let content = ` ${chalk.bold("Id")}: ${group.id}\n`;
+        content += ` ${chalk.bold("Admin")}: ${group.admin}\n`;
+        content += ` ${chalk.bold("Merkle tree")}:\n`;
+        content += `   Root: ${group.merkleTree.root}\n`;
+        content += `   Depth: ${group.merkleTree.depth}\n`;
+        content += `   Zero value: ${group.merkleTree.zeroValue}\n`;
+        content += `   Number of leaves: ${group.merkleTree.numberOfLeaves}`;
+        if (members) {
+            content += `\n\n ${chalk.bold("Members")}: \n${group.members
+                .map((member, i) => `   ${i}. ${member}`)
+                .join("\n")}`;
+        }
+        if (signals) {
+            content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
+                .map(({ signal }) => `   - ${signal}`)
+                .join("\n")}`;
+        }
+        console.info(`${content}\n`);
     }
-    if (signals) {
-        content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
-            .map(({ signal }, i) => `  [${i}] ${signal}`)
-            .join("\n")}`;
+    catch (error) {
+        spinner.stop();
+        console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph");
     }
-    spinner.stop();
-    console.log(`${content}\n`);
 });
 program.parse();

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@semaphore-protocol/cli",
     "type": "module",
-    "version": "0.0.1",
-    "description": "A command line tool to set up a Semaphore project and query groups.",
+    "version": "0.2.0",
+    "description": "A command line tool to set up your Semaphore project and query groups.",
     "license": "MIT",
     "bin": {
         "semaphore": "dist/index.js"
@@ -40,9 +40,12 @@
     },
     "dependencies": {
         "@semaphore-protocol/subgraph": "2.6.1",
+        "@types/clear": "^0.1.2",
         "chalk": "^5.1.2",
         "commander": "^9.4.1",
+        "download": "^8.0.0",
         "figlet": "^1.5.2",
+        "log-symbols": "^5.1.0",
         "ora": "^6.1.2"
     }
 }

package/src/index.ts

@@ -1,65 +1,137 @@
-/* eslint-disable no-console */
 import { Subgraph } from "@semaphore-protocol/subgraph"
 import chalk from "chalk"
 import { program } from "commander"
+import download from "download"
 import figlet from "figlet"
-import { readFileSync } from "fs"
-import ora from "ora"
+import { existsSync, readFileSync, renameSync } from "fs"
+import logSymbols from "log-symbols"
 import { dirname } from "path"
 import { fileURLToPath } from "url"
+import Spinner from "./spinner.js"
 
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
 const { version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"))
 
 program
     .name("semaphore")
-    .description("A command line tool to set up a Semaphore project and query groups.")
+    .description("A command line tool to set up your Semaphore project and query groups.")
     .version(version, "-v, --version", "Show Semaphore CLI version.")
-    .addHelpText("before", `${figlet.textSync("Semaphore CLI")}\n`)
+    .addHelpText("before", `${figlet.textSync("Semaphore")}\n`)
+    .addHelpText("after", "\r")
     .helpOption(undefined, "Display this help.")
     .addHelpCommand("help [command]", "Display help for a specific command.")
+    .configureOutput({
+        outputError: (message) => {
+            console.info(`\n ${logSymbols.error}`, message)
+        }
+    })
+
+program
+    .command("init")
+    .description("Initialize a Semaphore project with a supported template.")
+    .argument("<project-directory>", "Directory of the project.")
+    // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
+    .action(async (projectDirectory) => {
+        // const originalDirectory = process.cwd()
+        const spinner = new Spinner(`Creating '${projectDirectory}' project`)
+        const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`
+
+        if (existsSync(projectDirectory)) {
+            console.info(`\n ${logSymbols.error}`, `error: the '${projectDirectory}' folder already exists\n`)
+            return
+        }
+
+        spinner.start()
+
+        await download(templateURL, "./", { extract: true })
+
+        renameSync("package", projectDirectory)
+
+        spinner.stop()
+
+        console.info(` ${logSymbols.success}`, `Your '${projectDirectory}' project is ready!\n`)
+    })
+
+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")
+    .action(async ({ network }) => {
+        const subgraph = new Subgraph(network)
+        const spinner = new Spinner("Fetching groups")
+
+        spinner.start()
+
+        try {
+            const groups = await subgraph.getGroups()
+
+            spinner.stop()
+
+            if (groups.length === 0) {
+                console.info(` ${logSymbols.error}`, "error: there are no groups in this network\n")
+                return
+            }
+
+            const content = `${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")
+        }
+    })
 
 program
     .command("get-group")
-    .description("Get group data from a supported network.")
+    .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.")
-    .usage("<group-id> [options]")
     .action(async (groupId, { network, members, signals }) => {
         const subgraph = new Subgraph(network)
+        const spinner = new Spinner(`Fetching group ${groupId}`)
 
-        const spinner = ora({
-            text: `Fetching group ${groupId}`,
-            spinner: "boxBounce"
-        }).start()
-
-        const group = await subgraph.getGroup(groupId, { members, verifiedProofs: signals })
-
-        let content = `\n ${chalk.bold("Id")}: ${group.id}\n`
-        content += ` ${chalk.bold("Admin")}: ${group.admin}\n`
-        content += ` ${chalk.bold("Merkle tree")}:\n`
-        content += `   Root: ${group.merkleTree.root}\n`
-        content += `   Depth: ${group.merkleTree.depth}\n`
-        content += `   Zero value: ${group.merkleTree.zeroValue}\n`
-        content += `   Number of leaves: ${group.merkleTree.numberOfLeaves}`
-
-        if (members) {
-            content += `\n\n ${chalk.bold("Members")}: \n${group.members
-                .map((member: string, i: number) => `   [${i}] ${member}`)
-                .join("\n")}`
-        }
+        spinner.start()
 
-        if (signals) {
-            content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
-                .map(({ signal }: any, i: number) => `  [${i}] ${signal}`)
-                .join("\n")}`
-        }
+        try {
+            const group = await subgraph.getGroup(groupId, { members, verifiedProofs: signals })
 
-        spinner.stop()
+            spinner.stop()
+
+            if (!group) {
+                console.info(` ${logSymbols.error}`, "error: the group does not exist\n")
+
+                return
+            }
+
+            let content = ` ${chalk.bold("Id")}: ${group.id}\n`
+            content += ` ${chalk.bold("Admin")}: ${group.admin}\n`
+            content += ` ${chalk.bold("Merkle tree")}:\n`
+            content += `   Root: ${group.merkleTree.root}\n`
+            content += `   Depth: ${group.merkleTree.depth}\n`
+            content += `   Zero value: ${group.merkleTree.zeroValue}\n`
+            content += `   Number of leaves: ${group.merkleTree.numberOfLeaves}`
 
-        console.log(`${content}\n`)
+            if (members) {
+                content += `\n\n ${chalk.bold("Members")}: \n${group.members
+                    .map((member: string, i: number) => `   ${i}. ${member}`)
+                    .join("\n")}`
+            }
+
+            if (signals) {
+                content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
+                    .map(({ signal }: any) => `   - ${signal}`)
+                    .join("\n")}`
+            }
+
+            console.info(`${content}\n`)
+        } catch (error) {
+            spinner.stop()
+
+            console.info(` ${logSymbols.error}`, "error: unexpected error with the Semaphore subgraph")
+        }
     })
 
 program.parse()

package/src/spinner.ts

@@ -0,0 +1,25 @@
+import ora, { Ora } from "ora"
+
+export default class Spinner {
+    private text: string
+    private ora: Ora
+
+    constructor(text: string) {
+        this.text = text
+    }
+
+    start() {
+        console.info("")
+
+        this.ora = ora({
+            text: this.text,
+            indent: 1
+        }).start()
+    }
+
+    stop() {
+        this.ora.stop()
+
+        process.stdout.cursorTo(0)
+    }
+}