Replace Jest with the native Node test runner and update project tsconfig (#728)

Author: ymekuria

CHANGELOG.md

@@ -17,6 +17,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Unreleased
 
+## [0.22.7](https://github.com/o1-labs/zkapp-cli/compare/v0.22.6...v0.22.7) - 2025-04-13
+
+### Changed
+
+- Replaces Jest with the native Node test runner in default project and examples. The template tsconfig was updated to support all features in o1js and to be compatible with projects like mina attestatons. [#728](https://github.com/o1-labs/zkapp-cli/pull/728)
+
+## [0.22.6](https://github.com/o1-labs/zkapp-cli/compare/v0.22.5...v0.22.6) - 2025-04-09
+
 ### Added
 
 - Adds a new ZkProgram default example that is included with CLI generated projects, coupled with a new example template UI that demonstrates an end to end flow of generating proofs with a ZkProgram, and settling the state on Mina. [#725](https://github.com/o1-labs/zkapp-cli/pull/725)

examples/sudoku/ts/src/sudoku.test.ts

@@ -1,6 +1,8 @@
-import { Sudoku, SudokuZkApp } from './sudoku';
-import { cloneSudoku, generateSudoku, solveSudoku } from './sudoku-lib';
+import { Sudoku, SudokuZkApp } from './sudoku.js';
+import { cloneSudoku, generateSudoku, solveSudoku } from './sudoku-lib.js';
 import { PrivateKey, PublicKey, Mina, AccountUpdate } from 'o1js';
+import { describe, it, beforeEach } from 'node:test';
+import assert from 'node:assert';
 
 describe('sudoku', () => {
   let zkApp: SudokuZkApp,
@@ -25,7 +27,7 @@ describe('sudoku', () => {
     await deploy(zkApp, zkAppPrivateKey, sudoku, sender, senderKey);
 
     let isSolved = zkApp.isSolved.get().toBoolean();
-    expect(isSolved).toBe(false);
+    assert.strictEqual(isSolved, false);
 
     const solution = solveSudoku(sudoku);
     if (solution === undefined) throw Error('cannot happen');
@@ -37,7 +39,7 @@ describe('sudoku', () => {
     await tx.sign([senderKey]).send();
 
     isSolved = zkApp.isSolved.get().toBoolean();
-    expect(isSolved).toBe(true);
+    assert.strictEqual(isSolved, true);
   });
 
   it('rejects an incorrect solution', async () => {
@@ -49,7 +51,7 @@ describe('sudoku', () => {
     const noSolution = cloneSudoku(solution);
     noSolution[0][0] = (noSolution[0][0] % 9) + 1;
 
-    await expect(async () => {
+    await assert.rejects(async () => {
       const tx = await Mina.transaction(sender, async () => {
         const zkApp = new SudokuZkApp(zkAppAddress);
         await zkApp.submitSolution(
@@ -59,10 +61,10 @@ describe('sudoku', () => {
       });
       await tx.prove();
       await tx.sign([senderKey]).send();
-    }).rejects.toThrow(/array contains the numbers 1...9/);
+    }, /array contains the numbers 1...9/);
 
     const isSolved = zkApp.isSolved.get().toBoolean();
-    expect(isSolved).toBe(false);
+    assert.strictEqual(isSolved, false);
   });
 });
 

examples/tictactoe/ts/src/tictactoe.test.ts

@@ -1,4 +1,4 @@
-import { TicTacToe } from './tictactoe';
+import { TicTacToe } from './tictactoe.js';
 import {
   Field,
   Bool,
@@ -8,6 +8,8 @@ import {
   AccountUpdate,
   Signature,
 } from 'o1js';
+import { describe, it, beforeEach } from 'node:test';
+import assert from 'node:assert';
 
 describe('tictactoe', () => {
   let player1: Mina.TestPublicKey,
@@ -37,7 +39,7 @@ describe('tictactoe', () => {
     await txn.prove();
     await txn.sign([zkAppPrivateKey, player1Key]).send();
     const board = zkApp.board.get();
-    expect(board).toEqual(Field(0));
+    assert.deepStrictEqual(board, Field(0));
   });
 
   it('deploys tictactoe & accepts a correct move', async () => {
@@ -63,6 +65,6 @@ describe('tictactoe', () => {
 
     // check next player
     const isNextPlayer2 = zkApp.nextIsPlayer2.get();
-    expect(isNextPlayer2).toEqual(Bool(true));
+    assert.deepStrictEqual(isNextPlayer2, Bool(true));
   });
 });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "zkapp-cli",
-  "version": "0.22.6",
+  "version": "0.22.7",
   "description": "CLI to create zkApps (zero-knowledge apps) for Mina Protocol",
   "homepage": "https://github.com/o1-labs/zkapp-cli/",
   "repository": {

package.json

@@ -208,7 +208,7 @@ function scaffoldSvelte() {
   const customTsConfig = `{
   "extends": "./.svelte-kit/tsconfig.json",
   "compilerOptions": {
-    "target": "es2020",
+    "target": "es2021",
     "module": "es2022",
     "lib": ["dom", "esnext"],
     "strict": true,
@@ -224,7 +224,9 @@ function scaffoldSvelte() {
     "sourceMap": true,
     "noFallthroughCasesInSwitch": true,
     "allowSyntheticDefaultImports": true,
-    "isolatedModules": true
+    "isolatedModules": true,
+    "useDefineForClassFields": false, 
+    "importHelpers": true,
   },
   // Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
 	//
@@ -443,7 +445,7 @@ const __dirname = path.dirname(__filename);
 
   const tsconfig = `{
   "compilerOptions": {
-    "target": "es2020",
+    "target": "es2021",
     "module": "esnext",
     "lib": ["dom", "dom.iterable", "esnext"],
     "strict": true,
@@ -464,6 +466,8 @@ const __dirname = path.dirname(__filename);
     "incremental": true,
     "resolveJsonModule": true,
     "jsx": "preserve",
+    "useDefineForClassFields": false, 
+    "importHelpers": true,
     "paths": {
       "@/*": ["./src/*"]
     },

src/lib/project.js

@@ -18,19 +18,17 @@
     "buildw": "tsc --watch",
     "coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
     "format": "prettier --write --ignore-unknown **/*",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "testw": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
+    "test": "npm run build && find build/src -name '*.test.js' -exec node --test {} \\;",
+    "testw": "npm run build && find build/src -name '*.test.js' -exec node --test --watch {} \\;",
     "lint": "npx eslint src/* --fix"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.16.4",
     "@babel/preset-typescript": "^7.16.0",
-    "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",
     "eslint": "^8.7.0",
     "eslint-plugin-o1js": "^0.4.0",
-    "jest": "^29.7.0",
     "prettier": "^2.3.2",
     "ts-jest": "^29.2.4",
     "typescript": "^5.4.5"

templates/project-ts/jest-resolver.cjs

@@ -1,6 +1,8 @@
 import { AccountUpdate, Field, Mina, PrivateKey, PublicKey } from 'o1js';
-import { Add } from './Add';
-import { AddZkProgram } from './AddZkProgram';
+import { Add } from './Add.js';
+import { AddZkProgram } from './AddZkProgram.js';
+import { describe, it, before, beforeEach } from 'node:test';
+import assert from 'node:assert';
 
 /*
  * This file specifies how to test the `Add` example smart contract. It is safe to delete this file and replace
@@ -20,7 +22,7 @@ describe('Add', () => {
     zkAppPrivateKey: PrivateKey,
     zkApp: Add;
 
-  beforeAll(async () => {
+  before(async () => {
     await AddZkProgram.compile({ proofsEnabled });
     if (proofsEnabled) {
       await Add.compile();
@@ -54,7 +56,7 @@ describe('Add', () => {
 
     const { proof } = await AddZkProgram.init(Field(1));
 
-    expect(proof.publicOutput).toEqual(Field(1));
+    assert.deepStrictEqual(proof.publicOutput, Field(1));
   });
 
   it('correctly settles `AddZKprogram` state on the `Add` smart contract', async () => {
@@ -72,6 +74,6 @@ describe('Add', () => {
     await txn.sign([senderKey]).send();
 
     const updatedNum = zkApp.num.get();
-    expect(updatedNum).toEqual(Field(1));
+    assert.deepStrictEqual(updatedNum, Field(1));
   });
 });

templates/project-ts/jest.config.js

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "target": "es2020",
-    "module": "es2022",
+    "target": "es2021", // goal: ship *the most modern syntax* that is supported by *all* browsers that support our Wasm
+    "module": "nodenext", // allow top-level await
     "lib": ["dom", "esnext"],
     "outDir": "./build",
     "rootDir": ".",
@@ -10,15 +10,17 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "esModuleInterop": true,
-    "moduleResolution": "node",
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowJs": true,
+    "moduleResolution": "nodenext", // comply with node + "type": "module"
+    "experimentalDecorators": true, // needed for decorators used in o1js
+    "emitDecoratorMetadata": true, // needed for decorators used in o1js
+    "allowJs": true, // to use JSDoc in some places where TS would be too cumbersome
     "declaration": true,
     "sourceMap": true,
     "noFallthroughCasesInSwitch": true,
     "allowSyntheticDefaultImports": true,
-    "useDefineForClassFields": false,
+    "useDefineForClassFields": false, // ensure correct behaviour of class fields with decorators
+    "importHelpers": true, // bundle optimization to reduce size
+    "baseUrl": "." // base directory for module resolution
   },
-  "include": ["./src"],
+  "include": ["./src"]
 }