Skip to content

Commit 6fdb1de

Browse files
alexandratranAlexandra Tran
andauthored
Document --snapsync-server-enabled (#1831)
* Document truststore options Signed-off-by: Alexandra Tran <[email protected]> * add more context to descriptions Signed-off-by: Alexandra Tran <[email protected]> * Document `--snapsync-server-enabled` Signed-off-by: Alexandra Tran <[email protected]> * clarify descriptions Signed-off-by: Alexandra Tran <[email protected]> --------- Signed-off-by: Alexandra Tran <[email protected]> Co-authored-by: Alexandra Tran <[email protected]>
1 parent 4545fbd commit 6fdb1de

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

docs/public-networks/concepts/node-sync.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ to `false`. However, this will increase the sync time and disk space usage.
9797

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

101103
You can't switch from fast sync to snap sync. If your node is blocked in the middle of a fast sync,
102104
you can start over using snap sync instead by stopping the node, deleting the data directory, and

docs/public-networks/reference/cli/options.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5815,6 +5815,43 @@ Name of the security module plugin to use. For example, a Hardware Security Modu
58155815

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

5818+
### `snapsync-server-enabled`
5819+
5820+
<Tabs>
5821+
<TabItem value="Syntax" label="Syntax" default>
5822+
5823+
```bash
5824+
--snapsync-server-enabled[=<true|false>]
5825+
```
5826+
5827+
</TabItem>
5828+
<TabItem value="Example" label="Example">
5829+
5830+
```bash
5831+
--snapsync-server-enabled=true
5832+
```
5833+
5834+
</TabItem>
5835+
<TabItem value="Environment variable" label="Environment variable">
5836+
5837+
```bash
5838+
BESU_SNAPSYNC_SERVER_ENABLED=true
5839+
```
5840+
5841+
</TabItem>
5842+
<TabItem value="Example configuration file" label="Example configuration file">
5843+
5844+
```bash
5845+
snapsync-server-enabled=true
5846+
```
5847+
5848+
</TabItem>
5849+
</Tabs>
5850+
5851+
Enables or disables serving [snap sync](../../concepts/node-sync.md#snap-synchronization) data.
5852+
Set to `true` to allow other nodes to download data from this node using snap sync.
5853+
The default is `false`.
5854+
58185855
### `snapsync-synchronizer-pre-checkpoint-headers-only-enabled`
58195856

58205857
<Tabs>
@@ -5851,7 +5888,7 @@ snapsync-synchronizer-pre-checkpoint-headers-only-enabled=false
58515888
</TabItem>
58525889
</Tabs>
58535890

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

58575894
Setting this option to `false` increases sync time and disk space usage.

0 commit comments

Comments
 (0)