@semaphore-protocol/contracts 0.1.0 → 2.1.0

package/interfaces/ISemaphoreNullifiers.sol

@@ -1,14 +1,14 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.4;
+pragma solidity 0.8.4;
 
 /// @title SemaphoreNullifiers interface.
 /// @dev Interface of SemaphoreNullifiers contract.
 interface ISemaphoreNullifiers {
-  /// @dev Emitted when a external nullifier is added.
-  /// @param externalNullifier: External Semaphore nullifier.
-  event ExternalNullifierAdded(uint256 externalNullifier);
+    /// @dev Emitted when a external nullifier is added.
+    /// @param externalNullifier: External Semaphore nullifier.
+    event ExternalNullifierAdded(uint256 externalNullifier);
 
-  /// @dev Emitted when a external nullifier is removed.
-  /// @param externalNullifier: External Semaphore nullifier.
-  event ExternalNullifierRemoved(uint256 externalNullifier);
+    /// @dev Emitted when a external nullifier is removed.
+    /// @param externalNullifier: External Semaphore nullifier.
+    event ExternalNullifierRemoved(uint256 externalNullifier);
 }

package/interfaces/ISemaphoreVoting.sol

@@ -1,76 +1,86 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.4;
+pragma solidity 0.8.4;
 
 /// @title SemaphoreVoting interface.
 /// @dev Interface of SemaphoreVoting contract.
 interface ISemaphoreVoting {
-  enum PollState {
-    Created,
-    Ongoing,
-    Ended
-  }
+    error Semaphore__CallerIsNotThePollCoordinator();
+    error Semaphore__MerkleTreeDepthIsNotSupported();
+    error Semaphore__PollHasAlreadyBeenStarted();
+    error Semaphore__PollIsNotOngoing();
 
-  struct Poll {
-    address coordinator;
-    PollState state;
-  }
+    enum PollState {
+        Created,
+        Ongoing,
+        Ended
+    }
 
-  /// @dev Emitted when a new poll is created.
-  /// @param pollId: Id of the poll.
-  /// @param coordinator: Coordinator of the poll.
-  event PollCreated(uint256 pollId, address indexed coordinator);
+    struct Verifier {
+        address contractAddress;
+        uint256 merkleTreeDepth;
+    }
 
-  /// @dev Emitted when a poll is started.
-  /// @param pollId: Id of the poll.
-  /// @param coordinator: Coordinator of the poll.
-  /// @param encryptionKey: Key to encrypt the poll votes.
-  event PollStarted(uint256 pollId, address indexed coordinator, uint256 encryptionKey);
+    struct Poll {
+        address coordinator;
+        PollState state;
+    }
 
-  /// @dev Emitted when a user votes on a poll.
-  /// @param pollId: Id of the poll.
-  /// @param vote: User encrypted vote.
-  event VoteAdded(uint256 indexed pollId, bytes32 vote);
+    /// @dev Emitted when a new poll is created.
+    /// @param pollId: Id of the poll.
+    /// @param coordinator: Coordinator of the poll.
+    event PollCreated(uint256 pollId, address indexed coordinator);
 
-  /// @dev Emitted when a poll is ended.
-  /// @param pollId: Id of the poll.
-  /// @param coordinator: Coordinator of the poll.
-  /// @param decryptionKey: Key to decrypt the poll votes.
-  event PollEnded(uint256 pollId, address indexed coordinator, uint256 decryptionKey);
+    /// @dev Emitted when a poll is started.
+    /// @param pollId: Id of the poll.
+    /// @param coordinator: Coordinator of the poll.
+    /// @param encryptionKey: Key to encrypt the poll votes.
+    event PollStarted(uint256 pollId, address indexed coordinator, uint256 encryptionKey);
 
-  /// @dev Creates a poll and the associated Merkle tree/group.
-  /// @param pollId: Id of the poll.
-  /// @param coordinator: Coordinator of the poll.
-  /// @param depth: Depth of the tree.
-  function createPoll(
-    uint256 pollId,
-    address coordinator,
-    uint8 depth
-  ) external;
+    /// @dev Emitted when a user votes on a poll.
+    /// @param pollId: Id of the poll.
+    /// @param vote: User encrypted vote.
+    event VoteAdded(uint256 indexed pollId, bytes32 vote);
 
-  /// @dev Adds a voter to a poll.
-  /// @param pollId: Id of the poll.
-  /// @param identityCommitment: Identity commitment of the group member.
-  function addVoter(uint256 pollId, uint256 identityCommitment) external;
+    /// @dev Emitted when a poll is ended.
+    /// @param pollId: Id of the poll.
+    /// @param coordinator: Coordinator of the poll.
+    /// @param decryptionKey: Key to decrypt the poll votes.
+    event PollEnded(uint256 pollId, address indexed coordinator, uint256 decryptionKey);
 
-  /// @dev Starts a pull and publishes the key to encrypt the votes.
-  /// @param pollId: Id of the poll.
-  /// @param encryptionKey: Key to encrypt poll votes.
-  function startPoll(uint256 pollId, uint256 encryptionKey) external;
+    /// @dev Creates a poll and the associated Merkle tree/group.
+    /// @param pollId: Id of the poll.
+    /// @param coordinator: Coordinator of the poll.
+    /// @param merkleTreeDepth: Depth of the tree.
+    function createPoll(
+        uint256 pollId,
+        address coordinator,
+        uint256 merkleTreeDepth
+    ) external;
 
-  /// @dev Casts an anonymous vote in a poll.
-  /// @param vote: Encrypted vote.
-  /// @param nullifierHash: Nullifier hash.
-  /// @param pollId: Id of the poll.
-  /// @param proof: Private zk-proof parameters.
-  function castVote(
-    bytes32 vote,
-    uint256 nullifierHash,
-    uint256 pollId,
-    uint256[8] calldata proof
-  ) external;
+    /// @dev Adds a voter to a poll.
+    /// @param pollId: Id of the poll.
+    /// @param identityCommitment: Identity commitment of the group member.
+    function addVoter(uint256 pollId, uint256 identityCommitment) external;
 
-  /// @dev Ends a pull and publishes the key to decrypt the votes.
-  /// @param pollId: Id of the poll.
-  /// @param decryptionKey: Key to decrypt poll votes.
-  function endPoll(uint256 pollId, uint256 decryptionKey) external;
+    /// @dev Starts a pull and publishes the key to encrypt the votes.
+    /// @param pollId: Id of the poll.
+    /// @param encryptionKey: Key to encrypt poll votes.
+    function startPoll(uint256 pollId, uint256 encryptionKey) external;
+
+    /// @dev Casts an anonymous vote in a poll.
+    /// @param vote: Encrypted vote.
+    /// @param nullifierHash: Nullifier hash.
+    /// @param pollId: Id of the poll.
+    /// @param proof: Private zk-proof parameters.
+    function castVote(
+        bytes32 vote,
+        uint256 nullifierHash,
+        uint256 pollId,
+        uint256[8] calldata proof
+    ) external;
+
+    /// @dev Ends a pull and publishes the key to decrypt the votes.
+    /// @param pollId: Id of the poll.
+    /// @param decryptionKey: Key to decrypt poll votes.
+    function endPoll(uint256 pollId, uint256 decryptionKey) external;
 }

package/interfaces/ISemaphoreWhistleblowing.sol

@@ -1,55 +1,63 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.4;
+pragma solidity 0.8.4;
 
 /// @title SemaphoreWhistleblowing interface.
 /// @dev Interface of SemaphoreWhistleblowing contract.
 interface ISemaphoreWhistleblowing {
-  /// @dev Emitted when a new entity is created.
-  /// @param entityId: Id of the entity.
-  /// @param editor: Editor of the entity.
-  event EntityCreated(uint256 entityId, address indexed editor);
-
-  /// @dev Emitted when a whistleblower publish a new leak.
-  /// @param entityId: Id of the entity.
-  /// @param leak: News leak.
-  event LeakPublished(uint256 indexed entityId, bytes32 leak);
-
-  /// @dev Creates an entity and the associated Merkle tree/group.
-  /// @param entityId: Id of the entity.
-  /// @param editor: Editor of the entity.
-  /// @param depth: Depth of the tree.
-  function createEntity(
-    uint256 entityId,
-    address editor,
-    uint8 depth
-  ) external;
-
-  /// @dev Adds a whistleblower to an entity.
-  /// @param entityId: Id of the entity.
-  /// @param identityCommitment: Identity commitment of the group member.
-  function addWhistleblower(uint256 entityId, uint256 identityCommitment) external;
-
-  /// @dev Removes a whistleblower from an entity.
-  /// @param entityId: Id of the entity.
-  /// @param identityCommitment: Identity commitment of the group member.
-  /// @param proofSiblings: Array of the sibling nodes of the proof of membership.
-  /// @param proofPathIndices: Path of the proof of membership.
-  function removeWhistleblower(
-    uint256 entityId,
-    uint256 identityCommitment,
-    uint256[] calldata proofSiblings,
-    uint8[] calldata proofPathIndices
-  ) external;
-
-  /// @dev Allows whistleblowers to publish leaks anonymously.
-  /// @param leak: News leak.
-  /// @param nullifierHash: Nullifier hash.
-  /// @param entityId: Id of the entity.
-  /// @param proof: Private zk-proof parameters.
-  function publishLeak(
-    bytes32 leak,
-    uint256 nullifierHash,
-    uint256 entityId,
-    uint256[8] calldata proof
-  ) external;
+    error Semaphore__CallerIsNotTheEditor();
+    error Semaphore__MerkleTreeDepthIsNotSupported();
+
+    struct Verifier {
+        address contractAddress;
+        uint256 merkleTreeDepth;
+    }
+
+    /// @dev Emitted when a new entity is created.
+    /// @param entityId: Id of the entity.
+    /// @param editor: Editor of the entity.
+    event EntityCreated(uint256 entityId, address indexed editor);
+
+    /// @dev Emitted when a whistleblower publish a new leak.
+    /// @param entityId: Id of the entity.
+    /// @param leak: News leak.
+    event LeakPublished(uint256 indexed entityId, bytes32 leak);
+
+    /// @dev Creates an entity and the associated Merkle tree/group.
+    /// @param entityId: Id of the entity.
+    /// @param editor: Editor of the entity.
+    /// @param merkleTreeDepth: Depth of the tree.
+    function createEntity(
+        uint256 entityId,
+        address editor,
+        uint256 merkleTreeDepth
+    ) external;
+
+    /// @dev Adds a whistleblower to an entity.
+    /// @param entityId: Id of the entity.
+    /// @param identityCommitment: Identity commitment of the group member.
+    function addWhistleblower(uint256 entityId, uint256 identityCommitment) external;
+
+    /// @dev Removes a whistleblower from an entity.
+    /// @param entityId: Id of the entity.
+    /// @param identityCommitment: Identity commitment of the group member.
+    /// @param proofSiblings: Array of the sibling nodes of the proof of membership.
+    /// @param proofPathIndices: Path of the proof of membership.
+    function removeWhistleblower(
+        uint256 entityId,
+        uint256 identityCommitment,
+        uint256[] calldata proofSiblings,
+        uint8[] calldata proofPathIndices
+    ) external;
+
+    /// @dev Allows whistleblowers to publish leaks anonymously.
+    /// @param leak: News leak.
+    /// @param nullifierHash: Nullifier hash.
+    /// @param entityId: Id of the entity.
+    /// @param proof: Private zk-proof parameters.
+    function publishLeak(
+        bytes32 leak,
+        uint256 nullifierHash,
+        uint256 entityId,
+        uint256[8] calldata proof
+    ) external;
 }

package/interfaces/IVerifier.sol

@@ -1,13 +1,13 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.4;
+pragma solidity 0.8.4;
 
 /// @title Verifier interface.
 /// @dev Interface of Verifier contract.
 interface IVerifier {
-  function verifyProof(
-    uint256[2] memory a,
-    uint256[2][2] memory b,
-    uint256[2] memory c,
-    uint256[4] memory input
-  ) external view;
+    function verifyProof(
+        uint256[2] memory a,
+        uint256[2][2] memory b,
+        uint256[2] memory c,
+        uint256[4] memory input
+    ) external view;
 }

package/package.json

@@ -1,38 +1,38 @@
 {
-  "name": "@semaphore-protocol/contracts",
-  "version": "0.1.0",
-  "description": "A privacy gadget for creating anonymous proof of membership on Ethereum.",
-  "license": "MIT",
-  "files": [
-    "**/*.sol"
-  ],
-  "keywords": [
-    "blockchain",
-    "ethereum",
-    "hardhat",
-    "smart-contracts",
-    "semaphore",
-    "identity",
-    "solidity",
-    "zero-knowledge",
-    "zk-snarks",
-    "zero-knowledge-proofs",
-    "circom",
-    "proof-of-membership"
-  ],
-  "homepage": "https://github.com/appliedzkp/semaphore.git#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/appliedzkp/semaphore.git.git"
-  },
-  "bugs": {
-    "url": "https://github.com/appliedzkp/semaphore.git/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@openzeppelin/contracts": "^4.4.2",
-    "@zk-kit/incremental-merkle-tree.sol": "^0.3.1"
-  }
+    "name": "@semaphore-protocol/contracts",
+    "version": "2.1.0",
+    "description": "Semaphore contracts to manage groups and broadcast anonymous signals.",
+    "license": "MIT",
+    "files": [
+        "**/*.sol"
+    ],
+    "keywords": [
+        "blockchain",
+        "ethereum",
+        "hardhat",
+        "smart-contracts",
+        "semaphore",
+        "identity",
+        "solidity",
+        "zero-knowledge",
+        "zk-snarks",
+        "zero-knowledge-proofs",
+        "circom",
+        "proof-of-membership"
+    ],
+    "homepage": "https://github.com/semaphore-protocol/semaphore.git#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/semaphore-protocol/semaphore.git.git"
+    },
+    "bugs": {
+        "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "@openzeppelin/contracts": "4.4.2",
+        "@zk-kit/incremental-merkle-tree.sol": "1.3.0"
+    }
 }

package/{base/Verifier.sol → verifiers/Verifier16.sol}

@@ -130,7 +130,7 @@ library Pairing {
   }
 }
 
-contract Verifier {
+contract Verifier16 {
   using Pairing for *;
 
   struct VerifyingKey {
@@ -154,69 +154,56 @@ contract Verifier {
     );
 
     vk.beta2 = Pairing.G2Point(
-      [
-        4252822878758300859123897981450591353533073413197771768651442665752259397132,
-        6375614351688725206403948262868962793625744043794305715222011528459656738731
-      ],
-      [
-        21847035105528745403288232691147584728191162732299865338377159692350059136679,
-        10505242626370262277552901082094356697409835680220590971873171140371331206856
-      ]
+      [4252822878758300859123897981450591353533073413197771768651442665752259397132, 6375614351688725206403948262868962793625744043794305715222011528459656738731],
+      [21847035105528745403288232691147584728191162732299865338377159692350059136679, 10505242626370262277552901082094356697409835680220590971873171140371331206856]
     );
-    vk.gamma2 = Pairing.G2Point(
-      [
-        11559732032986387107991004021392285783925812861821192530917403151452391805634,
-        10857046999023057135944570762232829481370756359578518086990519993285655852781
-      ],
-      [
-        4082367875863433681332203403145435568316851327593401208105741076214120093531,
-        8495653923123431417604973247489272438418190587263600148770280649306958101930
-      ]
-    );
-    vk.delta2 = Pairing.G2Point(
-      [
-        12599857379517512478445603412764121041984228075771497593287716170335433683702,
-        7912208710313447447762395792098481825752520616755888860068004689933335666613
-      ],
-      [
-        11502426145685875357967720478366491326865907869902181704031346886834786027007,
-        21679208693936337484429571887537508926366191105267550375038502782696042114705
-      ]
-    );
-    vk.IC = new Pairing.G1Point[](5);
 
-    vk.IC[0] = Pairing.G1Point(
-      19918517214839406678907482305035208173510172567546071380302965459737278553528,
-      7151186077716310064777520690144511885696297127165278362082219441732663131220
-    );
-
-    vk.IC[1] = Pairing.G1Point(
-      690581125971423619528508316402701520070153774868732534279095503611995849608,
-      21271996888576045810415843612869789314680408477068973024786458305950370465558
+    vk.gamma2 = Pairing.G2Point(
+      [11559732032986387107991004021392285783925812861821192530917403151452391805634, 10857046999023057135944570762232829481370756359578518086990519993285655852781],
+      [4082367875863433681332203403145435568316851327593401208105741076214120093531, 8495653923123431417604973247489272438418190587263600148770280649306958101930]
     );
 
-    vk.IC[2] = Pairing.G1Point(
-      16461282535702132833442937829027913110152135149151199860671943445720775371319,
-      2814052162479976678403678512565563275428791320557060777323643795017729081887
+    vk.delta2 = Pairing.G2Point(
+      [13406811599156507528361773763681356312643537981039994686313383243831956396116, 16243966861079634958125511652590761846958471358623040426599000904006426210032],
+      [11781596534582143578120404722739278517564025497573071755253972265891888117374, 15688083679237922164673518758181461582601853873216319711156397437601833996222]
     );
 
-    vk.IC[3] = Pairing.G1Point(
-      4319780315499060392574138782191013129592543766464046592208884866569377437627,
-      13920930439395002698339449999482247728129484070642079851312682993555105218086
-    );
+    vk.IC = new Pairing.G1Point[](5);
 
-    vk.IC[4] = Pairing.G1Point(
-      3554830803181375418665292545416227334138838284686406179598687755626325482686,
-      5951609174746846070367113593675211691311013364421437923470787371738135276998
-    );
+    
+      vk.IC[0] = Pairing.G1Point(
+        1964404930528116823793003656764176108669615750422202377358993070935069307720,
+        2137714996673694828207437580381836490878070731768805974506391024595988817424
+      );
+    
+      vk.IC[1] = Pairing.G1Point(
+        19568893707760843340848992184233194433177372925415116053368211122719346671126,
+        11639469568629189918046964192305250472192697612201524135560178632824282818614
+      );
+    
+      vk.IC[2] = Pairing.G1Point(
+        5317268879687484957437879782519918549127939892210247573193613900261494313825,
+        528174394975085006443543773707702838726735933116136102590448357278717993744
+      );
+    
+      vk.IC[3] = Pairing.G1Point(
+        14865918005176722116473730206622066845866539143554731094374354951675249722731,
+        3197770568483953664363740385883457803041685902965668289308665954510373380344
+      );
+    
+      vk.IC[4] = Pairing.G1Point(
+        6863358721495494421022713667808247652425178970453300712435830652679038918987,
+        15025816433373311798308762709072064417001390853103872064614174594927359131281
+      );
+    
   }
 
   /// @dev Verifies a Semaphore proof. Reverts with InvalidProof if the proof is invalid.
   function verifyProof(
-    uint256[2] memory a,
-    uint256[2][2] memory b,
-    uint256[2] memory c,
-    uint256[4] memory input
+    uint[2] memory a,
+    uint[2][2] memory b,
+    uint[2] memory c,
+    uint[4] memory input
   ) public view {
     // If the values are not in the correct range, the Pairing contract will revert.
     Proof memory proof;