Sunspot

Sunspot provides tools to prove and verify noir circuits on solana.

⚠️ Requires Noir 1.0.0-beta.22

Security

Sunspot has not been audited yet and is provided as-is. We make no guarantees to its safety or reliability.

To report security vulnerabilities, please use the Security tab on this repository.

Installation

See INSTALLATION.md for instructions on installing Sunspot.

Usage

After installing Sunspot, you can use it as a command-line tool for working with Noir circuits on Solana.

sunspot [command]

Available Commands

Command	Description
compile	Compile an ACIR file into a CCS file
completion	Generate the autocompletion script for the specified shell
help	Display help information about any command
prove	Generate a Groth16 proof and public witness from an ACIR file, a witness, CCS, and proving key
setup	Generate a proving key (pk) and verifying key (vk) from a CCS file
verify	Verify a proof and public witness with a verification key
deploy	Create a verifying solana program executable and keypair

💡 Examples

# Compile a Noir ACIR file into a CCS file
sunspot compile my_circuit.json

# Generate a proving and verifying key
# ⚠️ THIS IS UNSAFE!
# ⚠️ IT PERFORMS GNARK TRUSTED SETUP WITH NO MITIGATION FOR CRYPTOGRAPHIC TOXIC WASTE!
# For a safe setup, use the Gnark setup tool with the compiled .ccs file:
#   https://github.com/reilabs/trusted-setup
sunspot setup my_circuit.ccs

# Create a Groth16 proof
sunspot prove my_circuit.json witness.gz my_circuit.ccs proving_key.pk

# Verify a proof
sunspot verify verifying_key.vk proof.proof public_witness.pw

# Create Solana verification program
sunspot deploy verifying_key.vk 

For detailed information on each command:

sunspot [command] --help

Codebase Overview

This project is organized as follows:

• go/ – Contains functionality to parse Noir circuits and witnesses and produces gnark outputs, also contains CLI functionality in go/cmd subdirectory.
• gnark-solana/ – Provides functionality to verify gnark proofs on solana, a fuller description of this directory can be found here.
• noir-samples/ – Example Noir projects used for unit and integration tests.
• testgen - Creates ACIR snippets to test parsing, does not produce semantically valid programs.

Credits

• Light Protocol
  Our thanks goes to Light protocol, the original authors of the Groth16-solana repo, who published it under the Apache 2.0 License. We used this for inspiration for our own core Gnark verifier for both the error type definition and some of the core verifier functionality.