docs: update golang client tut to use celestia-node/api/rpc/client instead of openrpc#2008
docs: update golang client tut to use celestia-node/api/rpc/client instead of openrpc#2008
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis update revises documentation in several how-to guides and a tutorial. Faucet URLs in the Arabica devnet, Mammoth, and Mocha testnet guides are updated to use new network-specific celenium subdomains. The Mammoth guide consolidates faucet references into a single URL. The Golang client tutorial is overhauled to replace the deprecated Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GoClientTutorial
participant CelestiaNodeAPI
User->>GoClientTutorial: Run SubmitBlob example
GoClientTutorial->>CelestiaNodeAPI: Connect via rpc/client
GoClientTutorial->>CelestiaNodeAPI: Submit blob with namespace
CelestiaNodeAPI-->>GoClientTutorial: Return inclusion height
GoClientTutorial-->>User: Print inclusion height
User->>GoClientTutorial: Run GetBlobs example
GoClientTutorial->>CelestiaNodeAPI: Retrieve blobs by height and namespace
CelestiaNodeAPI-->>GoClientTutorial: Return blobs
GoClientTutorial-->>User: Print blobs or error
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
how-to-guides/arabica-devnet.md (1)
169-169: Line length exceeds markdownlint recommendation. This line is over 190 characters and triggers MD013. Consider breaking it into a list or using reference-style links to improve readability and comply with the 80-character limit. For example:The web faucet is available at: - [https://arabica.celenium.io/faucet](https://arabica.celenium.io/faucet) - [https://faucet.celestia-arabica-11.com/](https://faucet.celestia-arabica-11.com/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
169-169: Line length
Expected: 80; Actual: 191(MD013, line-length)
tutorials/golang-client-tutorial.md (2)
11-14: Clarify deprecation note and section flow
The new deprecation note is helpful, but consider linking directly to the officialcelestia-openrpcdeprecation announcement or issue for more context. Also, the horizontal rule and the repeated “## Project setup” header can be confusing—either remove the first heading or merge the two sections for better flow.
34-34: Align heading style with retrieving example
The “### Submitting a blob” heading is singular, while the retrieval heading is plural. For consistency, consider renaming to “### Submitting blobs”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
how-to-guides/arabica-devnet.md(1 hunks)how-to-guides/mammoth.md(1 hunks)how-to-guides/mocha-testnet.md(1 hunks)tutorials/golang-client-tutorial.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/arabica-devnet.md
169-169: Line length
Expected: 80; Actual: 191
(MD013, line-length)
🔇 Additional comments (18)
how-to-guides/mammoth.md (1)
125-125: LGTM — Faucet URL updated correctly
The link to the Mammoth testnet faucet now uses the consolidatedmammoth.celenium.iosubdomain, matching the pattern in other network guides.how-to-guides/mocha-testnet.md (1)
239-239: Approved: Correct Mocha faucet URL update
The web faucet link has been updated to the Mocha-specific subdomain as intended. This aligns with the changes in other network guides for consistency across documentation.how-to-guides/arabica-devnet.md (1)
169-169: Faucet URL update is correct. The web faucet link has been updated to the Arabica-specific subdomain, matching the changes in related network guides.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
169-169: Line length
Expected: 80; Actual: 191(MD013, line-length)
tutorials/golang-client-tutorial.md (15)
25-26: Verify auth-token guide link
You’ve linked to/tutorials/node-tutorial.md#auth-token—please confirm that this path matches your docs structure (most env guides live under/how-to-guides), or update the URL to point at the correct location.
28-28: Confirm default RPC port
The default URL is set tohttp://localhost:26658. Please verify that Celestia’s RPC endpoint listens on port 26658 by default (some setups use 26657).
32-32: Introduction to blob examples is clear
This line succinctly sets up the upcoming examples.
38-42: Import block looks good
Standard-library imports (context,fmt) and external packages are correctly declared.
45-47: Function signature is clear
SubmitBlob(ctx, url, token)reads well and parameters are descriptive.
49-51: Error wrapping and cleanup are correct
You correctly wrap client creation errors and deferc.Close().
53-57: Namespace creation with error handling is solid
Usingshare.NewBlobNamespaceV0and wrapping the error provides clear diagnostics.
59-62: Blob instantiation is correct
Creatingblob.NewBlobV0with proper error propagation is on point.
71-73: Output formatting and return look good
Printing the height and returningnilfollows Go examples conventions.
79-82:GetBlobsinitialization is well-structured
The signature, client creation, and wrapped error are implemented correctly.
84-85: Deferring client close is handled properly
Ensures WebSocket/HTTP connections are cleaned up.
86-89: Blob retrieval logic is correct
Callingc.Blob.GetAllwith error wrapping provides clear flow.
90-91: Returning blob slice is straightforward
No further comments here.
98-100: Notes section is informative
These bullets clearly warn about temporary dependencies and point readers to advanced usage.
20-22:⚠️ Potential issueFix duplicated and missing dependencies
Thego getlist currently installs the RPC client twice and omits the blob builder. To ensure users pull in all required packages, please update as follows:-go get github.com/celestiaorg/celestia-node/api/rpc/client -go get github.com/celestiaorg/celestia-node/api/rpc/client -go get github.com/celestiaorg/celestia-node/nodebuilder/share +go get github.com/celestiaorg/celestia-node/api/rpc/client +go get github.com/celestiaorg/celestia-node/nodebuilder/blob +go get github.com/celestiaorg/celestia-node/nodebuilder/shareLikely an incorrect or invalid review comment.
added 2 examples but can't figure out how to make the client.go example work due to this dependency issue |
1 participant
Overview
WIP
Summary by CodeRabbit