Skip to content

Commit

Permalink
Updated split existing validator private keys page (#300)
Browse files Browse the repository at this point in the history
* Updated split existing validator private keys page

* Update docs/int/quickstart/advanced/quickstart-split.md

Co-authored-by: Thomas H <107747791+thomasheremans@users.noreply.github.com>

* Changed output structure

---------

Co-authored-by: Thomas H <107747791+thomasheremans@users.noreply.github.com>
  • Loading branch information
pinebit and thomasheremans authored Feb 8, 2024
1 parent 07d0d27 commit b9197b0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/int/quickstart/advanced/quickstart-split.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Charon is in a beta state and should be used with caution according to its [Term
This process should only be used if you want to split an *existing validator private key* into multiple private key shares for use in a Distributed Validator Cluster. If your existing validator is not properly shut down before the Distributed Validator starts, your validator may be slashed.

If you are starting a new validator, you should follow a [quickstart guide](../index.md) instead.

If you use MEV-Boost, make sure you turned off your MEV-Boost service for the time of splitting the keys, otherwise you may hit [this issue](https://github.com/ObolNetwork/charon/issues/2770).
:::

Split an existing Ethereum validator key into multiple key shares for use in an [Obol Distributed Validator Cluster](../../key-concepts#distributed-validator-cluster).
Expand Down Expand Up @@ -65,7 +67,7 @@ NODES= # The number of nodes in the cluster.
docker run --rm -v $(pwd):/opt/charon obolnetwork/charon:${CHARON_VERSION} create cluster --name="${CLUSTER_NAME}" --withdrawal-addresses="${WITHDRAWAL_ADDRESS}" --fee-recipient-addresses="${FEE_RECIPIENT_ADDRESS}" --split-existing-keys --split-keys-dir=/opt/charon/split_keys --nodes ${NODES} --network goerli
```

The above command will create `validator_keys` along with `cluster-lock.json` in `./.charon/cluster` for each node.
The above command will create `validator_keys` along with `cluster-lock.json` in `./cluster` for each node.

Command output:

Expand All @@ -79,7 +81,7 @@ Command output:
Created charon cluster:
--split-existing-keys=true
.charon/cluster/
./cluster/
├─ node[0-*]/ Directory for each node
│ ├─ charon-enr-private-key Charon networking private key for node authentication
│ ├─ cluster-lock.json Cluster lock defines the cluster lock file which is signed by all nodes
Expand Down

0 comments on commit b9197b0

Please sign in to comment.