vesnica / risc0-rust-starter

Customized RISC Zero Rust Starter

Need apply risc0/risc0#244 first.

RISC Zero Rust Starter

The risc0-rust-starter repository is a minimal starting project for zero-knowledge software development. In this RISC Zero "Hello World" project, we use zero-knowledge proof techniques to prove that we know the factors of some composite number N, without revealing what the factors are.

For more information, check out the risc0/risc0 repository and the RISC Zero website.

Quick Start

First, make sure rustup is installed. This project uses a nightly version of Rust. The rust-toolchain file will be used by cargo to automatically install the correct version.

To build all methods and execute the method within the zkVM, run the following command:

cargo run --release

Zero-Knowledge Programs

A zkVM program is composed of a host and a guest. The host code runs like any other rust program and launches a zkVM instance using the Prover interface. The guest code is compiled for riscv32im and runs inside a zkVM. Guest code does not have access to std since the zkVM is similar to an embedded system. Use the env in your zkVM guest code to communicate with the host.

Contributor's Guide

We welcome contributions to documentation and code via PRs and GitHub Issues.

Questions, Feedback, and Collaborations

We'd love to hear from you on Discord or Twitter.