@semaphore-protocol/cli-template-contracts-hardhat 4.0.0-alpha.8 → 4.0.0-beta.1

package/.editorconfig

@@ -0,0 +1,13 @@
+#root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintignore

@@ -0,0 +1,23 @@
+# dependencies
+node_modules
+package-lock.json
+yarn.lock
+.yarn
+
+# testing
+coverage
+coverage.json
+
+# hardhat
+artifacts
+cache
+typechain-types
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

package/.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"
+    }
+}

package/.prettierignore

@@ -0,0 +1,29 @@
+# dependencies
+node_modules
+package-lock.json
+yarn.lock
+.yarn
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# testing
+coverage
+coverage.json
+
+# hardhat
+artifacts
+cache
+typechain-types
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+    "semi": false,
+    "arrowParens": "always",
+    "trailingComma": "none"
+}

package/README.md

@@ -2,15 +2,23 @@
 
 This project demonstrates a basic Semaphore use case. It comes with a sample contract, a test for that contract and a sample task that deploys that contract.
 
+## Install
+
+### Install dependencies
+
+```bash
+yarn
+```
+
 ## Usage
 
-### Compile
+### Compile contracts
 
 ```bash
 yarn compile
 ```
 
-### Testing
+### Test contracts
 
 ```bash
 yarn test
@@ -28,7 +36,7 @@ Or a test gas report:
 yarn test:report-gas
 ```
 
-### Deploy
+### Deploy contracts
 
 1. Copy the `.env.example` file as `.env`.
 
@@ -52,3 +60,23 @@ yarn deploy --semaphore <semaphore-address> --group <group-id> --network sepolia
 
 > **Warning**  
 > The group id is a number!
+
+### Code quality and formatting
+
+Run [ESLint](https://eslint.org/) and [solhint](https://github.com/protofire/solhint) to analyze the code and catch bugs:
+
+```bash
+yarn lint
+```
+
+Run [Prettier](https://prettier.io/) to check formatting rules:
+
+```bash
+yarn prettier
+```
+
+Or to automatically format the code:
+
+```bash
+yarn prettier:write
+```

package/contracts/Feedback.sol

@@ -8,8 +8,8 @@ contract Feedback {
 
     uint256 public groupId;
 
-    constructor(ISemaphore _semaphore, uint256 _groupId) {
-        semaphore = _semaphore;
+    constructor(address semaphoreAddress, uint256 _groupId) {
+        semaphore = ISemaphore(semaphoreAddress);
         groupId = _groupId;
 
         semaphore.createGroup(groupId, address(this));

package/hardhat.config.ts

@@ -1,17 +1,10 @@
-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"
-import "hardhat-gas-reporter"
 import { HardhatUserConfig } from "hardhat/config"
 import { NetworksUserConfig } from "hardhat/types"
-import "solidity-coverage"
+import "@nomicfoundation/hardhat-toolbox"
+import "dotenv/config"
+import "@semaphore-protocol/hardhat"
 import "./tasks/deploy"
 
-dotenvConfig()
-
 function getNetworks(): NetworksUserConfig {
     if (!process.env.INFURA_API_KEY || !process.env.ETHEREUM_PRIVATE_KEY) {
         return {}
@@ -49,7 +42,7 @@ function getNetworks(): NetworksUserConfig {
     }
 }
 
-const hardhatConfig: HardhatUserConfig = {
+const config: HardhatUserConfig = {
     solidity: "0.8.23",
     networks: {
         hardhat: {
@@ -73,4 +66,4 @@ const hardhatConfig: HardhatUserConfig = {
     }
 }
 
-export default hardhatConfig
+export default config

package/package.json

@@ -1,65 +1,78 @@
 {
   "name": "@semaphore-protocol/cli-template-contracts-hardhat",
-  "version": "4.0.0-alpha.8",
+  "version": "4.0.0-beta.1",
   "description": "Semaphore Hardhat template.",
   "license": "Unlicense",
   "files": [
     "files.tgz",
     "contracts/",
-    "scripts/",
     "tasks/",
     "test/",
+    ".editorconfig",
     ".env.example",
+    ".eslintignore",
+    ".eslintrc.json",
+    ".prettierignore",
+    ".prettierrc.json",
     "hardhat.config.ts",
     "tsconfig.json",
-    "README.md"
+    "README.md",
+    ".yarn/",
+    ".yarnrc.yml"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "dev": "hardhat node & yarn compile && yarn deploy --network localhost",
+    "dev": "hardhat node & yarn deploy --network localhost",
     "compile": "hardhat compile",
-    "deploy": "yarn compile && hardhat deploy",
+    "deploy": "hardhat compile && hardhat deploy",
+    "verify": "hardhat verify",
     "test": "hardhat test",
     "test:report-gas": "REPORT_GAS=true hardhat test",
     "test:coverage": "hardhat coverage",
     "typechain": "hardhat typechain",
-    "prepublish": "tar -czf files.tgz .gitignore"
+    "prepublish": "tar -czf files.tgz .gitignore",
+    "lint": "eslint . --ext .js,.ts && solhint 'contracts/**/*.sol'",
+    "prettier": "prettier -c --plugin=prettier-plugin-solidity .",
+    "prettier:write": "prettier -w --plugin=prettier-plugin-solidity ."
   },
   "devDependencies": {
-    "@ethersproject/abi": "^5.4.7",
-    "@ethersproject/providers": "^5.4.7",
-    "@nomicfoundation/hardhat-chai-matchers": "^2.0.3",
+    "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
     "@nomicfoundation/hardhat-ethers": "^3.0.0",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.0",
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "@nomicfoundation/hardhat-verify": "^2.0.0",
-    "@semaphore-protocol/group": "4.0.0-alpha.8",
-    "@semaphore-protocol/hardhat": "4.0.0-alpha.8",
-    "@semaphore-protocol/identity": "4.0.0-alpha.8",
-    "@semaphore-protocol/proof": "4.0.0-alpha.8",
+    "@semaphore-protocol/core": "4.0.0-beta.1",
+    "@semaphore-protocol/hardhat": "4.0.0-beta.1",
     "@typechain/ethers-v6": "^0.5.0",
     "@typechain/hardhat": "^9.0.0",
     "@types/chai": "^4.2.0",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^20",
+    "@types/eslint": "^8",
+    "@types/mocha": ">=9.1.0",
+    "@types/node": "^20.11.20",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
     "chai": "^4.2.0",
-    "dotenv": "^16.0.3",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
     "ethers": "^6.4.0",
-    "hardhat": "^2.19.4",
+    "hardhat": "^2.20.1",
     "hardhat-gas-reporter": "^1.0.8",
+    "prettier": "^3.2.5",
+    "prettier-plugin-solidity": "^1.3.1",
+    "solhint": "^4.1.1",
     "solidity-coverage": "^0.8.1",
     "ts-node": "^10.9.2",
     "typechain": "^8.3.0",
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@semaphore-protocol/contracts": "4.0.0-alpha.8"
+    "@semaphore-protocol/contracts": "4.0.0-beta.1"
   },
-  "config": {
-    "solidity": {
-      "version": "0.8.4"
-    }
-  }
+  "packageManager": "yarn@4.1.0"
 }

package/test/Feedback.ts

@@ -1,37 +1,41 @@
-import { Group } from "@semaphore-protocol/group"
-import { Identity } from "@semaphore-protocol/identity"
-import { generateProof } from "@semaphore-protocol/proof"
+import { loadFixture } from "@nomicfoundation/hardhat-toolbox/network-helpers"
+import { Group, Identity, generateProof } from "@semaphore-protocol/core"
 import { expect } from "chai"
 import { encodeBytes32String } from "ethers"
 import { run } from "hardhat"
 // @ts-ignore: typechain folder will be generated after contracts compilation
-import { Feedback } from "../typechain-types"
+// eslint-disable-next-line
+import { Feedback, ISemaphore } from "../typechain-types"
 
 describe("Feedback", () => {
-    let feedbackContract: Feedback
-    let semaphoreContract: string
+    async function deployFeedbackFixture() {
+        const groupId = "42"
 
-    const groupId = "42"
-    const group = new Group()
-    const users: Identity[] = []
-
-    before(async () => {
         const { semaphore } = await run("deploy:semaphore", {
             logs: false
         })
 
-        feedbackContract = await run("deploy", { logs: false, group: groupId, semaphore: await semaphore.getAddress() })
-        semaphoreContract = semaphore
+        const semaphoreContract: ISemaphore = semaphore
 
-        users.push(new Identity())
-        users.push(new Identity())
-    })
+        const feedbackContract: Feedback = await run("deploy", {
+            logs: false,
+            group: groupId,
+            semaphore: await semaphoreContract.getAddress()
+        })
+
+        return { semaphoreContract, feedbackContract, groupId }
+    }
 
     describe("# joinGroup", () => {
         it("Should allow users to join the group", async () => {
-            for await (const [i, user] of users.entries()) {
-                const transaction = feedbackContract.joinGroup(user.commitment)
+            const { semaphoreContract, feedbackContract, groupId } = await loadFixture(deployFeedbackFixture)
+
+            const users = [new Identity(), new Identity()]
+
+            const group = new Group()
 
+            for (const [i, user] of users.entries()) {
+                const transaction = await feedbackContract.joinGroup(user.commitment)
                 group.addMember(user.commitment)
 
                 await expect(transaction)
@@ -43,6 +47,16 @@ describe("Feedback", () => {
 
     describe("# sendFeedback", () => {
         it("Should allow users to send feedback anonymously", async () => {
+            const { semaphoreContract, feedbackContract, groupId } = await loadFixture(deployFeedbackFixture)
+
+            const users = [new Identity(), new Identity()]
+            const group = new Group()
+
+            for (const user of users) {
+                await feedbackContract.joinGroup(user.commitment)
+                group.addMember(user.commitment)
+            }
+
             const feedback = encodeBytes32String("Hello World")
 
             const proof = await generateProof(users[1], group, feedback, groupId)

package/tsconfig.json

@@ -1,15 +1,13 @@
 {
     "compilerOptions": {
-        "moduleResolution": "Node",
-        "noImplicitAny": true,
-        "resolveJsonModule": true,
-        "target": "ES2018",
-        "module": "CommonJS",
-        "strict": true,
+        "target": "es2020",
+        "module": "commonjs",
         "esModuleInterop": true,
-        "outDir": "dist",
-        "typeRoots": ["node_modules/@types", "types"]
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true
     },
-    "include": ["scripts/**/*", "tasks/**/*", "test/**/*", "build/typechain/**/*", "types/**/*"],
+    "include": ["scripts/**/*", "tasks/**/*", "test/**/*", "typechain-types/**/*"],
     "files": ["./hardhat.config.ts"]
 }