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.

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

fix: CLI help for PayForBlob #2991

Merged
merged 3 commits into from
Jan 8, 2024
Merged

fix: CLI help for PayForBlob #2991

merged 3 commits into from
Jan 8, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Jan 8, 2024

Closes #2990

Testing

$ ./build/celestia-appd tx blob PayForBlob --help
Pay for data blob(s) to be published to Celestia.
To publish a single blob, specify the namespaceID and blob via CLI arguments.
To publish multiple blobs, use the --input-file flag with the path to a JSON file.
The JSON should look like:

{
	"Blobs": [
		{
			"namespaceID": "0x00010203040506070809",
			"blob": "0x48656c6c6f2c20576f726c6421"
		},
		{
			"namespaceID": "0x00010203040506070809",
			"blob": "0x48656c6c6f2c20576f726c6421"
		}
	]
}

The namespaceID is the user-specifiable portion of a version 0 namespace.
The namespaceID must be a hex encoded string of 10 bytes.
The blob must be a hex encoded string of non-zero length.

Usage:
  celestia-appd tx blob PayForBlobs [namespaceID blob] [flags]

@rootulp rootulp self-assigned this Jan 8, 2024
Copy link
Contributor

coderabbitai bot commented Jan 8, 2024

Walkthrough

Walkthrough

The update to the payforblob.go file streamlines the help message for the PayForBlob command, enhancing readability and user guidance. The changes include cosmetic improvements such as fixing indentation and removing unnecessary characters in the help message. Additionally, the command's usability has been improved by refining the instructions for submitting blobs and adjusting the validation rules for input.

Changes

File Path Change Summary
.../cli/payforblob.go Updated help message formatting and instructions, removed errors import, renamed PayForBlobs to PayForBlob, and refined validation logic.

Assessment against linked issues

Objective Addressed Explanation
#2990: Fix indentation and remove \ns in PayForBlob --help
#2990: Reword help message for clarity
#2990: Ensure proper validation logic for input
#2990: Rename command for consistency and clarity

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@celestia-bot celestia-bot requested a review from a team January 8, 2024 01:24
cmwaters
cmwaters previously approved these changes Jan 8, 2024
evan-forbes
evan-forbes previously approved these changes Jan 8, 2024
@rootulp rootulp dismissed stale reviews from evan-forbes and cmwaters via 2f88919 January 8, 2024 14:21
@celestia-bot celestia-bot requested a review from a team January 8, 2024 14:22
@rootulp rootulp enabled auto-merge (squash) January 8, 2024 14:22
staheri14
staheri14 previously approved these changes Jan 8, 2024
Copy link
Contributor

@staheri14 staheri14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

x/blob/client/cli/payforblob.go Outdated Show resolved Hide resolved
x/blob/client/cli/payforblob.go Show resolved Hide resolved
@rootulp rootulp disabled auto-merge January 8, 2024 18:22
@rootulp rootulp merged commit ebd733d into celestiaorg:main Jan 8, 2024
29 of 30 checks passed
@rootulp rootulp deleted the rp/fix-help branch January 8, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PayForBlob --help indentation is off
4 participants