Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.
/ sp1 Public archive
forked from succinctlabs/sp1

A performant, 100% open-source, contributor-friendly zkVM.

License

Notifications You must be signed in to change notification settings

nyunyunyunyu/sp1

 
 

Repository files navigation

SP1

Telegram Chat

SP1 is a performant, 100% open-source, contributor-friendly zero-knowledge virtual machine (zkVM) that can prove the execution of arbitrary Rust (or any LLVM-compiled language) programs. SP1 democratizes access to ZKPs by allowing developers to use programmable truth with popular programming languages.

SP1 is inspired by the open-source software movement and takes a collaborative approach towards building the best zkVM for rollups, coprocessors and other ZKP applications. We envision a diversity of contributors integrating the latest ZK innovations, creating a zkVM that is performant, customizable and will stand the test of time.

Install | Docs | Examples

For Developers: Build with SP1

Note that SP1 is still in alpha and is not yet ready for production use.

Today, developers can write programs, including complex, large programs like a ZK Tendermint light client, in Rust (with std support), generate proofs and verify them. Most Rust crates should be supported and can be used seamlessly by your program. Example programs can be found in the examples folder.

To get started, make sure you have Rust installed. Then follow the installation guide in the SP1 book and read the getting started section.

For developers looking for inspiration on what to build, check out the open issues with the showcase label to see what sorts of programs that showcase the capabilities of SP1 are interesting to hack on.

For Contributors

Open-source is a core part of SP1's ethos and key to its advantages. We wish to cultivate a vibrant community of open-source contributors that span individuals, teams and geographies. If you want to contribute, or follow along with contributor discussion, you can use our main Telegram to chat with us. Our contributor guidelines can be found in CONTRIBUTING.md.

Find a list of good first issues in the open issues of this repo. We are always looking for contributors interested in tasks big and small, including minor chores across the codebase, optimizing performance, adding precompiles for commonly used cryptographic operations, adding documentation, creating new example programs and more. Please reach out in the Telegram chat if interested!

Roadmap

Today, SP1 can generate and verify proofs for Rust programs that have been compiled to RISC-V. SP1 supports proving of programs of arbitrary length by using a unique "shared challenges" argument that allows the prover to shard a long computation into small shards, and then generate a global proof that these shards are properly connected together.

The main priorities in the next few months are performance optimizations, getting the core zkVM constraint logic audited, as well as wrapping the SP1 STARK proof into a SNARK proof that is cheaply verifiable in the EVM (by adapting similar previous work done by the Succinct Team).

Acknowledgements

We would like to acknowledge the projects below whose previous work has been instrumental in making this project a reality:

  • Plonky3: The SP1's prover is powered by the Plonky3 toolkit.
  • Valida: The SP1 cross-table lookup architecture, prover, borrow macro, and chip design are inspired by Valida.
  • RISC0: The SP1 Rust toolchain and install/build scripts for the toolchain borrow code from RISC0.

Tips

We recommend you install the rust-analyzer extension. Note that if you use cargo prove new inside a monorepo, you will need to add the manifest file to rust-analyzer.linkedProjects to get full IDE support.

About

A performant, 100% open-source, contributor-friendly zkVM.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • Rust 95.2%
  • Go 3.4%
  • Assembly 0.8%
  • Shell 0.6%
  • Makefile 0.0%
  • Dockerfile 0.0%