Skip to content

Document --snapsync-server-enabled #1831

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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/public-networks/concepts/node-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ to `false`. However, this will increase the sync time and disk space usage.

Instead of downloading the [state trie](data-storage-formats.md) node by node, snap
sync downloads as many leaves of the trie as possible, and reconstructs the trie locally.
To enable serving snap sync data to other nodes, set
[`--snapsync-server-enabled`](../reference/cli/options.md#snapsync-server-enabled) to `true`.

You can't switch from fast sync to snap sync. If your node is blocked in the middle of a fast sync,
you can start over using snap sync instead by stopping the node, deleting the data directory, and
Expand Down
39 changes: 38 additions & 1 deletion docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -5815,6 +5815,43 @@ Name of the security module plugin to use. For example, a Hardware Security Modu

The default is the node's local private key file specified using [`--node-private-key-file`](#node-private-key-file).

### `snapsync-server-enabled`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--snapsync-server-enabled[=<true|false>]
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--snapsync-server-enabled=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
BESU_SNAPSYNC_SERVER_ENABLED=true
```

</TabItem>
<TabItem value="Example configuration file" label="Example configuration file">

```bash
snapsync-server-enabled=true
```

</TabItem>
</Tabs>

Enables or disables serving [snap sync](../../concepts/node-sync.md#snap-synchronization) data.
Set to `true` to allow other nodes to download data from this node using snap sync.
The default is `false`.

### `snapsync-synchronizer-pre-checkpoint-headers-only-enabled`

<Tabs>
Expand Down Expand Up @@ -5851,7 +5888,7 @@ snapsync-synchronizer-pre-checkpoint-headers-only-enabled=false
</TabItem>
</Tabs>

If set to `false`, Snap sync downloads full pre-merge Proof of Work (PoW) historical blocks
If set to `false`, [snap sync](../../concepts/node-sync.md#snap-synchronization) downloads full pre-merge Proof of Work (PoW) historical blocks
instead of headers only, allowing full historical data to be retained. The default is `true`.

Setting this option to `false` increases sync time and disk space usage.
Expand Down
Loading