Skip to content

Commit 6b8c282

Browse files
authored
Merge pull request #82 from Alex-ssvlabs/ssv-signer
Added SSV-Signer page, Sidecars section, link redirects
2 parents 7e863ba + 7c1c7d0 commit 6b8c282

24 files changed

+1460
-112
lines changed

docs/developers/SSV-SDK/examples/create-validator-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66

77
The SSV SDK does not natively support programmatically generating keystores out of the box, but a number of external libraries can be used to achieve this. 
88

9-
If you do not need to do this programmatically, it may be easier to use the [Ethereum Staking Deposit CLI](https://github.com/ethereum/staking-deposit-cli) to generate validator keys.
9+
If you do not need to do this programmatically, it may be easier to use the [Ethereum Staking Deposit CLI](https://github.com/ethereum/staking-deposit-cli) to generate validator keys. To generate Hoodi validator keys you can use [eth-educators' Staking Deposit CLI fork](https://github.com/eth-educators/ethstaker-deposit-cli).
1010

1111
:::info
1212
As this is not part of the SSV SDK, SSV is not liable for any misuse of the packages used to generate validator keys in the method show below.

docs/developers/tools/ssv-dkg-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ In order for the DKG protocol to execute successfully:
2929
* separately, an _Initiator_ (one of the Operators, or a separate entity), starts the DKG ceremony by running the `ssv-dkg` tool with the `init` parameter
3030
* the tool automatically exchange data between the interested parties, as outlined in the Architecture section, until the key shares are created
3131

32-
For details on how to run the tool as an Operator, please head over to [this sub-page containing the related instructions](/operators/operator-node/node-setup/enabling-dkg/).
32+
For details on how to run the tool as an Operator, please head over to [this sub-page containing the related instructions](/operators/operator-node/setup-sidecars/enabling-dkg/README.md).
3333

3434
Similarly, head over to [this other sub-page ](generate-key-shares.md)for instructions on how to launch the tool as the Initiator of the DKG ceremony.
3535

docs/developers/tools/ssv-dkg-client/commands-and-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The `ssv-dkg` tool provides 3 main functionalities, detailed in the following p
2121
* [Re-generate Key Shares with a different operator set](change-operator-set-and-reshare-validator-key-shares.md)
2222
* [Re-generate the signature of Key Shares through the same operator set (changing owner, nonce)](update-owner-nonce-in-key-shares.md)
2323
Additional option, only for SSV node operators, treated in the related section:
24-
* [Start the DKG server](../../../operators/operator-node/node-setup/enabling-dkg)
24+
* [Start the DKG server](/docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md)
2525
In order to provide these features, the following options are available:
2626
* `init` - initiates a DKG ceremony to generate new Key Shares and a new validator pubkey
2727
* `generate-reshare-msg` - generates a message with the content of a `proofs.json` file from a past ceremony, that needs to be signed by the `owner` used in that ceremony, in order for a `reshare` ceremony to take place

docs/developers/tools/ssv-dkg-client/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sidebar_position: 7
1212
2025-02-18T11:46:49.637474Z FATAL dkg-initiator 😥 Failed to initiate DKG ceremony: {"error": "failed to validate ceremony proof: invalid proof validator pubkey"}
1313
```
1414

15-
This error appears if `ssv-dkg` tool has not met [the hardware requirements](../../../operators/operator-node/node-setup/enabling-dkg/prerequisites), CPU specifically.
15+
This error appears if `ssv-dkg` tool has not met [the hardware requirements](/operators/operator-node/setup-sidecars/enabling-dkg/prerequisites), CPU specifically.
1616

1717
The requirements are for both initiator and operator, the error will appear if any of parties have not met them.
1818

docs/operators/operator-node/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,23 @@ sidebar_position: 7
88
This section is to help you install and run your SSV Node 🚀
99

1010
The steps to follow on your journey:
11-
1. [**Install SSV Node**](./node-setup)
11+
1. [**Setup SSV Node**](./node-setup)
1212
* [Hardware Requirements](./node-setup/hardware-requirements.md) - to make sure your hardware is sufficient.
1313
* [Best Practices](./node-setup/best-practices.md) - tips for better performance of your setup.
14-
* [*Node Configuration Reference*](./node-setup/node-configuration-reference.md) - (*optional*) reference of SSV's node config.
15-
* [*Manual Node Setup*](./node-setup/manual-setup.md) - (*optional*) alternative setup guide with manual installation.
16-
2. [**Install Sidecars**](/operators/operator-node/node-setup/enabling-dkg/)
17-
* [Enable DKG](/operators/operator-node/node-setup/enabling-dkg/) - to participate in DKG ceremonies and get more validators.
18-
* [Configure MEV](/operators/operator-node/node-setup/configuring-mev) - to increase rewards for block proposals.
19-
* [Configure Primev](./node-setup/configuring-primev.md) - alternative to MEV, includes Pre-confirmations.
14+
* [*Node Configuration Reference*](./node-setup/node-configuration-reference.md) - *(optional)* reference of SSV's node config.
15+
* [*Manual Node Setup*](./node-setup/manual-setup.md) - *(optional)* alternative setup guide with manual installation.
16+
2. [**Setup Sidecars**](/operators/operator-node/setup-sidecars/README.md)
17+
* [Enable DKG](/operators/operator-node/setup-sidecars/enabling-dkg/) - to participate in DKG ceremonies and get more validators.
18+
* [Configure MEV](/operators/operator-node/setup-sidecars/configuring-mev) - to increase rewards for block proposals.
19+
* [Configure Primev](/operators/operator-node/setup-sidecars/configuring-primev) - alternative to MEV, includes Pre-confirmations.
20+
<!-- * [*Configure SSV Remote Signer*](/operators/operator-node/setup-sidecars/remote-signer) - *(optional)* separates the key management functions from the SSV node. -->
2021
3. [**Monitoring setup**](./monitoring/README.md)
2122
* [Dashboard Runbook](./monitoring/dashboard-runbook.md) - install our Grafana dashboard and learn how to use it.
22-
* [*Metrics Index*](./monitoring/metrics-index.md) - (*optional*) learn about SSV metrics in detail.
23+
* [*Metrics Index*](./monitoring/metrics-index.md) - *(optional)* learn about SSV metrics in detail.
2324
4. [**Maintenance**](./maintenance/README.md)
2425
* [Troubleshooting](./maintenance/troubleshooting.md) - identify and fix issues with your setup.
2526
* [Common Errors](./maintenance/common-errors.md) - learn about most common errors you might see in your logs.
26-
* [*Node Migration*](./maintenance/node-migration.md) - (*optional*) guide on how to migrate an SSV Node.
27-
* [*DKG Node Migration*](./maintenance/dkg-operator-migration.md) - (*optional*) guide on how to migrate DKG Node.
27+
* [*Node Migration*](./maintenance/node-migration.md) - *(optional)* guide on how to migrate an SSV Node.
28+
* [*DKG Node Migration*](./maintenance/dkg-operator-migration.md) - *(optional)* guide on how to migrate DKG Node.
2829

2930
After you're done with installation, you can go and [register your operator](../operator-management/README.md) to the network.

docs/operators/operator-node/maintenance/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Maintenance
1+
---
2+
title: Maintenance
3+
sidebar_position: 4
4+
---
25

3-
If you are having troubles with your SSV node visit
4-
* [Troubleshooting section](./troubleshooting.md)
6+
# Maintenance
57

6-
If you are looking for a specific error, you might find it on the
7-
* [Common errors page](./common-errors.md)
8+
* [Troubleshooting section](./troubleshooting.md) - If you are having troubles with your SSV node.
9+
* [Common errors page](./common-errors.md) - If you are looking for a specific error, you might find it here.
810
***
911
To migrate your SSV node follow the guides
1012
* [Node Migration](./node-migration.md)

docs/operators/operator-node/maintenance/dkg-operator-migration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ The recommended migration process could be summarised in the following steps:
1313

1414
* Backup DKG files (if applicable)
1515
* Shut down DKG operator (if applicable) on the current machine
16-
* [Start DKG operator on the new machine](../node-setup/enabling-dkg/start-dkg-node/)
17-
* [Update operator metadata on the SSV WebApp](../node-setup/enabling-dkg/final-steps#update-operator-metadata)
16+
* [Start DKG operator on the new machine](/operators/operator-node/setup-sidecars/enabling-dkg/start-dkg-node/)
17+
* [Update operator metadata on the SSV WebApp](/operators/operator-node/setup-sidecars/enabling-dkg/final-steps#update-operator-metadata)
1818

1919
:::info
2020
Please note: since the DKG node does not have to be on the same machine as the SSV node, one can be migrated without having to migrate the other.
2121
:::
2222

2323
### DKG backup (if necessary)
2424

25-
If you have followed [the dedicated guide to enable DKG for your operator](../node-setup/enabling-dkg/start-dkg-node/), you most likely have (at least) these files in the folder with your node configuration:
25+
If you have followed [the dedicated guide to enable DKG for your operator](/operators/operator-node/setup-sidecars/enabling-dkg/start-dkg-node/), you most likely have (at least) these files in the folder with your node configuration:
2626

2727
```
2828
⇒ tree

docs/operators/operator-node/monitoring/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Monitoring
3-
sidebar_position: 6
3+
sidebar_position: 3
44
---
55

66
## Introduction

docs/operators/operator-node/node-setup/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
sidebar_label: 'Node Setup'
2+
sidebar_label: 'Setup SSV Node'
33
sidebar_position: 1
44
---
55

6-
# Node setup
6+
# Setup SSV Node
77

88
In this section, we will walk through the process of installing the [SSV Node stack](https://github.com/ssvlabs/ssv-stack) using the standard Docker-based setup. This will install and configure the node itself with the monitoring stack:
99

@@ -194,7 +194,7 @@ docker compose up -d
194194
## Start DKG Node
195195
You can also run the stack with DKG, simplifying the setup process.
196196

197-
The instructions are on the ["Enablind DKG" section](./enabling-dkg/start-dkg-node/README.md).
197+
The instructions are on the ["Enablind DKG" section](/operators/operator-node/setup-sidecars/enabling-dkg/).
198198

199199

200200
## Other setup options
@@ -205,9 +205,9 @@ Alternatively, SSV Node setup is also available using [eth-docker](https://eth-d
205205

206206
## What's next?
207207

208-
* You might want to [configure MEV](configuring-mev) to increase your rewards for block proposals.&#x20;
208+
* You might want to [configure MEV](/operators/operator-node/setup-sidecars/configuring-mev) to increase your rewards for block proposals.&#x20;
209209

210-
* You can [enable DKG node](enabling-dkg) to increase your chances of being included in a cluster.
210+
* You can [enable DKG node](/operators/operator-node/setup-sidecars/enabling-dkg/) to increase your chances of being included in a cluster.
211211

212212
* You might want to learn [how to use your Monitoring stack](/operators/operator-node/monitoring/), to stay on top of your performance.
213213

docs/operators/operator-node/node-setup/manual-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: In case you don't want to use the SSV Stack automated setup.
3-
sidebar_position: 6
3+
sidebar_position: 7
44
---
55

66
import Tabs from '@theme/Tabs';
@@ -162,7 +162,7 @@ ssv:
162162
ValidatorOptions:
163163
# Block proposals are by default controlled by Beacon Node.
164164
# Requires the connected Beacon node to be MEV-enabled.
165-
# Please see https://docs.ssv.network/operators/operator-node/node-setup/configuring-mev
165+
# Please see https://docs.ssv.network/operators/operator-node/setup-sidecars/configuring-mev
166166

167167
eth2:
168168
# HTTP URL of the Beacon node to connect to.

docs/operators/operator-node/node-setup/node-configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Node Configuration Reference
3-
sidebar_position: 7
3+
sidebar_position: 8
44
---
55

66
The table below represents the reference for every Node configuration option available.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_label: 'Setup Sidecars'
3+
description: Configure Sidecars for your SSV Node
4+
sidebar_position: 2
5+
---
6+
7+
<!-- DONT FORGET TO UNCOMMENT IN OPERATOR-NODE README -->
8+
9+
# Setup Sidecars
10+
11+
The sidecars are meant to be running alongside your SSV Node. The available ones are:
12+
* [**Enable DKG**](/docs/operators/operator-node/setup-sidecars/enabling-dkg/) - to participate in DKG ceremonies and get more validators.
13+
* [**Configure MEV**](/docs/operators/operator-node/setup-sidecars/configuring-mev.md) - to increase rewards for block proposals.
14+
* [**Configure Primev**](/docs/operators/operator-node/setup-sidecars/configuring-primev.md) - alternative to MEV, includes Pre-confirmations.
15+
<!-- * [*Configure SSV Remote Signer*](./setup-sidecars/remote-signer) - *(optional)* separates the key management functions from the SSV node. -->

docs/operators/operator-node/node-setup/configuring-mev.md renamed to docs/operators/operator-node/setup-sidecars/configuring-mev.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuring MEV
3-
sidebar_position: 4
3+
sidebar_position: 2
44
---
55

66
This guide outlines the necessary steps required to configure MEV within your SSV node to enable operators to participate in proposing MEV blocks for the validators they manage.
@@ -13,11 +13,11 @@ This integration will grant you access to a network of block builders, who colla
1313

1414
Follow the setup guidelines for configuring MEV on your preferred client:
1515

16-
* [Prysm](https://docs.prylabs.network/docs/advanced/builder)
16+
* [Prysm](https://www.offchainlabs.com/prysm/docs/configure-prysm/builder/)
1717
* [Teku](https://docs.teku.consensys.net/how-to/configure/use-proposer-config-file)
18-
* [Lighthouse](https://lighthouse-book.sigmaprime.io/builders.html?highlight=mev#maximal-extractable-value-mev)
18+
* [Lighthouse](https://lighthouse-book.sigmaprime.io/advanced_builders.html?highlight=mev#maximal-extractable-value-mev)
1919
* [Nimbus](https://nimbus.guide/external-block-builder.html)
20-
* [Lodestar](https://chainsafe.github.io/lodestar/usage/mev-integration/)
20+
* [Lodestar](https://chainsafe.github.io/lodestar/run/beacon-management/mev-and-builder-integration)
2121

2222
:::info
2323
For reference, the [ETHStaker](https://github.com/eth-educators/ethstaker-guides/blob/main/MEV-relay-list.md) community provides a list of MEV relays and their corresponding endpoints.

docs/operators/operator-node/node-setup/configuring-primev.md renamed to docs/operators/operator-node/setup-sidecars/configuring-primev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuring Primev
3-
sidebar_position: 5
3+
sidebar_position: 3
44
---
55

66
This guide outlines the necessary steps required to configure MEV-commit within your SSV node to enable operators to participate in MEV and preconfirmations. You can learn more about the concept and technical details on [Primev documentation](https://docs.Primev.xyz/v1.0.0/get-started/welcome-to-Primev).

docs/operators/operator-node/node-setup/enabling-dkg/README.md renamed to docs/operators/operator-node/setup-sidecars/enabling-dkg/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: 'Enabling DKG'
3-
sidebar_position: 3
3+
sidebar_position: 1
44
---
55

66
# Enabling DKG

0 commit comments

Comments
 (0)