Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs revamp #302

Closed
wants to merge 21 commits into from
Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/int/quickstart/alone/create-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Alternatively, the private key shares can be created in a lower-trust manner wit

## Pre-requisites

- Ensure you have [docker](https://docs.docker.com/engine/install/) installed.
- A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators.
- Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't have to be docker desktop, in fact most people will only have the engine installed and not the UI as they are not running a node with a UI framework installed

- Make sure `docker` is running before executing the commands below.

## Create the key shares locally
Expand Down
3 changes: 2 additions & 1 deletion docs/int/quickstart/alone/test-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ The default cluster consists of:

## Pre-requisites

- Ensure you have [docker](https://docs.docker.com/engine/install/) installed.
- A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators.
- Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

- Ensure you have [git](https://git-scm.com/downloads) installed.
- Make sure `docker` is running before executing the commands below.

Expand Down
3 changes: 2 additions & 1 deletion docs/int/quickstart/group/quickstart-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ The following instructions aim to assist a group of operators coordinating toget

## Pre-requisites

- Ensure you have [docker](https://docs.docker.com/engine/install/) installed.
- A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators.
- Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

- Ensure you have [git](https://git-scm.com/downloads) installed.
- Make sure `docker` is running before executing the commands below.
- Decide who the Leader or Creator of your cluster will be. Only them have to perform [step 2](#step-2-leader-creates-the-dkg-configuration-file-and-distributes-it-to-everyone-else) and [step 5](#step-5-activate-the-deposit-data) in this quickstart. They do not get any special privilege.
Expand Down
18 changes: 14 additions & 4 deletions docs/int/quickstart/group/quickstart-group-leader-creator.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ These roles hold no position of privilege in the cluster, they only set the init
The person creating the cluster <b>will</b> be a node operator in the cluster.<br /><br />
<h1>Pre-requisites</h1>
<ul>
<li>Ensure you have <a href="https://docs.docker.com/engine/install/" target="_blank">docker</a> installed.</li>
<li>A basic <a href="https://docs.ethstaker.cc/ethstaker-knowledge-base/" target="_blank">knowledge</a> of Ethereum nodes and validators.</li>
<li>Ensure you have <a href="https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop" target="_blank">docker</a> installed.</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

<li>Ensure you have <a href="https://git-scm.com/downloads" target="_blank">git</a> installed.</li>
<li>Make sure <code>docker</code> is running before executing the commands below.</li>
</ul>
Expand All @@ -32,6 +33,8 @@ These roles hold no position of privilege in the cluster, they only set the init

## Overview Video

This video shows the flow within the [DV Launchpad](https://docs.obol.tech/docs/dvl/intro#dv-launchpad-links):

<p align="center"><iframe width="560" height="315" src="https://www.youtube.com/embed/OK6WE8te33Q" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>

## Step 1. Collect Ethereum addresses of the cluster operators
Expand All @@ -42,7 +45,7 @@ Before starting the cluster creation, you will need to collect one Ethereum addr
<Tabs groupId="leader-creator">
<TabItem value="leader" label="Leader" default>

In order to prepare for a distributed key generation ceremony, you need to create an [ENR](docs/int/faq/errors.mdx#enrs-keys) for your charon client. Operators in your cluster will also need to do this step, as per their [quickstart](./quickstart-group-operator#step-2-create-and-back-up-a-private-key-for-charon). This ENR is a public/private key pair, and allows the other charon clients in the DKG to identify and connect to your node.
In order to prepare for a distributed key generation ceremony, you need to create an [ENR](docs/int/faq/errors.mdx#enrs-keys) for your charon client. Operators in your cluster will also need to do this step as per their [quickstart](./quickstart-group-operator#step-2-create-and-back-up-a-private-key-for-charon). This ENR is a public/private key pair, and allows the other charon clients in the DKG to identify and connect to your node.

```sh
# Clone this repo
Expand All @@ -66,10 +69,17 @@ If instead of being shown your `enr` you see an error saying `permission denied`
Ensure you create a backup of the private key stored in the '.charon' folder, specifically at '.charon/charon-enr-private-key'. This is the file used to generate your private key. Be careful not to commit it to git! **If you lose this file you won't be able to take part in the DKG ceremony and start the DV cluster successfully.**
:::

:::info
The `charon-distributed-validator-node` repo is set by default to the Holesky testnet. If you wish to change the network, copy the file `.env.sample` inside the `charon-distributed-validator-node` folder, uncommenting line 5 and setting a value for `NETWORK`, saving the new file with the name `.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.
:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good but not sure it is in the right place. On this page before running the node is probably better? http://localhost:3000/docs/next/int/quickstart/group/quickstart-group-operator. As per the other conversation, this will only be relevant for the users using docker CDVN and should be under a tab moving forward



</TabItem>
<TabItem value="creator" label="Creator">

This step is not needed and you can move on to [Step 3](#step-3-create-the-dkg-configuration-file-and-distribute-it-to-cluster-operators).
This step is not needed, you can move on to [Step 3](#step-3-create-the-dkg-configuration-file-and-distribute-it-to-cluster-operators).

</TabItem>
</Tabs>
Expand All @@ -78,7 +88,7 @@ Ensure you create a backup of the private key stored in the '.charon' folder, sp

You will prepare the configuration file for the distributed key generation ceremony using the launchpad.

1. Go to the [DV Launchpad](https://goerli.launchpad.obol.tech)
1. Go to the [DV Launchpad](https://docs.obol.tech/docs/dvl/intro#dv-launchpad-links)
2. Connect your wallet

![Connect your Wallet](/img/Guide01.png)
Expand Down
8 changes: 6 additions & 2 deletions docs/int/quickstart/group/quickstart-group-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ Charon is in a beta state and should be used with caution according to its [Term
The following instructions aim to assist a group of operators coordinating together to create a distributed validator cluster after receiving an cluster invite link from a leader or creator.

## Overview Video

This video shows the flow within the [DV Launchpad](https://docs.obol.tech/docs/dvl/intro#dv-launchpad-links):

<p align="center"><iframe width="560" height="315" src="https://www.youtube.com/embed/6pXASqjAQbs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>

## Pre-requisites

- Ensure you have [docker](https://docs.docker.com/engine/install/) installed.
- A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators.
- Ensure you have [docker](https://docs.docker.com/desktop/install/ubuntu/#install-docker-desktop) installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

- Ensure you have [git](https://git-scm.com/downloads) installed.
- Make sure `docker` is running before executing the commands below.

Expand Down Expand Up @@ -73,7 +77,7 @@ After receiving the invite link created by the **Leader** or **Creator**, you wi

7. Wait for all the other operators in your cluster to do the same.

## Step 4. Run the DKG
## Step 4. Run the DKG
:::info
For the [DKG](docs/charon/dkg.md) to complete, all operators need to be running the command simultaneously. It helps to coordinate an agreed upon time amongst operators at which to run the command.
:::
Expand Down
3 changes: 2 additions & 1 deletion docs/int/quickstart/quickstart-mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ This section is intended for users who wish to run their Distributed Validator o

## Pre-requisites

- A basic [knowledge](https://docs.ethstaker.cc/ethstaker-knowledge-base/) of Ethereum nodes and validators.
- You have [enough up-to-spec nodes](../key-concepts.md#distributed-validator-threshold) for your mainnet deployment.
- Ensure you have [docker](https://docs.docker.com/engine/install/) installed on each node.
- Ensure you have [docker](https://docs.docker.com/desktop/install/linux-install/#generic-installation-steps) installed on each node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

- Ensure you have [git](https://git-scm.com/downloads) installed on each node.
- Make sure `docker` is running before executing the commands below.

Expand Down
Loading