Conversation
this is live in v0.13.0 i think, cc @vgonkivs for review
WalkthroughThis update simplifies the data structure within a Node.js tutorial by altering the JSON payload. Rather than employing a nested object, the payload now utilizes a straightforward single value, streamlining the process for developers and enhancing the tutorial's clarity and efficiency. Changes
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 Configration File (
|
|
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- developers/node-tutorial.md (1 hunks)
Additional comments: 11
developers/node-tutorial.md (11)
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [7-7]
The document mentions "Celestia-node RPC CLI tutorial" which might be a typo. Consider using "Celestia Node RPC CLI Tutorial" for consistency and to follow proper naming conventions.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [55-55]
The hardware requirements section mentions "56 Kbps for Download/56 Kbps for Upload". This seems unusually low for modern standards, especially considering the rest of the hardware requirements. Please verify if this bandwidth requirement is accurate or if it needs updating.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [107-107]
The installation instructions for Golang use a placeholder
{{constants.golangNodeMainnet}}for the version. Ensure that this placeholder is correctly replaced with the actual version number during the document rendering process. If this process is not automated, consider specifying the current recommended version explicitly.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [192-196]
The section on installing Celestia-node mentions compatibility with the Arabica devnet or Mocha testnet. It's important to ensure that the document is updated to include any new networks or significant changes to existing ones, especially if there are version-specific instructions.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [244-244]
The document mentions an experimental build option using
jemallocfor optimal performance. It's crucial to highlight any potential risks or stability issues associated with experimental features to guide users in making informed decisions.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [284-289]
The section on instantiating a Celestia light node briefly mentions RPC endpoints without providing detailed information on how to configure or use them. Consider expanding this section with examples or links to more detailed documentation on RPC endpoint configuration and usage.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [315-322]
The document references deprecated gateway endpoints and suggests checking out the Mocha testnet and Arabica devnet pages for community-run API endpoints. Ensure that all links and references are up-to-date and that deprecated features are clearly marked to prevent confusion.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [438-443]
The RPC CLI guide section provides a general overview of interacting with the Celestia node's RPC API. To enhance the learning experience, consider including a link to a comprehensive reference or API documentation that covers all available RPC CLI commands and their parameters.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [791-791]
The example for setting a higher gas price uses
0.004 utiaas the value. Ensure that this example is consistent with the current gas pricing model and network conditions. It might be helpful to provide a brief explanation of how to determine an appropriate gas price.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1099-1099]
The advanced example using the
jqcommand to parse the output of one command for use in another is a powerful technique. However, it assumes familiarity withjqand shell scripting. Consider adding a brief explanation or link to resources for users who may not be familiar with these tools.
- 1130-1136: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1161-1173]
The troubleshooting section mentions a specific error related to
PayForBlobstransactions and testnet tokens. It's good practice to include a section on common issues and their resolutions. Consider expanding this section with additional common errors and troubleshooting steps to provide more comprehensive support to users.
|
thanks for review. i'm going to park this here until v0.13.xx is live on Mainnet beta |
this is live in v0.13.0 i think, cc @vgonkivs for review
…stream (#1489) * docs: add documentation on how to build rollups on Celestia * docs: remove question * docs: one -> value * docs: explain more the proofs + reformating * docs: set ETA * docs: expand on protobuf deserialisation * docs: expand on protobuf deserialisation * docs: rewrite, reorganise, explain * docs: review feedback * docs: grammar * docs: remove new lines * docs: add links to inclusion proofs * docs: update blobstream contract addresses (#1485) Replaces #1482 * ci: test removing the CNAME file for clean up of previews. (#1493) * docs: update blobstream (#1495) * docs: update bubs-testnet.md with new URIs * docs: add status page and bridge * docs: comment out thirdweb bc chain is different now * docs: update gm portal and contract guides for bubs * docs: add mocha and namespace * docs: add bridging context * [GH Action] Update release tags and commit SHAs for arabica (#1497) * [automated GH action] update latest release tags & commit sha (arabica) * Update .vitepress/constants/arabica_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * [GH Action] Update release tags and commit SHAs for mocha (#1498) * [automated GH action] update latest release tags & commit sha (mocha) * Update .vitepress/constants/mocha_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: update go constants for arabiac and mocha * docs: update to make install for all types of machines (#1502) * feat: Update node-tutorial.md (#1478) this is live in v0.13.0 i think, cc @vgonkivs for review * feat: split consensus node page (#1472) * docs: split consensus node page * docs: setup to set up * docs: setup to set up 2 * docs: coderabbit reviews * docs: change to everywhere * docs: add backlink --------- Co-authored-by: jcstein <mail@jcstein.dev> * docs: rollup available link Vitalik (#1505) * docs: rollup link Vitalik * docs: changes follow suggestion for example giving comma * docs: Fix proof query example errors (#1504) * Add missing return statement in toRowProofs function * fix dataRoot slice out of range error * fixes another missing return in toRowProofs * docs: fix blobstream proof queries code (#1506) * docs: initial commit, needs revision * docs: remove old light node config * docs: edits and refactor page * docs: minor copy edit * docs: cleanup for new deployment guide * docs: todos for deployment guide * docs: edit intro * docs: step 1-2 * docs: deploy steps and table * docs: remainder of deploy steps draft * docs: change style of quickstart to Quickstart: Deploy an Orbit rollup * docs: add todos * docs: update contract addresses * docs: using light node, namespace, auth token * docs: add link to arb doc * docs: add todo * docs: resolve build errs * docs: add bridging guide * docs: small revisions * docs: copy edits * docs: deploy revision * docs: fix blobstream address * docs: add alchemy rpc section * docs: note about opening ports in docker * docs: bump celestia-node version * docs: edit l1 to l2 * docs: add newer success logs * feat: add full node page to docs for orbit * feat: write out full node page * docs: more info on validatorfn page * docs: update wasm root * docs: update nitro release * docs: use v2.3.1-rc.1 everywhere for nitro * docs: edit out 'click heres' * fix: links * docs: add eth-rpc variable * docs: coderabbit suggestions * docs: clarify wss * docs: swap steps 6 and 7 for deploy doc * docs: edit wss section * docs: add more context for wss * docs: improve md readabliity in table * docs: update deployui url * docs: update ui url * docs: we'll use in next step * docs: updates * docs: add fn * [GH Action] Update release tags and commit SHAs for mainnet (#1507) * [automated GH action] update latest release tags & commit sha (mainnet) * Update .vitepress/constants/mainnet_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: update newmetric endpoints Resolves #1501 * docs: update orbit URL * docs: coderabbit suggestions * docs: add op raspberry testnet * [GH Action] Update release tags and commit SHAs for arabica (#1511) * [automated GH action] update latest release tags & commit sha (arabica) * Apply suggestions from code review --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: add sepolia -> mocha (#1512) * fix typo in arabica-devnet page (#1513) * [WIP] docs: add audits for blobstream x (#1491) * docs: add audits for blobstream x * docs: add veridise audit * Update rollup-overview.md (#1516) * feat: restructure developers category (#1515) * feat: drafting buttons * fix: color of btn * feat: add note text optional * feat: rename to build-whatever.md * fix: copy * feat: category shuffle * fix: suggestions from code review * feat: add vistara * Apply suggestions from code review * fix: typo * feat: add alt texts * fix: typo * feat: aria-labels * docs: shuffle intro * feat: add celestia-node.sh script * fix: clarify section vs. tutorial * feat: exit if dir change fails * Update mocha_versions.js (#1529) * Update mocha_versions.js * Update mocha_versions.js * Add Grove archival endpoints to `nodes/mainnet.md` (#1525) * Add Grove to nodes/mainnet.md * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update nodes/mainnet.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Store image in src code * Add description of archival nodes * Apply suggestions from code review * Apply suggestions from code review * Update nodes/mainnet.md --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * docs: fix typos (#1526) * fix typo * fix typo * fix typo * fix typo * fix typos * fix typo * fix typo * fix typos * fix typos * fix typos * fix typos * fix typo * fix typo * fix typo Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Update mainnet.md (#1527) Add noders endpoints * Update mocha-testnet.md (#1528) * Update mocha-testnet.md Add noders endpoints * Fixed link to endpoint * Apply suggestions from code review --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * fix: veridise path * feat: add to menu * docs: begin lint * docs: remove duplicate headings * docs: clarify duplicate headings * docs: better headings * docs: mention blobstream rollups docs in the blobstream overview --------- Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> Co-authored-by: Matthew Sevey <mjsevey@gmail.com> Co-authored-by: jcstein <mail@jcstein.dev> Co-authored-by: celestia-bot <136652805+celestia-bot@users.noreply.github.com> Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Levai Mackenzie Ágbàrà <levaiagbara@gmail.com> Co-authored-by: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Co-authored-by: Kassius <34594014+CryptoKass@users.noreply.github.com> Co-authored-by: Ratan Kaliani <ratankaliani@berkeley.edu> Co-authored-by: Callum Waters <cmwaters19@gmail.com> Co-authored-by: Alex Beckett <75361908+alex-beckett@users.noreply.github.com> Co-authored-by: mindstyle85 <55639830+mindstyle85@users.noreply.github.com> Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: Alex Moskaleu (SeptimA) <dudava45@gmail.com>
this is live in v0.13.0 i think, cc @vgonkivs for review
Overview
Checklist
Summary by CodeRabbit