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

Nimbus book: update volumes 1 + 2 for mainnet

This commit is contained in:
yslcrypto 2020-11-24 15:00:35 +01:00
parent f2722ed866
commit 6de42a6341
7 changed files with 35 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/the_nimbus_book/src/connect-eth2.md
View File

@ -1,6 +1,6 @@
# Connect your validator to eth2 # Connect your validator to eth2
> ⚠️ This page concerns the **Pyrmont** testnet only. If you have made a mainnet deposit, you do not need to connect your validator to eth2 quite yet. Mainnet [Genesis](https://hackmd.io/@benjaminion/genesis) date has been set to [December 1st](https://blog.ethereum.org/2020/11/04/eth2-quick-update-no-19/). This page will be updated nearer the time. **Pyrmont**
To connect your validator to the Pyrmont testnet, from the `nimbus-eth2` repository run: To connect your validator to the Pyrmont testnet, from the `nimbus-eth2` repository run:
@ -8,12 +8,21 @@ To connect your validator to the Pyrmont testnet, from the `nimbus-eth2` reposit
./run-pyrmont-beacon-node.sh ./run-pyrmont-beacon-node.sh
``` ```
You'll be asked to enter your [Web3 provider URL](./start-syncing.md#web3-provider-url) again. **Mainnet**
To connect your validator to mainnet, from the `nimbus-eth2` repository run:
```
./run-mainnet-beacon-node.sh
```
In both cases, you'll be asked to enter your [Web3 provider URL](./start-syncing.md#web3-provider-url) again.
> **Note:** If your beacon node is already running, you'll need to shut it down gracefully (`Ctrl+c`) and re-run the above command. > **Note:** If your beacon node is already running, you'll need to shut it down gracefully (`Ctrl+c`) and re-run the above command.
This will build Nimbus and its dependencies, and connect your validator the eth2 network. Your beacon node will launch and connect your validator the eth2 network. To check that this has happened correctly, check your logs for the following:
You should see that the beacon node has launched with your validator attached:
``` ```
INF 2020-11-18 11:20:00.181+01:00 Launching beacon node INF 2020-11-18 11:20:00.181+01:00 Launching beacon node

2
docs/the_nimbus_book/src/deposit.md
View File

@ -45,5 +45,5 @@ It's a good idea to bookmark this page.
## Expected waiting time (the queue) ## Expected waiting time (the queue)
Once you send off your transaction(s), your validator will be put in a queue based on deposit time. Getting through the queue may take a few hours or days (assuming the chain is finalising). No validators are accepted into the validator set while the chain isn't finalising. Once you send off your transaction(s), your validator will be put in a queue based on deposit time. Getting through the queue may take a few hours or days (assuming the chain is finalising). No validators are accepted into the validator set while the chain isn't finalising.
*If you've made a mainnet deposit, your validator will be activated when mainnet launches, regardless of how many deposits are made before then: this will in all likelihood be **Dec 1st 2020, 12pm UTC*** *If you've made a mainnet deposit, your validator will be activated when mainnet launches, regardless of how many deposits are made before then: this will be **Dec 1st 2020, 12pm UTC***

2
docs/the_nimbus_book/src/eth2-stats.md
View File

@ -1,6 +1,6 @@
# Network stats and monitoring # Network stats and monitoring
> ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. If you have made a mainnet deposit, you do not need to connect to eth2 quite yet. Mainnet [Genesis](https://hackmd.io/@benjaminion/genesis) date has been set to [December 1st](https://blog.ethereum.org/2020/11/04/eth2-quick-update-no-19/). This page will be updated nearer the time. > ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. This page will be updated for mainnet very soon.
eth2stats is a network monitoring suite for your beacon node + validator client. eth2stats is a network monitoring suite for your beacon node + validator client.

7
docs/the_nimbus_book/src/graffiti.md
View File

@ -2,10 +2,15 @@
You can use your validator client's graffiti flag to add a personal touch to your proposed blocks (some text of your choice). You will be able to see it using the block explorer. You can use your validator client's graffiti flag to add a personal touch to your proposed blocks (some text of your choice). You will be able to see it using the block explorer.
To do so on Pyrmont, run: To do so on **Pyrmont**, run:
``` ```
./run-pyrmont-beacon-node.sh --graffiti="<YOUR_GRAFFITI>" ./run-pyrmont-beacon-node.sh --graffiti="<YOUR_GRAFFITI>"
``` ```
To do so on **Mainnet**, run:
```
./run-mainnet-beacon-node.sh --graffiti="<YOUR_GRAFFITI>"
```

9
docs/the_nimbus_book/src/infura-guide.md
View File

@ -47,19 +47,22 @@ You'll be directed to the settings page of your newly created project
![](https://i.imgur.com/kx3R8XS.png) ![](https://i.imgur.com/kx3R8XS.png)
### 6. View Görli endpoints ### 6. Select endpoint
In the `KEYS` section, click on the dropdown menu to the right of `ENDPOINTS`, and select `GÖRLI` > ⚠️ **Warning:** if you're connecting to mainnet, you should skip this step
If you're connecting to a testnet, in the `KEYS` section, click on the dropdown menu to the right of `ENDPOINTS`, and select `GÖRLI`
![](https://i.imgur.com/D9186kv.png) ![](https://i.imgur.com/D9186kv.png)
### 7. Copy the websocket endpoint ### 7. Copy the websocket endpoint
Copy the address that starts with `wss://` Copy the address that starts with `wss://`
![](https://i.imgur.com/fZ6Bcjy.png) ![](https://i.imgur.com/fZ6Bcjy.png)
> ⚠️ **Warning:** make sure you've copied the endpoint that starts with`wss` (websocket), and not the `https` endpoint. > ⚠️ **Warning:** make sure you've copied the endpoint that starts with`wss` (websocket), and not the `https` endpoint. If you're connecting to mainnet this will read `wss://mainnet.infura.io/ws/...`
### 8. Run the beacon node ### 8. Run the beacon node

2
docs/the_nimbus_book/src/keep-an-eye.md
View File

@ -13,8 +13,6 @@ You can even create an account ([testnet link](https://pyrmont.beaconcha.in/regi
------------------------------- -------------------------------
> ⚠️ The rest of this page concerns the Pyrmont testnet only. If you have made a mainnet deposit, you do not need to run Nimbus quite yet. Mainnet [Genesis](https://hackmd.io/@benjaminion/genesis) date has been set to [December 1st](https://blog.ethereum.org/2020/11/04/eth2-quick-update-no-19/). This page will be updated nearer the time.
## Make sure your validator is attached ## Make sure your validator is attached
On startup, you should see a log message that reads `Local validator attached`. This has a `pubKey` field which should the public key of your validator. On startup, you should see a log message that reads `Local validator attached`. This has a `pubKey` field which should the public key of your validator.

14
docs/the_nimbus_book/src/keys.md
View File

@ -1,17 +1,19 @@
# Import your keys # Import your keys
> ⚠️ This page concerns the **Pyrmont** testnet only. If you have made a mainnet deposit, you do not need to import your keys into Nimbus quite yet.
To import your signing key(s) into Nimbus, from the `nimbus-eth2` directory run: To import your signing key(s) into Nimbus, from the `nimbus-eth2` directory run:
**Pyrmont**
``` ```
build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0 "<YOUR VALIDATOR KEYS DIRECTORY>" build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
``` ```
**Mainnet**
```
build/nimbus_beacon_node deposits import --data-dir=build/data/shared_mainnet_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
```
Replacing `<YOUR VALIDATOR KEYS DIRECTORY>` with the full pathname of the `validator_keys` directory that was created when you generated your keys using the [Pyrmont Launchpad](https://pyrmont.launchpad.ethereum.org/) [command line app](https://github.com/ethereum/eth2.0-deposit-cli/releases/). Replacing `<YOUR VALIDATOR KEYS DIRECTORY>` with the full pathname of the `validator_keys` directory that was created when you generated your keys using the [command line app](https://github.com/ethereum/eth2.0-deposit-cli/releases/).
> **Tip:** run `pwd` in your `validator_keys` directory to print the full pathname to the console (if you're on Windows, run `cd` instead). > **Tip:** run `pwd` in your `validator_keys` directory to print the full pathname to the console (if you're on Windows, run `cd` instead).
@ -21,7 +23,7 @@ build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0
## Storage ## Storage
When you import your keys into Nimbus, your validator signing key(s) are stored in the `build/data/shared_pyrmont_0/` folder, under `secrets` and `validators` - **make sure you keep these folders backed up somewhere safe.** When you import your keys into Nimbus, your validator signing key(s) are stored in the `build/data/shared_<TESTNET OR MAINNET>_0/` folder, under `secrets` and `validators` - **make sure you keep these folders backed up somewhere safe.**
The `secrets` folder contains the common secret that gives you access to all your validator keys. The `secrets` folder contains the common secret that gives you access to all your validator keys.