https://github.com/kroma-network/rules_circom
Bazel rules for circom
https://github.com/kroma-network/rules_circom
bazel bazel-rules circom
Last synced: 8 months ago
JSON representation
Bazel rules for circom
- Host: GitHub
- URL: https://github.com/kroma-network/rules_circom
- Owner: kroma-network
- Created: 2024-03-18T10:59:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-05T05:55:35.000Z (about 2 years ago)
- Last Synced: 2025-01-07T15:05:58.803Z (over 1 year ago)
- Topics: bazel, bazel-rules, circom
- Language: Starlark
- Homepage:
- Size: 35.2 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rules Circom
Bazel Rule for Circom!
Please take a look at [kroma-network/circomlib](https://github.com/kroma-network/circomlib) for real examples!
## Prerequisites
### Bazel
Follow the instructions [here](https://bazel.build/install).
## How to use
Add this to your `WORKSPACE`:
```bazel
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "kroma_network_rules_circom",
sha256 = "",
strip_prefix = "rules_circom-",
urls = ["https://github.com/kroma-network/rules_circom/archive/.tar.gz"],
)
load("@kroma_network_rules_circom//:rules_circom_deps.bzl", "rules_circom_deps")
rules_circom_deps()
load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains")
rules_rust_dependencies()
rust_register_toolchains(
edition = "2021",
versions = [
"1.66.1",
],
)
load("@rules_rust//crate_universe:repositories.bzl", "crate_universe_dependencies")
crate_universe_dependencies()
load("@rules_rust//crate_universe:defs.bzl", "crates_repository")
crates_repository(
name = "crate_index",
cargo_lockfile = "@kroma_network_rules_circom//:Cargo.lock",
lockfile = "@kroma_network_rules_circom//:Cargo.Bazel.lock",
manifests = ["@kroma_network_rules_circom//:Cargo.toml"],
)
load("@crate_index//:defs.bzl", "crate_repositories")
crate_repositories()
```
### How to compute sha256
```shell
curl -LO https://github.com/kroma-network/rules_circom/archive/.tar.gz
shasum -a 256 .tar.gz
```
And then, add this to your `BUILD.bazel`:
```bazel
load("@kroma_network_rules_circom//:build_defs.bzl", "circom_library", "compile_circuit")
circom_library(
name = "",
srcs = [
"foo.circom",
"bar.circom",
],
)
compile_circuit(
name = "",
main = "baz.circom",
deps = [":"]
)
```
## Rules
### circom_library
- `srcs`: a list of sources. The files should end with **.circom**.
- `includes`: a list of directory to be linked. The list is going to be passed to [compile_circuit](#compile_circuit) as **-l** options.
- `deps`: a list of dependencies. Only the target defined by [circom_library](#circom_library) can be added.
### compile_circuit
- `srcs`: a list of sources. The files should end with **.circom**.
- `main`: a single file that contains main component.
- `includes`: a list of directory to be linked. The list is going to be passed to [compile_circuit](#compile_circuit) as **-l** options.
- `deps`: a list of dependencies. Only the target defined by [circom_library](#circom_library) can be added.
The followings flags are defined by [circom v2.1.8](https://github.com/iden3/circom/releases/tag/v2.1.8).
- `O0`: no simplification is applied.
- `O1`: only applies signal to signal and signal to constant simplification.
- `O2`: full constraint simplification.
- `verbose`: shows logs during compilation.
- `inspect`: does an additional check over the constraints produced.
- `use_old_simplification_heuristics`: applies the old version of the heuristics when performing linear .simplification
- `simplification_substitution`: outputs the substitution applied in the simplification phase in json.
- `prime`: to choose the prime number to use to generate the circuit. It should be either one of ("bn128", "bls12381", "goldilocks", "grumpkin", "pallas", "vesta", "secq256r1"). By default, "bn128".
- `O2round`: maximum number of rounds of the simplification process.