diff --git a/barretenberg/README.md b/barretenberg/README.md index 82e5d65486f..07a4bb6eaba 100644 --- a/barretenberg/README.md +++ b/barretenberg/README.md @@ -34,7 +34,7 @@ Barretenberg (or `bb` for short) is an optimized elliptic curve library for the - [WASM](#wasm) - [How to run](#how-to-run) - [Debugging](#debugging) - - [Debugging Verifification Failures](#debugging-verifification-failures) + - [Debugging Verification Failures](#debugging-verifification-failures) - [Improving LLDB Debugging](#improving-lldb-debugging) - [Using Tracy to Profile Memory/CPU](#using-tracy-to-profile-memorycpu) @@ -393,7 +393,7 @@ cmake --build --preset default --target run_ecc_bench #### Debugging Verifification Failures -The CicuitChecker::check_circuit function is used to get the gate index and block information about a failing circuit constraint. +The CircuitChecker::check_circuit function is used to get the gate index and block information about a failing circuit constraint. If you are in a scenario where you have a failing call to check_circuit and wish to get more information out of it than just the gate index, you can use this feature to get a stack trace, see example below. Usage instructions: diff --git a/barretenberg/acir_tests/README.md b/barretenberg/acir_tests/README.md index af6bc622d6b..5a33c7d05e6 100644 --- a/barretenberg/acir_tests/README.md +++ b/barretenberg/acir_tests/README.md @@ -5,7 +5,7 @@ The aim is to verify acir tests verify through a given backend binary. "Backend - bb (native CLI) - bb.js (typescript CLI) - bb.js-dev (symlink in your PATH that runs the typescript CLI via ts-node) -- bb.js.browser (script in `headless-test` that runs a a test through bb.js in a browser instance via playwright) +- bb.js.browser (script in `headless-test` that runs a test through bb.js in a browser instance via playwright) To run: @@ -34,7 +34,7 @@ $ BIN=../ts/bb.js-dev VERBOSE=1 ./run_acir_tests.sh 1_mul $ BIN=./headless-test/bb.js.browser VERBOSE=1 ./run_acir_tests.sh 1_mul ``` -You can specify a different testing "flow" with with `FLOW` environment variable. Flows are in the `flows` dir. +You can specify a different testing "flow" with `FLOW` environment variable. Flows are in the `flows` dir. The default flow is `prove_and_verify`, which is the quickest way to... prove and verify. It's used to test the acir test vectors actually all pass in whichever version of the backend is being run. The `all_cmds` flow tests all the supported commands on the binary. Slower, but is there to test the cli. @@ -59,4 +59,4 @@ To generate a new input you can run the script again. To generate a new file und You can then copy these inputs over to your working branch in Noir and regenerate the witness for `double_verify_proof`. You can then change the branch in `run_acir_tests.sh` to this Noir working branch as well and `double_verify_proof` should pass. -The same process should then be repeated, but now `double_verify_proof_recursive` will be the circuit for which we will be generating recursive inputs using `gen_inner_proof_inputs.sh`. The recursive artifacts should then supplied as inputs to `double_verify_nested_proof`. \ No newline at end of file +The same process should then be repeated, but now `double_verify_proof_recursive` will be the circuit for which we will be generating recursive inputs using `gen_inner_proof_inputs.sh`. The recursive artifacts should then be supplied as inputs to `double_verify_nested_proof`. diff --git a/barretenberg/bbup/README.md b/barretenberg/bbup/README.md index 818dfe3fafa..a2c009fe5d0 100644 --- a/barretenberg/bbup/README.md +++ b/barretenberg/bbup/README.md @@ -45,7 +45,7 @@ You can install any specific version of `bb` with the `-v` flag. Example: bbup -v 0.56.0 ``` -You can also can pass [any Noir version](https://github.com/noir-lang/noir/tags) with the `-nv` flag, or specify `nightly` for the nightly version. Examples: +You can also pass [any Noir version](https://github.com/noir-lang/noir/tags) with the `-nv` flag, or specify `nightly` for the nightly version. Examples: ```bash bbup # installs the barretenberg version matching your current nargo version diff --git a/barretenberg/cpp/pil/avm/README.txt b/barretenberg/cpp/pil/avm/README.txt index cf63996a3c2..8d24c888096 100644 --- a/barretenberg/cpp/pil/avm/README.txt +++ b/barretenberg/cpp/pil/avm/README.txt @@ -4,7 +4,7 @@ Applied heuristic to assess the cost of a relation is given below. This will be used to determine whether it is worth to merge some relations into one. -N_mul = number of mulitplication in the relation +N_mul = number of multiplication in the relation N_add = number of additions/subtraction in the relation deg = degree of the relation (total degree of the polynomial) @@ -18,4 +18,4 @@ Future: There is an optimization in sumcheck protocol allowing to skip some enabled over 2 adjacent rows). However, this feature is not yet enabled in the AVM context. This might change the decision on whether some relations should be merged or not. Basically, merging relations would decrease the - likelihood to be disabled over adjacent rows. \ No newline at end of file + likelihood to be disabled over adjacent rows.