Skip to content

Commit 1dcb8ca

Browse files
PatStilesglpecile
andauthored
docs: update zkRust documentation (#932)
Co-authored-by: Gian <58370608+glpecile@users.noreply.github.com>
1 parent 2661d68 commit 1dcb8ca

1 file changed

Lines changed: 27 additions & 14 deletions

File tree

docs/3_guides/5_using_zkrust.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Generating & submitting proofs to Aligned using zkRust
22

3-
With zkRust, you can generate proofs of Rust code and then submit them to Aligned to be verified with only one command.
4-
You can choose between different Rust zkVMs for generating your proof.
5-
The supported provers at the moment are:
3+
[zkRust](https://github.com/yetanotherco/zkRust) is a CLI tool to generate proofs of your rust code using a RISCV-zkVM's and submit them to Aligned to be verified with only one command.
4+
The following provers are supported:
65

7-
* [Risc0](https://github.com/risc0/risc0)
8-
* [SP1](https://github.com/succinctlabs/sp1)
6+
- [Risc0](https://github.com/risc0/risc0)
7+
- [SP1](https://github.com/succinctlabs/sp1)
98

109
## Dependencies
1110

@@ -19,13 +18,27 @@ To generate and submit proofs to Aligned using ZKRust, you need to have the foll
1918

2019
To generate and submit proofs to Aligned testnet using zkRust, you can follow the steps below:
2120

22-
### 1. Clone the zkRust repository:
21+
### 1. Install zkRust :
2322

24-
```bash
25-
git clone https://github.com/lambdaclass/zkRust
23+
The zkRust executable can be installed directly via the command line via:
24+
25+
```sh
26+
curl -L https://raw.githubusercontent.com/yetanotherco/zkRust/main/install_zkrust.sh | bash
27+
```
28+
29+
or built by cloning the repo
30+
31+
```sh
32+
git clone https://github.com/yetanotherco/zkRust
2633
cd zkRust
2734
```
2835

36+
and running the installation script:
37+
38+
```sh
39+
make install
40+
```
41+
2942
### 2. Generate a keystore:
3043

3144
You can use cast to create a local keystore.
@@ -48,11 +61,12 @@ You can get Holesky ETH from the [faucet](https://cloud.google.com/application/w
4861

4962
The zkRust repo has some predefined examples that can be used to generate a proof.
5063
You can find them in `zkRust/examples`.
51-
For example, to generate a proof of a `fibonacci` program with Risc0 and submit it to aligned, run:
64+
For example, to generate a proof of a `fibonacci` program with Risc0 or SP1 and submit it to aligned, run:
5265

53-
```bash
54-
cargo run --release -- prove-risc0 \
55-
--submit-to-aligned-with-keystore <path_to_keystore> \
66+
```sh
67+
cargo run --release -- prove-risc0 \
68+
--submit-to-aligned-with-keystore \
69+
<PATH_TO_KEYSTORE> \
5670
examples/fibonacci .
5771
```
5872

@@ -75,5 +89,4 @@ cargo run --release -- prove-sp1 \
7589

7690
For the moment, the Rust code that can be proven has some limitations:
7791

78-
* Programs with I/O are not supported
79-
* Programs that rely on zkVMs Precompiles may take too much time and computing resources.
92+
- Programs with user Input and Output to the vm code are not supported.

0 commit comments

Comments
 (0)