feat: evm reth state backup #582
Conversation
WalkthroughA new guide for backing up the reth state in Rollkit EVM environments was added to the documentation. The sidebar configuration was updated to include a link to this guide under "How To Guides." The guide provides both manual and automated backup procedures, including a bash script and best practices. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Rollkit Node
participant reth-rollkit Service
participant Backup Script
participant Remote Storage
User->>Backup Script: Schedule/Run backup script
Backup Script->>Rollkit Node: Check sync status via HTTP RPC
Backup Script->>reth-rollkit Service: Check sync status via HTTP RPC
Backup Script->>Rollkit Node: Stop service (via Docker Compose)
Backup Script->>reth-rollkit Service: Stop service (via Docker Compose)
Backup Script->>reth-rollkit Service: Compress and backup datadir
Backup Script->>Remote Storage: (Optional) Transfer backup via rsync
Backup Script->>Rollkit Node: Restart service
Backup Script->>reth-rollkit Service: Restart service
Backup Script->>Backup Script: Cleanup old backups
Assessment against linked issues
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @auricom, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces essential documentation and tooling for managing the Reth state of Rollkit EVM-based blockchains. It provides users with clear, actionable steps for both manual and automated backup procedures, ensuring data protection and operational resilience. The changes enhance the project's guidance on maintaining production-ready Rollkit full nodes.
Highlights
- New Documentation Guide: A comprehensive guide titled 'Rollkit EVM reth State Backup Guide' has been added, detailing procedures for backing up the Reth state of Rollkit EVM-based blockchains.
- Manual Backup Procedure: The guide outlines a step-by-step manual backup process, including verifying node synchronization, gracefully stopping services (Rollkit and Reth), creating a compressed backup of the Reth datadir using
tarandzstd, generating a checksum, and restarting services. - Automated Backup Solution: An automated backup solution is provided, featuring a robust bash script (
rollkit-backup.sh) that handles configuration, node health checks, service orchestration (stopping/starting Docker containers), Zstandard compression, remote backup transfer viarsync, and old backup cleanup based on retention policies. Instructions for scheduling this script withcrontabare also included. - Documentation Navigation Update: The project's documentation sidebar (
.vitepress/config.ts) has been updated to include a new link to the 'EVM reth state backup' guide, making it easily discoverable for users. - Best Practices: The guide concludes with best practices for backup strategies, emphasizing regular scheduling, retention policies, restoration testing, monitoring, and appropriate Zstandard compression levels.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces a guide for backing up the reth state of a Rollkit EVM-based blockchain. The guide covers both manual and automated backup procedures. The review focuses on improving clarity, correctness, and robustness. A critical issue was identified in the backup script where a mandatory variable is not validated, which would cause the script to fail. Other suggestions include correcting inconsistencies in service names, clarifying placeholder variables, and making a health check more effective.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
guides/evm-reth-backup.md (1)
122-130:RETH_ROLLKIT_DATADIRis empty – script will failThe variable is initialised to an empty string and never validated.
tar -Con line 180 will error out.-RETH_ROLLKIT_DATADIR="" # IMPORTANT: Set this to your reth-rollkit data directory path +RETH_ROLLKIT_DATADIR="/path/to/reth-rollkit/datadir" # <-- edit + +if [[ -z "$RETH_ROLLKIT_DATADIR" ]]; then + echo "RETH_ROLLKIT_DATADIR is not set" >&2 + exit 1 +fi
🧹 Nitpick comments (5)
.vitepress/config.ts (1)
331-334: Title-case the new sidebar label for visual consistencyOther entries under “How To Guides” (e.g. “EVM Based Sequencer”, “Metrics”) use Title-case. Capitalising “Reth” and “State” keeps the list uniform.
- text: "EVM reth state backup", + text: "EVM Reth State Backup",guides/evm-reth-backup.md (4)
5-5: Use “back up” (verb) instead of “backup” (noun)
Small grammar nit:-This guide covers how to backup the reth state +This guide covers how to back up the reth state
11-17: Listrsyncas a prerequisiteThe automated script relies on
rsync(line 188) for remote transfer, but it isn’t mentioned in the prerequisites block. Add it to avoid runtime surprises.
77-83: Remove duplicated “Create backup directory” comment blockLines 77-83 repeat the same heading twice. Keeping one is cleaner:
-# Create backup directory -# Create backup directory +# Create backup directory
207-207: Remove stray apostropheLine 207 ends the header with an extra
', producing malformed markdown.-### 2. Make Script Executable' +### 2. Make Script Executable
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.vitepress/config.ts(1 hunks)guides/evm-reth-backup.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
.vitepress/config.ts (1)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
🪛 LanguageTool
guides/evm-reth-backup.md
[grammar] ~5-~5: The word “backup” is a noun. The verb is spelled with a white space.
Context: ... Introduction This guide covers how to backup the reth state of a Rollkit EVM based b...
(NOUN_VERB_CONFUSION)
| # Backup reth state using zstandard compression | ||
| log "Backing up reth state with zstandard compression" | ||
| tar cf - -C ${RETH_ROLLKIT_DATADIR} . | zstd -${ZSTD_LEVEL} -T${ZSTD_THREADS} > "${BACKUP_DIR}/reth_state_${BACKUP_DATE}.tar.zst" | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Quote variable and check directory existence before tar
Unquoted ${RETH_ROLLKIT_DATADIR} breaks on paths with spaces; missing existence check may lead to silent empty archives.
-tar cf - -C ${RETH_ROLLKIT_DATADIR} . | zstd -${ZSTD_LEVEL} -T${ZSTD_THREADS} > "${BACKUP_DIR}/reth_state_${BACKUP_DATE}.tar.zst"
+[[ -d "$RETH_ROLLKIT_DATADIR" ]] || { echo "Datadir not found: $RETH_ROLLKIT_DATADIR"; exit 1; }
+tar cf - -C "$RETH_ROLLKIT_DATADIR" . | zstd -"${ZSTD_LEVEL}" -T"${ZSTD_THREADS}" > "${BACKUP_DIR}/reth_state_${BACKUP_DATE}.tar.zst"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Backup reth state using zstandard compression | |
| log "Backing up reth state with zstandard compression" | |
| tar cf - -C ${RETH_ROLLKIT_DATADIR} . | zstd -${ZSTD_LEVEL} -T${ZSTD_THREADS} > "${BACKUP_DIR}/reth_state_${BACKUP_DATE}.tar.zst" | |
| # Backup reth state using zstandard compression | |
| log "Backing up reth state with zstandard compression" | |
| [[ -d "$RETH_ROLLKIT_DATADIR" ]] || { echo "Datadir not found: $RETH_ROLLKIT_DATADIR"; exit 1; } | |
| tar cf - -C "$RETH_ROLLKIT_DATADIR" . | zstd -"${ZSTD_LEVEL}" -T"${ZSTD_THREADS}" > "${BACKUP_DIR}/reth_state_${BACKUP_DATE}.tar.zst" |
🤖 Prompt for AI Agents
In guides/evm-reth-backup.md around lines 178 to 181, the variable
${RETH_ROLLKIT_DATADIR} used in the tar command is unquoted, which causes issues
if the path contains spaces. Additionally, there is no check to verify that the
directory exists before running tar, which could result in creating empty
archives silently. To fix this, quote the variable in the tar command and add a
conditional check to ensure the directory exists before proceeding with the
backup.
EVM reth state backup
rollkit/rollkit#2391
Summary by CodeRabbit