Merge pull request #28601 from ProvableHQ/feat/cli-improvements

Overhaul `leo::{deploy, execute}`

Author: d0cd

Cargo.lock

@@ -168,7 +168,6 @@ only_testnet = [ ]
 [dependencies]
 dialoguer = "0.11.0"
 num-format = "0.4.4"
-text-tables = "0.3.1"
 
 [dependencies.leo-ast]
 workspace = true

Cargo.toml

@@ -227,7 +227,7 @@ create_messages!(
     invalid_network_name {
         args: (network: impl Display),
         msg: format!("Invalid network name: {network}"),
-        help: Some("Valid network names are `testnet` and `mainnet`.".to_string()),
+        help: Some("Valid network names are `testnet`, `mainnet`, and `canary`.".to_string()),
     }
 
     @backtraced
@@ -327,4 +327,11 @@ create_messages!(
         msg: format!("Invalid program name `{name}`"),
         help: None,
     }
+
+    @backtraced
+    custom {
+        args: (msg: impl Display),
+        msg: format!("{msg}"),
+        help: None,
+    }
 );

errors/src/errors/cli/cli_errors.rs

@@ -238,7 +238,7 @@ create_messages!(
     /// For when file could not be read.
     @backtraced
     failed_to_read_file {
-        args: (path: impl Display, error: impl ErrorArg),
+        args: (path: impl Display, error: impl Display),
         msg: format!("failed to read file: {path}, error: {error}"),
         help: None,
     }

errors/src/errors/package/package_errors.rs

@@ -186,6 +186,7 @@ mod tests {
                     inputs: vec!["1u32".to_string(), "2u32".to_string()],
                     file: None,
                     compiler_options: Default::default(),
+                    env_override: Default::default(),
                 },
             },
             path: Some(project_directory.clone()),
@@ -231,6 +232,7 @@ mod tests {
                     ],
                     file: None,
                     compiler_options: Default::default(),
+                    env_override: Default::default(),
                 },
             },
             path: Some(project_directory.clone()),
@@ -270,6 +272,7 @@ mod tests {
                     name: "inner_1_main".to_string(),
                     inputs: vec!["1u32".to_string(), "2u32".to_string()],
                     compiler_options: Default::default(),
+                    env_override: Default::default(),
                     file: None,
                 },
             },
@@ -307,6 +310,7 @@ mod tests {
                     name: "main".to_string(),
                     inputs: vec!["1u32".to_string(), "2u32".to_string()],
                     compiler_options: Default::default(),
+                    env_override: Default::default(),
                     file: None,
                 },
             },
@@ -322,7 +326,7 @@ mod tests {
 
 #[cfg(test)]
 mod test_helpers {
-    use crate::cli::{CLI, LeoAdd, LeoNew, cli::Commands, run_with_args};
+    use crate::cli::{CLI, DependencySource, LeoAdd, LeoNew, cli::Commands, run_with_args};
     use leo_span::create_session_if_not_set_then;
     use std::path::Path;
 
@@ -415,8 +419,7 @@ function external_nested_function:
             command: Commands::Add {
                 command: LeoAdd {
                     name: "nested_example_layer_0".to_string(),
-                    local: None,
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: None, network: true },
                     clear: false,
                     dev: false,
                 },
@@ -528,8 +531,7 @@ program child.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "parent".to_string(),
-                    local: Some(parent_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(parent_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -544,8 +546,7 @@ program child.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "child".to_string(),
-                    local: Some(child_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(child_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -560,8 +561,7 @@ program child.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "child".to_string(),
-                    local: Some(child_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(child_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -703,8 +703,7 @@ program outer.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "inner_1".to_string(),
-                    local: Some(inner_1_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(inner_1_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -719,8 +718,7 @@ program outer.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "inner_2".to_string(),
-                    local: Some(inner_2_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(inner_2_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -892,8 +890,7 @@ program outer_2.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "inner_1".to_string(),
-                    local: Some(inner_1_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(inner_1_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },
@@ -908,8 +905,7 @@ program outer_2.aleo {
             command: Commands::Add {
                 command: LeoAdd {
                     name: "inner_2".to_string(),
-                    local: Some(inner_2_directory.clone()),
-                    network: NETWORK.to_string(),
+                    source: DependencySource { local: Some(inner_2_directory.clone()), network: false },
                     clear: false,
                     dev: false,
                 },

leo/cli/cli.rs

@@ -15,7 +15,7 @@
 // along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
 
 use super::*;
-use leo_package::{Dependency, Location, Manifest, NetworkName};
+use leo_package::{Dependency, Location, Manifest};
 use std::path::PathBuf;
 
 /// Add a new on-chain or local dependency to the current package.
@@ -25,11 +25,8 @@ pub struct LeoAdd {
     #[clap(name = "NAME", help = "The dependency name. Ex: `credits.aleo` or `credits`.")]
     pub(crate) name: String,
 
-    #[clap(short = 'l', long, help = "Path to local dependency")]
-    pub(crate) local: Option<PathBuf>,
-
-    #[clap(short = 'n', long, help = "Name of the network to use", default_value = "testnet")]
-    pub(crate) network: String,
+    #[clap(flatten)]
+    pub(crate) source: DependencySource,
 
     #[clap(short = 'c', long, help = "Clear all previous dependencies.", default_value = "false")]
     pub(crate) clear: bool,
@@ -38,6 +35,16 @@ pub struct LeoAdd {
     pub(crate) dev: bool,
 }
 
+#[derive(Parser, Debug)]
+#[group(required = true, multiple = false)]
+pub struct DependencySource {
+    #[clap(short = 'l', long, help = "Whether the dependency is local to the machine.", group = "source")]
+    pub(crate) local: Option<PathBuf>,
+
+    #[clap(short = 'n', long, help = "Whether the dependency is on a live network.", group = "source")]
+    pub(crate) network: bool,
+}
+
 impl Command for LeoAdd {
     type Input = ();
     type Output = ();
@@ -64,13 +71,10 @@ impl Command for LeoAdd {
             return Err(CliError::invalid_program_name(name).into());
         }
 
-        let network: NetworkName = self.network.parse()?;
-
         let new_dependency = Dependency {
             name: name.clone(),
-            location: if self.local.is_some() { Location::Local } else { Location::Network },
-            network: if self.local.is_some() { None } else { Some(network) },
-            path: self.local.clone(),
+            location: if self.source.local.is_some() { Location::Local } else { Location::Network },
+            path: self.source.local.clone(),
         };
 
         let deps = if self.dev { &mut manifest.dev_dependencies } else { &mut manifest.dependencies };
@@ -87,10 +91,10 @@ impl Command for LeoAdd {
             *matched_dep = new_dependency;
         } else {
             deps.as_mut().unwrap().push(new_dependency);
-            if let Some(path) = self.local.as_ref() {
+            if let Some(path) = self.source.local.as_ref() {
                 tracing::info!("✅ Added local dependency to program `{name}` at path `{}`.", path.display());
             } else {
-                tracing::info!("✅ Added network dependency `{name}` from network `{}`.", self.network);
+                tracing::info!("✅ Added network dependency `{name}` from network `{}`.", self.source.network);
             }
         }
 

leo/cli/commands/add.rs

@@ -47,6 +47,8 @@ impl From<BuildOptions> for CompilerOptions {
 pub struct LeoBuild {
     #[clap(flatten)]
     pub(crate) options: BuildOptions,
+    #[clap(flatten)]
+    pub(crate) env_override: EnvOptions,
 }
 
 impl Command for LeoBuild {
@@ -63,7 +65,7 @@ impl Command for LeoBuild {
 
     fn apply(self, context: Context, _: Self::Input) -> Result<Self::Output> {
         // Parse the network.
-        let network: NetworkName = context.get_network(&self.options.network)?.parse()?;
+        let network: NetworkName = context.get_network(&self.env_override.network)?.parse()?;
         match network {
             NetworkName::MainnetV0 => handle_build::<MainnetV0>(&self, context),
             NetworkName::TestnetV0 => handle_build::<TestnetV0>(&self, context),
@@ -78,9 +80,9 @@ fn handle_build<N: Network>(command: &LeoBuild, context: Context) -> Result<<Leo
     let home_path = context.home()?;
 
     let package = if command.options.build_tests {
-        leo_package::Package::from_directory_with_tests(&package_path, &home_path)?
+        leo_package::Package::from_directory_with_tests(&package_path, &home_path, command.options.no_cache)?
     } else {
-        leo_package::Package::from_directory(&package_path, &home_path)?
+        leo_package::Package::from_directory(&package_path, &home_path, command.options.no_cache)?
     };
 
     let outputs_directory = package.outputs_directory();

leo/cli/commands/build.rs

@@ -0,0 +1,60 @@
+// Copyright (C) 2019-2025 Provable Inc.
+// This file is part of the Leo library.
+
+// The Leo library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// The Leo library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
+
+use super::*;
+use leo_package::NetworkName;
+
+/// Asks the user to confirm an action, with an optional `--yes` override.
+pub fn confirm(prompt: &str, skip_confirmation: bool) -> Result<bool> {
+    if skip_confirmation {
+        return Ok(true);
+    }
+
+    let result = Confirm::with_theme(&ColorfulTheme::default())
+        .with_prompt(prompt)
+        .default(false)
+        .interact()
+        .map_err(|e| CliError::custom(format!("Failed to prompt user: {e}")).into());
+
+    // Print a newline for better formatting.
+    println!();
+
+    result
+}
+
+/// Asks the user to confirm a fee.
+pub fn confirm_fee<N: Network>(
+    fee: &snarkvm::prelude::Fee<N>,
+    private_key: &PrivateKey<N>,
+    address: &Address<N>,
+    endpoint: &str,
+    network: NetworkName,
+    context: &Context,
+    skip: bool,
+) -> Result<bool> {
+    // Get the fee amount.
+    let total_cost = (*fee.amount()? as f64) / 1_000_000.0;
+    if fee.is_fee_public() {
+        let public_balance =
+            get_public_balance(private_key, endpoint, &network.to_string(), context)? as f64 / 1_000_000.0;
+        println!("💰Your current public balance is {public_balance} credits.\n");
+        if public_balance < total_cost {
+            return Err(PackageError::insufficient_balance(address, public_balance, total_cost).into());
+        }
+    }
+    // Confirm the transaction.
+    confirm(&format!("This transaction will cost you {total_cost} credits. Do you want to proceed?"), skip)
+}

leo/cli/commands/common/interactive.rs

@@ -0,0 +1,26 @@
+// Copyright (C) 2019-2025 Provable Inc.
+// This file is part of the Leo library.
+
+// The Leo library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// The Leo library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
+
+mod interactive;
+pub use interactive::*;
+
+mod options;
+pub use options::*;
+
+mod query;
+pub use query::*;
+
+use super::*;