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

refactor: v0.15.0 #1671

Merged
merged 1 commit into from
Aug 21, 2024
Merged

refactor: v0.15.0 #1671

merged 1 commit into from
Aug 21, 2024

Conversation

distractedm1nd
Copy link
Collaborator

@distractedm1nd distractedm1nd commented Aug 19, 2024

Adds blobsub and SubmitOptions to the golang node tutorial.

Summary by CodeRabbit

  • New Features

    • Enhanced blob submission process with configurable options for gas price and transaction parameters.
    • Added guidance on subscribing to new blobs in specific namespaces, complete with practical code examples.
  • Documentation

    • Updated the tutorial to reflect changes in blob submission and subscription practices, improving clarity and usability for users.

Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Walkthrough

The recent updates to the Golang client tutorial significantly enhance blob submission and subscription functionalities. Users can now customize transaction parameters more flexibly with the new blob.NewSubmitOptions() method. Additionally, a section on subscribing to new blobs has been introduced, providing practical guidance for monitoring blobs in specific namespaces, thus improving the tutorial's usability and comprehensiveness.

Changes

Files Change Summary
developers/golang-client-tutorial.md Replaced blob.DefaultGasPrice() with blob.NewSubmitOptions() for enhanced configuration; added a new section on subscribing to blobs using blob.Subscribe(ctx). Retained and clarified the section on subscribing to headers.

Poem

In fields of code where rabbits play,
New blobs emerge, bright as day.
With options to tweak and listen clear,
Our tutorial's now a joyful cheer!
Hop along, dear coder friends,
For in this change, the fun never ends! 🐇✨


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 as 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.

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

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
Contributor

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1671/
on branch main at 2024-08-19 14:25 UTC

Copy link
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/golang-client-tutorial.md (1)

Line range hint 62-110: Replace hard tabs with spaces.

The presence of hard tabs can lead to inconsistent formatting. Consider replacing them with spaces for better readability and consistency.

-	// Example with hard tab
+  // Example with spaces
Tools
Markdownlint

86-86: Column: 1
Hard tabs

(MD010, no-hard-tabs)


87-87: Column: 1
Hard tabs

(MD010, no-hard-tabs)


88-88: Column: 1
Hard tabs

(MD010, no-hard-tabs)


89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


94-94: Column: 1
Hard tabs

(MD010, no-hard-tabs)


95-95: Column: 1
Hard tabs

(MD010, no-hard-tabs)


97-97: Column: 1
Hard tabs

(MD010, no-hard-tabs)


98-98: Column: 1
Hard tabs

(MD010, no-hard-tabs)


99-99: Column: 1
Hard tabs

(MD010, no-hard-tabs)


100-100: Column: 1
Hard tabs

(MD010, no-hard-tabs)


101-101: Column: 1
Hard tabs

(MD010, no-hard-tabs)


103-103: Column: 1
Hard tabs

(MD010, no-hard-tabs)


104-104: Column: 1
Hard tabs

(MD010, no-hard-tabs)


105-105: Column: 1
Hard tabs

(MD010, no-hard-tabs)


106-106: Column: 1
Hard tabs

(MD010, no-hard-tabs)


107-107: Column: 1
Hard tabs

(MD010, no-hard-tabs)


108-108: Column: 1
Hard tabs

(MD010, no-hard-tabs)


109-109: Column: 1
Hard tabs

(MD010, no-hard-tabs)


110-110: Column: 1
Hard tabs

(MD010, no-hard-tabs)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 77edd2b and f869c67.

Files selected for processing (1)
  • developers/golang-client-tutorial.md (3 hunks)
Additional context used
Markdownlint
developers/golang-client-tutorial.md

62-62: Column: 1
Hard tabs

(MD010, no-hard-tabs)


86-86: Column: 1
Hard tabs

(MD010, no-hard-tabs)


87-87: Column: 1
Hard tabs

(MD010, no-hard-tabs)


88-88: Column: 1
Hard tabs

(MD010, no-hard-tabs)


89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


94-94: Column: 1
Hard tabs

(MD010, no-hard-tabs)


95-95: Column: 1
Hard tabs

(MD010, no-hard-tabs)


97-97: Column: 1
Hard tabs

(MD010, no-hard-tabs)


98-98: Column: 1
Hard tabs

(MD010, no-hard-tabs)


99-99: Column: 1
Hard tabs

(MD010, no-hard-tabs)


100-100: Column: 1
Hard tabs

(MD010, no-hard-tabs)


101-101: Column: 1
Hard tabs

(MD010, no-hard-tabs)


103-103: Column: 1
Hard tabs

(MD010, no-hard-tabs)


104-104: Column: 1
Hard tabs

(MD010, no-hard-tabs)


105-105: Column: 1
Hard tabs

(MD010, no-hard-tabs)


106-106: Column: 1
Hard tabs

(MD010, no-hard-tabs)


107-107: Column: 1
Hard tabs

(MD010, no-hard-tabs)


108-108: Column: 1
Hard tabs

(MD010, no-hard-tabs)


109-109: Column: 1
Hard tabs

(MD010, no-hard-tabs)


110-110: Column: 1
Hard tabs

(MD010, no-hard-tabs)

Additional comments not posted (3)
developers/golang-client-tutorial.md (3)

27-27: LGTM: Improved usability with blob.NewSubmitOptions().

The introduction of blob.NewSubmitOptions() enhances flexibility in setting transaction parameters, which is a valuable improvement for users.


62-62: Example usage of blob.NewSubmitOptions() is clear.

The SubmitBlob function effectively demonstrates the use of blob.NewSubmitOptions() for submitting blobs.

Tools
Markdownlint

62-62: Column: 1
Hard tabs

(MD010, no-hard-tabs)


80-112: Comprehensive guidance on subscribing to new blobs.

The new section on subscribing to blobs using blob.Subscribe offers clear and practical instructions, improving the tutorial's usability.

Tools
Markdownlint

86-86: Column: 1
Hard tabs

(MD010, no-hard-tabs)


87-87: Column: 1
Hard tabs

(MD010, no-hard-tabs)


88-88: Column: 1
Hard tabs

(MD010, no-hard-tabs)


89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


94-94: Column: 1
Hard tabs

(MD010, no-hard-tabs)


95-95: Column: 1
Hard tabs

(MD010, no-hard-tabs)


97-97: Column: 1
Hard tabs

(MD010, no-hard-tabs)


98-98: Column: 1
Hard tabs

(MD010, no-hard-tabs)


99-99: Column: 1
Hard tabs

(MD010, no-hard-tabs)


100-100: Column: 1
Hard tabs

(MD010, no-hard-tabs)


101-101: Column: 1
Hard tabs

(MD010, no-hard-tabs)


103-103: Column: 1
Hard tabs

(MD010, no-hard-tabs)


104-104: Column: 1
Hard tabs

(MD010, no-hard-tabs)


105-105: Column: 1
Hard tabs

(MD010, no-hard-tabs)


106-106: Column: 1
Hard tabs

(MD010, no-hard-tabs)


107-107: Column: 1
Hard tabs

(MD010, no-hard-tabs)


108-108: Column: 1
Hard tabs

(MD010, no-hard-tabs)


109-109: Column: 1
Hard tabs

(MD010, no-hard-tabs)


110-110: Column: 1
Hard tabs

(MD010, no-hard-tabs)

Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

LGTM! thank you @distractedm1nd

@jcstein jcstein merged commit 87fef17 into main Aug 21, 2024
4 checks passed
@jcstein jcstein deleted the v15 branch August 21, 2024 16:07
@coderabbitai coderabbitai bot mentioned this pull request Nov 6, 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.

2 participants