docs: update BN/FN/LN requirements for shwap

[jcstein]

To merge after shwap is live on all networks.

Overview

Summary by CodeRabbit

• New Features

  • Updated hardware minimum requirements for running Bridge and Full Storage nodes, reducing memory requirements from 16 GB to 8 GB RAM and adjusting CPU specifications.

• Documentation

  • Revised specifications in the overview documentation for various node types to reflect the updated hardware requirements.

[coderabbitai]

Walkthrough

The changes in this pull request update the hardware minimum requirements for the Bridge node and Full storage node. Both nodes now require a minimum of 8 GB RAM instead of 16 GB, and the CPU requirement for the Bridge node has been adjusted from 6 cores to Quad core. The Consensus node's CPU terminology has also been standardized. Other specifications, such as disk storage and bandwidth, remain unchanged across all node types.

Changes

File	Change Summary
nodes/bridge-node.md, nodes/full-storage-node.md, nodes/overview.md	Updated hardware minimum requirements: Memory reduced to 8 GB RAM, CPU for Bridge node changed to Quad core. Consensus node CPU terminology standardized. Other specs unchanged.

Possibly related PRs

• docs: update state sync instructions #1652: Updates the documentation for the full consensus node, discussing hardware requirements similar to the full storage node changes.
• docs: update consensus-node page  #1662: Includes updates to the consensus node documentation related to hardware requirements and terminology changes.
• docs: add updated diagrams for node requirements and consensus node #1674: Modifies the consensus node diagram to reflect updated terminology, related to the main PR's hardware specifications.
• docs: migrate node ID in bridge-node, full-storage-node, light-node #1685: Enhances documentation for the full storage node with migration instructions, relevant to node specifications.

Suggested labels

documentation

🐰 "In the meadow, changes bloom,
With RAM reduced, we make room.
Quad cores now, a lighter load,
Nodes align on the data road.
Hopping forward, clear and bright,
Documentation shines with new light!" 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 506aa9a and 7a7a36f.

📒 Files selected for processing (3)

• nodes/bridge-node.md (1 hunks)
• nodes/full-storage-node.md (1 hunks)
• nodes/overview.md (1 hunks)

🔇 Additional comments (6)

nodes/overview.md (3)

39-39: Confirm the rationale behind Bridge node specification changes.

The changes to the Bridge node specifications (reduced RAM and changed CPU requirement) are consistent with the summary. However, please clarify:

1. The reason for reducing the memory requirement from 16 GB to 8 GB RAM.
2. Whether changing from "6 cores" to "Quad core" affects performance.
3. If these changes are related to the shwap feature mentioned in the PR objectives.

Consider adding a note explaining these changes and their relation to shwap if applicable.

---

40-40: Confirm the rationale behind Full storage node memory reduction.

The change to the Full storage node specification (reduced RAM) is consistent with the summary. However, please clarify:

1. The reason for reducing the memory requirement from 16 GB to 8 GB RAM.
2. Whether this change affects the node's performance or capabilities.
3. If this change is related to the shwap feature mentioned in the PR objectives.

Consider adding a note explaining this change and its relation to shwap if applicable.

---

47-47: Approved: Consistent terminology for CPU specifications.

The change from "Quad-core" to "Quad core" for the Consensus node's CPU specification improves consistency with other node types in the document. This is a good improvement in terminology standardization.

nodes/full-storage-node.md (2)

25-26: Approved changes, but additional context needed.

The hardware requirements for memory and CPU have been reduced:

• Memory: from 16 GB to 8 GB RAM
• CPU: from 6 cores to Quad core

These changes could make running a full storage node more accessible. However, it would be helpful to provide context for why these requirements were lowered. Are there any performance implications or trade-offs that users should be aware of?

To ensure these changes are consistent across the documentation, please run the following script:

---

Line range hint 1-100: Missing information on BN/FN/LN requirements for shwap.

The PR objectives mention updating the documentation regarding the requirements for BN (Block Number), FN (Function Number), and LN (Line Number) in relation to the shwap feature. However, this information is not present in the current document.

Could you please clarify:

1. Should this information be added to this document?
2. If not, in which file should these requirements be documented?
3. Are there any additional changes needed to fulfill the PR objectives?

To help locate any existing documentation related to these requirements, please run the following script:

nodes/bridge-node.md (1)

50-51: Approved changes, but clarification needed.

The updates to the hardware requirements (reducing RAM from 16 GB to 8 GB and changing CPU from 6 cores to Quad core) are noted. These changes could potentially make it easier for more people to run bridge nodes, which might increase network decentralization.

However, two points need attention:

1. Could you please clarify how these changes relate to the PR objectives mentioned in the description? The PR summary talks about updating BN/FN/LN requirements for shwap, but these changes don't seem to directly address that.

2. It's important to verify that these reduced requirements are still sufficient for optimal performance of a bridge node. Have these new specifications been thoroughly tested?

To ensure these changes are appropriate, please run performance tests with the new minimum specifications and compare them with the previous requirements. This will help verify that the bridge node can still perform all its functions efficiently with the reduced hardware.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-09-30 20:41 UTC

[jcstein]

will reopen this when it makes sense tbh