feat: add --hex-file <file_path> option to blockstack-cli contract-call
#6195
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fdefelici
changed the title
-xf <file_path> option to blockstack-cli contract-call--hex-file <file_path> option to blockstack-cli contract-call
kantai
previously approved these changes
Jun 12, 2025
There was a problem hiding this comment.
Tested locally using a 1.5MB hex file (which was not possible before this feature because of shell limitations), and seems to work fine. What I used to test:
# Call the contract with the file containing the hex-encoded argument.
./stacks-core/target/release-lite/blockstack-cli \
contract-call \
<private-key> \
10000000 \
1 \
<stx-addr> \
contract-name \
function-name \
--hex-file ./hex-args.txt
stackslib/src/blockstack_cli.rs
Outdated
Comment on lines
1245
to
1294
| #[test] | ||
| fn test_contract_call_with_serialized_arg_from_file_fails_due_to_content() { | ||
| //Scenerio 01: Bad hex string but (good except for the \n) | ||
| let mut file = NamedTempFile::new().expect("Cannot create tempfile!"); | ||
| 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()); | ||
|
|
||
| //Scenerio 02: short buffer | ||
| let mut file = NamedTempFile::new().expect("Cannot create tempfile!"); | ||
| 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()); | ||
| } | ||
|
|
There was a problem hiding this comment.
The only thing I'd suggest (sorry for nitpicking) is to break this test into two, or at least not use the same failed assertion message in the two assert!(result.is_err(), "Result should be err!");.
There was a problem hiding this comment.
No problem at all! I was trying to follow the codebase style, but I’ve gone ahead and split the test into two.: ecbc255
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change, add
--hex-file <file_path>option toblockstack-cli contract-callthat allows to allow a serialized Clarity value by file.This is useful in case the value is great enough to not fit in the command-line.
It can be used like this:
Applicable issues
blockstack-clicontract-callhex function args #6193Additional info (benefits, drawbacks, caveats)
Checklist
docs/rpc/openapi.yamlandrpc-endpoints.mdfor v2 endpoints,event-dispatcher.mdfor new events)clarity-benchmarkingrepobitcoin-tests.yml