feat: add details about pruning for v0.13.0 celestia-node

[jcstein]

Overview

Resolves #1415

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• New Features
  • Introduced a 30-day light node sampling window for data retrievability and storage management, enhancing network efficiency by pruning data outside this window.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs/pr-preview/pr-1424/
on branch gh-pages at 2024-02-19 16:59 UTC

[coderabbitai]

Walkthrough

The v0.13.0 update of celestia-node introduces a significant enhancement in data management by implementing a 30-day light node sampling window. This change allows for the pruning of data that falls outside this window, optimizing storage and retrievability within the network.

Changes

File(s)	Change Summary
learn/retrievability.md	Introduced a 30-day light node sampling window for data pruning.

Assessment against linked issues

Objective	Addressed	Explanation
Document pruning for v0.13.0 (#1415)	✅

🐇✨
In the realm of data, wide and vast,
A change has come, quite unsurpassed.
With thirty days, we look, we see,
What stays and goes, in memory.
Pruned away, the old must part,
To make way for the new to start.
🌿📉🔄

• CodeRabbit

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 48c84dd and 6858c9a.

Files selected for processing (1)

• learn/retrievability.md (1 hunks)

Additional comments: 2

learn/retrievability.md (2)

• 32-32: This line effectively clarifies the distinction between pruned and archival nodes, and how data retrievability is managed between them. It's well-explained and adds important context for understanding the network's data management strategy.
• 37-37: The statement about light nodes performing data availability sampling only within the 30-day window is clear and reinforces the concept introduced earlier. This consistency in messaging helps solidify the reader's understanding of the new feature.

[Bidon15]

nits mostly

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6858c9a and 9f7f471.

Files selected for processing (1)

• learn/retrievability.md (1 hunks)

Additional comments: 1

learn/retrievability.md (1)

• 37-38: The statement that light nodes will only perform data availability sampling for blocks within the 30-day window is concise and directly ties back to the new pruning feature. This reinforces the operational changes introduced in celestia-node v0.13.0. No further refinement is needed here.

[jcstein]

likely need to revert this as it appears the window was the only thing introduced, and that the release notes say "Light nodes will now only sample blocks within a 30 day window instead of sampling all blocks from genesis." but it does not work this way.