feat: Replace guest script with a fully-fledged Rust program

6 files changed, 338 insertions, 19 deletions

diff --git a/flake.nix b/flake.nix
index 228aca8..903acb4 100644
--- a/flake.nix
+++ b/flake.nix
@@ -65,10 +65,11 @@
 
       guestPackages = foldr (guest: accum:
         accum // {
-          ${guest} = callPackage ./guest.nix {
+          ${guest} = callPackage ./zkvms_guest_io/default.nix {
             inherit guest;
             inherit zkvms;
             inherit hostPackages;
+            inherit craneLib-default;
           };
         }) { } guests;
     in {
diff --git a/guest.nix b/guest.nix
deleted file mode 100644
index 4b3782f..0000000
--- a/guest.nix
+++ /dev/null
@@ -1,18 +0,0 @@
-{ writeShellApplication, guest, zkvms, hostPackages, lib, }:
-writeShellApplication {
-  name = "${guest}";
-
-  runtimeInputs =
-    lib.foldr (zkvm: accum: accum ++ [ hostPackages."${zkvm}/${guest}" ]) [ ]
-    zkvms;
-
-  text = ''
-    runZKVM() {
-      echo "$1"
-      "$@"
-    }
-  '' + lib.foldr (zkvm: accum:
-    ''
-      runZKVM "${hostPackages."${zkvm}/${guest}"}/bin/${zkvm}_${guest}" "$@"
-    '' + accum) "" zkvms;
-}
diff --git a/zkvms_guest_io/Cargo.lock b/zkvms_guest_io/Cargo.lock
new file mode 100644
index 0000000..ddfdde7
--- /dev/null
+++ b/zkvms_guest_io/Cargo.lock
@@ -0,0 +1,244 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "anstream"
+version = "0.6.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is_terminal_polyfill",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
+
+[[package]]
+name = "anstyle-parse"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
+dependencies = [
+ "windows-sys",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "3.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca3534e77181a9cc07539ad51f2141fe32f6c3ffd4df76db8ad92346b003ae4e"
+dependencies = [
+ "anstyle",
+ "once_cell",
+ "windows-sys",
+]
+
+[[package]]
+name = "clap"
+version = "4.5.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "027bb0d98429ae334a8698531da7077bdf906419543a35a55c2cb1b66437d767"
+dependencies = [
+ "clap_builder",
+ "clap_derive",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.5.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5589e0cba072e0f3d23791efac0fd8627b49c829c196a492e88168e6a669d863"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "clap_lex",
+ "strsim",
+]
+
+[[package]]
+name = "clap_derive"
+version = "4.5.28"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bf4ced95c6f4a675af3da73304b9ac4ed991640c36374e4b46795c49e17cf1ed"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "clap_lex"
+version = "0.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"
+
+[[package]]
+name = "colorchoice"
+version = "1.0.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "is_terminal_polyfill"
+version = "1.70.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
+
+[[package]]
+name = "once_cell"
+version = "1.20.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "945462a4b81e43c4e3ba96bd7b49d834c6f61198356aa858733bc4acf3cbe62e"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.94"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a31971752e70b8b2686d7e46ec17fb38dad4051d94024c88df49b667caea9c84"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.39"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1f1914ce909e1658d9907913b4b91947430c7d9be598b15a1912935b8c04801"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "strsim"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
+
+[[package]]
+name = "syn"
+version = "2.0.99"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e02e925281e18ffd9d640e234264753c43edc62d64b2d4cf898f1bc5e75f3fc2"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
+
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
+[[package]]
+name = "windows-sys"
+version = "0.59.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
+dependencies = [
+ "windows-targets",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+dependencies = [
+ "windows_aarch64_gnullvm",
+ "windows_aarch64_msvc",
+ "windows_i686_gnu",
+ "windows_i686_gnullvm",
+ "windows_i686_msvc",
+ "windows_x86_64_gnu",
+ "windows_x86_64_gnullvm",
+ "windows_x86_64_msvc",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
+
+[[package]]
+name = "windows_i686_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
+
+[[package]]
+name = "zkvms_guest_io"
+version = "0.1.0"
+dependencies = [
+ "clap",
+]
diff --git a/zkvms_guest_io/Cargo.toml b/zkvms_guest_io/Cargo.toml
new file mode 100644
index 0000000..76ead99
--- /dev/null
+++ b/zkvms_guest_io/Cargo.toml
@@ -0,0 +1,7 @@
+[package]
+name = "zkvms_guest_io"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+clap = { version = "4.5.31", features = ["derive"] }
diff --git a/zkvms_guest_io/default.nix b/zkvms_guest_io/default.nix
new file mode 100644
index 0000000..20c75a7
--- /dev/null
+++ b/zkvms_guest_io/default.nix
@@ -0,0 +1,21 @@
+{ craneLib-default, guest, zkvms, hostPackages, lib, }:
+let
+  commonArgs = {
+    name = "${guest}";
+
+    buildInputs =
+      lib.foldr (zkvm: accum: accum ++ [ hostPackages."${zkvm}/${guest}" ]) [ ]
+      zkvms;
+
+    src = lib.fileset.toSource {
+      root = ./.;
+      fileset = ./.;
+    };
+
+    PROGRAMS = lib.foldr (zkvm: accum:
+      hostPackages."${zkvm}/${guest}" + "/bin/${zkvm}_${guest}," + accum) ""
+      zkvms;
+  };
+
+  cargoArtifacts = craneLib-default.buildDepsOnly commonArgs;
+in craneLib-default.buildPackage commonArgs
diff --git a/zkvms_guest_io/src/main.rs b/zkvms_guest_io/src/main.rs
new file mode 100644
index 0000000..f4187b3
--- /dev/null
+++ b/zkvms_guest_io/src/main.rs
@@ -0,0 +1,64 @@
+use clap::Parser;
+use std::process::{Command, Stdio};
+use std::thread;
+use std::time::Duration;
+
+/// A CLI tool for running and benchmarking a guest program inside all
+/// supported zkVMs.
+/// This binary has been built with a single guest program in mind.
+/// If you want to run or benchmark your own guest program inside a zkVM,
+/// head on over to https://github.com/blocksense-network/zkVMs-benchmarks
+#[derive(Parser, Debug)]
+#[command(about, long_about = None)]
+struct Cli {
+    /// Ignored zkVMs. Values are substrings of names.
+    #[arg(short, long, value_delimiter = ',', num_args = 1..)]
+    ignore: Option<Vec<String>>,
+
+    /// Arguments which are passed to each tool for a single guest and single zkVM
+    #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
+    zkvm_args: Vec<String>,
+}
+
+fn main() {
+    let cli = Cli::parse();
+
+    let guests: Vec<&str> = env!("PROGRAMS")
+        .split(',')
+        .filter(|x| !x.is_empty())
+        .collect();
+    let mut threads = Vec::new();
+    let ignored = cli.ignore.unwrap_or(Vec::new());
+
+    for guest in guests.into_iter() {
+        if ignored.iter().any(|i| guest.contains(i)) {
+            continue;
+        }
+
+        let args = cli.zkvm_args.clone();
+        threads.push(
+            thread::Builder::new()
+                .name(format!(r#"Running "{}""#, guest))
+                .spawn(move || {
+                    let output = Command::new(guest)
+                        .args(args)
+                        .stdout(Stdio::piped())
+                        .output()
+                        .expect("error occured!");
+
+                    let mut stdout = String::from_utf8(output.stdout).unwrap();
+                    if !output.stderr.is_empty() {
+                        stdout.push('\n');
+                        stdout += &String::from_utf8(output.stderr).unwrap();
+                    }
+
+                    print!("== Executing {} ==\n{}", guest, stdout);
+                })
+                .unwrap(),
+        );
+    }
+
+    while threads.iter().any(|t| !t.is_finished()) {
+        thread::sleep(Duration::from_millis(200));
+    }
+}