feat(cast storage): allow exporting the JSON layout #9332
+25
−5
Conversation
This file contains 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
Prior to this change, `cast storage $ADDRESS --rpc-url $RPC_URL --etherscan-api-key $ETHERSCAN_API_KEY` always provided a prettified output. This change adds a `--pretty` flag to `cast storage` which defaults to `true` thus retaining backwards compatibility. Passing `--pretty=false` to `cast storage` results in the json output of the storage layout being produced instead.
MaxMustermann2
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
The default value is accessible via `cast storage --help`
MaxMustermann2
changed the title
grandizzy
requested changes
Nov 16, 2024
There was a problem hiding this comment.
thank you! left some comments, please also add a test similar with
foundry/crates/cast/tests/cli/main.rs
Line 1116 in a79dfae
| /// is not provided. The formatted (pretty) storage layout is shown even if this value | ||
| /// is provided. | ||
| #[arg(long, default_value = "", value_name = "output_json")] | ||
| pub output_json: String, |
There was a problem hiding this comment.
we have the global --json flag you could use, just check shell::is_json() to see if cast storage was called with it. then one could just redirect output to desired file, I don't think this new arg is needed.
| @@ -256,7 +276,7 @@ async fn fetch_storage_slots<P: Provider<T, AnyNetwork>, T: Transport + Clone>( | |||
| fn print_storage(layout: StorageLayout, values: Vec<StorageValue>, pretty: bool) -> Result<()> { | |||
| if !pretty { | |||
| sh_println!("{}", serde_json::to_string_pretty(&serde_json::to_value(layout)?)?)?; | |||
| return Ok(()) | |||
| return Ok(()); | |||
There was a problem hiding this comment.
let's keep current format
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.
Motivation
Prior to this change,
cast storage $ADDRESS --rpc-url $RPC_URL --etherscan-api-key $ETHERSCAN_API_KEYalways provided a prettified output. There was no way to obtain the JSON storage layout.Solution
This change adds a
--output-jsonflag tocast storage. If--slotis omitted and this flag is provided, the storage layout JSON is saved to the specified location.