feat(circuits): remove circomlib fork in favour of latest and zk-kit

Remove circomlib fork for poseidon decryption circuit, and use zk-kit instead. Also update circomlib to the latest version and use circomkit for circuits management and testing fix #772
privacy-scaling-explorations · Jan 14, 2024 · 334474c · 334474c
1 parent c2ee394
commit 334474c
Show file tree

Hide file tree

Showing 87 changed files with 1,051 additions and 739 deletions.
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -62,13 +62,24 @@ jobs:
           wget -qO /home/runner/work/maci/.local/bin/circom https://github.com/iden3/circom/releases/download/v2.1.6/circom-linux-amd64
           chmod +x /home/runner/work/maci/.local/bin/circom
 
-      - name: Generate zkeys
+      - name: Create zkeys folder
         run: |
           cd cli
           mkdir -p zkeys
+
+      - name: Compile Circuits And Generate zkeys
+        run: |
+          cd circuits
+          export PATH=$PATH:/home/runner/work/maci/.local/bin
+          pnpm build-test-circuits-c
+          ls build
+          mv ../build/test/* ../cli/zkeys/
+          cd ../cli
           wget -qO zkeys/powersOfTau28_hez_final_20.ptau https://maci-devops-zkeys.s3.ap-northeast-2.amazonaws.com/powersOfTau28_hez_final_20.ptau
-          pnpm exec zkey-manager compile -c ./zkeys.config.yml
-          pnpm exec zkey-manager genZkeys -c ./zkeys.config.yml
+          ls ./zkeys
+          pnpm snarkjs groth16 setup ./zkeys/ProcessMessages_10-2-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/ProcessMessages_10-2-1-2_test.0.zkey
+          pnpm snarkjs groth16 setup ./zkeys/TallyVotes_10-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/TallyVotes_10-1-2_test.0.zkey
+          pnpm snarkjs groth16 setup ./zkeys/SubsidyPerBatch_10-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/SubsidyPerBatch_10-1-2_test.0.zkey
 
       - name: ${{ matrix.command }}
         run: pnpm run ${{ matrix.command }}

diff --git a/.github/workflows/reusable-e2e.yml b/.github/workflows/reusable-e2e.yml
@@ -79,14 +79,26 @@ jobs:
           wget -qO /home/runner/work/maci/.local/bin/circom https://github.com/iden3/circom/releases/download/v2.1.6/circom-linux-amd64
           chmod +x /home/runner/work/maci/.local/bin/circom
 
-      - name: Generate zkeys
+      - name: Create zkeys folder
         if: ${{ env.CHANGED == 'true' }}
         run: |
           cd cli
           mkdir -p zkeys
+
+      - name: Compile Circuits And Generate zkeys
+        if: ${{ env.CHANGED == 'true' }}
+        run: |
+          cd circuits
+          export PATH=$PATH:/home/runner/work/maci/.local/bin
+          pnpm build-test-circuits-c
+          ls build
+          mv ../build/test/* ../cli/zkeys/
+          cd ../cli
           wget -qO zkeys/powersOfTau28_hez_final_20.ptau https://maci-devops-zkeys.s3.ap-northeast-2.amazonaws.com/powersOfTau28_hez_final_20.ptau
-          pnpm exec zkey-manager compile -c ./zkeys.config.yml
-          pnpm exec zkey-manager genZkeys -c ./zkeys.config.yml
+          ls ./zkeys
+          pnpm snarkjs groth16 setup ./zkeys/ProcessMessages_10-2-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/ProcessMessages_10-2-1-2_test.0.zkey
+          pnpm snarkjs groth16 setup ./zkeys/TallyVotes_10-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/TallyVotes_10-1-2_test.0.zkey
+          pnpm snarkjs groth16 setup ./zkeys/SubsidyPerBatch_10-1-2_test.r1cs ./zkeys/powersOfTau28_hez_final_20.ptau ./zkeys/SubsidyPerBatch_10-1-2_test.0.zkey
 
       - name: Download zkeys
         if: ${{ env.CHANGED == 'false' }}

diff --git a/.gitignore b/.gitignore
@@ -149,6 +149,8 @@ cli/tallyinput.json
 cli/contractAddresses.json
 cli/contractAddresses.old.json
 
+circuits/circom/test
+
 # mdBook rendered files
 publish
 

diff --git a/circuits/circom/circuits.json b/circuits/circom/circuits.json
@@ -0,0 +1,32 @@
+{
+  "processMessages": {
+    "file": "processMessages",
+    "template": "ProcessMessages",
+    "params": [6, 8, 2, 3],
+    "pubs": ["inputHash"]
+  },
+  "ProcessMessages_10-2-1-2_test": {
+    "file": "processMessages",
+    "template": "ProcessMessages",
+    "params": [10, 2, 1, 2],
+    "pubs": ["inputHash"]
+  },
+  "tallyVotes": {
+    "file": "tallyVotes",
+    "template": "TallyVotes",
+    "params": [6, 2, 3],
+    "pubs": ["inputHash"]
+  },
+  "TallyVotes_10-1-2_test": {
+    "file": "tallyVotes",
+    "template": "TallyVotes",
+    "params": [10, 1, 2],
+    "pubs": ["inputHash"]
+  },
+  "SubsidyPerBatch_10-1-2_test": {
+    "file": "subsidy",
+    "template": "SubsidyPerBatch",
+    "params": [10, 1, 2],
+    "pubs": ["inputHash"]
+  }
+}
diff --git a/circuits/circom/ecdh.circom b/circuits/circom/ecdh.circom
@@ -1,6 +1,8 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/bitify.circom";
-include "../node_modules/circomlib/circuits/escalarmulany.circom";
+
+// circomlib imports
+include "./bitify.circom";
+include "./escalarmulany.circom";
 
 template Ecdh() {
     // Note: the private key needs to be hashed and pruned first

diff --git a/circuits/circom/float.circom b/circuits/circom/float.circom
@@ -1,7 +1,9 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/bitify.circom";
-include "../node_modules/circomlib/circuits/comparators.circom";
-include "../node_modules/circomlib/circuits/mux1.circom";
+
+// circomlib imports
+include "./bitify.circom";
+include "./comparators.circom";
+include "./mux1.circom";
 
 template msb(n) {
     // require in < 2**n 

diff --git a/circuits/circom/hasherPoseidon.circom b/circuits/circom/hasherPoseidon.circom
@@ -1,4 +1,6 @@
 pragma circom 2.0.0;
+
+// local imports
 include "./poseidon/poseidonHashT3.circom";
 include "./poseidon/poseidonHashT4.circom";
 include "./poseidon/poseidonHashT5.circom";

diff --git a/circuits/circom/hasherSha256.circom b/circuits/circom/hasherSha256.circom
@@ -1,6 +1,8 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/sha256/sha256.circom"; 
-include "../node_modules/circomlib/circuits/bitify.circom"; 
+
+// circomlib imports
+include "./sha256/sha256.circom"; 
+include "./bitify.circom"; 
 
 template Sha256HashLeftRight() {
     signal input left;

diff --git a/circuits/circom/messageHasher.circom b/circuits/circom/messageHasher.circom
@@ -1,4 +1,6 @@
 pragma circom 2.0.0;
+
+// local import
 include "./hasherPoseidon.circom";
 
 // hash a MACI message together with the public key

diff --git a/circuits/circom/messageToCommand.circom b/circuits/circom/messageToCommand.circom
@@ -1,8 +1,13 @@
 pragma circom 2.0.0;
+
+// circomlib import
+include "./bitify.circom";
+// @zk-kit import
+include "./poseidon-cipher.circom";
+
+// local imports
 include "./ecdh.circom";
 include "./unpackElement.circom";
-include "../node_modules/circomlib/circuits/bitify.circom";
-include "../node_modules/circomlib/circuits/poseidon.circom";
 
 // template that converts a MACI message
 // to a command (decrypts it)

diff --git a/circuits/circom/messageValidator.circom b/circuits/circom/messageValidator.circom
@@ -1,4 +1,6 @@
 pragma circom 2.0.0;
+
+// local imports
 include "./verifySignature.circom";
 include "./utils.circom";
 

diff --git a/circuits/circom/poseidon/poseidon.circom b/circuits/circom/poseidon/poseidon.circom
@@ -0,0 +1,16 @@
+pragma circom 2.0.0;
+
+// https://github.com/weijiekoh/circomlib/blob/feat/poseidon-encryption/circuits/poseidon.circom
+include "./poseidon-cipher.circom";
+
+template Poseidon_OLD(nInputs) {
+    signal input inputs[nInputs];
+    signal output out;
+
+    component strategy = PoseidonPerm(nInputs + 1);
+    strategy.inputs[0] <== 0;
+    for (var i = 0; i < nInputs; i++) {
+        strategy.inputs[i + 1] <== inputs[i];
+    }
+    out <== strategy.out[0];
+}
diff --git a/circuits/circom/poseidon/poseidonHashT3.circom b/circuits/circom/poseidon/poseidonHashT3.circom
@@ -1,12 +1,13 @@
 pragma circom 2.0.0;
-include "../../node_modules/circomlib/circuits/poseidon.circom";
+
+include "./poseidon.circom";
 
 template PoseidonHashT3() {
     var nInputs = 2;
     signal input inputs[nInputs];
     signal output out;
 
-    component hasher = Poseidon(nInputs);
+    component hasher = Poseidon_OLD(nInputs);
     for (var i = 0; i < nInputs; i ++) {
         hasher.inputs[i] <== inputs[i];
     }

diff --git a/circuits/circom/poseidon/poseidonHashT4.circom b/circuits/circom/poseidon/poseidonHashT4.circom
@@ -1,12 +1,13 @@
 pragma circom 2.0.0;
-include "../../node_modules/circomlib/circuits/poseidon.circom";
+
+include "./poseidon.circom";
 
 template PoseidonHashT4() {
     var nInputs = 3;
     signal input inputs[nInputs];
     signal output out;
 
-    component hasher = Poseidon(nInputs);
+    component hasher = Poseidon_OLD(nInputs);
     for (var i = 0; i < nInputs; i ++) {
         hasher.inputs[i] <== inputs[i];
     }

diff --git a/circuits/circom/poseidon/poseidonHashT5.circom b/circuits/circom/poseidon/poseidonHashT5.circom
@@ -1,12 +1,13 @@
 pragma circom 2.0.0;
-include "../../node_modules/circomlib/circuits/poseidon.circom";
+
+include "./poseidon.circom";
 
 template PoseidonHashT5() {
     var nInputs = 4;
     signal input inputs[nInputs];
     signal output out;
 
-    component hasher = Poseidon(nInputs);
+    component hasher = Poseidon_OLD(nInputs);
     for (var i = 0; i < nInputs; i ++) {
         hasher.inputs[i] <== inputs[i];
     }

diff --git a/circuits/circom/poseidon/poseidonHashT6.circom b/circuits/circom/poseidon/poseidonHashT6.circom
@@ -1,12 +1,13 @@
 pragma circom 2.0.0;
-include "../../node_modules/circomlib/circuits/poseidon.circom";
+
+include "./poseidon.circom";
 
 template PoseidonHashT6() {
     var nInputs = 5;
     signal input inputs[nInputs];
     signal output out;
 
-    component hasher = Poseidon(nInputs);
+    component hasher = Poseidon_OLD(nInputs);
     for (var i = 0; i < nInputs; i ++) {
         hasher.inputs[i] <== inputs[i];
     }

diff --git a/circuits/circom/privToPubKey.circom b/circuits/circom/privToPubKey.circom
@@ -1,6 +1,8 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/bitify.circom";
-include "../node_modules/circomlib/circuits/escalarmulfix.circom";
+
+// circomlib imports
+include "./bitify.circom";
+include "./escalarmulfix.circom";
 
 // convert a private key to a public key
 // @note the basepoint is the base point of the baby jubjub curve

diff --git a/circuits/circom/processMessages.circom b/circuits/circom/processMessages.circom
@@ -1,11 +1,15 @@
 pragma circom 2.0.0;
+
+// circomlib import
+include "./mux1.circom";
+
+// local imports
 include "./hasherSha256.circom";
 include "./messageHasher.circom";
 include "./messageToCommand.circom";
 include "./privToPubKey.circom";
 include "./stateLeafAndBallotTransformer.circom";
 include "./trees/incrementalQuinTree.circom";
-include "../node_modules/circomlib/circuits/mux1.circom";
 include "./utils.circom";
 
 // Proves the correctness of processing a batch of messages.

diff --git a/circuits/circom/stateLeafAndBallotTransformer.circom b/circuits/circom/stateLeafAndBallotTransformer.circom
@@ -1,6 +1,10 @@
 pragma circom 2.0.0;
+
+// circomlib import
+include "./mux1.circom";
+
+// local import
 include "./messageValidator.circom";
-include "../node_modules/circomlib/circuits/mux1.circom";
 
 // Apply a command to a state leaf and ballot.
 template StateLeafAndBallotTransformer() {

diff --git a/circuits/circom/subsidy.circom b/circuits/circom/subsidy.circom
@@ -1,12 +1,15 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/comparators.circom";
+
+// circomlib import
+include "./comparators.circom";
+
+// local imports
 include "./trees/incrementalQuinTree.circom";
 include "./trees/calculateTotal.circom";
 include "./trees/checkRoot.circom";
 include "./hasherSha256.circom";
 include "./hasherPoseidon.circom";
 include "./unpackElement.circom";
-
 include "./float.circom";
 
 /*

diff --git a/circuits/circom/tallyVotes.circom b/circuits/circom/tallyVotes.circom
@@ -1,5 +1,9 @@
 pragma circom 2.0.0;
-include "../node_modules/circomlib/circuits/comparators.circom";
+
+// circomlib import
+include "./comparators.circom";
+
+// local imports
 include "./trees/incrementalQuinTree.circom";
 include "./trees/calculateTotal.circom";
 include "./trees/checkRoot.circom";

diff --git a/...s/circom/test/processMessages_test.circom → ...test/ProcessMessages_10-2-1-2_test.circom b/...s/circom/test/processMessages_test.circom → ...test/ProcessMessages_10-2-1-2_test.circom
@@ -1,5 +1,7 @@
 pragma circom 2.0.0;
+
 include "../processMessages.circom";
+
 /*
 stateTreeDepth,
 msgTreeDepth,

diff --git a/circuits/circom/test/SubsidyPerBatch_10-1-2_test.circom b/circuits/circom/test/SubsidyPerBatch_10-1-2_test.circom
@@ -0,0 +1,5 @@
+pragma circom 2.0.0;
+
+include "../subsidy.circom";
+
+component main {public [inputHash]} = SubsidyPerBatch(10, 1, 2);
diff --git a/circuits/circom/test/tallyVotes_test.circom → ...circom/test/TallyVotes_10-1-2_test.circom b/circuits/circom/test/tallyVotes_test.circom → ...circom/test/TallyVotes_10-1-2_test.circom
@@ -1,7 +1,5 @@
 pragma circom 2.0.0;
+
 include "../tallyVotes.circom";
 
 component main {public [inputHash]} = TallyVotes(10, 1, 2);
-/*stateTreeDepth,*/
-/*intStateTreeDepth,*/
-/*voteOptionTreeDepth*/
diff --git a/circuits/circom/test/calculateTotal_test.circom b/circuits/circom/test/calculateTotal_test.circom
diff --git a/circuits/circom/test/ceremonyParams/processMessages_test.circom b/circuits/circom/test/ceremonyParams/processMessages_test.circom
diff --git a/circuits/circom/test/ceremonyParams/tallyVotes_test.circom b/circuits/circom/test/ceremonyParams/tallyVotes_test.circom
diff --git a/circuits/circom/test/ecdh_test.circom b/circuits/circom/test/ecdh_test.circom
diff --git a/circuits/circom/test/hasher13_test.circom b/circuits/circom/test/hasher13_test.circom
diff --git a/circuits/circom/test/hasher3_test.circom b/circuits/circom/test/hasher3_test.circom
diff --git a/circuits/circom/test/hasher4_test.circom b/circuits/circom/test/hasher4_test.circom
diff --git a/circuits/circom/test/hasher5_test.circom b/circuits/circom/test/hasher5_test.circom
diff --git a/circuits/circom/test/hashleftright_test.circom b/circuits/circom/test/hashleftright_test.circom