Skip to main content
Version: Next

Examples

  • Hello World: a recommended place to start. Prove a number is composite, and you know its factors without revealing them
  • JSON: prove the contents of some entry in a JSON file, while keeping the rest of the data private
  • Where's Waldo: prove that Waldo appears in a JPG file, while keeping the rest of the image private, additionally, there is Where's Waldo blog
  • ZK Checkmate: prove that you see a mate-in-one, without revealing the winning move
  • ZK Proof of Exploit: prove that you could exploit an Ethereum account, without revealing the exploit
  • ECDSA signature verification: prove the validity of an ECDSA signature
  • zkEVM: demo of running EVM engine on the Risc Zero zkVM

Running the Examples

The examples listed above and others can be found in RISC Zero's repository under /examples. Unless otherwise noted in their own READMEs, the examples can be run following the instructions below.

Install Dependencies

First, ensure that you have all RISC Zero tools installed. See installation instructions for more information.

Check Out the Correct Version of the Example

The compilation of the examples is tied to the version installed, so it is important to check out the correct version that corresponds to the local one. To do so, first get the available version in your system:

cargo risczero --version

Then check out the corresponding branch of the example:

git checkout release-$MAJOR.$MINOR # e.g. release-1.0

See Releases to check out to the latest version.

Run the Example

Finally, run the example with:

cargo run --release