refactor(build-guest): separate stages better (#106)

* try

* try2

* lint

* rewrite build guest

* lint

* clean github action

* update

* clean up scripts

* fix env var loading

Author: lispc

.github/workflows/build-guest.yml

@@ -39,108 +39,6 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: chunk commitments (prover)
-        id: commitments-chunk-prover
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/prover/src/commitments/chunk.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: batch commitments (prover)
-        id: commitments-batch-prover
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/prover/src/commitments/batch.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: bundle commitments (prover)
-        id: commitments-bundle-prover
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/prover/src/commitments/bundle.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: chunk commitments (verifier)
-        id: commitments-chunk-verifier
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/verifier/src/commitments/chunk.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: batch commitments (verifier)
-        id: commitments-batch-verifier
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/verifier/src/commitments/batch.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: bundle commitments (verifier)
-        id: commitments-bundle-verifier
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/verifier/src/commitments/bundle.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: chunk commitments (circuits)
-        id: commitments-chunk-circuits
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/circuits/batch-circuit/src/child_commitments.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: batch commitments (circuits)
-        id: commitments-batch-circuits
-        run: |
-          {
-            echo 'commitments<<EOF'
-            cat crates/circuits/bundle-circuit/src/child_commitments.rs
-            echo EOF
-          } >> $GITHUB_OUTPUT
-
-      - name: Sanity check for chunk-commitments (prover vs verifier)
-        uses: nick-fields/assert-action@aa0067e01f0f6545c31755d6ca128c5a3a14f6bf # v2.0.0
-        with:
-          expected: ${{ steps.commitments-chunk-prover.outputs.commitments }}
-          actual: ${{ steps.commitments-chunk-verifier.outputs.commitments }}
-
-      - name: Sanity check for chunk-commitments (prover vs circuits)
-        uses: nick-fields/assert-action@aa0067e01f0f6545c31755d6ca128c5a3a14f6bf # v2.0.0
-        with:
-          expected: ${{ steps.commitments-chunk-prover.outputs.commitments }}
-          actual: ${{ steps.commitments-chunk-circuits.outputs.commitments }}
-
-      - name: Sanity check for batch-commitments (prover vs verifier)
-        uses: nick-fields/assert-action@aa0067e01f0f6545c31755d6ca128c5a3a14f6bf # v2.0.0
-        with:
-          expected: ${{ steps.commitments-batch-prover.outputs.commitments }}
-          actual: ${{ steps.commitments-batch-verifier.outputs.commitments }}
-
-      - name: Sanity check for batch-commitments (prover vs circuits)
-        uses: nick-fields/assert-action@aa0067e01f0f6545c31755d6ca128c5a3a14f6bf #v2.0.0
-        with:
-          expected: ${{ steps.commitments-batch-prover.outputs.commitments }}
-          actual: ${{ steps.commitments-batch-circuits.outputs.commitments }}
-
-      - name: Sanity check for bundle-commitments (prover vs verifier)
-        uses: nick-fields/assert-action@aa0067e01f0f6545c31755d6ca128c5a3a14f6bf #v2.0.0
-        with:
-          expected: ${{ steps.commitments-bundle-prover.outputs.commitments }}
-          actual: ${{ steps.commitments-bundle-verifier.outputs.commitments }}
-
       - name: Build guest and check diff
         run: |
           make build-guest

.gitignore

@@ -11,3 +11,5 @@ root_verifier.asm
 root-verifier-vm-config
 root-verifier-committed-exe
 verifier.bin
+
+.vscode/

Cargo.lock

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 # run crates/build-guest
-cargo run --release -p scroll-zkvm-build-guest ${FEATURE}
+cargo run --release -p scroll-zkvm-build-guest

build-guest-actions-entrypoint.sh

@@ -8,24 +8,17 @@ docker run --cidfile ./build-guest.cid --platform linux/amd64 -e FEATURE=${FEATU
 container_id=$(cat ./build-guest.cid)
 rm ./build-guest.cid
 
-# copy commitments from container to local (prover)
-docker cp ${container_id}:/app/crates/prover/src/commitments/chunk.rs crates/prover/src/commitments/chunk.rs
-docker cp ${container_id}:/app/crates/prover/src/commitments/chunk_rv32.rs crates/prover/src/commitments/chunk_rv32.rs
-docker cp ${container_id}:/app/crates/prover/src/commitments/batch.rs crates/prover/src/commitments/batch.rs
-docker cp ${container_id}:/app/crates/prover/src/commitments/bundle.rs crates/prover/src/commitments/bundle.rs
-docker cp ${container_id}:/app/crates/prover/src/commitments/bundle_euclidv1.rs crates/prover/src/commitments/bundle_euclidv1.rs
-
-# copy commitments to local (verifier)
-cp crates/prover/src/commitments/chunk.rs crates/verifier/src/commitments/chunk.rs
-cp crates/prover/src/commitments/chunk_rv32.rs crates/verifier/src/commitments/chunk_rv32.rs
-cp crates/prover/src/commitments/batch.rs crates/verifier/src/commitments/batch.rs
-cp crates/prover/src/commitments/bundle.rs crates/verifier/src/commitments/bundle.rs
-cp crates/prover/src/commitments/bundle_euclidv1.rs crates/verifier/src/commitments/bundle_euclidv1.rs
-
-# copy commitments to local (circuits)
-cp crates/prover/src/commitments/chunk.rs crates/circuits/batch-circuit/src/child_commitments.rs
-cp crates/prover/src/commitments/chunk_rv32.rs crates/circuits/batch-circuit/src/child_commitments_rv32.rs
-cp crates/prover/src/commitments/batch.rs crates/circuits/bundle-circuit/src/child_commitments.rs
+# copy commitments from container to local
+for f in chunk-circuit/chunk_exe_commit.rs \
+         chunk-circuit/chunk_exe_rv32_commit.rs \
+         chunk-circuit/chunk_leaf_commit.rs \
+         batch-circuit/batch_exe_commit.rs \
+         batch-circuit/batch_leaf_commit.rs \
+         bundle-circuit/bundle_exe_commit.rs \
+         bundle-circuit/bundle_euclidv1_commit.rs \
+         bundle-circuit/bundle_leaf_commit.rs; do
+    docker cp ${container_id}:/app/crates/circuits/${f} crates/circuits/${f}
+done
 
 # copy root verifier
 docker cp ${container_id}:/app/crates/build-guest/root_verifier.asm crates/build-guest/root_verifier.asm

build-guest.sh

@@ -15,7 +15,8 @@ openvm-transpiler = { workspace = true, default-features = false }
 openvm-native-circuit = { workspace = true, default-features = false }
 openvm-native-transpiler = { workspace = true, default-features = false }
 openvm-ecc-guest = { workspace = true, features = ["p256", "k256"]}
-openvm-algebra-guest ={ workspace = true, default-features = false }
+openvm-algebra-guest = { workspace = true, default-features = false }
+openvm-circuit = { workspace = true }
 
 tracing.workspace = true
 tracing-subscriber.workspace = true
@@ -32,6 +33,7 @@ snark-verifier-sdk.workspace = true
 toml.workspace = true
 
 cargo_metadata = "0.19.1"
+dotenv = "0.15.0"
 
 [features]
 default = []

crates/build-guest/Cargo.toml

@@ -1,8 +1,5 @@
 use openvm_build::GuestOptions;
-use std::{
-    fs::read_to_string,
-    path::{Path, PathBuf},
-};
+use std::{fs::read_to_string, path::Path};
 
 use openvm_instructions::exe::VmExe;
 use openvm_sdk::{
@@ -32,27 +29,30 @@ pub fn build<S: AsRef<str>>(
     Sdk::new().build(guest_opts, project_root, &Default::default())
 }
 
+pub fn load_app_config(project_root: &str) -> eyre::Result<AppConfig<SdkVmConfig>> {
+    // First read the app config specified in the project's root directory.
+    let path_app_config = Path::new(project_root).join(FD_APP_CONFIG);
+    let app_config: AppConfig<SdkVmConfig> =
+        toml::from_str(&read_to_string(&path_app_config).unwrap()).unwrap();
+    println!(
+        "{project_root} app config: {}",
+        toml::to_string_pretty(&app_config).unwrap()
+    );
+    Ok(app_config)
+}
+
 /// Transpile the ELF into a VmExe.
 #[instrument("BuildGuest::transpile", skip_all, fields(project_root))]
 pub fn transpile(
     project_root: &str,
     elf: Elf,
     fd_app_exe: Option<&str>,
-) -> eyre::Result<(PathBuf, AppConfig<SdkVmConfig>, PathBuf, VmExe<F>)> {
+    app_config: AppConfig<SdkVmConfig>,
+) -> eyre::Result<VmExe<F>> {
     // Create the assets dir if not already present.
     let path_assets = Path::new(project_root).join("openvm");
     std::fs::create_dir_all(&path_assets)?;
 
-    // First read the app config specified in the project's root directory.
-    let path_app_config = Path::new(project_root).join(FD_APP_CONFIG);
-    let app_config: AppConfig<SdkVmConfig> =
-        toml::from_str(&read_to_string(&path_app_config).unwrap()).unwrap();
-
-    println!(
-        "{project_root} app config: {}",
-        toml::to_string_pretty(&app_config).unwrap()
-    );
-
     // Transpile ELF to openvm executable.
     let transpiler = app_config
         .app_vm_config
@@ -66,5 +66,5 @@ pub fn transpile(
 
     println!("exe written to {path_app_exe:?}");
 
-    Ok((path_app_config, app_config, path_app_exe, app_exe))
+    Ok(app_exe)
 }