Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Arvolear committed Oct 29, 2024
1 parent 1d52727 commit e44df79
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
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.
4 changes: 2 additions & 2 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion 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
4 changes: 2 additions & 2 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 Expand Up @@ -34,5 +36,3 @@ export const WASM_COMPILER_VERSIONING: { [key: string]: string } = {
"2.1.8": "0.2.18-rc.3",
"2.1.9": "0.2.19-rc.0",
};

export const BN128_CURVE_NAME = "bn128";

0 comments on commit e44df79

Please sign in to comment.