export-sui-verifier-core 0.3.0

Load Groth16 artifacts from snarkjs JSON or Arkworks bundles and generate Sui Move verifier packages.
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

pub fn readme_content(
    package_name: &str,
    module_name: &str,
    curve: &str,
    has_test_vectors: bool,
    include_entry: bool,
) -> String {
    let tests = if has_test_vectors {
        "This package includes Move unit tests with the proof/public inputs supplied at generation time."
    } else {
        "This package was generated from a verification key only, so no proof-vector tests were emitted. Use `export-sui-verifier proof-data` later to print Move test helper functions for a proof."
    };
    let entry_api = if include_entry {
        "- `verify_entry(proof_bytes, public_inputs_bytes)` when generated in `entry` or `test` mode"
    } else {
        ""
    };

    format!(
        r#"# {package_name}

Generated Sui Move Groth16 verifier package.

## Generated API

The verifier module is `{package_name}::{module_name}`.

- Curve: `{curve}`
- `verifying_key_bytes()`
- `prepare()`
- `verify(proof_bytes, public_inputs_bytes)`
- `verify_with_prepared(prepared_verifying_key, proof_bytes, public_inputs_bytes)`
{entry_api}

The verifier uses `sui::groth16` and expects Arkworks canonical compressed proof bytes plus concatenated 32-byte little-endian public inputs.

## Regenerate

Run `export-sui-verifier` with root-level generation flags:

```sh
export-sui-verifier --vk ./verification_key.json --out ./generated --force
export-sui-verifier --bundle ./groth16_artifacts.json --out ./generated --force
```

Add `--proof ./proof.json` and optional `--public ./public.json` to include local proof verification and generated Move tests.

Useful flags:

- `--package-name {package_name}`
- `--module-name {module_name}`
- `--mode library|entry|test`
- `--run-sui-test`
- `--skip-local-verify`

VK-only packages are generated without `tests/`. To print proof helpers for a later test file, run:

```sh
export-sui-verifier proof-data --vk ./verification_key.json --proof ./proof.json
```

## Tests
{tests}

Run:

```sh
sui move test
```

## Known limitations

- Supported curves: BN254 and BLS12-381.
- The curve and input format are inferred from artifact metadata.
- Generated verifier code is not audited. Review it before production use.
"#,
        package_name = package_name,
        module_name = module_name,
        curve = curve,
        entry_api = entry_api,
        tests = tests
    )
}