Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe recent updates across multiple files clarify the distinction between community and production RPC endpoints. The changes emphasize that community endpoints are not suitable for production use and recommend relying on paid service providers with service level agreements (SLAs). This enhances guidance for developers in selecting appropriate resources for their production deployments. Changes
Sequence Diagram(s)Due to the nature of the changes involving URL updates and clarifications rather than modifications to the control flow or new feature implementations, sequence diagrams are not applicable for this update. Assessment against linked issues
Poem
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? 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 as PR comments)
Additionally, you can add 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: 2
Outside diff range and nitpick comments (14)
nodes/full-storage-node.md (2)
Line range hint
123-123: Consider rephrasing for conciseness.- In order to run a full storage node using a custom key: + To run a full storage node using a custom key:This change reduces wordiness and improves readability.
Line range hint
159-159: Consider rephrasing for conciseness.- In order to gracefully stop the full storage node, use `Control + C` in the terminal window where the node is running. + To gracefully stop the full storage node, use `Control + C` in the terminal window where the node is running.This change reduces wordiness and improves readability.
nodes/light-node.md (1)
Line range hint
166-166: Consider rephrasing for conciseness.- In order to run a light node using a custom key: + To run a light node using a custom key:This change reduces wordiness and improves readability.
nodes/bridge-node.md (1)
Line range hint
167-167: Consider rephrasing for conciseness.- In order to run a bridge node using a custom key: + To run a bridge node using a custom key:This change reduces wordiness and improves readability.
developers/arbitrum-integration.md (7)
44-44: Ensure there is a blank line before this list for proper Markdown formatting.Adding a blank line before the list will adhere to Markdown best practices and improve the readability of the document.
Tools
Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
49-49: Ensure there is a blank line before this list for proper Markdown formatting.Adding a blank line before the list will adhere to Markdown best practices and improve the readability of the document.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
54-54: Consider rephrasing for conciseness.- In order to support fraud proofs, this integration has the necessary code... + To support fraud proofs, this integration has the necessary code...This change reduces wordiness and improves readability.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
55-55: Consider rephrasing for conciseness.- ...that then get "unpealed" in order to reveal the full data for a Blob. + ...that then get "unpealed" to reveal the full data for a Blob.This change reduces wordiness and improves readability.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
62-62: Consider adding commas for clarity.- ...the row roots are in fact correct. + ...the row roots are, in fact, correct.Adding commas around "in fact" improves the readability of the sentence by isolating the adverbial phrase.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
77-77: Consider adding a comma for clarity.- By default in [Arbitrum Nitro](https://github.com/OffchainLabs/nitro), the + By default, in [Arbitrum Nitro](https://github.com/OffchainLabs/nitro), theAdding a comma after "By default" improves the readability of the sentence.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Line range hint
95-95: Consider using "whether" instead of "if" for clarity.- ...to check if a data root has been posted on Blobstream or not... + ...to check whether a data root has been posted on Blobstream or not...Using "whether" instead of "if" clarifies that the statement is checking for two possibilities, improving the formal tone of the documentation.
Tools
LanguageTool
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...Markdownlint
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank linesnodes/mainnet.md (2)
Line range hint
60-60: Consider adding a comma after "64x64" for better readability.- The maximum square size is 64x64 which gives us 4096 shares. + The maximum square size is 64x64, which gives us 4096 shares.Tools
LanguageTool
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...tions of the types of nodes you can run in order to participate in Mainnet Beta: ### Produ...Markdownlint
108-108: Expected: 80; Actual: 97 (MD013, line-length)
Line length
Line range hint
90-90: Consider using concise language to enhance clarity and reduce wordiness.- Here is a list of options of the types of nodes you can run in order to participate in Mainnet Beta: + Here are the node types you can run to participate in Mainnet Beta:Also applies to: 94-94
Tools
LanguageTool
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...tions of the types of nodes you can run in order to participate in Mainnet Beta: ### Produ...Markdownlint
108-108: Expected: 80; Actual: 97 (MD013, line-length)
Line lengthnodes/celestia-app-vesting.md (1)
Line range hint
361-361: Consider using "different from" instead of "different than" to align with formal writing standards.- ...our vesting command that are different than the devnet version. Since we aren't usi... + ...our vesting command that are different from the devnet version. Since we aren't usi...
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (11)
- developers/arbitrum-integration.md (1 hunks)
- developers/node-tutorial.md (1 hunks)
- nodes/arabica-devnet.md (1 hunks)
- nodes/bridge-node.md (1 hunks)
- nodes/celestia-app-vesting.md (1 hunks)
- nodes/docker-images.md (1 hunks)
- nodes/full-storage-node.md (1 hunks)
- nodes/light-node.md (1 hunks)
- nodes/mainnet.md (5 hunks)
- nodes/mocha-testnet.md (5 hunks)
- nodes/validator-node.md (1 hunks)
Additional context used
LanguageTool
nodes/full-storage-node.md
[style] ~123-~123: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...he full storage node with a custom key In order to run a full storage node using a custom ...
[style] ~159-~159: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... node. ### Stop the full storage node In order to gracefully stop the full storage node, ...nodes/light-node.md
[style] ~166-~166: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...: run the light node with a custom key In order to run a light node using a custom key: 1...nodes/bridge-node.md
[style] ~167-~167: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... run the bridge node with a custom key In order to run a bridge node using a custom key: ...developers/arbitrum-integration.md
[style] ~41-~41: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ed Blob Pointer struct and consuming it in order to fetch the data from Celestia and additi...
[typographical] ~46-~46: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... in BlobstreamX and if the verification succeeds, otherwise it will discard the batch. Since it wil...
[style] ~54-~54: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...l! ### Preimage Oracle Implementation In order to support fraud proofs, this integration ...
[style] ~55-~55: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...elestia hashes that then get "unpealed" in order to reveal the full data for a Blob. You ca...
[typographical] ~62-~62: Consider isolating this adverbial phrase with commas. (IN_FACT_COMMA_2)
Context: ...ng unpealed as well as the row roots are in fact correct. ### Blobstream X implementati...
[uncategorized] ~77-~77: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ...# Ethereum fallback mechanism in Nitro By default in [Arbitrum Nitro](https://github.com/...
[style] ~95-~95: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER)
Context: ...er to callVerifyAttestationto check if a data root has been posted on Blobstre...nodes/docker-images.md
[style] ~26-~26: Consider removing “of” to be more concise (ALL_OF_THE)
Context: ... worry about installing and configuring all of the dependencies required to run the node. ...
[duplication] ~40-~40: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...-docker) and a basic understanding of Docker - [Docker Engine for Linux](https://docs.docker.c...
[style] ~156-~156: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... ### Initialize the node store and key In order to mount a volume to the container, you ne...
[style] ~157-~157: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ...to mount a volume to the container, you need to specify the path to the volume. When yo...
[grammar] ~259-~259: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”? (A_MY)
Context: ...poses Celestia expects to interact with the your node's keys in a read-only manner. This...
[typographical] ~262-~262: Consider adding a comma after this introductory phrase. (AS_A_NN_COMMA)
Context: ...upport these types of permissions. As a result the recommended path for Windows users ...nodes/validator-node.md
[uncategorized] ~47-~47: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... stake to any validator, including your own you will need thecelesvaloperaddres...
[style] ~50-~50: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...your local validator wallet in case you want to delegate more to it: ```bash celestia-...
[style] ~144-~144: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...he network. ## Run the validator node In order to start your validator node, run the foll...
[style] ~151-~151: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ..., you are now ready to run a validator! In order to create your validator onchain, follow t...
[uncategorized] ~158-~158: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...
[uncategorized] ~239-~239: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...nodes/arabica-devnet.md
[style] ~26-~26: ‘lag behind’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_LAG_BEHIND)
Context: ...hey chose to do so, it just will always lag behind Arabica devnet until Mocha undergoes Ha...
[style] ~49-~49: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
[style] ~73-~73: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... SLAs](#production-rpc-endpoints). ::: in order to participate in Arabica devnet: <!-- ma...
[style] ~137-~137: Consider removing “of” to be more concise (ALL_OF_THE)
Context: ...com ``` :::tip Bridge node runners Not all of the RPC endpoints do not guarantee the full...nodes/mocha-testnet.md
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...nsensus node](./full-consensus-node.md) in order to download full blocks from it. ::: - `p...nodes/mainnet.md
[uncategorized] ~60-~60: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ximum square size is 64x64, which gives us 4096 shares. - One share is reserved fo...
[style] ~90-~90: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...tions of the types of nodes you can run in order to participate in Mainnet Beta: ### Produ...nodes/celestia-app-vesting.md
[style] ~361-~361: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style. (DIFFERENT_THAN)
Context: ... our vesting command that are different than the devnet version. Since we aren't usi...developers/node-tutorial.md
[style] ~285-~285: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...
[style] ~309-~309: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...
[style] ~643-~643: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...
[style] ~671-~671: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...
[uncategorized] ~815-~815: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...
[grammar] ~847-~847: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...$NODE_STORE ``` #### Help To get help and view the CLI menu, use the following co...
[style] ~874-~874: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...
[uncategorized] ~941-~941: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...net faucet has funded your account with tokens and then try again.
Markdownlint
developers/arbitrum-integration.md
44-44: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
49-49: null (MD032, blanks-around-lists)
Lists should be surrounded by blank linesnodes/mainnet.md
108-108: Expected: 80; Actual: 97 (MD013, line-length)
Line length
Gitleaks
nodes/validator-node.md
59-61: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
Additional comments not posted (10)
nodes/full-storage-node.md (1)
84-85: Update the links to community RPC endpoints to reflect the changes in the documentation.This change aligns with the PR's objective to differentiate between community and production RPC endpoints, ensuring users do not mistakenly use community endpoints for production environments.
nodes/light-node.md (1)
100-100: Ensure the links to community RPC endpoints are updated to reflect the changes in the documentation.This change aligns with the PR's objective to differentiate between community and production RPC endpoints, ensuring users do not mistakenly use community endpoints for production environments.
nodes/bridge-node.md (1)
91-92: Update the links to community RPC endpoints to reflect the changes in the documentation.This change aligns with the PR's objective to differentiate between community and production RPC endpoints, ensuring users do not mistakenly use community endpoints for production environments.
nodes/docker-images.md (1)
82-84: Ensure the updated RPC endpoint references are correct and clearly marked as "community" to avoid confusion in usage.nodes/validator-node.md (1)
125-126: Verify that the updated links point correctly to the community RPC endpoints as intended, ensuring they align with the documentation's advice against using community endpoints for production.nodes/arabica-devnet.md (1)
53-66: The distinction between "Production" and "Community" RPC endpoints is clearly articulated. Ensure that the URLs provided are accurate and lead to the intended service providers.nodes/mocha-testnet.md (1)
Line range hint
57-109: The updates to the RPC, API, and gRPC endpoints are well-categorized into "Production" and "Community". This helps clarify which endpoints should be used for different purposes and environments.nodes/mainnet.md (2)
97-108: The addition of specific production RPC endpoints for Mainnet Beta is a crucial update for users who require reliable and professional services. This aligns well with the PR's objective to emphasize the importance of using service providers with SLAs for production environments.Tools
Markdownlint
108-108: Expected: 80; Actual: 97 (MD013, line-length)
Line length
115-121: The warning about not relying on free community endpoints for production deployments is clear and well-placed. This is essential for guiding users towards more reliable service options and aligns with the PR's objectives.developers/node-tutorial.md (1)
96-97: The updated links to the Mocha and Arabica testnet pages now correctly point to the community-specific RPC endpoints, aligning with the PR's objective to discourage the use of community endpoints for production purposes.
jcstein
added
documentation
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- nodes/arabica-devnet.md (1 hunks)
- nodes/mainnet.md (5 hunks)
- nodes/mocha-testnet.md (5 hunks)
Additional context used
LanguageTool
nodes/arabica-devnet.md
[style] ~26-~26: ‘lag behind’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_LAG_BEHIND)
Context: ...hey chose to do so, it just will always lag behind Arabica devnet until Mocha undergoes Ha...
[style] ~49-~49: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
[style] ~73-~73: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... SLAs](#production-rpc-endpoints). ::: in order to participate in Arabica devnet: <!-- ma...
[style] ~137-~137: Consider removing “of” to be more concise (ALL_OF_THE)
Context: ...com ``` :::tip Bridge node runners Not all of the RPC endpoints do not guarantee the full...nodes/mocha-testnet.md
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...nsensus node](./full-consensus-node.md) in order to download full blocks from it. ::: - `p...nodes/mainnet.md
[uncategorized] ~60-~60: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ximum square size is 64x64, which gives us 4096 shares. - One share is reserved fo...
[style] ~90-~90: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...
[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...tions of the types of nodes you can run in order to participate in Mainnet Beta: ### Produ...
[uncategorized] ~276-~276: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...istory of the chain without pruning any data so all data available data is retrievab...
Additional comments not posted (6)
nodes/arabica-devnet.md (2)
53-66: Addition of "Production RPC endpoints" section enhances clarity for users on reliable service options.
66-72: The warning about not relying on community endpoints for production is clear and aligns with the PR objectives.nodes/mocha-testnet.md (2)
57-69: The "Production RPC endpoints" section clearly lists reliable service providers, which is crucial for production environments.
70-74: Warning against using community endpoints for production deployments is well-placed and necessary for guiding users appropriately.nodes/mainnet.md (2)
97-109: The "Production RPC endpoints" section is well-structured, providing essential information for users requiring stable and reliable services.
115-121: The introduction of "Community consensus RPC endpoints" with a warning about their reliability for production use is a good addition, ensuring users are well-informed.
|
Hi :) is there an ETA for this pr to get merged? |
|
Can we also add something like "or run your own endpoint" (as an alternative to using third party providers)? |
|
yes @musalbas adding now |
4 participants
Overview
Resolves #1555
Summary by CodeRabbit