Repository: SomerEsat/ethereum-staking-guides Branch: master Commit: 73bfff141ca5 Files: 4 Total size: 65.1 KB Directory structure: gitextract_1e8x451f/ ├── ChangeLogArchive.md ├── LICENSE ├── README.md └── UbuntuPrysmTopaz.md ================================================ FILE CONTENTS ================================================ ================================================ FILE: ChangeLogArchive.md ================================================ # Ethereum Staking Guides - Change Log Archive# ## Mainnet Staking Guides ## | Guide | Change Log *(dd-mm-yy)* | | :--------- | :---------- | | [Ubuntu/Lighthouse](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-lighthouse-773f5d982e03) | *12-11-23* - Updated Nethermind service config to specify new binary name.
*12-11-23* - Fixed various broken links and updated all clients to latest version.
*20-05-23* - Added [link](https://validator-queue-monitoring.vercel.app/) to validator queue.
*09-04-23* - Updated all clients to latest version.
*09-04-23* - Added `--db.engine pebble` flag for Geth.
*09-04-23* - Added instructions for `--eth1_withdrawal_address` for new and existing mnemonic.
*21-03-23* - Updated Lighthouse release to 3.5.1.
*21-03-23* - Updated Requirements to 16GB RAM minimum.
*21-03-23* - Updated Besu release to 23.1.1.
*21-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Besu client config.
*10-02-23* - Removed incorrectly placed `=` sign in flag description. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/8) for details.
*19-11-22* - Added `TimeoutStopSec=600` to Geth config. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/6) for details.
*14-11-22* - Added required flag `--externalcl` to Erigon config.
*18-10-22* - Replaced Infura with [Checkpoint Sync Endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
*08-10-22* - Added `--prune-payloads` to Lighthouse service config.
*08-10-22* - Added `--logfile-max-number` & `--logfile-max-size` to Lighthouse service config.
*08-10-22* - Added `--Xplugin-rocksdb-high-spec-enabled` to Besu service config.
*08-10-22* - Added graffiti max 32 char limit note.
*08-10-22* - Removed section on merge.
*08-10-22* - Updated Besu, Erigon, Nethermind client versions.
*17-09-22* - Updated Erigon release to 2022.09.02.
*17-09-22* - Updated Geth release to 1.10.25.
*17-09-22* - Updated Nethermind release to 1.14.2.
*11-09-22* - Updated Besu service config to use 4GB RAM (-Xmx4g).
*08-09-22* - Updated Besu release to 22.7.2.
*08-09-22* - Updated Nethermind release to 1.14.1.
*06-09-22* - Updated Erigon release to 2022.09.01.
*01-09-22* - Updated Lighthouse release to 3.1.0.
*28-08-22* - Updated Erigon release to 2022-08-03-Alpha.
*27-08-22* - Added missing `chown` step.
*24-08-22* - Updated Geth release to 1.10.23.
*24-08-22* - Added link to the [supplementary guide](https://someresat.medium.com/supplementary-guide-to-staking-on-ethereum-for-existing-stakers-57493678a460).
*23-08-22* - Added "A Note on the Merge" section.
*22-08-22* - Merge-Ready version published.
*26-11-20* - Beacon Chain Genesis version published. | | [Ubuntu/Lodestar](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-lodestar-193a2553a161) |
*12-11-23* - Updated Nethermind service config to specify new binary name.
*12-11-23* - Fixed various broken links and updated all clients to latest version.
*20-05-23* - Added [link](https://validator-queue-monitoring.vercel.app/) to validator queue.
*09-04-23* - Updated all clients to latest version.
*09-04-23* - Added `--db.engine pebble` flag for Geth.
*09-04-23* - Added instructions for `--eth1_withdrawal_address` for new and existing mnemonic.
*04-04-23* - Updated NodeJS version to 18.15 (LTS). Added `--check-files` flag to yarn install.
*21-03-23* - Updated Requirements to 16GB RAM minimum.
*21-03-23* - Updated Besu release to 23.1.1.
*21-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Besu client config.
*19-11-22* - Added `TimeoutStopSec=600` to Geth config. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/6) for details.
*14-11-22* - Added required flag `--externalcl` to Erigon config.
*18-10-22* - Replaced Infura with [Checkpoint Sync Endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
*08-10-22* - Added `--Xplugin-rocksdb-high-spec-enabled` to Besu service config.
*08-10-22* - Added graffiti max 32 char limit note.
*08-10-22* - Removed section on merge.
*08-10-22* - Updated Besu, Erigon, Nethermind client versions.
*17-09-22* - Updated Erigon release to 2022.09.02.
*17-09-22* - Updated Geth release to 1.10.25.
*17-09-22* - Updated Nethermind release to 1.14.2.
*11-09-22* - Updated Besu service config to use 4GB RAM (-Xmx4g).
*08-09-22* - Updated Nimbus release to 22.9.0.
*08-09-22* - Updated Besu release to 22.7.2.
*08-09-22* - Updated Nethermind release to 1.14.1.
*06-09-22* - Updated Erigon release to 2022.09.01.
*01-09-22* - Updated Nimbus release to 22.8.2.
*30-08-22* - Updated Nimbus release to 22.8.1.
*28-08-22* - Updated Erigon release to 2022-08-03-Alpha.
*24-08-22* - Updated Geth release to 1.10.23.
*24-08-22* - Added link to the [supplementary guide](https://someresat.medium.com/supplementary-guide-to-staking-on-ethereum-for-existing-stakers-57493678a460).
*23-08-22* - Added "A Note on the Merge" section.
*22-08-22* - Merge-Ready version published.
*26-11-20* - Beacon Chain Genesis version published. | | [Ubuntu/Nimbus](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-nimbus-31f56657ea8f) |
*12-11-23* - Updated Nethermind service config to specify new binary name.
*12-11-23* - Fixed various broken links and updated all clients to latest version.
*20-05-23* - Added [link](https://validator-queue-monitoring.vercel.app/) to validator queue.
*09-04-23* - Updated all clients to latest version.
*09-04-23* - Added `--db.engine pebble` flag for Geth.
*09-04-23* - Added instructions for `--eth1_withdrawal_address` for new and existing mnemonic.
*21-03-23* - Updated Requirements to 16GB RAM minimum.
*21-03-23* - Updated Besu release to 23.1.1.
*21-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Besu client config.
*19-11-22* - Added `TimeoutStopSec=600` to Geth config. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/6) for details.
*14-11-22* - Added required flag `--externalcl` to Erigon config.
*18-10-22* - Updated Nimbus logo and release to 22.10.1.
*18-10-22* - Replaced Infura with [Checkpoint Sync Endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
*08-10-22* - Added `--Xplugin-rocksdb-high-spec-enabled` to Besu service config.
*08-10-22* - Added graffiti max 32 char limit note.
*08-10-22* - Removed section on merge.
*08-10-22* - Updated Besu, Erigon, Nethermind client versions.
*17-09-22* - Updated Erigon release to 2022.09.02.
*17-09-22* - Updated Geth release to 1.10.25.
*17-09-22* - Updated Nethermind release to 1.14.2.
*11-09-22* - Updated Besu service config to use 4GB RAM (-Xmx4g).
*08-09-22* - Updated Nimbus release to 22.9.0.
*08-09-22* - Updated Besu release to 22.7.2.
*08-09-22* - Updated Nethermind release to 1.14.1.
*06-09-22* - Updated Erigon release to 2022.09.01.
*01-09-22* - Updated Nimbus release to 22.8.2.
*30-08-22* - Updated Nimbus release to 22.8.1.
*28-08-22* - Updated Erigon release to 2022-08-03-Alpha.
*24-08-22* - Updated Geth release to 1.10.23.
*24-08-22* - Added link to the [supplementary guide](https://someresat.medium.com/supplementary-guide-to-staking-on-ethereum-for-existing-stakers-57493678a460).
*23-08-22* - Added "A Note on the Merge" section.
*22-08-22* - Merge-Ready version published.
*26-11-20* - Beacon Chain Genesis version published. | | [Ubuntu/Prysm](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-prysm-581fb1969460) |
*12-11-23* - Updated Nethermind service config to specify new binary name.
*12-11-23* - Fixed various broken links and updated all clients to latest version.
*20-05-23* - Added [link](https://validator-queue-monitoring.vercel.app/) to validator queue.
*09-04-23* - Updated all clients to latest version.
*09-04-23* - Added `--db.engine pebble` flag for Geth.
*09-04-23* - Added instructions for `--eth1_withdrawal_address` for new and existing mnemonic.
*21-03-23* - Updated Requirements to 16GB RAM minimum.
*21-03-23* - Updated Besu release to 23.1.1.
*21-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Besu client config.
*19-11-22* - Added `TimeoutStopSec=600` to Geth config. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/6) for details.
*14-11-22* - Added required flag `--externalcl` to Erigon config.
*18-10-22* - Replaced Infura with [Checkpoint Sync Endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
*08-10-22* - Added `--Xplugin-rocksdb-high-spec-enabled` to Besu service config.
*08-10-22* - Added graffiti max 32 char limit note.
*08-10-22* - Removed section on merge.
*08-10-22* - Updated Besu, Erigon, Nethermind client versions.
*17-09-22* - Updated Erigon release to 2022.09.02.
*17-09-22* - Updated Geth release to 1.10.25.
*17-09-22* - Updated Nethermind release to 1.14.2.
*11-09-22* - Updated Besu service config to use 4GB RAM (-Xmx4g).
*08-09-22* - Updated Besu release to 22.7.2.
*08-09-22* - Updated Nethermind release to 1.14.1.
*06-09-22* - Updated Erigon release to 2022.09.01.
*05-09-22* - Updated Prysm release to 3.1.0.
*28-08-22* - Updated Erigon release to 2022-08-03-Alpha.
*27-08-22* - Added missing `chown` step.
26-08-22 - Added `suggested-fee-recipient` to validator config.
*24-08-22* - Updated Geth release to 1.10.23.
*24-08-22* - Added link to the [supplementary guide](https://someresat.medium.com/supplementary-guide-to-staking-on-ethereum-for-existing-stakers-57493678a460).
*23-08-22* - Replaced `--http-web3provider` with `--execution-endpoint`.
*23-08-22* - Added "A Note on the Merge" section.
*22-08-22* - Merge-Ready version published.
*27-11-20* - Beacon Chain Genesis version published. | | [Ubuntu/Teku](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-teku-f09ecd9ef2ee) |
*12-11-23* - Updated Nethermind service config to specify new binary name.
*12-11-23* - Fixed various broken links and updated all clients to latest version.
*18-07-23* - Updated Teku client prerequisite to Java 17 for install and update.
*20-05-23* - Added [link](https://validator-queue-monitoring.vercel.app/) to validator queue.
*09-04-23* - Updated all clients to latest version.
*09-04-23* - Added `--db.engine pebble` flag for Geth.
*09-04-23* - Added instructions for `--eth1_withdrawal_address` for new and existing mnemonic.
*21-03-23* - Updated Requirements to 16GB RAM minimum.
*21-03-23* - Updated Besu release to 23.1.1.
*21-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Besu client config.
*20-03-23* - Updated `JAVA_OPTS=-Xmx3g` to `-Xmx5g` on Teku client config at request of Teku Team.
*19-11-22* - Added `TimeoutStopSec=600` to Geth config. See [here](https://github.com/SomerEsat/ethereum-staking-guides/issues/6) for details.
*14-11-22* - Added required flag `--externalcl` to Erigon config.
*18-10-22* - Replaced Infura with [Checkpoint Sync Endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
*08-10-22* - Added `--Xplugin-rocksdb-high-spec-enabled` to Besu service config.
*08-10-22* - Added graffiti max 32 char limit note.
*08-10-22* - Removed section on merge.
*08-10-22* - Updated Besu, Erigon, Nethermind client versions.
*19-09-22* - Updated Teku release to 22.9.1.
*17-09-22* - Updated Erigon release to 2022.09.02.
*17-09-22* - Updated Geth release to 1.10.25.
*17-09-22* - Updated Nethermind release to 1.14.2.
*11-09-22* - Updated Besu service config to use 4GB RAM (-Xmx4g).
*08-09-22* - Updated Besu release to 22.7.2.
*08-09-22* - Updated Nethermind release to 1.14.1.
*06-09-22* - Updated Erigon release to 2022.09.01.
*01-09-22* - Updated Teku release to 22.9.0.
*30-08-22* - Updated Teku release to 22.8.2.
*28-08-22* - Updated Erigon release to 2022-08-03-Alpha.
*24-08-22* - Updated Geth client version to 1.10.23.
*24-08-22* - Added link to the [supplementary guide](https://someresat.medium.com/supplementary-guide-to-staking-on-ethereum-for-existing-stakers-57493678a460).
*23-08-22* - Added "A Note on the Merge" section.
*22-08-22* - Merge-Ready version published.
*26-11-20* - Beacon Chain Genesis version published. |
## Goerli Testnet Staking Guides ## | Guide | Change Log *(dd-mm-yy)* | | :---- | :--------- | | [Ubuntu/Lighthouse](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-g%C3%B6erli-lighthouse-8d0a2a811e6e) | Published 06-08-22, Updated 19-11-22 | | [Ubuntu/Lodestar](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-goerli-lodestar-f3c8f77e7097) | Published 10-09-22, Updated 19-11-22 | | [Ubuntu/Prysm](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-goerli-prysm-4a640794e8b5) | Published 07-08-22, Updated 19-11-22 | | [Ubuntu/Nimbus](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-goerli-nimbus-3b0e2c0c6e0e) | Published 06-08-22, Updated 19-11-22 | | [Ubuntu/Teku](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-g%C3%B6erli-teku-6512b26f1372) | Published 06-08-22, Updated 19-11-22 |
## Mainnet Migration Guides (Not Merge Ready - Updates Pending) ## | Guide | Change Log *(dd-mm-yy)* | | :---- | :--------- | | [Series Introduction](https://someresat.medium.com/ethereum-staker-migration-guides-introduction-45505079b1f0) | Published 12-04-22 | | [Migrating from Prysm to Nimbus](https://someresat.medium.com/ethereum-staker-migration-guide-migrating-from-prysm-to-nimbus-b802a7dcb31e) (NOT Merge Ready)| Published 11-05-22 | | Migrating from Prysm to Teku - coming soon! | | | Migrating from Prysm to Lodestar - coming soon! | | | Migrating from Prysm to Lighthouse - coming soon! | | | Series Conclusion - coming soon! | | ================================================ FILE: LICENSE ================================================ GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ================================================ FILE: README.md ================================================ # Ethereum Staking Guides # ## Introduction ## Welcome! If you would like to become a solo staker, the **gold standard** for staking on the Ethereum network, then these guides are for you! Required is a machine running Ubuntu (22.04 LTS or newer) with a modern CPU, 16GB RAM (32GB is better) and a good quality 2TB SSD (4TB is better). To get started, go to one of the [**Mainnet Staking Guides**](https://github.com/SomerEsat/ethereum-staking-guides#mainnet-staking-guides) below. If you're not sure which client to use, go with the one that has the lowest share. See here: https://clientdiversity.org. The guides below are named after the major **Consensus Clients** (Lighthouse, Lodestar, Prysm, Nimbus, and Teku) so you'll have to choose that one first. Each guide then contains instructions for installing an **Execution Client** which is required for staking as well. Again, it is recommended that you choose the one with the lowest share. Finally, be aware that there may be a queue to start validating on the mainnet. Check here: https://validator-queue-monitoring.vercel.app. Somer Esat
## Mainnet Staking Guides ## Use these guides for staking on the Ethereum mainnet. | Guide | Change Log *(dd-mm-yy)* | | :--------- | :---------- | | [Lighthouse](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-lighthouse-773f5d982e03) |
*27-11-25* - Updated deposit CLI to EthStaker version.
*27-11-25* - Added section to explain the difference between compounding and regular validators.
*27-11-25* - Updated Linux OS version. Fixed broken links.
*20-08-24* - Added Reth Execution Client.
*18-08-24* - Updated Lighthouse client to 5.3.0.
*19-06-24* - Updated Lighthouse client to 5.2.0.
*18-06-24* - Updated Besu client to 24.5.4.
*09-06-24* - Updated Nethermind config to add Pruning flags.
*09-06-24* - Updated Nethermind config to remove Sync.AncientBodies/Receipts flags.
*09-06-24* - Updated Nethermind client to 1.26.0.
*09-06-24* - Updated Geth client to 1.14.5.
*09-06-24* - Updated Erigon client to 2.6.1.
*02-06-24* - Updated Erigon client to 2.6.0.
*02-06-24* - Removed Erigon deprecated config flag --externalcl per [Issue 13](https://github.com/SomerEsat/ethereum-staking-guides/issues/13).
*02-06-24* - Updated Erigon config to use the prebuilt binary.
*02-06-24* - Removed redundant Erigon prerequisites.
*30-05-24* - Updated Besu client to 24.5.2 and fixed broken links in Besu config flags section.
*30-05-24* - Updated Besu config to rename X_SNAP to SNAP per [#6405](https://github.com/hyperledger/besu/pull/6405).
*30-05-24* - Updated Besu prerequisites to require Java Runtime v21 (headless).
*14-04-24* - Added table of contents.
*14-04-24* - Increased Ubuntu Server Version to 22.04.
See [Change Log Archive](https://github.com/SomerEsat/ethereum-staking-guides/blob/master/ChangeLogArchive.md). | | [Lodestar](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-lodestar-193a2553a161) |
*27-11-25* - Updated deposit CLI to EthStaker version.
*27-11-25* - Added section to explain the difference between compounding and regular validators.
*27-11-25* - Updated Linux OS version. Fixed broken links.
*20-08-24* - Added Reth Execution Client.
*11-08-24* - Fixed incorrect link to Lodestar releases.
*18-06-24* - Removed redundant Lodestar prerequisites (NodeJS and build-essential).
*18-06-24* - Updated Lodestar config to use the prebuilt binary.
*18-06-24* - Updated Lodestar client to 1.19.0.
*18-06-24* - Updated Besu client to 24.5.4.
*18-06-24* - Updated Nethermind config to add Pruning flags.
*18-06-24* - Updated Nethermind config to remove Sync.AncientBodies/Receipts flags.
*18-06-24* - Updated Nethermind client to 1.26.0.
*18-06-24* - Updated Geth client to 1.14.5.
*18-06-24* - Updated Erigon client to 2.6.1.
*02-06-24* - Updated Erigon client to 2.6.0.
*02-06-24* - Removed Erigon deprecated config flag --externalcl per [Issue 13](https://github.com/SomerEsat/ethereum-staking-guides/issues/13).
*02-06-24* - Updated Erigon config to use the prebuilt binary.
*02-06-24* - Removed redundant Erigon prerequisites.
*30-05-24* - Updated Besu client to 24.5.2 and fixed broken links in Besu config flags section.
*30-05-24* - Updated Besu config to rename X_SNAP to SNAP per [#6405](https://github.com/hyperledger/besu/pull/6405).
*30-05-24* - Updated Besu prerequisites to require Java Runtime v21 (headless).
*27-04-24* - Added table of contents.
*27-04-24* - Increased Ubuntu Server Version to 22.04.
See [Change Log Archive](https://github.com/SomerEsat/ethereum-staking-guides/blob/master/ChangeLogArchive.md). | | [Prysm](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-prysm-581fb1969460) |
*27-11-25* - Updated deposit CLI to EthStaker version.
*27-11-25* - Added section to explain the difference between compounding and regular validators.
*27-11-25* - Updated Linux OS version. Fixed broken links.
*20-08-24* - Added Reth Execution Client.
*24-06-24* - Updated Prysm client to 5.0.4.
*19-06-24* - Updated Prysm client to 5.0.3.
*18-06-24* - Updated Besu client to 24.5.4.
*18-06-24* - Updated Nethermind config to add Pruning flags.
*18-06-24* - Updated Nethermind config to remove Sync.AncientBodies/Receipts flags.
*18-06-24* - Updated Nethermind client to 1.26.0.
*18-06-24* - Updated Geth client to 1.14.5.
*18-06-24* - Updated Erigon client to 2.6.1.
*02-06-24* - Updated Erigon client to 2.6.0.
*02-06-24* - Removed Erigon deprecated config flag --externalcl per [Issue 13](https://github.com/SomerEsat/ethereum-staking-guides/issues/13).
*02-06-24* - Updated Erigon config to use the prebuilt binary.
*02-06-24* - Removed redundant Erigon prerequisites.
*30-05-24* - Updated Besu client to 24.5.2 and fixed broken links in Besu config flags section.
*30-05-24* - Updated Besu config to rename X_SNAP to SNAP per [#6405](https://github.com/hyperledger/besu/pull/6405).
*30-05-24* - Updated Besu prerequisites to require Java Runtime v21 (headless).
*27-04-24* - Added table of contents.
*27-04-24* - Increased Ubuntu Server Version to 22.04.
See [Change Log Archive](https://github.com/SomerEsat/ethereum-staking-guides/blob/master/ChangeLogArchive.md). | | [Nimbus](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-nimbus-31f56657ea8f) |
*27-11-25* - Updated deposit CLI to EthStaker version.
*27-11-25* - Added section to explain the difference between compounding and regular validators.
*27-11-25* - Updated Linux OS version. Fixed broken links.
*20-08-24* - Added Reth Execution Client.
*24-06-24* - Updated Nimbus client to 24.6.0.
*19-06-24* - Updated Nimbus client to 24.5.0.
*18-06-24* - Updated Besu client to 24.5.4.
*18-06-24* - Updated Nethermind config to add Pruning flags.
*18-06-24* - Updated Nethermind config to remove Sync.AncientBodies/Receipts flags.
*18-06-24* - Updated Nethermind client to 1.26.0.
*18-06-24* - Updated Geth client to 1.14.5.
*18-06-24* - Updated Erigon client to 2.6.1.
*02-06-24* - Updated Erigon client to 2.6.0.
*02-06-24* - Removed Erigon deprecated config flag --externalcl per [Issue 13](https://github.com/SomerEsat/ethereum-staking-guides/issues/13).
*02-06-24* - Updated Erigon config to use the prebuilt binary.
*02-06-24* - Removed redundant Erigon prerequisites.
*30-05-24* - Updated Besu client to 24.5.2 and fixed broken links in Besu config flags section.
*30-05-24* - Updated Besu config to rename X_SNAP to SNAP per [#6405](https://github.com/hyperledger/besu/pull/6405).
*30-05-24* - Updated Besu prerequisites to require Java Runtime v21 (headless).
*27-04-24* - Added table of contents.
*27-04-24* - Increased Ubuntu Server Version to 22.04.
See [Change Log Archive](https://github.com/SomerEsat/ethereum-staking-guides/blob/master/ChangeLogArchive.md). | | [Teku](https://someresat.medium.com/guide-to-staking-on-ethereum-ubuntu-teku-f09ecd9ef2ee) |
*27-11-25* - Updated deposit CLI to EthStaker version.
*27-11-25* - Added section to explain the difference between compounding and regular validators.
*27-11-25* - Updated Linux OS version. Fixed broken links.
*20-08-24* - Added Reth Execution Client.
*19-06-24* - Updated Teku prerequisites to require Java Runtime v21 (headless).
*19-06-24* - Updated Teku client to 24.6.0.
*18-06-24* - Updated Besu client to 24.5.4.
*18-06-24* - Updated Nethermind config to add Pruning flags.
*18-06-24* - Updated Nethermind config to remove Sync.AncientBodies/Receipts flags.
*18-06-24* - Updated Nethermind client to 1.26.0.
*18-06-24* - Updated Geth client to 1.14.5.
*18-06-24* - Updated Erigon client to 2.6.1.
*02-06-24* - Updated Erigon client to 2.6.0.
*02-06-24* - Removed Erigon deprecated config flag --externalcl per [Issue 13](https://github.com/SomerEsat/ethereum-staking-guides/issues/13).
*02-06-24* - Updated Erigon config to use the prebuilt binary.
*02-06-24* - Removed redundant Erigon prerequisites.
*30-05-24* - Updated Besu client to 24.5.2 and fixed broken links in Besu config flags section.
*30-05-24* - Updated Besu config to rename X_SNAP to SNAP per [#6405](https://github.com/hyperledger/besu/pull/6405).
*30-05-24* - Updated Besu prerequisites to require Java Runtime v21 (headless).
*18-05-24* - Added table of contents.
*18-05-24* - Increased Ubuntu Server Version to 22.04.
See [Change Log Archive](https://github.com/SomerEsat/ethereum-staking-guides/blob/master/ChangeLogArchive.md). |
## Update Withdrawal Credentials Guide ## Stakers may use this guide to update withdrawal credentials on their validator(s) from 0x00 to 0x01. | Guide | Change Log *(dd-mm-yy)* | | :--------- | :---------- | | [Guide to Configuring
Withdrawal Credentials
on Ethereum](https://someresat.medium.com/guide-to-configuring-withdrawal-credentials-on-ethereum-812dce3193a) |
*14-04-24* - Added table of contents.
*12-11-23* - Fixed various broken links.
*16-04-23* - Fix typo & add extra warning prior to Submit & Broadcast.
*13-04-23* - Various updates to improve readability.
*12-04-23* - Added example Beaconcha.in submit success message.
*11-04-23* - Published. |
## Donations Appreciated ## Somer.eth (0x32B74B90407309F6637245292cd90347DE658A37)
================================================ FILE: UbuntuPrysmTopaz.md ================================================ # Ethereum 2.0 Staking Guide (Ubuntu / Prysm / Topaz)
This is a step-by-step guide to staking on Ethereum 2.0. It is based on the following technologies: - Ubuntu v20.04 (LTS) x64 server ([link](https://ubuntu.com/)) - Prysmatic Labs Ethereum 2.0 client - Prysm ([link](https://prysmaticlabs.com/)) - Prysmatic Labs Topaz Testnet public network - MetaMask crypto wallet browser extension ([link](https://metamask.io/)) - Prometheus metrics ([link](https://prometheus.io/)) - Grafana dashboard ([link](https://grafana.com/)) This guide includes instructions on how to: - Configure a newly running Ubuntu server instance - Install and configue the Prysmatic Labs beacon-chain and validator software - Send validator deposits for staking on the Topaz Testnet - Install and configure Prometheus metrics and set up a Grafana dashboard to view them ### Acknowledgements This guide is based on information I got from various sources. They are listed in the references section at the bottom and this guide wouldn't exist without them. Thank you, all! Thanks also to Prysmatic Labs for their cool software, great documentation, and their assistance with running my own staking setup. ### Disclaimer I'm not an expert in any of the technologies listed in this guide (basically I am a noob). I got it working and it's a lot of fun, so I wanted to share it with others. Please forgive any errors or ill-informed choices. Feedback is appreciated! ### Note for Raspberry Pi Users I haven't tested this guide on a Rpi. If you want to try, just swap out any required softare for the ARM version where available (e.g. Prometheus has an ARM binary available on the download page - replace the amd64 link with that). No guarantee it will work! You can get support on the Prysmatic Labs Discord. ### Prerequisites This guide assumes basic knowledge of Ethereum, ETH, staking, Linux, and MetaMask. Before you get started you will need to have your Ubuntu server instance up and running. For simplicity I used a VM hosted in a virtual public cloud, but a locally hosted instance is also fine. It will help to have the MetaMask browser extension installed and configured. The rest we will do along the way. GLHF! ### Requirements - Ubuntu server instance. I used v20.04 (LTS) x64 server VM. - MetaMask crypto wallet browser extension, installed and configured. - Prysm software [minimum requirements](https://docs.prylabs.network/docs/install/linux/): - Operating System: 64-bit Linux - Processor: Intel Core i5–760 or AMD FX-8100 or better - Memory: 4GB RAM - Storage: 20GB available space SSD - Internet: Broadband connection
## Step 1 - Secure Your System Security is important. This is not a comprehensive security guide, rather just some basic settings: a firewall and a user account. This assumes you have console access to your Ubuntu instance and are logged in as the root user. ### Configure the firewall Ubuntu 20.04 servers can use the default [UFW firewall](https://help.ubuntu.com/community/UFW) to restrict traffic to the server. We need to allow SSH, RDP (for remote desktop connections), Grafana (for metrics), and Prysm (for incoming P2P connections) to connect to the server. Allow SSH - Allows connection to the server over SSH (port 22/TCP). ``` ufw allow 22/tcp ``` Allow Grafana - Allows incoming requests to the Grafana web server (port 3000/TCP): ``` ufw allow 3000/tcp ``` Allow RDP - Allows connection to the server over RDP (port 3389/TCP). This is so we can (optionally) remote into the server and run the Prysm clients (beacon and validator). We will configure a minimal desktop environment for the server below. ``` ufw allow 3389/tcp ``` Or if you want better security you can limit connections to just your local IP address: ``` ufw allow from to any port 22 proto tcp ufw allow from to any port 3389 proto tcp ufw allow from to any port 3000 proto tcp ``` Allow Prysm - Allows P2P connections with peers for actions on the beacon node: > 13000/TCP and 12000/UDP are [recommended](https://docs.prylabs.network/docs/prysm-usage/p2p-host-ip/#incoming-p2p-connection-prerequisites) by Prysmatic Labs. ``` ufw allow 13000/tcp ufw allow 12000/udp ``` Now enable the firewall: ``` ufw enable ``` Check to verify the rules have been correctly configured: ``` ufw status numbered ``` Output should look something like this: ``` Status: Active To Action From -- ------ ---- [ 1] 22/tcp ALLOW IN Anywhere [ 3] 3000/tcp ALLOW IN Anywhere [ 2] 3389/tcp ALLOW IN Anywhere [ 3] 13000/tcp ALLOW IN Anywhere [ 4] 12000/udp ALLOW IN Anywhere ``` ### Create a new user and grant administrative privileges Using the root user to log in is [risky](https://askubuntu.com/questions/16178/why-is-it-bad-to-log-in-as-root). Instead, create a user-level account with admin privileges. ``` adduser ``` You will asked to create a password and some other information. Next, modify the permissions of the new user to grant admin rights to the user by adding them to the sudo group. ``` usermod -aG sudo ``` When you log in as `` you can type sudo before commands to perform actions with superuser privileges.
## Step 2 - Update Your System SSH into your Ubuntu instance with your newly created username and apply the following commands to update the system. ``` sudo apt update && sudo apt upgrade sudo apt dist-upgrade && sudo apt autoremove ```
## Step 3 - Install a lightweight GUI for RDP Not the cleanest approach, but it makes things much easier to visualize. The Prysm beacon and validator services could be run as background services on startup so you don't have to manually start them, however, the validator requires a password, and I'm not sure how to store it in a secure way. Probably via an [ethdo wallet](https://docs.prylabs.network/docs/prysm-usage/wallet-keymanager/). The following will install a lightweight GUI onto the Ubuntu server called [xfce](https://www.xfce.org/). If it gives you the option during setup, select `lightdm`. ``` sudo apt-get -y install xfce4 ``` Next wire up the RDP to the xfce OS. ``` sudo apt-get -y install xrdp sudo systemctl enable xrdp echo xfce4-session >~/.xsession sudo service xrdp restart ``` Now you can RDP into the Ubuntu instance using a RDP client.
## Step 4 - Install Prysm Next we will install the Prysm software which includes a beacon chain and validator. This is done using the Prysm installation script (Prysm.sh). The instructions to do this are on Prysm's [website](https://docs.prylabs.network/docs/install/linux/), and I will summarize the steps here. > It's also possible to build the software yourself using Prysmatic's build tool, [Bazel](https://docs.prylabs.network/docs/install/lin/bazel). ### Pull down the Prysm.sh script and execute the beacon chain ``` cd ~ mkdir prysm && cd prysm curl https://raw.githubusercontent.com/prysmaticlabs/prysm/master/prysm.sh --output prysm.sh && chmod +x prysm.sh ``` Execute the beacon chain. The prysm.sh script will download and run the beacon-chain binary. ``` ./prysm.sh beacon-chain --p2p-host-ip=$(curl -s v4.ident.me) ``` Use the --p2p-host-ip parameter to specify your public IP. From Prysmatic Labs: > "The beacon node needs to know what your public IP address is so that it can inform other peers how to reach your node. Do this by including the --p2p-host-ip= flag when you start up the beacon-chain." The first thing it does is process deposits. The output looks like this: ``` [2020-05-17 21:49:52] INFO powchain: Processing deposits from Ethereum 1 chain deposits=8192 [2020-05-17 21:49:55] INFO powchain: Processing deposits from Ethereum 1 chain deposits=8704 ``` Once that is done it will wait for suitable peers. The output looks like this: ``` [2020-05-17 21:52:20] INFO initial-sync: Waiting for enough suitable peers before syncing required=3 suitable=2 [2020-05-17 21:52:25] INFO initial-sync: Waiting for enough suitable peers before syncing required=3 suitable=2 ``` And then once it has found and connected to the minimum number of peers, it begins the sync process. The output looks like this: ``` [2020-05-17 21:53:02] INFO initial-sync: Processing block 0xc7c761d3... 532/215365 - estimated time remaining 2h31m23s blocksPerSecond=23.6 peers=12 [2020-05-17 21:53:02] INFO initial-sync: Processing block 0xf0a3de3a... 533/215365 - estimated time remaining 2h31m4s blocksPerSecond=23.7 peers=12 ``` The beacon-chain will begin to sync. It may take several hours for the node to fully sync. The terminal output gives status information and an estimate for time remaining. Prysmatic Labs recommends that you wait for this to complete before you run the validator: > "NOTICE: The beacon node you are using should be completely synced before submitting your deposit for the validator client, otherwise the validator will not be able to validate and will inflict minor inactivity balance penalties." While the beacon node is syncing, let's move onto the next steps.
## Step 5 - Configure validator staking keys *Your beacon node does not have to be synced to do these steps.* The validator allows you to define one or more validator keys. Each key will need to be associated with a 32 ETH deposit into the Topaz Testnet staking deposit contract. ### Get staking ETH To become a validator on the Topaz testnet you will need to get 32 ETH from the Göerli Test Network. **Do not use mainnet ETH**. Follow these steps: a) Click on the MetaMask browser extension and log in. b) Using the dropdown at the top, select the Goerli Test Network. c) Cick on your name to copy your Goerli ETH wallet address. d) Head over to the [Prysm Labs Discord](https://discord.gg/YMVYzv6). e) Ask one of the mods *nicely* to transfer you some ETH and paste your Goerli ETH wallet address. f) If you are planning on running multiple validators you can ask for what you need (32 x number of validators). Once the ETH appears in your MetaMask wallet we are ready to continue to the next step. ### Connect your MetaMask wallet As I mentioned above, in order to validate you will need to deposit 32 Göerli ETH into the Topaz Testnet staking deposit contract. To do this you send the Göerli ETH in a deposit transaction with your validator key data attached, or you can use the Prysm Labs validator participation web page. Let's do that. Go to [Prysm Labs Testnet Participation](https://prylabs.net/participate) in your web browser. Click on `Step 2` on the web page then click on the MetaMask button. Log into MetaMask (if necessary) and click `Connect`. The web page should then display a confirmation that you have sufficient Göerli ETH in your wallet to stake: ``` This test network leverages the Goerli test network to simulate validator deposits on a proof-of-work chain. You are 0x724F321C4efeD5e3C7CcA40168810c258c82d02F and you have 631 GöETH. To deposit as a validator you'll need at least 32.0 GöETH. ``` ### Generate validator keys If you have >= 32 Göerli ETH the page will allow you to click on `Step 3`. This is where you will paste your validator's staking data and send Göerli ETH to the deposit contact. Next we will get the staking data. #### a) Run the validator In a new terminal window run this command to create a validator account: ``` cd prysm/ ./prysm.sh validator accounts create ``` The Prysm validator binary will be downloaded and executed. #### b) Set up the keystore It will prompt you to specify the keystore path where your validator account keys will be stored. ``` INFO accounts: Please specify the keystore path for your private keys (default: "/root/.eth2validators"): ``` You can provide a different value if you like, but, to keep things simple go with the default keystore by pressing **\**. #### c) Secure the key data Next it will ask you for a password. This is the password for your key. **You will need to specify this password each time you run the validator binary** so you will want to make a note of it. For now, I *recommend* using the same key for each validator you create. This will likely change by the time we go to production. After you enter your password and confirm it you should get the following output: ``` INFO accounts: Account creation complete! Copy and paste the raw transaction data shown below when issuing a transaction into the ETH1.0 deposit contract to activate your validator client ========================Raw Transaction Data======================= 0x228951180000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000 00000000000000000000e000000000000000000000000000000000000000000000000000000000000001206617145a28456c7f0670d52cffbad3 d3baad15e1df92f1f1ecdf0c493080c9150000000000000000000000000000000000000000000000000000000000000030aef319a5d9c4ae04a7 5e651558384cf86eed7d010d814cff776185a9ec22661fbe99d651e3f4ddd7096ca218c6b29290000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000020009a3665a747517ea6df3a95eb81d3047a496c505dc9eba79471fccd9704 49270000000000000000000000000000000000000000000000000000000000000060ab767dbd67471ffabfab8096c5b6cc4d998017be9feed0826 13a3ea3465014c1660f7862ef26b90462980668b4cff21c189b41dbde0cb15b621c3d12fc4a4c67e288ab8c0b42e36463ff432005829ced527458 926a6d9a1e2d252438ceb5a25e =================================================================== INFO accounts: Deposit data displayed for public key: 0xaef319a5d9c4ae04a75e651558384cf86eed7d010d814cff776185a9ec22661fbe99d651e3f4ddd7096ca218c6b29290 ``` Make a note of your public Key. This will be useful later to view the validator account status on [beaconcha.in](http://www.beaconcha.in). #### d) Make the deposit Copy the **Raw Transaction Data** without the header and footer and paste it into the box under the heading **Your validator deposit data** at `Step 3` on the [Prysm Labs Testnet Participation](https://prylabs.net/participate) web page. Ignore `Step 4` and click on `Step 5`. Click on the `Make deposit` button. MetaMask will pop-up and once you examine and verify the transaction details, click on the **Confirm** button. MetaMask will eventually confirm the transaction and a message will show at the bottom of the web page: **Transaction Confirmed. You are deposited**. You can also confirm the transaction on the blockchain via Etherscan by clicking on the small arrow on the confirmed transaction in MetaMask. > Sometimes the Prysm web page locks up after you submit. It's not a major problem - the main thing to verify is that your deposit is confimred as successful in Etherscan. Repeat steps **a** through **d** in this section for each validator account you would like to create. Keys will all be stored in the keystore and the validator binary will manage all of the keys for you. > Remember: Each validator account you create corresponds to a unique set of transaction data paired with a 32 ETH deposit. For simplicity use the same password for each key.
## Step 6 - Begin validating (and earning sweet testnet ETH!) *Your beacon node should be **fully synced** before continuing with this step.* ### Run the validator It will prompt you for your password - this is the password you supplied in the previous step. If you used the default key manager, the syntax is: ``` cd ~ cd prysm/ ./prysm.sh validator --keymanager=keystore --enable-account-metrics ``` The `--enable-account-metrics` parameter is an important addition that will allow us to expose metrics on the validator and the validations that it does. More about that in the next step. It can take more than 12 hours to activate the validation key(s). The output from the validator process indicates the status. ``` [2020-05-18 02:08:55] INFO validator: Deposit for validator received but not processed into the beacon state eth1DepositBlockNumber=2714819 expectedInclusionSlot=217796 pubKey=0xaef319a5d9c4 status=DEPOSITED ``` Once activated you should see something like this for each key: ``` [2020-05-17 18:18:47] INFO validator: Validator activated pubKey=0xaef319a5d9c4 ``` You can check the status of your validator via [beaconcha.in](http://www.beaconcha.in). Simply do a search for your validator public key.
## Step 7 - Install Prometheus *Your beacon node does not have to be synced to do these steps.* Prometheus is an open-source systems monitoring and alerting toolkit. It runs as a service on your Ubuntu server and its job is to capture metrics. More information [here](https://prometheus.io/docs/introduction/overview/). We are going to use Prometheus to expose runtime data from the beacon-chain and validator as well as instance specific metrics. ### Create user accounts Accounts for the services to run under. These accounts can't log into the server. ``` cd ~ sudo useradd --no-create-home --shell /bin/false prometheus sudo useradd --no-create-home --shell /bin/false node_exporter ``` ### Create directories Program and data directories. ``` sudo mkdir /etc/prometheus sudo mkdir /var/lib/prometheus ``` Set directory ownership. The prometheus account will manage these. ``` sudo chown prometheus:prometheus /etc/prometheus sudo chown prometheus:prometheus /var/lib/prometheus ``` ### Download Prometheus software Adjust the version number for the version you want from the [Prometheus download page](https://prometheus.io/download/). > For Raspberry Pi users - get the link for the arm version and substitute that for the link below. ``` cd ~ curl -LO https://github.com/prometheus/prometheus/releases/download/v2.18.1/prometheus-2.18.1.linux-amd64.tar.gz ``` Unpack the archive. It contains two binaries and some content files. ``` tar xvf prometheus-2.18.1.linux-amd64.tar.gz ``` Copy the binaries to the following locations. ``` sudo cp prometheus-2.18.1.linux-amd64/prometheus /usr/local/bin/ sudo cp prometheus-2.18.1.linux-amd64/promtool /usr/local/bin/ ``` Set directory ownership. The prometheus account will manage these. ``` sudo chown prometheus:prometheus /usr/local/bin/prometheus sudo chown prometheus:prometheus /usr/local/bin/promtool ``` Copy the content files to the following locations: ``` sudo cp -r prometheus-2.18.1.linux-amd64/consoles /etc/prometheus sudo cp -r prometheus-2.18.1.linux-amd64/console_libraries /etc/prometheus ``` Set directory and file (-R) ownership. The prometheus account will manage these. ``` sudo chown -R prometheus:prometheus /etc/prometheus/consoles sudo chown -R prometheus:prometheus /etc/prometheus/console_libraries ``` Remove the downloaded archive. ``` rm -rf prometheus-2.18.1.linux-amd64.tar.gz prometheus-2.18.1.linux-amd64 ``` ### Edit the configuration file Prometheus uses a configuration file so it knows where to scrape the data from. We will set this up here. Open the YAML config file for editing. ``` sudo nano /etc/prometheus/prometheus.yml ``` Paste the following into the file taking care not to make any additional edits and exit and save the file. ``` global: scrape_interval: 15s # Set the scrape interval to every 15 seconds. evaluation_interval: 15s # Evaluate rules every 15 seconds. # scrape_timeout is set to the global default (10s). # Alertmanager configuration: alerting: alertmanagers: - static_configs: - targets: # - alertmanager:9093 # Load rules once and periodically evaluate them: rule_files: # - "first_rules.yml" # - "second_rules.yml" # The scrape configuration: scrape_configs: - job_name: 'validator' scrape_interval: 5s static_configs: - targets: ['localhost:8081'] - job_name: 'beacon node' scrape_interval: 5s static_configs: - targets: ['localhost:8080'] - job_name: 'node_exporter' scrape_interval: 5s static_configs: - targets: ['localhost:9100'] ``` The **scrape_configs** define the output target for the different job names. We have 3 job names: validator, beacon node, and node_exporter. The first two are obvious, the last one is for metrics related to the server instance itself (memory, CPU, disk, network etc.). We will install and configure node_exporter below. Set ownership for the config file. The prometheus account will own this. ``` sudo chown prometheus:prometheus /etc/prometheus/prometheus.yml ``` Finally, let's test the service is running correctly. ``` sudo -u prometheus /usr/local/bin/prometheus \ --config.file /etc/prometheus/prometheus.yml \ --storage.tsdb.path /var/lib/prometheus/ \ --web.console.templates=/etc/prometheus/consoles \ --web.console.libraries=/etc/prometheus/console_libraries ``` Output should look something like this. Press Ctrl + C to exit. ``` level=info ts=2020-05-17T18:31:33.012Z caller=main.go:302 msg="No time or size retention was set so using the default time retention" duration=15d level=info ts=2020-05-17T18:31:33.012Z caller=main.go:337 msg="Starting Prometheus" version="(version=2.18.1, branch=HEAD, revision=ecee9c8abfd118f139014cb1b174b08db3f342cf)" level=info ts=2020-05-17T18:31:33.012Z caller=main.go:338 build_context="(go=go1.14.2, user=x@x, date=20200507-16:51:47)" level=info ts=2020-05-17T18:31:33.012Z caller=main.go:339 host_details="(Linux 5.4.0-29-generic #33-Ubuntu SMP Wed Apr 29 14:32:27 UTC 2020 x86_64 ETH-STAKER (none))" level=info ts=2020-05-17T18:31:33.012Z caller=main.go:340 fd_limits="(soft=1024, hard=1048576)" level=info ts=2020-05-17T18:31:33.013Z caller=main.go:341 vm_limits="(soft=unlimited, hard=unlimited)" level=info ts=2020-05-17T18:31:33.019Z caller=web.go:523 component=web msg="Start listening for connections" address=0.0.0.0:9090 level=info ts=2020-05-17T18:31:33.021Z caller=main.go:678 msg="Starting TSDB ..." level=info ts=2020-05-17T18:31:33.038Z caller=head.go:575 component=tsdb msg="Replaying WAL, this may take awhile" level=info ts=2020-05-17T18:31:33.038Z caller=head.go:624 component=tsdb msg="WAL segment loaded" segment=0 maxSegment=0 level=info ts=2020-05-17T18:31:33.039Z caller=head.go:627 component=tsdb msg="WAL replay completed" duration=451.301µs level=info ts=2020-05-17T18:31:33.041Z caller=main.go:694 fs_type=EXT4_SUPER_MAGIC level=info ts=2020-05-17T18:31:33.041Z caller=main.go:695 msg="TSDB started" level=info ts=2020-05-17T18:31:33.041Z caller=main.go:799 msg="Loading configuration file" filename=/etc/prometheus/prometheus.yml level=info ts=2020-05-17T18:31:33.052Z caller=main.go:827 msg="Completed loading of configuration file" filename=/etc/prometheus/prometheus.yml level=info ts=2020-05-17T18:31:33.052Z caller=main.go:646 msg="Server is ready to receive web requests." ``` ### Set Prometheus to autostart as a service Create a systemd service file to store the service config which tells systemd to run Prometheus as the prometheus user, with the configuration file located in the /etc/prometheus/prometheus.yml directory, and to store its data in the /var/lib/prometheus directory. ``` sudo nano /etc/systemd/system/prometheus.service ``` Paste the following into the file. Exit and save. ``` [Unit] Description=Prometheus Wants=network-online.target After=network-online.target [Service] User=prometheus Group=prometheus Type=simple ExecStart=/usr/local/bin/prometheus \ --config.file /etc/prometheus/prometheus.yml \ --storage.tsdb.path /var/lib/prometheus/ \ --web.console.templates=/etc/prometheus/consoles \ --web.console.libraries=/etc/prometheus/console_libraries [Install] WantedBy=multi-user.target ``` Reload systemd to reflect the changes. ``` sudo systemctl daemon-reload ``` And then start the service with the following command. ``` sudo systemctl start prometheus ``` Check the status to make sure it's running correctly. ``` sudo systemctl status prometheus ``` Output should look something like this. If you did everything right, it should say **Active: active (running)**. If not then go back and repeat the steps to fix the problem. Press Q to quit. ``` ● prometheus.service - Prometheus Loaded: loaded (/etc/systemd/system/prometheus.service; enabled; vendor preset: enabled) Active: active (running) since Sun 2020-05-17 22:53:29 UTC; 31min ago Main PID: 32345 (prometheus) Tasks: 10 (limit: 9513) Memory: 24.1M CGroup: /system.slice/prometheus.service └─32345 /usr/local/bin/prometheus --config.file /etc/prometheus/prometheus.yml --storage.tsdb.path /var/lib/prometheus/ --web.console.templates=/etc/prometheus/consoles --web.console.libraries=/etc/prometheus/console_libraries lines 1-19/19 (END) ``` Lastly enable Prometheus to start on boot. ``` sudo systemctl enable prometheus ``` ### Install Node Exporter Prometheus will provide metrics about the beacon chain and validators. If we want metrics about our Ubuntu instance, we'll need an extension called [Node_Exporter](https://github.com/prometheus/node_exporter). You can find the latest stable version [here](https://prometheus.io/download/) if you want to specify a different version below. > For Raspberry Pi users - get the link for the arm version and substitute that for the link below. ``` cd ~ curl -LO https://github.com/prometheus/node_exporter/releases/download/v1.0.0-rc.1/node_exporter-1.0.0-rc.1.linux-amd64.tar.gz ``` Unpack the downloaded software. ``` tar xvf node_exporter-1.0.0-rc.1.linux-amd64.tar.gz ``` Copy the binary to the /usr/local/bin directory and set the user and group ownership to the node_exporter user we created above. ``` sudo cp node_exporter-1.0.0-rc.1.linux-amd64/node_exporter /usr/local/bin sudo chown node_exporter:node_exporter /usr/local/bin/node_exporter ``` Remove the downloaded archive. ``` rm -rf node_exporter-1.0.0-rc.1.linux-amd64.tar.gz node_exporter-1.0.0-rc.1.linux-amd64 ``` ### Set Node Exporter to autostart as a service Create a systemd service file to store the service config which tells systemd to run Node_Exporter as the node_exporter user. ``` sudo nano /etc/systemd/system/node_exporter.service ``` Paste the following into the file. Exit and save. ``` [Unit] Description=Node Exporter Wants=network-online.target After=network-online.target [Service] User=node_exporter Group=node_exporter Type=simple ExecStart=/usr/local/bin/node_exporter [Install] WantedBy=multi-user.target ``` Reload systemd to relfect the changes. ``` sudo systemctl daemon-reload ``` And then start the service with the following command. ``` sudo systemctl start node_exporter ``` Check the status to make sure it's running correctly. ``` sudo systemctl status node_exporter ``` Output should look something like this. If you did everything right, it should say **Active: active (running)**. If not then go back and repeat the steps to fix the problem. Press Q to quit. ``` ● node_exporter.service - Node Exporter Loaded: loaded (/etc/systemd/system/node_exporter.service; disabled; vendor preset: enabled) Active: active (running) since Sun 2020-05-17 23:24:04 UTC; 5s ago Main PID: 33035 (node_exporter) Tasks: 6 (limit: 9513) Memory: 5.1M CGroup: /system.slice/node_exporter.service └─33035 /usr/local/bin/node_exporter ``` Enable Node Exporter to start on boot. ``` sudo systemctl enable node_exporter ``` ### Test prometheus and node_exporter Everything should be ready to go. You may test the functionality by running a browser on your instance and navigating to [http://localhost:9090]. From there you can run queries to view different metrics. For example try this query to see how much memory is free in bytes: ``` http://localhost:9090/new/graph?g0.expr=node_memory_MemFree_bytes&g0.tab=1&g0.stacked=0&g0.range_input=1h ``` Or try this query to see the balance for all of your validators: ``` http://localhost:9090/graph?g0.range_input=1h&g0.expr=validator_balance&g0.tab=1 ``` > If you would rather not do this via RDP, open up port 9090 and you can hit the endpoint remotely.
## Step 8 - Install Grafana While Prometheus is our datasource, Grafana is going provide our reporting dashboard capability. Let's install it and configure a dashboard. We will install using an APT repository beacuse it is easier to install and update. Grafana is available in the official Ubuntu packages repository, however the version of Grafana there may not be the latest, so we will use Grafana’s official repository. Download the Grafana GPG key with wget, then pipe the output to apt-key. This will add the key to your APT installation’s list of trusted keys. ``` wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add - ``` Add the Grafana repository to the APT sources. ``` sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main" ``` Refresh the apt cache. ``` sudo apt update ``` Make sure Grafana is installed from the repository. ``` apt-cache policy grafana ``` Output should look like this: ``` grafana: Installed: (none) Candidate: 6.7.3 Version table: 6.7.3 500 500 https://packages.grafana.com/oss/deb stable/main amd64 Packages 6.7.2 500 500 https://packages.grafana.com/oss/deb stable/main amd64 Packages ... ``` Verify the version at the top matches the latest version shown [here](https://grafana.com/grafana/download). Then proceed with the installation. ``` sudo apt install grafana ``` Start the Grafana server. ``` sudo systemctl start grafana-server ``` Check the status to make sure it's running correctly. ``` sudo systemctl status grafana-server ``` Output should look something like this. If you did everything right, it should say **Active: active (running)**. If not then go back and repeat the steps to fix the problem. Press Q to quit. ``` ● grafana-server.service - Grafana instance Loaded: loaded (/lib/systemd/system/grafana-server.service; disabled; vendor preset: enabled) Active: active (running) since Sun 2020-05-17 23:59:24 UTC; 5s ago Docs: http://docs.grafana.org Main PID: 35118 (grafana-server) Tasks: 14 (limit: 9513) Memory: 16.5M CGroup: /system.slice/grafana-server.service ``` Enable Grafana to start on boot. ``` sudo systemctl enable grafana-server ``` ### Configure Grafana login Great job on getting this far! Now that you have everything up and running you can go to [http://\:3000/] in a browser and the Grafana login screen should come up. You can go further to set up a Nginx web server and add an SSL certificate to secure your connection. This is testnet stuff so I didn't bother. Enter `admin` for the username and password. It will prompt you to change your password and you should do that. ### Configure Grafana data source Let's configure a datasource. Move your mouse over the gear icon on the left menu bar. A menu will pop-up - choose `Data Sources`. Click on `Add Data Source` and then choose `Prometheus`. Enter `http://localhost:9090` for the URL then click on `Save and Test`. ### Import Grafana dashboard Now let's import a dashboard. Move your mouse over the `+` icon on the left menu bar. A menu will pop-up - choose `Import`. Paste the JSON from [here](https://github.com/GuillaumeMiralles/prysm-grafana-dashboard/blob/master/less_10_validators.json) and click `Load`. You should be able to view the dashboard. At first you won't have sufficient data, especially if you haven't run your validator yet, but after running for a while you will see some metrics. > Credit goes to Github user [GuillaumeMiralles](https://github.com/GuillaumeMiralles) for the ace dashboard.
## Final Remarks That's it! I hope you enjoyed this guide! - If you have feedback you can reach me on [Twitter](https://www.twitter.com/SomerEsat). - If you liked this guide and think others would benefit from it then please share it! Donations/tips are always welcome. Mainnet ETH: 0x724F321C4efeD5e3C7CcA40168610c258c82d02F
## References I used a bunch of sites and guides to put this together. Thank you to those authors for showing me how! [Logging in as root is bad](https://askubuntu.com/questions/16178/why-is-it-bad-to-log-in-as-root) [Initial Server Setup with Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-20-04) [UFW firewall](https://help.ubuntu.com/community/UFW) [UFW Essentials](https://www.digitalocean.com/community/tutorials/ufw-essentials-common-firewall-rules-and-commands) [xfce](https://www.xfce.org/) [Prysmatic Labs](https://prysmaticlabs.com/) [Prysmatic Eth2 Testnet](https://prylabs.net/) [Prysmatic Labs Discord](https://discord.gg/YMVYzv6) [Installing Prysm on GNU/Linux with Prysm.sh](https://docs.prylabs.network/docs/install/linux/) [ethdo wallet](https://docs.prylabs.network/docs/prysm-usage/wallet-keymanager/) [Bazel](https://docs.prylabs.network/docs/install/lin/bazel) [Prometheus](https://prometheus.io/download/) [Node_Exporter](https://github.com/prometheus/node_exporter) [How to Install Prometheus on Ubuntu 16.04](https://www.digitalocean.com/community/tutorials/how-to-install-prometheus-on-ubuntu-16-04) [How to install and secure Grafana on Ubuntu 18.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-grafana-on-ubuntu-18-04) [GuillaumeMiralles Grafana dashboard](https://github.com/GuillaumeMiralles/prysm-grafana-dashboard/tree/master) [Markdownguide.org - Basic Syntax](https://www.markdownguide.org/basic-syntax/) [Stack Edit](https://stackedit.io/app#) [beaconcha.in](http://www.beaconcha.in)