Skip to content

Commit 52ddd58

Browse files
committed
quick readme fix
1 parent 1b98eef commit 52ddd58

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
This hardhat plugin is a zero-config, one-stop Circom development environment that streamlines circuits management and lets you focus on the important - code.
1616

1717
- Developer-oriented abstractions that simplify `r1cs`, `zkey`, `vkey`, and `witness` generation processes.
18-
- Supporting of the `groth16` and `plonk` proving systems.
18+
- Support for `groth16` and `plonk` proving systems.
1919
- Recompilation of only the modified circuits.
2020
- Full TypeScript typization of signals and ZK proofs.
2121
- Automatic downloads of phase-1 `ptau` files.
@@ -62,7 +62,7 @@ module.exports = {
6262
},
6363
setupSettings: {
6464
contributionSettings: {
65-
provingSystem: "groth16", // Or ["groth16", "plonk"]
65+
provingSystem: "groth16", // or ["groth16", "plonk"]
6666
contributions: 2,
6767
},
6868
onlyFiles: [],
@@ -202,11 +202,6 @@ describe("Multiplier", () => {
202202
it("should test the circuit", async () => {
203203
const circuit: Multiplier = await zkit.getCircuit("Multiplier");
204204
// or await zkit.getCircuit("circuits/multiplier.circom:Multiplier");
205-
206-
/*
207-
* If you set up both proving systems you will need to specify exact proving system in getCircuit function:
208-
* const circuit: Multiplier = await zkit.getCircuit("Multiplier", "plonk");
209-
*/
210205

211206
// witness testing
212207
await expect(circuit)
@@ -249,19 +244,18 @@ The method works regardless of how the circuit was compiled, however, if `zkit c
249244

250245
In case there are conflicts between circuit file names and `main` component names, you should use the `fullCircuitName`, which has the following form: `circuitSourceName:circuitName`.
251246

252-
`provingSystem` parameter should be specified only if several proving systems have been specified in the config.
247+
The optional `provingSystem` parameter should be specified only if multiple proving systems were set in the config.
253248

254249
Where:
255250

256251
- `circuitSourceName` - Path to the circuit file from the project root.
257252
- `circuitName` - Circuit `main` component name.
258-
- `provingSystem` - Optional parameter that can be `groth16` or `plonk`
253+
- `provingSystem` - Optional parameter that can either be `groth16` or `plonk`.
259254

260255
> [!IMPORTANT]
261256
> Please note that the method actually returns the [`zktype`](https://github.com/dl-solarity/zktype) typed zkit wrapper objects which enable full TypeScript typization of signals and proofs. Also, check out the [`zkit`](https://github.com/dl-solarity/zkit) documentation to understand zkit object capabilities and how to interact with circuits.
262257
263258
## Known limitations
264259

265-
- Sometimes `hardhat` scripts that generate ZK proofs may run indefinitely. This will be fixed in the next major release.
266260
- Currently there is minimal support for `var` Circom variables. Some circuits may not work if you are using complex `var`-dependent expressions.
267261
- Due to current `wasm` memory limitations (address space is 32-bit), the plugin may fail to compile especially large circuits on some platforms.

0 commit comments

Comments
 (0)