Conversation
WalkthroughThis pull request refines two documentation guides for Celestia. In the Mainnet guide, the introduction is streamlined, and sections on transaction and block size limits are added, along with a restructured community consensus endpoints table, expanded DA node connection instructions, and a new community endpoint status dashboard. In the Mocha Testnet guide, the QuickNode RPC endpoint entry is updated with enhanced detail and a documentation link. Changes
Sequence Diagram(s)(No sequence diagrams provided due to documentation-focused changes.) Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🪧 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 (2)
how-to-guides/mainnet.md (2)
143-157: Clear DA Node Connection InstructionsThe added section on connecting data availability (DA) nodes to consensus nodes is clear and practical. The inclusion of an example command demonstrates how to use the
--core.ipparameter effectively. For consistency, consider ensuring that command-line snippets are uniformly formatted (e.g., enclosed in backticks) throughout the document.
86-90: Optional Language ImprovementA brief suggestion: The sentence starting with "Each node's guide will link to the relevant network..." could be streamlined to reduce wordiness. Consider rephrasing this for improved clarity (e.g., "Each node guide links directly to its corresponding network instructions.").
🧰 Tools
🪛 LanguageTool
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
how-to-guides/mainnet.md(5 hunks)how-to-guides/mocha-testnet.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/mainnet.md
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (7)
how-to-guides/mocha-testnet.md (1)
64-70: Enhanced QuickNode RPC Entry with Documentation LinkThe updated QuickNode entry now includes a documentation link. This improvement provides additional context for users and aligns with similar enhancements in other guides. Please verify that the table’s structure and formatting remain consistent with the other entries in this section.
how-to-guides/mainnet.md (6)
12-15: Streamlined IntroductionThe revised introduction clearly sets the stage for the Mainnet Beta guide. The concise welcome message helps focus the reader on what to expect from the guide.
39-48: Addition of Network Parameters DetailsThe new "Transaction size limit" and "Block size limit" sections add valuable technical context regarding network constraints. The inclusion of the exact byte-limit calculation (7,896,602 bytes) is especially helpful for advanced users. Please ensure these numerical details remain up-to-date as network governance parameters evolve.
100-105: Updated Production RPC EndpointsThe production RPC endpoints table now features an updated QuickNode entry with the documentation link. This update is consistent with the improvements seen in the Mocha guide and enhances clarity for users choosing a provider.
111-140: Restructured Community Consensus Endpoints TableThe reformatted table for community consensus endpoints is well organized and comprehensive, displaying RPC, API, gRPC, and WebSocket endpoints in a clear manner. This structured layout improves readability and helps users quickly locate the information they need.
172-184: Addition of Archival DA RPC EndpointsIntroducing a dedicated section and table for archival DA RPC endpoints is a strong improvement. This addition provides essential guidance for users who need access to full historical chain data. Verify that the formatting (e.g., use of dashes for empty fields) is consistent with the production endpoints table.
198-208: Community Endpoint Status Dashboard SectionThe new section offering a link to the community endpoint status dashboard is a valuable resource. The detailed bullet list clearly communicates the metrics available (e.g., uptime, response times) which helps users make informed decisions based on endpoint performance.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
how-to-guides/mainnet.md (3)
64-72: Comprehensive Overview of Maximum Blob Size Factors
This expanded section thoroughly explains the factors that influence the maximum blob size. A minor punctuation tweak (e.g., inserting a comma for clarity) would improve readability.
88-89: Consider Breaking Up Long Lines
The sentence linking to the "determine which node you would like to run" guide exceeds the typical line length. Splitting it into two or rephrasing it may enhance readability and maintain consistency with markdown style guidelines.🧰 Tools
🪛 LanguageTool
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
88-88: Line length
Expected: 80; Actual: 107(MD013, line-length)
174-174: Punctuation Improvement for Clarity
In the sentence describing archival DA nodes, consider inserting a comma after "pruning any data" (around line 174) to improve readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/mainnet.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/mainnet.md
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~175-~175: A comma might be missing here.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/mainnet.md
88-88: Line length
Expected: 80; Actual: 107
(MD013, line-length)
🔇 Additional comments (11)
how-to-guides/mainnet.md (11)
12-15: Revised Introduction is Clear and Concise
The updated introduction effectively welcomes users and sets the stage for the Mainnet Beta guide. Consider briefly highlighting key improvements or changes that readers might expect in the guide.
39-41: Clear Explanation of Transaction Size Limit
The new "Transaction size limit" section clearly communicates that individual transactions are capped at 2 MiB (2,097,152 bytes) as specified in [CIP-28]. This direct reference reassures users about the constraints.
43-47: Detailed Block Size Limit Section
The "Block size limit" section provides valuable technical detail—including the precise calculation that results in 7,896,602 bytes. Consider adding a brief sentence explaining what “effective maximum square size” entails for readers who may be less familiar with the term.
[approved, refactor_suggestion_good_to_have]
80-83: Well-Referenced Specifications
The reference to the celestia-app specifications allows users to easily locate full network parameter details.
102-102: Enhanced Production RPC Endpoint Information
The updated QuickNode entry now includes a docs link, which improves the clarity and utility of the providers’ table for production RPC endpoints.
111-137: Restructured Community Consensus Endpoints Table
The new table format for community consensus endpoints presents the data in a much more digestible format. Please verify that all listed endpoints (RPC, API, gRPC, and WebSocket) are up-to-date with the latest documentation.
[approved, verify]
143-152: Expanded DA Node Connection Instructions
The "Connecting DA nodes to consensus nodes" section now offers clear, actionable guidance along with an example command snippet. Be sure the CLI flags (e.g.,--core.ipand--core.port) are current with the latest tool version.
[approved, offer_assistance]
155-161: Clear Example for P-OPS Connection
The provided command snippet for connecting to the P-OPS endpoint is straightforward and helpful. Confirm that the endpoint (rpc.celestia.pops.one) and the port (9090) are accurate as per the latest specifications.
162-169: Helpful Tip for Bridge Node Operators
The added tip for bridge node operators is a valuable inclusion, offering important context about the need for archive endpoints when full historical data is required. A short note clarifying the public availability (or limitations) of such endpoints could further enhance this section.
[approved, refactor_suggestion_good_to_have]
171-182: Informative Archival DA RPC Endpoints Table
The new section with the archival DA RPC endpoints table is informative and well-organized, clearly specifying the endpoints along with their respective ports. Ensure these details are kept up-to-date as specifications evolve.🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: A comma might be missing here.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
197-207: Useful Community Endpoint Status Dashboard Section
The addition of the "Community endpoint status dashboard" section is a great enhancement. It provides users with a centralized resource for endpoint health and performance metrics.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
how-to-guides/mainnet.md (2)
88-89: Node Participation Guidance & Line Length:
The sentence advising users to first [determine which node you would like to run] is clearer now; however, the line’s length exceeds common markdown style guidelines. Consider rephrasing or splitting the sentence for improved readability.🧰 Tools
🪛 LanguageTool
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
88-88: Line length
Expected: 80; Actual: 107(MD013, line-length)
171-177: Archival DA RPC Endpoints Description:
This new section clearly contrasts light versus archival nodes. One suggestion: in the sentence describing archival nodes, a comma before "so" can enhance readability.Suggested Diff:
- data availability (DA) nodes store the entire history of the chain without pruning any data so all data available data is retrievable. + data availability (DA) nodes store the entire history of the chain without pruning any data, so all available data is retrievable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: A comma might be missing here.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/mainnet.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/mainnet.md
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~175-~175: A comma might be missing here.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/mainnet.md
88-88: Line length
Expected: 80; Actual: 107
(MD013, line-length)
🔇 Additional comments (12)
how-to-guides/mainnet.md (12)
12-15: Improved Introduction Message:
The revised introduction now succinctly welcomes users to the Mainnet Beta guide, setting a clear and focused tone.
39-41: Addition of Transaction Size Limit Section:
Introducing the "Transaction size limit" section helps clarify that individual transactions are capped at 2 MiB (2,097,152 bytes) per [CIP-28]. This update sets clear expectations for users and developers regarding transaction constraints.
43-47: Block Size Limit Explanation:
The new "Block size limit" section clearly explains that while each transaction is limited to 2 MiB, blocks can contain multiple transactions—with the effective maximum block size (≈7,896,602 bytes) derived from the current governance parameter. Consider verifying that the terminology and figures align with the latest consensus constants.
64-65: Clarification on Total Blob Size:
The added clarification that there is no precise upper bound on the maximum total blob size (with it depending on several factors) is informative.
80-83: Enhanced Reference for Network Parameters:
The updated reference text and links now direct users to detailed network parameters, improving resource accessibility.
119-127: Restructured Community Consensus Endpoints Table:
Reformatting the community consensus endpoints into a table significantly improves readability and makes it easier for users to compare multiple endpoints.
149-151: DA Node Connection Command Example:
The provided bash snippetcelestia <da_type> start --core.ip <consensus_node_url> --core.port <port>serves as a clear and concise example for starting a DA node.
157-160: Practical Example for P-OPS Endpoint Connection:
The example command demonstrating how to connect to the P-OPS endpoint clarifies practical usage. It’s a helpful guide for users setting up their nodes.
164-167: Bridge Node Requirements Clarification:
The note that bridge nodes require access to the full historical block data—and hence should use an archive endpoint—provides important context for users.
178-183: Archival DA RPC Endpoints Table:
The table format for archival endpoints is clean and provides users with essential connection details.
189-190: Explorers List Update:
The update to include the Mammoblocks explorer enhances the list of available resources, offering users additional options.
197-204: Community Endpoint Status Dashboard Section:
The new section detailing the community endpoint status dashboard—complete with a description of the provided metrics (online status, response times, archival status, and last seen heights)—is a valuable addition that assists users in selecting the right endpoints.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
how-to-guides/mainnet.md (4)
43-47: Informative Block Size Limit Section.
This section effectively details the relationship between transaction limits and overall block capacity, including the precise calculation (7,896,602 bytes). Consider clarifying whether this value is a hard limit or may adjust with governance parameters.
88-89: Consider Simplifying Wordiness.
The phrasing in this segment is somewhat verbose. Consider rewording it to be more concise—for example: "First, choose which node to run; each node guide will then show you how to connect."🧰 Tools
🪛 LanguageTool
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
88-88: Line length
Expected: 80; Actual: 107(MD013, line-length)
173-176: Grammar Improvement: Consider Adding a Comma.
In the sentence discussing how archival DA nodes "store the entire history of the chain without pruning any data so all data available data is retrievable," adding a comma after "pruning any data" (e.g., "…without pruning any data, so all available data is retrievable") would improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: Possible missing comma found.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...(AI_HYDRA_LEO_MISSING_COMMA)
189-189: Updated Explorer List.
The addition of the mammoblocks.io explorer enhances the list. Please ensure the formatting and style are consistent with the other entries.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/mainnet.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/mainnet.md
[style] ~89-~89: Consider a shorter alternative to avoid wordiness.
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~175-~175: Possible missing comma found.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/mainnet.md
88-88: Line length
Expected: 80; Actual: 107
(MD013, line-length)
🔇 Additional comments (13)
how-to-guides/mainnet.md (13)
12-15: Clear and Concise Introduction Update.
The newly added opening sentences succinctly introduce the Mainnet Beta guide and emphasize its role in deploying rollups and unstoppable applications.
39-41: Well-Defined Transaction Size Limit Section.
The addition of the "Transaction size limit" section clearly explains the 2 MiB cap with a direct reference to [CIP-28], which helps set accurate expectations for users and developers.
64-65: Smooth Transition to Variability Explanation.
The transitional sentence introduces the factors that influence the total blob size in a clear and approachable manner.
80-83: Helpful Reference to Full Network Parameters.
Linking to the [celestia-app specifications] gives users easy access to detailed network parameters. This is a useful addition for those needing further technical insight.
102-102: Clear Production Endpoint Table Entry.
The QuickNode entry is well presented with both the URL and documentation link.
119-129: Enhanced Community Consensus Endpoints Table.
The restructured table is much easier to scan and compare. Please verify that all endpoint details (including placeholders like “-”) are accurate and consistently formatted.
143-147: Clear Instructions for Connecting DA Nodes.
The "Connecting DA nodes to consensus nodes" section provides straightforward guidance on using the--core.ipparameter. This update is clear and directly addresses the connection process.
149-151: Helpful Code Example for Starting DA Nodes.
The code snippet clearly demonstrates the command syntax, making it an effective guide for users setting up their DA nodes.
155-155: Concise Guidance on Endpoint Selection.
The instruction to use any RPC endpoint from the community table—with a reminder about the default gRPC port—provides clear and actionable guidance.
157-160: Good Illustrative Example for P-OPS Endpoint Connection.
The provided example command for connecting to the P-OPS endpoint is straightforward and useful for users.
162-170: Informative Bridge Node Requirements Section.
This new section effectively explains the necessity for accessing the full historical block data and provides clear alternatives (using an archive endpoint or running a no-pruning consensus node).
171-182: Comprehensive Archival DA RPC Endpoints Section.
The "Archival DA RPC endpoints" section and accompanying table comprehensively list options for nodes that require full chain history, enhancing clarity around archival versus light node functionality.🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: Possible missing comma found.
Context: ...istory of the chain without pruning any data so all data available data is retrievab...(AI_HYDRA_LEO_MISSING_COMMA)
197-207: Valuable Addition: Community Endpoint Status Dashboard.
This new section introduces a practical resource for checking the real-time status and performance of community endpoints. It significantly aids users in making informed decisions about endpoint selection.
2 participants
Overview
Replaces #1922 and improves mainnet page
PREVIEW
Summary by CodeRabbit
Summary by CodeRabbit