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.

Sign up for GitHub

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

Jump to bottom

Add goerli tab #251

Merged
merged 3 commits into from
Nov 30, 2023
Merged

Add goerli tab #251

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9559d31
Add goerli tab
LukeHackett12 Aug 23, 2023
1310146
add exit tabs
LukeHackett12 Oct 26, 2023
c0530af
Formatting adjustment but hasn't changed copy recognition but looks t…
OisinKyne Nov 30, 2023
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
275 changes: 204 additions & 71 deletions docs/int/quickstart/quickstart-exit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Exit a validator

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';

# Exit a DV

Expand All @@ -17,112 +18,244 @@ Users looking to exit staking entirely and withdraw their full balance back must
This process will take 27 hours or longer depending on the current length of the exit queue.

:::info

- A threshold of operators needs to run the exit command for the exit to succeed.
- If a charon client restarts after the exit command is run but before the threshold is reached, it will lose the partial exits it has received from the other nodes. If all charon clients restart and thus all partial exits are lost before the required threshold of exit messages are received, operators will have to rebroadcast their partial exit messages.
:::
:::

## Run the `voluntary-exit` command on your validator client

Run the appropriate command on your validator client to broadcast an exit message from your validator client to its upstream charon client.

It needs to be the validator client that is connected to your charon client taking part in the DV, as you are only signing a partial exit message, with a partial private key share, which your charon client will combine with the other partial exit messages from the other operators.
It needs to be the validator client that is connected to your charon client taking part in the DV, as you are only signing a partial exit message, with a partial private key share, which your charon client will combine with the other partial exit messages from the other operators.

:::info

- All operators need to use the same `EXIT_EPOCH` for the exit to be successful. Assuming you want to exit as soon as possible, the default epoch of `162304` included in the below commands should be sufficient.
- Partial exits can be broadcasted by any validator client as long as the sum reaches the threshold for the cluster.
:::
:::

<Tabs groupId="validator-clients">
<TabItem value="teku" label="Teku" default>
<pre>
<code>
{String.raw`docker exec -ti charon-distributed-validator-node-teku-1 /opt/teku/bin/teku voluntary-exit \
--beacon-node-api-endpoint="http://charon:3600/" \
--confirmation-enabled=false \
--validator-keys="/opt/charon/validator_keys:/opt/charon/validator_keys" \
--epoch=162304`}
</code>
</pre>
<TabItem value="Goerli" label="Goerli" default>
<Tabs groupId="validator-clients">
<TabItem value="teku" label="Teku" default>
<pre>
<code>
{String.raw`docker exec -ti charon-distributed-validator-node-teku-1 /opt/teku/bin/teku voluntary-exit \
--beacon-node-api-endpoint="http://charon:3600/" \
--confirmation-enabled=false \
--validator-keys="/opt/charon/validator_keys:/opt/charon/validator_keys" \
--epoch=162304`}
</code>
</pre>
</TabItem>
<TabItem value="nimbus" label="Nimbus">
The following executes an interactive command inside the Nimbus VC container. It copies all files and directories from the Keystore path <code>/home/user/data/charon</code> to the newly created <code>/home/user/data/wd</code> directory.
<br/><br/>
For each file in the <code>/home/user/data/wd/secrets</code> directory, it:
<li>Extracts the filename without the extension as the file name is the public key</li>
<li>Appends <code>{String.raw`--validator=<filename>`}</code> to the <code>command</code> variable.</li>
<li>Executes a program called <code>nimbus_beacon_node</code> with the following arguments:</li>
<ul>
<li><code>deposits exit</code> : Exits validators</li>
<li><code>$command</code> : The generated command string from the loop.</li>
<li><code>--epoch=162304</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--rest-url=http://charon:3600/</code> : Specifies the Charon <code>host:port</code></li>
<li><code>--data-dir=/home/user/charon/</code> : Specifies the <code>Keystore path</code> which has all the validator keys. There will be a <code>secrets</code> and a <code>validators</code> folder inside it.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-nimbus-1 /bin/bash -c '\

mkdir /home/user/data/wd
cp -r /home/user/data/charon/ /home/user/data/wd

command=""; \
for file in /home/user/data/wd/secrets/*; do \
filename=$(basename "$file" | cut -d. -f1); \
command+=" --validator=$filename"; \
done; \

/home/user/nimbus_beacon_node deposits exit $command --epoch=162304 --rest-url=http://charon:3600/ --data-dir=/home/user/data/wd/'`}
</code>
</pre>
</TabItem>
<TabItem value="lodestar" label="Lodestar" default>
The following executes an interactive command inside the Loestar VC container to exit all validators. It executes
<code>node /usr/app/packages/cli/bin/lodestar validator voluntary-exit</code> with the arguments:
<ul>
<li><code>--beaconNodes="http://charon:3600"</code> : Specifies the Charon <code>host:port</code>.</li>
<li><code>--data-dir=/opt/data</code> : Specifies the folder where the key stores were imported.</li>
<li><code>--exitEpoch=162304</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--network=goerli</code> : Specifies the network.</li>
<li><code>--yes</code> : Skips confirmation prompt.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-lodestar-1 /bin/sh -c 'node /usr/app/packages/cli/bin/lodestar validator voluntary-exit --beaconNodes="http://charon:3600" --dataDir=/opt/data --exitEpoch=162304 --network=goerli --yes'`}
</code>
</pre>
</TabItem>
</Tabs>
</TabItem>
<TabItem value="nimbus" label="Nimbus">
The following executes an interactive command inside the Nimbus VC container. It copies all files and directories from the Keystore path <code>/home/user/data/charon</code> to the newly created <code>/home/user/data/wd</code> directory.
<br/><br/>
For each file in the <code>/home/user/data/wd/secrets</code> directory, it:
<li>Extracts the filename without the extension as the file name is the public key</li>
<li>Appends <code>{String.raw`--validator=<filename>`}</code> to the <code>command</code> variable.</li>
<li>Executes a program called <code>nimbus_beacon_node</code> with the following arguments:</li>
<ul>
<li><code>deposits exit</code> : Exits validators</li>
<li><code>$command</code> : The generated command string from the loop.</li>
<li><code>--epoch=162304</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--rest-url=http://charon:3600/</code> : Specifies the Charon <code>host:port</code></li>
<li><code>--data-dir=/home/user/charon/</code> : Specifies the <code>Keystore path</code> which has all the validator keys. There will be a <code>secrets</code> and a <code>validators</code> folder inside it.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-nimbus-1 /bin/bash -c '\

mkdir /home/user/data/wd
cp -r /home/user/data/charon/ /home/user/data/wd

command=""; \
for file in /home/user/data/wd/secrets/*; do \
filename=$(basename "$file" | cut -d. -f1); \
command+=" --validator=$filename"; \
done; \

/home/user/nimbus_beacon_node deposits exit $command --epoch=162304 --rest-url=http://charon:3600/ --data-dir=/home/user/data/wd/'`}
</code>
</pre>
<TabItem value="Holesky" label="Holesky">
<Tabs groupId="validator-clients">
<TabItem value="teku" label="Teku" default>
<pre>
<code>
{String.raw`docker exec -ti charon-distributed-validator-node-teku-1 /opt/teku/bin/teku voluntary-exit \
--beacon-node-api-endpoint="http://charon:3600/" \
--confirmation-enabled=false \
--validator-keys="/opt/charon/validator_keys:/opt/charon/validator_keys" \
--epoch=256`}
</code>
</pre>
</TabItem>
<TabItem value="nimbus" label="Nimbus">
The following executes an interactive command inside the Nimbus VC container. It copies all files and directories from the Keystore path <code>/home/user/data/charon</code> to the newly created <code>/home/user/data/wd</code> directory.
<br/><br/>
For each file in the <code>/home/user/data/wd/secrets</code> directory, it:
<li>Extracts the filename without the extension as the file name is the public key</li>
<li>Appends <code>{String.raw`--validator=<filename>`}</code> to the <code>command</code> variable.</li>
<li>Executes a program called <code>nimbus_beacon_node</code> with the following arguments:</li>
<ul>
<li><code>deposits exit</code> : Exits validators</li>
<li><code>$command</code> : The generated command string from the loop.</li>
<li><code>--epoch=256</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--rest-url=http://charon:3600/</code> : Specifies the Charon <code>host:port</code></li>
<li><code>--data-dir=/home/user/charon/</code> : Specifies the <code>Keystore path</code> which has all the validator keys. There will be a <code>secrets</code> and a <code>validators</code> folder inside it.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-nimbus-1 /bin/bash -c '\

mkdir /home/user/data/wd
cp -r /home/user/data/charon/ /home/user/data/wd

command=""; \
for file in /home/user/data/wd/secrets/*; do \
filename=$(basename "$file" | cut -d. -f1); \
command+=" --validator=$filename"; \
done; \

/home/user/nimbus_beacon_node deposits exit $command --epoch=256 --rest-url=http://charon:3600/ --data-dir=/home/user/data/wd/'`}
</code>
</pre>
</TabItem>
<TabItem value="lodestar" label="Lodestar" default>
The following executes an interactive command inside the Loestar VC container to exit all validators. It executes
<code>node /usr/app/packages/cli/bin/lodestar validator voluntary-exit</code> with the arguments:
<ul>
<li><code>--beaconNodes="http://charon:3600"</code> : Specifies the Charon <code>host:port</code>.</li>
<li><code>--data-dir=/opt/data</code> : Specifies the folder where the key stores were imported.</li>
<li><code>--exitEpoch=256</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--network=holesky</code> : Specifies the network.</li>
<li><code>--yes</code> : Skips confirmation prompt.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-lodestar-1 /bin/sh -c 'node /usr/app/packages/cli/bin/lodestar validator voluntary-exit --beaconNodes="http://charon:3600" --dataDir=/opt/data --exitEpoch=256 --network=holesky --yes'`}
</code>
</pre>
</TabItem>
</Tabs>
</TabItem>
<TabItem value="lodestar" label="Lodestar" default>
The following executes an interactive command inside the Loestar VC container to exit all validators. It executes
<code>node /usr/app/packages/cli/bin/lodestar validator voluntary-exit</code> with the arguments:
<ul>
<li><code>--beaconNodes="http://charon:3600"</code> : Specifies the Charon <code>host:port</code>.</li>
<li><code>--data-dir=/opt/data</code> : Specifies the folder where the key stores were imported.</li>
<li><code>--exitEpoch=162304</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--network=goerli</code> : Specifies the network.</li>
<li><code>--yes</code> : Skips confirmation prompt.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-lodestar-1 /bin/sh -c 'node /usr/app/packages/cli/bin/lodestar validator voluntary-exit --beaconNodes="http://charon:3600" --dataDir=/opt/data --exitEpoch=162304 --network=goerli --yes'`}
</code>
</pre>
<TabItem value="Mainnet" label="Mainnet">
<Tabs groupId="validator-clients">
<TabItem value="teku" label="Teku" default>
<pre>
<code>
{String.raw`docker exec -ti charon-distributed-validator-node-teku-1 /opt/teku/bin/teku voluntary-exit \
--beacon-node-api-endpoint="http://charon:3600/" \
--confirmation-enabled=false \
--validator-keys="/opt/charon/validator_keys:/opt/charon/validator_keys" \
--epoch=194048`}
</code>
</pre>
</TabItem>
<TabItem value="nimbus" label="Nimbus">
The following executes an interactive command inside the Nimbus VC container. It copies all files and directories from the Keystore path <code>/home/user/data/charon</code> to the newly created <code>/home/user/data/wd</code> directory.
<br/><br/>
For each file in the <code>/home/user/data/wd/secrets</code> directory, it:
<li>Extracts the filename without the extension as the file name is the public key</li>
<li>Appends <code>{String.raw`--validator=<filename>`}</code> to the <code>command</code> variable.</li>
<li>Executes a program called <code>nimbus_beacon_node</code> with the following arguments:</li>
<ul>
<li><code>deposits exit</code> : Exits validators</li>
<li><code>$command</code> : The generated command string from the loop.</li>
<li><code>--epoch=194048</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--rest-url=http://charon:3600/</code> : Specifies the Charon <code>host:port</code></li>
<li><code>--data-dir=/home/user/charon/</code> : Specifies the <code>Keystore path</code> which has all the validator keys. There will be a <code>secrets</code> and a <code>validators</code> folder inside it.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-nimbus-1 /bin/bash -c '\

mkdir /home/user/data/wd
cp -r /home/user/data/charon/ /home/user/data/wd

command=""; \
for file in /home/user/data/wd/secrets/*; do \
filename=$(basename "$file" | cut -d. -f1); \
command+=" --validator=$filename"; \
done; \

/home/user/nimbus_beacon_node deposits exit $command --epoch=194048 --rest-url=http://charon:3600/ --data-dir=/home/user/data/wd/'`}
</code>
</pre>
</TabItem>
<TabItem value="lodestar" label="Lodestar" default>
The following executes an interactive command inside the Loestar VC container to exit all validators. It executes
<code>node /usr/app/packages/cli/bin/lodestar validator voluntary-exit</code> with the arguments:
<ul>
<li><code>--beaconNodes="http://charon:3600"</code> : Specifies the Charon <code>host:port</code>.</li>
<li><code>--data-dir=/opt/data</code> : Specifies the folder where the key stores were imported.</li>
<li><code>--exitEpoch=194048</code> : The epoch upon which to submit the voluntary exit.</li>
<li><code>--network=mainnet</code> : Specifies the network.</li>
<li><code>--yes</code> : Skips confirmation prompt.</li>
</ul>
<pre>
<code>
{String.raw`docker exec -it charon-distributed-validator-node-lodestar-1 /bin/sh -c 'node /usr/app/packages/cli/bin/lodestar validator voluntary-exit --beaconNodes="http://charon:3600" --dataDir=/opt/data --exitEpoch=194048 --network=mainnet --yes'`}
</code>
</pre>
</TabItem>
</Tabs>
</TabItem>
</Tabs>

Once a threshold of exit signatures has been received by any single charon client, it will craft a valid voluntary exit message and will submit it to the beacon chain for inclusion. You can monitor partial exits stored by each node in the [Grafana Dashboard](https://github.com/ObolNetwork/charon-distributed-validator-node).

## Exit epoch and withdrawable epoch

The process of a validator exiting from staking takes variable amounts of time, depending on how many others are exiting at the same time.

Immediately upon broadcasting a signed voluntary exit message, the exit epoch and withdrawable epoch values are calculated based off the current epoch number. These values determine exactly when the validator will no longer be required to be online performing validation, and when the validator is eligible for a full withdrawal respectively.

1. Exit epoch - epoch at which your validator is no longer active, no longer earning rewards, and is no longer subject to slashing rules.
:::caution
Up until this epoch (while "in the queue") your validator is expected to be online and is held to the same slashing rules as always. Do not turn your DV node off until this epoch is reached.
:::
:::caution
Up until this epoch (while "in the queue") your validator is expected to be online and is held to the same slashing rules as always. Do not turn your DV node off until this epoch is reached.
:::
2. Withdrawable epoch - epoch at which your validator funds are eligible for a full withdrawal during the next validator sweep.
This occurs 256 epochs after the exit epoch, which takes ~27.3 hours.
This occurs 256 epochs after the exit epoch, which takes ~27.3 hours.

## How to verify a validator exit

Consult the examples below and compare them to your validator's monitoring to verify that exits from each operator in the cluster are being received. This example is a cluster of 4 nodes with 2 validators and threshold of 3 nodes broadcasting exits are needed.

1. Operator 1 broadcasts an exit on validator client 1.
![Verify in Grafana Exit panel](/img/ExitPromQuery-01.png)
![Verify in Grafana Exit panel](/img/DutyExit-01.png)
![Verify in Grafana Exit panel](/img/ExitPromQuery-01.png)
![Verify in Grafana Exit panel](/img/DutyExit-01.png)
2. Operator 2 broadcasts an exit on validator client 2.
![Verify in Grafana Exit panel](/img/ExitPromQuery-02.png)
![Verify in Grafana Exit panel](/img/DutyExit-02.png)
![Verify in Grafana Exit panel](/img/ExitPromQuery-02.png)
![Verify in Grafana Exit panel](/img/DutyExit-02.png)
3. Operator 3 broadcasts an exit on validator client 3.
![Verify in Grafana Exit panel](/img/ExitPromQuery-03.png)
![Verify in Grafana Exit panel](/img/DutyExit-03.png)
![Verify in Grafana Exit panel](/img/ExitPromQuery-03.png)
![Verify in Grafana Exit panel](/img/DutyExit-03.png)

At this point, the threshold of 3 has been reached and the validator exit process will start. The logs will show the following:
![Verify in Grafana Exit panel](/img/ExitLogs.png)
![Verify in Grafana Exit panel](/img/ExitLogs.png)

:::tip
Once a validator has broadcasted an exit message, it must continue to validate for at least 27 hours or longer. Do not shut off your distributed validator nodes until your validator is fully exited.
:::
:::
Loading