Merge branch 'main' into shigoto/performance-regression-framework

Author: Shigoto-dev19

.github/workflows/checks.yml

@@ -161,6 +161,7 @@ jobs:
             'Verification Key Regression Check 1',
             'Verification Key Regression Check 2',
             'CommonJS test',
+            'Cache Regression',
           ]
     steps:
       - name: Checkout repository with submodules
@@ -176,6 +177,10 @@ jobs:
           repository: ${{ inputs.target_repo || github.repository }}
           ref: ${{ inputs.target_ref || github.ref }}
           proof_systems_commit: ${{ inputs.proof_systems_commit }}
+      - uses: 'google-github-actions/auth@v3'
+        name: Setup gcloud authentication
+        with:
+          credentials_json: '${{ secrets.GCP_O1JS_CI_BUCKET_SERVICE_ACCOUNT_KEY }}'
       - name: Prepare for tests
         run: touch profiling.md
       - name: Execute tests

.github/workflows/pull_requests.yml

@@ -39,3 +39,52 @@ jobs:
         with:
           commit_message: "auto update npmDepsHash"
           file_pattern: "npmDepsHash"
+
+
+  Lint-Format-and-TypoCheck:
+    if: github.event.pull_request.labels.*.name != 'skip-lint'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Setup Node.JS
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Get changed files
+        id: changed_files
+        run: |
+          git fetch --depth=1 origin ${{ github.event.pull_request.base.sha }}
+          git fetch --depth=1 origin ${{ github.event.pull_request.head.sha }}
+          git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} > changed_files.txt
+          TOTAL=$(wc -l < changed_files.txt)
+          echo "count=$TOTAL" >> $GITHUB_OUTPUT
+          echo "files=$(cat changed_files.txt | xargs)" >> $GITHUB_OUTPUT
+      - name: Run Prettier Check
+        if: steps.changed_files.outputs.count > 0
+        run: xargs npm run format:check < changed_files.txt
+
+      - name: Run Oxlint
+        if: steps.changed_files.outputs.count > 0
+        run: xargs npm run lint:strict < changed_files.txt
+
+      - name: Run Markdown Format Check
+        run: npm run format:md:check
+
+      - name: Run codespell
+        if: github.event.pull_request.labels.*.name != 'no-typo-check'
+        uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true
+          path: ${{ steps.changed_files.outputs.files }}
+          skip: "*.json,./node_modules,./dist,./.husky,./.git,./src/mina/**/*,./src/bindings/compiled/**/*"
+          check_hidden: false
+          ignore_words_list: "tHi,modul,optin,deriver,PRing,toWords,iSelf"

.github/workflows/upload-cache-regressions-artifacts.yml

@@ -0,0 +1,21 @@
+name: Upload Cache Regressions Artifacts
+on:
+  workflow_dispatch:
+
+jobs:
+  upload-artifacts:
+    name: Upload Cache Regressions Artifacts
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository with submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Build
+      uses: ./.github/actions/build
+    - uses: 'google-github-actions/auth@v3'
+      name: Setup gcloud authentication
+      with:
+        credentials_json: '${{ secrets.GCP_O1JS_CI_BUCKET_SERVICE_ACCOUNT_KEY }}'
+    - name: Generate artifacts and upload to GS
+      run: ./scripts/tests/dump-cache-regressions.sh

.oxlintrc.json

@@ -1,13 +1,14 @@
 {
-  "extends": "oxlint/recommended",
+  "extends": ["oxlint/recommended"],
   "rules": {
     "erasing-op": "off",
     "no-new-array": "off",
     "no-this-alias": "off",
     "no-unsafe-finally": "off",
     "no-unused-labels": "off",
     "no-useless-escape": "off",
-    "no-wrapper-object-types": "off"
+    "no-wrapper-object-types": "off",
+    "no-unused-vars": "off"
   },
   "ignorePatterns": [
     "_build/",

CHANGELOG.md

@@ -16,7 +16,9 @@ This project adheres to
     _Security_ in case of vulnerabilities.
  -->
 
-## [Unreleased](https://github.com/o1-labs/o1js/compare/114acff...HEAD)
+## [Unreleased](https://github.com/o1-labs/o1js/compare/3453d1e53...HEAD)
+
+## [2.10.0](https://github.com/o1-labs/o1js/compare/114acff...3453d1e53) - 2025-09-27
 
 ### Added
 
@@ -32,14 +34,17 @@ This project adheres to
 - Fixed a verification key regression that was caused by incorrectly enabling a
   proof system feature that wasn't needed.
   https://github.com/o1-labs/o1js/pull/2449
+- Fixed an edge case where not all the artefacts needed for the cache were
+  stored properly, resulting in them being re-computed after loading the cache.
+  https://github.com/o1-labs/o1js/pull/2460
 
 ### Deprecated
 
 - Deprecate the `Gates.addRuntimeTableConfig` and `Gadgets.inTable` functions in
   favor of the `RuntimeTable` class API
   https://github.com/o1-labs/o1js/pull/2402
 
-## [2.9.0](https://github.com/o1-labs/o1js/compare/4b1dccdd...114acff) - 2025-09-02
+## [2.9.0](https://github.com/o1-labs/o1js/compare/70bca22...2265adc) - 2025-09-02
 
 ### Added
 

npmDepsHash

@@ -1 +1 @@
-sha256-x44xLfNO8RQpMnlWFlOk/cvWd7264mWxpbWQaTCaFms=
+sha256-hvRlb/ZgfEnSW+OJG4UibamdL5UzygQQthMpUqh2W0w=

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "o1js",
   "description": "TypeScript framework for zk-SNARKs and zkApps",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "license": "Apache-2.0",
   "homepage": "https://github.com/o1-labs/o1js/",
   "repository": {
@@ -57,7 +57,7 @@
     "build:web": "./scripts/build/build-web.sh",
     "build:examples": "./scripts/build/build-examples.sh",
     "check:bindings": "./scripts/build/check-for-bindings.sh",
-    "build:docs": "npx typedoc",
+    "build:docs": "typedoc",
     "prepublish:web": "./scripts/prepublish/prepublish-web.sh",
     "prepublish:node": "./scripts/prepublish/prepublish-node.sh",
     "prepublish:full": "./scripts/prepublish/prepublish-full.sh",
@@ -71,9 +71,9 @@
     "format:md:check": "prettier --config .prettierrc.md.cjs --check '**/*.md'",
     "clean": "./scripts/clean/clean.sh",
     "clean:all": "./scripts/clean/clean-all.sh",
-    "lint": "npx oxlint",
-    "lint:fix": "npx oxlint --fix --fix-suggestions",
-    "lint:strict": "npx oxlint --max-warnings 0",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix --fix-suggestions",
+    "lint:strict": "oxlint --max-warnings 0",
     "test": "./run-jest-tests.sh",
     "test:integration": "./run-integration-tests.sh",
     "test:unit": "./run-unit-tests.sh",
@@ -94,13 +94,13 @@
     "@playwright/test": "^1.48.0",
     "@types/jest": "^27.0.0",
     "@types/libsodium-wrappers-sumo": "^0.7.8",
+    "@types/minimist": "^1.2.5",
     "@types/node": "^18.14.2",
     "esbuild": "^0.25.5",
     "expect": "^29.0.1",
     "fs-extra": "^10.0.0",
     "glob": "^8.0.3",
     "graphql": "^16.10.0",
-    "howslow": "^0.1.0",
     "husky": "^9.1.7",
     "jest": "^28.1.3",
     "jstat": "^1.9.6",

package.json

@@ -49,6 +49,10 @@ case $TEST_TYPE in
   node src/examples/commonjs.cjs
   ;;
 
+"Cache Regression")
+  echo "Cache Regression"
+  ./scripts/tests/check-cache-regressions.sh
+  ;;
 *)
   echo "ERROR: Invalid environment variable, not clear what tests to run! $CI_NODE_INDEX"
   exit 1

run-ci-tests.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+set -Eeuxo pipefail
+
+source ./scripts/lib/ux.sh
+
+# test cache regression packaging and unpackaging primitives here
+./run ./src/tests/cache/simple-regression.ts --bundle --mode dump --tarball ./tests/test-artifacts/cache/simple-regression.tar.gz
+
+./run ./src/tests/cache/simple-regression.ts --bundle --mode check --tarball ./tests/test-artifacts/cache/simple-regression.tar.gz
+
+# This pin is generated in ./dump-cache-regressions.sh
+ARTIFACT_PIN=2025-10-02T13:36:52-04:00
+
+WORKDIR=tests/test-artifacts/cache/
+mkdir -p $WORKDIR
+
+# Download all the artifacts into the workdir
+gcloud storage cp --recursive gs://o1js-ci/tests/cache/fixtures/$ARTIFACT_PIN/ $WORKDIR
+
+WORKDIR=tests/test-artifacts/cache/$ARTIFACT_PIN
+
+# Regression checks
+./run ./src/tests/cache/simple-regression.ts --bundle --mode check --tarball $WORKDIR/simple-regression.tar.gz
+./run ./src/tests/cache/complex-regression.ts --bundle --mode check --tarball $WORKDIR/complex-regression.tar.gz
+
+echo "Artifacts checked successfully!"