ObolNetwork · OisinKyne · Aug 22, 2023 · Jul 12, 2023 · Jul 12, 2023 · Aug 21, 2023
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ This repo contains a [charon](https://github.com/ObolNetwork/charon) distributed
 
 This repo aims to give users a feel for what a [Distributed Validator Cluster](https://docs.obol.tech/docs/int/key-concepts#distributed-validator-cluster) means in practice, and what the future of high-availability, fault-tolerant proof of stake validating deployments will look like.
 
+**This repo runs on a single machine, with only one execution and consensus client, you do not have fault tolerance with this setup, and this is only for demonstration purposes only, and should not be used in a production context.**
+
 A distributed validator cluster is a docker-compose file with the following containers running:
 
 - Single [Nethermind](https://github.com/NethermindEth/nethermind) execution layer client
@@ -22,161 +24,7 @@ In the future, this repo aims to contain compose files for every possible Execut
 
 ## Quickstart
 
-Ensure you have [docker](https://docs.docker.com/engine/install/) and [git](https://git-scm.com/downloads) installed. Also, make sure `docker` is running before executing the commands below.
-
-1. Clone the [charon-distributed-validator-cluster](https://github.com/ObolNetwork/charon-distributed-validator-cluster) repo and `cd` into the directory.
-
-   ```sh
-   # Clone the repo
-   git clone https://github.com/ObolNetwork/charon-distributed-validator-cluster.git
-
-   # Change directory
-   cd charon-distributed-validator-cluster/
-   ```
-
-1. Prepare the environment variables
-
-   ```sh
-   # Copy the sample environment variables
-   cp .env.sample .env
-   ```
-   `.env.sample` is a sample environment file that allows overriding default configuration defined in `docker-compose.yml`. Uncomment and set any variable to override its value.
-
-1. Create the artifacts needed to run a testnet distributed validator cluster
-
-   ```sh
-   # Define cluster name and number of validators
-   CLUSTER_NAME=<cluster_name>
-   NUM_VALS=1
-   # Define withdrawal and fee recipient addresses for each validator (comma separated)
-   WITHDRAWAL_ADDRS=0x000000000000000000000000000000000000dead
-   FEE_RECIPIENT_ADDRS=0x000000000000000000000000000000000000dead
-
-   docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v0.15.0 create cluster \
-    --withdrawal-addresses "$WITHDRAWAL_ADDRS" \
-    --fee-recipient-addresses "$FEE_RECIPIENT_ADDRS" \
-    --name "$CLUSTER_NAME" --nodes 6 --threshold 5 --num-validators $NUM_VALS --network goerli
-   ```
-
-1. Start the cluster
-   ```sh
-   # Start the distributed validator cluster
-   docker compose up -d --build
-   ```
-1. Checkout the monitoring dashboard and see if things look all right
-
-   ```sh
-   # Open Grafana
-   open http://localhost:3000/d/laEp8vupp
-   ```
-
-If everything goes correctly, it's natural to see logs like:
-
-`INFO sched      No active DVs for slot {"slot": 3288627}`
-
-This is because you need to activate your freshly created distributed validator on the testnet with the [existing launchpad](https://prater.launchpad.ethereum.org/en/). The validator deposit data should be
-present inside each `node` directory, for example, `.charon/cluster/node0/deposit-data.json`.
-
-## Distributed Validator Cluster
-
-The default cluster consists of:
-- [Nethermind](https://github.com/NethermindEth/nethermind), an execution layer client
-- [Lighthouse](https://github.com/sigp/lighthouse), a consensus layer client
-- Six [charon](https://github.com/ObolNetwork/charon) nodes
-- Mixture of validator clients:
-  - vc0: [Lighthouse](https://github.com/sigp/lighthouse)
-  - vc1: [Teku](https://github.com/ConsenSys/teku)
-  - vc2: [Nimbus](https://github.com/status-im/nimbus-eth2)
-  - vc3: [Lighthouse](https://github.com/sigp/lighthouse)
-  - vc4: [Teku](https://github.com/ConsenSys/teku)
-  - vc5: [Nimbus](https://github.com/status-im/nimbus-eth2)
-
-The intention is to support all validator clients, and work is underway to add support for lodestar to this repo, with prysm support to follow
-in the future. Read more about our client support [here](https://dvt.obol.tech/#1d534fbaeb5a438b864fa30ad1306634).
-
-## Create Distributed Validator Keys
-
-Create some testnet private keys for a six node distributed validator cluster with the following command:
-
-   ```sh
-   # Define cluster name and number of validators
-   CLUSTER_NAME=<cluster_name>
-   NUM_VALS=1
-   # Define withdrawal and fee recipient addresses for each validator (comma separated)
-   WITHDRAWAL_ADDRS=0x000000000000000000000000000000000000dead
-   FEE_RECIPIENT_ADDRS=0x000000000000000000000000000000000000dead
-
-   docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v0.15.0 create cluster \
-    --withdrawal-addresses "$WITHDRAWAL_ADDRS" \
-    --fee-recipient-addresses "$FEE_RECIPIENT_ADDRS" \
-    --name "$CLUSTER_NAME" --nodes 6 --threshold 5 --num-validators $NUM_VALS --network goerli
-   ```
-
-This command will create a subdirectory `.charon/cluster`. In it are six folders, one for each charon node created. Each folder contains partial private keys that together make up distributed validators defined in the `cluster-lock.json` file.
-
-### Activate your validator
-
-Along with the private keys and cluster lock file is a validator deposit data file located inside each node folder. For example, you can find the deposit data file inside the `node0` folder at
-`.charon/cluster/node0/deposit-data.json`. You can use the original [staking launchpad](https://goerli.launchpad.ethereum.org/) app to activate your new validator with the original UI.
-
-Your deposit will take at minimum 8 hours to process, near to the time you can run this new cluster with the command:
-
-```
-docker compose up -d --build
-```
-
-## Import Existing Validator Keys
-
-You might already have keys to an active validator, or are more comfortable creating keys with existing tooling like the [staking deposit CLI](https://github.com/ethereum/staking-deposit-cli) and [ethdo](https://github.com/wealdtech/ethdo).
-
-To import existing EIP-2335 validator key stores:
-
-```sh
-# Create a folder within this checked out repo
-mkdir split_keys
-
-# Put the validator `keystore.json` files in this folder.
-# Alongside them, with a matching filename but ending with `.txt` should be the password to the keystore.
-# E.g., keystore-0.json keystore-0.txt
-
-# Define withdrawal and fee recipient addresses for each validator (comma separated)
-WITHDRAWAL_ADDRS=0x000000000000000000000000000000000000dead
-FEE_RECIPIENT_ADDRS=0x000000000000000000000000000000000000dead
-
-# Split these keystores into "n" (--nodes) key shares with "t" (--threshold) as threshold for a distributed validator
-# Define cluster name and number of validators
-CLUSTER_NAME=<cluster_name>
-NUM_VALS=1
-# Define withdrawal and fee recipient addresses for each validator (comma separated)
-WITHDRAWAL_ADDRS=0x000000000000000000000000000000000000dead
-FEE_RECIPIENT_ADDRS=0x000000000000000000000000000000000000dead
-
-docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v0.15.0 create cluster \
---withdrawal-addresses "$WITHDRAWAL_ADDRS" \
---fee-recipient-addresses "$FEE_RECIPIENT_ADDRS" \
---name "$CLUSTER_NAME" --nodes 6 --threshold 5 --num-validators $NUM_VALS --network goerli
-
-# The above command will create 6 validator key shares along with cluster-lock.json and deposit-data.json in ./.charon/cluster :
-
-***************** WARNING: Splitting keys **********************
- Please make sure any existing validator has been shut down for
- at least 2 finalised epochs before starting the charon cluster,
- otherwise slashing could occur.
-****************************************************************
-
-Created charon cluster:
- --split-existing-keys=true
-
-.charon/cluster/
-├─ node[0-5]/                   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
-│  ├─ deposit-data.json         Deposit data file is used to activate a Distributed Validator on DV Launchpad
-│  ├─ validator_keys            Validator keystores and password
-│  │  ├─ keystore-*.json        Validator private share key for duty signing
-│  │  ├─ keystore-*.txt         Keystore password files for keystore-*.json
-
-```
+You can view a quickstart guide for testing this repo out on our [docs site](https://docs.obol.tech/docs/next/int/quickstart/alone/test-locally).
 
 ## Project Status
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -3,7 +3,7 @@ version: "3.8"
 x-node-base:
   # Pegged charon version (update this for each release).
   &node-base
-  image: obolnetwork/charon:${CHARON_VERSION:-v0.16.0}
+  image: obolnetwork/charon:${CHARON_VERSION:-v0.17.0}
   restart: unless-stopped
   networks: [ cluster ]
   depends_on: [ relay ]