@semaphore-protocol/cli-template-contracts-hardhat 3.15.1 → 4.0.0-alpha

package/.env.example

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

package/README.md

@@ -44,11 +44,11 @@ cp .env.example .env
 3. And deploy your contract.
 
 ```bash
-yarn deploy --semaphore <semaphore-address> --group <group-id> --network goerli
+yarn deploy --semaphore <semaphore-address> --group <group-id> --network sepolia
 ```
 
 > **Note**  
-> Check the Semaphore contract addresses [here](https://semaphore.pse.dev/docs/deployed-contracts#semaphore).
+> Check the Semaphore contract addresses [here](https://docs.semaphore.pse.dev/deployed-contracts#semaphore).
 
 > **Warning**  
 > The group id is a number!

package/contracts/Feedback.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: MIT
-pragma solidity ^0.8.4;
+pragma solidity ^0.8.23;
 
 import "@semaphore-protocol/contracts/interfaces/ISemaphore.sol";
 
@@ -8,11 +8,11 @@ contract Feedback {
 
     uint256 public groupId;
 
-    constructor(address semaphoreAddress, uint256 _groupId) {
-        semaphore = ISemaphore(semaphoreAddress);
+    constructor(ISemaphore _semaphore, uint256 _groupId) {
+        semaphore = _semaphore;
         groupId = _groupId;
 
-        semaphore.createGroup(groupId, 20, address(this));
+        semaphore.createGroup(groupId, address(this));
     }
 
     function joinGroup(uint256 identityCommitment) external {
@@ -20,11 +20,12 @@ contract Feedback {
     }
 
     function sendFeedback(
-        uint256 feedback,
+        uint256 merkleTreeDepth,
         uint256 merkleTreeRoot,
-        uint256 nullifierHash,
+        uint256 nullifier,
+        uint256 feedback,
         uint256[8] calldata proof
     ) external {
-        semaphore.verifyProof(groupId, merkleTreeRoot, feedback, nullifierHash, groupId, proof);
+        semaphore.validateProof(groupId, merkleTreeDepth, merkleTreeRoot, nullifier, feedback, groupId, proof);
     }
 }

package/hardhat.config.ts

@@ -1,5 +1,6 @@
-import "@nomiclabs/hardhat-ethers"
 import "@nomicfoundation/hardhat-chai-matchers"
+import "@nomicfoundation/hardhat-ethers"
+import "@nomicfoundation/hardhat-verify"
 import "@semaphore-protocol/hardhat"
 import "@typechain/hardhat"
 import { config as dotenvConfig } from "dotenv"
@@ -7,7 +8,6 @@ import "hardhat-gas-reporter"
 import { HardhatUserConfig } from "hardhat/config"
 import { NetworksUserConfig } from "hardhat/types"
 import "solidity-coverage"
-import { config } from "./package.json"
 import "./tasks/deploy"
 
 dotenvConfig()
@@ -21,11 +21,6 @@ function getNetworks(): NetworksUserConfig {
     const infuraApiKey = process.env.INFURA_API_KEY
 
     return {
-        goerli: {
-            url: `https://goerli.infura.io/v3/${infuraApiKey}`,
-            chainId: 5,
-            accounts
-        },
         sepolia: {
             url: `https://sepolia.infura.io/v3/${infuraApiKey}`,
             chainId: 11155111,
@@ -36,13 +31,18 @@ function getNetworks(): NetworksUserConfig {
             chainId: 80001,
             accounts
         },
-        "optimism-goerli": {
-            url: `https://optimism-goerli.infura.io/v3/${infuraApiKey}`,
-            chainId: 420,
+        "optimism-sepolia": {
+            url: `https://optimism-sepolia.infura.io/v3/${infuraApiKey}`,
+            chainId: 11155420,
+            accounts
+        },
+        "arbitrum-sepolia": {
+            url: "https://sepolia-rollup.arbitrum.io/rpc",
+            chainId: 421614,
             accounts
         },
         arbitrum: {
-            url: `https://arbitrum-mainnet.infura.io/v3/${infuraApiKey}`,
+            url: "https://arb1.arbitrum.io/rpc",
             chainId: 42161,
             accounts
         }
@@ -50,13 +50,7 @@ function getNetworks(): NetworksUserConfig {
 }
 
 const hardhatConfig: HardhatUserConfig = {
-    solidity: config.solidity,
-    paths: {
-        sources: config.paths.contracts,
-        tests: config.paths.tests,
-        cache: config.paths.cache,
-        artifacts: config.paths.build.contracts
-    },
+    solidity: "0.8.23",
     networks: {
         hardhat: {
             chainId: 1337
@@ -69,8 +63,13 @@ const hardhatConfig: HardhatUserConfig = {
         coinmarketcap: process.env.COINMARKETCAP_API_KEY
     },
     typechain: {
-        outDir: config.paths.build.typechain,
-        target: "ethers-v5"
+        target: "ethers-v6"
+    },
+    etherscan: {
+        apiKey: process.env.ETHERSCAN_API_KEY
+    },
+    sourcify: {
+        enabled: true
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/cli-template-contracts-hardhat",
-  "version": "3.15.1",
+  "version": "4.0.0-alpha",
   "description": "Semaphore Hardhat template.",
   "license": "Unlicense",
   "files": [
@@ -20,9 +20,8 @@
   "scripts": {
     "dev": "hardhat node & yarn compile && yarn deploy --network localhost",
     "compile": "hardhat compile",
-    "download:snark-artifacts": "hardhat run scripts/download-snark-artifacts.ts",
     "deploy": "yarn compile && hardhat deploy",
-    "test": "hardhat run scripts/download-snark-artifacts.ts && hardhat test",
+    "test": "hardhat test",
     "test:report-gas": "REPORT_GAS=true hardhat test",
     "test:coverage": "hardhat coverage",
     "typechain": "hardhat typechain",
@@ -31,48 +30,36 @@
   "devDependencies": {
     "@ethersproject/abi": "^5.4.7",
     "@ethersproject/providers": "^5.4.7",
-    "@nomicfoundation/hardhat-chai-matchers": "^1.0.0",
+    "@nomicfoundation/hardhat-chai-matchers": "^2.0.3",
+    "@nomicfoundation/hardhat-ethers": "^3.0.0",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.0",
-    "@nomicfoundation/hardhat-toolbox": "^2.0.0",
-    "@nomiclabs/hardhat-ethers": "^2.0.0",
-    "@nomiclabs/hardhat-etherscan": "^3.0.0",
-    "@semaphore-protocol/group": "3.15.1",
-    "@semaphore-protocol/hardhat": "3.15.1",
-    "@semaphore-protocol/identity": "3.15.1",
-    "@semaphore-protocol/proof": "3.15.1",
-    "@typechain/ethers-v5": "^10.1.0",
-    "@typechain/hardhat": "^6.1.2",
+    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
+    "@nomicfoundation/hardhat-verify": "^2.0.0",
+    "@semaphore-protocol/group": "4.0.0-alpha",
+    "@semaphore-protocol/hardhat": "4.0.0-alpha",
+    "@semaphore-protocol/identity": "4.0.0-alpha",
+    "@semaphore-protocol/proof": "4.0.0-alpha",
+    "@typechain/ethers-v6": "^0.5.0",
+    "@typechain/hardhat": "^9.0.0",
     "@types/chai": "^4.2.0",
-    "@types/download": "^8.0.1",
     "@types/mocha": "^9.1.0",
-    "@types/node": ">=12.0.0",
+    "@types/node": "^20",
     "chai": "^4.2.0",
     "dotenv": "^16.0.3",
-    "download": "^8.0.0",
-    "ethers": "^5.4.7",
-    "hardhat": "^2.11.0",
+    "ethers": "^6.4.0",
+    "hardhat": "^2.19.4",
     "hardhat-gas-reporter": "^1.0.8",
     "solidity-coverage": "^0.8.1",
-    "ts-node": ">=8.0.0",
-    "typechain": "^8.1.0",
-    "typescript": ">=4.5.0"
+    "ts-node": "^10.9.2",
+    "typechain": "^8.3.0",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@semaphore-protocol/contracts": "3.15.1"
+    "@semaphore-protocol/contracts": "4.0.0-alpha"
   },
   "config": {
     "solidity": {
       "version": "0.8.4"
-    },
-    "paths": {
-      "contracts": "./contracts",
-      "tests": "./test",
-      "cache": "./cache",
-      "build": {
-        "snark-artifacts": "./build/snark-artifacts",
-        "contracts": "./build/contracts",
-        "typechain": "./build/typechain"
-      }
     }
   }
 }

package/tasks/deploy.ts

@@ -10,7 +10,7 @@ task("deploy", "Deploy a Feedback contract")
                 logs
             })
 
-            semaphoreAddress = semaphore.address
+            semaphoreAddress = await semaphore.getAddress()
         }
 
         if (!groupId) {
@@ -21,10 +21,8 @@ task("deploy", "Deploy a Feedback contract")
 
         const feedbackContract = await FeedbackFactory.deploy(semaphoreAddress, groupId)
 
-        await feedbackContract.deployed()
-
         if (logs) {
-            console.info(`Feedback contract has been deployed to: ${feedbackContract.address}`)
+            console.info(`Feedback contract has been deployed to: ${await feedbackContract.getAddress()}`)
         }
 
         return feedbackContract

package/test/Feedback.ts

@@ -2,18 +2,17 @@ import { Group } from "@semaphore-protocol/group"
 import { Identity } from "@semaphore-protocol/identity"
 import { generateProof } from "@semaphore-protocol/proof"
 import { expect } from "chai"
-import { formatBytes32String } from "ethers/lib/utils"
+import { encodeBytes32String } from "ethers"
 import { run } from "hardhat"
 // @ts-ignore: typechain folder will be generated after contracts compilation
 import { Feedback } from "../build/typechain"
-import { config } from "../package.json"
 
 describe("Feedback", () => {
     let feedbackContract: Feedback
     let semaphoreContract: string
 
     const groupId = "42"
-    const group = new Group(groupId)
+    const group = new Group()
     const users: Identity[] = []
 
     before(async () => {
@@ -21,7 +20,7 @@ describe("Feedback", () => {
             logs: false
         })
 
-        feedbackContract = await run("deploy", { logs: false, group: groupId, semaphore: semaphore.address })
+        feedbackContract = await run("deploy", { logs: false, group: groupId, semaphore: await semaphore.getAddress() })
         semaphoreContract = semaphore
 
         users.push(new Identity())
@@ -43,27 +42,30 @@ describe("Feedback", () => {
     })
 
     describe("# sendFeedback", () => {
-        const wasmFilePath = `${config.paths.build["snark-artifacts"]}/semaphore.wasm`
-        const zkeyFilePath = `${config.paths.build["snark-artifacts"]}/semaphore.zkey`
-
         it("Should allow users to send feedback anonymously", async () => {
-            const feedback = formatBytes32String("Hello World")
+            const feedback = encodeBytes32String("Hello World")
 
-            const fullProof = await generateProof(users[1], group, groupId, feedback, {
-                wasmFilePath,
-                zkeyFilePath
-            })
+            const fullProof = await generateProof(users[1], group, feedback, groupId)
 
             const transaction = feedbackContract.sendFeedback(
-                feedback,
+                fullProof.merkleTreeDepth,
                 fullProof.merkleTreeRoot,
-                fullProof.nullifierHash,
+                fullProof.nullifier,
+                feedback,
                 fullProof.proof
             )
 
             await expect(transaction)
-                .to.emit(semaphoreContract, "ProofVerified")
-                .withArgs(groupId, fullProof.merkleTreeRoot, fullProof.nullifierHash, groupId, fullProof.signal)
+                .to.emit(semaphoreContract, "ProofValidated")
+                .withArgs(
+                    groupId,
+                    fullProof.merkleTreeDepth,
+                    fullProof.merkleTreeRoot,
+                    fullProof.nullifier,
+                    fullProof.message,
+                    groupId,
+                    fullProof.proof
+                )
         })
     })
 })

package/scripts/download-snark-artifacts.ts

@@ -1,24 +0,0 @@
-import download from "download"
-import fs from "fs"
-import { config } from "../package.json"
-
-async function main() {
-    const snarkArtifactsPath = config.paths.build["snark-artifacts"]
-    const url = `http://www.trusted-setup-pse.org/semaphore/${20}`
-
-    if (!fs.existsSync(snarkArtifactsPath)) {
-        fs.mkdirSync(snarkArtifactsPath, { recursive: true })
-    }
-
-    if (!fs.existsSync(`${snarkArtifactsPath}/semaphore.zkey`)) {
-        await download(`${url}/semaphore.wasm`, snarkArtifactsPath)
-        await download(`${url}/semaphore.zkey`, snarkArtifactsPath)
-    }
-}
-
-main()
-    .then(() => process.exit(0))
-    .catch((error) => {
-        console.error(error)
-        process.exit(1)
-    })