Merge pull request #6195 from fdefelici/feat/cli-contract-call-from-file

feat: add `--hex-file <file_path>` option to blockstack-cli contract-call

Author: fdefelici

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
   - `stacks_node_miner_stop_reason_total`: Counts the number of times the miner stopped mining due to various reasons.
   - Always report the number of transactions mined in the last attempt, even if there were 0
 
+- Added a new option `--hex-file <file_path>` to `blockstack-cli contract-call` command, that allows to pass a serialized Clarity value by file.
 - Added a new option `--postcondition-mode [allow, deny]` to `blockstack-cli publish` command, to set the post-condition mode to allow or deny on the transaction (default is deny)
 
 ### Changed

Cargo.lock

@@ -92,6 +92,7 @@ rstest_reuse = "0.5.0"
 mutants = "0.0.3"
 rlimit = "0.10.2"
 chrono = "0.4.19"
+tempfile = "3.3"
 
 [features]
 default = []

stackslib/Cargo.toml

@@ -112,16 +112,18 @@ Arguments are supplied in one of two ways: through script evaluation or via hex
 of the value serialization format. The method for supplying arguments is chosen by
 prefacing each argument with a flag:
 
-  -e  indicates the argument should be _evaluated_
-  -x  indicates the argument that a serialized Clarity value is being passed (hex-serialized)
+  -e                     indicates the argument should be _evaluated_
+  -x                     indicates the argument that a serialized Clarity value is being passed (hex-serialized)
+ --hex-file <file_path>  same as `-x`, but reads the serialized Clarity value from a file
 
 e.g.,
 
    blockstack-cli contract-call $secret_key 10 0 SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 foo-contract \\
       transfer-fookens -e \\'SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 \\
                        -e \"(+ 1 2)\" \\
                        -x 0000000000000000000000000000000001 \\
-                       -x 050011deadbeef11ababffff11deadbeef11ababffff
+                       -x 050011deadbeef11ababffff11deadbeef11ababffff \\
+                       --hex-file /path/to/value.hex
 ";
 
 const TOKEN_TRANSFER_USAGE: &str = "blockstack-cli (options) token-transfer [origin-secret-key-hex] [fee-rate] [nonce] [recipient-address] [amount] [memo] [args...]
@@ -606,7 +608,7 @@ fn handle_contract_call(
 
     if val_args.len() % 2 != 0 {
         return Err(
-            "contract-call arguments must be supplied as a list of `-e ...` or `-x 0000...` pairs"
+            "contract-call arguments must be supplied as a list of `-e ...` or `-x 0000...` or `--hex-file <file_path>` pairs"
                 .into(),
         );
     }
@@ -624,8 +626,16 @@ fn handle_contract_call(
                 vm_execute(input, clarity_version)?
                     .ok_or("Supplied argument did not evaluate to a Value")?
             },
+            "--hex-file" => {
+                let content = fs::read_to_string(input)
+                    .map_err(|e| {
+                        let err_msg = format!("Cannot read file: {input}. Reason: {e}");
+                        CliError::Message(err_msg)
+                    })?;
+                Value::try_deserialize_hex_untyped(&content)?
+            }
             _ => {
-                return Err("contract-call arguments must be supplied as a list of `-e ...` or `-x 0000...` pairs".into())
+                return Err("contract-call arguments must be supplied as a list of `-e ...` or `-x 0000...` or `--hex-file <file_path>` pairs".into())
             }
         };
 
@@ -1053,6 +1063,7 @@ mod test {
 
     use blockstack_lib::chainstate::stacks::TransactionPostCondition;
     use stacks_common::util::cargo_workspace;
+    use tempfile::NamedTempFile;
 
     use super::*;
 
@@ -1574,6 +1585,106 @@ mod test {
         );
     }
 
+    #[test]
+    fn test_contract_call_with_serialized_arg_from_file_ok() {
+        let mut file = NamedTempFile::new().expect("Cannot create tempfile!");
+        write!(file, "0000000000000000000000000000000001").expect("Cannot Write to temp file");
+
+        let file_path = file.path().to_str().unwrap();
+        let cc_args = [
+            "contract-call",
+            "043ff5004e3d695060fa48ac94c96049b8c14ef441c50a184a6a3875d2a000f3",
+            "1",
+            "0",
+            "SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4",
+            "foo-contract",
+            "transfer-fookens",
+            "--hex-file",
+            file_path,
+        ];
+
+        let result = main_handler(to_string_vec(&cc_args));
+        assert!(result.is_ok(), "Result should be ok!");
+
+        let expected_tx = "0000000001040021a3c334fc0ee50359353799e8b2605ac6be1fe400000000000000000000000000000001010011db0868db0cd44c463b3a8a8b3b428ddaad15661e7b7d8c92c814c142c526e30abffe74e1e098f517037a1ee74969f4db27630407f4c958cb0d6e1d7485fe06030200000000021625a2a51cf0712a9d228e2788e2fe7acf8917ec810c666f6f2d636f6e7472616374107472616e736665722d666f6f6b656e73000000010000000000000000000000000000000001";
+        assert_eq!(expected_tx, result.unwrap());
+    }
+
+    #[test]
+    fn test_contract_call_with_serialized_arg_from_file_fails_due_to_file() {
+        let file_path = "/tmp/this-file-not-exists";
+        let cc_args = [
+            "contract-call",
+            "043ff5004e3d695060fa48ac94c96049b8c14ef441c50a184a6a3875d2a000f3",
+            "1",
+            "0",
+            "SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4",
+            "foo-contract",
+            "transfer-fookens",
+            "--hex-file",
+            file_path,
+        ];
+
+        let result = main_handler(to_string_vec(&cc_args));
+        assert!(result.is_err(), "Result should be err!");
+
+        let expected_msg = format!("Cannot read file: {}. Reason: ", file_path);
+        assert!(result.unwrap_err().to_string().starts_with(&expected_msg));
+    }
+
+    #[test]
+    fn test_contract_call_with_serialized_arg_from_file_fails_due_to_bad_hex() {
+        let mut file = NamedTempFile::new().expect("Cannot create tempfile!");
+        // Bad hex string but (good except for the \n)
+        write!(file, "0000000000000000000000000000000001\n").expect("Cannot Write to temp file");
+        let file_path = file.path().to_str().unwrap();
+
+        let cc_args = [
+            "contract-call",
+            "043ff5004e3d695060fa48ac94c96049b8c14ef441c50a184a6a3875d2a000f3",
+            "1",
+            "0",
+            "SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4",
+            "foo-contract",
+            "transfer-fookens",
+            "--hex-file",
+            &file_path,
+        ];
+
+        let result = main_handler(to_string_vec(&cc_args));
+        assert!(result.is_err(), "Result should be err!");
+
+        let expected_msg = "Failed to deserialize: Deserialization error: Bad hex string";
+        assert_eq!(expected_msg, result.unwrap_err().to_string());
+    }
+
+    #[test]
+    fn test_contract_call_with_serialized_arg_from_file_fails_due_to_short_buffer() {
+        let mut file = NamedTempFile::new().expect("Cannot create tempfile!");
+        // hex buffer is short
+        write!(file, "0101").expect("Cannot Write to temp file");
+        let file_path = file.path().to_str().unwrap();
+
+        let cc_args = [
+            "contract-call",
+            "043ff5004e3d695060fa48ac94c96049b8c14ef441c50a184a6a3875d2a000f3",
+            "1",
+            "0",
+            "SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4",
+            "foo-contract",
+            "transfer-fookens",
+            "--hex-file",
+            &file_path,
+        ];
+
+        let result = main_handler(to_string_vec(&cc_args));
+        assert!(result.is_err(), "Result should be err!");
+
+        let expected_msg =
+            "Failed to deserialize: Serialization error caused by IO: failed to fill whole buffer";
+        assert_eq!(expected_msg, result.unwrap_err().to_string());
+    }
+
     #[test]
     fn simple_addresses() {
         let addr_args = [