docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify TxConfig initialization in golang-client-tutorial.md

Open thearcyx opened this issue 6 months ago • 2 comments

Overview

This PR improves the documentation of the NewTxConfig function in golang-client-tutorial.md.

The updated comment explains that NewTxConfig() initializes a transaction configuration with default gas settings (DefaultGasPrice, DefaultMaxGasPrice) and that it can optionally take variadic options to customize its behavior.

This change is important because passing nil as the TxConfig can lead to runtime errors. For example, when calling client.Blob.Submit(ctx, []*blob.Blob{...}, nil), although nil is accepted by the function signature, it may cause internal panics due to uninitialized fields in the transaction context. Using a default TxConfig avoids this and ensures stability.

Context

While following the Go client tutorial, I encountered a runtime error when submitting a blob using nil for the SubmitOptions. This was resolved by explicitly initializing a TxConfig using state.NewTxConfig(). This PR updates the guide to help future developers avoid the same pitfall.

Checklist

  • [x] Clear and safe example added for TxConfig usage
  • [x] Based on a reproducible runtime issue
  • [x] Aligned with Celestia's contributor guide
  • [x] No breaking changes introduced

Summary by CodeRabbit

  • Documentation
    • Updated the Golang client tutorial to use a default transaction configuration for blob submission, ensuring safer default settings.
    • Added comments to clarify the use of a default transaction configuration.

thearcyx avatar Jun 05 '25 11:06 thearcyx

Walkthrough

The Golang client tutorial was updated to use a default transaction configuration object when submitting a blob, replacing the previous use of nil. The import section now includes the state package, and comments were added to explain the rationale behind this change. No changes were made to control flow or error handling.

Changes

File(s) Change Summary
tutorials/golang-client-tutorial.md Updated blob submission example to use state.NewTxConfig() instead of nil; added explanatory comments; imported state package.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GolangClientTutorial
    participant CelestiaClient
    participant State

    User->>GolangClientTutorial: Call SubmitBlob()
    GolangClientTutorial->>State: Create TxConfig (NewTxConfig)
    GolangClientTutorial->>CelestiaClient: Submit(blob, namespace, TxConfig)
    CelestiaClient-->>GolangClientTutorial: Return result/error
    GolangClientTutorial-->>User: Return result/error

Possibly related PRs

  • celestiaorg/docs#1671: Modifies the Golang client tutorial to improve blob submission by introducing configurable transaction options.
  • celestiaorg/docs#2011: Updates the tutorial to use state.NewTxConfig() instead of nil for blob submission options.

Suggested reviewers

  • jcstein

Poem

A nibble of code, a hop and a bound,
With TxConfig in tow, safe defaults are found.
No more nils wandering in the night,
State imported, the future is bright!
🐰✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar Jun 05 '25 11:06 coderabbitai[bot]

let's also update the CI/CD that was added in https://github.com/celestiaorg/docs/pull/2069 for this

jcstein avatar Jun 05 '25 13:06 jcstein