Crate risc0_zkp

source ·
Expand description

The RISC Zero Proving System

These are the core algorithms that prove and verify the execution of zk-STARK circuits.

§Crate Feature Flags

The following crate feature flags are available.

FeatureTarget(s)ImpliesDescription
cudaprove, stdTurns on CUDA GPU acceleration for the prover. Requires CUDA toolkit to be installed.
metalmacosprove, stdDeprecated - Metal GPU acceleration for the prover is enabled by default on Apple Silicon.
proveall except rv32imstdEnables the prover, incompatible within the zkvm guest.
stdallSupport for the Rust stdlib.

Modules§

  • Interface between the circuit and prover/verifier
  • Core module used to implement a zk-STARK prover and verifier.
  • Finite field types and operations
  • halprove
    Hardware Abstraction Layer (HAL) for accelerating the ZKP system.
  • Utilities for accessing buffers of circuits symbolically.
  • proveprove
    Cryptographic algorithms for producing a ZK proof of compute
  • Cryptographic algorithms for verifying a ZK proof of compute

Macros§

  • Macro for constructing a Digest from a hex string.
  • Defines a buffer in a circuit that could have layout information. $ident should be the camelcase name of the buffer, and $elem should be the type of element in the buffer, e.g. BabyBearElem. $elem must implement Debug, and must be comparable to $elem::ZERO.

Constants§