chore: add semaphore-identity snark artifacts (#31)

privacy-scaling-explorations · May 14, 2024 · 4023ed5 · 4023ed5
1 parent 2248ff9
commit 4023ed5
Show file tree

Hide file tree

Showing 12 changed files with 2,485 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -44,35 +44,6 @@ Interested in contributing to this project? See the [board](https://github.com/o
     <th>Circuits</th>
     <th>JS library</th>
     <tbody>
-        <tr>
-            <td>
-                <a href="https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/eddsa">
-                    @zk-kit/eddsa-artifacts
-                </a>
-            </td>
-            <td>
-                <!-- NPM version -->
-                <a href="https://npmjs.org/package/@zk-kit/eddsa-artifacts">
-                    <img src="https://img.shields.io/npm/v/@zk-kit/eddsa-artifacts.svg?style=flat-square" alt="NPM version" />
-                </a>
-            </td>
-            <td>
-                <!-- Downloads -->
-                <a href="https://npmjs.org/package/@zk-kit/eddsa-artifacts">
-                    <img src="https://img.shields.io/npm/dm/@zk-kit/eddsa-artifacts.svg?style=flat-square" alt="Downloads" />
-                </a>
-            </td>
-            <td>
-                <a href="https://github.com/privacy-scaling-explorations/zk-kit/blob/main/packages/circuits/circom/eddsa-proof.circom">
-                    eddsa-proof.circom
-                </a>
-            </td>
-            <td>
-                <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-proof">
-                    @zk-kit/eddsa-proof
-                </a>
-            </td>
-        </tr>
         <tr>
             <td>
                 <a href="https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/poseidon">
@@ -131,6 +102,35 @@ Interested in contributing to this project? See the [board](https://github.com/o
                 </a>
             </td>
         </tr>
+        <tr>
+            <td>
+                <a href="https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/semaphore-identity">
+                    @zk-kit/semaphore-identity-artifacts
+                </a>
+            </td>
+            <td>
+                <!-- NPM version -->
+                <a href="https://npmjs.org/package/@zk-kit/semaphore-identity-artifacts">
+                    <img src="https://img.shields.io/npm/v/@zk-kit/semaphore-identity-artifacts.svg?style=flat-square" alt="NPM version" />
+                </a>
+            </td>
+            <td>
+                <!-- Downloads -->
+                <a href="https://npmjs.org/package/@zk-kit/semaphore-identity-artifacts">
+                    <img src="https://img.shields.io/npm/dm/@zk-kit/semaphore-identity-artifacts.svg?style=flat-square" alt="Downloads" />
+                </a>
+            </td>
+            <td>
+                <a href="https://github.com/semaphore-protocol/extensions/blob/main/packages/identity-proof.circom/src/identity-proof.circom">
+                    identity-proof.circom
+                </a>
+            </td>
+            <td>
+                <a href="https://github.com/semaphore-protocol/extensions/tree/main/packages/identity-proof">
+                    @semaphore-extensions/identity-proof
+                </a>
+            </td>
+        </tr>
     <tbody>
 </table>
 
@@ -152,6 +152,16 @@ You can also create [issue](https://github.com/privacy-scaling-explorations/snar
 
 For a more manageable clone that includes only the packages relevant to you or none of them, we use git's [`sparse-checkout`](https://git-scm.com/docs/git-sparse-checkout) and [`--filter`](https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---filterltfilter-specgt) features. This will reduce clone time and improve git performance.
 
+```bash
+git clone --sparse --filter=blob:none <forkedUrl>
+```
+
+And finally, if you need a specific package:
+
+```bash
+git sparse-checkout add packages/<package>
+```
+
 For convenience we provide an interactive [`setup`](https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/scripts/bin/setup) script.  
 It will ask you where to clone the repository, and what packages you want to sparse checkout.
 

diff --git a/packages/artifacts/package.json b/packages/artifacts/package.json
@@ -1,54 +1,54 @@
 {
-  "name": "@zk-kit/artifacts",
-  "version": "1.0.0",
-  "description": "Utilities for downloading snark artifacts",
-  "scripts": {
-    "build": "npm run clean && rollup -c rollup.config.ts --configPlugin typescript",
-    "clean": "rimraf dist"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/privacy-scaling-explorations/snark-artifacts.git"
-  },
-  "keywords": [
-    "snark",
-    "artifacts",
-    "circom",
-    "zk"
-  ],
-  "contributors": [
-    "cedoor <[email protected]>",
-    "sripwoud <[email protected]"
-  ],
-  "license": "AGPL-3.0",
-  "bugs": {
-    "url": "https://github.com/privacy-scaling-explorations/snark-artifacts/issues"
-  },
-  "homepage": "https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/artifacts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.esm.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "default": "./dist/index.esm.js",
-      "import": "./dist/index.esm.js",
-      "require": "./dist/index.cjs.js",
-      "types": "./dist/index.d.ts"
+    "name": "@zk-kit/artifacts",
+    "version": "1.1.0",
+    "description": "Utilities for downloading snark artifacts",
+    "scripts": {
+        "build": "npm run clean && rollup -c rollup.config.ts --configPlugin typescript",
+        "clean": "rimraf dist"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/privacy-scaling-explorations/snark-artifacts.git"
+    },
+    "keywords": [
+        "snark",
+        "artifacts",
+        "circom",
+        "zk"
+    ],
+    "contributors": [
+        "cedoor <[email protected]>",
+        "sripwoud <[email protected]"
+    ],
+    "license": "AGPL-3.0",
+    "bugs": {
+        "url": "https://github.com/privacy-scaling-explorations/snark-artifacts/issues"
+    },
+    "homepage": "https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/artifacts",
+    "publishConfig": {
+        "access": "public"
+    },
+    "main": "./dist/index.cjs.js",
+    "module": "./dist/index.esm.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "default": "./dist/index.esm.js",
+            "import": "./dist/index.esm.js",
+            "require": "./dist/index.cjs.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "devDependencies": {
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^11.1.6",
+        "@types/node": "^20.12.10",
+        "rimraf": "^5.0.5",
+        "rollup": "^2.79.1",
+        "tslib": "^2.6.2",
+        "typescript": "^5.4.5"
     }
-  },
-  "files": [
-    "dist"
-  ],
-  "devDependencies": {
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/node": "^20.12.10",
-    "rimraf": "^5.0.5",
-    "rollup": "^2.79.1",
-    "tslib": "^2.6.2",
-    "typescript": "^5.4.5"
-  }
 }
diff --git a/packages/artifacts/src/index.ts b/packages/artifacts/src/index.ts
@@ -1,6 +1,6 @@
 export enum Proof {
-  EDDSA = "eddsa",
-  POSEIDON = "poseidon",
-  //RLN = 'rln',
-  SEMAPHORE = "semaphore",
+    SEMAPHORE_IDENTITY = "semaphore-identity",
+    POSEIDON = "poseidon",
+    //RLN = 'rln',
+    SEMAPHORE = "semaphore"
 }
diff --git a/packages/eddsa/CHANGELOG.md b/packages/eddsa/CHANGELOG.md
diff --git a/packages/eddsa/README.md b/packages/eddsa/README.md
diff --git a/packages/eddsa/eddsa.zkey b/packages/eddsa/eddsa.zkey
diff --git a/packages/eddsa/package.json b/packages/eddsa/package.json
diff --git a/packages/semaphore-identity/README.md b/packages/semaphore-identity/README.md
@@ -0,0 +1,4 @@
+# [@zk-kit/semaphore-identity-artifacts](https://www.npmjs.com/package/@zk-kit/semaphore-identity-artifacts)
+
+* Circuits: [`identity-proof.circom`](https://github.com/semaphore-protocol/extensions/blob/main/packages/identity-proof.circom/src/identity-proof.circom)
+* JS library: [`@semaphore-extensions/identity-proof`](https://github.com/semaphore-protocol/extensions/tree/main/packages/identity-proof)
diff --git a/packages/semaphore-identity/package.json b/packages/semaphore-identity/package.json
@@ -0,0 +1,18 @@
+{
+    "name": "@zk-kit/semaphore-identity-artifacts",
+    "version": "1.0.0-beta",
+    "description": "semaphore identity artifacts",
+    "circuit": "@semaphore-extensions/identity-proof.circom",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/privacy-scaling-explorations/snark-artifacts.git"
+    },
+    "homepage": "https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/eddsa",
+    "bugs": {
+        "url": "https://github.com/privacy-scaling-explorations/snark-artifacts/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}
diff --git a/packages/eddsa/eddsa.wasm → ...emaphore-identity/semaphore-identity.wasm b/packages/eddsa/eddsa.wasm → ...emaphore-identity/semaphore-identity.wasm
diff --git a/packages/semaphore-identity/semaphore-identity.zkey b/packages/semaphore-identity/semaphore-identity.zkey