Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SnarkJS termination fix #46

Merged
merged 6 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Afterward, copy the provided script to the `test` directory and run the tests vi

---

- **`getCircuit(<fullCircuitName|circuitName>) -> zkit`**
- **`async getCircuit(<circuitName|fullCircuitName>) -> zkit`**

The method accepts the name of the `main` component of the circuit and returns the instantiated zkit object pointing to that circuit.

Expand All @@ -251,7 +251,7 @@ Where:

## Known limitations

- Temporarily, the only supported proving system is `groth16`.
- Sometimes `hardhat` scripts that generate `zkey` files may run indefinitely. Waiting for [this snarkjs fix](https://github.com/iden3/snarkjs/pull/512) to be published.
- Temporarily, the only available proving system is `groth16`. Support for `plonk` is just behind the corner.
- Sometimes `hardhat` scripts that generate ZK proofs may run indefinitely. This will be fixed in the next major release.
- Currently there is minimal support for `var` Circom variables. Some circuits may not work if you are using complex `var`-dependent expressions.
- Due to current `wasm` memory limitations (address space is 32-bit), the plugin may fail to compile especially large circuits on some platforms.
246 changes: 206 additions & 40 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@solarity/hardhat-zkit",
"version": "0.4.9",
"version": "0.4.10",
"description": "The ultimate TypeScript environment for Circom development",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand Down Expand Up @@ -65,7 +65,7 @@
"ora": "5.4.1",
"resolve": "1.22.8",
"semver": "7.6.3",
"snarkjs": "0.7.3",
"snarkjs": "0.7.5",
"uuid": "9.0.1",
"zod": "3.23.8",
"is-typed-array": "1.1.13",
Expand Down
2 changes: 2 additions & 0 deletions src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ export const CIRCUIT_COMPILE_CACHE_VERSION = "hh-zkit-compile-cache-1";
export const CIRCUIT_SETUP_CACHE_VERSION = "hh-zkit-setup-cache-1";
export const CIRCUIT_ARTIFACT_VERSION = "hh-zkit-artifacts-1";

export const BN128_CURVE_NAME = "bn128";

export const NODE_MODULES = "node_modules";

export const MAGIC_DESCRIPTOR = 1337;
Expand Down
Loading
Loading