cleanup nitro docs #1955
cleanup nitro docs #1955
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThis PR updates documentation files to improve clarity and consistency. The sidebar configuration in the VitePress setup has been updated with new, more concise item titles. Additionally, several how-to guides have been revised: the full node and validator instructions now include detailed Celestia DA configuration, the integration guide has been reworked to reflect the transition from Arbitrum Nitro to Arbitrum Orbit, and the local development guide now uses updated commands and version references. No changes were made to public API declarations. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ArbitrumOrbit
participant CelestiaServer
participant Fallback
User->>ArbitrumOrbit: Initiate transaction
ArbitrumOrbit->>CelestiaServer: Request data proof
CelestiaServer-->>ArbitrumOrbit: Return proof
alt Fallback needed
ArbitrumOrbit->>Fallback: Invoke fallback (Anytrust/Ethereum)
Fallback-->>ArbitrumOrbit: Provide fallback response
end
ArbitrumOrbit-->>User: Deliver confirmed transaction
sequenceDiagram
participant Developer
participant CLI
participant LocalDevnet
Developer->>CLI: Clone repo & checkout v3.2.5
Developer->>CLI: Run ./celestia-start.sh
CLI->>LocalDevnet: Initialize local devnet environment
LocalDevnet-->>CLI: Confirm node startup and endpoints
Developer-->>CLI: Access local devnet
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (4)
🪧 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: 0
🧹 Nitpick comments (4)
how-to-guides/arbitrum-full-node.md (1)
27-35: Specify JSON as the code block languageThe code block should specify JSON as the language for proper syntax highlighting.
-``` +```json "node": { ... "celestia-cfg": { "enable": true, "url": "DA_SERVER_URL" }, }how-to-guides/nitro-local.md (1)
10-12: Specify bash as the code block languageThe code block should specify a language for proper syntax highlighting.
-``` +```bash git clone -b release --recurse-submodules https://github.com/celestiaorg/nitro.git git checkout v3.2.5 && cd /nitro/nitro-testnode🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
how-to-guides/arbitrum-integration.md (2)
52-52: Fix typo in "guarantees"There's a spelling error in the word "guarantees".
-The integration ensures that in the case of a challenge in which the `ReadInboxMessage` instruction is disputed, that the corresponding batch can be confirmed to be in Celestia through the use of Blobstream (default is SP1 Blobstream by Succinct), which gives us strong security gaurantees that the data was made available on Celestia. +The integration ensures that in the case of a challenge in which the `ReadInboxMessage` instruction is disputed, that the corresponding batch can be confirmed to be in Celestia through the use of Blobstream (default is SP1 Blobstream by Succinct), which gives us strong security guarantees that the data was made available on Celestia.
56-56: Improve readability of fallback mechanism explanationThe explanation of the fallback mechanism is a very long sentence that could be broken up for better readability.
-Arbitrum Nitro natively supports the ability to "fallback" to Ethereum DA in case that writing a batch to Anytrust is unsuccessful, the Celestia DA integration goes a step beyond, enabling [fallbacks from any dapwriter to another](https://github.com/celestiaorg/nitro/blob/v3.5.2/arbnode/batch_poster.go#L1419-L1451) by introducing a [da-preference](https://github.com/celestiaorg/nitro/blob/v3.5.2/arbnode/node.go#L106) parameter to the node which allows developers to specify in which order they would like to prioritize fallbacks, for example, `["celestia", "anytrust"]` indicates the batch poster to first write to celestia, on failure fallback to anytrust, and on failure fallback to ethereum da or `"celestia" -> "anytrust" -> "blobs / calldata"` +Arbitrum Nitro natively supports the ability to "fallback" to Ethereum DA in case that writing a batch to Anytrust is unsuccessful. The Celestia DA integration goes a step beyond, enabling [fallbacks from any dapwriter to another](https://github.com/celestiaorg/nitro/blob/v3.5.2/arbnode/batch_poster.go#L1419-L1451) by introducing a [da-preference](https://github.com/celestiaorg/nitro/blob/v3.5.2/arbnode/node.go#L106) parameter to the node. + +This parameter allows developers to specify the order in which they would like to prioritize fallbacks. For example: +- `["celestia", "anytrust"]` instructs the batch poster to first write to Celestia +- On failure, it will fallback to Anytrust +- If that also fails, it will ultimately fallback to Ethereum DA + +This creates a fallback chain: `"celestia" -> "anytrust" -> "blobs / calldata"`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.vitepress/config.ts(1 hunks)how-to-guides/arbitrum-full-node.md(1 hunks)how-to-guides/arbitrum-integration.md(2 hunks)how-to-guides/nitro-local.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/nitro-local.md
10-10: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
how-to-guides/arbitrum-integration.md
[style] ~42-~42: Consider a shorter alternative to avoid wordiness.
Context: ...s. ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...
(IN_ORDER_TO_PREMIUM)
[style] ~43-~43: Consider a shorter alternative to avoid wordiness.
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (15)
.vitepress/config.ts (2)
562-563: LGTM: Updated sidebar text to "Arbitrum Orbit"This update makes the sidebar item more concise and aligns with the transition from Arbitrum Nitro to Arbitrum Orbit reflected in the documentation.
566-567: LGTM: Updated sidebar text to "Quickstart: Run a local devnet"This change simplifies the menu item and better reflects the content of the linked page, which now focuses on running a local development environment.
how-to-guides/arbitrum-full-node.md (3)
18-24: LGTM: Simplified node setup instructionsThe instructions now clearly direct users to the Arbitrum docs while highlighting the Celestia-specific configuration requirements. This improves readability and maintainability.
37-41: LGTM: Added helpful DA Server sectionThis new section provides valuable context about running a Celestia DA Server, including references to repository documentation and connection options.
45-46: LGTM: Updated validator configuration instructionsThe instructions now include a specific link to the DA Server validator configuration, making it easier for users to set up a validating node correctly.
how-to-guides/nitro-local.md (5)
5-5: LGTM: Updated title to "Quickstart: Run a local devnet"This title better reflects the content and purpose of the guide, and aligns with the sidebar menu item.
12-12: LGTM: Updated Git checkout versionUpdated from v3.2.1-rc.2 to the newer stable v3.2.5 version.
15-15: LGTM: Updated local development startup commandChanged from
./test-node.bash --init --devto the simpler./celestia-start.sh, which reflects updates in the repository's scripts.
18-18: LGTM: Simplified optional commandsRemoved unnecessary options while keeping the essential
--anytrustoption for testing fallbacks.
49-49: LGTM: Added Celestia Node endpointAdded the Celestia Node endpoint information to the default endpoints table, completing the list of available services in the local devnet.
how-to-guides/arbitrum-integration.md (5)
2-2: LGTM: Updated description to reference Orbit instead of NitroThe description now correctly references "Arbitrum Orbit" and mentions the fallback mechanism to both Anytrust and Ethereum.
6-6: LGTM: Updated title to reflect Arbitrum OrbitThe title has been updated to "Arbitrum Orbit with Celestia DA", which aligns with the current terminology.
25-28: LGTM: Improved key components sectionThe key components section has been updated with clearer, more specific anchor links and simplified terminology.
29-29: LGTM: Renamed fallback mechanism sectionUpdated from "Ethereum fallback mechanism" to "Fallback mechanism" to better reflect the broader fallback capabilities.
33-39: LGTM: Clarified DA provider implementationThe explanation of the DA provider interfaces and the celestia-server has been improved with specific links to code and better descriptions of the components.
|
|
||
| [More information can be found on the Ethereum fallback mechanisms for Celestia](/how-to-guides/ethereum-fallback.md), |
There was a problem hiding this comment.
do you want to remove the fallback page?
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
how-to-guides/arbitrum-full-node.md (2)
18-26: Ensure Terminology Consistency and Spacing
There’s an extra space in "Running a fullnode" (line 18) and an inconsistent use of "fullnode" versus "full node." Consider standardizing the term across the document for clarity.
27-35: Specify Language for Code Fence
The fenced code block (lines 27–35) would benefit from a language specifier (e.g.,json) to satisfy markdown lint rules and improve readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
how-to-guides/arbitrum-integration.md (7)
12-14: Refine Sentence Structure for Clarity
The sentence beginning on line 12 could be made clearer by, for example, adding a comma after the link. This would improve the flow between the introductory phrase and the rest of the sentence.
25-29: Review Key Components Bullet List
The bullet list is well structured. Double-check that the label "fallback mechanism" is still the best term in light of the updated integration details.
33-37: DA Provider Implementation Details
This section accurately describes the interfaces and the sidecar mechanism. Note a small typo on line 37—"retrivals" should be corrected to "retrievals." Additionally, verify whether "Arbitrum Nitro code" should be updated to "Arbitrum Orbit" for consistency with the new integration focus.
39-39: Punctuation in Celestia Server Instructions
Consider inserting a comma after "Celestia server" in "To run the Celestia server see the [nitro-das-celestia] repository" (line 39) for improved readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...aDasRpcClient.go). To run the Celestia server see the [nitro-das-celestia](https://gi...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
41-45: Simplify Preimage Oracle Implementation Language
To enhance conciseness, consider replacing "In order to support" with simply "To support" in this section.🧰 Tools
🪛 LanguageTool
[style] ~42-~42: Consider a shorter alternative to avoid wordiness.
Context: ...s. ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...(IN_ORDER_TO_PREMIUM)
[style] ~43-~43: Consider a shorter alternative to avoid wordiness.
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...(IN_ORDER_TO_PREMIUM)
50-53: Blobstream Integration Details
There is a typo—"gaurantees" (line 52) should be "guarantees." Also, breaking up the long sentence might improve readability.
54-57: Clarify Fallback Mechanism Details
The description is informative; however, "dapwriter" on line 56 appears to be a typo. Consider updating it to "DA writer" (or another appropriate term) and possibly splitting the sentence for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
how-to-guides/arbitrum-full-node.md(1 hunks)how-to-guides/arbitrum-integration.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/arbitrum-integration.md
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...aDasRpcClient.go). To run the Celestia server see the [nitro-das-celestia](https://gi...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~42-~42: Consider a shorter alternative to avoid wordiness.
Context: ...s. ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...
(IN_ORDER_TO_PREMIUM)
[style] ~43-~43: Consider a shorter alternative to avoid wordiness.
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/arbitrum-full-node.md
27-27: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (5)
how-to-guides/arbitrum-full-node.md (2)
37-42: DA Server Instructions Consistency
The instructions for running a Celestia DA server are clear and consistent with previous suggestions.
43-47: Validation Instructions Accuracy
The updated link for validator configuration (line 46) appears correct and integrates well with the rest of the document.how-to-guides/arbitrum-integration.md (3)
1-3: Updated Description Reflects New Integration Focus
The new description clearly highlights the integration with Arbitrum Orbit and the associated fallback mechanisms. The content aligns well with the updated context.
6-7: Title Update Verification
The new title, "# Arbitrum Orbit with Celestia DA", appropriately reflects the shift from Nitro to Orbit.
58-61: Next Steps Section Review
The call-to-action linking to the quickstart guide is clear. Ensure that the referenced guide is updated to mirror these changes.
thank you 
Summary by CodeRabbit