-
Notifications
You must be signed in to change notification settings - Fork 204
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): cut new docs version for tag v..
- Loading branch information
1 parent
cdb6a2c
commit 4dd2cbd
Showing
94 changed files
with
6,775 additions
and
0 deletions.
There are no files selected for viewing
177 changes: 177 additions & 0 deletions
177
docs/versioned_docs/version-v../explainers/explainer-recursion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
--- | ||
title: Recursive proofs | ||
description: Explore the concept of recursive proofs in Zero-Knowledge programming. Understand how recursion works in Noir, a language for writing smart contracts on the EVM blockchain. Learn through practical examples like Alice and Bob's guessing game, Charlie's recursive merkle tree, and Daniel's reusable components. Discover how to use recursive proofs to optimize computational resources and improve efficiency. | ||
|
||
keywords: | ||
[ | ||
"Recursive Proofs", | ||
"Zero-Knowledge Programming", | ||
"Noir", | ||
"EVM Blockchain", | ||
"Smart Contracts", | ||
"Recursion in Noir", | ||
"Alice and Bob Guessing Game", | ||
"Recursive Merkle Tree", | ||
"Reusable Components", | ||
"Optimizing Computational Resources", | ||
"Improving Efficiency", | ||
"Verification Key", | ||
"Aggregation Objects", | ||
"Recursive zkSNARK schemes", | ||
"PLONK", | ||
"Proving and Verification Keys" | ||
] | ||
sidebar_position: 1 | ||
--- | ||
|
||
In programming, we tend to think of recursion as something calling itself. A classic example would be the calculation of the factorial of a number: | ||
|
||
```js | ||
function factorial(n) { | ||
if (n === 0 || n === 1) { | ||
return 1; | ||
} else { | ||
return n * factorial(n - 1); | ||
} | ||
} | ||
``` | ||
|
||
In this case, while `n` is not `1`, this function will keep calling itself until it hits the base case, bubbling up the result on the call stack: | ||
|
||
```md | ||
Is `n` 1? <--------- | ||
/\ / | ||
/ \ n = n -1 | ||
/ \ / | ||
Yes No -------- | ||
``` | ||
|
||
In Zero-Knowledge, recursion has some similarities. | ||
|
||
It is not a Noir function calling itself, but a proof being used as an input to another circuit. In short, you verify one proof *inside* another proof, returning the proof that both proofs are valid. | ||
|
||
This means that, given enough computational resources, you can prove the correctness of any arbitrary number of proofs in a single proof. This could be useful to design state channels (for which a common example would be [Bitcoin's Lightning Network](https://en.wikipedia.org/wiki/Lightning_Network)), to save on gas costs by settling one proof on-chain, or simply to make business logic less dependent on a consensus mechanism. | ||
|
||
## Examples | ||
|
||
Let us look at some of these examples | ||
|
||
### Alice and Bob - Guessing game | ||
|
||
Alice and Bob are friends, and they like guessing games. They want to play a guessing game online, but for that, they need a trusted third-party that knows both of their secrets and finishes the game once someone wins. | ||
|
||
So, they use zero-knowledge proofs. Alice tries to guess Bob's number, and Bob will generate a ZK proof stating whether she succeeded or failed. | ||
|
||
This ZK proof can go on a smart contract, revealing the winner and even giving prizes. However, this means every turn needs to be verified on-chain. This incurs some cost and waiting time that may simply make the game too expensive or time-consuming to be worth it. | ||
|
||
As a solution, Alice proposes the following: "what if Bob generates his proof, and instead of sending it on-chain, I verify it *within* my own proof before playing my own turn?". | ||
|
||
She can then generate a proof that she verified his proof, and so on. | ||
|
||
```md | ||
Did you fail? <-------------------------- | ||
/ \ / | ||
/ \ n = n -1 | ||
/ \ / | ||
Yes No / | ||
| | / | ||
| | / | ||
| You win / | ||
| / | ||
| / | ||
Generate proof of that / | ||
+ / | ||
my own guess ---------------- | ||
``` | ||
|
||
### Charlie - Recursive merkle tree | ||
|
||
Charlie is a concerned citizen, and wants to be sure his vote in an election is accounted for. He votes with a ZK proof, but he has no way of knowing that his ZK proof was included in the total vote count! | ||
|
||
If the vote collector puts all of the votes into a [Merkle tree](https://en.wikipedia.org/wiki/Merkle_tree), everyone can prove the verification of two proofs within one proof, as such: | ||
|
||
```md | ||
abcd | ||
__________|______________ | ||
| | | ||
ab cd | ||
_____|_____ ______|______ | ||
| | | | | ||
alice bob charlie daniel | ||
``` | ||
|
||
Doing this recursively allows us to arrive on a final proof `abcd` which if true, verifies the correctness of all the votes. | ||
|
||
### Daniel - Reusable components | ||
|
||
Daniel has a big circuit and a big headache. A part of his circuit is a setup phase that finishes with some assertions that need to be made. But that section alone takes most of the proving time, and is largely independent of the rest of the circuit. | ||
|
||
He might find it more efficient to generate a proof for that setup phase separately, and verify that proof recursively in the actual business logic section of his circuit. This will allow for parallelization of both proofs, which results in a considerable speedup. | ||
|
||
## What params do I need | ||
|
||
As you can see in the [recursion reference](noir/standard_library/recursion.md), a simple recursive proof requires: | ||
|
||
- The proof to verify | ||
- The Verification Key of the circuit that generated the proof | ||
- A hash of this verification key, as it's needed for some backends | ||
- The public inputs for the proof | ||
- The input aggregation object | ||
|
||
It also returns the `output aggregation object`. These aggregation objects can be confusing at times, so let's dive in a little bit. | ||
|
||
### Aggregation objects | ||
|
||
Recursive zkSNARK schemes do not necessarily "verify a proof" in the sense that you expect a true or false to be spit out by the verifier. Rather an aggregation object is built over the public inputs. | ||
|
||
In the case of PLONK the recursive aggregation object is two G1 points (expressed as 16 witness values). The final verifier (in our case this is most often the smart contract verifier) has to be aware of this aggregation object to execute a pairing and check the validity of these points. | ||
|
||
So, taking the example of Alice and Bob and their guessing game: | ||
|
||
- Alice makes her guess. Her proof is *not* recursive: it doesn't verify any proof within it! It's just a standard `assert(x != y)` circuit | ||
- Bob verifies Alice's proof and makes his own guess. In this circuit, he is verifying a proof, so it needs to output an `aggregation object`: he is generating a recursive proof! | ||
- Alice verifies Bob's *recursive proof*, and uses Bob's `output aggregation object` as the `input aggregation object` in her proof... Which in turn, generates another `output aggregation object`. | ||
|
||
One should notice that when Bob generates his first proof, he has no input aggregation object. Because he is not verifying an recursive proof, he has no `input aggregation object`. In this case, he may use zeros instead. | ||
|
||
We can imagine the `aggregation object` as the baton in a [relay race](https://en.wikipedia.org/wiki/Relay_race). The first runner doesn't have to receive the baton from anyone else, as he/she already starts with it. But when his/her turn is over, the next runner needs to receive it, run a bit more, and pass it along. Even though every runner could theoretically verify the baton mid-run (why not? 🏃🔍), only at the end of the race does the referee verify that the whole race is valid. | ||
|
||
## Some architecture | ||
|
||
As with everything in computer science, there's no one-size-fits all. But there are some patterns that could help understanding and implementing them. To give three examples: | ||
|
||
### Adding some logic to a proof verification | ||
|
||
This would be an approach for something like our guessing game, where proofs are sent back and forth and are verified by each opponent. This circuit would be divided in two sections: | ||
|
||
- A `recursive verification` section, which would be just the call to `std::verify_proof`, and that would be skipped on the first move (since there's no proof to verify) | ||
- A `guessing` section, which is basically the logic part where the actual guessing happens | ||
|
||
In such a situation, and assuming Alice is first, she would skip the first part and try to guess Bob's number. Bob would then verify her proof on the first section of his run, and try to guess Alice's number on the second part, and so on. | ||
|
||
### Aggregating proofs | ||
|
||
In some one-way interaction situations, recursion would allow for aggregation of simple proofs that don't need to be immediately verified on-chain or elsewhere. | ||
|
||
To give a practical example, a barman wouldn't need to verify a "proof-of-age" on-chain every time he serves alcohol to a customer. Instead, the architecture would comprise two circuits: | ||
|
||
- A `main`, non-recursive circuit with some logic | ||
- A `recursive` circuit meant to verify two proofs in one proof | ||
|
||
The customer's proofs would be intermediate, and made on their phones, and the barman could just verify them locally. He would then aggregate them into a final proof sent on-chain (or elsewhere) at the end of the day. | ||
|
||
### Recursively verifying different circuits | ||
|
||
Nothing prevents you from verifying different circuits in a recursive proof, for example: | ||
|
||
- A `circuit1` circuit | ||
- A `circuit2` circuit | ||
- A `recursive` circuit | ||
|
||
In this example, a regulator could verify that taxes were paid for a specific purchase by aggregating both a `payer` circuit (proving that a purchase was made and taxes were paid), and a `receipt` circuit (proving that the payment was received) | ||
|
||
## How fast is it | ||
|
||
At the time of writing, verifying recursive proofs is surprisingly fast. This is because most of the time is spent on generating the verification key that will be used to generate the next proof. So you are able to cache the verification key and reuse it later. | ||
|
||
Currently, Noir JS packages don't expose the functionality of loading proving and verification keys, but that feature exists in the underlying `bb.js` package. |
5 changes: 5 additions & 0 deletions
5
docs/versioned_docs/version-v../getting_started/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"position": 0, | ||
"collapsible": true, | ||
"collapsed": true | ||
} |
142 changes: 142 additions & 0 deletions
142
docs/versioned_docs/version-v../getting_started/create_a_project.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
--- | ||
title: Creating A Project | ||
description: | ||
Learn how to create and verify your first Noir program using Nargo, a programming language for | ||
zero-knowledge proofs. | ||
keywords: | ||
[ | ||
Nargo, | ||
Noir, | ||
zero-knowledge proofs, | ||
programming language, | ||
create Noir program, | ||
verify Noir program, | ||
step-by-step guide, | ||
] | ||
sidebar_position: 1 | ||
|
||
--- | ||
|
||
Now that we have installed Nargo, it is time to make our first hello world program! | ||
|
||
## Create a Project Directory | ||
|
||
Noir code can live anywhere on your computer. Let us create a _projects_ folder in the home | ||
directory to house our Noir programs. | ||
|
||
For Linux, macOS, and Windows PowerShell, create the directory and change directory into it by | ||
running: | ||
|
||
```sh | ||
mkdir ~/projects | ||
cd ~/projects | ||
``` | ||
|
||
## Create Our First Nargo Project | ||
|
||
Now that we are in the projects directory, create a new Nargo project by running: | ||
|
||
```sh | ||
nargo new hello_world | ||
``` | ||
|
||
> **Note:** `hello_world` can be any arbitrary project name, we are simply using `hello_world` for | ||
> demonstration. | ||
> | ||
> In production, the common practice is to name the project folder as `circuits` for better | ||
> identifiability when sitting alongside other folders in the codebase (e.g. `contracts`, `scripts`, | ||
> `test`). | ||
A `hello_world` folder would be created. Similar to Rust, the folder houses _src/main.nr_ and | ||
_Nargo.toml_ that contains the source code and environmental options of your Noir program | ||
respectively. | ||
|
||
### Intro to Noir Syntax | ||
|
||
Let us take a closer look at _main.nr_. The default _main.nr_ generated should look like this: | ||
|
||
```rust | ||
fn main(x : Field, y : pub Field) { | ||
assert(x != y); | ||
} | ||
``` | ||
|
||
The first line of the program specifies the program's inputs: | ||
|
||
```rust | ||
x : Field, y : pub Field | ||
``` | ||
|
||
Program inputs in Noir are private by default (e.g. `x`), but can be labeled public using the | ||
keyword `pub` (e.g. `y`). To learn more about private and public values, check the | ||
[Data Types](../noir/concepts/data_types/index.md) section. | ||
|
||
The next line of the program specifies its body: | ||
|
||
```rust | ||
assert(x != y); | ||
``` | ||
|
||
The Noir syntax `assert` can be interpreted as something similar to constraints in other zk-contract languages. | ||
|
||
For more Noir syntax, check the [Language Concepts](../noir/concepts/comments.md) chapter. | ||
|
||
## Build In/Output Files | ||
|
||
Change directory into _hello_world_ and build in/output files for your Noir program by running: | ||
|
||
```sh | ||
cd hello_world | ||
nargo check | ||
``` | ||
|
||
Two additional files would be generated in your project directory: | ||
|
||
_Prover.toml_ houses input values, and _Verifier.toml_ houses public values. | ||
|
||
## Prove Our Noir Program | ||
|
||
Now that the project is set up, we can create a proof of correct execution on our Noir program. | ||
|
||
Fill in input values for execution in the _Prover.toml_ file. For example: | ||
|
||
```toml | ||
x = "1" | ||
y = "2" | ||
``` | ||
|
||
Prove the valid execution of your Noir program: | ||
|
||
```sh | ||
nargo prove | ||
``` | ||
|
||
A new folder _proofs_ would then be generated in your project directory, containing the proof file | ||
`<project-name>.proof`, where the project name is defined in Nargo.toml. | ||
|
||
The _Verifier.toml_ file would also be updated with the public values computed from program | ||
execution (in this case the value of `y`): | ||
|
||
```toml | ||
y = "0x0000000000000000000000000000000000000000000000000000000000000002" | ||
``` | ||
|
||
> **Note:** Values in _Verifier.toml_ are computed as 32-byte hex values. | ||
## Verify Our Noir Program | ||
|
||
Once a proof is generated, we can verify correct execution of our Noir program by verifying the | ||
proof file. | ||
|
||
Verify your proof by running: | ||
|
||
```sh | ||
nargo verify | ||
``` | ||
|
||
The verification will complete in silence if it is successful. If it fails, it will log the | ||
corresponding error instead. | ||
|
||
Congratulations, you have now created and verified a proof for your very first Noir program! | ||
|
||
In the [next section](./project_breakdown.md), we will go into more detail on each step performed. |
6 changes: 6 additions & 0 deletions
6
docs/versioned_docs/version-v../getting_started/installation/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"position": 0, | ||
"label": "Install Nargo", | ||
"collapsible": true, | ||
"collapsed": true | ||
} |
45 changes: 45 additions & 0 deletions
45
docs/versioned_docs/version-v../getting_started/installation/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
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 through the most common and easy method, noirup | ||
keywords: [ | ||
Nargo | ||
Noir | ||
Rust | ||
Cargo | ||
Noirup | ||
Installation | ||
Terminal Commands | ||
Version Check | ||
Nightlies | ||
Specific Versions | ||
Branches | ||
Noirup Repository | ||
] | ||
--- | ||
|
||
`nargo` is the one-stop-shop for almost everything related with Noir. The name comes from our love for Rust and its package manager `cargo`. | ||
|
||
With `nargo`, you can start new projects, compile, execute, prove, verify, test, generate solidity contracts, and do pretty much all that is available in Noir. | ||
|
||
Similarly to `rustup`, we also maintain an easy installation method that covers most machines: `noirup`. | ||
|
||
## Installing Noirup | ||
|
||
Open a terminal on your machine, and write: | ||
|
||
```bash | ||
curl -L https://raw.githubusercontent.com/noir-lang/noirup/main/install | bash | ||
``` | ||
|
||
Close the terminal, open another one, and run | ||
|
||
```bash | ||
noirup | ||
``` | ||
|
||
Done. That's it. You should have the latest version working. You can check with `nargo --version`. | ||
|
||
You can also install nightlies, specific versions | ||
or branches. Check out the [noirup repository](https://github.com/noir-lang/noirup) for more | ||
information. |
Oops, something went wrong.