Merges the two dry-run args into a single one

Author: grarco

crates/apps_lib/src/cli.rs

@@ -7816,7 +7816,6 @@ pub mod args {
 
             Ok(Tx::<SdkTypes> {
                 dry_run: self.dry_run,
-                dry_run_wrapper: self.dry_run_wrapper,
                 dump_tx: self.dump_tx,
                 dump_wrapper_tx: self.dump_wrapper_tx,
                 output_folder: self.output_folder,
@@ -7967,8 +7966,13 @@ pub mod args {
         }
 
         fn parse(matches: &ArgMatches) -> Self {
-            let dry_run = DRY_RUN_TX.parse(matches);
-            let dry_run_wrapper = DRY_RUN_WRAPPER_TX.parse(matches);
+            let dry_run = if DRY_RUN_TX.parse(matches) {
+                Some(DryRun::Inner)
+            } else if DRY_RUN_WRAPPER_TX.parse(matches) {
+                Some(DryRun::Wrapper)
+            } else {
+                None
+            };
             let dump_tx = DUMP_TX.parse(matches);
             let dump_wrapper_tx = DUMP_WRAPPER_TX.parse(matches);
             let force = FORCE.parse(matches);
@@ -8003,7 +8007,6 @@ pub mod args {
             let device_transport = DEVICE_TRANSPORT.parse(matches);
             Self {
                 dry_run,
-                dry_run_wrapper,
                 dump_tx,
                 dump_wrapper_tx,
                 force,

crates/apps_lib/src/cli/client.rs

@@ -37,8 +37,7 @@ impl CliApi {
                         client.wait_until_node_is_synced(&io).await?;
                         let args = args.to_sdk(&mut ctx)?;
                         let namada = ctx.to_sdk(client, io);
-                        let dry_run =
-                            args.tx.dry_run || args.tx.dry_run_wrapper;
+                        let dry_run = args.tx.dry_run.is_some();
                         tx::submit_custom(&namada, args).await?;
                         if !dry_run {
                             namada
@@ -193,8 +192,7 @@ impl CliApi {
                         client.wait_until_node_is_synced(&io).await?;
                         let args = args.to_sdk(&mut ctx)?;
                         let namada = ctx.to_sdk(client, io);
-                        let dry_run =
-                            args.tx.dry_run || args.tx.dry_run_wrapper;
+                        let dry_run = args.tx.dry_run.is_some();
                         tx::submit_init_account(&namada, args).await?;
                         if !dry_run {
                             namada

crates/apps_lib/src/client/tx.rs

@@ -491,7 +491,7 @@ pub async fn submit_change_consensus_key(
         let wrapper_hash = tx.wrapper_hash();
         let resp = namada.submit(tx, &args.tx).await?;
 
-        if !(args.tx.dry_run || args.tx.dry_run_wrapper) {
+        if args.tx.dry_run.is_none() {
             if resp
                 .is_applied_and_valid(wrapper_hash.as_ref(), &cmt)
                 .is_some()
@@ -689,7 +689,7 @@ pub async fn submit_become_validator(
         let wrapper_hash = tx.wrapper_hash();
         let resp = namada.submit(tx, &args.tx).await?;
 
-        if args.tx.dry_run || args.tx.dry_run_wrapper {
+        if args.tx.dry_run.is_some() {
             display_line!(
                 namada.io(),
                 "Transaction dry run. No key or addresses have been saved."
@@ -815,7 +815,7 @@ pub async fn submit_init_validator(
     )
     .await?;
 
-    if tx_args.dry_run || tx_args.dry_run_wrapper {
+    if tx_args.dry_run.is_some() {
         eprintln!(
             "Cannot proceed to become validator in dry-run as no account has \
              been created"
@@ -1794,7 +1794,7 @@ where
         let wrapper_hash = tx.wrapper_hash();
         let resp = namada.submit(tx, &args.tx).await?;
 
-        if !(args.tx.dry_run || args.tx.dry_run_wrapper)
+        if args.tx.dry_run.is_none()
             && resp
                 .is_applied_and_valid(wrapper_hash.as_ref(), &cmt)
                 .is_some()

crates/apps_lib/src/config/genesis/transactions.rs

@@ -77,8 +77,7 @@ fn get_tx_args(use_device: bool) -> TxArgs {
     use std::str::FromStr;
 
     TxArgs {
-        dry_run: false,
-        dry_run_wrapper: false,
+        dry_run: None,
         dump_tx: false,
         dump_wrapper_tx: false,
         output_folder: None,

crates/sdk/src/args.rs

@@ -2622,14 +2622,20 @@ impl TxExpiration {
     }
 }
 
+/// Argument for dry-runs
+#[derive(Clone, Debug)]
+pub enum DryRun {
+    /// Request a dry run of the inner transaction(s) only
+    Inner,
+    /// Request a dry run of both the inner transaction(s) and the wrapper
+    Wrapper,
+}
+
 /// Common transaction arguments
 #[derive(Clone, Debug)]
 pub struct Tx<C: NamadaTypes = SdkTypes> {
-    // FIXME: should these two be mutually exclusive? Yes
-    /// Simulate applying the transaction
-    pub dry_run: bool,
-    /// Simulate applying both the wrapper and inner transactions
-    pub dry_run_wrapper: bool,
+    /// Simulate applying the transaction (possibly the wrapper too)
+    pub dry_run: Option<DryRun>,
     /// Dump the raw transaction bytes to file
     // FIXME: should these two be mutually exclusive? Yes
     // FIXME: can we use dump tx to avoid wrapping the tx instead of the extra
@@ -2714,16 +2720,9 @@ pub trait TxBuilder<C: NamadaTypes>: Sized {
     where
         F: FnOnce(Tx<C>) -> Tx<C>;
     /// Simulate applying the transaction
-    fn dry_run(self, dry_run: bool) -> Self {
+    fn dry_run(self, dry_run: Option<DryRun>) -> Self {
         self.tx(|x| Tx { dry_run, ..x })
     }
-    /// Simulate applying both the wrapper and inner transactions
-    fn dry_run_wrapper(self, dry_run_wrapper: bool) -> Self {
-        self.tx(|x| Tx {
-            dry_run_wrapper,
-            ..x
-        })
-    }
     /// Dump the transaction bytes to file
     fn dump_tx(self, dump_tx: bool) -> Self {
         self.tx(|x| Tx { dump_tx, ..x })

crates/sdk/src/lib.rs

@@ -124,8 +124,7 @@ pub trait Namada: NamadaIo {
     /// Make a tx builder using no arguments
     fn tx_builder(&self) -> args::Tx {
         args::Tx {
-            dry_run: false,
-            dry_run_wrapper: false,
+            dry_run: None,
             dump_tx: false,
             dump_wrapper_tx: false,
             output_folder: None,
@@ -708,8 +707,7 @@ where
             io,
             native_token: native_token.clone(),
             prototype: args::Tx {
-                dry_run: false,
-                dry_run_wrapper: false,
+                dry_run: None,
                 dump_tx: false,
                 dump_wrapper_tx: false,
                 output_folder: None,

crates/sdk/src/signing.rs

@@ -2474,8 +2474,7 @@ mod test_signing {
 
     fn arbitrary_args() -> args::Tx {
         args::Tx {
-            dry_run: false,
-            dry_run_wrapper: false,
+            dry_run: None,
             dump_tx: false,
             dump_wrapper_tx: false,
             output_folder: None,

crates/sdk/src/tx.rs

@@ -242,7 +242,7 @@ pub async fn prepare_tx(
     fee_amount: DenominatedAmount,
     fee_payer: common::PublicKey,
 ) -> Result<()> {
-    if args.dry_run || args.dump_tx {
+    if matches!(args.dry_run, Some(args::DryRun::Inner)) || args.dump_tx {
         Ok(())
     } else {
         signing::wrap_tx(tx, args, fee_amount, fee_payer).await
@@ -266,7 +266,7 @@ pub async fn process_tx(
     // let request_body = request.into_json();
     // println!("HTTP request body: {}", request_body);
 
-    if args.dry_run || args.dry_run_wrapper {
+    if args.dry_run.is_some() {
         expect_dry_broadcast(TxBroadcastData::DryRun(tx), context).await
     } else {
         // We use this to determine when the wrapper tx makes it on-chain
@@ -3538,6 +3538,9 @@ where
         fee_payer,
     }) = wrap_args
     {
+        // FIXME: if wrap_args is provided we wrap it but within prepare_tx we
+        // avoid wrapping it if a dry-run or dump is requested so maybe there's
+        // a way to avoid the wrap_it argument
         prepare_tx(tx_args, &mut tx, fee_amount, fee_payer).await?;
     }