Merge master into develop [DO NOT MERGE - only to see the diff]

.github/workflows/ci.yml

@@ -95,7 +95,7 @@ jobs:
         with:
           rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
 
-      - name: Rust Cache
+      - name: Apply the Rust smart cacheing
         uses: Swatinem/rust-cache@v2
 
       - name: Use shared OCaml setting up steps
@@ -134,7 +134,7 @@ jobs:
       - name: Build cargo docs
         run: |
           eval $(opam env)
-          RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps
+          make generate-doc
 
       #
       # Coding guidelines
@@ -174,24 +174,20 @@ jobs:
           eval $(opam env)
           make nextest
 
-      - name: Run heavy tests without the code coverage
+      - name: Run non-heavy tests with the code coverage
         if: ${{ matrix.rust_toolchain_version == env.RUST_TOOLCHAIN_COVERAGE_VERSION }}
         run: |
           eval $(opam env)
-          make nextest-heavy
-          # TODO: Re-enable this for tests with coverage data gathering.
-          # TODO: We intentionally disable the tests with the code coverage data gathering because
-          # TODO:   Rust's code coverage instrumentation is not compatible with some of the optimizations that occur during release builds.
-          # make nextest-with-coverage
-          # make test-doc-with-coverage
-          # make generate-test-coverage-report
-
-      # - name: Use shared code coverage summary
-      #   if: ${{ matrix.rust_toolchain_version == env.RUST_TOOLCHAIN_COVERAGE_VERSION }}
-      #   uses: ./.github/actions/coverage-summary-shared
-
-      # - name: Use shared Codecov reporting steps
-      #   if: ${{ matrix.rust_toolchain_version == env.RUST_TOOLCHAIN_COVERAGE_VERSION }}
-      #   uses: ./.github/actions/codecov-shared
-      #   with:
-      #     token: ${{ secrets.CODECOV_TOKEN }}
+          make nextest-with-coverage
+          make test-doc-with-coverage
+          make generate-test-coverage-report
+
+      - name: Use shared code coverage summary
+        if: ${{ matrix.rust_toolchain_version == env.RUST_TOOLCHAIN_COVERAGE_VERSION }}
+        uses: ./.github/actions/coverage-summary-shared
+
+      - name: Use shared Codecov reporting steps
+        if: ${{ matrix.rust_toolchain_version == env.RUST_TOOLCHAIN_COVERAGE_VERSION }}
+        uses: ./.github/actions/codecov-shared
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/gh-page.yml

@@ -2,12 +2,13 @@ name: Deploy Specifications & Docs to GitHub Pages
 
 on:
   push:
-    branches:
-      - master
+    branches: ["master"]
 
 env:
   OCAML_VERSION: "4.14.0"
-  RUST_TOOLCHAIN_VERSION: "nightly"
+  # This version has been chosen randomly. It seems that with 2023-11-16, it is
+  # broken. The compiler crashes. Feel free to pick any newer working version.
+  RUST_TOOLCHAIN_VERSION: "1.72"
 
 jobs:
   release:
@@ -30,10 +31,11 @@ jobs:
         with:
           ocaml_version: ${{ env.OCAML_VERSION }}
 
+      # This must be the same as in the section "Generate rustdoc locally" in the README.md
       - name: Build Rust Documentation
         run: |
           eval $(opam env)
-          RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly doc --all --no-deps
+          RUSTDOCFLAGS="--enable-index-page -Zunstable-options -D warnings" cargo doc --workspace --all-features --no-deps
 
       - name: Build the mdbook
         run: |
@@ -47,7 +49,8 @@ jobs:
           mv ./target/doc ./book/book/html/rustdoc
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref == 'refs/heads/master'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./book/book/html

.github/workflows/o1vm-ci.yml

@@ -0,0 +1,92 @@
+name: o1vm CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  # https://doc.rust-lang.org/cargo/reference/profiles.html#release
+  # Disable for the time being since it fails with the "attempt to multiply with overflow" error.
+  # Known issue yeat to be fixed.
+  # RUSTFLAGS: -Coverflow-checks=y -Cdebug-assertions=y
+  # https://doc.rust-lang.org/cargo/reference/profiles.html#incremental
+  CARGO_INCREMENTAL: 1
+  # https://nexte.st/book/pre-built-binaries.html#using-nextest-in-github-actions
+  CARGO_TERM_COLOR: always
+  # 30 MB of stack for Keccak tests
+  RUST_MIN_STACK: 31457280
+
+jobs:
+  run_o1vm_with_cached_data:
+    name: Run o1vm with cached data
+    # We run only one of the matrix options on the toffee `hetzner-1` self-hosted GitHub runner.
+    # Only in this configuration we enable tests with the code coverage data gathering.
+    runs-on: ["ubuntu-latest"]
+    strategy:
+      matrix:
+        rust_toolchain_version: ["1.74"]
+        # FIXME: currently not available for 5.0.0.
+        # It might be related to boxroot dependency, and we would need to bump
+        # up the ocaml-rs dependency
+        ocaml_version: ["4.14"]
+    services:
+      o1vm-e2e-testing-cache:
+        image: o1labs/proof-systems:o1vm-e2e-testing-cache
+        volumes:
+          - /tmp:/tmp/cache
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Use shared Rust toolchain setting up steps
+        uses: ./.github/actions/toolchain-shared
+        with:
+          rust_toolchain_version: ${{ matrix.rust_toolchain_version }}
+
+      - name: Apply the Rust smart cacheing
+        uses: Swatinem/rust-cache@v2
+
+      - name: Use shared OCaml setting up steps
+        uses: ./.github/actions/ocaml-shared
+        with:
+          ocaml_version: ${{ matrix.ocaml_version }}
+
+      - name: Install the Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          check-latest: true
+
+      - name: Install the Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.21.0"
+
+      - name: Install the Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Build the OP program
+        run: |
+          cd o1vm
+          make -C ./ethereum-optimism/op-program op-program
+          cd ..
+
+      - name: Start the local HTTP server
+        run: |
+          python -m http.server 8765 &
+
+      #
+      # Tests
+      #
+
+      - name: Execute o1vm in E2E flavor using cached data
+        run: |
+          eval $(opam env)
+          cd o1vm
+          unzip -q -o /tmp/o1vm-e2e-testing-cache.zip -d ./
+          RUN_WITH_CACHED_DATA="y" FILENAME="env-for-latest-l2-block.sh" O1VM_FLAVOR="pickles" STOP_AT="=3000000" ./run-code.sh

.gitignore

@@ -29,3 +29,13 @@ build
 tools/srs
 
 .ignore
+o1vm/env-for-*
+o1vm/cpu.pprof
+o1vm/snapshot-state*
+o1vm/rpcs.sh
+o1vm/meta.json
+o1vm/out.json
+o1vm/op-program-db*
+o1vm/state.json
+meta.json
+state.json

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "proof-systems-vendors"]
-	path = proof-systems-vendors
-	url = https://github.com/o1-labs/proof-systems-vendors.git
+[submodule "o1vm/ethereum-optimism"]
+    path = o1vm/ethereum-optimism
+    url = https://github.com/ethereum-optimism/optimism.git

.rustfmt.toml

@@ -1,3 +1,3 @@
 indent_style = "Block"
 imports_granularity = "Crate"
-reorder_imports = true
+reorder_imports = true

CONTRIBUTING.md

@@ -14,8 +14,8 @@ We have a list of easy task to start contributing. [Start over there](https://gi
 
 ## Setting up the project
 
-Make sure you have the GNU `make` utility installed since we use it to streamline various tasks.  
-Windows users may need to use the `WSL` to run `make` commands.  
+Make sure you have the GNU `make` utility installed since we use it to streamline various tasks.
+Windows users may need to use the `WSL` to run `make` commands.
 For the complete list of `make` targets, please refer to the [Makefile](Makefile).
 
 After the repository being cloned, run:
@@ -75,6 +75,12 @@ BIN_EXTRA_ARGS="-p poly-commitment" make nextest-all-with-coverage
 ```
 
 Note: In example above we run tests for the `poly-commitment` package only.
+You can also use the environment variable `BIN_EXTRA_ARGS` to select a specific
+test to run. For instance:
+```
+BIN_EXTRA_ARGS="test_opening_proof" make nextest
+```
+will only run the tests containing `test_opening_proof`.
 
 We build and run tests in `--release` mode, because otherwise tests execution can last for a long time.
 
@@ -96,7 +102,7 @@ Note: cargo can automatically fix some lints. To do so, add `--fix` to the `CARG
 CARGO_EXTRA_ARGS="--fix" make lint
 ```
 
-Formatting and lints are enforced by GitHub PR checks, so please be sure to have any errors produced by the above tools fixed before pushing the code to your pull request branch.  
+Formatting and lints are enforced by GitHub PR checks, so please be sure to have any errors produced by the above tools fixed before pushing the code to your pull request branch.
 Please refer to [CI](.github/workflows/ci.yml) workflow to see all PR checks.
 
 ## Branching policy