Skip to content

Latest commit

 

History

History
333 lines (240 loc) · 13.6 KB

holesky-node.md

File metadata and controls

333 lines (240 loc) · 13.6 KB
Raw

Guide on how to setup a Holeksy testnet node (Nethermind/Lighthouse)

Holešky is a new Ethereum testnet meant to replace Goerli as a staking, infrastructure and protocol-developer testnet.

This guide is meant for people with little or some experience in running Ethereum clients and using the command-line interface (CLI). It will show you step by step how to setup your machine to join the Holesky testnet by giving you the instructions to install and configure all the tools needed. It will assume you are using a modern linux distribution with systemd and APT (like Ubuntu 22.04 or Debian 12) on a modern x86 CPU (Intel, AMD). A clean install of your operating system on a dedicated machine or a virtual machine before proceeding is preferable.

Overview

We will use the latest version for Nethermind and the latest version for Lighthouse. We will configure them to connect to the Holesky testnet.

Executing the commands

Almost all of these commands will be performed in a terminal. Start your Terminal application. Any line that starts with the dollar sign ($) is a command that need to be executed in your terminal. Do not input the dollar sign ($) in your terminal, only the text that comes after that.

Executing a command with sudo will occasionally ask you for your password. Make sure to enter your account password correctly. You can execute the command again if you fail to enter the correct password after a few attempts.

Installing Prerequisites

Make sure we have fully updated packages first.

$ sudo apt -y update
$ sudo apt -y upgrade

Install prerequisites commonly available.

$ sudo apt -y install wget curl ccze unzip libsnappy-dev

Installing Nethermind

Download the latest release version for Nethermind and extract it. If the latest version is more recent than what is used here, use that version and adjust for the new URL and archive name. Make sure to use the linux-x64 version.

$ cd ~
$ wget https://github.com/NethermindEth/nethermind/releases/download/1.25.4/nethermind-1.25.4-20b10b35-linux-x64.zip
$ sudo mkdir -p /usr/share/nethermind
$ sudo unzip nethermind-1.25.4-20b10b35-linux-x64.zip -d /usr/share/nethermind
$ rm nethermind-1.25.4-20b10b35-linux-x64.zip

Installing Lighthouse

Download the latest release version for Lighthouse and extract it. If the latest version is more recent than what is used here, use that version and adjust for the new URL and archive name. Make sure to use the linux x86_64 version.

$ cd ~
$ wget https://github.com/sigp/lighthouse/releases/download/v5.0.0/lighthouse-v5.0.0-x86_64-unknown-linux-gnu.tar.gz
$ tar xvf lighthouse-v5.0.0-x86_64-unknown-linux-gnu.tar.gz
$ rm lighthouse-v5.0.0-x86_64-unknown-linux-gnu.tar.gz

Install this Lighthouse version globally.

$ sudo cp ~/lighthouse /usr/local/bin
$ rm ~/lighthouse

Creating the JWT token file

Create a JWT token file in a neutral location and make it readable to everyone. We will use the /var/lib/ethereum/jwttoken location to store the JWT token file.

$ sudo mkdir -p /var/lib/ethereum
$ openssl rand -hex 32 | tr -d "\n" | sudo tee /var/lib/ethereum/jwttoken
$ sudo chmod +r /var/lib/ethereum/jwttoken

Configuring your Nethermind node

Create a dedicated user for running Nethermind, create a directory for holding the data and assign the proper permissions.

$ sudo useradd --no-create-home --shell /bin/false nethermind
$ sudo mkdir -p /var/lib/nethermind
$ sudo chown -R nethermind:nethermind /var/lib/nethermind

Create a systemd service config file to configure the Nethermind node service.

$ sudo nano /etc/systemd/system/nethermind.service

Paste the following service configuration into the file. Exit and save once done (Ctrl + X, Y, Enter).

[Unit]
Description=Nethermind Execution Client (Holesky)
After=network.target
Wants=network.target

[Service]
User=nethermind
Group=nethermind
Type=simple
Restart=always
RestartSec=5
TimeoutStopSec=180
WorkingDirectory=/var/lib/nethermind
Environment="DOTNET_BUNDLE_EXTRACT_BASE_DIR=/var/lib/nethermind"
ExecStart=/usr/share/nethermind/nethermind \
  --config holesky \
  --datadir /var/lib/nethermind \
  --Metrics.Enabled true \
  --Metrics.ExposePort 6061 \
  --Sync.SnapSync true \
  --JsonRpc.JwtSecretFile /var/lib/ethereum/jwttoken \
  --JsonRpc.Enabled true \
  --HealthChecks.Enabled true \
  --JsonRpc.EnabledModules='[Eth, Subscribe, Trace, TxPool, Web3, Personal, Proof, Net, Parity, Health, Rpc, Admin]' \
  --JsonRpc.AdditionalRpcUrls=http://127.0.0.1:8555|http|admin \
  --JsonRpc.EnginePort 8551

[Install]
WantedBy=default.target

Reload systemd to reflect the changes and start the service. Check status to make sure it’s running correctly.

$ sudo systemctl daemon-reload
$ sudo systemctl start nethermind.service
$ sudo systemctl status nethermind.service

It should say active (running) in green text. If not then go back and repeat the steps to fix the problem. Press Q to quit (will not affect the nethermind service).

Enable the nethermind service to automatically start on reboot.

$ sudo systemctl enable nethermind.service

You can watch the live messages from your Nethermind node logs using this command. Make sure nothing suspicious shows up in your logs.

$ sudo journalctl -f -u nethermind.service -o cat | ccze -A

Press Ctrl + C to stop showing those messages.

Configuring your Lighthouse beacon node

Create a dedicated user for running the Lighthouse beacon node, create a directory for holding the data, copy testnet files and assign the proper permissions.

$ sudo useradd --no-create-home --shell /bin/false lighthousebeacon
$ sudo mkdir -p /var/lib/lighthouse
$ sudo chown -R lighthousebeacon:lighthousebeacon /var/lib/lighthouse

Create a systemd service config file to configure the Lighthouse beacon node service.

$ sudo nano /etc/systemd/system/lighthousebeacon.service

Paste the following service configuration into the file. Exit and save once done (Ctrl + X, Y, Enter).

[Unit]
Description=Lighthouse Beacon Node (Holesky)
Wants=network-online.target
After=network-online.target

[Service]
Type=simple
User=lighthousebeacon
Group=lighthousebeacon
Restart=always
RestartSec=5
ExecStart=/usr/local/bin/lighthouse bn \
    --network holesky \
    --datadir /var/lib/lighthouse \
    --http \
    --execution-endpoint http://127.0.0.1:8551 \
    --checkpoint-sync-url https://holesky.beaconstate.ethstaker.cc \
    --metrics \
    --execution-jwt /var/lib/ethereum/jwttoken \
    --gui \
    --validator-monitor-auto

[Install]
WantedBy=multi-user.target

Reload systemd to reflect the changes and start the service. Check status to make sure it’s running correctly.

$ sudo systemctl daemon-reload
$ sudo systemctl start lighthousebeacon.service
$ sudo systemctl status lighthousebeacon.service

It should say active (running) in green text. If not then go back and repeat the steps to fix the problem. Press Q to quit (will not affect the Lighthouse beacon node service).

Enable the Lighthouse beacon node service to automatically start on reboot.

$ sudo systemctl enable lighthousebeacon.service

You can watch the live messages from your Lighthouse beacon node logs using this command. Make sure nothing suspicious shows up in your logs.

$ sudo journalctl -f -u lighthousebeacon.service -o cat | ccze -A

Press Ctrl + C to stop showing those messages.

Trying the Holesky testnet

Requesting testnet funds

Requesting or obtaining enough Holesky ETH to perform your validator deposit can be challenging. We suggest you use the EthStaker #cheap-holesky-validator free process. Join the EthStaker Discord server and use the /cheap-holesky-deposit slash command (start typing the command and it will show up above your input box). From there, follow the instructions from the bot. As an alternative, you can try obtaining 32 Holesky ETH from various faucets or bridges on https://faucetlink.to/holesky . Holesky ETH was also distributed to anyone who created or deployed a smart contract previously on Goerli. You might already have some Holesky ETH in your wallet if you were involved with smart contracts on Goerli.

Adding a validator

Creating your validator keys and performing the deposit

There are 2 great tools to create your validator keys:

If you choose the Wagyu Key Gen application, make sure to select the Holesky network and follow the instructions provided. If you are using the #cheap-holesky-validator process, you will need to use 0x4D496CcC28058B1D74B7a19541663E21154f9c84 as your withdrawal address. This is only required for that process. When on Mainnet, you should use a withdrawal address you control if you want to use one.

If you choose the staking-deposit-cli application, here is how to create your validator keys. Make sure to replace the 0x4D496CcC28058B1D74B7a19541663E21154f9c84 withdrawal address with your own address that you control if you need or want to:

$ cd ~
$ wget https://github.com/ethereum/staking-deposit-cli/releases/download/v2.7.0/staking_deposit-cli-fdab65d-linux-amd64.tar.gz
$ tar xvf staking_deposit-cli-fdab65d-linux-amd64.tar.gz
$ rm staking_deposit-cli-fdab65d-linux-amd64.tar.gz
$ cd staking_deposit-cli-fdab65d-linux-amd64/
$ ./deposit new-mnemonic --num_validators 1 --chain holesky --execution_address 0x4D496CcC28058B1D74B7a19541663E21154f9c84
$ ls -d $PWD/validator_keys/*

Make sure to store your keystore password and your mnemonic somewhere safe. You should end up with a deposit file (starts with deposit_data- and ends with .json) and one or more keystore files (starts with keystore- and ends with .json), 1 per validator. Copy them around if needed. Make sure your deposit file and your keystore files are in a known and accessible location on your machine.

Next we will need to perform your deposit. If you used the #cheap-holesky-validator process, you can perform your deposit on https://holesky.launchpad.ethstaker.cc/ . If you managed to obtained 32 Holesky ETH, you can use the official Holesky launchpad on https://holesky.launchpad.ethereum.org/ .

Configuring your Lighthouse validator client

Create a dedicated user for running the Lighthouse validator client, create a directory for holding the data and assign the proper permissions.

$ sudo useradd --no-create-home --shell /bin/false lighthousevalidator
$ sudo mkdir -p /var/lib/lighthouse/validators
$ sudo chown -R lighthousevalidator:lighthousevalidator /var/lib/lighthouse/validators
$ sudo chmod 700 /var/lib/lighthouse/validators

Import your keystore that includes your validator key for the Lighthouse validator client. Running the first command will prompt you for that keystore password. Make sure to enter it correctly and avoid leaving it blank. Make sure to replace /path/to/keystores with the actual path to your keystores created in the previous step.

$ sudo /usr/local/bin/lighthouse account validator import \
    --directory /path/to/keystores \
    --datadir /var/lib/lighthouse \
    --network holesky
$ sudo chown -R lighthousevalidator:lighthousevalidator /var/lib/lighthouse/validators

Create a systemd service config file to configure the Lighthouse validator client service.

$ sudo nano /etc/systemd/system/lighthousevalidator.service

Paste the following service configuration into the file. Exit and save once done (Ctrl + X, Y, Enter). Make sure to replace the 0x0000000000000000000000000000000000000000 address with your own Ethereum address that you control where you want to receive the transaction tips.

[Unit]
Description=Lighthouse Validator Client (Holesky)
Wants=network-online.target
After=network-online.target

[Service]
User=lighthousevalidator
Group=lighthousevalidator
Type=simple
Restart=always
RestartSec=5
ExecStart=/usr/local/bin/lighthouse vc \
    --network holesky \
    --datadir /var/lib/lighthouse \
    --graffiti EthStaker \
    --metrics \
    --suggested-fee-recipient 0x0000000000000000000000000000000000000000

[Install]
WantedBy=multi-user.target

Reload systemd to reflect the changes and start the service. Check status to make sure it’s running correctly.

$ sudo systemctl daemon-reload
$ sudo systemctl start lighthousevalidator.service
$ sudo systemctl status lighthousevalidator.service

It should say active (running) in green text. If not then go back and repeat the steps to fix the problem. Press Q to quit (will not affect the Lighthouse validator client service).

Enable the Lighthouse validator client service to automatically start on reboot.

$ sudo systemctl enable lighthousevalidator.service

You can watch the live messages from your Lighthouse validator client logs using this command.

$ sudo journalctl -f -u lighthousevalidator.service -o cat | ccze -A

Press Ctrl + C to stop showing those messages.

Support

If you have any question or if you need additional support, make sure to get in touch with the EthStaker community on:

Credits

Based on Somer Esat's guide.