Circom circuit implementations with in-depth explanations.

Install packages with:

yarn install

We use mdbook to create the book, see the book folder. You can build the book with the following:

yarn book # automatically serve the book
yarn book:build # build without serving

The book is based on the mdBook template and is published at https://circom.erhant.me.

Run circuit tests with:

yarn test

# with pattern matching
yarn test pattern-name

# with explicit paths
yarn test ./path/to/some.test.ts

The tests make use of Circomkit.

Check the formatting with the following command:

yarn format

This command checks the test code with Prettier.