Skip to content

Commit

Permalink
Use custom artifacts for types generation (#12)
Browse files Browse the repository at this point in the history
* Used custom artifacts for types generation

* Updated config types

* Updated README

* Updated CHANGELOG.md
  • Loading branch information
KyrylR authored Aug 22, 2024
1 parent 06e893b commit b83e5b5
Show file tree
Hide file tree
Showing 47 changed files with 1,524 additions and 2,052 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,5 @@ typings/

# Optional npm cache directory
.npm

!test/fixture-cache/artifacts
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [v0.3.0]

* Switched to the use of custom artifacts generated by the hardhat-zkit package
* Removed all code related to artifact generation and circuit compilation

## [v0.2.7]

* Improved error messages during the artifact extraction process
Expand Down
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ ZKTypeConfig = {
basePath: string;
projectRoot: string;
circuitsASTPaths: string[];
outputArtifactsDir?: string;
outputTypesDir?: string;
};
```
Expand All @@ -41,9 +40,7 @@ This config contains all the information required to generate TypeScript binding

- `basePath` - Path to the root directory of the project where circuits are stored.
- `projectRoot` - Absolute path to the root directory of the project.
- `circuitsASTPaths` - Array of paths to the circuits' AST files.
- `outputArtifactsDir` - Path to the directory where the generated artifacts will be stored.
- Optional. Default: `artifacts/circuits`.
- `circuitsArtifactsPaths` - Array of paths to the circuits' Artifact files.
- `outputTypesDir` - Path to the directory where the generated types will be stored.
- Optional. Default: `generated-types/circuits`.

Expand Down
Loading

0 comments on commit b83e5b5

Please sign in to comment.