Skip to content

Commit

Permalink
docs(circom): update how to use circom prover
Browse files Browse the repository at this point in the history
  • Loading branch information
chokobole committed May 20, 2024
1 parent 86ee913 commit 09f238c
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions vendors/circom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,44 @@
4. Integrated Build System: Tachyon seamlessly integrates circom compilation into the build system, specifically bazel. When you make changes to a circom file, it's compiled accordingly and built in parallel, ensuring a safe and efficient process.
5. Field Support: Tachyon isn't limited to bn128; it easily supports all fields!

## How to migrate
## How to build

See [circom-example](https://github.com/kroma-network/circom-example/) for more details.
Go to [prerequisites](../../docs/how_to_use/how_to_build.md#Prerequisites) and follow the instructions.

### Linux

```shell
bazel build --@kroma_network_tachyon//:has_openmp -c opt --config linux //:prover_main
```

### MacOS arm64

```shell
bazel build -c opt --config macos_arm64 //:prover_main
```

### MacOS x64

```shell
bazel build -c opt --config macos_x86_64 //:prover_main
```

## How to run

```shell
bazel-bin/prover_main -h
Usage:

bazel-bin/prover_main zkey wtns proof public [OPTIONS]

Positional arguments:

zkey The path to zkey file
wtns The path to wtns file
proof The path to proof json
public The path to public json

Optional arguments:

--curve The curve type among ('bn254', bls12_381'), by default 'bn254'
```

0 comments on commit 09f238c

Please sign in to comment.