Expander-RS

Expander is a proof generation backend for Polyhedra Network. It aims to support fast proof generation.

This is the rust version of the "core" repo and more on "demo" purpose, we will continue develop on the repo to support more features.

For more technical introduction, visit our markdown files here.

And here for an example on how to use the gkr lib.

For more information, see the cpp version of the repo here.

Environment Setup

Before executing setup, please make sure you read through the system requirements, and make sure your CPU is in the list.

wget -P data https://storage.googleapis.com/keccak8/ExtractedCircuitMul.txt
wget -P data https://storage.googleapis.com/keccak8/ExtractedCircuitAdd.txt
wget -P data https://storage.googleapis.com/keccak8/circuit8.txt

Benchmarks

Make sure you include RUSTFLAGS="-C target-cpu=native" to allow platform specific accelerations.

Command template:

RUSTFLAGS="-C target-cpu=native" RUSTFLAGS="-C target-feature=+avx2" cargo run --release -- -f [254|31] -t [#threads]

Concretely if you are running on a 16 physical core CPU for Bn256 scalar field:

RUSTFLAGS="-C target-cpu=native" cargo run cargo run --release -- -f 254 -t 16

Correctness test

Here we provide a test case for end-to-end proof generation and verification. To check the correctness, run the follow standard Rust test command:

RUSTFLAGS="-C target-cpu=native" cargo test --release -- --nocapture

How to contribute?

Thank you for your interest in contributing to our project! We seek contributors with a robust background in cryptography and programming, aiming to improve and expand the capabilities of our proof generation system.

Contribution Guidelines:

Pull Requests

We welcome your pull requests (PRs) and ask that you follow these guidelines to facilitate the review process:

General Procedure:
1. Fork the repository and clone it locally.
2. Create a branch for your changes related to a specific issue or improvement.
3. Commit your changes: Use clear and meaningful commit messages.
4. Push your changes to your fork and then submit a pull request to the main repository.
PR Types and Specific Guidelines:
- [BUG] for bug fixes:
  - Title: Start with [BUG] followed by a brief description.
  - Content: Explain the issue being fixed, steps to reproduce, and the impact of the bug. Include any relevant error logs or screenshots.
  - Tests: Include tests that ensure the bug is fixed and will not recur.
- [FEATURE] for new features:
  - Title: Start with [FEATURE] followed by a concise feature description.
  - Content: Discuss the benefits of the feature, possible use cases, and any changes it introduces to existing functionality.
  - Documentation: Update relevant documentation and examples.
  - Tests: Add tests that cover the new feature's functionality.
- [DOC] for documentation improvements:
  - Title: Start with [DOC] and a short description of what is being improved.
  - Content: Detail the changes made and why they are necessary, focusing on clarity and accessibility.
- [TEST] for adding or improving tests:
  - Title: Begin with [TEST] and describe the type of testing enhancement.
  - Content: Explain what the tests cover and how they improve the project's reliability.
- [PERF] for performance improvements:
  - Title: Use [PERF] and a brief note on the enhancement.
  - Content: Provide a clear comparison of performance before and after your changes, including benchmarks or profiling data.
  - Tests/Benchmarks: Add tests that cover the new feature's functionality, and benchmarks to prove your improvement.

Review Process

Each pull request will undergo a review by one or more core contributors. We may ask for changes to better align with the project's goals and standards. Once approved, a maintainer will merge the PR.

We value your contributions greatly and are excited to see what you bring to this project. Let’s build something great together!

narsis77/Expander-rs