https://github.com/limechain/wisp-prover
Prover REST API of the Wisp Protocol
https://github.com/limechain/wisp-prover
Last synced: 9 months ago
JSON representation
Prover REST API of the Wisp Protocol
- Host: GitHub
- URL: https://github.com/limechain/wisp-prover
- Owner: LimeChain
- License: gpl-3.0
- Created: 2023-02-10T08:28:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-07T09:39:41.000Z (about 3 years ago)
- Last Synced: 2025-03-16T21:48:41.779Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 137 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wisp Prover Server
[](https://github.com/LimeChain/crc-prover/actions/workflows/ci.yaml)
The Prover is a fork of [Iden3's prover-server](https://github.com/iden3/prover-server). It is a REST API Wrapper
for [go-rapidsnark](https://github.com/iden3/go-rapidsnark)
## Installation
### Docker Image
1. Download the already published image containing the circuits and verification key (~50 GB)
```bash
docker pull limechain/wisp-prover:1.0
```
2. Run the image
```bash
docker run -d -p 8000:8000 limechain/wisp-prover:1.0
```
**Note**
- The image contains `ssz2Poseidon` and `blsHeaderVerify` circuits
- Hardware requirements are `256GB RAM`, `32-core CPU`
and `1 TB SSD`
### From Source
1. (Optional) Create / edit your config file. Defaults to `configs/dev.yaml`.
2. Prepare compiled circuits, zkey and verification key.
1. Option 1 (Development): Use `multiplier`:
```bash
mkdir ./circuits && cp -R .github/workflows/test-circuit/multiplier ./circuits/multiplier
```
2. Option 2: CRC circuits (`ssz2Poseidon` and `blsHeaderVerify`):
```bash
bash get-circuits.sh
```
Hardware requirements are `256GB RAM`, `32-core CPU` and `1 TB SSD`
3. Build the image
```bash
docker build -t prover-server .
```
4. Run Prover
```
docker run -it -p 8000:8000 prover-server
```
If you want to use config, different from the default `dev` one you must pass it as an environmental
variable `CONFIG={config}`
## API
### Generate proof
```
POST /api/v1/proof/generate
Content-Type: application/json
{
"circuit": "multiplier", // name of the requested circuit as specified in the config
"inputs": {...} // circuit specific inputs
}
```
## License
- The code in this project is licensed under the [GNU GPLv3 license](prover-server-LICENSE)
- Iden'3 `prover-server` is part of the iden3 project copyright 2021 0KIMS association and published
with GPL-3 license