Skip to content

Commit

Permalink
docs: Include lido-status command
Browse files Browse the repository at this point in the history 
* docs: Include lido-status command

* docs: Adjust lido in  quickstart

* docs: Update clients and networks execution example

* docs: Add information about rewardAddress

* docs: update lido-status with --nodeID flag
  • Loading branch information
@khalifaa55
khalifaa55 authored Sep 12, 2024
1 parent 9563877 commit ea6586f
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 64 deletions.
124 changes: 71 additions & 53 deletions docs/docs/commands/clients.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,57 +30,75 @@ The execution of `sedge clients` will result in an output like this, that will s

```
$ sedge clients
2023-10-13 14:13:44 -- [INFO] [Logger Init] Log level: info
2023-10-13 14:13:45 -- [INFO] You are running the latest version of sedge. Version: v1.3.1
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network chiado
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 - teku teku
3 - lodestar lodestar
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network custom
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 - prysm prysm
3 - teku teku
4 - lodestar lodestar
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network gnosis
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 erigon teku teku
3 - lodestar lodestar
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network holesky
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 geth teku teku
3 erigon lodestar lodestar
4 besu prysm prysm
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network mainnet
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 geth prysm prysm
3 erigon teku teku
4 besu lodestar lodestar
2023-10-13 14:13:45 -- [INFO] Listing supported clients for network sepolia
# Execution Clients Consensus Clients Validator Clients
=== =================== =================== ===================
1 nethermind lighthouse lighthouse
2 geth prysm prysm
3 erigon teku teku
4 besu lodestar lodestar
2024-08-21 12:17:07 -- [INFO] [Logger Init] Log level: info
2024-08-21 12:17:08 -- [INFO] You are running the latest version of sedge. Version: v1.4.0
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network chiado
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │- │teku │teku
3 │- │lodestar │lodestar
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network custom
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │- │prysm │prysm
3 │- │teku │teku
4 │- │lodestar │lodestar
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network gnosis
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │erigon │teku │teku
3 │- │lodestar │lodestar
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network holesky
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │geth │prysm │prysm
3 │erigon │teku │teku
4 │besu │lodestar │lodestar
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network mainnet
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │geth │prysm │prysm
3 │erigon │teku │teku
4 │besu │lodestar │lodestar
2024-08-21 12:17:08 -- [INFO] Listing supported clients for network sepolia
# │Execution Clients │Consensus Clients │Validator Clients
────────┼───────────────────────┼───────────────────────┼───────────────────────
1 │nethermind │lighthouse │lighthouse
2 │geth │prysm │prysm
3 │erigon │teku │teku
4 │besu │lodestar │lodestar
```
35 changes: 35 additions & 0 deletions docs/docs/commands/lidoStatus.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 15
id: lido-status
---

# Lido Status

Running `sedge lido-status` will display detailed data for a single Lido Node Operator based on the provided rewards address.
Including information on the node operator's status, queue details, bond and reward information, and any relevant alerts.

## Help

```
$ sedge lido-status -h
This command retrieves and displays the status and detailed information of Lido Node Operators.
This information includes:
- Node Operator ID.
- Keys and queue information: available for deposit (in the queue), stuck, refunded, exited, deposited.
- Bond and rewards information: total amount, amounts lower and higher than required, non-claimed rewards.
Valid args: reward address of Node Operator (rewards recipient)
Usage:
sedge lido-status [flags] [args]
Flags:
-n, --network string Target network. e.g. holesky, mainnet etc. (default "holesky")
--l Show detailed descriptions for each value
-i, --nodeID int Your Node Operator ID (optional) (default -1)
-h, --help help for lido-status
Global Flags:
--log-level string Set Log Level, e.g panic, fatal, error, warn, warning, info, debug, trace (default "info")
```
20 changes: 12 additions & 8 deletions docs/docs/commands/networks.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,16 @@ $ sedge networks
2024-07-09 12:23:03 -- [INFO] You are running the latest version of sedge. Version: v1.5.0
2024-07-09 12:23:03 -- [INFO] Listing supported networks
# Supported Networks
=== ====================
1 chiado
2 custom
3 gnosis
4 holesky
5 mainnet
6 sepolia
# │Supported Networks
───────────────────────────────┼────────────────────────────────────────────────
1 │chiado
2 │custom
3 │gnosis
4 │holesky
5 │mainnet
6 │sepolia
```
38 changes: 35 additions & 3 deletions docs/docs/quickstart/lido.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ running and ready for validator activation.

:::info

The official [instructions guide] (https://dvt-homestaker.stakesaurus.com/bonded-validators-setup/lido-csm/upload-remove-view-validator-keys#upload-keys) provides detailed instructions on how to upload the deposit data and register your Node Operatort.
The official [instructions guide] (https://dvt-homestaker.stakesaurus.com/bonded-validators-setup/lido-csm/upload-remove-view-validator-keys#upload-keys) provides detailed instructions on how to upload the deposit data and register your Node Operator.

:::

Expand All @@ -103,8 +103,40 @@ meantime.

## Managing Your Node Operator

Once your validator keys are deposited and your node is running, you can manage your Node Operator using the Lido
CSM Widget. This interface allows you to:
Once your validator keys are deposited and your node is running, you can manage your Node Operator using Sedge commands and the Lido
CSM Widget.

### Checking Node Operator Status

To view detailed data about your Node Operator, use the `sedge lido-status` [command](../commands/lidoStatus.mdx). This command displays information specific to the Node Operator based on the provided rewards address.

```bash
sedge lido-status <your_reward_address>
```

:::info

`rewardAddress` is the ultimate recipient of the rewards. It can perform the following actions regarding the CSM Node Operator:

- Claim rewards
- Propose a new `rewardAddress`
- Reset `managerAddress` to make it equal to the current `rewardAddress`

The [Lido Documentation] (https://docs.lido.fi/staking-modules/csm/guides/addresses#reward-address) provides detailed information about the `rewardAddress`.

:::

#### Description

This command helps you monitor your Node Operator's performance by displaying:

- Node Operator ID
- Queue information (e.g., available for deposit, stuck, refunded, exited, deposited)
- Bond and rewards details

### Additional Management Tasks

Using the Lido CSM Widget, it allows you to:

- Claim bond and rewards
- Add extra bond amount
Expand Down

0 comments on commit ea6586f

Please sign in to comment.