Skip to content

Update docs to use version v1.5.0 #562

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/adv/advanced/quickstart-combine.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Run the following command:

```shell
# Combine a clusters private keys
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 combine --cluster-dir /opt/charon/cluster --output-dir /opt/charon/combined
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 combine --cluster-dir /opt/charon/cluster --output-dir /opt/charon/combined
```

This command will store the combined keys in the `output-dir`, in this case a folder named `combined`.
Expand Down
2 changes: 1 addition & 1 deletion docs/adv/advanced/quickstart-split.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ At the end of this process, you should have a tree like this:
Run the following docker command to split the keys (for mainnet):

```shell
CHARON_VERSION= # E.g. v1.2.0
CHARON_VERSION= # E.g. v1.5.0
CLUSTER_NAME= # The name of the cluster you want to create.
WITHDRAWAL_ADDRESS= # The address you want to use for withdrawals (this is just for accuracy in your lock file, you can't change a withdrawal address for a validator that has already been deposited)
FEE_RECIPIENT_ADDRESS= # The address you want to use for block reward and MEV payments.
Expand Down
2 changes: 1 addition & 1 deletion docs/adv/troubleshooting/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ docker compose logs

`cd` to the directory where your private keys are located (ex: `cd /path/to/charon/enr/private/key`)

Run `docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 enr`. This prints the ENR on your screen.
Run `docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 enr`. This prints the ENR on your screen.

### What do I do if lose my `charon-enr-private-key`?

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/charon/charon-cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 5

# CLI Reference

The following is a reference for Charon version [`v1.2.0`](https://github.com/ObolNetwork/charon/releases/tag/v1.2.0). Find the latest release on [our Github](https://github.com/ObolNetwork/charon/releases).
The following is a reference for Charon version [`v1.5.0`](https://github.com/ObolNetwork/charon/releases/tag/v1.5.0). Find the latest release on [our Github](https://github.com/ObolNetwork/charon/releases).

The following are the top-level commands available to use.

Expand Down
2 changes: 1 addition & 1 deletion docs/run/integrations/lido-csm.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ cd charon-distributed-validator-node
Use docker to create an ENR

```sh
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 create enr
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 create enr
```

### Back up the private key located in `.charon/charon-enr-private-key`
Expand Down
30 changes: 15 additions & 15 deletions docs/run/prepare/test-command.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Intended for running tests across all categories. Each flag should have a prefix

<h3>Example run</h3>
```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
Expand All @@ -371,7 +371,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-definition-file="/opt/charon/test/.charon/cluster-definition.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
Expand All @@ -390,7 +390,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-lock-file="/opt/charon/test/.charon/cluster-lock.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key"
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
Expand Down Expand Up @@ -420,7 +420,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="http://lighthouse:5052/" \
Expand All @@ -446,7 +446,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-definition-file="/opt/charon/test/.charon/cluster-definition.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="http://lighthouse:5052/" \
Expand All @@ -472,7 +472,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test all \
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test all \
--peers-lock-file="/opt/charon/test/.charon/cluster-lock.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="http://lighthouse:5052/" \
Expand Down Expand Up @@ -515,7 +515,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test peers \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test peers \
--enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--private-key-file="/opt/charon/test/.charon/charon-enr-private-key"
```
Expand All @@ -528,7 +528,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test peers \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test peers \
--definition-file="/opt/charon/test/.charon/cluster-definition.json" \
--private-key-file="/opt/charon/test/.charon/charon-enr-private-key"
```
Expand All @@ -541,7 +541,7 @@ Intended for running tests across all categories. Each flag should have a prefix
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test peers \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test peers \
--lock-file="/opt/charon/test/.charon/cluster-lock.json" \
--private-key-file="/opt/charon/test/.charon/charon-enr-private-key"
```
Expand All @@ -564,7 +564,7 @@ Run tests on beacon node(s), to evaluate their effectiveness for a Distributed V
<h3>Example run</h3>

```shell
docker run obolnetwork/charon:v1.2.0 alpha test beacon \
docker run obolnetwork/charon:v1.5.0 alpha test beacon \
--endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com"
```
</TabItem>
Expand All @@ -583,7 +583,7 @@ Run tests on beacon node(s), to evaluate their effectiveness for a Distributed V
<h3>Example run</h3>

```shell
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test beacon \
docker run --network="charon-distributed-validator-node_dvnode" -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test beacon \
--endpoints="http://lighthouse:5052/" \
--simulation-file-dir="/opt/charon/test" \
--load-test
Expand All @@ -605,7 +605,7 @@ Default endpoint for validator and port is used at `127.0.0.1:3600`. This can be
<h3>Example run</h3>

```shell
docker run --network="charon-distributed-validator-node_dvnode" obolnetwork/charon:v1.2.0 alpha test validator \
docker run --network="charon-distributed-validator-node_dvnode" obolnetwork/charon:v1.5.0 alpha test validator \
--validator-api-address="lodestar:5064"
```

Expand All @@ -624,7 +624,7 @@ At least 1 endpoint is required to be supplied to the `--endpoints` flag.
<h3>Example run</h3>

```shell
docker run obolnetwork/charon:v1.2.0 alpha test mev \
docker run obolnetwork/charon:v1.5.0 alpha test mev \
--endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz"
```

Expand All @@ -639,7 +639,7 @@ At least 1 endpoint is required to be supplied to the `--endpoints` flag.
<h3>Example run</h3>

```shell
docker run obolnetwork/charon:v1.2.0 alpha test mev \
docker run obolnetwork/charon:v1.5.0 alpha test mev \
--endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--load-test \
--beacon-node-endpoint="https://ethereum-beacon-api.publicnode.com"
Expand All @@ -660,7 +660,7 @@ None.
<h3>Example run</h3>

```shell
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.2.0 alpha test infra \
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.5.0 alpha test infra \
--disk-io-test-file-dir=/opt/charon/test
```

Expand Down
4 changes: 2 additions & 2 deletions docs/run/start/quickstart_alone.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The private key shares can be created centrally and distributed securely to each
cd charon-distributed-validator-cluster/

# Run the command provided in the DV Launchpad "Create a cluster alone" flow
docker run -u $(id -u):$(id -g) --rm -v "$(pwd)/:/opt/charon" obolnetwork/charon:v1.2.0 create cluster --definition-file=...
docker run -u $(id -u):$(id -g) --rm -v "$(pwd)/:/opt/charon" obolnetwork/charon:v1.5.0 create cluster --definition-file=...
```

</TabItem>
Expand All @@ -58,7 +58,7 @@ The private key shares can be created centrally and distributed securely to each
Check the [Charon CLI reference](../../learn/charon/charon-cli-reference.md#create-a-full-cluster-locally) for additional, optional flags to set.

```shell
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 create cluster \
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 create cluster \
--nodes=6 \
--network=holesky \
--num-validators=1 \
Expand Down
8 changes: 4 additions & 4 deletions docs/run/start/quickstart_group.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ git clone https://github.com/ObolNetwork/charon-distributed-validator-node.git
# Change directory
cd charon-distributed-validator-node/
# Use docker to create an ENR. Backup the file `.charon/charon-enr-private-key`.
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 create enr
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 create enr
```
You should expect to see a console output like this:
```logs
Expand Down Expand Up @@ -160,7 +160,7 @@ Create an ENR using charon:

```shell
# Use docker to create an ENR. Backup the file `.charon/charon-enr-private-key`.
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 create enr
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 create enr
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -312,7 +312,7 @@ For Step 2 of the quickstart:
Run the <code>charon create dkg</code> command that generates DKG
cluster-definition.json file.
<pre>
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 create dkg {'\n'}
docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 create dkg {'\n'}
--name="Quickstart" {'\n'}
--num-validators=1 {'\n'}
--fee-recipient-addresses="0x0000000000000000000000000000000000000000" {'\n'}
Expand Down Expand Up @@ -423,7 +423,7 @@ For the [DKG](../../learn/charon/dkg.md) to complete, all operators need to be r

</TabItem>
<TabItem value="CLI" label="CDVN">
Once the creator gives you the <code>cluster-definition.json</code> file and you place it in a <code>.charon</code> subdirectory, run: <pre>docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.2.0 dkg --publish</pre> and the DKG process should begin.
Once the creator gives you the <code>cluster-definition.json</code> file and you place it in a <code>.charon</code> subdirectory, run: <pre>docker run --rm -v "$(pwd):/opt/charon" obolnetwork/charon:v1.5.0 dkg --publish</pre> and the DKG process should begin.
</TabItem>
<TabItem value="DappnodeTab" label="Dappnode">
Follow this step if you are signing through the DV Launchpad, importing the cluster definition URL into the DappNode package's config & then running the DKG inside the DappNode, followed by cluster run.<br/>
Expand Down
7 changes: 7 additions & 0 deletions versioned_docs/version-vv1.5.0/adv/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "ADVANCED & TROUBLESHOOTING",
"position": 3,
"collapsed": false,
"collapsible": false,
"className": "menuSection"
}
5 changes: 5 additions & 0 deletions versioned_docs/version-vv1.5.0/adv/advanced/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Advanced Guides",
"position": 1,
"collapsed": true
}
38 changes: 38 additions & 0 deletions versioned_docs/version-vv1.5.0/adv/advanced/adv-docker-configs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_position: 6
description: Use advanced docker-compose features to have more flexibility and power to change the default configuration.
---

# Advanced Docker Configs

:::info
This section is intended for *docker power users*, i.e.: for those who are familiar with working with `docker compose` and want to have more flexibility and power to change the default configuration.
:::

We use the "Multiple Compose File" feature which provides a very powerful way to override any configuration in `docker-compose.yml` without needing to modify git-checked-in files since that results in conflicts when upgrading this repo.
See [this](https://docs.docker.com/compose/extends/#multiple-compose-files) for more details.

There are some additional compose files in [this repository](https://github.com/ObolNetwork/charon-distributed-validator-node/), `compose-debug.yml` and `docker-compose.override.yml.sample`, along-with the default `docker-compose.yml` file that you can use for this purpose.

- `compose-debug.yml` contains some additional containers that developers can use for debugging, like `jaeger`. To achieve this, you can run:

```shell
docker compose -f docker-compose.yml -f compose-debug.yml up
```

- `docker-compose.override.yml.sample` is intended to override the default configuration provided in `docker-compose.yml`. This is useful when, for example, you wish to add port mappings or want to disable a container.

- To use it, just copy the sample file to `docker-compose.override.yml` and customise it to your liking. Please create this file ONLY when you want to tweak something. This is because the default override file is empty and docker errors if you provide an empty compose file.

```shell
cp docker-compose.override.yml.sample docker-compose.override.yml

# Tweak docker-compose.override.yml and then run docker compose up
docker compose up
```

- You can also run all these compose files together. This is desirable when you want to use both the features. For example, you may want to have some debugging containers AND also want to override some defaults. To achieve this, you can run:

```shell
docker compose -f docker-compose.yml -f docker-compose.override.yml -f compose-debug.yml up
```
Loading