Dev

.editorconfig

@@ -0,0 +1,8 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+[*.ts]
+indent_size = 2
+max_line_length = 120

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,30 @@
+name: Bug Report
+description: File a bug report
+labels: [ 'bug' ]
+assignees:
+  - dovgopoly
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: version
+    attributes:
+      label: "Project version"
+      placeholder: "1.2.3"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A brief description of what happened and what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: "Minimal reproduction steps"
+      description: "The minimal steps needed to reproduce the bug"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,13 @@
+name: Feature request
+description: Suggest a new feature
+labels: [ 'feature' ]
+assignees:
+  - dovgopoly
+body:
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: "Describe the feature"
+      description: "A description of what you would like to see in the project"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/other-issue.md

@@ -0,0 +1,4 @@
+---
+name: Other issue
+about: Other kind of issue
+---

.github/workflows/tests.yml

@@ -0,0 +1,38 @@
+name: tests
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  test:
+    name: 'Node.js v${{ matrix.node }}'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node:
+          - 18
+          - 20
+    steps:
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '${{ matrix.node }}'
+
+      - uses: actions/checkout@v3
+      - name: 'Cache node_modules'
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-v${{ matrix.node }}-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-v${{ matrix.node }}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run All Tests
+        run: npm run test

.gitignore

@@ -0,0 +1,47 @@
+node_modules
+.DS_Store
+.idea
+.eslintcache
+
+coverage
+coverage.json
+
+publish
+!publish/package.json
+
+# Compilation output
+/build-test/
+/dist
+
+.nyc_output
+
+# Below is Github's node gitignore template,
+# ignoring the node_modules part, as it'd ignore every node_modules, and we have some for testing
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# node-waf configuration
+.lock-wscript
+
+# TypeScript v1 declaration files
+typings/
+**/.storage.json
+
+# Optional npm cache directory
+.npm
+
+test/ptau
+test/verifiers
+test/zkit-artifacts

.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint-fix && git add -u

.mocharc.json

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

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2
+      }
+    }
+  ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Solarity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,61 @@
-# zkit-chai-matchers
+[![npm](https://img.shields.io/npm/v/@solarity/chai-zkit.svg)](https://www.npmjs.com/package/@solarity/chai-zkit)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Chai-zkit - Chai matchers for Circom
+
+**A user-friendly Circom Chai matchers for testing witnesses and ZK proofs**
+
+- Write convenient circuits tests via [Chai](https://www.chaijs.com/) assertions extension.
+- Enjoy full TypeScript typization of input and output signals.
+- Integrate smoothly with [hardhat-zkit](https://github.com/dl-solarity/hardhat-zkit).
+
+## Installation
+
+To install the package, run:
+
+```bash
+npm install --save-dev @solarity/chai-zkit
+```
+
+And add the following line to your `hardhat.config`:
+
+```js
+require("@solarity/chai-zkit");
+```
+
+Or if you are using TypeScript:
+
+```ts
+import "@solarity/chai-zkit";
+```
+
+## Usage
+
+> [!IMPORTANT]
+> The package is meant to be used together with [hardhat-zkit](https://github.com/dl-solarity/hardhat-zkit) plugin that provides circuits objects to be tested with chai assertions.
+
+After installing the package, you may use the following assertions:
+
+```ts
+const matrix = await zkit.getCircuit("Matrix");
+
+// strict assertion, all the outputs must be present
+await expect(matrix).with.witnessInputs({ a, b, c }).to.have.witnessOutputsStrict({ d, e, f });
+
+// partial output assertion
+await expect(matrix).with.witnessInputs({ a, b, c }).to.have.witnessOutputs({ d });
+
+// provided output `e` doesn't match the obtained one
+await expect(expect(matrix).with.witnessInputs({ a, b, c }).to.have.witnessOutputs({ e })).to.be.rejectedWith(
+  `Expected output "e" to be "[[2,5,0],[17,26,0],[0,0,0]]", but got "[[1,4,0],[16,25,0],[0,0,0]]"`,
+);
+
+// `not` negation used, provided output `d` matches the obtained one
+await expect(
+  expect(matrix).with.witnessInputs({ a, b, c }).to.not.have.witnessOutputs({ d }),
+).to.be.rejectedWith(`Expected output "d" NOT to be "[[2,5,0],[17,26,0],[0,0,0]]", but it is"`);
+```
+
+## Known limitations
+
+- Temporarily, only the witness `input <> output` signals testing is supported.