@semaphore-protocol/cli 3.15.1 → 4.0.0-alpha

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Ethereum Foundation
+Copyright (c) 2024 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

package/README.md

@@ -76,9 +76,9 @@ Options:
 
 Commands:
   create [options] [project-directory]  Create a Semaphore project with a supported template.
-  get-groups [options]                  Get the list of groups from a supported network (e.g. goerli or arbitrum).
-  get-group [options] [group-id]        Get the data of a group from a supported network (e.g. goerli or arbitrum).
-  get-members [options] [group-id]      Get the members of a group from a supported network (e.g. goerli or arbitrum).
-  get-proofs [options] [group-id]       Get the proofs of a group from a supported network (e.g. goerli or arbitrum).
+  get-groups [options]                  Get the list of groups from a supported network (e.g. sepolia or arbitrum).
+  get-group [options] [group-id]        Get the data of a group from a supported network (e.g. sepolia or arbitrum).
+  get-members [options] [group-id]      Get the members of a group from a supported network (e.g. sepolia or arbitrum).
+  get-proofs [options] [group-id]       Get the proofs of a group from a supported network (e.g. sepolia or arbitrum).
   help [command]                        Display help for a specific command.
 ```

package/dist/index.js

@@ -2,9 +2,9 @@
 
 /**
  * @module @semaphore-protocol/cli
- * @version 3.15.1
+ * @version 4.0.0-alpha
  * @file A command line tool to set up your Semaphore project and get group data.
- * @copyright Ethereum Foundation 2022
+ * @copyright Ethereum Foundation 2024
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli}
 */
@@ -12,11 +12,11 @@
 import { SemaphoreSubgraph, SemaphoreEthers, getSupportedNetworks } from '@semaphore-protocol/data';
 import chalk from 'chalk';
 import { program } from 'commander';
+import decompress from 'decompress';
 import figlet from 'figlet';
 import { readFileSync, existsSync, unlinkSync, copyFileSync } from 'fs';
 import logSymbols from 'log-symbols';
 import pacote from 'pacote';
-import decompress from 'decompress';
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';
 import axios from 'axios';
@@ -221,7 +221,7 @@ program
 });
 program
     .command("get-groups")
-    .description("Get the list of groups from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the list of groups from a supported network (e.g. sepolia or arbitrum).")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
     .action(async ({ network }) => {
@@ -244,7 +244,7 @@ program
 });
 program
     .command("get-group")
-    .description("Get the data of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the data of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -294,13 +294,12 @@ program
     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}`;
+    content += `   Size: ${group.merkleTree.size}`;
     console.info(`\n${content}\n`);
 });
 program
     .command("get-members")
-    .description("Get the members of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the members of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -352,7 +351,7 @@ program
 });
 program
     .command("get-proofs")
-    .description("Get the proofs of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the proofs of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -372,19 +371,19 @@ program
         }
         groupId = await getGroupId(groupIds);
     }
-    let verifiedProofs;
+    let validatedProofs;
     const spinner = new Spinner(`Fetching proofs of group ${groupId}`);
     spinner.start();
     try {
         const semaphoreSubgraph = new SemaphoreSubgraph(network);
-        const group = await semaphoreSubgraph.getGroup(groupId, { verifiedProofs: true });
-        verifiedProofs = group.verifiedProofs;
+        const group = await semaphoreSubgraph.getGroup(groupId, { validatedProofs: true });
+        validatedProofs = group.validatedProofs;
         spinner.stop();
     }
     catch {
         try {
             const semaphoreEthers = new SemaphoreEthers(network);
-            verifiedProofs = await semaphoreEthers.getGroupVerifiedProofs(groupId);
+            validatedProofs = await semaphoreEthers.getGroupValidatedProofs(groupId);
             spinner.stop();
         }
         catch {
@@ -393,12 +392,12 @@ program
             return;
         }
     }
-    if (verifiedProofs.length === 0) {
+    if (validatedProofs.length === 0) {
         console.info(`\n ${logSymbols.info}`, "info: there are no proofs in this group\n");
         return;
     }
-    const content = `${chalk.bold("Proofs")} (${verifiedProofs.length}): \n${verifiedProofs
-        .map(({ signal, merkleTreeRoot, externalNullifier, nullifierHash }, i) => `   ${i}. signal: ${signal} \n      merkleTreeRoot: ${merkleTreeRoot} \n      externalNullifier: ${externalNullifier} \n      nullifierHash: ${nullifierHash}`)
+    const content = `${chalk.bold("Proofs")} (${validatedProofs.length}): \n${validatedProofs
+        .map(({ message, merkleTreeRoot, merkleTreeDepth, scope, nullifier, proof }, i) => `   ${i}. message: ${message} \n      merkleTreeRoot: ${merkleTreeRoot} \n      merkleTreeDepth: ${merkleTreeDepth} \n      scope: ${scope} \n      nullifier: ${nullifier} \n      proof: [${proof.join(", ")}]`)
         .join("\n")}`;
     console.info(`\n${content}\n`);
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semaphore-protocol/cli",
   "type": "module",
-  "version": "3.15.1",
+  "version": "4.0.0-alpha",
   "description": "A command line tool to set up your Semaphore project and get group data.",
   "license": "MIT",
   "bin": {
@@ -23,7 +23,7 @@
     "node": ">=14.16"
   },
   "scripts": {
-    "start": "ts-node --esm src/index.ts",
+    "start": "node --loader ts-node/esm --no-warnings 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"
@@ -42,7 +42,7 @@
     "ts-node": "^10.9.1"
   },
   "dependencies": {
-    "@semaphore-protocol/data": "3.15.1",
+    "@semaphore-protocol/data": "4.0.0-alpha",
     "axios": "^1.3.2",
     "boxen": "^7.0.1",
     "chalk": "^5.1.2",

package/src/index.ts

@@ -1,11 +1,11 @@
 import { GroupResponse, SemaphoreEthers, SemaphoreSubgraph, getSupportedNetworks } from "@semaphore-protocol/data"
 import chalk from "chalk"
 import { program } from "commander"
+import decompress from "decompress"
 import figlet from "figlet"
-import { existsSync, readFileSync, unlinkSync, copyFileSync } from "fs"
+import { copyFileSync, existsSync, readFileSync, unlinkSync } from "fs"
 import logSymbols from "log-symbols"
 import pacote from "pacote"
-import decompress from "decompress"
 import { dirname } from "path"
 import { fileURLToPath } from "url"
 import checkLatestVersion from "./checkLatestVersion.js"
@@ -117,7 +117,7 @@ program
 
 program
     .command("get-groups")
-    .description("Get the list of groups from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the list of groups from a supported network (e.g. sepolia or arbitrum).")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
     .action(async ({ network }) => {
@@ -146,7 +146,7 @@ program
 
 program
     .command("get-group")
-    .description("Get the data of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the data of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -209,15 +209,14 @@ program
         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}`
+        content += `   Size: ${group.merkleTree.size}`
 
         console.info(`\n${content}\n`)
     })
 
 program
     .command("get-members")
-    .description("Get the members of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the members of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -283,7 +282,7 @@ program
 
 program
     .command("get-proofs")
-    .description("Get the proofs of a group from a supported network (e.g. goerli or arbitrum).")
+    .description("Get the proofs of a group from a supported network (e.g. sepolia or arbitrum).")
     .argument("[group-id]", "Identifier of the group.")
     .option("-n, --network <network-name>", "Supported Ethereum network.")
     .allowExcessArguments(false)
@@ -308,7 +307,7 @@ program
             groupId = await getGroupId(groupIds)
         }
 
-        let verifiedProofs: any[]
+        let validatedProofs: any[]
 
         const spinner = new Spinner(`Fetching proofs of group ${groupId}`)
 
@@ -317,15 +316,15 @@ program
         try {
             const semaphoreSubgraph = new SemaphoreSubgraph(network)
 
-            const group = await semaphoreSubgraph.getGroup(groupId, { verifiedProofs: true })
-            verifiedProofs = group.verifiedProofs
+            const group = await semaphoreSubgraph.getGroup(groupId, { validatedProofs: true })
+            validatedProofs = group.validatedProofs
 
             spinner.stop()
         } catch {
             try {
                 const semaphoreEthers = new SemaphoreEthers(network)
 
-                verifiedProofs = await semaphoreEthers.getGroupVerifiedProofs(groupId)
+                validatedProofs = await semaphoreEthers.getGroupValidatedProofs(groupId)
 
                 spinner.stop()
             } catch {
@@ -335,15 +334,17 @@ program
             }
         }
 
-        if (verifiedProofs.length === 0) {
+        if (validatedProofs.length === 0) {
             console.info(`\n ${logSymbols.info}`, "info: there are no proofs in this group\n")
             return
         }
 
-        const content = `${chalk.bold("Proofs")} (${verifiedProofs.length}): \n${verifiedProofs
+        const content = `${chalk.bold("Proofs")} (${validatedProofs.length}): \n${validatedProofs
             .map(
-                ({ signal, merkleTreeRoot, externalNullifier, nullifierHash }: any, i: number) =>
-                    `   ${i}. signal: ${signal} \n      merkleTreeRoot: ${merkleTreeRoot} \n      externalNullifier: ${externalNullifier} \n      nullifierHash: ${nullifierHash}`
+                ({ message, merkleTreeRoot, merkleTreeDepth, scope, nullifier, proof }: any, i: number) =>
+                    `   ${i}. message: ${message} \n      merkleTreeRoot: ${merkleTreeRoot} \n      merkleTreeDepth: ${merkleTreeDepth} \n      scope: ${scope} \n      nullifier: ${nullifier} \n      proof: [${proof.join(
+                        ", "
+                    )}]`
             )
             .join("\n")}`