Remove guest directory from guest libraries

Author: Avaneesh-axiom

.github/workflows/guest-lib-tests.yml

@@ -60,15 +60,13 @@ jobs:
           cache-on-failure: true
       - uses: taiki-e/install-action@nextest
 
-      - name: Run ${{ matrix.crate.name }} guest library unit tests
-        if: hashFiles(format('guest-libs/{0}/guest', matrix.crate.path)) != ''
-        working-directory: guest-libs/${{ matrix.crate.path }}/guest
-        run: |
-          cargo nextest run --cargo-profile=fast --no-tests=pass
-
-      - name: Run ${{ matrix.crate.name }} guest library integration tests
-        if: hashFiles(format('guest-libs/{0}/tests', matrix.crate.path)) != ''
-        working-directory: guest-libs/${{ matrix.crate.path }}/tests
+      - name: Run ${{ matrix.crate.name }} guest library tests
+        if: hashFiles(format('guest-libs/{0}/', matrix.crate.path)) != ''
+        working-directory: guest-libs/${{ matrix.crate.path }}
         run: |
           rustup component add rust-src --toolchain nightly-2025-02-14
-          cargo nextest run --cargo-profile=fast --no-tests=pass
+          FEATURE_ARGS=""
+          if [[ "${{ matrix.crate.name }}" == "pairing" ]]; then
+            FEATURE_ARGS="--features=bn254,bls12_381"
+          fi
+          cargo nextest run --cargo-profile=fast $FEATURE_ARGS --no-tests=pass

.github/workflows/lints.yml

@@ -23,7 +23,7 @@ jobs:
 
       - uses: codespell-project/actions-codespell@v2
         with:
-          skip: Cargo.lock,./book/pnpm-lock.yaml,*.txt,./crates/toolchain/openvm/src/memcpy.s,./crates/toolchain/openvm/src/memset.s,./audits/*.pdf,./guest-libs/ruint/guest/*
+          skip: Cargo.lock,./book/pnpm-lock.yaml,*.txt,./crates/toolchain/openvm/src/memcpy.s,./crates/toolchain/openvm/src/memset.s,./audits/*.pdf,./guest-libs/ruint/*
           ignore_words_file: .codespellignore
 
       - uses: dtolnay/rust-toolchain@stable

Cargo.toml

@@ -62,20 +62,13 @@ members = [
     "extensions/pairing/circuit",
     "extensions/pairing/guest",
     "extensions/pairing/transpiler",
-    "guest-libs/ff_derive/guest/",
-    "guest-libs/ff_derive/tests/",
-    "guest-libs/k256/guest/",
-    "guest-libs/k256/tests/",
-    "guest-libs/p256/guest/",
-    "guest-libs/p256/tests/",
-    "guest-libs/keccak256/guest/",
-    "guest-libs/keccak256/tests/",
-    "guest-libs/pairing/guest/",
-    "guest-libs/pairing/tests/",
-    "guest-libs/ruint/guest/",
-    "guest-libs/ruint/tests/",
-    "guest-libs/sha2/guest/",
-    "guest-libs/sha2/tests/",
+    "guest-libs/ff_derive/",
+    "guest-libs/k256/",
+    "guest-libs/p256/",
+    "guest-libs/keccak256/",
+    "guest-libs/pairing/",
+    "guest-libs/ruint/",
+    "guest-libs/sha2/",
 ]
 exclude = ["crates/sdk/example"]
 resolver = "2"

benchmarks/guest/ecrecover/Cargo.toml

@@ -12,8 +12,8 @@ openvm-algebra-guest = { path = "../../../extensions/algebra/guest", default-fea
 openvm-ecc-guest = { path = "../../../extensions/ecc/guest", default-features = false, features = [
     "k256",
 ] }
-openvm-keccak256 = { path = "../../../guest-libs/keccak256/guest", default-features = false }
-k256 = { path = "../../../guest-libs/k256/guest", default-features = false, features = ["ecdsa"], package = "openvm-k256" }
+openvm-keccak256 = { path = "../../../guest-libs/keccak256/", default-features = false }
+k256 = { path = "../../../guest-libs/k256/", default-features = false, features = ["ecdsa"], package = "openvm-k256" }
 # We do not patch revm-precompile so that the benchmark only depends on this repo.
 revm-precompile = { version = "14.0.0", default-features = false }
 alloy-primitives = { version = "0.8.10", default-features = false, features = [

benchmarks/guest/kitchen-sink/Cargo.toml

@@ -17,10 +17,10 @@ openvm-pairing-guest = { path = "../../../extensions/pairing/guest", default-fea
     "bn254",
     "bls12_381",
 ] }
-openvm-pairing = { path = "../../../guest-libs/pairing/guest", features = ["bn254", "bls12_381"] }
-openvm-keccak256 = { path = "../../../guest-libs/keccak256/guest", default-features = false }
-openvm-sha2 = { path = "../../../guest-libs/sha2/guest", default-features = false }
-openvm-ruint = { path = "../../../guest-libs/ruint/guest", default-features = false }
+openvm-pairing = { path = "../../../guest-libs/pairing/", features = ["bn254", "bls12_381"] }
+openvm-keccak256 = { path = "../../../guest-libs/keccak256/", default-features = false }
+openvm-sha2 = { path = "../../../guest-libs/sha2/", default-features = false }
+openvm-ruint = { path = "../../../guest-libs/ruint/", default-features = false }
 hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
 serde = "1.0"
 

benchmarks/guest/pairing/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
 openvm-algebra-guest = { path = "../../../extensions/algebra/guest", default-features = false }
 openvm-ecc-guest = { path = "../../../extensions/ecc/guest", default-features = false }
-openvm-pairing = { path = "../../../guest-libs/pairing/guest", default-features = false, features = [
+openvm-pairing = { path = "../../../guest-libs/pairing/", default-features = false, features = [
     "bn254",
 ] }
 openvm-pairing-guest = { path = "../../../extensions/pairing/guest", default-features = false, features = [

benchmarks/guest/regex/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 
 [dependencies]
 openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
-openvm-keccak256 = { path = "../../../guest-libs/keccak256/guest" }
+openvm-keccak256 = { path = "../../../guest-libs/keccak256/" }
 regex = { version = "1.11.1", default-features = false }
 
 [features]

examples/pairing/Cargo.toml

@@ -13,7 +13,7 @@ openvm-algebra-guest = { path = "../../extensions/algebra/guest" }
 openvm-algebra-moduli-macros = { path = "../../extensions/algebra/moduli-macros" }
 openvm-algebra-complex-macros = { path = "../../extensions/algebra/complex-macros" }
 openvm-ecc-guest = { path = "../../extensions/ecc/guest" }
-openvm-pairing = { path = "../../guest-libs/pairing/guest", features = [
+openvm-pairing = { path = "../../guest-libs/pairing/", features = [
     "bls12_381",
 ] }
 openvm-pairing-guest = { path = "../../extensions/pairing/guest", features = [

extensions/ecc/tests/programs/Cargo.toml

@@ -15,7 +15,7 @@ openvm-algebra-guest = { path = "../../../algebra/guest", default-features = fal
 openvm-algebra-moduli-macros = { path = "../../../algebra/moduli-macros", default-features = false }
 openvm-rv32im-guest = { path = "../../../../extensions/rv32im/guest", default-features = false }
 
-openvm-keccak256 = { path = "../../../../guest-libs/keccak256/guest" }
+openvm-keccak256 = { path = "../../../../guest-libs/keccak256/" }
 
 serde = { version = "1.0", default-features = false, features = [
     "alloc",

guest-libs/ff_derive/guest/Cargo.toml renamed to guest-libs/ff_derive/Cargo.toml

@@ -24,3 +24,17 @@ num-integer = "0.1"
 proc-macro2 = "1"
 quote = "1"
 syn = { version = "1", features = ["full"] }
+
+[dev-dependencies]
+openvm-instructions = { workspace = true }
+openvm-stark-sdk = { workspace = true } 
+openvm-circuit = { workspace = true, features = ["test-utils", "parallel"]}
+openvm-transpiler = { workspace = true }
+openvm-algebra-transpiler = { workspace = true }
+openvm-algebra-circuit = { workspace = true }
+openvm-rv32im-transpiler = { workspace = true }
+openvm-toolchain-tests = { workspace = true }
+
+eyre = { workspace = true }
+num-bigint = { workspace = true }
+

guest-libs/ff_derive/guest/src/lib.rs renamed to guest-libs/ff_derive/src/lib.rs

@@ -25,7 +25,11 @@ mod tests {
         let moduli = ["39402006196394479212279040100143613805079739270465446667948293404245721771496870329047266088258938001861606973112319"]
         .map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "full_limbs", &config)?;
+        let elf = build_example_program_at_path(
+            get_programs_dir!("tests/programs"),
+            "full_limbs",
+            &config,
+        )?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -43,7 +47,8 @@ mod tests {
     fn test_fermat() -> Result<()> {
         let moduli = ["65537"].map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "fermat", &config)?;
+        let elf =
+            build_example_program_at_path(get_programs_dir!("tests/programs"), "fermat", &config)?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -61,7 +66,8 @@ mod tests {
     fn test_sqrt() -> Result<()> {
         let moduli = ["357686312646216567629137"].map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "sqrt", &config)?;
+        let elf =
+            build_example_program_at_path(get_programs_dir!("tests/programs"), "sqrt", &config)?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -81,7 +87,11 @@ mod tests {
             ["52435875175126190479447740508185965837690552500527637822603658699938581184513"]
                 .map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "constants", &config)?;
+        let elf = build_example_program_at_path(
+            get_programs_dir!("tests/programs"),
+            "constants",
+            &config,
+        )?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -101,7 +111,11 @@ mod tests {
             ["52435875175126190479447740508185965837690552500527637822603658699938581184513"]
                 .map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "from_u128", &config)?;
+        let elf = build_example_program_at_path(
+            get_programs_dir!("tests/programs"),
+            "from_u128",
+            &config,
+        )?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -122,7 +136,7 @@ mod tests {
                 .map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
         let elf = build_example_program_at_path_with_features(
-            get_programs_dir!(),
+            get_programs_dir!("tests/programs"),
             "batch_inversion",
             ["std"],
             &config,
@@ -146,7 +160,11 @@ mod tests {
             ["52435875175126190479447740508185965837690552500527637822603658699938581184513"]
                 .map(|s| BigUint::from_str(s).unwrap());
         let config = Rv32ModularConfig::new(moduli.to_vec());
-        let elf = build_example_program_at_path(get_programs_dir!(), "operations", &config)?;
+        let elf = build_example_program_at_path(
+            get_programs_dir!("tests/programs"),
+            "operations",
+            &config,
+        )?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()

guest-libs/ff_derive/guest/src/pow_fixed.rs renamed to guest-libs/ff_derive/src/pow_fixed.rs

@@ -19,7 +19,7 @@ ff = { version = "0.13.1", features = ["derive"] }
 rand = { version = "0.9.1", default-features = false }
 num-bigint = { version = "0.4.6", default-features = false }
 
-openvm-ff-derive = { path = "../../guest" }
+openvm-ff-derive = { path = "../../" }
 
 [features]
 default = []

guest-libs/ff_derive/tests/Cargo.toml

@@ -26,10 +26,30 @@ k256 = { workspace = true }
 [target.'cfg(not(target_os = "zkvm"))'.dependencies]
 num-bigint = { workspace = true }
 
+[dev-dependencies]
+openvm-circuit = { workspace = true, features = ["test-utils", "parallel"] }
+openvm-transpiler.workspace = true
+openvm-algebra-circuit.workspace = true
+openvm-algebra-transpiler.workspace = true
+openvm-ecc-transpiler.workspace = true
+openvm-ecc-circuit.workspace = true
+openvm-sha256-circuit.workspace = true
+openvm-sha256-transpiler.workspace = true
+openvm-rv32im-circuit.workspace = true
+openvm-rv32im-transpiler.workspace = true
+openvm-toolchain-tests.workspace = true
+
+openvm-stark-backend.workspace = true
+openvm-stark-sdk.workspace = true
+
+serde.workspace = true
+eyre.workspace = true
+derive_more = { workspace = true, features = ["from"] }
+
 [features]
 default = ["ecdsa"]
 ecdsa = ["k256/ecdsa", "ecdsa-core"]
 ecdsa-core = ["k256/ecdsa-core"]
 
 [package.metadata.cargo-shear]
-ignored = ["openvm", "num-bigint", "serde"]
+ignored = ["openvm", "num-bigint", "serde", "derive_more"]

guest-libs/ff_derive/tests/src/lib.rs renamed to guest-libs/ff_derive/tests/lib.rs

@@ -19,7 +19,8 @@ mod tests {
     #[test]
     fn test_add() -> Result<()> {
         let config = Rv32WeierstrassConfig::new(vec![SECP256K1_CONFIG.clone()]);
-        let elf = build_example_program_at_path(get_programs_dir!(), "add", &config)?;
+        let elf =
+            build_example_program_at_path(get_programs_dir!("tests/programs"), "add", &config)?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -36,7 +37,8 @@ mod tests {
     #[test]
     fn test_mul() -> Result<()> {
         let config = Rv32WeierstrassConfig::new(vec![SECP256K1_CONFIG.clone()]);
-        let elf = build_example_program_at_path(get_programs_dir!(), "mul", &config)?;
+        let elf =
+            build_example_program_at_path(get_programs_dir!("tests/programs"), "mul", &config)?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -140,7 +142,8 @@ mod tests {
     fn test_ecdsa() -> Result<()> {
         let config = EcdsaConfig::new(vec![SECP256K1_CONFIG.clone()]);
 
-        let elf = build_example_program_at_path(get_programs_dir!(), "ecdsa", &config)?;
+        let elf =
+            build_example_program_at_path(get_programs_dir!("tests/programs"), "ecdsa", &config)?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()
@@ -156,9 +159,13 @@ mod tests {
     }
 
     #[test]
-    fn test_scalar_sqrt() -> Result<()> {
+    fn test_sjcalar_sqrt() -> Result<()> {
         let config = Rv32WeierstrassConfig::new(vec![SECP256K1_CONFIG.clone()]);
-        let elf = build_example_program_at_path(get_programs_dir!(), "scalar_sqrt", &config)?;
+        let elf = build_example_program_at_path(
+            get_programs_dir!("tests/programs"),
+            "scalar_sqrt",
+            &config,
+        )?;
         let openvm_exe = VmExe::from_elf(
             elf,
             Transpiler::<F>::default()

guest-libs/ff_derive/tests/programs/Cargo.toml

@@ -10,8 +10,8 @@ openvm-algebra-guest = { path = "../../../../extensions/algebra/guest" }
 openvm-algebra-moduli-macros = { path = "../../../../extensions/algebra/moduli-macros/" }
 openvm-ecc-guest = { path = "../../../../extensions/ecc/guest" }
 openvm-ecc-sw-macros = { path = "../../../../extensions/ecc/sw-macros/" }
-openvm-k256 = { path = "../../guest" }
-openvm-sha2 = { path = "../../../sha2/guest" }
+openvm-k256 = { path = "../../" }
+openvm-sha2 = { path = "../../../sha2/" }
 
 elliptic-curve = { version = "0.13.8" }
 ecdsa = { version = "0.16.9" }