feat: OpenVmHalo2Verifier (#1549)

This PR adds a new verifier contract generation that wraps the original
`snark-verifier` output (via inheritance). The goal of this wrapper
`OpenVmHalo2Verifier` is to expose a more friendly interface to users
that cleanly separates out the guest program public values.
`OpenVmHalo2Verifier` exposes the following interface:

```solidity
interface IOpenVmHalo2Verifier {
    function verify(bytes calldata publicValues, bytes calldata proofData, bytes32 appExeCommit, bytes32 appVmCommit)
        external
        view;
}
```

- `publicValues`: The bytes revealed in the OpenVM guest program packed
together.
- `proofData`: Defined as `abi.encodePacked(KZG accumulators,
publicValuesSuffix)`
- `appExeCommit`: The commitment to the OpenVM application executable
whose execution is being verified.
- `appVmCommit`: The commitment to the VM configuration (aka
`leaf_exe_commit`)

Once received, the proof is constructed into the format expected by
`snark-verifier`. The expected format is
`abi.encodePacked(proofData[0:0x180], appExeCommit, appVmExeCommit,
publicValuesPayload, proofData[0x180:])` where `publicValuesPayload` is
a memory payload with each byte in `publicValues` separated into its own
`bytes32` word.

Since `OpenVmHalo2Verifier` inherits the `snark-verifier` output, the
proof is forwarded via self-call.

## Verifier Generation

The smart contract is written as a template that does not compile in
isolation. During generation, the OpenVM SDK will fill out the maximum
amount of public values and the OpenVM version with which the generation
happened.

Given an output folder, the relevant contracts are written into the
following folder structure:

```
halo2/
├── interfaces/
│   └── IOpenVmHalo2Verifier.sol
├── OpenVmHalo2Verifier.sol
├── Halo2Verifier.sol
```

`cargo openvm setup` will now generate this output directly into the
`~/.openvm/` dir.

Closes INT-3710

Author: HrikB

.github/workflows/sdk.yml

@@ -39,6 +39,9 @@ jobs:
       - name: Install solc # svm should support arm64 linux
         run: (hash svm 2>/dev/null || cargo install --version 0.2.23 svm-rs) && svm install 0.8.19 && solc --version
 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
       - name: Install architecture specific tools
         run: |
           arch=$(uname -m)
@@ -74,8 +77,24 @@ jobs:
         run: |
           bash ../../extensions/native/recursion/trusted_setup_s3.sh
 
+      - name: Run openvm-sdk contracts/ tests
+        working-directory: crates/sdk/contracts
+        run: |
+          forge fmt --check
+          forge build --sizes
+          forge test
+
+      - name: Check IOpenVmHalo2Verifier.sol abi correctness
+        working-directory: crates/sdk/contracts
+        run: |
+          forge build
+          jq -S '.abi' ./out/IOpenVmHalo2Verifier.sol/IOpenVmHalo2Verifier.json > compiled_abi.json
+          jq -S . ./abi/IOpenVmHalo2Verifier.json > expected_abi_sorted.json
+          diff -u expected_abi_sorted.json compiled_abi.json
+
       - name: Run openvm-sdk crate tests
         working-directory: crates/sdk
         run: |
           export RUST_BACKTRACE=1
           cargo nextest run --cargo-profile=fast --test-threads=2 --features parallel
+

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "toolchain/tests/rv32im-test-vectors/riscv-tests"]
 	path = crates/toolchain/tests/rv32im-test-vectors/riscv-tests
 	url = https://github.com/riscv-software-src/riscv-tests.git
+[submodule "crates/sdk/contracts/lib/forge-std"]
+	path = crates/sdk/contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

Cargo.lock

@@ -184,9 +184,12 @@ snark-verifier-sdk = { version = "0.2.0", default-features = false, features = [
     "loader_halo2",
     "halo2-axiom",
 ] }
+snark-verifier = { version = "0.2.0", default-features = false }
 halo2curves-axiom = "0.7.0"
 
 cargo_metadata = "0.18"
+alloy-primitives = "0.8.25"
+alloy-sol-types = "0.8.25"
 tracing = "0.1.40"
 bon = "3.2.0"
 serde_json = "1.0.117"

Cargo.toml

@@ -1,5 +1,5 @@
 use std::{
-    fs::{read, write},
+    fs::{create_dir_all, read, write},
     path::PathBuf,
 };
 
@@ -146,6 +146,9 @@ pub(crate) fn build(build_args: &BuildArgs) -> Result<Option<PathBuf>> {
         let exe = Sdk::new().transpile(elf, transpiler)?;
         let committed_exe = commit_app_exe(app_config.app_fri_params.fri_params, exe.clone());
         write_exe_to_file(exe, output_path)?;
+        if let Some(parent) = build_args.committed_exe_output.parent() {
+            create_dir_all(parent)?;
+        }
         write(
             &build_args.committed_exe_output,
             committed_exe_as_bn254(&committed_exe).value.to_bytes(),

crates/cli/src/commands/build.rs

@@ -11,13 +11,13 @@ use openvm_native_recursion::halo2::utils::CacheHalo2ParamsReader;
 use openvm_sdk::{
     config::AggConfig,
     fs::{
-        write_agg_pk_to_file, write_evm_verifier_to_folder, EVM_VERIFIER_ARTIFACT_FILENAME,
-        EVM_VERIFIER_SOL_FILENAME,
+        write_agg_pk_to_file, write_evm_halo2_verifier_to_folder, EVM_HALO2_VERIFIER_BASE_NAME,
+        EVM_HALO2_VERIFIER_INTERFACE_NAME, EVM_HALO2_VERIFIER_PARENT_NAME,
     },
     DefaultStaticVerifierPvHandler, Sdk,
 };
 
-use crate::default::{DEFAULT_AGG_PK_PATH, DEFAULT_PARAMS_DIR, DEFAULT_VERIFIER_FOLDER};
+use crate::default::{DEFAULT_AGG_PK_PATH, DEFAULT_EVM_HALO2_VERIFIER_PATH, DEFAULT_PARAMS_DIR};
 
 #[derive(Parser)]
 #[command(
@@ -29,11 +29,15 @@ pub struct EvmProvingSetupCmd {}
 impl EvmProvingSetupCmd {
     pub async fn run(&self) -> Result<()> {
         if PathBuf::from(DEFAULT_AGG_PK_PATH).exists()
-            && PathBuf::from(DEFAULT_VERIFIER_FOLDER)
-                .join(EVM_VERIFIER_ARTIFACT_FILENAME)
+            && PathBuf::from(DEFAULT_EVM_HALO2_VERIFIER_PATH)
+                .join(EVM_HALO2_VERIFIER_PARENT_NAME)
                 .exists()
-            && PathBuf::from(DEFAULT_VERIFIER_FOLDER)
-                .join(EVM_VERIFIER_SOL_FILENAME)
+            && PathBuf::from(DEFAULT_EVM_HALO2_VERIFIER_PATH)
+                .join(EVM_HALO2_VERIFIER_BASE_NAME)
+                .exists()
+            && PathBuf::from(DEFAULT_EVM_HALO2_VERIFIER_PATH)
+                .join("interfaces")
+                .join(EVM_HALO2_VERIFIER_INTERFACE_NAME)
                 .exists()
         {
             println!("Aggregation proving key and verifier contract already exist");
@@ -53,13 +57,13 @@ impl EvmProvingSetupCmd {
         let agg_pk = sdk.agg_keygen(agg_config, &params_reader, &DefaultStaticVerifierPvHandler)?;
 
         println!("Generating verifier contract...");
-        let verifier = sdk.generate_snark_verifier_contract(&params_reader, &agg_pk)?;
+        let verifier = sdk.generate_halo2_verifier_solidity(&params_reader, &agg_pk)?;
 
         println!("Writing proving key to file...");
         write_agg_pk_to_file(agg_pk, DEFAULT_AGG_PK_PATH)?;
 
         println!("Writing verifier contract to file...");
-        write_evm_verifier_to_folder(verifier, DEFAULT_VERIFIER_FOLDER)?;
+        write_evm_halo2_verifier_to_folder(verifier, DEFAULT_EVM_HALO2_VERIFIER_PATH)?;
 
         Ok(())
     }