feat: multi-crate ELF building support

.github/workflows/pr.yml

@@ -36,6 +36,12 @@ jobs:
       - name: Setup CI
         uses: ./.github/actions/setup
 
+      - name: Install SP1 toolchain
+        run: |
+          curl -L https://sp1.succinct.xyz | bash
+          ~/.sp1/bin/sp1up 
+          ~/.sp1/bin/cargo-prove prove --version
+
       - name: Run cargo check
         uses: actions-rs/cargo@v1
         with:
@@ -72,6 +78,12 @@ jobs:
       - name: Setup CI
         uses: ./.github/actions/setup
 
+      - name: Install SP1 toolchain
+        run: |
+          curl -L https://sp1.succinct.xyz | bash
+          ~/.sp1/bin/sp1up 
+          ~/.sp1/bin/cargo-prove prove --version
+
       - name: Run cargo check
         uses: actions-rs/cargo@v1
         with:
@@ -102,6 +114,12 @@ jobs:
       - name: Setup CI
         uses: ./.github/actions/setup
 
+      - name: Install SP1 toolchain
+        run: |
+          curl -L https://sp1.succinct.xyz | bash
+          ~/.sp1/bin/sp1up 
+          ~/.sp1/bin/cargo-prove prove --version
+
       - name: Run cargo fmt
         uses: actions-rs/cargo@v1
         with:
@@ -110,6 +128,14 @@ jobs:
         env:
           CARGO_INCREMENTAL: 1
 
+      - name: Check test-artifacts
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: -p test-artifacts
+        env:
+          CARGO_INCREMENTAL: 1
+
       - name: Run cargo clippy
         uses: actions-rs/cargo@v1
         with:
@@ -155,36 +181,6 @@ jobs:
           cd ./examples/
           cargo clippy --all-targets --all-features -- -D warnings -A incomplete-features
 
-  tests:
-    name: Tests
-    runs-on: [runs-on, runner=64cpu-linux-x64, "run-id=${{ github.run_id }}"]
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v4
-
-      - name: Setup CI
-        uses: ./.github/actions/setup
-
-      - name: Install SP1 toolchain
-        run: |
-          cargo install --locked --force --path crates/cli
-          cargo prove install-toolchain
-
-      - name: Run cargo fmt
-        run: |
-          cd ./tests/
-          cargo fmt --all -- --check
-
-      - name: Run cargo clippy
-        run: |
-          cd ./tests/
-          cargo clippy --all-targets --all-features -- -D warnings -A incomplete-features
-
-      - name: Build test ELF files
-        run: |
-          cd ./tests/
-          make
-
   cli:
     name: CLI
     runs-on: [runs-on, runner=8cpu-linux-x64, "run-id=${{ github.run_id }}"]
@@ -438,13 +434,14 @@ jobs:
         run: |
           find -name Cargo.lock -type f -exec rm {} \;
 
-      - name: "Build SP1 without lock files"
-        run: |
-          cargo build --all --all-targets
-
+      # We need the SP1 toolchain to be installed in order to build test-artifacts
       - name: Install SP1 toolchain
         run: |
           cargo run -p sp1-cli -- prove install-toolchain
+
+      - name: "Build SP1 without lock files"
+        run: |
+          cargo build --all --all-targets
 
       - name: "Build examples without lock files"
         run: |

Cargo.toml

@@ -31,6 +31,7 @@ members = [
   "crates/verifier",
   "crates/stark",
   "crates/zkvm/*",
+  "crates/test-artifacts",
 ]
 exclude = ["examples/target"]
 resolver = "2"
@@ -72,6 +73,9 @@ sp1-lib = { path = "crates/zkvm/lib", version = "3.0.0", default-features = fals
 # make sure to update this crate.
 sp1-zkvm = { path = "crates/zkvm/entrypoint", version = "3.0.1", default-features = false }
 
+# For testing.
+test-artifacts = { path = "crates/test-artifacts", version = "3.0.0" }
+
 # p3
 # p3-air = "0.1.4-succinct"
 # p3-field = "0.1.4-succinct"

book/getting-started/quickstart.md

@@ -34,8 +34,6 @@ Your new project will have the following structure (ignoring the `contracts` fol
 ├── program
 │   ├── Cargo.lock
 │   ├── Cargo.toml
-│   ├── elf
-│   │   └── riscv32im-succinct-zkvm-elf
 │   └── src
 │       └── main.rs
 ├── rust-toolchain
@@ -66,7 +64,7 @@ Before we can run the program inside the zkVM, it must be compiled to a RISC-V e
 cd program && cargo prove build
 ```
 
-which will output the compiled ELF to the file `program/elf/riscv32im-succinct-zkvm-elf`. 
+which will generate an ELF file under `target/elf-compilation`. 
 
 Note: the `build.rs` file in the `script` directory will use run the above command automatically to build the ELF, meaning you don't have to manually run `cargo prove build` every time you make a change to the program!
 

book/writing-programs/compiling.md

@@ -14,7 +14,7 @@ To build a program while developing, simply run the following command in the cra
 cargo prove build
 ```
 
-This will compile the ELF that can be executed in the zkVM and put it in the file `elf/riscv32im-succinct-zkvm-elf`. The output from the command will look something like this:
+This will compile the ELF that can be executed in the zkVM. The output from the command will look something like this:
 
 ```bash
 [sp1]     Compiling version_check v0.9.4

crates/build/src/build.rs

@@ -5,7 +5,7 @@ use cargo_metadata::camino::Utf8PathBuf;
 
 use crate::{
     command::{docker::create_docker_command, local::create_local_command, utils::execute_command},
-    utils::{cargo_rerun_if_changed, copy_elf_to_output_dir, current_datetime},
+    utils::{cargo_rerun_if_changed, current_datetime},
     BuildArgs, BUILD_TARGET, HELPER_TARGET_SUBDIR,
 };
 
@@ -48,12 +48,6 @@ pub fn execute_build_program(
 
     let target_elf_paths = generate_elf_paths(&program_metadata, Some(args))?;
 
-    // Temporary backward compatibility with the deprecated behavior of copying the ELF file.
-    // TODO: add option to turn off this behavior
-    if target_elf_paths.len() == 1 {
-        copy_elf_to_output_dir(args, &program_metadata, &target_elf_paths[0].1)?;
-    }
-
     Ok(target_elf_paths)
 }
 
@@ -120,20 +114,41 @@ fn generate_elf_paths(
     args: Option<&BuildArgs>,
 ) -> Result<Vec<(String, Utf8PathBuf)>> {
     let mut target_elf_paths = vec![];
+    let packages_to_iterate = if let Some(args) = args {
+        if !args.packages.is_empty() {
+            args.packages
+                .iter()
+                .map(|wanted_package| {
+                    metadata
+                        .packages
+                        .iter()
+                        .find(|p| p.name == *wanted_package)
+                        .ok_or_else(|| {
+                            anyhow::anyhow!("cannot find package named {}", wanted_package)
+                        })
+                        .map(|p| p.id.clone())
+                })
+                .collect::<anyhow::Result<Vec<_>>>()?
+        } else {
+            metadata.workspace_default_members.to_vec()
+        }
+    } else {
+        metadata.workspace_default_members.to_vec()
+    };
 
-    for program_crate in metadata.workspace_default_members.iter() {
+    for program_crate in packages_to_iterate {
         let program = metadata
             .packages
             .iter()
-            .find(|p| &p.id == program_crate)
+            .find(|p| p.id == program_crate)
             .ok_or_else(|| anyhow::anyhow!("cannot find package for {}", program_crate))?;
 
         for bin_target in program.targets.iter().filter(|t| {
             t.kind.contains(&"bin".to_owned()) && t.crate_types.contains(&"bin".to_owned())
         }) {
             // Filter out irrelevant targets if `--bin` is used.
             if let Some(args) = args {
-                if !args.binary.is_empty() && bin_target.name != args.binary {
+                if !args.binaries.is_empty() && !args.binaries.contains(&bin_target.name) {
                     continue;
                 }
             }

crates/build/src/command/utils.rs

@@ -22,9 +22,14 @@ pub(crate) fn get_program_build_args(args: &BuildArgs) -> Vec<String> {
 
     build_args.push("-Ztrim-paths".to_string());
 
-    if !args.binary.is_empty() {
+    for p in &args.packages {
+        build_args.push("-p".to_string());
+        build_args.push(p.to_string());
+    }
+
+    for b in &args.binaries {
         build_args.push("--bin".to_string());
-        build_args.push(args.binary.clone());
+        build_args.push(b.to_string());
     }
 
     if !args.features.is_empty() {