@semaphore-protocol/proof 2.3.1 → 2.4.0

package/README.md

@@ -6,11 +6,11 @@
 </p>
 
 <p align="center">
-    <a href="https://github.com/semaphore-protocol/semaphore.js">
-        <img src="https://img.shields.io/badge/project-semaphore.js-blue.svg?style=flat-square">
+    <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.js/blob/main/packages/proof/LICENSE">
-        <img alt="Github license" src="https://img.shields.io/github/license/semaphore-protocol/semaphore.js.svg?style=flat-square">
+    <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/proof">
         <img alt="NPM version" src="https://img.shields.io/npm/v/@semaphore-protocol/proof?style=flat-square" />
@@ -28,12 +28,20 @@
 
 <div align="center">
     <h4>
-        <a href="https://t.me/joinchat/B-PQx1U3GtAh--Z4Fwo56A">
-            🗣️ Chat &amp; Support
+        <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://semaphore-protocol.github.io/semaphore.js/proof">
-            📘 Docs
+        <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>
@@ -45,16 +53,16 @@
 
 ### npm or yarn
 
-Install the `@semaphore-protocol/proof` package with npm:
+Install the `@semaphore-protocol/proof` package and its peer dependencies with npm:
 
 ```bash
-npm i @semaphore-protocol/proof
+npm i @semaphore-protocol/identity @semaphore-protocol/group @semaphore-protocol/proof
 ```
 
 or yarn:
 
 ```bash
-yarn add @semaphore-protocol/proof
+yarn add @semaphore-protocol/identity @semaphore-protocol/group @semaphore-protocol/proof
 ```
 
 ## 📜 Usage

package/dist/index.mjs

@@ -1,10 +1,10 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 2.3.1
+ * @version 2.4.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/proof}
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof}
 */
 import { poseidon } from 'circomlibjs';
 import { groth16 } from 'snarkjs';

package/dist/index.node.js

@@ -1,10 +1,10 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 2.3.1
+ * @version 2.4.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/proof}
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof}
 */
 'use strict';
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/proof",
-    "version": "2.3.1",
+    "version": "2.4.0",
     "description": "A library to generate and verify Semaphore proofs.",
     "license": "MIT",
     "main": "dist/index.node.js",
@@ -15,8 +15,11 @@
         "LICENSE",
         "README.md"
     ],
-    "repository": "https://github.com/semaphore-protocol/semaphore.js",
-    "homepage": "https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/proof",
+    "repository": "https://github.com/semaphore-protocol/semaphore",
+    "homepage": "https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof",
+    "bugs": {
+        "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
+    },
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
@@ -27,18 +30,19 @@
         "access": "public"
     },
     "devDependencies": {
-        "download": "^8.0.0",
         "ffjavascript": "^0.2.54",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.31.2",
         "typedoc": "^0.22.11"
     },
+    "peerDependencies": {
+        "@semaphore-protocol/group": "2.4.0",
+        "@semaphore-protocol/identity": "2.4.0"
+    },
     "dependencies": {
         "@ethersproject/bytes": "^5.7.0",
         "@ethersproject/solidity": "^5.5.0",
         "@ethersproject/strings": "^5.5.0",
-        "@semaphore-protocol/group": "2.2.0",
-        "@semaphore-protocol/identity": "2.0.0",
         "@zk-kit/incremental-merkle-tree": "0.4.3",
         "circomlibjs": "0.0.8",
         "snarkjs": "^0.4.13"

package/src/index.test.ts

@@ -1,7 +1,6 @@
 import { formatBytes32String } from "@ethersproject/strings"
 import { Group } from "@semaphore-protocol/group"
 import { Identity } from "@semaphore-protocol/identity"
-import download from "download"
 import { getCurveFromName } from "ffjavascript"
 import fs from "fs"
 import generateNullifierHash from "./generateNullifierHash"
@@ -12,13 +11,14 @@ import { FullProof } from "./types"
 import verifyProof from "./verifyProof"
 
 describe("Proof", () => {
-    const treeDepth = 20
+    const treeDepth = Number(process.env.TREE_DEPTH) || 20
 
     const externalNullifier = "1"
     const signal = "0x111"
 
-    const snarkArtifactsPath = "./packages/proof/snark-artifacts"
-    const snarkArtifactsUrl = `http://www.trusted-setup-pse.org/semaphore/${treeDepth}`
+    const wasmFilePath = `./snark-artifacts/semaphore.wasm`
+    const zkeyFilePath = `./snark-artifacts/semaphore.zkey`
+    const verificationKeyPath = `./snark-artifacts/semaphore.json`
 
     const identity = new Identity()
     const identityCommitment = identity.generateCommitment()
@@ -28,17 +28,7 @@ describe("Proof", () => {
 
     beforeAll(async () => {
         curve = await getCurveFromName("bn128")
-
-        if (!fs.existsSync(snarkArtifactsPath)) {
-            fs.mkdirSync(snarkArtifactsPath)
-        }
-
-        if (!fs.existsSync(`${snarkArtifactsPath}/semaphore.zkey`)) {
-            await download(`${snarkArtifactsUrl}/semaphore.wasm`, snarkArtifactsPath)
-            await download(`${snarkArtifactsUrl}/semaphore.zkey`, snarkArtifactsPath)
-            await download(`${snarkArtifactsUrl}/semaphore.json`, snarkArtifactsPath)
-        }
-    }, 10000)
+    })
 
     afterAll(async () => {
         await curve.terminate()
@@ -52,8 +42,8 @@ describe("Proof", () => {
 
             const fun = () =>
                 generateProof(identity, group, externalNullifier, signal, {
-                    wasmFilePath: `${snarkArtifactsPath}/semaphore.wasm`,
-                    zkeyFilePath: `${snarkArtifactsPath}/semaphore.zkey`
+                    wasmFilePath,
+                    zkeyFilePath
                 })
 
             await expect(fun).rejects.toThrow("The identity is not part of the group")
@@ -75,8 +65,8 @@ describe("Proof", () => {
             group.addMembers([BigInt(1), BigInt(2), identityCommitment])
 
             fullProof = await generateProof(identity, group, externalNullifier, signal, {
-                wasmFilePath: `${snarkArtifactsPath}/semaphore.wasm`,
-                zkeyFilePath: `${snarkArtifactsPath}/semaphore.zkey`
+                wasmFilePath,
+                zkeyFilePath
             })
 
             expect(typeof fullProof).toBe("object")
@@ -90,8 +80,8 @@ describe("Proof", () => {
             group.addMembers([BigInt(1), BigInt(2), identityCommitment])
 
             fullProof = await generateProof(identity, group.generateProofOfMembership(2), externalNullifier, signal, {
-                wasmFilePath: `${snarkArtifactsPath}/semaphore.wasm`,
-                zkeyFilePath: `${snarkArtifactsPath}/semaphore.zkey`
+                wasmFilePath,
+                zkeyFilePath
             })
 
             expect(typeof fullProof).toBe("object")
@@ -132,7 +122,7 @@ describe("Proof", () => {
 
     describe("# verifyProof", () => {
         it("Should generate and verify a Semaphore proof", async () => {
-            const verificationKey = JSON.parse(fs.readFileSync(`${snarkArtifactsPath}/semaphore.json`, "utf-8"))
+            const verificationKey = JSON.parse(fs.readFileSync(verificationKeyPath, "utf-8"))
 
             const response = await verifyProof(verificationKey, fullProof)