Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve description of --blob-amounts flag in txsim CLI #3311

Closed
staheri14 opened this issue Apr 12, 2024 · 0 comments · Fixed by #3312
Closed

Improve description of --blob-amounts flag in txsim CLI #3311

staheri14 opened this issue Apr 12, 2024 · 0 comments · Fixed by #3312
Assignees
@staheri14
Labels
chore optional label for items that follow the `chore` conventional commit WS: Big Blonks 🔭 Improving consensus critical gossiping protocols

Comments

@staheri14
Copy link
Collaborator

staheri14 commented Apr 12, 2024 •
edited
Loading

This issue was identified during the big block workstream, specifically while conducting sanity tests and aligning the txsim configurations between the Testground and Knuu backends.

The current description for the --blob-amounts flag in the txsim CLI is ambiguous and does not provide clear guidance on acceptable input formats or the resulting behavior. The description reads:

--blob-amounts string  range of blobs to send per PFB in a sequence (default "1")

This issue highlights the need to enhance the flag description to address the following points:

  • Clarify whether providing a single value sets that exact number of blobs per PFB or if it signifies the maximum number of blobs.
  • Explain how to input a range of values and describe the behavior when a range is specified.

The goal is to revise the flag description to ensure it is straightforward and informative, helping users understand how to effectively utilize this option.
@staheri14 staheri14 self-assigned this Apr 12, 2024
@staheri14 staheri14 mentioned this issue Apr 13, 2024
Merged
@staheri14 staheri14 added WS: Big Blonks 🔭 Improving consensus critical gossiping protocols chore optional label for items that follow the `chore` conventional commit and removed needs:triage labels Apr 13, 2024
staheri14 added a commit that referenced this issue Apr 15, 2024
@staheri14
chore: improves description of --blob-amounts flag in txsim CLI (#3312)
4f2e0f5 
Closes #3311

No changes to the implementation are necessary to support a range for
the number of blobs in txsim CLI; the description of the
`--blob-amounts` flag is merely underspecified. I tested the CLI, and it
can indeed accept a range, such as `--blob-amounts 1-10`.
ninabarbakadze pushed a commit to ninabarbakadze/celestia-app that referenced this issue Apr 17, 2024
@staheri14 @ninabarbakadze
chore: improves description of --blob-amounts flag in txsim CLI (cele…
04baf2f 
…stiaorg#3312)

Closes celestiaorg#3311

No changes to the implementation are necessary to support a range for
the number of blobs in txsim CLI; the description of the
`--blob-amounts` flag is merely underspecified. I tested the CLI, and it
can indeed accept a range, such as `--blob-amounts 1-10`.
@coderabbitai coderabbitai bot mentioned this issue May 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@staheri14 staheri14

Labels
chore optional label for items that follow the `chore` conventional commit WS: Big Blonks 🔭 Improving consensus critical gossiping protocols
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: improves description of --blob-amounts flag in txsim CLI celestiaorg/celestia-app
1 participant
@staheri14