Skip to content

Commit

Permalink
files to include detailed descriptions of all formats produced by cir…
Browse files Browse the repository at this point in the history
…com compiler added (to be completed)
  • Loading branch information
alrubio committed Jan 13, 2024
1 parent 1eb7c92 commit 216f54b
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 2 deletions.
6 changes: 6 additions & 0 deletions mkdocs/docs/circom-language/formats/constraints-json.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: >-
This is a detailed description of the json R1CS format produced by the circom compiler when the flag --json is activated.
---
# R1CS json format

7 changes: 7 additions & 0 deletions mkdocs/docs/circom-language/formats/r1cs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: >-
This is a detailed description of the binary R1CS format produced by the circom compiler when the flag --r1cs is activated.
---
# R1CS binary format

The format divides the circuit description in five phases (there could be more in the future) ...
5 changes: 5 additions & 0 deletions mkdocs/docs/circom-language/formats/simplification-json.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: >-
This is a detailed description of the json format produced by the circom compiler when the flag --simplification_substitution is activated.
---
# Simplification substitution json format
7 changes: 7 additions & 0 deletions mkdocs/docs/circom-language/formats/sym.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: >-
This is a detailed description of the sym format produced by the circom compiler when the flag --sym is activated.
---
# sym format

The format provides a list of lines, where each line contains the information about a signal of the circuit except for the signal 0 which is always reserved to denote the constat one ("1").
4 changes: 2 additions & 2 deletions mkdocs/docs/getting-started/compilation-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ In the following, we explain these options.
#####Flags and options related to the compiler's output
* Flag ```--r1cs``` outputs the constraints in binary R1CS format (see the detailed format [here](../circom-language/formats/r1cs)).
* Flag ```--sym``` outputs for every signal of the circuit: the unique number given by the compiler, the circom qualified name, the number of the witness signal that contains it and the (unique) number of the component (given by the compiler) it belongs (see the detailed format and examples [here](../circom-language/formats/sym)).
* Flag ```--simplification_substitution``` outputs the substitutions performed by the --O1 and --O2 (default) constraint simplification options in json format (see the detailed format [here](../circom-language/formats/simplification_json)).
* Flag ```--simplification_substitution``` outputs the substitutions performed by the --O1 and --O2 (default) constraint simplification options in json format (see the detailed format [here](../circom-language/formats/simplification-json)).
* Flag ```--wasm``` produces a WebAssembly program that receives the private and public inputs and generates the circuit witness.
* Flag ```-c / --c``` produces a C++ program that receives the private and public inputs and generates the circuit witness.
* Flag ```--wat``` compiles the circuit to wat.
* Flag ```--json``` outputs the R1CS system in JSON format (see the detailed format [here](../circom-language/formats/constraints_json)).
* Flag ```--json``` outputs the R1CS system in JSON format (see the detailed format [here](../circom-language/formats/constraints-json)).
* Option ```-o / --output <output>``` allows to indicate the path to the directory where the output will be written. By default the path is ```.```.

#####Flags and options related to the constraint generation process
Expand Down

0 comments on commit 216f54b

Please sign in to comment.