From 74da6181ee74bff3d3c83bf4ce031fc1e700362a Mon Sep 17 00:00:00 2001 From: Sacha Saint-Leger Date: Mon, 30 Nov 2020 02:13:47 +0100 Subject: [PATCH] Updates (#2108) --- docs/the_nimbus_book/src/SUMMARY.md | 2 +- docs/the_nimbus_book/src/keys.md | 32 +++++++++++++++------- docs/the_nimbus_book/src/preparation.md | 3 ++ docs/the_nimbus_book/src/voluntary-exit.md | 24 ++++++++++++++++ 4 files changed, 50 insertions(+), 11 deletions(-) create mode 100644 docs/the_nimbus_book/src/voluntary-exit.md diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index e5120464e..9b4375840 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -20,9 +20,9 @@ - [Raspberry Pi: Mainnet advice](./pi-guide-mainnet.md) - [Graffiti the blockchain](./graffiti.md) - [Your own Infura endpoint](infura-guide.md) +- [Perform a voluntary exit](voluntary-exit.md) - [Run just the beacon node]() - [Switch between clients]() -- [Useful pre-genesis checks]() # Volume 3 - [Advanced options]() - [Windows users]() diff --git a/docs/the_nimbus_book/src/keys.md b/docs/the_nimbus_book/src/keys.md index 76b0098af..b66dfa6d8 100644 --- a/docs/the_nimbus_book/src/keys.md +++ b/docs/the_nimbus_book/src/keys.md @@ -1,22 +1,34 @@ # Import your keys -To import your signing key(s) into Nimbus, from the `nimbus-eth2` directory run: - +To import your signing key(s) into Nimbus, copy the `validator_keys` directory -- the directory that was created for you when you generated your keys -- into `nimbus-eth2`. Then run: **Pyrmont** ``` -build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0 "" - ``` - - **Mainnet** - ``` -build/nimbus_beacon_node deposits import --data-dir=build/data/shared_mainnet_0 "" +build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0 ``` - - Replacing `` 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/). + +**Mainnet** +``` +build/nimbus_beacon_node deposits import --data-dir=build/data/shared_mainnet_0 +``` + +>**Note:** You can also specify a different path to your validator_keys directory as follows: +> +>*Pyrmont* +>``` +>build/nimbus_beacon_node deposits import --data-dir=build/data/shared_pyrmont_0 "" +> ``` +> +> *Mainnet* +> ``` +>build/nimbus_beacon_node deposits import --data-dir=build/data/shared_mainnet_0 "" +>``` +> +> Replacing `` 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). + You'll be asked to enter the password you created to encrypt your keystore(s). Don't worry, this is entirely normal. Your validator client needs both your signing keystore(s) and the password encrypting it to import your [key](https://blog.ethereum.org/2020/05/21/keys/) (since it needs to decrypt the keystore in order to be able to use it to sign on your behalf). diff --git a/docs/the_nimbus_book/src/preparation.md b/docs/the_nimbus_book/src/preparation.md index 25bcfdaef..23259d26b 100644 --- a/docs/the_nimbus_book/src/preparation.md +++ b/docs/the_nimbus_book/src/preparation.md @@ -32,3 +32,6 @@ To avoid exposing your validator identity to the network, we recommend you use a Ad a final check, we recommend you also go through the EF'S [staker checklist](https://launchpad.ethereum.org/checklist). +## Email notifications + +You can use [beaconcha.in](https://beaconcha.in/) to set up email notifications in case your validator goes offline. diff --git a/docs/the_nimbus_book/src/voluntary-exit.md b/docs/the_nimbus_book/src/voluntary-exit.md new file mode 100644 index 000000000..f1b9aebed --- /dev/null +++ b/docs/the_nimbus_book/src/voluntary-exit.md @@ -0,0 +1,24 @@ +# Perform a voluntary exit + +> ⚠️ : Voluntary exits are **irreversible**. You won't be able to validate again with the same key. And you won't be able to withdraw your stake until the Eth1 and Eth2 merge. *Note that voluntary exits won't be processed if the chain isn't finalising.* + +To perform a voluntary exit, with your beacon node running, run: + +**Pyrmont** + + +``` +build/nimbus_beacon_node deposits exit --validator= --data-dir=build/data/shared_pyrmont_0 + +``` + +**Mainnet** + +``` +build/nimbus_beacon_node deposits exit --validator= --data-dir=build/data/shared_mainnet_0 +``` + +> **Note:** Make sure your `` is prefixed with `0x`. In other words the public key should look like `0x95e3...` + + +