Skip to content

Commit 94a87da

Browse files
authored
Documentation for the --with-deposit-snapshot option (#4440)
1 parent 2184fd2 commit 94a87da

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

docs/the_nimbus_book/src/options.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ The following options are available:
106106
a validator with the same index (a doppelganger), before sending an attestation
107107
itself. This protects against slashing (due to double-voting) but means you will
108108
miss two attestations when restarting. [=true].
109-
--validator-monitor-auto Automatically monitor locally active validators [=false].
109+
--validator-monitor-auto Automatically monitor locally active validators (BETA) [=false].
110110
--validator-monitor-pubkey One or more validators to monitor - works best when --subscribe-all-subnets is
111-
enabled.
111+
enabled (BETA).
112112
--validator-monitor-totals Publish metrics to single 'totals' label for better collection performance when
113-
monitoring many validators [=false].
113+
monitoring many validators (BETA) [=false].
114114
--suggested-fee-recipient Suggested fee recipient.
115115
--payload-builder Enable external payload builder [=false].
116116
--payload-builder-url Payload builder URL.

docs/the_nimbus_book/src/trusted-node-sync.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
!!! note ""
44
This feature is available from `v1.7.0` onwards
55

6-
When you [start the beacon node](./quick-start.md) for the first time, it will connect to the beacon chain network and start syncing automatically - a process that can take several days.
6+
When you [start the beacon node](./quick-start.md) for the first time, it connects to the beacon chain network and starts syncing automatically - a process that can take several days.
77

88
Trusted node sync allows you to get started more quickly by fetching a recent checkpoint from a trusted node - you can get started in minutes instead of days.
99

10-
To use trusted node sync, you must have access to a node that you trust that exposes the [Beacon API](./rest-api.md) (for example a locally running backup node).
10+
To use trusted node sync, you must have access to a node that you trust and that exposes the [Beacon API](./rest-api.md) (for example a locally running backup node).
1111

1212
Should this node, or your connection to it, be compromised, your node will not be able to detect whether or not it is being served false information.
1313

@@ -80,6 +80,13 @@ The `head` root is also printed in the log output at regular intervals.
8080

8181
## Advanced
8282

83+
### Skip syncing the history of deposits
84+
85+
The recently standardized Beacon API endpoint `/eth/v1/beacon/deposit_snapshot` allows a client to skip downloading the entire history of deposit by downloading a small snapshot of the state of the validator deposit contract. To take advantage of this functionality, make sure you are syncing against a beacon node which supports it (e.g. Nimbus 22.12.0 or later) and specify the the command line option `--with-deposit-snapshot` when executed the `trustedNodeSync` command.
86+
87+
!!! tip
88+
It's safe to always specify this option. Nimbus will produce a warning if the specified beacon node doesn't support the required endpoint. Future versions of Nimbus will enable the option by default.
89+
8390
### Delay block history backfill
8491

8592
By default, both the state and the full block history will be downloaded from the trusted node.

0 commit comments

Comments
 (0)