Skip to content

Commit 38301fe

Browse files
Add notifications (#451)
1 parent 52ad4c3 commit 38301fe

File tree

3 files changed

+57
-24
lines changed

3 files changed

+57
-24
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Notifications & Warnings
2+
3+
The DAppNodePackage-lido-csm provides notifications and warnings to help you monitor your infraestructure and validator performance. You will be able to setup your notifications either during the onboarding process if you are registering as a new Node Operator and from the UI navigating to `/notifications`.
4+
5+
## **UI Warnings**
6+
7+
The UI will display in the dashboard the following warnings:
8+
9+
- Infraestructure healthcheck:
10+
- Execution client health: you will be able to check the status of your execution client, either if its installed, running and syncing.
11+
- Consensus client health: you will be able to check the status of your consensus client, either if its installed, running and syncing.
12+
- Web3signer: you will be able to check the status of your web3signer, either if its installed and running.
13+
- MEV Boost: you will be able to check the status of your MEV Boost, either if its installed and running.
14+
- Relays (comming soon):
15+
- Blocklisted relay: you will be able to check if your validator is using a blocklisted relay.
16+
- No mandatory relay: you will be able to check if your validator is not using any mandatory relay.
17+
- Attestations performance (comming soon): you will be able to check if your validator is not performing as expected according to the Lido tresholds.
18+
- Keystores not imported: you will be able to check if there are 1 or more keystores that belongs to your Node Operator and are not imported in the web3signer.
19+
20+
## **Telegram notifications**
21+
22+
You will be able to setup your notifications either during the onboarding process if you are registering as a new Node Operator and from the UI navigating to `/notifications`. You must provide:
23+
24+
- Bot token: this is the secret token from a bot that you must create. You can get it from the Telegram BotFather. See the [obtain your bot token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token) section.
25+
- User ID: this is your Telegram user ID. You can get it from the [userinfobot](https://t.me/userinfobot) typing `/start`.
26+
27+
Once your notifications are setup, you will receive notificatios for the following events:
28+
29+
- Lido Smart Contract events:
30+
- [Lido VEVO events](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-vebo): the most important event to remark is the validator exit request event, that will trigger the Ejector to exit the validator.
31+
- [Lido CSM events](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-csm): check the Lido documentation for more details.
32+
- [Lido CSFeeDistributor](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-csfeedistributor): check the Lido documentation for more details.
33+
- Validator exit:
34+
- Successful exit: you will receive a notification when the validator has been successfully exited.
35+
- Failed exit: you will receive a notification when the validator exit has failed, letting you know that a manual exit is required.
36+
- Relays (comming soon):
37+
- Blocklisted relay: you will receive a notification when your validator is using a blocklisted relay.
38+
- No relay: you will receive a notification when your validator is not using any relay.
39+
- Performance (comming soon):
40+
- Attestations performance: you will receive a notification when your validator is not performing as expected according to the Lido tresholds.
41+
- Keystores not imported (comming soon):
42+
- You will receive a notification when there are 1 or more keystores that belongs to your Node Operator and are not imported in the web3signer.

docs/user/staking/ethereum/lsd-pools/lido/overview.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,35 @@ Becoming a Lido Node Operator is recommended for users with some experience in r
1414

1515
## **Lido CSM in dappnode**
1616

17-
Dappnode provides an easy-to-use and intuitive interface for most of the infrastructure needed to become a Lido Node Operator. The process is straightforward and requires only a few steps to set up a node operator and start earning rewards.
17+
Dappnode provides an easy-to-use and intuitive interface for most of the infrastructure needed to become a Lido Node Operator. The process is straightforward and requires only a few steps to set up a node operator and start earning rewards.
1818

1919
Steps to become Node Operator
20+
2021
1. Go to Dappnode platform https://my.dappnode/
2122
2. Go to Dappstore tab in the left menu
2223
3. Search and install Lido CSM package
23-
4. Once it is installed, go to packages tab and click on the name of the Lido CSM package and find the section Ui below the version title.
24-
5. You will be in the Lido interface, connect your wallet and start the staking process.
24+
4. Once it is installed, go to packages tab and click on the name of the Lido CSM package and find the section Ui below the version title.
25+
5. You will be in the Lido interface, connect your wallet and start the staking process.
2526

2627
Dappnode takes care of the Lido protocol requirements, such as exiting validator when needed, and provides a user-friendly interface to manage the node operator.
2728

28-
2929
The main functionalities covered by Dappnode in the Lido CSM package are:
3030

31-
- **Telegram Notifications**: you can setup notifications for your Node Operator to be informed about any event. You need to configure the user ID and Telegram token to received your notifications.
31+
- **Telegram Notifications**: you can setup notifications for your Node Operator to be informed about any event. You need to configure the user ID and Telegram token to received your notifications.
3232
- **Ejector**: whenever any of your validator requires to be exited, it will be done automatically sending you the corresponding notification.
3333
- **Track multiple Node Operators**: you can track multiple Node Operators from the same DAppNodePackage-lido-csm.
3434
- **Performance**: your validators attestations performance will be tracked and you will be notified if they are not performing as expected according to the Lido tresholds.
3535
- **MEV boost relays**: you will receive notifications whenever your validators are using relays blocklisted in the Lido CSM or not using any relay at all.
3636
- **Import keystores directly from the Lido CSM**: you can import your keystores directly from the Lido CSM to your DAppNodePackage-lido-csm and they will be automatically tagged as Lido.
3737
- **Infraestructure monitoring**: you will be able to visualize the status of your infraestructure (EC - CC - Signer - MEV Boost).
3838

39-
### **Telegram Notifications**
40-
41-
You will be able to setup your notifications either during the onboarding process if you are registering as a new Node Operator and from the UI navigating to `/notifications`. You must provide:
39+
### **Notifications**
4240

43-
- Bot token: this is the secret token from a bot that you must create. You can get it from the Telegram BotFather. See the [obtain your bot token](https://core.telegram.org/bots/tutorial#obtain-your-bot-token) section.
44-
- User ID: this is your Telegram user ID. You can get it from the [userinfobot](https://t.me/userinfobot) typing `/start`.
41+
The DAppNodePackage-lido-csm provides notifications and warnings to help you monitor your infraestructure and validator performance. You will be able to setup your notifications either during the onboarding process if you are registering as a new Node Operator and from the UI navigating to `/notifications`.
4542

46-
Once your notifications are setup, you will receive notificatios for the following events:
47-
48-
- Lido Smart Contract events:
49-
- [Lido VEVO events](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-vebo): the most important event to remark is the validator exit request event, that will trigger the Ejector to exit the validator.
50-
- [Lido CSM events](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-csm): check the Lido documentation for more details.
51-
- [Lido CSFeeDistributor](https://docs.lido.fi/staking-modules/csm/guides/events/#contract-csfeedistributor): check the Lido documentation for more details.
52-
- Validator exit:
53-
- Successful exit: you will receive a notification when the validator has been successfully exited.
54-
- Failed exit: you will receive a notification when the validator exit has failed, letting you know that a manual exit is required.
55-
- Relays (comming soon):
56-
- Blocklisted relay: you will receive a notification when your validator is using a blocklisted relay.
57-
- No relay: you will receive a notification when your validator is not using any relay.
58-
- Performance (comming soon):
59-
- Attestations performance: you will receive a notification when your validator is not performing as expected according to the Lido tresholds.
43+
:::info
44+
For further information on how to setup your notifications, see Notifications section
45+
:::
6046

6147
### **Ejector**
6248

sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ const sidebars = {
170170
label: "I am already a Node Operator",
171171
id: "user/staking/ethereum/lsd-pools/lido/already-node-operator",
172172
},
173+
{
174+
type: "doc",
175+
label: "Notifications & Warnings",
176+
id: "user/staking/ethereum/lsd-pools/lido/notifications",
177+
},
173178
],
174179
},
175180
{

0 commit comments

Comments
 (0)