From 9dd9195d8da2d7e2bc85d39e53b33cc82597da1f Mon Sep 17 00:00:00 2001 From: Savio <72797635+Savio-Sou@users.noreply.github.com> Date: Fri, 26 Jul 2024 03:48:20 +0900 Subject: [PATCH] chore(bb readme): Update versioning instructions and add Honk Solidity verifier commands (#7608) ### Summary - Supplement additional Noir <> BB version matching instructions - Update list of commands linked to include new Honk Solidity verifier generation commands --- .../cpp/src/barretenberg/bb/readme.md | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/barretenberg/cpp/src/barretenberg/bb/readme.md b/barretenberg/cpp/src/barretenberg/bb/readme.md index 99f4339ecce..d0ae01e75a1 100644 --- a/barretenberg/cpp/src/barretenberg/bb/readme.md +++ b/barretenberg/cpp/src/barretenberg/bb/readme.md @@ -28,12 +28,14 @@ This binary will take as input ACIR and witness values described in the IR to cr source ~/.bashrc ``` -3. Install the version of `bb` compatible with your Noir version: +3. Install the version of `bb` compatible with your Noir version; with Noir v0.32.0 for example: ```bash bbup -v 0.46.1 ``` + Check the version compatibility section below for how to identify matching versions. + 4. Check if the installation was successful: ```bash @@ -42,25 +44,25 @@ This binary will take as input ACIR and witness values described in the IR to cr If installation was successful, the command would print the version of `bb` installed. +### Version compatibility with Noir + +TODO: https://github.com/AztecProtocol/aztec-packages/issues/7511 + +For quick reference: +- Noir v0.32.0 <> BB v0.46.1 +- Noir v0.31.0 <> BB v0.41.0 + ### Usage TODO: https://github.com/AztecProtocol/aztec-packages/issues/7600 Full list of available commands: -https://github.com/AztecProtocol/aztec-packages/blob/840486e5ce6b41d6c873239de108b3731dd81101/barretenberg/cpp/src/barretenberg/bb/main.cpp#L1290-L1414 +https://github.com/AztecProtocol/aztec-packages/blob/1a97698071a667cd56510c7b7201373a9ac9c646/barretenberg/cpp/src/barretenberg/bb/main.cpp#L1361-L1493 #### FilePath vs Stdout For commands which allow you to send the output to a file using `-o {filePath}`, there is also the option to send the output to stdout by using `-o -`. -### Version compatibility with Noir - -TODO: https://github.com/AztecProtocol/aztec-packages/issues/7511 - -For quick reference: -- Noir v0.32.0 <> BB v0.46.1 -- Noir v0.31.0 <> BB v0.41.0 - ### Maximum circuit size Currently the binary downloads an SRS that can be used to prove the maximum circuit size. This maximum circuit size parameter is a constant in the code and has been set to $2^{23}$ as of writing. This maximum circuit size differs from the maximum circuit size that one can prove in the browser, due to WASM limits.