Skip to content

add celenium post a blob tutorial#1702

Merged
jcstein merged 2 commits intocelestiaorg:mainfrom
Mackenzie-OO7:post-a-blob-tutorial
Sep 16, 2024
Merged

add celenium post a blob tutorial#1702
jcstein merged 2 commits intocelestiaorg:mainfrom
Mackenzie-OO7:post-a-blob-tutorial

Conversation

@Mackenzie-OO7
Copy link
Copy Markdown
Contributor

@Mackenzie-OO7 Mackenzie-OO7 commented Sep 10, 2024

closes #1548

Summary by CodeRabbit

  • New Features
    • Enhanced user guidance for submitting BlobTxs, now featuring six methods instead of four.
    • Introduced a new section on submitting blobs directly from Celenium, including a step-by-step guide.
  • Documentation
    • Updated the document for clarity and usability, emphasizing key actions and requirements for users.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 10, 2024

Walkthrough

The document developers/submit-data.md has been updated to enhance user guidance for submitting BlobTxs. A new section has been introduced that outlines the process for submitting blobs via Celenium, expanding the submission methods from four to six. The update includes a detailed step-by-step guide covering necessary actions, file compatibility, and transaction approval, thereby improving the clarity of the submission process.

Changes

File Change Summary
developers/submit-data.md Updated submission methods from four to six; added new section on posting blobs from Celenium.

Assessment against linked issues

Objective Addressed Explanation
Add Celenium post a blob tutorial (#1548)

🐇 In the meadow where data flows,
A new path for blobs now glows.
With Celenium's guide, users can see,
Six ways to submit, oh what glee!
Hop along, let transactions thrive,
In the world of Celestia, we come alive! 🌟

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 851aba4 and fc69c30.

Files selected for processing (1)
  • developers/submit-data.md (2 hunks)
Additional context used
LanguageTool
developers/submit-data.md

[uncategorized] ~364-~364: Possible missing comma found.
Context: ...ps://node-rpc-docs.celestia.org/). ### Post a blob directly from Celenium Celenium...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~372-~372: Consider adding a hyphen.
Context: ... 2. Click on the terminal button in the top right corner of the screen and select the "Su...

(TOP_LEFT_CORNER)

Additional comments not posted (1)
developers/submit-data.md (1)

177-177: LGTM!

The change is approved as it accurately reflects the addition of the new blob submission method via Celenium.


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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
developers/submit-data.md (1)

364-379: Excellent addition! Just a minor nitpick.

The new section provides clear and concise instructions for submitting blobs directly from the Celenium explorer interface, enhancing the usability of the document.

Nitpick:
At line 377, replace "the its" with "its" for grammatical correctness.

-Once the blob is submitted, you will see the its hash on the screen.
+Once the blob is submitted, you will see its hash on the screen.
Tools
LanguageTool

[uncategorized] ~372-~372: Consider adding a hyphen.
Context: ... 2. Click on the terminal button in the top right corner of the screen and select the "Su...

(TOP_LEFT_CORNER)


[grammar] ~377-~377: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “its”?
Context: ...nce the blob is submitted, you will see the its hash on the screen. You can also use Ce...

(A_MY)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c37c3af and 851aba4.

Files selected for processing (1)
  • developers/submit-data.md (2 hunks)
Additional context used
LanguageTool
developers/submit-data.md

[uncategorized] ~372-~372: Consider adding a hyphen.
Context: ... 2. Click on the terminal button in the top right corner of the screen and select the "Su...

(TOP_LEFT_CORNER)


[grammar] ~377-~377: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “its”?
Context: ...nce the blob is submitted, you will see the its hash on the screen. You can also use Ce...

(A_MY)

Additional comments not posted (1)
developers/submit-data.md (1)

177-177: LGTM!

The change is approved as it accurately reflects the expanded functionality for creating and submitting BlobTxs.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
developers/submit-data.md (1)

364-379: Excellent addition of the new section on submitting blobs via Celenium!

The new section is well-written and provides clear step-by-step instructions for users to submit blobs directly from the Celenium explorer interface. This is a valuable addition to the document as it introduces a user-friendly method for blob submission.

Just a minor nitpick, feel free to ignore:

Consider adding a hyphen in "top right" to make it "top-right" for consistency with common usage. For example:

- 2. Click on the terminal button in the top right corner of the screen and select the "Submit data blob" option.
+ 2. Click on the terminal button in the top-right corner of the screen and select the "Submit data blob" option.

Overall, great work on enhancing the document with this new section!

Tools
LanguageTool

[uncategorized] ~364-~364: Possible missing comma found.
Context: ...ps://node-rpc-docs.celestia.org/). ### Post a blob directly from Celenium Celenium...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~372-~372: Consider adding a hyphen.
Context: ... 2. Click on the terminal button in the top right corner of the screen and select the "Su...

(TOP_LEFT_CORNER)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 851aba4 and fc69c30.

Files selected for processing (1)
  • developers/submit-data.md (2 hunks)
Additional context used
LanguageTool
developers/submit-data.md

[uncategorized] ~364-~364: Possible missing comma found.
Context: ...ps://node-rpc-docs.celestia.org/). ### Post a blob directly from Celenium Celenium...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~372-~372: Consider adding a hyphen.
Context: ... 2. Click on the terminal button in the top right corner of the screen and select the "Su...

(TOP_LEFT_CORNER)

Additional comments not posted (1)
developers/submit-data.md (1)

177-177: LGTM!

The change is approved as it accurately reflects the addition of the new blob submission method via Celenium.

Comment thread developers/submit-data.md
## API

Users can currently create and submit `BlobTx`s in four ways.
Users can currently create and submit `BlobTx`s in six ways.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

did this PR add 2 ways, or is the old version wrong? thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

did this PR add 2 ways, or is the old version wrong? thanks!

There were five methods listed already, not four.

Comment thread developers/submit-data.md

Learn more in the [celestia-node API docs](https://node-rpc-docs.celestia.org/).

### Post a blob directly from Celenium
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM otherwise!

@jcstein jcstein merged commit b6ee7f8 into celestiaorg:main Sep 16, 2024
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.

feat: add celenium post a blob tutorial

2 participants