feat: add format flag in chain head command #5215
Conversation
akaladarshi
requested review from
LesnyRumcajs and
sudo-shashank
and removed request for
a team
|
|
|
|
There was a problem hiding this comment.
@akaladarshi Thanks for the contribution! In general, looks good. I requested some minor changes.
Also
- Pease add sample test to:
https://github.com/akaladarshi/forest/blob/akaladarshi/add-format-flag/scripts/tests/calibnet_other_check.sh#L32-L34
Something along forest-cli chain head --tipsets 5 --format json | jq to assert valid JSON is produced
- Please add an entry to the changelog
src/cli/subcommands/chain_cmd.rs
Outdated
| #[arg(short, long, default_value = "text")] | ||
| format: Format, |
There was a problem hiding this comment.
Let's not use the short -f here. Typically, it denotes --force or --file.
src/cli/subcommands/chain_cmd.rs
Outdated
| cids: Vec<String>, | ||
| } | ||
|
|
||
| async fn collect_tipsets(client: &rpc::Client, n: u64) -> anyhow::Result<Vec<TipsetInfo>> { |
There was a problem hiding this comment.
Let's have a doc for the function.
src/cli/subcommands/chain_cmd.rs
Outdated
| cids: Vec<String>, | ||
| } | ||
|
|
||
| async fn collect_tipsets(client: &rpc::Client, n: u64) -> anyhow::Result<Vec<TipsetInfo>> { |
There was a problem hiding this comment.
| async fn collect_tipsets(client: &rpc::Client, n: u64) -> anyhow::Result<Vec<TipsetInfo>> { | |
| async fn collect_n_tipsets(client: &rpc::Client, n: u64) -> anyhow::Result<Vec<TipsetInfo>> { |
src/cli/subcommands/chain_cmd.rs
Outdated
| ensure!(n > 0, "number of tipsets must be positive"); | ||
| let current_epoch = ChainHead::call(client, ()).await?.epoch() as u64; | ||
|
|
||
| let mut result = Vec::with_capacity(n as usize); |
There was a problem hiding this comment.
| let mut result = Vec::with_capacity(n as usize); | |
| let mut tipsets = Vec::with_capacity(n as usize); |
src/cli/subcommands/chain_cmd.rs
Outdated
|
|
||
| /// Print the first `n` tipsets from the head (inclusive). | ||
| async fn print_chain_head(client: &rpc::Client, n: u64, format: Format) -> anyhow::Result<()> { | ||
| let result = collect_tipsets(client, n).await?; |
There was a problem hiding this comment.
| let result = collect_tipsets(client, n).await?; | |
| let tipsets = collect_tipsets(client, n).await?; |
src/cli/subcommands/chain_cmd.rs
Outdated
| /// Collects `n` tipsets from the head (inclusive) and returns them as a list of | ||
| /// `TipsetInfo` objects. |
There was a problem hiding this comment.
Let's have proper Rust doc linking.
| /// Collects `n` tipsets from the head (inclusive) and returns them as a list of | |
| /// `TipsetInfo` objects. | |
| /// Collects `n` tipsets from the head (inclusive) and returns them as a list of | |
| /// [`TipsetInfo`] objects. |
Summary of changes
Changes introduced in this pull request:
--formator-fflag to theforest-cli chain headcommand--formatflag acceptsjsonortextvalue, by defaulttextReference issue to close (if applicable)
#4954
Other information and links
Change checklist