Add CLI Foundry Template

.gitmodules

@@ -0,0 +1,15 @@
+[submodule "packages/cli-template-contracts-foundry/lib/forge-std"]
+	path = packages/cli-template-contracts-foundry/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "packages/cli-template-contracts-foundry/lib/semaphore"]
+	path = packages/cli-template-contracts-foundry/lib/semaphore
+	url = https://github.com/semaphore-protocol/semaphore
+[submodule "packages/cli-template-contracts-foundry/lib/zk-kit.solidity"]
+	path = packages/cli-template-contracts-foundry/lib/zk-kit.solidity
+	url = https://github.com/privacy-scaling-explorations/zk-kit.solidity
+[submodule "packages/cli-template-contracts-foundry/lib/poseidon-solidity"]
+	path = packages/cli-template-contracts-foundry/lib/poseidon-solidity
+	url = https://github.com/chancehudson/poseidon-solidity
+[submodule "packages/cli-template-contracts-foundry/lib/openzeppelin-contracts"]
+	path = packages/cli-template-contracts-foundry/lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

packages/cli-template-contracts-foundry/.env.example

@@ -0,0 +1,4 @@
+SEPOLIA_RPC_URL=
+SEPOLIA_API_URL=
+ETHERSCAN_API_KEY=
+PRIVATE_KEY=

packages/cli-template-contracts-foundry/.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

packages/cli-template-contracts-foundry/Makefile

@@ -0,0 +1,48 @@
+-include .env
+
+DEFAULT_ANVIL_KEY := 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+DEFAULT_ANVIL_ADDRESS := 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+DEFAULT_RPC_URL := http://localhost:8545
+
+.PHONY: all test clean
+
+all: clean remove install build
+
+# Clean the repo
+clean  :; forge clean
+
+# Remove modules
+remove :; rm -rf .gitmodules && rm -rf .git/modules/* && rm -rf lib && touch .gitmodules && git add . && git commit -m "modules"
+
+install :; forge install semaphore-protocol/semaphore privacy-scaling-explorations/zk-kit.solidity chancehudson/poseidon-solidity OpenZeppelin/openzeppelin-contracts foundry-rs/forge-std
+
+install-no-git :; forge install --no-git semaphore-protocol/semaphore privacy-scaling-explorations/zk-kit.solidity chancehudson/poseidon-solidity OpenZeppelin/openzeppelin-contracts foundry-rs/forge-std
+
+# Update Dependencies
+update :; forge update
+
+build :; forge build
+
+test :; forge test -vvv
+
+gas-report :; forge test --gas-report
+
+coverage :; forge coverage
+
+snapshot :; forge snapshot
+
+format :; forge fmt
+
+slither :; slither ./src 
+
+#format :; prettier --write src/**/*.sol && prettier --write src/*.sol
+
+# solhint should be installed globally
+lint :; solhint src/**/*.sol && solhint src/*.sol
+
+# use the "@" to hide the command from your shell
+deploy :; @forge script script/DeployFeedback.s.sol:DeployFeedback --rpc-url $(DEFAULT_RPC_URL) --private-key $(DEFAULT_ANVIL_KEY) --broadcast -vvvvv
+
+deploy-sepolia :; @forge script script/DeployFeedback.s.sol:DeployFeedback --rpc-url $(SEPOLIA_RPC_URL) --private-key $(PRIVATE_KEY) --broadcast --etherscan-api-key $(ETHERSCAN_API_KEY) -vvvvv
+
+deploy-sepolia-verify :; @forge script script/DeployFeedback.s.sol:DeployFeedback --rpc-url $(SEPOLIA_RPC_URL) --private-key $(PRIVATE_KEY) --broadcast --verify --etherscan-api-key $(ETHERSCAN_API_KEY) -vvvvv

packages/cli-template-contracts-foundry/README.md

@@ -0,0 +1,89 @@
+# Semaphore Foundry Template
+
+This project demonstrates a basic Semaphore use case. It comes with a sample contract, a test for that contract and a sample script that deploys that contract.
+
+## Install  
+
+### Install dependencies
+
+```bash
+make install
+```
+
+## Usage
+
+### Compile contracts
+
+```bash
+make build
+```
+
+### Test
+
+```bash
+make test
+```
+
+You can also generate a test coverage report:
+
+```bash
+make coverage
+```
+
+Or a test gas report:
+
+```bash  
+make gas-report
+```
+
+### Deploy contracts
+
+1. Copy the `.env.example` file as `.env`.
+
+```bash
+cp .env.example .env
+```
+
+2. Add your environment variables.
+
+> [!NOTE]
+> You should at least set a valid Ethereum URL (e.g. Infura) and a private key with some ethers.
+
+3. And deploy your contract.
+
+```bash
+make deploy
+```
+
+4. You can also deploy your contract in Sepolia test chain.
+
+```bash
+make deploy-sepolia
+```
+
+```bash
+make deploy-sepolia-verify
+```
+
+> [!NOTE]
+> Check the Semaphore contract addresses [here](https://docs.semaphore.pse.dev/deployed-contracts).
+
+### 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
+```

packages/cli-template-contracts-foundry/foundry.toml

@@ -0,0 +1,13 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+remappings = [
+    "@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
+    "@zk-kit/lean-imt.sol=lib/zk-kit.solidity/packages/lean-imt/contracts/",
+    "@semaphore/contracts/=lib/semaphore/packages/contracts/",
+    "poseidon-solidity/=lib/poseidon-solidity/contracts/"
+]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

packages/cli-template-contracts-foundry/script/DeployFeedback.s.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import {Feedback} from "../src/Feedback.sol";
+import {Semaphore} from "@semaphore/contracts/contracts/Semaphore.sol";
+import {SemaphoreVerifier} from "@semaphore/contracts/contracts/base/SemaphoreVerifier.sol";
+import {ISemaphoreVerifier} from "@semaphore/contracts/contracts/interfaces/ISemaphoreVerifier.sol";
+import "forge-std/Script.sol";
+
+contract DeployFeedback is Script {
+    function run() external returns (address, address) {
+
+        address semaphoreVerifierAddress;
+        address semaphoreAddress;
+
+        if (block.chainid == 11155111) {
+            semaphoreVerifierAddress = 0xe538f9DeeE04A397decb1E7dc5D16fD6f123c043;
+            semaphoreAddress = 0x1e0d7FF1610e480fC93BdEC510811ea2Ba6d7c2f;
+        }
+
+        vm.startBroadcast();
+
+        if (semaphoreAddress == address(0)) {
+            // Deploy SemaphoreVerifier for Semaphore
+            SemaphoreVerifier semaphoreVerifier = new SemaphoreVerifier();
+            semaphoreVerifierAddress = address(semaphoreVerifier);
+            ISemaphoreVerifier IsemaphoreVerifier = ISemaphoreVerifier(address(semaphoreVerifier));
+            // Deploy Semaphore for Feedback
+            Semaphore semaphore = new Semaphore(IsemaphoreVerifier);
+            semaphoreAddress = address(semaphore);
+        }
+
+        // Deploy Feedback
+        Feedback feedback = new Feedback(semaphoreAddress);
+
+        vm.stopBroadcast();
+
+        console.log("Feedback contract has been deployed to:", address(feedback));
+
+        return (address(feedback), semaphoreAddress);
+    }
+}

packages/cli-template-contracts-foundry/src/Feedback.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import {ISemaphore} from "@semaphore/contracts/contracts/interfaces/ISemaphore.sol";
+
+contract Feedback {
+    ISemaphore public semaphore;
+
+    uint256 public groupId;
+
+    constructor(address semaphoreAddress) {
+        semaphore = ISemaphore(semaphoreAddress);
+
+        groupId = semaphore.createGroup();
+    }
+
+    function joinGroup(uint256 identityCommitment) external {
+        semaphore.addMember(groupId, identityCommitment);
+    }
+
+    function sendFeedback(
+        uint256 merkleTreeDepth,
+        uint256 merkleTreeRoot,
+        uint256 nullifier,
+        uint256 feedback,
+        uint256[8] calldata points
+    ) external {
+        ISemaphore.SemaphoreProof memory proof = ISemaphore.SemaphoreProof(
+            merkleTreeDepth,
+            merkleTreeRoot,
+            nullifier,
+            feedback,
+            groupId,
+            points
+        );
+
+        semaphore.validateProof(groupId, proof);
+    }
+}

packages/cli-template-contracts-foundry/test/TestFeedback.t.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import {Feedback} from "../src/Feedback.sol";
+import {DeployFeedback} from "../script/DeployFeedback.s.sol";
+import {ISemaphore} from "@semaphore/contracts/contracts/interfaces/ISemaphore.sol";
+import "forge-std/Test.sol";
+import "forge-std/Vm.sol";
+import "forge-std/StdAssertions.sol";
+
+contract TestFeedback is Test {
+    event MemberAdded(uint256 indexed groupId, uint256 index, uint256 identityCommitment, uint256 merkleTreeRoot);
+
+    Feedback feedback;
+    ISemaphore semaphore;
+
+    function setUp() external {
+        DeployFeedback deployFeedback = new DeployFeedback();
+        (address feedbackAddress, address semaphoreAddress) = deployFeedback.run();
+        feedback = Feedback(feedbackAddress);
+        semaphore = ISemaphore(semaphoreAddress);
+    }
+
+    function testGroupCanBeSuccessfullyCreatedInConstructor() public view {
+        uint256 groupCount = semaphore.groupCounter();
+        assertEq(groupCount, 1);
+    }
+
+    function testJoinGroup() public {
+        // The commitment below is generated with private key of the first account in Anvil
+        uint256 identityCommitment = 15072455385723004728391568434269917452175057560864330595979104241296826134229;
+
+        vm.expectEmit();    
+        emit MemberAdded(0, 0, identityCommitment, identityCommitment);
+
+        feedback.joinGroup(identityCommitment);
+    }
+
+    function testSendFeedback() public {
+        // The commitment below is generated with private key of the first account in Anvil
+        uint256 identityCommitment = 15072455385723004728391568434269917452175057560864330595979104241296826134229;
+
+        // proof
+        uint256 merkleTreeDepth = 1;
+        uint256 merkleTreeRoot = 15072455385723004728391568434269917452175057560864330595979104241296826134229;
+        uint256 nullifier = 19686122779422310562166284157356225273555811832250923548604308577995736533741;
+        uint256 _feedback = 10;
+        uint256[8] memory points = [
+            12048312860461559338883155239253399933546666729690013703471566999549175452467,
+            21840091385609522690103928000869734241136862303146585471149748945500784854265,
+            10054166788431277732934266072748176286083365382773741957806739135617485223542,
+            9116054769380232069869558420495933708797671282085269461846220481242548419978,
+            6948551756635965397908570768367265912884504926499199123083878377204200654789,
+            2245690128809758381379719477871572712156305432595569015554741897717367802975,
+            5611601698470220983640634359607737788561497874240905720723835997666161640377,
+            10003362076211645361201917446734540672642362716488164733173444779942043660944
+        ];
+
+        feedback.joinGroup(identityCommitment);
+        feedback.sendFeedback(merkleTreeDepth, merkleTreeRoot, nullifier, _feedback, points);
+    }
+}