Skip to content

Commit 0eadd82

Browse files
authored
Merge pull request #18 from Alex-ssvlabs/main
Multiple changes + initial cleanup
2 parents 0f494a2 + 413767c commit 0eadd82

25 files changed

+363
-363
lines changed

docs/developers/tools/ssv-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Using the `ssv-keys` SDK can be simply summarized in 3 steps:
5050
:::info
5151
A requirement for splitting the keys of a validator, is to know the validator key owner's nonce (how many times this address has callded the registerValidator() function of the SSV contract) and their address.
5252

53-
These can be obtained via the [SSV Scanner tool](../ssv-scanner/).
53+
These can be obtained via the [SSV SDK](../SSV-SDK/examples/api-calls/#get-nonce), or the [SSV Subgraph](./ssv-subgraph/subgraph-examples/#account-nonce).
5454
:::
5555

5656
## Example
@@ -70,7 +70,7 @@ const keystore = require('./path-to-keystore.json');
7070
const keystorePassword = 'XYZ';
7171

7272
// The nonce of the owner within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool
73-
const TEST_OWNER_NONCE = 1;
73+
const TEST_OWNER_NONCE = 0;
7474
// The cluster owner address
7575
const TEST_OWNER_ADDRESS = '0x81592c3de184a3e2c0dcb5a261bc107bfa91f494';
7676

docs/operators/liquidator-bot/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ OWNER OPERATORIDS BALANCE BURNR
2626
2. **Liquidating accounts** \
2727
Once the potential liquidation block is reached the liquidator bot will call the [liquidate()](../../developers/smart-contracts/ssvnetwork#liquidateowner-operatorids-cluster) function in the network contract, if the bot was the first to successfully pass the transaction the cluster will be liquidated and its SSV collateral will be sent to the wallet address which performed the liquidation  
2828

29+
You can find the [installation instructions here](./installation).

docs/operators/operator-node/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ sidebar_position: 7
77

88
Operators provide hardware infrastructure, run the SSV protocol, and are responsible for maintaining the overall health of the SSV network. Operators determine their own fees and are compensated for their integral services to the network by operating and maintaining validators on-behalf of stakers.
99

10-
To join the network as an operator a user must [install](installation.md) the SSV node software, and [register](../operator-management/registration.md) the operator to the network.
10+
To join the network as an operator a user must [install](./node-setup) the SSV node software, and [register](../operator-management/registration.md) the operator to the network.
1111

12-
* [Installation Guide](installation.md)
12+
* [Installation Guide](./node-setup)
1313
* [Configuring MEV](configuring-mev.md)
1414
* [Enabling DKG](enabling-dkg.md)
1515
* [Operator Registration](../operator-management/registration.md)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
11
# Maintenance
22

3+
If you are having troubles with your SSV node visit
4+
* [Troubleshooting section](./troubleshooting.md).
5+
***
6+
To migrate your SSV node follow the guides
7+
* [Node Migration](./node-migration.md)
8+
* [DKG Migration](./dkg-operator-migration)

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](../enabling-dkg.md#start-ssv-dkg)
17-
* [Update operator metadata on the SSV WebApp](enabling-dkg.md#update-operator-metadata)
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)
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](../enabling-dkg), 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](../node-setup/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/maintenance/node-migration.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ As a node operator, it may happen that the software stack needs to be migrated t
77

88
In such a scenario, it is very important to know what operations must be performed, in which order, and what are the sensitive pieces of data that need to be preserved and copied over to the new hardware. Here is a summary:
99

10-
### Procedure
10+
## Procedure
1111

1212
In order to migrate the SSV Node to a different machine, it is necessary to shut down the current setup, **before** launching the new one.
1313

@@ -17,19 +17,25 @@ Two nodes with the same public key should never be running at the same time. The
1717

1818
So, for this reason, the migration process could be easily summarised in the following steps:
1919

20-
* Backup node files
21-
* Shut down SSV Node on the current machine
22-
* Setup SSV Node on the new machine using backups
23-
* Wait at least one epoch
24-
* Start SSV Node service on the new machine
20+
1. Backup node files
21+
2. Shut down SSV Node on the current machine
22+
3. Setup SSV Node on the new machine using backups
23+
4. Wait at least one epoch
24+
5. Start SSV Node service on the new machine
2525

2626
:::warning
2727
Please note: if you are also running a DKG operator node, you may have to [follow the DKG operator migration guide](./dkg-operator-migration), if it is running on the same machine as the SSV node, or if it is running on a different machine, but you need to decommission that machine as well.
2828
:::
2929

30-
### Node backup
30+
## Node backup
3131

32-
If you have followed [the dedicated Node setup guide](../installation.md), you most likely have (at least) these files in the folder with your node configuration:
32+
### SSV Stack setup
33+
34+
If you have followed the [automatic node setup with SSV Stack](../node-setup), your files should be in `/ssv-stack/ssv-node-data` directory.
35+
36+
### Manual Node setup
37+
38+
If you have followed [the Manual Node setup guide](../node-setup/manual-setup), you most likely have (at least) these files in the folder with your node configuration:
3339

3440
```
3541
⇒ tree
@@ -64,7 +70,7 @@ The configuration file (`config.yaml` in the code snippet above), is necessary f
6470

6571
Operator keys are, essentially, the authentication method to identify an SSV node, and link it to an operator ID. As a consequence, whenever a node is moved to a different machine, they **absolutely must** be preserved and copied from the existing setup to the new one.
6672

67-
The files in question are `encrypted_private_key.json` and `password` in the snippet above and if you have followed [the Node setup guide](../installation.md), the filenames should be the same for you.
73+
The files in question are `encrypted_private_key.json` and `password` in the snippet above and if you have followed [the Manual Node setup guide](../node-setup/manual-setup), the filenames should be the same for you.
6874

6975
#### Node database
7076

0 commit comments

Comments
 (0)