Move to Bun.js (#6)

* switch to bun * fix workflow
erhant · Apr 20, 2024 · 04544e0 · 04544e0
1 parent 1bd134b
commit 04544e0
Show file tree

Hide file tree

Showing 25 changed files with 33 additions and 4,432 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,11 +14,11 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
 
-      - name: Enable Corepack for Yarn
-        run: corepack enable
-
-      - name: Install dependencies
+      - name: Install Circom dependencies
         run: |
           sudo apt-get update
           sudo apt-get install --yes \
@@ -37,8 +37,8 @@ jobs:
       - name: Print Circom version
         run: circom --version
 
-      - name: Install dependencies
-        run: yarn
+      - name: Install JS dependencies
+        run: bun install
 
       - name: Run tests
-        run: yarn test
+        run: bun test
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,3 +1,3 @@
 {
-  "recommendations": ["iden3.circom"]
+  "recommendations": ["iden3.circom", "oven.bun-vscode"]
 }
diff --git a/.yarnrc.yml b/.yarnrc.yml
diff --git a/README.md b/README.md
@@ -24,16 +24,16 @@
 Install packages with:
 
 ```sh
-yarn install
+bun install
 ```
 
 ## Book
 
 We use `mdbook` to create the book, see the [book](./book/) folder. You can build the book with the following:
 
 ```sh
-yarn book # automatically serve the book
-yarn book:build # build without serving
+bun book # automatically serve the book
+bun book:build # build without serving
 ```
 
 The book is based on the [mdBook template](https://github.com/erhant/mdbook-template) and is published at <https://circom.erhant.me>.
@@ -43,13 +43,13 @@ The book is based on the [mdBook template](https://github.com/erhant/mdbook-temp
 Run circuit tests with:
 
 ```sh
-yarn test
+bun test
 
 # with pattern matching
-yarn test pattern-name
+bun test pattern-name
 
 # with explicit paths
-yarn test ./path/to/some.test.ts
+bun test ./path/to/some.test.ts
 ```
 
 The tests make use of [Circomkit](https://github.com/erhant/circomkit).

diff --git a/bun.lockb b/bun.lockb
diff --git a/circuits/test/comparators/compconstant.circom b/circuits/test/comparators/compconstant.circom
@@ -3,4 +3,4 @@ pragma circom 2.0.0;
 
 include "../../comparators/constant.circom";
 
-component main = CompConstant(1693);
+component main = CompConstant(1017);
diff --git a/jest.config.ts b/jest.config.ts
diff --git a/package.json b/package.json
@@ -15,17 +15,12 @@
     "circomlib": "^2.0.5"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.12",
+    "@types/bun": "^1.1.0",
     "@types/node": "^20.11.16",
-    "jest": "^29.7.0",
-    "markdownlint": "^0.33.0",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
   },
   "prettier": {
     "printWidth": 120
-  },
-  "packageManager": "yarn@4.1.0"
+  }
 }
diff --git a/tests/arithmetic/adder.test.ts b/tests/arithmetic/adder.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 const N = 3;
 

diff --git a/tests/arithmetic/int-div.test.ts b/tests/arithmetic/int-div.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("integer division", () => {
   let circuit: WitnessTester<["in"], ["out"]>;

diff --git a/tests/arithmetic/inverse.test.ts b/tests/arithmetic/inverse.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("inverse", () => {
   let circuit: WitnessTester<["in"], ["out"]>;

diff --git a/tests/arithmetic/multiplier.test.ts b/tests/arithmetic/multiplier.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 const N = 3;
 

diff --git a/tests/arrays/distinct.test.ts b/tests/arrays/distinct.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("distinct", () => {
   const N = 3;

diff --git a/tests/arrays/index.test.ts b/tests/arrays/index.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit, primes } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("arrays", () => {
   const N = 10;

diff --git a/tests/arrays/sorted.test.ts b/tests/arrays/sorted.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("sorted", () => {
   const N = 10;

diff --git a/tests/bits/gates.test.ts b/tests/bits/gates.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("logic gates", () => {
   it("AND", async () => {

diff --git a/tests/bits/index.test.ts b/tests/bits/index.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it, expect } from "bun:test";
 
 describe("bits", () => {
   const N = 5;

diff --git a/tests/comparators/constant.test.ts b/tests/comparators/constant.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit, primes, toBinary } from "../common";
+import { describe, beforeAll, it, expect } from "bun:test";
 
 describe("constant", () => {
   describe("compconstant", () => {

diff --git a/tests/comparators/index.test.ts b/tests/comparators/index.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("comparators", () => {
   describe("is zero", () => {

diff --git a/tests/comparators/range.test.ts b/tests/comparators/range.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("range", () => {
   const [MIN, MAX] = [1, 9];

diff --git a/tests/control-flow/index.test.ts b/tests/control-flow/index.test.ts
@@ -1,4 +1,5 @@
 import { circomkit } from "../common";
+import { describe, beforeAll, it } from "bun:test";
 
 describe("control-flow", () => {
   it("if-else", async () => {

diff --git a/tests/examples/intermediate/sudoku.test.ts b/tests/examples/intermediate/sudoku.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../../common";
+import { describe, beforeAll, it } from "bun:test";
 
 const BOARD_SIZES = [4, 9] as const;
 type BOARD_SIZES = (typeof BOARD_SIZES)[number];

diff --git a/tests/examples/simple/fibonacci.test.ts b/tests/examples/simple/fibonacci.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../../common";
+import { describe, beforeAll, it } from "bun:test";
 
 const N = 14;
 

diff --git a/tests/examples/simple/magic.test.ts b/tests/examples/simple/magic.test.ts
@@ -1,5 +1,6 @@
 import type { WitnessTester } from "circomkit";
 import { circomkit } from "../../common";
+import { describe, beforeAll, it } from "bun:test";
 
 // board sizes
 const MAGIC_SIZES = [3, 4] as const;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,4 @@ pragma circom 2.0.0;

		include "../../comparators/constant.circom";

		component main = CompConstant(1693);
		component main = CompConstant(1017);