Merge pull request #295 from athenavm/remove-helper-crate

remove `athena-helper` crate

Cargo.toml

@@ -7,7 +7,6 @@ members = [
   "ffi/athcon/bindings/rust/athcon-sys",
   "ffi/athcon/bindings/rust/athcon-vm",
   "ffi/vmlib",
-  "helper",
   "interface",
   "runner",
   "sdk",

builder/README.md

@@ -1,7 +1,6 @@
 # athena-builder
 
-Lightweight crate used to build Athena programs. Internal crate that is exposed to users via `athena-cli` and
-`athena-helper`.
+A crate used to build Athena programs. It can be used directly or via the `athena-cli`.
 
 Exposes `build_program`, which builds an Athena program in the local environment or in a docker container with the
 specified parameters from `BuildArgs`.

helper/src/lib.rs → builder/src/build.rs

@@ -1,7 +1,8 @@
-pub use athena_builder::BuildArgs;
 use cargo_metadata::Metadata;
 use std::path::Path;
 
+use crate::BuildArgs;
+
 /// Re-run the cargo command if the Cargo.toml or Cargo.lock file changes.
 fn cargo_rerun_if_changed(metadata: &Metadata, program_dir: &Path) {
   // Tell cargo to rerun the script only if program/{src, bin, build.rs, Cargo.toml} changes
@@ -51,7 +52,7 @@ fn execute_build_cmd(program_dir: &impl AsRef<std::path::Path>, args: Option<Bui
     return;
   }
 
-  athena_builder::build_program(
+  crate::build_program(
     &args.unwrap_or_default(),
     Some(program_dir.as_ref().to_path_buf()),
   )

builder/src/lib.rs

@@ -1,3 +1,4 @@
+pub mod build;
 mod docker;
 
 use clap::Parser;
@@ -259,8 +260,7 @@ fn copy_elf_to_output_dir(
   Ok(result_elf_path)
 }
 
-/// Build a program with the specified [`BuildArgs`]. The `program_dir` is specified as an argument when
-/// the program is built via `build_program` in athena-helper.
+/// Build a program with the specified [`BuildArgs`].
 ///
 /// # Arguments
 ///

core/Cargo.toml

@@ -35,4 +35,4 @@ debug = []
 unittest = []
 
 [build-dependencies]
-athena-helper = { path = "../helper" }
+athena-builder = { path = "../builder/" }

core/build.rs

@@ -1,12 +1,8 @@
 #[cfg(feature = "unittest")]
 fn build_programs_for_tests() {
-  use athena_helper::build_program;
+  use athena_builder::build::build_program;
 
-  build_program("../examples/fibonacci/program");
-  build_program("../examples/hello_world/program");
   build_program("../examples/io/program");
-  build_program("../examples/wallet/program");
-  build_program("../tests/host");
   build_program("../tests/panic");
 }
 

examples/fibonacci/program/src/main.rs

@@ -18,8 +18,8 @@ pub fn main() {
   athena_vm::io::write(&n);
 
   // Compute the n'th fibonacci number, using normal Rust code.
-  let mut a = 0;
-  let mut b = 1;
+  let mut a = 0u32;
+  let mut b = 1u32;
   for _ in 0..n {
     let mut c = a + b;
     c %= 7919; // Modulus to prevent overflow.

examples/fibonacci/script/Cargo.toml

@@ -9,7 +9,7 @@ athena-sdk = { path = "../../../sdk" }
 tracing-subscriber = "0.3.18"
 
 [build-dependencies]
-athena-helper = { path = "../../../helper" }
+athena-builder = { path = "../../../builder" }
 
 [[bin]]
 name = "fibonacci-script"

examples/fibonacci/script/build.rs

@@ -1,3 +1,3 @@
 fn main() {
-  athena_helper::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
+  athena_builder::build::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
 }

examples/hello_world/script/Cargo.toml

@@ -8,4 +8,4 @@ athena-sdk = { path = "../../../sdk" }
 tracing-subscriber = "0.3.18"
 
 [build-dependencies]
-athena-helper = { path = "../../../helper" }
+athena-builder = { path = "../../../builder" }

examples/hello_world/script/build.rs

@@ -1,3 +1,3 @@
 fn main() {
-  athena_helper::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
+  athena_builder::build::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
 }

examples/io/script/Cargo.toml

@@ -9,4 +9,4 @@ athena-sdk = { path = "../../../sdk" }
 tracing-subscriber = "0.3.18"
 
 [build-dependencies]
-athena-helper = { path = "../../../helper" }
+athena-builder = { path = "../../../builder" }

examples/io/script/build.rs

@@ -1,3 +1,3 @@
 fn main() {
-  athena_helper::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
+  athena_builder::build::build_program(&format!("{}/../program", env!("CARGO_MANIFEST_DIR")));
 }

examples/wallet/script/Cargo.toml

@@ -20,4 +20,4 @@ ed25519-dalek = { version = "2.1.1", features = ["rand_core"] }
 rand = "0.8.5"
 
 [build-dependencies]
-athena-helper = { path = "../../../helper" }
+athena-builder = { path = "../../../builder" }

examples/wallet/script/build.rs

@@ -1,5 +1,3 @@
-use athena_helper::build_program;
-
 fn main() {
-  build_program("../program")
+  athena_builder::build::build_program("../program")
 }

ffi/vmlib/Cargo.toml

@@ -17,3 +17,12 @@ athena-runner = { path = "../../runner" }
 athcon-sys = { path = "../athcon/bindings/rust/athcon-sys" }
 athcon-vm = { path = "../athcon/bindings/rust/athcon-vm" }
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
+
+[dev-dependencies]
+athena-vmlib = { path = ".", features = ["unittest"] }
+
+[build-dependencies]
+athena-builder = { path = "../../builder" }
+
+[features]
+unittest = []

ffi/vmlib/build.rs

@@ -7,4 +7,7 @@ fn main() {
     println!("cargo:rustc-link-arg=-undefined");
     println!("cargo:rustc-link-arg=dynamic_lookup");
   }
+
+  #[cfg(feature = "unittest")]
+  athena_builder::build::build_program("../../examples/hello_world/program");
 }

runner/Cargo.toml

@@ -20,7 +20,7 @@ athena-runner = { path = ".", features = ["unittest"] }
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
 
 [build-dependencies]
-athena-helper = { path = "../helper" }
+athena-builder = { path = "../builder" }
 
 [features]
 unittest = []

runner/build.rs

@@ -1,7 +1,8 @@
 #[cfg(feature = "unittest")]
 fn build_programs_for_tests() {
-  use athena_helper::build_program;
+  use athena_builder::build::build_program;
   build_program("../tests/entrypoint");
+  build_program("../tests/recursive_call");
 }
 
 fn main() {

sdk/Cargo.toml

@@ -13,10 +13,14 @@ athena-core = { path = "../core" }
 athena-interface = { path = "../interface" }
 
 [build-dependencies]
-anyhow = "1.0.95"
+athena-builder = { path = "../builder" }
 vergen-git2 = { version = "1.0.2", default-features = false, features = [
     "build",
 ] }
 
 [dev-dependencies]
+athena-sdk = { path = ".", features = ["unittest"] }
 tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
+
+[features]
+unittest = []

sdk/build.rs

@@ -1,13 +1,23 @@
-use anyhow::Result;
 use vergen_git2::{BuildBuilder, Emitter, Git2Builder};
 
-fn main() -> Result<()> {
+fn main() -> Result<(), Box<dyn std::error::Error>> {
   let build = BuildBuilder::default().build_timestamp(true).build()?;
   let git2 = Git2Builder::default().sha(true).build()?;
 
   Emitter::default()
     .add_instructions(&build)?
     .add_instructions(&git2)?
-    .emit()?;
+    .emit()
+    .unwrap();
+
+  #[cfg(feature = "unittest")]
+  build_programs_for_tests();
+
   Ok(())
 }
+
+#[cfg(feature = "unittest")]
+fn build_programs_for_tests() {
+  athena_builder::build::build_program("../examples/fibonacci/program");
+  athena_builder::build::build_program("../tests/panic");
+}