-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: proofread Requester-Producer flow, Mina readme and parts 1,2
- Loading branch information
1 parent
f100cff
commit 3140d62
Showing
4 changed files
with
188 additions
and
222 deletions.
There are no files selected for viewing
55 changes: 32 additions & 23 deletions
55
gitbook-docs/guides-1/mina-proof-pipeline-example/1.-setup.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 |
---|---|---|
@@ -1,41 +1,50 @@ | ||
# 1. Setup | ||
# Part 1: setup | ||
|
||
MINA proofs are computationally heavy; hence, users need to use the proof market to generate proofs to have a MINA state proof validated in EVM. | ||
Mina proofs are computationally heavy; hence, proof producers can benefit from | ||
using Proof Market to generate Mina state proofs for their further in-EVM validation. | ||
|
||
You need to set up the following environments to follow along with this guide. | ||
You're going to need the following environments ready for this guide. | ||
|
||
## 1. Proof Market  | ||
## Step 1: Proof Market | ||
|
||
Please ensure you have done the following steps: | ||
Prerequisites from the Proof Market side are: | ||
|
||
* [Installation](../../guides/installation.md): Clone the repository. You don't need to build anything, as we will only be using Python scripts. | ||
* [Authentication](../../market/user-guides/sign-up.md): Set up the `proof-market-toolchain` authentication as a user. You do not need to create a Proof Producer profile. | ||
* [Environment setup](../getting-started/environment-setup.md). | ||
* [Proof Market toolchain installation and setup](../../getting-started/installation.md). | ||
You don't need to set up a virtual environment for the Proof Market toolchain, | ||
we will only be using its Python scripts. | ||
This will be referred to as `proof-market-toolchain` home in the guide. | ||
* [Authentication on Proof Market](../../market/user-guides/sign-up.md). | ||
There's no need to register as a producer, any account will suffice. | ||
|
||
This will be referred to as `proof-market-toolchain` the home in the guide | ||
## Step 2: Mina state proof | ||
|
||
## 2. Mina State Proof  | ||
Mina state proof repository maintained by `=nil;` Foundation | ||
comprises the following artifacts: | ||
* Solidity EVM verifier; | ||
* C++ circuits; | ||
* scripts to fetch Mina state (ledger) and Mina account state (user/zkApp). | ||
|
||
Mina state-proof repository maintains the following artifcats | ||
Please clone the [Mina state proof repository](https://github.com/NilFoundation/mina-state-proof) | ||
and install all its dependencies. | ||
|
||
* Solidity EVM verifier  | ||
* C++ circuits | ||
* Scripts to fetch mina state (ledger) , mina account state (user/zkApp) | ||
This will be referred to as `mina-state-proof` home in the guide. | ||
|
||
 Please clone the repository located [here](https://github.com/NilFoundation/mina-state-proof) and install any dependencies.  | ||
## Step 3: Mina zkApp | ||
|
||
This will be referred to as `mina-state-proof` home in the guide | ||
Mina zkApp project consists of a sample zkApp | ||
located at `mina-state-proof/examples/mina-add-zkapp` with 8 state variables | ||
that are updated on each interaction. | ||
Please follow the steps | ||
from [`mina-add-zkapp/README.md`](https://github.com/NilFoundation/mina-state-proof/tree/master/examples/mina-add-zkapp) | ||
to install the project dependencies. | ||
|
||
## 3. Mina zkApp | ||
This will be referred to as `mina-add-zkApp` home in the guide. | ||
|
||
Mina zkApp project consists of a sample zkApp with 8 state variables that are updated on each interaction. This is located at `mina-state-proof/examples/mina-add-zkapp` . Please follow the steps to Install the project dependencies present at `mina-state-proof/examples/mina-add-zkapp/README.md`.  | ||
By now, you should have three folders with the three repositories above: | ||
|
||
This will be referred to as `mina-add-zkApp` home in the guide | ||
|
||
At the end of this step, you should have 3 folders representing the three repositories above as follows | ||
|
||
``` | ||
```bash | ||
proof-market-toolchain/ | ||
mina-state-proof/ | ||
mina-state-proof/examples/mina-add-zkapp/ | ||
``` | ||
|
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
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 |
---|---|---|
@@ -1,3 +1,6 @@ | ||
# Mina Proof pipeline - Example | ||
# Mina proof pipeline example | ||
|
||
This section describes a step-by-step workflow to validate MINA proofs in EVM via the =nil;Proof Market. | ||
This section describes a step-by-step workflow to validate MINA proofs in EVM | ||
via `=nil;` Proof Market. | ||
|
||
Start here: [Mina proof pipeline example, step 1](1.-setup.md). |
Oops, something went wrong.