From 7536d916fa33a9f25e35673e0ccfcfd99350478a Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Tue, 1 Feb 2022 16:47:52 +0100 Subject: [PATCH] minor edits --- docs/the_nimbus_book/src/SUMMARY.md | 4 ++-- docs/the_nimbus_book/src/migration.md | 2 +- docs/the_nimbus_book/src/rest-api.md | 4 ++-- docs/the_nimbus_book/src/trusted-node-sync.md | 6 ++---- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index e8b1ed447..526f50842 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -12,7 +12,7 @@ - [Install dependencies](./install.md) - [Build the beacon node](./build.md) - [Sync from scratch](./start-syncing.md) -- [Sync from a trusted node (checkpoint sync)](./trusted-node-sync.md) +- [Checkpoint sync from a trusted node](./trusted-node-sync.md) - [Add a backup web3 provider](./web3-backup.md) # How-to (validator) @@ -53,7 +53,7 @@ # Reference - [JSON-RPC API](./api.md) -- [REST API](./rest-api.md) +- [Beacon (REST) API](./rest-api.md) - [Keymanager API](./keymanager-api.md) - [Help / Command line options](./options.md) - [Advanced migration options](./migration-options.md) diff --git a/docs/the_nimbus_book/src/migration.md b/docs/the_nimbus_book/src/migration.md index df53e4581..1df4d5ccb 100644 --- a/docs/the_nimbus_book/src/migration.md +++ b/docs/the_nimbus_book/src/migration.md @@ -43,7 +43,7 @@ sudo systemctl stop prysmvalidator.service sudo systemctl disable prysmvalidator.service ``` -It's important that you disable the Prysm validator as well as stopping it, to prevent it from starting up again on reboot. +*It's important that you disable the Prysm validator as well as stopping it, to prevent it from starting up again on reboot.* #### 2. Export slashing protection history diff --git a/docs/the_nimbus_book/src/rest-api.md b/docs/the_nimbus_book/src/rest-api.md index fe65bd692..9e0e73954 100644 --- a/docs/the_nimbus_book/src/rest-api.md +++ b/docs/the_nimbus_book/src/rest-api.md @@ -1,6 +1,6 @@ -# REST API +# Beacon (REST) API -Nimbus exposes an **extremely fast** implementation of the standard [Beacon Node API](https://ethereum.github.io/beacon-APIs/). The API allows you to use Nimbus together with third-party tooling such as validator clients, block explorers as well as your own monitoring infrastructure. +Nimbus exposes an **extremely fast** implementation of the standard [Beacon API](https://ethereum.github.io/beacon-APIs/). The API allows you to use Nimbus together with third-party tooling such as validator clients, block explorers as well as your own monitoring infrastructure. The API is a `REST` interface accessed via `HTTP`. **The API should not be exposed to the public Internet** unless protected by additional security: it includes multiple endpoints which could open your node to denial-of-service (DoS) attacks. diff --git a/docs/the_nimbus_book/src/trusted-node-sync.md b/docs/the_nimbus_book/src/trusted-node-sync.md index 7e04fed70..026f217f4 100644 --- a/docs/the_nimbus_book/src/trusted-node-sync.md +++ b/docs/the_nimbus_book/src/trusted-node-sync.md @@ -1,4 +1,4 @@ -# Sync from a trusted node +# Sync from a trusted node (a.k.a Checkpoint or Snapshot sync) 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. @@ -12,9 +12,7 @@ It is possibly to use trusted node sync with a third-party API provider -- see [ ## Perform a trusted node sync -> **Tip:** Make sure to replace `http://localhost:5052` in the commands below with the appropriate endpoint for you. `http://localhost:5052` is the endpoint exposed by Nimbus but this is not consistent across all clients. 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` +> **Tip:** Make sure to replace `http://localhost:5052` in the commands below with the appropriate endpoint for you. `http://localhost:5052` is the default endpoint exposed by Nimbus and all other clients, so if you haven't specified a different port the commands below should work as is. **Mainnet**