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.

Sign up for GitHub

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

chore(bb readme): Update versioning instructions and add Honk Solidity verifier commands #7608

Merged
merged 2 commits into from
Jul 25, 2024
Merged

chore(bb readme): Update versioning instructions and add Honk Solidity verifier commands #7608

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed84af8
chore(bb readme): Update versioning instructions and add honk solidit…
Savio-Sou Jul 25, 2024
87e7cb5
Update commit linked for command list
Savio-Sou Jul 25, 2024
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
22 changes: 12 additions & 10 deletions barretenberg/cpp/src/barretenberg/bb/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Loading