Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(boojum): Adding README to prover directory #189

Merged
merged 4 commits into from
Oct 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions prover/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Prover directory

This directory contains all the libraries and binaries related to proving of the blocks.

Directories with 'fri' suffix, are mostly used with the new proof system (Boojum).

## Components

### vk_setup_data_generator_server_fri

Set of tools to create setup keys, verification keys and verification key hashes for the circuits.

Usually run once, and then we use their outputs in multiple places in the system.

### prover_fri_gateway

Communication module between the 'main' server running the state keeper, and the proving subsystem.

### witness_generator

Creating prover jobs and saving necessary artifacts.

### prover_fri

This directory contains the main 'prover'. It can be run in two modes: either as CPU or as GPU. (controlled via 'gpu'
feature flag).

### witness_vector_generator

Only used in GPU proving mode. Prepares all the witness data using CPU, and then streams it to the prover_fri.

This is mosty used for resource efficiency (as machines with GPUs are more expensive, it allows us to run many
witness_vector_generators, that can 'share' as single gpu based prover_fri).

### proof_fri_compressor

Used as a 'last step' to compress/wrap the final FRI proof into a SNARK (to make L1 verification cheaper).

## Old proof system

Some of the components here belong to the old proof system:

- circuit_synthesizer
- prover
- setup_key_generator_and_server

Moreover old proof system is also using components from 'core' directory, like:

- core/bin/verification_key_generator_and_server
- core/lib/zksycn_core/src/witness_generator.