Add scripts for Circom circuits

Author: OmegaTymbJIep

.gitignore

@@ -1,5 +1,6 @@
 .idea
 
+/node_modules
 /target
 
 *.dev.*

scripts/README.md

@@ -0,0 +1,6 @@
+# Auxiliaries scripts:
+- ``` compile-circuit.sh <circuit_name> ```
+- ``` trusted-setup.sh <powers> ```
+- ``` export-keys.sh <circuit_name> <powers> ```
+- ``` prove.sh <circuit_name> <path_to_input_file> ```
+- ``` verify.sh <circuit_name> ```

scripts/compile-circuit.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+set -e
+
+CIRCUIT_NAME=$1
+BUILD_DIR=""
+CIRCUIT_FILE=""
+
+# Define the build directory where intermediate files will be stored
+if [ -d ./circuits ]; then
+    BUILD_DIR="./$CIRCUIT_NAME.dev"
+    CIRCUIT_FILE="./circuits/$CIRCUIT_NAME.circom"
+elif [ -d ../circuits ]; then
+    BUILD_DIR="../$CIRCUIT_NAME.dev"
+    CIRCUIT_FILE="../circuits/$CIRCUIT_NAME.circom"
+else
+    echo "Error: can't find way to circuits folder: unknow directory."
+    exit 1
+fi
+
+if [ -z "$CIRCUIT_NAME" ]; then
+    echo "Error: CIRCUIT_NAME is empty."
+    exit 1
+elif [ ! -e "$CIRCUIT_FILE" ]; then
+    echo "Error: circuit doesn't exist."
+    exit 1
+fi
+
+rm -rf ${BUILD_DIR}
+mkdir -p ${BUILD_DIR}
+
+# Compiling circuit with .r1cs and .wasm files as result
+echo -e "\nCompiling the circuits..."
+
+circom ${CIRCUIT_FILE} --r1cs --wasm --sym -o ${BUILD_DIR}
+
+mv ${BUILD_DIR}/${CIRCUIT_NAME}_js/${CIRCUIT_NAME}.wasm ${BUILD_DIR}/mul.wasm
+
+#snarkjs r1cs print ${BUILD_DIR}/${CIRCUIT_NAME}.r1cs ${BUILD_DIR}/${CIRCUIT_NAME}.sym
+
+echo -e "\nCircuit compiled ${BUILD_DIR}"

scripts/export-keys.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+set -e
+
+CIRCUIT_NAME=$1
+SETUP_POWERS=$2
+POWERS_FILE=""
+BUILD_DIR=""
+
+# Define the build directory where intermediate files will be stored
+if [ -d ./circuits ]; then
+    BUILD_DIR="./$CIRCUIT_NAME.dev"
+    POWERS_FILE=./powers.dev/$SETUP_POWERS.ptau
+elif [ -d ../circuits ]; then
+    BUILD_DIR="../$CIRCUIT_NAME.dev"
+    POWERS_FILE=../powers.dev/$SETUP_POWERS.ptau
+else
+    echo "Error: can't find way to circuits folder: unknow directory."
+    exit 1
+fi
+
+rm -rf ${BUILD_DIR}/zkey
+mkdir -p ${BUILD_DIR}/zkey
+
+# Exporting key with verification_key.json, verifier.sol and circtuis_final.zkey as a result
+echo -e "\nExporting keys..."
+
+snarkjs groth16 setup ${BUILD_DIR}/${CIRCUIT_NAME}.r1cs ${POWERS_FILE} ${BUILD_DIR}/${CIRCUIT_NAME}_0000.zkey -v
+echo `xxd -l 128 -p /dev/urandom` | snarkjs zkey contribute ${BUILD_DIR}/${CIRCUIT_NAME}_0000.zkey ${BUILD_DIR}/circuit_final.zkey --name="Someone" -v
+
+snarkjs zkey export verificationkey ${BUILD_DIR}/circuit_final.zkey ${BUILD_DIR}/verification_key.json
+snarkjs zkey export solidityverifier ${BUILD_DIR}/circuit_final.zkey ${BUILD_DIR}/verifier.sol
+
+# Removing redudant files
+rm -rf ${BUILD_DIR}/zkey ${BUILD_DIR}/${CIRCUIT_NAME}_0000.zkey
+
+echo -e "\nKeys exported $BUILD_DIR/circuit_final.zkey, $BUILD_DIR/verification_key.json, $BUILD_DIR/verifier.sol"

scripts/prove.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -e
+
+CIRCUIT_NAME=$1
+INPUT_FILE=$2
+BUILD_DIR="$CIRCUIT_NAME.dev"
+
+# Define the build directory where intermediate files will be stored
+if [ -d ./$BUILD_DIR ]; then
+    BUILD_DIR="./$BUILD_DIR"
+elif [ -d ../$BUILD_DIR ]; then
+    BUILD_DIR="../$BUILD_DIR"
+else
+    echo "Error: can't find way to build folder '$BUILD_DIR': unknow directory."
+    exit 1
+fi
+
+if [ ! -e "$INPUT_FILE" ]; then
+    echo "Error: can't find the input file '$INPUT_FILE'"
+    exit 1
+fi
+
+echo -e "\nProving..."
+
+node ${BUILD_DIR}/${CIRCUIT_NAME}_js/generate_witness.js ${BUILD_DIR}/${CIRCUIT_NAME}.wasm ${INPUT_FILE} ${BUILD_DIR}/witness.wtns
+
+snarkjs groth16 prove ${BUILD_DIR}/circuit_final.zkey ${BUILD_DIR}/witness.wtns ${BUILD_DIR}/proof.json ${BUILD_DIR}/public.json
+
+echo -e "Proof generated ${BUILD_DIR}/proof.json"

scripts/trusted-setup.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -e
+
+SETUP_POWERS=$1
+BUILD_DIR=powers.dev
+
+# Define the build directory where intermediate files will be stored
+if [ -d ./circuits ]; then
+    BUILD_DIR="./$BUILD_DIR"
+elif [ -d ../circuits ]; then
+    BUILD_DIR="../$BUILD_DIR"
+else
+    echo "Error: can't find way to circuits folder: unknow directory."
+    exit 1
+fi
+
+mkdir -p $BUILD_DIR/$SETUP_POWERS
+
+# Generatin trusted setup as powers/SETUP_POWERS.ptau
+echo -e "\Generating trustep setup..."
+
+snarkjs powersoftau new bn128 ${SETUP_POWERS} ${BUILD_DIR}/${SETUP_POWERS}/pot${SETUP_POWERS}_0000.ptau
+echo `xxd -l 128 -p /dev/urandom` | snarkjs powersoftau contribute ${BUILD_DIR}/${SETUP_POWERS}/pot${SETUP_POWERS}_0000.ptau ${BUILD_DIR}/${SETUP_POWERS}/pot${SETUP_POWERS}_0001.ptau --name="Someone" -v
+
+snarkjs powersoftau prepare phase2 ${BUILD_DIR}/${SETUP_POWERS}/pot${SETUP_POWERS}_0001.ptau ${BUILD_DIR}/${SETUP_POWERS}.ptau -v
+
+# Removing redudant files
+rm -rf $BUILD_DIR/$SETUP_POWERS
+
+echo -e "\nTrusted setup generated $BUILD_DIR/$SETUP_POWERS.ptau"

scripts/verify.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+
+CIRCUIT_NAME=$1
+BUILD_DIR="$CIRCUIT_NAME.dev"
+
+# Define the build directory where intermediate files will be stored
+if [ -d ./$BUILD_DIR ]; then
+    BUILD_DIR="./$BUILD_DIR"
+elif [ -d ../$BUILD_DIR ]; then
+    BUILD_DIR="../$BUILD_DIR"
+else
+    echo "Error: can't find way to build folder '$BUILD_DIR': unknow directory."
+    exit 1
+fi
+
+# Verifying proof
+echo -e "\nVerifying..."
+
+snarkjs groth16 verify ${BUILD_DIR}/verification_key.json ${BUILD_DIR}/public.json ${BUILD_DIR}/proof.json
+
+echo -e "Verified ${BUILD_DIR}/proof.json"