Skip to content

Commit bc989f4

Browse files
committed
formatting doc
1 parent 9bd9ec1 commit bc989f4

File tree

1 file changed

+36
-44
lines changed

1 file changed

+36
-44
lines changed

docs/user/staking/switch-clients.md

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This guide explains how to switch execution and consensus clients on Dappnode for Ethereum, Gnosis, and Lukso networks. It includes detailed information about the switching process and expected waiting times for resynchronization and attestation.
44

55
## General Information
6+
67
Important considerations before switching clients:
78

89
- **Downtime:** Switching clients will result in temporary downtime and missed attestations.
@@ -11,111 +12,101 @@ Important considerations before switching clients:
1112
- **Backup:** Always backup your validator keys and wallet information before making any changes.
1213

1314
**Basic Switching Process Overview**
14-
The following switching process applies to Ethereum, Gnosis and Lukso.
15-
- Install new client.
16-
- Go to the stakers tab in the left menu.
15+
The following switching process applies to Ethereum, Gnosis and Lukso.
16+
17+
- Install new client.
18+
- Go to the stakers tab in the left menu.
1719
- Select the new client.
1820
- Click on the Apply changes button.
19-
20-
![stakers tab](/img/stakerstab.png)
2121

22-
- Wait for synchronization. You can view the sync process in the dashboard tab or inside the client package in the logs section.
23-
![Dashboard](/img/dashboard.png)
22+
![stakers tab](/img/stakerstab.png)
2423

24+
- Wait for synchronization. You can view the sync process in the dashboard tab or inside the client package in the logs section.
25+
![Dashboard](/img/dashboard.png)
2526

2627
**What's happening during Sync?**
28+
2729
- Connecting to peers on the network
2830
- Downloading block headers and bodies
2931
- Processing and validating transactions
3032
- Building the state trie and other database structures
3133
- Executing all historical transactions
3234

33-
34-
**Verify correct operation**
35-
Go to the new client package in the packages tab and check the logs section (Technical knowledge is needed to read the logs)
36-
Go to Beaconcha.in dashboard and check if your validators are active and attesting.
37-
35+
**Verify correct operation**
36+
Go to the new client package in the packages tab and check the logs section (Technical knowledge is needed to read the logs)
37+
Go to Beaconcha.in dashboard and check if your validators are active and attesting.
3838

3939
## Execution client switch
4040

41-
The current execution clients supported in Dappnode are the following:
41+
The current execution clients supported in Dappnode are the following:
4242

4343
- Ethereum execution clients: Reth, Geth, Nethermind, Erigon and Besu
4444
- Gnosis execution clients: Nethermind and Erigon
4545
- Lukso execution client: Geth
4646

47-
Switching execution clients is a **critical operation that can substantially impact attestation performance** due to the extensive sync time required. Additionally, it is important to consider that installing a new execution client demands significant disk space.
48-
49-
47+
Switching execution clients is a **critical operation that can substantially impact attestation performance** due to the extensive sync time required. Additionally, it is important to consider that installing a new execution client demands significant disk space.
5048

5149
| Sync time | Attestattion impact | Disk space required |
52-
| -------- | -------- | -------- |
53-
| 12-48h | 12-48h | +2 TB |
54-
50+
| --------- | ------------------- | ------------------- |
51+
| 12-48h | 12-48h | +2 TB |
5552

5653
If the client was not downloaded and sync previously, an initial sync is needed. It typically takes from 12 to 48 hours depending on the client. All times mentioned here assume standard Solid State Disk storage and reasonable network conditions. Actual times may vary based on hardware, network conditions, and chain state. Attestation impact directly correlates with sync time plus small overhead for client initialization.
5754

58-
:::info
59-
The sync process might **require high resources of your hardware**, do not worry if your CPU temperature reaches 100ºC or your CPU usage is +90%, it is normal during the sync process. It would be problematic only if it stays at these levels for several days. In this case check maintenance practices in this documentation.
55+
:::info
56+
The sync process might **require high resources of your hardware**, do not worry if your CPU temperature reaches 100ºC or your CPU usage is +90%, it is normal during the sync process. It would be problematic only if it stays at these levels for several days. In this case check maintenance practices in this documentation.
6057
:::
6158

6259
## Consensus client switch
6360

64-
The current consensus clients supported in Dappnode are the following:
61+
The current consensus clients supported in Dappnode are the following:
6562
Ethereum consensus clients: Lighthouse, Teku, Lodestar Nimbus and Prysm.
66-
Gnosis consensus clients: Lighthouse, Teku, Lodestar and Nimbus
63+
Gnosis consensus clients: Lighthouse, Teku, Lodestar and Nimbus
6764
Lukso consensus clients: Teku and Prysm
6865

69-
Switching consensus clients is a **quick action and the attestation impact is limited**. Consensus clients do not require a lot of space to run properly.
66+
Switching consensus clients is a **quick action and the attestation impact is limited**. Consensus clients do not require a lot of space to run properly.
7067

7168
| Sync time | Attestattion impact | Disk space required |
72-
| -------- | -------- | -------- |
73-
| 10 min | 30 min | +30 GB |
69+
| --------- | ------------------- | ------------------- |
70+
| 10 min | 30 min | +30 GB |
7471

7572
All consensus clients have a **sync time of 5-10 minutes** max thanks to checkpoint sync.
76-
Checkpoint sync helps to connect to the current state of the blockchain getting the data from an external node, so it does not need to start from scratch, reducing the time of synchronization significantly.
73+
Checkpoint sync helps to connect to the current state of the blockchain getting the data from an external node, so it does not need to start from scratch, reducing the time of synchronization significantly.
7774

78-
It is always advisable to switch to a new consensus client from scratch (without existent volumes) to trigger the checkpoint sync. Otherwise, if you have a client with previous blockchain data, it will require more time to sync.
75+
It is always advisable to switch to a new consensus client from scratch (without existent volumes) to trigger the checkpoint sync. Otherwise, if you have a client with previous blockchain data, it will require more time to sync.
7976

80-
:::info
77+
:::info
8178
After sync time completes, it has an extra downtime of 1-3 epochs (6 - 18 minutes). This is the “doppelganger” check, an extra protection measure to avoid slashing.
8279
:::
8380

8481
## Blockchains sync time & recommended disk space
85-
The sync time varies depending on the blockchain selected to run your validators.
82+
83+
The sync time varies depending on the blockchain selected to run your validators.
8684

8785
| Blockchain | Sync time | Disk space recommended |
8886
| ---------- | --------- | ---------------------- |
8987
| Ethereum | 12-48 h | +1.5 TB |
9088
| Gnosis | 8-16 h | +0.5 TB |
91-
| Lukso | 4-12 h | +0.5 TB |
92-
| Hoodi | 2-4 h | +0.5 TB |
93-
89+
| Lukso | 4-12 h | +0.5 TB |
90+
| Hoodi | 2-4 h | +0.5 TB |
9491

9592
## Best Practices
9693

9794
**Plan Your Switch**: Choose a time with low network activity for switching to minimize the impact of missed attestations.
9895

99-
100-
**Don't Delete Old Client Data Immediately:** Keep the data from your old client for a few days in case you need to switch back. If you want to keep the new client in the long term, we recommend deleting the previous client before installing the new one to ensure enough disk space
101-
96+
**Don't Delete Old Client Data Immediately:** Keep the data from your old client for a few days in case you need to switch back. If you want to keep the new client in the long term, we recommend deleting the previous client before installing the new one to ensure enough disk space
10297

10398
**Monitor Synchronization:** Use Dappnode's dashboard to monitor the synchronization progress of your new client.
10499

105-
106-
**Verify Client Health:** After switching, verify that your new client is properly connected to the network and producing attestations in the package logs.
107-
100+
**Verify Client Health:** After switching, verify that your new client is properly connected to the network and producing attestations in the package logs.
108101

109102
**Check Logs:** Regularly check the logs of your new client to ensure there are no errors or issues.
110103

111-
112104
**Update API Connections:** If you have any external tools connecting to your node, update their connection settings to point to the new client.
113105

114-
115-
**Enable Dappnode notifications:** Push notifications can help to track the status of your validators and clients.
116-
106+
**Enable Dappnode notifications:** Push notifications can help to track the status of your validators and clients.
117107

118108
## Troubleshooting
109+
119110
Common Issues and Solutions
120111

121112
<details>
@@ -160,5 +151,6 @@ Common Issues and Solutions
160151
</details>
161152

162153
If you are experiencing a different problem, you can:
154+
163155
- Ask the community in the support channel in Discord.
164-
- Subscribe to **Dappnode Premium** to be guided by a Dappnode team member personally.
156+
- Subscribe to **Dappnode Premium** to be guided by a Dappnode team member personally.

0 commit comments

Comments
 (0)