Skip to content

chore: Update README.md #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Autoparallel merged 3 commits into from
Mar 11, 2025
Merged

chore: Update README.md #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
348bce4
Update README.md
Autoparallel Mar 11, 2025
abfca19
Update README.md
Autoparallel Mar 11, 2025
67df0db
Update README.md
Autoparallel Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,16 @@

## Features
- Supernova NIVC folding scheme implementation
- Support for both Noir and Circom circuit frameworks
- Client-side proving capabilities through native ARM & WebAssembly
- Recursive proof generation and verification
- Support for Noir circuit DSL
- Client-side proving capabilities through native x86, aarch64, and WASM
- End-to-end proof setup, running, and verification

## Project Structure
The repository contains several key components:
- `edge-prover`: Backend implementation of Supernova NIVC folding scheme
- `edge-frontend`: Frontend adapters for Noir to use `edge-prover`
- `demo`: A demo application for the `edge-frontend` and `edge-prover`
- `nivc`: A Noir package to use with the NIVC folding scheme

### Prerequisites
Before running the demo, ensure you have:
Expand Down Expand Up @@ -83,9 +84,21 @@ ERROR demo: ❌ Proof verification failed: NovaError
Error: NovaError(ProofVerifyError)
```


## Usage
This repository and its crates are **not** production ready. Do not use them in production. No audits have been done and none are planned.
You can use the `edge-frontend` crate to use the NIVC folding scheme for your own Noir programs. In your `Cargo.toml`, add the following:
```
[dependencies]
edge-frontend = { git = "https://github.com/pluto/edge", branch = "main" }
```
and then add the following to your `Nargo.toml`:
```
[dependencies]
nivc = { tag = "v0.1.0", git = "https://github.com/pluto/edge" }
```
The `edge-frontend` assumes that the structure provided by the `nivc` crate is used. Please see the `demo` crate for an example of how to use the `edge-frontend` with the `nivc` crate and the `examples` directory for examples of Noir programs that use the `nivc` crate inside of other tests (see `frontend/tests/nivc/`).

> [!WARNING]
> This repository and its crates are **not** production ready. Do not use them in production. No audits have been done and none are planned.

With that said, work has been done to make the implementation here work with an offline setup phase. Therefore, this can be used run proofs on an edge device which can later be verified by a remote server.

Expand All @@ -103,4 +116,4 @@ This project is licensed under the Apache V2 License - see the [LICENSE](LICENSE

## Acknowledgements
> [!NOTE]
> This repository is a fork of the original hosted at [https://github.com/microsoft/nova](https://github.com/microsoft/nova) and also forked from [https://github.com/argumentcomputer/arecibo](https://github.com/argumentcomputer/arecibo).
> This repository is a fork of the original hosted at [https://github.com/microsoft/nova](https://github.com/microsoft/nova) and also forked from [https://github.com/argumentcomputer/arecibo](https://github.com/argumentcomputer/arecibo).