https://github.com/zkemail/sp1-zkemail
SP1 Implementation of ZKEmail Circuits
https://github.com/zkemail/sp1-zkemail
Last synced: about 1 year ago
JSON representation
SP1 Implementation of ZKEmail Circuits
- Host: GitHub
- URL: https://github.com/zkemail/sp1-zkemail
- Owner: zkemail
- License: mit
- Created: 2024-12-10T06:07:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-04T12:08:09.000Z (about 1 year ago)
- Last Synced: 2025-04-14T18:16:23.400Z (about 1 year ago)
- Language: Rust
- Size: 812 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# SP1 ZkEmail
ZK Email is an application that allows for anonymous verification of email signatures while masking specific data. It enables verification of emails to/from specific domains or subsets of domains, as well as verification based on specific text in the email body.
This repository contains the SP1 program and the Solidity contract that verifies the SP1 proofs.
## Requirements
- [Rust](https://rustup.rs/)
- [SP1](https://docs.succinct.xyz/getting-started/install.html)
## 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:
```sh
cd program
cargo prove build
```
### Execute the Program
To run the program without generating a proof:
```sh
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:
```sh
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:
```sh
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:
```sh
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.
### Retrieve the Verification Key
To retrieve your `programVKey` for your on-chain contract, run the following command:
```sh
cargo prove vkey --program fibonacci-program
```
## Using the Prover Network
We highly recommend using the Succinct prover network for any non-trivial programs or benchmarking purposes. For more information, see the [setup guide](https://docs.succinct.xyz/generating-proofs/prover-network.html).
To get started, copy the example environment file:
```sh
cp .env.example .env
```
Then, set the `SP1_PROVER` environment variable to `network` and set the `SP1_PRIVATE_KEY`
environment variable to your whitelisted private key.
For example, to generate an EVM-compatible proof using the prover network, run the following
command:
```sh
SP1_PROVER=network SP1_PRIVATE_KEY=... cargo run --release --bin evm
```