chore: updated ACIR documentation and other docs

acvm-repo/acir/acir_docs.md

@@ -6,14 +6,14 @@
 ## Introduction
 The purpose of ACIR is to make the link between a generic proving system, such as Aztec's Barretenberg, and a frontend, such as Noir, which describes user-specific computations.
 
-More precisely, Noir is a programming language for zero-knowledge proofs (ZKP) which allows users to write programs in an intuitive way using a high-level language close to Rust syntax. Noir is able to generate a proof of execution of a Noir program, using an external proving system. However, proving systems uses specific low-level constrain-based languages. Similarly, frontends have their own internal representation in order to represent user programs.
+More precisely, Noir is a programming language for zero-knowledge proofs (ZKP) which allows users to write programs in an intuitive way using a high-level language close to Rust syntax. Noir is able to generate a proof of execution of a Noir program, using an external proving system. However, proving systems use specific low-level constrain-based languages. Similarly, frontends have their own internal representation in order to represent user programs.
 
 The goal of ACIR is to provide a generic open-source intermediate representation close to proving system 'languages', but agnostic to a specific proving system, that can be used both by proving system as well as a target for frontends. So, at the end of the day, an ACIR program is just another representation of a program, dedicated to proving systems.
 
 ## Abstract Circuit Intermediate Representation
 ACIR stands for abstract circuit intermediate representation:
 - **abstract circuit**: circuits are a simple computation model where basic computation units, named gates, are connected with wires. Data flows through the wires while gates compute output wires based on their input. More formally, they are directed acyclic graphs (DAG) where the vertices are the gates and the edges are the wires. Due to the immutability nature of the wires (their value does not change during an execution), they are well suited for describing computations for ZKPs. Furthermore, we do not lose any expressiveness when using a circuit as it is well known that any bounded computation can be translated into an arithmetic circuit (i.e a circuit with only addition and multiplication gates).
-The term abstract here simply mean that we do not refer to an actual physical circuit (such as an electronic circuit). Furthermore, we will not exactly use the circuit model, but another model even better suited to ZKPs, the constraint model (see below).
+The term abstract here simply means that we do not refer to an actual physical circuit (such as an electronic circuit). Furthermore, we will not exactly use the circuit model, but another model even better suited to ZKPs, the constraint model (see below).
 - **intermediate representation**: The ACIR representation is intermediate because it lies between a frontend and its proving system. ACIR bytecode makes the link between noir compiler output and the proving system backend input.
 
 ## The constraint model
@@ -32,13 +32,13 @@
 In summary, the workflow is the following:
 1. user program -> (compilation) ACIR, a list of opcodes which constrain (partial) witnesses
 2. user inputs + ACIR -> (execution/solving) assign values to all the (partial) witnesses 
-3. witness assignement + ACIR -> (proving system) proof
+3. witness assignment + ACIR -> (proving system) proof
 
 
 Although the ordering of opcode does not matter in theory, since a system of equations is not dependent on its ordering, in practice it matters a lot for the solving (i.e the performance of the execution). ACIR opcodes **must be ordered** so that each opcode can be resolved one after the other.
 
 
-The values of the witnesses lie in the scalar field of the proving system. We will refer to it as FieldElement or ACIR field. The proving system need the values of all the partial witnesses and all the constraints in order to generate a proof.
+The values of the witnesses lie in the scalar field of the proving system. We will refer to it as FieldElement or ACIR field. The proving system needs the values of all the partial witnesses and all the constraints in order to generate a proof.
 
 
 *Remark*: The value of a partial witness is unique and fixed throughout a program execution, although in some rare cases, multiple values are possible for a same execution and witness (when there are several valid solutions to the constraints). Having multiple possible values for a witness may indicate that the circuit is not safe.
@@ -51,7 +51,7 @@
 
 Some opcodes have inputs and outputs, which means that the output is constrained to be the result of the opcode computation from the inputs. The solver expects that all inputs are known when solving such opcodes.
 
-Some opcodes are not constrained, which mean they will not be used by the proving system and are only used by the solver.
+Some opcodes are not constrained, which means they will not be used by the proving system and are only used by the solver.
 
 Finally, some opcodes will have a predicate, whose value is 0 or 1. Its purpose is to nullify the opcode when the value is 0, so that it has no effect. Note that removing the opcode is not a solution because this modifies the circuit (the circuit being mainly the list of the opcodes). 
 
@@ -71,7 +71,7 @@
 
 ### BlackBoxFuncCall opcode
 These opcodes represent a specific computation. Even if any computation can be done using only assert-zero opcodes, it is not always efficient. Some proving systems, and in particular the proving system from Aztec, can implement several computations more efficiently using for instance look-up tables. The BlackBoxFuncCall opcode is used to ask the proving system to handle the computation by itself.
-All black box functions takes as input a tuple (witness, num_bits), where num_bits is a constant representing the bit size of the input witness, and they have one or several witnesses as output.
+All black box functions take as input a tuple (witness, num_bits), where num_bits is a constant representing the bit size of the input witness, and they have one or several witnesses as output.
 Some more advanced computations assume that the proving system has an 'embedded curve'. It is a curve that cycle with the main curve of the proving system, i.e the scalar field of the embedded curve is the base field of the main one, and vice-versa. The curves used by the proving system are dependent on the proving system (and/or its configuration). Aztec's Barretenberg uses BN254 as the main curve and Grumpkin as the embedded curve.
 
 The black box functions supported by ACIR are:
@@ -187,10 +187,10 @@
 In summary, solving a Brillig opcode performs the computation defined by its bytecode, on the provided inputs, and assign the result to the outputs witnesses, without adding any constraint.
 
 ### Directive
 This opcode is a specialisation of Brillig opcode. Instead of having some generic assembly code like Brillig, a directive has a hardcoded name which tells the solver which computation to do: with Brillig, the computation refers to the compiled bytecode of an unconstrained Noir function, but with a directive, the computation is hardcoded inside the compiler. Directives will be replaced by Brillig opcodes in the future.
 
 ### MemoryOp: memory abstraction for ACIR
 ACIR is able to address any array of witnesses. Each array is assigned an id (BlockId) and needs to be initialised with the MemoryInit opcode. Then it is possible to read and write from/to an array by providing the index and the value we read/write, as arithmetic expression. Note that ACIR arrays all have a known fixed length (given in the MemoryInit opcode below)
 - block_id: identifier of the array
 - op: describe the memory operation to perform
 	- operation: constant expression having value 1 for a write to memory and 0 for a read
@@ -199,7 +199,7 @@
 - predicate: an arithmetic expression that disable the opcode when it is null.
 
 ### MemoryInit
 Initialise an ACIR array from a vector of witnesses.
 - block_id: identifier of the array
 - init: Vector of witnesses specifying the initial value of the arrays
 

cspell.json

@@ -64,6 +64,7 @@
         "gloo",
         "grumpkin",
         "Guillaume",
+        "gzipped",
         "hasher",
         "hexdigit",
         "higher-kinded",

docs/docs/getting_started/installation/index.md

@@ -1,7 +1,7 @@
 ---
 title: Nargo Installation
 description:
-  nargo is a command line tool for interacting with Noir programs. This page is a quick guide on how to install Nargo though the most common and easy method, noirup
+  nargo is a command line tool for interacting with Noir programs. This page is a quick guide on how to install Nargo through the most common and easy method, noirup
 keywords: [
    Nargo
    Noir

docs/docs/getting_started/tooling/testing.md

@@ -24,7 +24,7 @@ fn test_add() {
 }
 ```
 
-Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
+Running `nargo test` will test that the `test_add` function can be executed while satisfying all
 the constraints which allows you to test that add returns the expected values. Test functions can't
 have any arguments currently.
 

docs/docs/migration_notes.md

@@ -50,7 +50,7 @@ If you are using the default barretenberg backend, simply run:
 nargo prove
 ```
 
-with you Noir program.
+with your Noir program.
 
 This will trigger the download and installation of the latest version of barretenberg compatible with your Nargo in use.
 
@@ -78,7 +78,7 @@ nargo backend install acvm-backend-barretenberg https://github.com/noir-lang/bar
 
 This downloads and installs a specific bb.js based version of barretenberg binary from GitHub.
 
-The gzipped filed is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
+The gzipped file is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
 
 Then run:
 

docs/docs/noir/standard_library/logging.md

@@ -22,7 +22,7 @@ The standard library provides two familiar statements you can use: `println` and
 
 You can print the output of both statements in your Noir code by using the `nargo execute` command or the `--show-output` flag when using `nargo test` (provided there are print statements in your tests).
 
-It is recommended to use `nargo execute` if you want to debug failing constrains with `println` or `print` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). Neither `println`, nor `print` are callable for failed constraints caught at compile time.
+It is recommended to use `nargo execute` if you want to debug failing constraints with `println` or `print` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). Neither `println`, nor `print` are callable for failed constraints caught at compile time.
 
 Both `print` and `println` are generic functions which can work on integers, fields, strings, and even structs or expressions. Note however, that slices are currently unsupported. For example:
 

docs/versioned_docs/version-v0.17.0/index.md

@@ -25,7 +25,7 @@ slug: /
 
 Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.
 
-It's design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
+Its design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
 
 ## Who is Noir for?
 

docs/versioned_docs/version-v0.17.0/migration_notes.md

@@ -42,7 +42,7 @@ If you are using the default barretenberg backend, simply run:
 nargo prove
 ```
 
-with you Noir program.
+with your Noir program.
 
 This will trigger the download and installation of the latest version of barretenberg compatible with your Nargo in use.
 
@@ -70,7 +70,7 @@ nargo backend install acvm-backend-barretenberg https://github.com/noir-lang/bar
 
 This downloads and installs a specific bb.js based version of barretenberg binary from GitHub.
 
-The gzipped filed is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
+The gzipped file is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
 
 Then run:
 

docs/versioned_docs/version-v0.17.0/nargo/02_testing.md

@@ -23,7 +23,7 @@ fn test_add() {
 }
 ```
 
-Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
+Running `nargo test` will test that the `test_add` function can be executed while satisfying all
 the constraints which allows you to test that add returns the expected values. Test functions can't
 have any arguments currently.
 

docs/versioned_docs/version-v0.17.0/standard_library/logging.md

@@ -22,7 +22,7 @@ implementation of rust's `println!` macro, this construct can be useful for debu
 
 You can print the output of println statements in your Noir code by using the `nargo execute` command or the `--show-output` flag when using `nargo test` (provided there are println statements in your tests).
 
-It is recommended to use `nargo execute` if you want to debug failing constrains with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
+It is recommended to use `nargo execute` if you want to debug failing constraints with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
 
 The `println` statement is unconstrained, so it works for outputting integers, fields, strings, and even structs or expressions. For example:
 

docs/versioned_docs/version-v0.19.0/index.md

@@ -25,7 +25,7 @@ slug: /
 
 Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.
 
-It's design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
+Its design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
 
 ## Who is Noir for?
 

docs/versioned_docs/version-v0.19.0/migration_notes.md

@@ -50,7 +50,7 @@ If you are using the default barretenberg backend, simply run:
 nargo prove
 ```
 
-with you Noir program.
+with your Noir program.
 
 This will trigger the download and installation of the latest version of barretenberg compatible with your Nargo in use.
 
@@ -78,7 +78,7 @@ nargo backend install acvm-backend-barretenberg https://github.com/noir-lang/bar
 
 This downloads and installs a specific bb.js based version of barretenberg binary from GitHub.
 
-The gzipped filed is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
+The gzipped file is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
 
 Then run:
 

docs/versioned_docs/version-v0.19.0/nargo/02_testing.md

@@ -23,7 +23,7 @@ fn test_add() {
 }
 ```
 
-Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
+Running `nargo test` will test that the `test_add` function can be executed while satisfying all
 the constraints which allows you to test that add returns the expected values. Test functions can't
 have any arguments currently.
 

docs/versioned_docs/version-v0.19.0/standard_library/logging.md

@@ -22,7 +22,7 @@ implementation of rust's `println!` macro, this construct can be useful for debu
 
 You can print the output of println statements in your Noir code by using the `nargo execute` command or the `--show-output` flag when using `nargo test` (provided there are println statements in your tests).
 
-It is recommended to use `nargo execute` if you want to debug failing constrains with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
+It is recommended to use `nargo execute` if you want to debug failing constraints with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
 
 The `println` statement is unconstrained, so it works for outputting integers, fields, strings, and even structs or expressions. For example:
 

docs/versioned_docs/version-v0.19.1/index.md

@@ -25,7 +25,7 @@ slug: /
 
 Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.
 
-It's design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
+Its design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
 
 ## Who is Noir for?
 

docs/versioned_docs/version-v0.19.1/migration_notes.md

@@ -50,7 +50,7 @@ If you are using the default barretenberg backend, simply run:
 nargo prove
 ```
 
-with you Noir program.
+with your Noir program.
 
 This will trigger the download and installation of the latest version of barretenberg compatible with your Nargo in use.
 
@@ -78,7 +78,7 @@ nargo backend install acvm-backend-barretenberg https://github.com/noir-lang/bar
 
 This downloads and installs a specific bb.js based version of barretenberg binary from GitHub.
 
-The gzipped filed is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
+The gzipped file is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
 
 Then run:
 

docs/versioned_docs/version-v0.19.1/nargo/02_testing.md

@@ -23,7 +23,7 @@ fn test_add() {
 }
 ```
 
-Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
+Running `nargo test` will test that the `test_add` function can be executed while satisfying all
 the constraints which allows you to test that add returns the expected values. Test functions can't
 have any arguments currently.
 

docs/versioned_docs/version-v0.19.1/standard_library/logging.md

@@ -22,7 +22,7 @@ implementation of rust's `println!` macro, this construct can be useful for debu
 
 You can print the output of println statements in your Noir code by using the `nargo execute` command or the `--show-output` flag when using `nargo test` (provided there are println statements in your tests).
 
-It is recommended to use `nargo execute` if you want to debug failing constrains with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
+It is recommended to use `nargo execute` if you want to debug failing constraints with `println` statements. This is due to every input in a test being a constant rather than a witness, so we issue an error during compilation while we only print during execution (which comes after compilation). `println` will not work for failed constraints caught at compile time.
 
 The `println` statement is unconstrained, so it works for outputting integers, fields, strings, and even structs or expressions. For example:
 

docs/versioned_docs/version-v0.19.2/index.md

@@ -25,7 +25,7 @@ slug: /
 
 Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.
 
-It's design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
+Its design choices are influenced heavily by Rust and focuses on a simple, familiar syntax.
 
 ## Who is Noir for?
 

docs/versioned_docs/version-v0.19.2/migration_notes.md

@@ -50,7 +50,7 @@ If you are using the default barretenberg backend, simply run:
 nargo prove
 ```
 
-with you Noir program.
+with your Noir program.
 
 This will trigger the download and installation of the latest version of barretenberg compatible with your Nargo in use.
 
@@ -78,7 +78,7 @@ nargo backend install acvm-backend-barretenberg https://github.com/noir-lang/bar
 
 This downloads and installs a specific bb.js based version of barretenberg binary from GitHub.
 
-The gzipped filed is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
+The gzipped file is running [this bash script](https://github.com/noir-lang/barretenberg-js-binary/blob/master/run-bb-js.sh), where we need to gzip it as the Nargo currently expect the backend to be zipped up.
 
 Then run:
 

docs/versioned_docs/version-v0.19.2/nargo/02_testing.md

@@ -23,7 +23,7 @@ fn test_add() {
 }
 ```
 
-Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
+Running `nargo test` will test that the `test_add` function can be executed while satisfying all
 the constraints which allows you to test that add returns the expected values. Test functions can't
 have any arguments currently.