feat: client multicall

Signed-off-by: Tomas Fabrizio Orsi <[email protected]>

Author: lima-limon-inc

bin/miden-cli/src/commands/account.rs

@@ -9,7 +9,7 @@ use miden_client::{
 use miden_objects::PrettyPrint;
 
 use crate::{
-    CLIENT_BINARY_NAME,
+    client_binary_name,
     config::CliConfig,
     create_dynamic_table,
     errors::CliError,
@@ -324,7 +324,10 @@ pub(crate) fn maybe_set_default_account(
 
     let account_id = account_id.to_bech32(current_config.rpc.endpoint.0.to_network_id()?);
     println!("Setting account {account_id} as the default account ID.");
-    println!("You can unset it with `{CLIENT_BINARY_NAME} account --default none`.");
+    println!(
+        "You can unset it with `{} account --default none`.",
+        client_binary_name().display()
+    );
     current_config.default_account_id = Some(account_id);
 
     Ok(())

bin/miden-cli/src/commands/new_account.rs

@@ -26,7 +26,7 @@ use rand::RngCore;
 use tracing::debug;
 
 use crate::{
-    CLIENT_BINARY_NAME, CliKeyStore, commands::account::maybe_set_default_account,
+    CliKeyStore, client_binary_name, commands::account::maybe_set_default_account,
     errors::CliError, utils::load_config_file,
 };
 
@@ -133,7 +133,8 @@ impl NewWalletCmd {
 
         println!("Successfully created new wallet.");
         println!(
-            "To view account details execute {CLIENT_BINARY_NAME} account -s {account_address}",
+            "To view account details execute {} account -s {account_address}",
+            client_binary_name().display()
         );
 
         maybe_set_default_account(&mut current_config, new_account.id())?;
@@ -196,7 +197,8 @@ impl NewAccountCmd {
 
         println!("Successfully created new account.");
         println!(
-            "To view account details execute {CLIENT_BINARY_NAME} account -s {account_address}"
+            "To view account details execute {} account -s {account_address}",
+            client_binary_name().display()
         );
 
         Ok(())

bin/miden-cli/src/errors.rs

@@ -6,8 +6,7 @@ use miden_objects::{AccountError, AccountIdError, AssetError, NetworkIdError};
 use miette::Diagnostic;
 use thiserror::Error;
 
-use crate::CLIENT_BINARY_NAME;
-
+use crate::client_binary_name;
 type SourceError = Box<dyn Error + Send + Sync>;
 
 #[derive(Debug, Diagnostic, Error)]
@@ -31,7 +30,9 @@ pub enum CliError {
     #[diagnostic(
         code(cli::config_error),
         help(
-            "Check if the configuration file exists and is well-formed. If it does not exist, run `{CLIENT_BINARY_NAME} init` command to create it."
+            "Check if the configuration file exists and is well-formed. If it does not exist, run `{} init` command to create it.",
+            client_binary_name().display()
+
         )
     )]
     Config(#[source] SourceError, String),

bin/miden-cli/src/lib.rs

@@ -1,6 +1,6 @@
-use std::{env, sync::Arc};
+use std::{env, ffi::OsString, sync::Arc};
 
-use clap::Parser;
+use clap::{Parser, Subcommand};
 use comfy_table::{Attribute, Cell, ContentArrangement, Table, presets};
 use errors::CliError;
 use miden_client::{
@@ -41,7 +41,24 @@ mod utils;
 const CLIENT_CONFIG_FILE_NAME: &str = "miden-client.toml";
 
 /// Client binary name.
-pub const CLIENT_BINARY_NAME: &str = "miden-client";
+/// Note: If, for whatever reason, we fail to obtain the client's executable
+/// name, then we simply display the standard "miden-client".
+pub fn client_binary_name() -> OsString {
+    std::env::current_exe()
+        .map(|executable| {
+            executable
+                .file_name()
+                .expect("ERROR: failed to obtain the executable's file name")
+                .to_os_string()
+        })
+        .inspect_err(|e| {
+            eprintln!(
+                "WARNING: Couldn't obtain the name of the current executable because of {e}.\
+             Defaulting to miden-client."
+            );
+        })
+        .unwrap_or(OsString::from("miden-client"))
+}
 
 /// Number of blocks that must elapse after a transaction’s reference block before it is marked
 /// stale and discarded.
@@ -55,14 +72,53 @@ const TX_GRACEFUL_BLOCK_DELTA: u32 = 20;
     version,
     rename_all = "kebab-case"
 )]
-pub struct Cli {
+#[command(multicall(true))]
+pub struct MidenClientCLI {
     #[command(subcommand)]
-    action: Command,
+    behavior: Behavior,
+}
+
+impl From<MidenClientCLI> for Cli {
+    fn from(value: MidenClientCLI) -> Self {
+        match value.behavior {
+            Behavior::MidenClient { cli } => cli,
+            Behavior::External(args) => Cli::parse_from(args).set_external(),
+        }
+    }
+}
 
+#[derive(Debug, Subcommand)]
+#[command(rename_all = "kebab-case")]
+enum Behavior {
+    /// The Miden toolchain installer
+    MidenClient {
+        #[command(flatten)]
+        cli: Cli,
+    },
+
+    /// Used when the Miden Client CLI is called under a different name, like it
+    /// is the case in [Midenup](https://github.com/0xMiden/midenup).
+    #[command(external_subcommand)]
+    External(Vec<OsString>),
+}
+
+#[derive(Parser, Debug)]
+#[command(name = "miden-client")]
+pub struct Cli {
     /// Activates the executor's debug mode, which enables debug output for scripts
     /// that were compiled and executed with this mode.
     #[arg(short, long, default_value_t = false)]
     debug: bool,
+
+    #[command(subcommand)]
+    action: Command,
+
+    /// Indicates whether the client's CLI is being called directly, or
+    /// externally under an alias (like in the case of
+    /// [Midenup](https://github.com/0xMiden/midenup).
+    #[arg(skip)]
+    #[allow(unused)]
+    external: bool,
 }
 
 /// CLI actions.
@@ -153,6 +209,11 @@ impl Cli {
             Command::ConsumeNotes(consume_notes) => consume_notes.execute(client).await,
         }
     }
+
+    fn set_external(mut self) -> Self {
+        self.external = true;
+        self
+    }
 }
 
 pub fn create_dynamic_table(headers: &[&str]) -> Table {

bin/miden-cli/src/main.rs

@@ -1,14 +1,17 @@
-use miden_client_cli::Cli;
+use clap::FromArgMatches;
+use miden_client_cli::{Cli, MidenClientCLI};
 
 extern crate std;
 
 #[tokio::main]
 async fn main() -> miette::Result<()> {
-    use clap::Parser;
-
     tracing_subscriber::fmt::init();
+
     // read command-line args
-    let cli = Cli::parse();
+    let input = <MidenClientCLI as clap::CommandFactory>::command();
+    let matches = input.get_matches();
+    let parsed = MidenClientCLI::from_arg_matches(&matches).map_err(|err| err.exit()).unwrap();
+    let cli: Cli = parsed.into();
 
     // execute cli action
     Ok(cli.execute().await?)