-
Notifications
You must be signed in to change notification settings - Fork 716
chore(snapshots): documentation clarification #1734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,10 @@ description: Download and restore Base node snapshots to significantly reduce in | |
|
|
||
| Using a snapshot significantly reduces the initial time required to sync a Base node. Snapshots are updated regularly. | ||
|
|
||
| <Note> | ||
| A snapshot configuration website is coming soon. It will help you choose a preset or customize the data you download for your node. This guide will be updated with a link when the website launches. | ||
| </Note> | ||
|
|
||
| If you're a prospective or current Base node operator, you can restore from a snapshot to speed up your initial sync. Follow the steps below carefully. | ||
|
|
||
| ## Restoring from Snapshot | ||
|
|
@@ -30,7 +34,7 @@ These steps use the `base-reth-node` CLI to download snapshots. If you don't alr | |
| | Base Mainnet | `base` | | ||
| | Base Sepolia | `base-sepolia` | | ||
|
|
||
| 3. **Download Snapshot**: Choose the appropriate snapshot for your network and client from the table below. | ||
| 3. **Download Snapshot**: V2 snapshots are split into many small, segmented files rather than a single archive. The CLI lists one `archive` snapshot because it contains all available files. The `full` and `minimal` options select progressively smaller subsets of that archive: | ||
|
|
||
| | Config | Flag | What you get | Use when | | ||
| |--------------|-------------|------------------------------------------------------------------------------|-------------------------------------------------------------| | ||
|
|
@@ -42,6 +46,8 @@ These steps use the `base-reth-node` CLI to download snapshots. If you don't alr | |
| Ensure you have enough free disk space to download the snapshot _and_ extract its contents. The extracted data will be significantly larger than the archive. | ||
| </Note> | ||
|
|
||
| The above presets are convenient defaults. You may still configure custom pruning flags with the [flag](https://github.com/base/node/blob/main/.env.mainnet#L55). It is required to download the archival snapshot and then configure your custom pruning args. | ||
|
|
||
| ```bash | ||
| # Minimal node on Base Mainnet | ||
| base-reth-node download --minimal --datadir ./reth-data --chain base --resumable | ||
|
|
@@ -134,5 +140,11 @@ In Reth, a "full" node is just a pruned node with a specific preset rather than | |
|
|
||
| Base's `--full` snapshot uses a 31-day rolling retention window instead. If a smaller storage footprint is preferred, you can override `reth.toml` to match the 10,064-block preset. | ||
|
|
||
| </Accordion> | ||
|
|
||
| <Accordion title="I'm seeing: Archive extracted, but output verification failed. How'd I fix this?"> | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove the "How'd I. fix this?" |
||
|
|
||
| Please interrupt the download command and re-run it. The download is idempotent, so it wont redownload everything it has already downloaded. This is caused due to a newer snapshot being uploaded during the time your download is happening. | ||
|
wlawt marked this conversation as resolved.
Outdated
|
||
|
|
||
| </Accordion> | ||
| </AccordionGroup> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.