Circom101

Circom circuit implementations with in-depth explanations.

Setup

Install packages with:

bun install

Book

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

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

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

Tests

Run circuit tests with:

bun test

# with pattern matching
bun test pattern-name

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

The tests make use of Circomkit.

Style

Check the formatting with the following command:

bun format

This command checks the test code with Prettier.