Feat/v4 contracts

.gitignore

@@ -53,11 +53,27 @@ node_modules/
 # Yarn Integrity file
 .yarn-integrity
 
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
 # Production
 build
 dist
 /docs
 
+# Docusaurus cache and generated files
+.docusaurus
+.cache-loader
+
+# Hardhat
+artifacts
+cache
+typechain-types
+
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
@@ -69,3 +85,12 @@ dist
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+
+# asdf
+.tool-versions
+
+# direnv
+.envrc
+
+# Other
+snark-artifacts

.lintstagedrc.json

@@ -1,4 +1,4 @@
 {
-    "**/*.{js,ts,jsx,tsx,md,json,sol}": "prettier --write",
+    "**/*.{js,ts,jsx,tsx,md,json,sol,yaml,yml}": "prettier --write",
     "**/*.{js,ts,jsx,tsx}": "eslint"
 }

package.json

@@ -4,11 +4,13 @@
     "packageManager": "[email protected]",
     "scripts": {
         "build": "yarn build:libraries",
-        "build:libraries": "yarn workspaces foreach -A -t --no-private run build",
+        "build:libraries": "yarn workspaces foreach -A --no-private run build",
+        "compile:contracts": "yarn workspace extension-contracts compile",
         "test": "yarn test:libraries && yarn test:circuits",
         "test:libraries": "jest --coverage",
         "test:library": "jest packages/${0}",
         "test:circuits": "yarn workspace @semaphore-extensions/identity-proof.circom test",
+        "test:contracts": "yarn workspace extension-contracts test:coverage",
         "lint:eslint": "eslint . --ext .js,.ts,.tsx",
         "lint": "yarn lint:eslint",
         "lint:fix": "yarn lint:eslint --fix",

packages/contracts/.env.example

@@ -0,0 +1,4 @@
+ETHEREUM_PRIVATE_KEY=
+REPORT_GAS=false
+ETHERSCAN_API_KEY=
+COINMARKETCAP_API_KEY=

packages/contracts/.eslintrc.json

@@ -0,0 +1,24 @@
+{
+    "root": true,
+    "env": {
+        "es6": true
+    },
+    "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module",
+        "project": ["./tsconfig.json"]
+    },
+    "plugins": ["@typescript-eslint"],
+    "rules": {
+        "no-underscore-dangle": "off",
+        "import/no-extraneous-dependencies": "off",
+        "no-bitwise": "off",
+        "no-await-in-loop": "off",
+        "no-restricted-syntax": "off",
+        "no-console": ["warn", { "allow": ["info", "warn", "error", "log"] }],
+        "@typescript-eslint/lines-between-class-members": "off",
+        "no-param-reassign": "off"
+    }
+}

packages/contracts/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "semi": false,
+    "arrowParens": "always",
+    "trailingComma": "none",
+    "plugins": ["prettier-plugin-solidity"]
+}

packages/contracts/README.md

@@ -0,0 +1 @@
+contracts/README.md

packages/contracts/contracts/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ethereum Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/contracts/contracts/README.md

@@ -0,0 +1,103 @@
+<p align="center">
+    <h1 align="center">
+        Semaphore Extension Contracts
+    </h1>
+    <p align="center">Extension contracts to manage Voting and whistleBlowing</p>
+</p>
+<p align="center">
+    <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/extensions/blob/main/packages/contracts/contracts/LICENSE">
+        <img alt="NPM license" src="https://img.shields.io/npm/l/%40semaphore-extensions%2Fcontracts?style=flat-square">
+    </a>
+    <a href="https://www.npmjs.com/package/@semaphore-extensions/contracts">
+        <img alt="NPM version" src="https://img.shields.io/npm/v/@semaphore-extensions/contracts?style=flat-square" />
+    </a>
+    <a href="https://npmjs.org/package/@semaphore-extensions/contracts">
+        <img alt="Downloads" src="https://img.shields.io/npm/dm/@semaphore-extensions/contracts.svg?style=flat-square" />
+    </a>
+</p>
+<div align="center">
+    <h4>
+        <a href="https://github.com/semaphore-protocol/extensions/blob/main/CONTRIBUTING.md">
+            👥 Contributing
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://github.com/semaphore-protocol/extensions/blob/main/CODE_OF_CONDUCT.md">
+            🤝 Code of conduct
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://github.com/semaphore-protocol/extensions/contribute">
+            🔎 Issues
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://semaphore.pse.dev/discord">
+            🗣️ Chat &amp; Support
+        </a>
+    </h4>
+</div>
+
+## 🛠 Install
+
+### npm or yarn
+
+Install the `@semaphore-extension/contracts` package with npm:
+
+```bash
+npm i @semaphore-extension/contracts
+```
+
+or yarn: <br>
+
+```bash
+yarn add @semaphore-extension/contracts
+```
+
+## Usage
+
+### Compile contracts
+
+```bash
+yarn compile
+```
+
+### Test contracts
+
+```bash
+yarn test
+```
+
+You can also generate a test coverage report:
+
+```bash
+yarn test:coverage
+```
+
+Or a test gas report:
+
+```bash
+yarn test:report-gas
+```
+
+1. Copy the `.env.example` file as `.env`.
+
+```bash
+cp .env.example .env
+```
+
+2. Add your environment variables.
+
+### Deploy contracts
+
+Deploy the `SemaphoreVoting.sol` and `SemaphoreWhistleblowing.sol` contract without any parameter:
+
+```bash
+yarn deploy
+```
+
+> **Note**  
+> You should at least set a valid Ethereum URL (e.g. Infura) and a private key with some ethers.
+
+> **Warning**  
+> The group id is a number!

packages/contracts/contracts/SemaphoreVoting.sol

@@ -0,0 +1,103 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import {ISemaphore} from "@semaphore-protocol/contracts/interfaces/ISemaphore.sol";
+import {ISemaphoreVoting} from "./interfaces/ISemaphoreVoting.sol";
+import {SemaphoreGroups} from "@semaphore-protocol/contracts/base/SemaphoreGroups.sol";
+
+/// @title Semaphore Voting contract.
+/// @notice It allows users to vote anonymously in a poll.
+/// @dev The following code allows you to create polls, add voters and allow them to vote anonymously.
+contract SemaphoreVoting is ISemaphoreVoting, SemaphoreGroups {
+    ISemaphore public group;
+
+    /// @dev Gets a poll id and returns the poll data.
+    mapping(uint256 => Poll) internal polls;
+
+    /// @dev Checks if the poll coordinator is the transaction sender.
+    /// @param pollId: Id of the poll.
+    modifier onlyCoordinator(uint256 pollId) {
+        if (polls[pollId].coordinator != msg.sender) {
+            revert Semaphore__CallerIsNotThePollCoordinator();
+        }
+
+        _;
+    }
+
+    /// @dev Initializes the Semaphore group used to verify the user's ZK proofs.
+    /// @param _group: Semaphore group address.
+    constructor(ISemaphore _group) {
+        group = _group;
+    }
+
+    /// @dev See {ISemaphoreVoting-createPoll}.
+    function createPoll(uint256 pollId, address coordinator) public override {
+        uint256 groupId = group.createGroup();
+
+        polls[pollId].coordinator = coordinator;
+        polls[pollId].groupId = groupId;
+
+        emit PollCreated(pollId, coordinator);
+    }
+
+    /// @dev See {ISemaphoreVoting-addVoter}.
+    function addVoter(uint256 pollId, uint256 identityCommitment) public override onlyCoordinator(pollId) {
+        if (polls[pollId].state != PollState.Created) {
+            revert Semaphore__PollHasAlreadyBeenStarted();
+        }
+
+        group.addMember(polls[pollId].groupId, identityCommitment);
+    }
+
+    /// @dev See {ISemaphoreVoting-startPoll}.
+    function startPoll(uint256 pollId, uint256 encryptionKey) public override onlyCoordinator(pollId) {
+        if (polls[pollId].state != PollState.Created) {
+            revert Semaphore__PollHasAlreadyBeenStarted();
+        }
+
+        polls[pollId].state = PollState.Ongoing;
+
+        emit PollStarted(pollId, msg.sender, encryptionKey);
+    }
+
+    /// @dev See {ISemaphoreVoting-castVote}.
+    function castVote(uint256 vote, uint256 nullifierHash, uint256 pollId, uint256[8] calldata proof) public override {
+        if (polls[pollId].state != PollState.Ongoing) {
+            revert Semaphore__PollIsNotOngoing();
+        }
+
+        if (polls[pollId].nullifierHashes[nullifierHash]) {
+            revert Semaphore__YouAreUsingTheSameNullifierTwice();
+        }
+
+        uint256 merkleTreeRoot = getMerkleTreeRoot(polls[pollId].groupId);
+
+        ISemaphore.SemaphoreProof memory semaphoreProof = ISemaphore.SemaphoreProof({
+            merkleTreeDepth: 32,
+            merkleTreeRoot: merkleTreeRoot,
+            nullifier: nullifierHash,
+            message: vote,
+            scope: pollId,
+            points: proof
+        });
+
+        group.verifyProof(polls[pollId].groupId, semaphoreProof);
+
+        polls[pollId].nullifierHashes[nullifierHash] = true;
+
+        emit VoteAdded(pollId, vote);
+    }
+
+    /// @dev See {ISemaphoreVoting-endPoll}.
+    function endPoll(uint256 pollId, uint256 decryptionKey) public override onlyCoordinator(pollId) {
+        if (polls[pollId].state != PollState.Ongoing) {
+            revert Semaphore__PollIsNotOngoing();
+        }
+
+        polls[pollId].state = PollState.Ended;
+
+        emit PollEnded(pollId, msg.sender, decryptionKey);
+    }
+
+    function createPoll(uint256 pollId, address coordinator, uint256 merkleTreeDepth) external {}
+}