zkRust

CLI tool to prove your rust code easily using either SP1 or Risc0.

zkRust supports generating proofs for executable scripts. Specifically, zkRust supports generating proofs for executable programs with inputs, code, and outputs known at compile time and defined within a main() function and main.rs file.

Installation:

First make sure Rust is installed on your machine. Then install the zkVM toolchains from risc0 and sp1 by running:

make install

zkRust can then be installed directly by downloading the latest release binaries.

curl -L https://github.com/raw/yetanotherco/zkRust/main/install_zkrust.sh | bash

Quickstart

You can test zkRust for any of the examples in the examples folder. This include:

• a Fibonacci program
• a RSA program
• an ECDSA program
• a simple blockchain state diff program

Run one of the following commands to test zkRust. You can choose either risc0 or sp1:

Fibonacci:

make prove_risc0_fibonacci

make prove_sp1_fibonacci

RSA:

make prove_risc0_rsa

make prove_sp1_rsa

ECDSA:

make prove_risc0_ecdsa

make prove_sp1_ecdsa

Blockchain state diff:

make prove_risc0_blockchain_state

make prove_sp1_blockchain_state

Usage:

To use zkRust, define the code you would like to generate a proof for in a main.rs in a directory with the following structure:

.
└── <PROGRAM_DIRECTORY>
    ├── Cargo.toml
    └── src
        └── main.rs

To generate a proof of the execution of your code run the following:

• Sp1:

  cargo run --release -- prove-sp1 <PROGRAM_DIRECTORY_PATH> .

• Risc0:

  cargo run --release -- prove-risc0  <PROGRAM_DIRECTORY_PATH> .

  Make sure to have Risc0 installed with version v1.0.1

To generate your proof and send it to Aligned Layer. First generate a local wallet keystore using `cast.

cast wallet new-mnemonic

Then you can import your created keystore using:

cast wallet import --interactive <PATH_TO_KEYSTORE.json>

Finally, to generate and send your proof of your programs execution to aligned use the zkRust CLI with the --submit-to-aligned-with-keystore flag.

cargo run --release -- prove-sp1 --submit-to-aligned-with-keystore <PATH_TO_KEYSTORE> <PROGRAM_DIRECTORY_PATH .

Flags

• --precompiles: Enables in acceleration via precompiles for supported zkVM's. Specifying this flag allows for VM specific speedups for specific expensive operations such as SHA256, SHA3, bigint multiplication, and ed25519 signature verification. By specifying this flag proving operations for specific operations within the following rust crates are accelerated:
  • SP1:
    • sha2 v0.10.6
    • sha3 v0.10.8
    • crypto-bigint v0.5.5
    • tiny-keccak v2.0.2
    • ed25519-consensus v2.1.0
    • ecdsa-core v0.16.9
  • Risc0:
    • sha2 v0.10.6
    • k256 v0.13.1
    • crypto-bigint v0.5.5 NOTE: for the precompiles to be included within the compilation step the crate version you are using must match the crate version above.

Limitations:

Currently zkRust does not support fully support the following:

• Programs with a library structure.
• VM user Input and Output
• VM Precompiles

These are features are planned to be added in later editions.

Acknowledgments

SP1

Risc0