@semaphore-protocol/cli 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ethereum Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+<p align="center">
+    <h1 align="center">
+        Semaphore CLI
+    </h1>
+    <p align="center">A command line tool to set up a Semaphore project.</p>
+</p>
+
+<p align="center">
+    <a href="https://github.com/semaphore-protocol">
+        <img src="https://img.shields.io/badge/project-Semaphore-blue.svg?style=flat-square">
+    </a>
+    <a href="https://github.com/semaphore-protocol/semaphore/blob/main/LICENSE">
+        <img alt="Github license" src="https://img.shields.io/github/license/semaphore-protocol/semaphore.svg?style=flat-square">
+    </a>
+    <a href="https://www.npmjs.com/package/@semaphore-protocol/cli">
+        <img alt="NPM version" src="https://img.shields.io/npm/v/@semaphore-protocol/cli?style=flat-square" />
+    </a>
+    <a href="https://npmjs.org/package/@semaphore-protocol/cli">
+        <img alt="Downloads" src="https://img.shields.io/npm/dm/@semaphore-protocol/cli.svg?style=flat-square" />
+    </a>
+    <a href="https://eslint.org/">
+        <img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint" />
+    </a>
+    <a href="https://prettier.io/">
+        <img alt="Code style prettier" src="https://img.shields.io/badge/code%20style-prettier-f8bc45?style=flat-square&logo=prettier" />
+    </a>
+</p>
+
+<div align="center">
+    <h4>
+        <a href="https://github.com/semaphore-protocol/semaphore/blob/main/CONTRIBUTING.md">
+            👥 Contributing
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://github.com/semaphore-protocol/semaphore/blob/main/CODE_OF_CONDUCT.md">
+            🤝 Code of conduct
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://github.com/semaphore-protocol/semaphore/contribute">
+            🔎 Issues
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://discord.gg/6mSdGHnstH">
+            🗣️ Chat &amp; Support
+        </a>
+    </h4>
+</div>
+
+| ... |
+| --- |
+
+## 🛠 Install
+
+### npm or yarn
+
+Install the `@semaphore-protocol/cli` package with npm:
+
+```bash
+npm i @semaphore-protocol/cli
+```
+
+or yarn:
+
+```bash
+yarn add @semaphore-protocol/cli
+```
+
+## 📜 Usage

package/dist/index.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+
+/**
+ * @module @semaphore-protocol/cli
+ * @version 0.0.1
+ * @file A command line tool to set up a Semaphore project and query groups.
+ * @copyright Ethereum Foundation 2022
+ * @license MIT
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli}
+*/
+
+import { Subgraph } from '@semaphore-protocol/subgraph';
+import chalk from 'chalk';
+import { program } from 'commander';
+import figlet from 'figlet';
+import { readFileSync } from 'fs';
+import ora from 'ora';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+/* 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.")
+    .version(version, "-v, --version", "Show Semaphore CLI version.")
+    .addHelpText("before", `${figlet.textSync("Semaphore CLI")}\n`)
+    .helpOption(undefined, "Display this help.")
+    .addHelpCommand("help [command]", "Display help for a specific command.");
+program
+    .command("get-group")
+    .description("Get group data from a supported network.")
+    .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")}`;
+    }
+    if (signals) {
+        content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
+            .map(({ signal }, i) => `  [${i}] ${signal}`)
+            .join("\n")}`;
+    }
+    spinner.stop();
+    console.log(`${content}\n`);
+});
+program.parse();

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@semaphore-protocol/cli",
+    "type": "module",
+    "version": "0.0.1",
+    "description": "A command line tool to set up a Semaphore project and query groups.",
+    "license": "MIT",
+    "bin": {
+        "semaphore": "dist/index.js"
+    },
+    "types": "dist/types/index.d.ts",
+    "files": [
+        "dist/",
+        "src/",
+        "LICENSE",
+        "README.md"
+    ],
+    "repository": "https://github.com/semaphore-protocol/semaphore",
+    "homepage": "https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli",
+    "bugs": {
+        "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
+    },
+    "engines": {
+        "node": ">=14.16"
+    },
+    "scripts": {
+        "start": "ts-node --esm src/index.ts",
+        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
+        "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
+        "prepublishOnly": "yarn build"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {
+        "@types/figlet": "^1.5.5",
+        "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": "2.6.1",
+        "chalk": "^5.1.2",
+        "commander": "^9.4.1",
+        "figlet": "^1.5.2",
+        "ora": "^6.1.2"
+    }
+}

package/src/index.ts

@@ -0,0 +1,65 @@
+/* eslint-disable no-console */
+import { Subgraph } from "@semaphore-protocol/subgraph"
+import chalk from "chalk"
+import { program } from "commander"
+import figlet from "figlet"
+import { readFileSync } from "fs"
+import ora from "ora"
+import { dirname } from "path"
+import { fileURLToPath } from "url"
+
+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.")
+    .version(version, "-v, --version", "Show Semaphore CLI version.")
+    .addHelpText("before", `${figlet.textSync("Semaphore CLI")}\n`)
+    .helpOption(undefined, "Display this help.")
+    .addHelpCommand("help [command]", "Display help for a specific command.")
+
+program
+    .command("get-group")
+    .description("Get group data from a supported network.")
+    .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: string, i: number) => `   [${i}] ${member}`)
+                .join("\n")}`
+        }
+
+        if (signals) {
+            content += `\n\n ${chalk.bold("Signals")}: \n${group.verifiedProofs
+                .map(({ signal }: any, i: number) => `  [${i}] ${signal}`)
+                .join("\n")}`
+        }
+
+        spinner.stop()
+
+        console.log(`${content}\n`)
+    })
+
+program.parse()