V0.1.0

[StefanosChaliasos]

PR of merging v0.1.0 to dev and then eventually merging it to the main branch and updating the website.

Description

In this version of zk-Harness, we aim to support more frameworks. Will also add support for two main circuits, exponentiate and sha256, using various inputs. Finally, we will produce results for both Mac and AWS servers.

General

• Clear files and update gitignores (e.g., https://github.com/zkCollective/zk-Harness/tree/v0.1.0/circom/inputs)
• Create general configuration files
• Clean up configs
• Functionality to run only new benchmarks
• Gather results from AWS instance
• Gather results from Mac
• Update UI to handle various machines
• Update input format (Input Format Synchronization  #14)
• Update benchmark results to benchmarks/<circuits|math>/<machine>/<framework>/
• Add --machine option to Python script, handle it in Makefile
• Merge https://github.com/zkCollective/zk-Harness/tree/feat/zkalc
• Move frameworks under frameworks dir
• Merge https://github.com/zkCollective/zk-Harness/tree/machine-structure
• Add installation instructions
• Add script to print a summary of a specific run

Documentation

• High-level documentation of circuits and their inputs.
• Display the high-level documentation and the explanation of the inputs in the UI.
• Qualitative table for supported frameworks
• Display qualitative table in the UI
• Update Documentation

halo2

• Currently, we support only halo2_pse. Add support for vanilla halo2
• Fix memory measuring (introduce memory usage benchmarks for Rust-based frameworks #24)
• Use sha256 inputs dynamically
• Fix _scripts/parsers/criterion_rust_parser.py
• Check if anything has broken
• Update logs format

Circom + snarkjs/rapidsnark

• Check if anything has broken
• Decouple snarkjs/rapidsnark, and add support for rapidsnark via configs
• Add support for C++ compilation?
• Update logs format

bellman

• Add tutorials
• Fix memory measuring (introduce memory usage benchmarks for Rust-based frameworks #24)
• Check if anything has broken
• Update logs format
• Fix exponentiate circuit

gnark

• Check if anything has broken
• Fix memory measuring (introduce memory usage benchmarks for Rust-based frameworks #24)
  Note: Memory Measurement currently only for gnark, issues with serialization of the CCS in the case of plonk for gnark v0.8.0.
• Merge branch feat/recursionTwoChain, closing PR Recursion specification, 2-Chain Recursion in gnark, PlonkFRI #25 for v0.1.0
• Refactoring and Cleanup
• Update logs format
• Fix gnark runner

starky

• Add SHA256
• Add Exponentiate
• Parsing
• Merge feat/starky
• Update logs format

[StefanosChaliasos]

For halo2 statistics, we can write a helper function to print some statistics per circuit given the input. Then we should call that from within the reader, similar to the binary we run for computing the memory.

[StefanosChaliasos]

Currently, the way we use time will fail in Linux machines. We should use something like: /usr/bin/time -v command, which will print something like:

	Command being timed: "ls"
	User time (seconds): 0.00
	System time (seconds): 0.00
	Percent of CPU this job got: 0%
	Elapsed (wall clock) time (h:mm:ss or m:ss): 0:00.00
	Average shared text size (kbytes): 0
	Average unshared data size (kbytes): 0
	Average stack size (kbytes): 0
	Average total size (kbytes): 0
	Maximum resident set size (kbytes): 2476
	Average resident set size (kbytes): 0
	Major (requiring I/O) page faults: 0
	Minor (reclaiming a frame) page faults: 125
	Voluntary context switches: 1
	Involuntary context switches: 0
	Swaps: 0
	File system inputs: 0
	File system outputs: 0
	Socket messages sent: 0
	Socket messages received: 0
	Signals delivered: 0
	Page size (bytes): 4096
	Exit status: 0

We should update that in the Python script and also handle it in the CSV parser

[StefanosChaliasos]

All rust memory measurements are now done #24

[StefanosChaliasos]

@tumberger, I think we don't need this one:

zk-Harness/rust_utils/Cargo.toml

Line 2 in 12508a9

name = "rust_utils"

anymore. If that is the case, can you remove it?

[StefanosChaliasos]

@tumberger, I haven't updated the logs for arithmetics. Should we do it here or in #17?