status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Trusted node sync clarifications in nimbus book (#4146) 

- Make it clear that it is a separate command from actually
running the beacon node
- Fix and extend the note on starting from a clean folder
This commit is contained in:
Kim De Mey 2022-09-19 12:32:28 +02:00 committed by GitHub
parent e3750e96e8
commit c607d7da0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/the_nimbus_book/src/trusted-node-sync.md
View File

@ -21,11 +21,13 @@ It is possibly to use trusted node sync with a third-party API provider -- see [
!!! tip
Make sure to replace `http://localhost:5052` in the commands below with the appropriate endpoint of the trusted beacon node. `http://localhost:5052` is the default endpoint exposed by Nimbus, but this is not consistent across all clients.
!!! note ""
The path specified for data-dir must be an empty directory
For example, if your trusted node is a [Prysm node](https://docs.prylabs.network/docs/how-prysm-works/ethereum-public-api#performing-requests-against-a-local-prysm-node), it exposes `127.0.0.1:3500` by default. Which means you would run the commands below with `--trusted-node-url=http://127.0.0.1:3500`
!!! note
The path specified for `--data-dir` must be an empty directory as trusted node sync needs to be started from a fresh database.
To start trusted node sync, run:
=== "Mainnet"
```sh
build/nimbus_beacon_node trustedNodeSync \
@ -41,9 +43,23 @@ It is possibly to use trusted node sync with a third-party API provider -- see [
--trusted-node-url=http://localhost:5052
```
If the command was executed succesfully, following log lines will be visible:
```
Writing checkpoint state
Writing checkpoint block
```
And eventually:
```
Done, your beacon node is ready to serve you! Don't forget to check that you're on the canonical chain by comparing the checkpoint root with other online sources. See https://nimbus.guide/trusted-node-sync.html for more information.
```
After this the application will terminate and you can now [start the `nimbus_beacon_node`](./quick-start.md) with your usual command.
!!! note
Because trusted node sync by default copies all blocks via REST, you may hit API limits if you are using a third-party provider. If this happens to you, you may need to use the `--backfill` option to [delay the backfill of the block history](./trusted-node-sync.md#delay-block-history-backfill).
## Verify you synced the correct chain
When performing a trusted node sync, you can manually verify that the correct chain was synced by comparing the head hash with other sources (e.g. your friends, forums, chats and web sites). If you're syncing using your own backup node you can retrieve the current head from the node using: