rust-rapidsnark 0.1.0

Rust wrapper for the Rapidsnark proof system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# Rust Rapidsnark

<!-- [![Crates.io](https://img.shields.io/crates/v/witnesscalc-adapter?label=witnesscalc-adapter)](https://crates.io/crates/witnesscalc-adapter) -->

This project provides a Rust adapter for compiling and linking [Rapidsnark](https://github.com/iden3/rapidsnark) into a native library for target platforms (e.g., mobile devices). It includes macros and functions to facilitate the integration of proof generation into Rust codebases.

## Usage

Include the crate in your `Cargo.toml`:

```toml
[dependencies]
rust-rapidsnark = "0.1.0"

[build-dependencies]
rust-rapidsnark = "0.1.0"
```

It doesn't include the witness generation functions, you need to use one of the following crates to generate the witness:

-   [rust-witness](https://github.com/chancehudson/rust-witness)
-   [witnesscalc-adapter](https://github.com/zkmopro/witnesscalc_adapter)
-   [circom-witnesscalc](https://github.com/iden3/circom-witnesscalc)
-   [wasmer](https://github.com/wasmerio/wasmer)

For example, building witness with `witnesscalc-adapter`:

```rust
witnesscalc_adapter::witness!(multiplier2);
let json_input_string = "{\"a\": [\"2\"], \"b\": [\"3\"]}";;
let wtns_buffer = multiplier2_witness(json_input_string).unwrap();
```

### Calculate the proof

Calculate the proof by using the `groth16_prover_zkey_file_wrapper` function.
It will take a `wtns` bytes array like the output of [witnesscalc](https://github.com/0xPolygonID/witnesscalc) or [snarkjs](https://github.com/iden3/snarkjs).

```rust
let zkey_path = "./test-vectors/multiplier2_final.zkey".to_string();
let proof = rust_rapidsnark::groth16_prover_zkey_file_wrapper(&zkey_path, wtns_buffer).unwrap();
```

### Verify the proof

Verify the proof by using the `groth16_verifier_zkey_file_wrapper` function.

```rust
let vkey = std::fs::read_to_string("./test-vectors/keccak256_256_test.vkey.json")?;
let valid = rust_rapidsnark::groth16_verify_wrapper(
    &proof.proof,
    &proof.public_signals,
    &vkey,
)?;
```

## Supported platforms

### Linux

-   x86_64 linux
-   arm64 linux

### MacOS

-   aarch64-apple-darwin
-   x86_64-apple-darwin

### iOS

-   aarch64-apple-ios
-   aarch64-apple-ios-sim
-   x86_64-apple-ios

### Android

-   aarch64-linux-android
-   x86_64-linux-android

## Uploaded binaries

-   Rapidsnark artifacts are uploaded [here](https://github.com/vivianjeng/rapidsnark/actions/runs/13075683259)

## Community

-   Website: [zkmopro.com](https://zkmopro.com)
-   X account: <a href="https://twitter.com/zkmopro"><img src="https://img.shields.io/twitter/follow/zkmopro?style=flat-square&logo=x&label=zkmopro"></a>
-   Telegram group: <a href="https://t.me/zkmopro"><img src="https://img.shields.io/badge/telegram-@zkmopro-blue.svg?style=flat-square&logo=telegram"></a>

## Acknowledgements

-   The project is sponsored by [PSE](https://pse.dev/).