Skip to content

Commit

Permalink
docs: Include lido-status command
Browse files Browse the repository at this point in the history
  • Loading branch information
khalifaa55 committed Aug 16, 2024
1 parent 01fcb11 commit d9af7ad
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
36 changes: 36 additions & 0 deletions docs/docs/commands/lidoStatus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
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.
- Alerts for penalties and exit requests.
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
-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")
```
16 changes: 15 additions & 1 deletion docs/docs/quickstart/lido.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,21 @@ 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:
CSM Widget and Sedge commands.

### 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_address>
```

This command helps you keep track of your Node Operator's performance and manage any issues that arise.

### 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 d9af7ad

Please sign in to comment.