Added apps/circuits (#10)

* Added circom to perform range check

* using fully qualified name to get contract artifact

* minor update

* prettier:write

* adding to the test cases

* Adding apps/circuits

* added circuits components

* updated with rangecheck

* removed circuits from contracts

* Added script to copy app/circuits compiled assets over to app/contracts dir inside

* passing prettier:write

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-    PSE Core Hackathon
+    PSE Core Stage 2: Number Guessing Game
 </h1>
 
 <p align="center">
@@ -14,8 +14,8 @@
     </a>
 </p>
 
-| The repository is divided into two components: [web app](./apps/web-app) and [contracts](./apps/contracts). Hopefully the app will be deployed on Sepolia. |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| The repository is divided into two components: [web app](./apps/web-app), [contracts](./apps/contracts), and [circuits](./apps/circuits). Hopefully the app will be deployed on Sepolia. |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 This repo is modified from [Semaphore Boilerplate Template](https://github.com/semaphore-protocol/boilerplate)
 
@@ -92,3 +92,10 @@ or to automatically format the code:
 ```bash
 yarn prettier:write
 ```
+
+### Key Components
+
+Key components for writing circuits
+
+- [circomkit](https://github.com/erhant/circomkit/tree/main)
+- [hardhat-circom](https://github.com/projectsophon/hardhat-circom)

apps/circuits/.gitignore

@@ -0,0 +1,2 @@
+artifacts
+src/test

apps/circuits/.mocharc.json

@@ -0,0 +1,7 @@
+{
+  "extension": ["ts"],
+  "require": "ts-node/register",
+  "spec": "./tests/*.test.ts",
+  "timeout": 100000,
+  "exit": true
+}

apps/circuits/circomkit.json

@@ -0,0 +1,17 @@
+{
+  "protocol": "plonk",
+  "optimization": 1,
+  "prime": "bn128",
+  "version": "2.1.6",
+  "circuits": "./circuits.json",
+
+  "dirCircuits": "./src",
+  "dirInputs": "./src/inputs",
+  "dirPtau": "./artifacts/ptau",
+  "dirBuild": "./artifacts/build",
+
+  "prettyCalldata": true,
+  "inspect": true,
+  "logLevel": "INFO",
+  "verbose": true
+}

apps/circuits/circuits.json

@@ -0,0 +1,7 @@
+{
+  "submit-rangecheck-1-100": {
+    "file": "submit-rangecheck",
+    "template": "SubmissionRangeCheck",
+    "params": [1, 100, 7]
+  }
+}

apps/circuits/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "circuits",
+  "version": "0.0.1",
+  "description": "Guessing game circuits",
+  "license": "MIT",
+  "files": [
+    "**/*.circom",
+    "!main",
+    "!test",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "compile": "./scripts/build-circuit.sh",
+    "prove": "timeout 5s circomkit witness submit-rangecheck-1-100 in-range; timeout 5s circomkit prove submit-rangecheck-1-100 in-range",
+    "verify": "timeout 5s circomkit verify submit-rangecheck-1-100 in-range",
+    "clear": "circomkit clear",
+    "test": "mocha"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "circomlib": "2.0.5",
+    "snarkjs": "^0.7.4"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.6",
+    "@types/snarkjs": "^0.7.4",
+    "@zk-kit/baby-jubjub": "1.0.1",
+    "circomkit": "^0.2.1",
+    "mocha": "^10.2.0",
+    "poseidon-lite": "^0.2.0"
+  }
+}

apps/circuits/scripts/build-circuit.sh

@@ -0,0 +1,24 @@
+#!/bin/bash -e
+CIRCUIT=$1
+TIMEOUT_SEC="6s"
+
+# Yellow color escape code
+YELLOW='\033[1;33m'
+# Reset Color
+NC='\033[0m'
+
+
+echo -e "${YELLOW}Compiling ${CIRCUIT}${NC}"
+yarn circomkit compile ${CIRCUIT}
+
+echo -e "\n${YELLOW}Setting up ${CIRCUIT}${NC}"
+timeout ${TIMEOUT_SEC} yarn circomkit setup ${CIRCUIT} || true
+timeout ${TIMEOUT_SEC} yarn circomkit contract ${CIRCUIT} || true
+
+echo -e "\n${YELLOW}Copying circuit assets from app/circuits to app/contracts ${NC}"
+mkdir -p ../contracts/artifacts/circuits
+cp artifacts/build/${CIRCUIT}/${CIRCUIT}.r1cs ../contracts/artifacts/circuits/${CIRCUIT}.r1cs
+cp artifacts/build/${CIRCUIT}/plonk_pkey.zkey ../contracts/artifacts/circuits/${CIRCUIT}.zkey
+cp artifacts/build/${CIRCUIT}/${CIRCUIT}_js/${CIRCUIT}.wasm ../contracts/artifacts/circuits/${CIRCUIT}.wasm
+
+cp artifacts/build/${CIRCUIT}/plonk_verifier.sol ../contracts/contracts/${CIRCUIT}_verifier.sol

apps/circuits/src/inputs/submit-rangecheck-1-100/in-range.json

@@ -0,0 +1,3 @@
+{
+  "in": 1
+}

apps/circuits/src/inputs/submit-rangecheck-1-100/out-of-range.json

@@ -0,0 +1,3 @@
+{
+  "in": 101
+}

apps/circuits/src/main/submit-rangecheck-1-100.circom

@@ -0,0 +1,6 @@
+// auto-generated by circomkit
+pragma circom 2.1.6;
+
+include "../submit-rangecheck.circom";
+
+component main = SubmissionRangeCheck(1, 100, 7);

apps/circuits/src/submit-rangecheck.circom

@@ -0,0 +1,17 @@
+pragma circom 2.1.6;
+
+include "../../../node_modules/circomlib/circuits/comparators.circom";
+
+template SubmissionRangeCheck(min, max, nBit) {
+  signal input in;
+  signal output out;
+
+  component lessEqThan = LessEqThan(nBit);
+  lessEqThan.in <== [in, max];
+
+  component greaterEqThan = GreaterEqThan(nBit);
+  greaterEqThan.in <== [in, min];
+
+  out <== lessEqThan.out * greaterEqThan.out;
+  out === 1;
+}

apps/circuits/tests/common.ts

@@ -0,0 +1,11 @@
+import { Circomkit } from "circomkit";
+import { readFileSync } from "fs";
+import path from "path";
+
+const configFilePath = path.join(__dirname, "../circomkit.json");
+const config = JSON.parse(readFileSync(configFilePath, "utf-8"));
+
+export const circomkit = new Circomkit({
+  ...config,
+  verbose: false,
+});

apps/circuits/tests/submit-rangecheck.test.ts

@@ -0,0 +1,35 @@
+import { WitnessTester } from "circomkit";
+import { circomkit } from "./common";
+
+describe("submit-rangecheck", () => {
+  let circuit: WitnessTester<
+    ["in"] // private inputs
+  >;
+
+  const [MIN, MAX, NBITS] = [1, 100, 7];
+
+  before(async () => {
+    circuit = await circomkit.WitnessTester("submit-rangecheck", {
+      file: "submit-rangecheck",
+      template: "SubmissionRangeCheck",
+      params: [MIN, MAX, NBITS],
+    });
+  });
+
+  it("Should pass when the value is within range", async () => {
+    let INPUT = { in: MIN };
+    const OUT = { out: 1 };
+    await circuit.expectPass(INPUT, OUT);
+
+    INPUT = { in: MAX };
+    await circuit.expectPass(INPUT, OUT);
+  });
+
+  it("Should fail when the value is out of range", async () => {
+    let INPUT = { in: MIN - 1 };
+    await circuit.expectFail(INPUT);
+
+    INPUT = { in: MAX + 1 };
+    await circuit.expectFail(INPUT);
+  });
+});

apps/circuits/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "esModuleInterop": true
+  },
+  "include": ["tests/**/*"]
+}

apps/contracts/contracts/GuessingGame.sol

@@ -69,7 +69,10 @@ contract GuessingGame is IGuessingGame, Ownable {
     _;
   }
 
-  // View functions
+  /**
+   * View functions
+   **/
+
   function getGame(uint32 gameId) public view validGameId(gameId) returns (GameView memory) {
     Game storage game = games[gameId];
 
@@ -86,7 +89,14 @@ contract GuessingGame is IGuessingGame, Ownable {
       });
   }
 
-  // Helper functions
+  function getGameHost(uint32 gameId) public view validGameId(gameId) returns (address) {
+    Game storage game = games[gameId];
+    return game.players[0];
+  }
+
+  /**
+   * Helpers functions
+   **/
 
   function _verifyBidProof(
     bytes32 proof,
@@ -134,7 +144,9 @@ contract GuessingGame is IGuessingGame, Ownable {
     }
   }
 
-  // Main functions
+  /**
+   * Main functions
+   **/
 
   function newGame() external override returns (uint32 gameId) {
     Game storage game = games.push();