Installation

I-Dependencies

• I-a) Node JS:
  • curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
  • source ~/.bashrc
  • nvm install --lts

• I-b) snarkjs:
  • npm install -g snarkjs
• I-c) Rust:
  • curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
  • rustup default stable
• I-d) build-essentials:
  • Debian (Ubuntu,...): sudo apt install gcc build-essential nlohmann-json3-dev libgmp3-dev nasm
  • Fedora: sudo dnf install make automake gcc gcc-c++ kernel-devel json-devel nasm gmp-devel
• I-e) Circom:
  • git clone https://github.com/iden3/circom.git
  • cd circom
  • cargo build --release
  • cargo install --path circom
  • Verify the installation: circom --version
• I-f) Time:
  • sudo apt install time

II-Minimum Hardware Requirements

Any Linux-based system with a 8GB+ RAM and relatively generous SWAP size (at least 16GB) could be in theory capable of running these benchmarks. However, we suggest a midrange laptop with relatively recent CPU for better results.

III-Building & Installing ProvenView

Once you have installed dependencies, you can proceed with setting up and running provenview. To obtain the latest version of provenview, head to directory of your choice and install provenview using the following command:

• Clone: git clone https://github.com/zero-savvy/proven-view.git
• Head to the nova directory: cd proven-view/nova/
• build and install provenview using cargo:
  • cargo build
  • cargo install --path .
  • verify installation of provenview: provenview --help

Building Circuits

go to the circuits directory:

cd ../circuits

build node modules:

npm install

build ZK circuits using the provided script in this directory:

./build_circuits.sh

Benchmarks

We've built the tools necessary for benchmarking using the samples provided in the samples directory. To do this, simply Go to the main directory of provenview repo and run the provided script:

./benchmark.sh 

This script reproduces the benchmarks for proving the construction of full VC in ZK (Table 6) with expected times and detailed report breakdowns.

How to Use (Detailed)

You can try to use the system with any video file that you have.

cd ../python
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt

execute commit phase:

python commit_phase.py

execute prove phase:

python prove_phase_full.py

• when promted, just press enter for default values!

Then, you can use the generated files (in the python/output/ directory) as the input for the actual proof:

provenview --function <FUNCTION>
--resolution <RESOLUTION> --input <FILE>
--circuit <R1CS FILE> --output <FILE>
--witnessgenerator <BINARY/WASM FILE>

which will be like this:

provenview --circuit ../circuits/merkle_fold_step.r1cs --function vector_commitment --input output/ --output folding-proof-file.json --witnessgenerator ../circuits/merkle_fold_step_cpp/merkle_fold_step

Use the built-in provenview --help command for detailes on flag/params. The expected output is as follows:

USAGE:
    provenview [OPTIONS] --circuit <R1CS FILE> --function <FUNCTION> --input <FILE> --output <FILE> --witnessgenerator <BINARY/WASM FILE>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --circuit <R1CS FILE>                    The R1CS file of the compiled Circom circuit.
    -f, --function <FUNCTION>                    The transformation function. [possible values: trim, vector_commitment]
    -i, --input <FILE>
      The JSON file containing the original and the transformed video data to verify.

    -o, --output <FILE>                          This file will contain the final Proof to be verified by others.
    -s, --synthetic <FOLDS>                      input value for folds (synthetic benchmarks). [default: 0]
    -w, --witnessgenerator <BINARY/WASM FILE>    Witness generator file of the circuit.