Skip to content

Commit fad759b

Browse files
committed
Updated README
1 parent f9bb576 commit fad759b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,11 @@ To create a `CircuitTypesGenerator` object, it is necessary to pass a config:
3131
ZKTypeConfig = {
3232
basePath: "circuits",
3333
projectRoot: process.cwd(),
34-
circuitsArtifactsPaths: [
35-
"circuits/auth/Matrix_artifacts.json",
34+
circuitsArtifacts: [
35+
{
36+
artifactPath: "circuits/auth/Matrix_artifacts.json",
37+
circuitProtocolType: ["groth16"],
38+
},
3639
],
3740
outputTypesDir: "generated-types/circuits",
3841
}
@@ -42,7 +45,7 @@ This config contains all the information required to generate TypeScript binding
4245

4346
- `basePath` - Path to the root directory of the project where circuits are stored.
4447
- `projectRoot` - Absolute path to the root directory of the project.
45-
- `circuitsArtifactsPaths` - Array of paths to the circuits' artifact files.
48+
- `circuitsArtifacts` - Array of object containing the path to the circuit artifact and the protocol type of the circuit.
4649
- `outputTypesDir` - Path to the directory where the generated types will be stored.
4750
- Optional. Default: `generated-types/circuits`.
4851

0 commit comments

Comments
 (0)