Str-796: ZkVMs prover performance metrics

.github/workflows/prover.yml

@@ -7,7 +7,12 @@ on:
     branches: [main]
 
 jobs:
-  build:
+  eval_perf:
+    permissions:
+      # Needed to install the toolchain.
+      contents: write
+      # Needed to post the performance report comments.
+      issues: write
     runs-on: ubuntu-latest
 
     steps:
@@ -44,8 +49,14 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Build prover guest code
-        run: cargo build --profile prover-ci -F "prover"
-        working-directory: provers/sp1
+      - name: Run performance evaluation
+        run: |
+          cargo run --profile prover-ci -- \
+          --post-to-gh \
+          --github-token "${{ secrets.GITHUB_TOKEN }}" \
+          --pr-number "${{ github.event.pull_request.number }}" \
+          --commit-hash "${{ github.sha }}" \
+        working-directory: provers/perf
         env:
-          RUSTFLAGS: "-C link-arg=-fuse-ld=lld"
+          RUSTFLAGS: "-C target-cpu=native -C link-arg=-fuse-ld=lld"
+

.gitignore

@@ -263,6 +263,4 @@ provers/**/*.id
 provers/**/*.proof
 
 proving_keys/
-provers/test-util/el/el_proofs/
-provers/test-util/cl/cl_proofs/
 provers/sp1/proofs/

Cargo.toml

@@ -56,6 +56,7 @@ members = [
   "bin/strata-client",
   "bin/strata-reth",
   "bin/prover-client",
+  "provers/perf",
 
   # integration tests
   "tests",
@@ -189,6 +190,7 @@ bincode = "1.3"
 bitcoin = { version = "=0.32.5", features = ["serde"] }
 borsh = { version = "1.5.0", features = ["derive"] }
 bytes = "1.6.0"
+cfg-if = "1.0.0"
 chrono = "0.4.38"
 clap = "4"
 digest = "0.10"

crates/zkvm/adapters/native/src/host.rs

@@ -1,8 +1,7 @@
 use std::{fmt, sync::Arc};
 
 use strata_zkvm::{
-    Proof, ProofReceipt, ProofReport, ProofType, PublicValues, VerificationKey, ZkVmError,
-    ZkVmHost, ZkVmResult,
+    Proof, ProofReceipt, ProofType, PublicValues, VerificationKey, ZkVmError, ZkVmHost, ZkVmResult,
 };
 
 use crate::{env::NativeMachine, input::NativeMachineInputBuilder, proof::NativeProofReceipt};
@@ -45,14 +44,6 @@ impl ZkVmHost for NativeHost {
     fn verify_inner(&self, _proof: &NativeProofReceipt) -> ZkVmResult<()> {
         Ok(())
     }
-
-    fn perf_report<'a>(
-        &self,
-        _input: NativeMachine,
-        _proof_type: ProofType,
-    ) -> ZkVmResult<ProofReport> {
-        Ok(ProofReport { cycles: 0 })
-    }
 }
 
 impl fmt::Display for NativeHost {

crates/zkvm/adapters/risc0/src/host.rs

@@ -4,8 +4,7 @@
 use risc0_zkvm::{compute_image_id, default_prover, sha::Digest, Journal, ProverOpts};
 use serde::{de::DeserializeOwned, Serialize};
 use strata_zkvm::{
-    ProofReport, ProofType, PublicValues, VerificationKey, ZkVmError, ZkVmHost, ZkVmInputBuilder,
-    ZkVmResult,
+    ProofType, PublicValues, VerificationKey, ZkVmError, ZkVmHost, ZkVmInputBuilder, ZkVmResult,
 };
 
 use crate::{input::Risc0ProofInputBuilder, proof::Risc0ProofReceipt};
@@ -26,6 +25,11 @@
             id,
         }
     }
+
+    // TODO: consider moving to ZkVkHost trait.
+    pub fn get_elf(&self) -> &[u8] {
+        &self.elf
+    }
 }
 
 impl ZkVmHost for Risc0Host {
@@ -81,14 +85,6 @@
             .map_err(|e| ZkVmError::ProofVerificationError(e.to_string()))?;
         Ok(())
     }
-
-    fn perf_report<'a>(
-        &self,
-        _input: <Self::Input<'a> as ZkVmInputBuilder<'a>>::Input,
-        _proof_type: ProofType,
-    ) -> ZkVmResult<ProofReport> {
-        Ok(ProofReport { cycles: 0 })
-    }
 }
 
 impl fmt::Display for Risc0Host {
@@ -113,6 +109,7 @@
     const TEST_ELF: &[u8] = include_bytes!("../tests/elf/risc0-zkvm-elf");
 
     #[test]
+    #[ignore]
     fn test_mock_prover() {
         let input: u32 = 1;
         let host = Risc0Host::init(TEST_ELF);
@@ -137,6 +134,7 @@
     }
 
     #[test]
+    #[ignore]
     fn test_mock_prover_with_public_param() {
         let input: u32 = 1;
         let zkvm = Risc0Host::init(TEST_ELF);

crates/zkvm/adapters/sp1/src/host.rs

@@ -3,8 +3,7 @@
 use serde::{de::DeserializeOwned, Serialize};
 use sp1_sdk::{HashableKey, ProverClient, SP1ProvingKey, SP1VerifyingKey};
 use strata_zkvm::{
-    ProofReport, ProofType, PublicValues, VerificationKey, ZkVmError, ZkVmHost, ZkVmInputBuilder,
-    ZkVmResult,
+    ProofType, PublicValues, VerificationKey, ZkVmError, ZkVmHost, ZkVmInputBuilder, ZkVmResult,
 };
 
 use crate::{input::SP1ProofInputBuilder, proof::SP1ProofReceipt};
@@ -49,6 +48,11 @@
             verifying_key,
         }
     }
+
+    // TODO: consider moving to ZkVkHost trait.
+    pub fn get_elf(&self) -> &[u8] {
+        &self.elf
+    }
 }
 
 impl ZkVmHost for SP1Host {
@@ -102,14 +106,6 @@
 
         Ok(())
     }
-
-    fn perf_report<'a>(
-        &self,
-        _input: <Self::Input<'a> as ZkVmInputBuilder<'a>>::Input,
-        _proof_type: ProofType,
-    ) -> ZkVmResult<ProofReport> {
-        Ok(ProofReport { cycles: 0 })
-    }
 }
 
 impl fmt::Display for SP1Host {

crates/zkvm/hosts/Cargo.toml

@@ -12,10 +12,10 @@ strata-sp1-guest-builder = { path = "../../../provers/sp1", optional = true }
 strata-risc0-adapter = { workspace = true, optional = true }
 strata-risc0-guest-builder = { path = "../../../provers/risc0", optional = true }
 
-strata-primitives.workspace = true
+# native
+strata-native-zkvm-adapter = { workspace = true, optional = true }
 
-# TODO: make it optional, via the native feature.
-strata-native-zkvm-adapter.workspace = true
+strata-primitives.workspace = true
 strata-proofimpl-btc-blockspace.workspace = true
 strata-proofimpl-checkpoint.workspace = true
 strata-proofimpl-cl-agg.workspace = true
@@ -25,11 +25,12 @@ strata-proofimpl-l1-batch.workspace = true
 
 bincode.workspace = true
 borsh.workspace = true
-cfg-if = "1.0.0"
+cfg-if.workspace = true
 serde.workspace = true
 thiserror.workspace = true
 
 [features]
-native = []
+default = []
+native = ["strata-native-zkvm-adapter"]
 risc0 = ["strata-risc0-adapter/prover", "strata-risc0-guest-builder/prover"]
 sp1 = ["strata-sp1-adapter/prover", "strata-sp1-guest-builder/prover"]

crates/zkvm/hosts/src/lib.rs

@@ -1,30 +1,37 @@
-// TODO figure out the cfg-if.
+#[macro_use]
+extern crate cfg_if;
 
-#[cfg(feature = "native")]
-pub mod native;
-#[cfg(feature = "native")]
-use strata_native_zkvm_adapter::NativeHost;
-#[cfg(feature = "native")]
-pub fn get_native_host(vm: ProofVm) -> &'static NativeHost {
-    native::get_host(vm)
+cfg_if! {
+    if #[cfg(feature = "native")] {
+        pub mod native;
+        use strata_native_zkvm_adapter::NativeHost;
+
+        pub fn get_native_host(vm: ProofVm) -> &'static NativeHost {
+            native::get_host(vm)
+        }
+    }
 }
 
-#[cfg(feature = "risc0")]
-pub mod risc0;
-#[cfg(feature = "risc0")]
-use strata_risc0_adapter::Risc0Host;
-#[cfg(feature = "risc0")]
-pub fn get_risc0_host(vm: ProofVm) -> &'static Risc0Host {
-    risc0::get_host(vm)
+cfg_if! {
+    if #[cfg(feature = "risc0")] {
+        pub mod risc0;
+        use strata_risc0_adapter::Risc0Host;
+
+        pub fn get_risc0_host(vm: ProofVm) -> &'static Risc0Host {
+            risc0::get_host(vm)
+        }
+    }
 }
 
-#[cfg(feature = "sp1")]
-pub mod sp1;
-#[cfg(feature = "sp1")]
-use strata_sp1_adapter::SP1Host;
-#[cfg(feature = "sp1")]
-pub fn get_sp1_host(vm: ProofVm) -> &'static SP1Host {
-    sp1::get_host(vm)
+cfg_if! {
+    if #[cfg(feature = "sp1")] {
+        pub mod sp1;
+        use strata_sp1_adapter::SP1Host;
+
+        pub fn get_sp1_host(vm: ProofVm) -> &'static SP1Host {
+            sp1::get_host(vm)
+        }
+    }
 }
 
 /// An identifier of different prover types.