Merge pull request #3757 from anoma/brent/better-custom-tx-error

Improve custom tx error and help msg
anoma · Sep 6, 2024 · bd686dc · bd686dc
2 parents 521511f + 03c9cbf
commit bd686dc
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/.changelog/unreleased/improvements/3757-better-custom-tx-error.md b/.changelog/unreleased/improvements/3757-better-custom-tx-error.md
@@ -0,0 +1,3 @@
+- Improve error and help messages to clarify that a .tx
+  file is expected as input to --tx-path for a custom tx.
+  ([\#3757](https://github.com/anoma/namada/pull/3757))
diff --git a/crates/apps_lib/src/cli.rs b/crates/apps_lib/src/cli.rs
@@ -4483,7 +4483,11 @@ pub mod args {
                 .arg(
                     TX_PATH_OPT
                         .def()
-                        .help(wrap!("The path to a serialized transaction."))
+                        .help(wrap!(
+                            "The path to a serialized transaction. It is \
+                             expected that this transaction is contained in a \
+                             .tx file, typically produced from a tx dump."
+                        ))
                         .conflicts_with_all([
                             CODE_PATH_OPT.name,
                             DATA_PATH_OPT.name,

diff --git a/crates/sdk/src/tx.rs b/crates/sdk/src/tx.rs
@@ -3708,7 +3708,12 @@ pub async fn build_custom(
 
     let mut tx = if let Some(serialized_tx) = serialized_tx {
         Tx::deserialize(serialized_tx.as_ref()).map_err(|_| {
-            Error::Other("Invalid tx deserialization.".to_string())
+            Error::Other(
+                "Invalid tx deserialization. Please make sure you are passing \
+                 a file in .tx format, typically produced from using the \
+                 `--dump-tx` flag."
+                    .to_string(),
+            )
         })?
     } else {
         let code_path = code_path