From d0c743e6c47f92cc43987e0a1a80c73d55fafd4d Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Mon, 7 Dec 2020 16:38:34 +0100 Subject: [PATCH] Quickstart guide + updates --- docs/the_nimbus_book/src/SUMMARY.md | 8 +-- docs/the_nimbus_book/src/deposit.md | 2 +- docs/the_nimbus_book/src/install.md | 57 +++++++++++++++++++ docs/the_nimbus_book/src/keys.md | 2 +- docs/the_nimbus_book/src/quick-start.md | 76 +++++++++++++++++++++++++ 5 files changed, 139 insertions(+), 6 deletions(-) create mode 100644 docs/the_nimbus_book/src/quick-start.md diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index bfa45565b..3eda45c89 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -2,10 +2,10 @@ - [Introduction](./intro.md) - [Philosophy]() - [System requirements](./hardware.md) -- [Quick start]() +- [Run just the beacon node (quickstart)](./quick-start.md) # Raspberry Pi -- [Run your node on a Raspberry Pi](./pi-guide.md) +- [Validating with a Raspberry Pi](./pi-guide.md) - [Mainnet advice](./pi-guide-mainnet.md) # How-to @@ -13,8 +13,8 @@ - [Build the beacon node](./build.md) - [Run an eth1 node](./eth1.md) - [Sync the beacon node](./start-syncing.md) -- [Make a deposit](./deposit.md) -- [Import your keys](./keys.md) +- [Make a deposit for your validator](./deposit.md) +- [Import your validator keys](./keys.md) - [Connect your validator to eth2](./connect-eth2.md) - [Keep an eye on your validator](./keep-an-eye.md) - [Keep Nimbus updated](./keep-updated.md) diff --git a/docs/the_nimbus_book/src/deposit.md b/docs/the_nimbus_book/src/deposit.md index d574c4e73..2df040932 100644 --- a/docs/the_nimbus_book/src/deposit.md +++ b/docs/the_nimbus_book/src/deposit.md @@ -1,4 +1,4 @@ -# Make a deposit +# Make a deposit for your validator The easiest way to get your deposit in is to follow the Ethereum Foundation's launchpad instructions here: **Testnet**: diff --git a/docs/the_nimbus_book/src/install.md b/docs/the_nimbus_book/src/install.md index 098e47b1b..488eb270f 100644 --- a/docs/the_nimbus_book/src/install.md +++ b/docs/the_nimbus_book/src/install.md @@ -46,6 +46,63 @@ Assuming you use [Homebrew](https://brew.sh/) to manage packages ```sh brew install cmake ``` +# Quick start + +This page takes you through how to run just the beacon node without a validator attached. + +Running just a beacon node can help improve the anonymity properties of the network as a whole. + +### 1. Install dependencies + +You'll need to install some packages (`git`) in order for Nimbus to run correctly. + +To do so, run: +``` +sudo apt-get install git + +``` + +### 2. Clone the Nimbus repository + +Run the following command to clone the [nimbus-eth2 repository](https://github.com/status-im/nimbus-eth2): + +``` +git clone https://github.com/status-im/nimbus-eth2 +``` + +### 3. Build the beacon node + +Change into the directory and build the beacon node. +``` +cd nimbus-eth2 +make nimbus_beacon_node +``` + +*Patience... this may take a few minutes.* + +### 4. Connect to mainnet + +To connect to mainnet, run: +``` +./run-mainnet-beacon-node.sh +``` + +You'll be prompted to enter a web3-provider url: + +``` +To monitor the Eth1 validator deposit contract, you'll need to pair +the Nimbus beacon node with a Web3 provider capable of serving Eth1 +event logs. This could be a locally running Eth1 client such as Geth +or a cloud service such as Infura. For more information please see +our setup guide: + +https://status-im.github.io/nimbus-eth2/eth1.html + +Please enter a Web3 provider URL: +``` + +Press enter to skip (this is only important when you're running a validator). + ### Windows diff --git a/docs/the_nimbus_book/src/keys.md b/docs/the_nimbus_book/src/keys.md index b66dfa6d8..eac5f37c1 100644 --- a/docs/the_nimbus_book/src/keys.md +++ b/docs/the_nimbus_book/src/keys.md @@ -1,4 +1,4 @@ -# Import your keys +# Import your validator keys 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: diff --git a/docs/the_nimbus_book/src/quick-start.md b/docs/the_nimbus_book/src/quick-start.md new file mode 100644 index 000000000..50d397624 --- /dev/null +++ b/docs/the_nimbus_book/src/quick-start.md @@ -0,0 +1,76 @@ +# Run just the beacon node (quickstart) + +This page takes you through how to run just the beacon node without a validator attached. + +Running a beacon node without a validator attached can help improve the anonymity properties of the network as a whole. + +## 1. Install dependencies + +You'll need to install some packages in order for Nimbus to run correctly. + + +**Linux** + +On common Linux distributions the dependencies can be installed with + +```sh +# Debian and Ubuntu +sudo apt-get install build-essential git + +# Fedora +dnf install @development-tools + +# Archlinux, using an AUR manager +yourAURmanager -S base-devel +``` + +**macOS** + +Assuming you use [Homebrew](https://brew.sh/) to manage packages: + +```sh +brew install cmake +``` + + +## 2. Clone the Nimbus repository + +Run the following command to clone the [nimbus-eth2 repository](https://github.com/status-im/nimbus-eth2): + +``` +git clone https://github.com/status-im/nimbus-eth2 +``` + +## 3. Build the beacon node + +Change into the directory and build the beacon node. +``` +cd nimbus-eth2 +make nimbus_beacon_node +``` + +*Patience... this may take a few minutes.* + +## 4. Connect to mainnet + +To connect to mainnet, run: +``` +./run-mainnet-beacon-node.sh +``` + +You'll be prompted to enter a web3-provider url: + +``` +To monitor the Eth1 validator deposit contract, you'll need to pair +the Nimbus beacon node with a Web3 provider capable of serving Eth1 +event logs. This could be a locally running Eth1 client such as Geth +or a cloud service such as Infura. For more information please see +our setup guide: + +https://status-im.github.io/nimbus-eth2/eth1.html + +Please enter a Web3 provider URL: +``` + +Press enter to skip (this is only important when you're running a validator). +