docs: add quicknode, xtoken guide, and update for v0.21.5+ core.port #1890
Conversation
|
Warning Rate limit exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 18 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request introduces several updates across various documentation files, primarily focusing on the addition of the Changes
Assessment against linked issues
Possibly related issues
Possibly related PRs
Suggested labels
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
jcstein
changed the title
![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/multiaccounts.md (1)
15-16: Use a variable for the port numberInstead of hardcoding the port number to 9090, consider using a variable placeholder
<port>to allow users to specify their desired port number.- --core.port 9090 --p2p.network=arabica --keyring.keyname testKey + --core.port <port> --p2p.network=arabica --keyring.keyname testKeyhow-to-guides/systemd.md (1)
182-182: Add port configuration documentationConsider adding a note about the port configuration requirement and how to determine the appropriate port value for the systemd service.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
how-to-guides/arabica-devnet.md(2 hunks)how-to-guides/arbitrum-deploy.md(3 hunks)how-to-guides/bridge-node.md(4 hunks)how-to-guides/celestia-node-metrics.md(5 hunks)how-to-guides/celestia-node-troubleshooting.md(2 hunks)how-to-guides/celestia-node-trusted-hash.md(1 hunks)how-to-guides/docker-images.md(2 hunks)how-to-guides/feegrant-for-blobs.md(3 hunks)how-to-guides/full-storage-node.md(2 hunks)how-to-guides/light-node.md(3 hunks)how-to-guides/mainnet.md(2 hunks)how-to-guides/multiaccounts.md(1 hunks)how-to-guides/quick-start.md(1 hunks)how-to-guides/systemd.md(1 hunks)how-to-guides/validator-node.md(4 hunks)tutorials/celestia-node-key.md(2 hunks)tutorials/node-tutorial.md(4 hunks)tutorials/prompt-scavenger.md(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- tutorials/prompt-scavenger.md
- how-to-guides/arbitrum-deploy.md
🚧 Files skipped from review as they are similar to previous changes (1)
- how-to-guides/mainnet.md
🔇 Additional comments (21)
how-to-guides/celestia-node-trusted-hash.md (1)
31-32: LGTM: Command updated with core port parameterThe addition of
--core.port <port>parameter aligns with the standardized command structure across the documentation.how-to-guides/celestia-node-metrics.md (1)
20-24: LGTM: Consistent updates across all command examplesThe addition of
--core.port <port>parameter is consistently applied across all network examples and command variations.Also applies to: 41-44, 51-54, 61-64, 84-87, 89-92
how-to-guides/full-storage-node.md (2)
69-71: LGTM: Important warning about P2P connectivityThe added warning about port 2121 accessibility is crucial for proper node operation in the DHT network.
78-78: LGTM: Consistent command structureThe addition of
--core.port <port>parameter is consistently applied across all command examples and network configurations.Also applies to: 132-134, 137-140, 143-146
how-to-guides/feegrant-for-blobs.md (2)
57-57: LGTM! Command updated to use separate port parameter.The commands have been updated to use
--core.port $RPC_PORT, which aligns with the new standard for specifying core ports across the documentation.Also applies to: 74-74
166-167: LGTM! Improved RPC configuration by separating URL and port.The RPC configuration has been split into separate URL and port variables, making it clearer and more maintainable.
how-to-guides/light-node.md (1)
93-94: LGTM! Commands updated with explicit port specification.The commands have been consistently updated to include
--core.port 9090across all network configurations, improving clarity and standardization.Also applies to: 98-99, 103-104, 133-135, 139-142
how-to-guides/bridge-node.md (2)
70-70: LGTM! Added required port parameter and version note.The command has been updated to include the required
--core.port <port>parameter, and a helpful note has been added about the requirement after v0.21.5.Also applies to: 73-74
98-99: LGTM! Commands consistently updated with port parameter.All bridge node commands have been consistently updated to include the
--core.portparameter, ensuring standardization across different network configurations.Also applies to: 102-103, 106-107, 117-117, 123-123, 129-130, 171-172, 176-177, 181-182
tutorials/celestia-node-key.md (1)
187-187: LGTM! Docker commands updated with port parameter.The Docker commands have been updated to include
--core.port 9090, aligning with the new standard for port specification.Also applies to: 252-252
how-to-guides/docker-images.md (2)
91-95: LGTM! Added RPC port configuration.Added clear instructions for setting the RPC port as a separate environment variable.
104-104: LGTM! Docker commands updated with port parameter.All Docker commands have been consistently updated to use
--core.port $RPC_PORT, standardizing the port configuration across different network types.Also applies to: 110-110, 116-116, 220-220, 227-227, 234-234
how-to-guides/arabica-devnet.md (2)
120-120: LGTM! Command updated to use standardized port parameter.The command has been correctly updated to use
--core.portinstead of--core.grpc.port, which aligns with the standardized approach for specifying ports.
133-138: LGTM! Port specification added to light node command.The command for starting a light node has been correctly updated to include the
--core.port 9090parameter, making the port specification explicit.how-to-guides/celestia-node-troubleshooting.md (2)
21-23: LGTM! Port parameter added to node command.The command has been correctly updated to include the
--core.portparameter, maintaining consistency with other documentation.
123-125: LGTM! Port parameter added to node store example.The command example has been correctly updated to include the
--core.portparameter when using a custom node store location.how-to-guides/quick-start.md (2)
114-115: LGTM! Clear explanation of port requirement added.The documentation now clearly states that
--core.portmust be specified after v0.21.5 and provides the default port value.
128-129: LGTM! Port specification added to all network examples.The command examples for all networks (Mainnet Beta, Mocha, and Arabica) have been correctly updated to include the
--core.port 9090parameter.Also applies to: 132-133, 136-138
how-to-guides/validator-node.md (2)
109-110: LGTM! Port parameter added to bridge node initialization.The bridge node initialization command has been correctly updated to include the
--core.portparameter.
178-182: LGTM! Network table formatting improved.The network table has been reformatted for better readability while maintaining the same content.
tutorials/node-tutorial.md (1)
872-874: LGTM! Core port requirement clarified.The documentation has been updated to clearly state that both
--core.ipand--core.portflags are required for consensus endpoint access.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
how-to-guides/arbitrum-deploy.md (1)
198-198: Fix line length for better readability.The line exceeds the recommended 80-character limit.
Apply this diff to fix the formatting:
-celestia light start --core.ip <URI> --core.port <port> \ +celestia light start --core.ip <URI> \ + --core.port <port> \🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
198-198: Line length
Expected: 80; Actual: 131(MD013, line-length)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
how-to-guides/arbitrum-deploy.md(3 hunks)how-to-guides/bridge-node.md(4 hunks)how-to-guides/celestia-node-troubleshooting.md(2 hunks)how-to-guides/light-node.md(5 hunks)how-to-guides/mainnet.md(2 hunks)how-to-guides/submit-data.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- how-to-guides/mainnet.md
- how-to-guides/celestia-node-troubleshooting.md
- how-to-guides/bridge-node.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/arbitrum-deploy.md
198-198: Line length
Expected: 80; Actual: 131
(MD013, line-length)
🪛 Gitleaks (8.21.2)
how-to-guides/light-node.md
244-244: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🔇 Additional comments (6)
how-to-guides/light-node.md (4)
54-57: Great addition of the trusted hash initialization tip!This tip provides users with a valuable alternative to speed up node initialization by skipping header sampling.
98-99: Well-structured command updates with port specification!The addition of
--core.port 9090parameter is consistent across all network options and properly formatted.Also applies to: 103-104, 108-109
133-134: Consistent port parameter addition in custom key commands!The
--core.portparameter has been properly added to all custom key commands while maintaining consistent formatting.Also applies to: 139-140, 145-146
225-243: Excellent addition of authentication documentation!The new section provides clear instructions for using authenticated core endpoints, with well-structured examples and proper formatting.
Also applies to: 245-246
how-to-guides/submit-data.md (1)
197-202: Clean reference updates!The documentation references have been properly updated to include both Golang and Rust client tutorials.
how-to-guides/arbitrum-deploy.md (1)
232-233: Consistent port parameter addition!The
--core.port 9090parameter has been properly added to the light node start command.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
public/Blobspace.pngis excluded by!**/*.png
📒 Files selected for processing (2)
how-to-guides/light-node.md(5 hunks)how-to-guides/quick-start.md(5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- how-to-guides/quick-start.md
🔇 Additional comments (2)
how-to-guides/light-node.md (2)
54-57: LGTM! Great addition of the trusted hash tip.The tip about initializing from a trusted hash is well-placed and provides a useful optimization option for users.
98-99: LGTM! Consistent addition of the core.port parameter.The addition of
--core.port 9090parameter across all start commands is consistent with the explanation in line 82-83 about connecting to a validator node's gRPC endpoint.Also applies to: 103-104, 108-109, 134-134, 139-140, 145-146, 215-216, 221-222, 229-230
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
how-to-guides/light-node.md (1)
180-201:⚠️ Potential issueEnhance security of the x-token authentication example.
The section about authentication with x-token is well-documented, but the example JSON structure could be improved for security.
Apply this diff to use a more secure placeholder and add a note about file permissions:
- "x-token": "<YOUR-SECRET-X-TOKEN" + "x-token": "<YOUR-SECRET-X-TOKEN>"Also, add a note about securing the x-token file:
Where `/path-to-directory` is the path to the directory containing the -`x-token.json` file with the format of: +`x-token.json` file. Ensure the file has restricted permissions (e.g., `chmod 600`) and contains:
🧹 Nitpick comments (3)
tutorials/rust-client-tutorial.md (1)
11-12: Link updates are correct, with a minor style suggestion.The conversion to absolute paths improves documentation consistency. Consider rephrasing the auth token instructions to avoid repetitive sentence beginnings:
-To use the following methods, you will need the node URL and your auth token. To get your auth token, see this [guide](/tutorials/node-tutorial.md#auth-token). To run your node without an auth token, you can use the `--rpc.skip-auth` flag when starting your node. +To use the following methods, you will need the node URL and your auth token. You can obtain your auth token by following this [guide](/tutorials/node-tutorial.md#auth-token). Alternatively, you can run your node without an auth token by using the `--rpc.skip-auth` flag when starting your node.Also applies to: 23-23
how-to-guides/blobstream.md (1)
1196-1197: Fix inconsistent line endings in code blocks.The code blocks contain inconsistent line endings (some lines end with
~). This appears to be a formatting issue.- sp1blobstreamwrapper "github.com/succinctlabs/sp1-blobstream/bindings"~ + sp1blobstreamwrapper "github.com/succinctlabs/sp1-blobstream/bindings"Also applies to: 1255-1256
how-to-guides/blobstream-proof-queries.md (1)
434-435: Consider rewording for clarity.The sentence about proving rollup transactions could be clearer. Consider splitting it into two sentences for better readability.
-To prove that a rollup transaction, the PFB transaction and not the blob containing the -Rollup blocks data, is part of the data root, we will need to +To prove that a rollup transaction is part of the data root (specifically the PFB transaction, +not the blob containing the Rollup blocks data), we will need to🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
434-434: Line length
Expected: 80; Actual: 87(MD013, line-length)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (53)
community/foundation-delegation-program.md(3 hunks)community/modular-meetup-guide.md(1 hunks)community/modular-meetup-intro.md(2 hunks)how-to-guides/arabica-devnet.md(7 hunks)how-to-guides/arbitrum-deploy.md(7 hunks)how-to-guides/arbitrum-full-node.md(1 hunks)how-to-guides/arbitrum-integration.md(4 hunks)how-to-guides/blobstream-contracts.md(4 hunks)how-to-guides/blobstream-offchain.md(1 hunks)how-to-guides/blobstream-proof-queries.md(12 hunks)how-to-guides/blobstream-x-requesting-data-commitment-ranges.md(3 hunks)how-to-guides/blobstream.md(4 hunks)how-to-guides/blobstreamx.md(1 hunks)how-to-guides/bridge-node.md(7 hunks)how-to-guides/bubs-testnet.md(2 hunks)how-to-guides/celestia-app-vesting.md(4 hunks)how-to-guides/celestia-app-wallet.md(2 hunks)how-to-guides/celestia-app.md(3 hunks)how-to-guides/celestia-node-custom-networks.md(1 hunks)how-to-guides/celestia-node-metrics.md(6 hunks)how-to-guides/celestia-node.md(2 hunks)how-to-guides/consensus-node.md(2 hunks)how-to-guides/decide-node.md(1 hunks)how-to-guides/docker-images.md(6 hunks)how-to-guides/ethereum-fallback.md(1 hunks)how-to-guides/feegrant-for-blobs.md(5 hunks)how-to-guides/full-storage-node.md(5 hunks)how-to-guides/ibc-relayer.md(1 hunks)how-to-guides/instantiate-testnet.md(2 hunks)how-to-guides/intro-to-op-stack.md(1 hunks)how-to-guides/light-node.md(8 hunks)how-to-guides/mainnet.md(6 hunks)how-to-guides/mocha-testnet.md(4 hunks)how-to-guides/network-upgrade-process.md(1 hunks)how-to-guides/nodes-overview.md(1 hunks)how-to-guides/optimism.md(2 hunks)how-to-guides/participate.md(4 hunks)how-to-guides/quick-start.md(8 hunks)how-to-guides/rollup-stacks.md(1 hunks)how-to-guides/submit-data.md(2 hunks)how-to-guides/transaction-resubmission.md(1 hunks)how-to-guides/validator-node.md(9 hunks)learn/how-celestia-works/transaction-lifecycle.md(1 hunks)learn/paying-for-blobspace.md(2 hunks)learn/staking-governance-supply.md(3 hunks)learn/staking.md(2 hunks)learn/tia.md(1 hunks)tutorials/celestia-node-key.md(5 hunks)tutorials/golang-client-tutorial.md(2 hunks)tutorials/integrate-celestia.md(1 hunks)tutorials/node-api.md(2 hunks)tutorials/prompt-scavenger.md(3 hunks)tutorials/rust-client-tutorial.md(2 hunks)
✅ Files skipped from review due to trivial changes (30)
- how-to-guides/network-upgrade-process.md
- learn/staking-governance-supply.md
- how-to-guides/celestia-node-custom-networks.md
- how-to-guides/celestia-app.md
- how-to-guides/celestia-app-wallet.md
- learn/staking.md
- how-to-guides/optimism.md
- how-to-guides/ibc-relayer.md
- how-to-guides/bubs-testnet.md
- how-to-guides/ethereum-fallback.md
- how-to-guides/transaction-resubmission.md
- learn/how-celestia-works/transaction-lifecycle.md
- tutorials/integrate-celestia.md
- community/foundation-delegation-program.md
- how-to-guides/rollup-stacks.md
- learn/paying-for-blobspace.md
- how-to-guides/intro-to-op-stack.md
- how-to-guides/blobstream-offchain.md
- how-to-guides/blobstream-x-requesting-data-commitment-ranges.md
- community/modular-meetup-guide.md
- how-to-guides/instantiate-testnet.md
- how-to-guides/blobstream-contracts.md
- community/modular-meetup-intro.md
- how-to-guides/consensus-node.md
- learn/tia.md
- how-to-guides/arbitrum-full-node.md
- tutorials/node-api.md
- how-to-guides/decide-node.md
- how-to-guides/celestia-app-vesting.md
- how-to-guides/nodes-overview.md
🚧 Files skipped from review as they are similar to previous changes (10)
- how-to-guides/docker-images.md
- how-to-guides/feegrant-for-blobs.md
- how-to-guides/submit-data.md
- tutorials/prompt-scavenger.md
- tutorials/celestia-node-key.md
- how-to-guides/arabica-devnet.md
- how-to-guides/quick-start.md
- how-to-guides/validator-node.md
- how-to-guides/celestia-node-metrics.md
- how-to-guides/mainnet.md
🧰 Additional context used
🪛 LanguageTool
how-to-guides/celestia-node.md
[typographical] ~148-~148: Usually, there’s no comma before “if”.
Context: ...des/nodes-overview.md) of our node types, if you haven't yet. Now that you've insta...
(IF_NO_COMMA)
how-to-guides/mocha-testnet.md
[style] ~95-~95: Consider a shorter alternative to avoid wordiness.
Context: ...node](/how-to-guides/consensus-node.md) in order to download full blocks from it. ::: - `p...
(IN_ORDER_TO_PREMIUM)
how-to-guides/blobstreamx.md
[style] ~75-~75: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...to deploy the contract. Then, you will need to run a relayer, which will generate the ...
(REP_NEED_TO_VB)
tutorials/golang-client-tutorial.md
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... need the node URL and your auth token. To get your auth token, see this [guide](/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tutorials/node-tutorial.md#auth-token). To run your node without an auth token, yo...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
tutorials/rust-client-tutorial.md
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... need the node URL and your auth token. To get your auth token, see this [guide](/...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~23-~23: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tutorials/node-tutorial.md#auth-token). To run your node without an auth token, yo...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/arbitrum-deploy.md
198-198: Line length
Expected: 80; Actual: 131
(MD013, line-length)
how-to-guides/blobstream-proof-queries.md
434-434: Line length
Expected: 80; Actual: 87
(MD013, line-length)
how-to-guides/blobstream.md
137-137: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (12)
how-to-guides/participate.md (1)
16-16: LGTM! Path updates improve link reliability.The changes from relative to absolute paths ensure links work correctly regardless of the current directory context.
Also applies to: 33-33, 45-45, 63-64
how-to-guides/celestia-node.md (1)
19-19: LGTM! Path updates improve documentation navigation.The changes from relative to absolute paths enhance the documentation's navigability.
Also applies to: 147-147, 154-154, 160-160
how-to-guides/full-storage-node.md (1)
78-78: LGTM! Command updated to include required core.port parameter.The command now correctly reflects the mandatory --core.port parameter requirement.
how-to-guides/bridge-node.md (1)
70-70: LGTM! Clear documentation of core.port requirement.The changes effectively communicate the mandatory --core.port parameter requirement and provide helpful version-specific context.
Also applies to: 73-74
how-to-guides/light-node.md (1)
54-57: LGTM! Helpful tip about trusted hash initialization.The new tip provides users with a useful alternative for faster node initialization.
how-to-guides/arbitrum-integration.md (1)
50-50: Link updates look good!The conversion from relative to absolute paths improves link reliability and maintainability across the documentation.
Also applies to: 76-76, 92-92, 107-107
how-to-guides/mocha-testnet.md (1)
13-13: Link updates are consistent and correct!The standardization to absolute paths across node type references and network upgrade documentation improves navigation consistency.
Also applies to: 27-34, 95-95, 257-258
how-to-guides/arbitrum-deploy.md (1)
17-17: Command and link updates are properly implemented!The addition of the
--core.port 9090parameter and standardization of absolute paths improve clarity and consistency.Also applies to: 33-33, 37-37, 232-233
how-to-guides/blobstreamx.md (1)
75-75: Link update is correct!The conversion to absolute path for the local proving documentation maintains consistency with the documentation standards.
🧰 Tools
🪛 LanguageTool
[style] ~75-~75: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...to deploy the contract. Then, you will need to run a relayer, which will generate the ...(REP_NEED_TO_VB)
tutorials/golang-client-tutorial.md (1)
5-6: LGTM! Good improvement to link reliability.Converting relative paths to absolute paths makes the documentation more robust and maintainable. This change ensures links work correctly regardless of where the documentation is hosted or how files are organized.
Also applies to: 17-17
how-to-guides/blobstream.md (1)
27-29: LGTM! Clear and informative description of SP1 Blobstream.The addition of SP1 Blobstream information is well-documented and provides clear context about the implementation's benefits.
how-to-guides/blobstream-proof-queries.md (1)
1558-1560: Update example project reference.The reference to the BlobstreamX example project should be updated since the documentation now focuses on SP1 Blobstream.
Please verify if there's an equivalent SP1 Blobstream example project that should be referenced instead.
Overview
/section/page.mdSummary by CodeRabbit
Summary by CodeRabbit
--core.port <port>parameter for starting nodes, enhancing clarity and ensuring proper configuration.