risc0-zkvm

Crates.iorisc0-zkvm
lib.rsrisc0-zkvm
version1.1.3
sourcesrc
created_at2022-08-08 05:52:30.878411
updated_at2024-11-09 05:53:00.052632
descriptionRISC Zero zero-knowledge VM
homepagehttps://risczero.com/
repositoryhttps://github.com/risc0/risc0/
max_upload_size
id640657
size4,480,693
maintainers (github:risc0:maintainers)

documentation

README

The RISC Zero zkVM is a RISC-V virtual machine that produces zero-knowledge proofs of code it executes. By using the zkVM, a cryptographic receipt is produced which anyone can verify was produced by the zkVM's guest code. No additional information about the code execution (such as, for example, the inputs provided) is revealed by publishing the receipt.

Additional (non-reference) resources for using our zkVM that you may also find helpful, especially if you're new to the RISC Zero zkVM. These include:

  • Our zkVM Tutorial, which walks you through writing your first zkVM project.
  • The cargo risczero tool. It includes a new command which generates code for building and launching a zkVM guest and guidance on where projects most commonly modify host and guest code.
  • The examples, which contains various examples using our zkVM.
  • This clip from our presentation at ZK Hack III gives an overview of the RISC Zero zkVM. Our YouTube channel has many more videos as well.
  • We track zkVM issues with known workarounds using the rust guest workarounds GitHub tag. If you're having problems running your code in the zkVM, you can see if there's a workaround, and if you're using a workaround, you can track when it gets resolved to a permanent solution.
  • And more on the RISC Zero developer website!

Crate Feature Flags

The following feature flags are supported.

Note that in order to use risc0-zkvm in the guest, you must disable the default features by setting default-features = false.

Feature Target(s) Implies Description
client all except rv32im std Enables the client API.
cuda prove, std Enables CUDA GPU acceleration for the prover. Requires CUDA toolkit to be installed.
disable-dev-mode all except rv32im Disables dev mode so that proving and verifying may not be faked. Used to prevent a misplaced RISC0_DEV_MODE from breaking security in production systems.
metal macos prove, std Deprecated - Metal GPU acceleration for the prover is now enabled by default on Apple Silicon.
prove all except rv32im std Enables the prover, incompatible within the zkvm guest.
std all Support for the Rust stdlib.
Commit count: 1430

cargo fmt