https://github.com/pluto/web-prover-circuits
Circuits for Pluto's `web-prover`
https://github.com/pluto/web-prover-circuits
Last synced: about 1 year ago
JSON representation
Circuits for Pluto's `web-prover`
- Host: GitHub
- URL: https://github.com/pluto/web-prover-circuits
- Owner: pluto
- License: apache-2.0
- Created: 2024-10-23T22:45:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T18:18:41.000Z (over 1 year ago)
- Last Synced: 2025-03-28T13:21:17.545Z (about 1 year ago)
- Language: TypeScript
- Size: 1.31 MB
- Stars: 21
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Web-Prover Circuits
## Overview
`web-prover-circuits` is a project focused on implementing parsers and extractors/selective-disclosure for various data formats inside zero-knowledge circuits.
Specifically, these are designed to be used in an NIVC folding scheme.
Currently, our program layout looks like this:
## Repository Structure
- `circuits/`: Current implementation of circuits
- `chacha`: ChaCha encryption circuit
- `http`: HTTP parser and extractor
- `json`: JSON parser and extractor
- `json` has its own documentation [here](docs/json.md)
- `utils`: Utility circuits
- `test`: Circuit tests
- `src/`: Rust public-params creation binary
- `examples/`: Reference examples for JSON and HTTP parsers
Documentation, in general, can be found in the `docs` directory.
## Getting Started
### Prerequisites
To use this repo, you will need to install the following dependencies.
These instructions should work on Linux/GNU and MacOS, but aren't guaranteed to work on Windows.
#### Install Rust
To install Rust, you need to run:
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
exec $SHELL
```
Check this is installed by running:
```sh
rustc --version && cargo --version
```
to see the path to your Rust compiler and Cargo package manager.
#### Install Circom
Succinctly, `cd` to a directory of your choosing and run:
```sh
git clone https://github.com/iden3/circom.git
cd circom
cargo build --release
cargo install --path circom
```
in order to install `circom` globally.
#### Install Node
First, install `nvm` by running:
```sh
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
exec $SHELL
```
Now with `nvm` installed, run:
```sh
nvm install --lts
nvm use --lts
node --version && npm --version
```
#### Node packages
From the root of the repository, you can now run:
```sh
npm install
```
which will install all the necessary packages for working with Circom.
This includes executables `circomkit`, `snarkjs`, and `mocha` which are accessible with Node: `npx`.
##### Circomkit
This repository uses `circomkit` to manage Circom circuits.
To see what you can do with `circomkit`, we suggest running:
```
npx circomkit help
```
`circomkit` can essentially do everything you would want to do with these Circuits, though we can't guarantee all commands work properly.
**Example:**
For example, to compile the `plaintext_authentication`, you can run the following from the repository root:
```
npx circomkit compile plaintext_authentication_1024b
```
which implicitly checks the `circuits.json` for an object that points to the circuit's code itself.
If you are having trouble with `circomkit`, consider
##### Mocha
`mocha` will also be installed from before.
Running
```sh
npx mocha
```
will run every circuit test.
To filter tests, you can use the `-g` flag (very helpful!).
## License
Licensed under the Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
## Contributing
We welcome contributions to our open-source projects. If you want to contribute or follow along with contributor discussions, join our [main Telegram channel](https://t.me/pluto_xyz/1) to chat about Pluto's development.
Our contributor guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md). A good starting point is issues labelled 'bounty' in our repositories.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.