Skip to content

Latest commit

 

History

History
184 lines (123 loc) · 4.94 KB

README.md

File metadata and controls

184 lines (123 loc) · 4.94 KB
Raw

raiko

Taiko's multi-prover for Taiko & Ethereum blocks. Currently supports Risc0, SP1, and SGX.

Usage

Installing

To download all dependencies for all provers you can run:

make install

You can also download all required dependencies for each prover separately, for example to install SP1:

TARGET=sp1 make install

Building

After installing dependencies of the selected prover, the following command internally calls cargo to build the prover's guest target with the --release profile by default, for example:

TARGET=sp1 make build

If you set DEBUG=1, then the target will be compiled without optimization (not recommended for zkVM elfs).

Running

Note that you have to run make build first before running zkVM provers, otherwise the guest elf may not be up to date and can result in proof failures.

TARGET=sp1 make run

Just for development with the native prover which runs through the block execution without producing any ZK/SGX proof:

cargo run

The run command will start the host service that listens to proof requests, then in another terminal you can do requests like this, which proves the 10th block with the native prover on Taiko's A7 testnet:

./script/prove-block.sh taiko_a7 native 10

Task Management

The script prove-block.sh always sends a POST request to Raiko server and enqueue a proving task. If you repeately send the same request, it will pull the latest status of the task and return the proof if ready. To check the progress of all tasks:

 curl --location --request POST 'http://localhost:8080/proof/report'

To list all requested proofs with (chainID, blockhash, proofsys_id) and ID generated by the proof system:

 curl --location --request POST 'http://localhost:8080/proof/list'

To prune all tasks (the cancellation feature that kills prover is still WIP):

 curl --location --request POST 'http://localhost:8080/proof/prune'

Look into prove-block.sh for the available options or run the script without inputs for hints. You can also automatically sync with the tip of the chain and prove all new blocks:

./script/prove-block.sh taiko_a7 native sync

Task Management

The script prove-block.sh always sends a POST request to Raiko server and enqueue a proving task. If you repeately send the same request, it will pull the latest status of the task and return the proof if ready. To check the progress of all tasks:

 curl --location --request POST 'http://localhost:8080/proof/report'

To prune all tasks (the cancellation feature that kills prover is still WIP):

 curl --location --request POST 'http://localhost:8080/proof/prune'

Provers

For all host programs, you can enable CPU optimization through exporting CPU_OPT=1.

Risc zero

To install, build, and run in one step:

export TARGET=risc0
make install && make build && make run

To build and run tests on Risc0 zkVM:

TARGET=risc0 make test

Bonsai

If you are using the Bonsai service, edit run-bonsai.sh to setup your API key, endpoint, and on-chain verifier address.

./script/setup-bonsai.sh
./script/prove-block.sh taiko_a7 risc0-bonsai 10

GPU

If you have a GPU with CUDA or Apple's GPU API to accelerate Risc0 proofs, you can do:

// cuda
cargo run -F cuda --release --features risc0
// metal
cargo run -F metal --release --features risc0

Note that CUDA needs to be installed when using cuda: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html.

SP1

To install, build, and run in one step:

export TARGET=sp1
make install && make build && make run

To build and run tests on the SP1 zkVM:

TARGET=sp1 make test

Some optimized configurations tailored to the host can be found here.

SGX

To install, build, and run in one step:

export TARGET=sgx
make install && make build && make run

To build and run test related SGX provers:

TARGET=sgx make test

If your CPU doesn't support SGX, you can still run the SGX code through gramine like it would on an SGX machine:

MOCK=1 TARGET=sgx make run

Misc docs

Execution Trace

You can generate an execution trace for the block that is being proven by enabling the tracer feature:

cargo run --features tracer

A traces folder will be created inside the root directory. This folder will contain json files with the trace of each valid transaction in the block.

OpenAPI

When running any of the features/provers, OpenAPI UIs are available in both Swagger and Scalar flavors on /swagger-ui and /scalar respectively.

Smart Contract Verification

Raiko support Sp1 Smart Contract Verification, see how to verify a proof in solidity test here