Implement zkit wrapper generation for given circuits

.github/workflows/tests.yml

@@ -22,10 +22,6 @@ jobs:
         with:
           node-version: '${{ matrix.node }}'
 
-      - uses: oven-sh/setup-bun@v1
-        with:
-          bun-version: latest
-
       - uses: actions/checkout@v3
       - name: 'Cache node_modules'
         uses: actions/cache@v3
@@ -36,7 +32,7 @@ jobs:
             ${{ runner.os }}-node-v${{ matrix.node }}
 
       - name: Install Dependencies
-        run: bun install
+        run: npm install
 
       - name: Run All Tests
-        run: bun run test
+        run: npm run test

.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "require": "ts-node/register",
+  "file": ["test/setup.ts"],
+  "ignore": ["test/fixture-projects/**/*"],
+  "timeout": 10000
+}

CHANGELOG.md

@@ -1,14 +1,23 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [v0.2.0]
 
-## [Unreleased]
+- Resolved an issue where inputs could have the wrong number of dimensions, such as `bigint[]` when `bigint[][]` was expected.
+- Refactored architecture to work as a library
+    - Deleted support for standalone run
+    - Added ability to specify where the circuit's AST files are stored
+    - Added ability to specify where to put generated artifacts and types
+- Implemented Zkit wrapper generation for given circuits
+- Used EJS instead of TS factory to render the wrapper class
+- Added generation of the Hardhat runtime extension file for circuits
+- Added a helper function to return the circuit object from a given name
+- Changed the ArtifactGeneratorConfig to accept an array of paths to circuit ASTs.
+- Deleted automatic artifacts clean up.
+
+## [v0.1.1]
 
 ### Added
 
 - Initial release of the ZKType package
 - Support for generating TypeScript bindings for Circom circuits
 
-[Unreleased]: https://github.com/dl-solarity/zktype/compare/master...develop

README.md

@@ -1,8 +1,12 @@
-[![npm](https://img.shields.io/npm/v/@solarity/zktype.svg)](https://www.npmjs.com/package/@solarity/zktype) 
+[![npm](https://img.shields.io/npm/v/@solarity/zktype.svg)](https://www.npmjs.com/package/@solarity/zktype)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-# ZKType 
+# ZKType - TypeScript bindings for Circom circuits
 
-ZKType - unleash TypeScript bindings for Circom circuits.
+**ZKType simplifies and makes user-friendly the process of working with Circom circuits.**
+
+- Generate a [zkit](https://github.com/dl-solarity/zkit) wrapper for given circuits.
+- Ensure that all inputs and proofs are correctly formatted.
 
 ## Installation
 
@@ -14,31 +18,38 @@ npm install --save-dev @solarity/zktype
 
 ## Usage
 
-If all of your circuits are in the `circuits` folder, simply run the following command to generate TypeScript bindings 
-for the Circom circuits:
-
-```bash
-npx zktype
-```
+> [!IMPORTANT]
+> ZKType is not meant to be used directly as its fitness relies heavily on the environment, e.g., on Circom compilation artifacts management. Consider using [hardhat-zkit](https://github.com/dl-solarity/hardhat-zkit), which is a complete, developer-friendly package.
 
-By default, the script will look for circuits inside the `circuits` folder. If you wish to specify another folder 
-to look for circuits, you can use the following command:
+### CircuitTypesGenerator
 
-```bash
-npx zktype --path ./src 
-```
+`CircuitTypesGenerator` is an entry point for generating TypeScript bindings for a given circuit.
 
-To learn more about available commands, run:
+To create a `CircuitTypesGenerator` object, it is necessary to pass a config:
 
-```bash 
-npx zktype --help 
+```typescript
+ZKTypeConfig = {
+  basePath: string;
+  circuitsASTPaths: string[];
+  outputArtifactsDir?: string;
+  outputTypesDir?: string;
+};
 ```
 
-## How it works
+This config contains all the information required to generate TypeScript bindings for given circuits.
 
-Under the hood, ZKType uses the `@distributedlab/circom2` package, which contains a WASM-compiled Circom compiler. 
-It uses this compiler to extract ASTs from all the circuits, generate artifacts, and then generate types based on these artifacts.
+- `basePath` - Path to the root directory of the project where circuits are stored.
+- `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`.
+- `outputTypesDir` - Path to the directory where the generated types will be stored.
+    - Optional. Default: `generated-types/circuits`.
 
-## Known limitations
+#### generateTypes()
 
-* Currently, after each run, all circuits will be recompiled without checking if a circuit has changed or not.
+Generates TypeScript bindings for the given circuits, based on the provided config.
+
+```typescript
+const generator = new CircuitTypesGenerator(config);
+await generator.generateTypes();
+```