UPA-SP1 Project Template

This is a template for creating an end-to-end SP1 project that can generate a proof of any RISC-V program and getting the proof verified in NEBRA UPA.

This repo is a NEBRA maintained fork from sp1-project-template, the credits of all the SP1 related code belongs to the original author.

Requirements

Running the Project

There are four main ways to run this project: build a program, execute a program, generate a core proof, and generate an EVM-compatible proof.

Build the Program

To build the program, run the following command:

cd program
cargo prove build

Execute the Program

To run the program without generating a proof:

cd script
cargo run --release -- --execute

This will execute the program and display the output.

Generate a Core Proof

To generate a core proof for your program:

cd script
cargo run --release -- --prove

Generate an EVM-Compatible Proof

Warning

You will need at least 128GB RAM to generate a Groth16 or PLONK proof.

To generate a proof that is small enough to be verified on-chain and verifiable by the EVM:

cd script
cargo run --release --bin evm -- --system groth16

this will generate a Groth16 proof. If you want to generate a PLONK proof, run the following command:

cargo run --release --bin evm -- --system plonk

These commands will also generate fixtures that can be used to test the verification of SP1 zkVM proofs inside Solidity.

UPA Integration

cd into the upa directory and run the following commands:

yarn
yarn build
./scripts/upa_sp1

Under the hood the upa_sp1 script:

Converts the SP1 Groth16 proof into UPA file format.
Deploys UPA Verifier contract to a local hardhat network.
Deploys a Fibonacci contract to a local hardhat network. The Fibonacci contract has an entry point verifyFibonacci that checks that the public values of the SP1 proof correspond to a Groth16 proof that was marked as verified on the UPA Verifier contract. Importantly, note that this function does not do the actual verification of the Groth16 proof.
Submits SP1 Fibonacci Groth16 proof to the UPA Verifier contract.
Uses the UPA dev aggregator (a dev tool to mimic actual UPA aggregator) to aggregate the SP1 Groth16 proof along with another test Groth16 proof. Submits the aggregated proof on-chain.
Calls the verifyFibonacci function on the Fibonacci contract to check that the SP1 Groth16 proof was successfully aggregated.

We highly recommend using the Succinct prover network for any non-trivial programs or benchmarking purposes. For more information, see the setup guide.

NebraZKP/upa-sp1-project-template