Challenge zk voting (#376)

* changes regarding grader, verifier contract, etc.

* adapt readme to changes for grader

Author: phipsae

README.md

@@ -161,6 +161,8 @@ Our contract will support three main functions:
 🔍 Open it up and check out the placeholder functions. Each of them represents a key piece of the voting logic.
 If you can already explain what they’re supposed to do, you’re ahead of the game! 😎
 
+💡 The `Verifier.sol` contract is currently just a placeholder and will be replaced with the actual implementation later.
+
 But this time you won’t just be working on the smart contract **🙂**
 
 ### **🥅 Goals**
@@ -943,7 +945,7 @@ You’ve built the circuit, created the verifier contract — now it’s time to
 
 ### 🔹 Step 1: Bring in the Verifier Contract
 
-1. Copy your verifier contract into **`packages/hardhat/contracts`**.
+1. Replace the placeholder verifier contract **`Verifier.sol`** in **`packages/hardhat/contracts`** with the newly generated contract located in **`packages/circuits/target`**.
 2. Open **`00_deploy_your_voting_contract.ts`** and:
    - Uncomment the verifier deployment
    - Comment out the `verifierAddress`
@@ -982,8 +984,6 @@ That’s why **nullifiers are the cornerstone** of privacy-preserving voting.
 - Increment `s_yesVotes` or `s_noVotes` accordingly
 - Emit the `VoteCast` event
 
-> 🚨⚠️ Go to packages/hardhat/contracts/mocks and uncomment all the code. This enables the mock contracts needed for local testing and verification.
-
 <details>
 <summary>🦉 Guiding Questions</summary>
 
@@ -1714,8 +1714,8 @@ const voteOnSepolia = async ({
     functionName: "vote",
     args: [
       toHex(proofData.proof),
-      proofData.publicInputs[0], // _root
-      proofData.publicInputs[1], // _nullifierHash
+      proofData.publicInputs[0], // _nullifierHash
+      proofData.publicInputs[1], // _root
       proofData.publicInputs[2], // _vote
       proofData.publicInputs[3], // _depth
     ],

extension/README.md.args.mjs

@@ -163,6 +163,8 @@ Our contract will support three main functions:
 🔍 Open it up and check out the placeholder functions. Each of them represents a key piece of the voting logic.
 If you can already explain what they’re supposed to do, you’re ahead of the game! 😎
 
+💡 The \`Verifier.sol\` contract is currently just a placeholder and will be replaced with the actual implementation later.
+
 But this time you won’t just be working on the smart contract **🙂**
 
 ### **🥅 Goals**
@@ -948,7 +950,7 @@ You’ve built the circuit, created the verifier contract — now it’s time to
 
 ### 🔹 Step 1: Bring in the Verifier Contract
 
-1. Copy your verifier contract into **\`packages/hardhat/contracts\`**.
+1. Replace the placeholder verifier contract **\`Verifier.sol\`** in **\`packages/hardhat/contracts\`** with the newly generated contract located in **\`packages/circuits/target\`**.
 2. Open **\`00_deploy_your_voting_contract.ts\`** and:
    - Uncomment the verifier deployment
    - Comment out the \`verifierAddress\`
@@ -987,8 +989,6 @@ That’s why **nullifiers are the cornerstone** of privacy-preserving voting.
 - Increment \`s_yesVotes\` or \`s_noVotes\` accordingly
 - Emit the \`VoteCast\` event
 
-> 🚨⚠️ Go to packages/hardhat/contracts/mocks and uncomment all the code. This enables the mock contracts needed for local testing and verification.
-
 <details>
 <summary>🦉 Guiding Questions</summary>
 
@@ -1075,16 +1075,6 @@ function vote(bytes memory _proof, bytes32 _nullifierHash, bytes32 _root, bytes3
 
     emit VoteCast(_nullifierHash, msg.sender, _vote == bytes32(uint256(1)), block.timestamp, s_yesVotes, s_noVotes);
 }
-
-emit VoteCast(
-    _nullifierHash,
-    msg.sender,
-    _vote == bytes32(uint256(1)),
-    block.timestamp,
-    s_yesVotes,
-    s_noVotes
-);
-}
 \`\`\`
 
 </details>
@@ -1729,8 +1719,8 @@ const voteOnSepolia = async ({
     functionName: "vote",
     args: [
       toHex(proofData.proof),
-      proofData.publicInputs[0], // _root
-      proofData.publicInputs[1], // _nullifierHash
+      proofData.publicInputs[0], //  _nullifierHash
+      proofData.publicInputs[1], // _root
       proofData.publicInputs[2], // _vote
       proofData.publicInputs[3], // _depth
     ],

extension/packages/hardhat/contracts/Verifier.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.27;
+
+interface IVerifier {
+    function verify(bytes calldata _proof, bytes32[] calldata _publicInputs) external view returns (bool);
+}

extension/packages/hardhat/contracts/mocks/VerifierMock.sol

@@ -2,50 +2,50 @@
 pragma solidity >=0.8.0 <0.9.0;
 
 /// Checkpoint 6 //////
-// import {IVerifier} from "../Verifier.sol";
+import {IVerifier} from "../Verifier.sol";
 
-// contract VerifierMock is IVerifier {
-//     bool public shouldVerify = true;
+contract VerifierMock is IVerifier {
+    bool public shouldVerify = true;
 
-//     // Optional: enforce an exact public inputs set and order for tests
-//     bool public enforceExpectedInputs;
-//     bytes32 public expectedNullifier;
-//     bytes32 public expectedRoot;
-//     bytes32 public expectedVote;
-//     bytes32 public expectedDepth;
+    // Optional: enforce an exact public inputs set and order for tests
+    bool public enforceExpectedInputs;
+    bytes32 public expectedNullifier;
+    bytes32 public expectedRoot;
+    bytes32 public expectedVote;
+    bytes32 public expectedDepth;
 
-//     function setShouldVerify(bool _shouldVerify) external {
-//         shouldVerify = _shouldVerify;
-//     }
+    function setShouldVerify(bool _shouldVerify) external {
+        shouldVerify = _shouldVerify;
+    }
 
-//     function setExpectedInputs(bytes32 _nullifier, bytes32 _root, bytes32 _vote, bytes32 _depth) external {
-//         enforceExpectedInputs = true;
-//         expectedNullifier = _nullifier;
-//         expectedRoot = _root;
-//         expectedVote = _vote;
-//         expectedDepth = _depth;
-//     }
+    function setExpectedInputs(bytes32 _nullifier, bytes32 _root, bytes32 _vote, bytes32 _depth) external {
+        enforceExpectedInputs = true;
+        expectedNullifier = _nullifier;
+        expectedRoot = _root;
+        expectedVote = _vote;
+        expectedDepth = _depth;
+    }
 
-//     function clearExpectedInputs() external {
-//         enforceExpectedInputs = false;
-//         expectedNullifier = 0x0;
-//         expectedRoot = 0x0;
-//         expectedVote = 0x0;
-//         expectedDepth = 0x0;
-//     }
+    function clearExpectedInputs() external {
+        enforceExpectedInputs = false;
+        expectedNullifier = 0x0;
+        expectedRoot = 0x0;
+        expectedVote = 0x0;
+        expectedDepth = 0x0;
+    }
 
-//     function verify(bytes calldata, bytes32[] calldata _publicInputs) external view returns (bool) {
-//         if (!shouldVerify) {
-//             return false;
-//         }
-//         if (enforceExpectedInputs) {
-//             if (
-//                 _publicInputs.length != 4 || _publicInputs[0] != expectedNullifier || _publicInputs[1] != expectedRoot
-//                     || _publicInputs[2] != expectedVote || _publicInputs[3] != expectedDepth
-//             ) {
-//                 return false;
-//             }
-//         }
-//         return true;
-//     }
-// }
+    function verify(bytes calldata, bytes32[] calldata _publicInputs) external view returns (bool) {
+        if (!shouldVerify) {
+            return false;
+        }
+        if (enforceExpectedInputs) {
+            if (
+                _publicInputs.length != 4 || _publicInputs[0] != expectedNullifier || _publicInputs[1] != expectedRoot
+                    || _publicInputs[2] != expectedVote || _publicInputs[3] != expectedDepth
+            ) {
+                return false;
+            }
+        }
+        return true;
+    }
+}

extension/packages/hardhat/hardhat.config.ts.args.mjs

@@ -13,4 +13,9 @@ export const configOverrides = {
       },
     ],
   },
+  networks: {
+    hardhat: {
+      allowUnlimitedContractSize: true,
+    },
+  },
 };