-
Notifications
You must be signed in to change notification settings - Fork 71
Add "Run on Lido" section and CSM guide for NOs #612
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
base: main
Are you sure you want to change the base?
Conversation
feat(docs): add CSM Guide multi-instance
Need to proof-read and solve minor issues. But al pages are imported.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to trink about what stuff from http://localhost:3000/staking-modules/csm/guides/ should be moved (to avoid duplicates) and how this new guide will be linked from that section
Also review build errors and fix them |
This first one does not include anything repeated from the main guides. In fact some of them are referenced and linked, but I agree. We can discuss later and move some of them. |
Reverted |
run-on-lido/csm/alerts-and-monitoring/beginner-csm-widget-ethseer-beaconcha.in.md
Outdated
Show resolved
Hide resolved
run-on-lido/csm/alerts-and-monitoring/intermediate-other-external-dashboards.md
Outdated
Show resolved
Hide resolved
run-on-lido/csm/alerts-and-monitoring/intermediate-other-external-dashboards.md
Outdated
Show resolved
Hide resolved
run-on-lido/csm/alerts-and-monitoring/intermediate-other-external-dashboards.md
Outdated
Show resolved
Hide resolved
|
||
Here, you will see your net rewards and bond claimable in aggregate and broken down into its individual parts. Note that `Locked bond` is also deducted from your aggregate rewards here. | ||
|
||
You will also be able to claim your net rewards + bond in total or in individual parts if you wish, and select among 3 token types to receive: ETH / stETH / wstETH. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ETH is not claimable directly. Add a note that to get ETH you need to get Withdrawal NFT first
|
||
 | ||
|
||
:::info |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not fully accurate. Bond is required to cover both deposited and uploaded keys. To release bond you should either exit deposited keys or remove undeposited ones
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching this. This statement "Exiting your CSM-deposited keys will not unlock your Locked bonds" is meant for the "Unlock Bond" section.
run-on-lido/csm/lido-csm-widget/upload-remove-view-validator-keys.md
Outdated
Show resolved
Hide resolved
run-on-lido/csm/lido-csm-widget/upload-remove-view-validator-keys.md
Outdated
Show resolved
Hide resolved
@@ -0,0 +1,249 @@ | |||
import Tabs from '@theme/Tabs'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also mention somewhere here that you need to use 0x01 WC and set deposit amount to 32 ETH
Co-authored-by: Dmitry Gusakov <[email protected]>
Replace ls with find to capture more edge cases
…ent.md updated validator keystore file paths
@@ -1,5 +1,8 @@ | |||
# Intro | |||
|
|||
:::info |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:::info | |
:::tip |
|
||
# Run on Lido | ||
|
||
This section of the Lido documentation is for users wanting to run any of the Lido products, whether Node Operators, Vault managers or Oracle Operators. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section of the Lido documentation is for users wanting to run any of the Lido products, whether Node Operators, Vault managers or Oracle Operators. | |
This section of the Lido documentation is for users who want to run any of the Lido products, whether Node Operators, Vault managers, or Oracle Operators. |
| ---- | ------- | | ||
| [Lido CSM Operator Portal](https://operatorportal.lido.fi/modules/community-staking-module) | Concepts and requirements of participating in the Lido CSM. Useful for getting up to speed quickly for new CSM operators. | | ||
| [Lido CSM Documentation](https://docs.lido.fi/staking-modules/csm/intro) | Contracts and detailed specifications of the Lido CSM and guides for advanced users. | | ||
| Mainnet: [csm.lido.fi](https://csm.lido.fi/)<br />Hoodi Testnet: [csm.testnet.fi](https://csm.testnet.fi/) | This is where you connect your wallet, upload keys, provide and withdraw bonds, and claim rewards. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Mainnet: [csm.lido.fi](https://csm.lido.fi/)<br />Hoodi Testnet: [csm.testnet.fi](https://csm.testnet.fi/) | This is where you connect your wallet, upload keys, provide and withdraw bonds, and claim rewards. | | |
| [CSM UI on Mainnet](https://csm.lido.fi/)<br /> [CSM UI on Hoodi Testnet](https://csm.testnet.fi/) | This is where you connect your wallet, upload keys, provide and withdraw bonds, and claim rewards. | |
## Full Node Setup | ||
|
||
:::info | ||
Machines purchased from the Dappnode store are plug-and-play. If you’re installing on your own hardware, it must run Debian. Follow the official Debian installer guide [here](https://www.debian.org/devel/debian-installer/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Machines purchased from the Dappnode store are plug-and-play. If you’re installing on your own hardware, it must run Debian. Follow the official Debian installer guide [here](https://www.debian.org/devel/debian-installer/). | |
Machines purchased from the [Dappnode store](https://dappnode.com/) are plug-and-play. If you’re installing it on your own hardware, it must run on Debian. Follow the official Debian installer guide [here](https://www.debian.org/devel/debian-installer/). |
:::info | ||
**DO NOT DEPOSIT 32 ETH** using the deposit data file generated this way as the Lido CSM will make the deposit for you. _**Doing so will result in a loss of funds.**_ | ||
::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:::info | |
**DO NOT DEPOSIT 32 ETH** using the deposit data file generated this way as the Lido CSM will make the deposit for you. _**Doing so will result in a loss of funds.**_ | |
::: | |
:::warning | |
**DO NOT DEPOSIT 32 ETH** using the deposit data file generated this way, as the Lido CSM will make a deposit for you. | |
_**Doing so will result in a loss of funds.**_ | |
::: |
 | ||
|
||
:::warning | ||
Keys that have been deposited cannot be deleted and only can be exited. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And add a link to the corresponding section
Keys that have been deposited cannot be deleted and only can be exited. | |
Keys that have been deposited cannot be deleted and can only be exited from the Consensus Layer. |
|
||
There are 2 reasons why CSM operators can receive exit request from the Lido Protocol: | ||
1. If the protocol needs ETH to fulfill stETH withdrawal requests. Note that because of how the protocol works withdrawal requests will, for the most part, be requested from bigger modules like the Curated Module first. | ||
2. If the validator is performing below the Performance Threshold for 3 frames within 6 months. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only true for v2 and should be framed differently for v2. So remove it for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the case about unbonded validators. Basically all unbonded validators are required to exit
1. To use the hosted version, click [here for Mainnet](https://t.me/CSMSentinel_bot) or here for [Hoodi](https://t.me/CSMSentinelHoodi_bot) | ||
Search for the **"CSM Sentinel"** bot on Telegram and open a chat with it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. To use the hosted version, click [here for Mainnet](https://t.me/CSMSentinel_bot) or here for [Hoodi](https://t.me/CSMSentinelHoodi_bot) | |
Search for the **"CSM Sentinel"** bot on Telegram and open a chat with it | |
1. To use the hosted version, click [here for Mainnet](https://t.me/CSMSentinel_bot) or here for [Hoodi](https://t.me/CSMSentinelHoodi_bot). Alternatively, search for the **"CSM Sentinel"** bot on Telegram and open a chat with it |
## How to Exit Keys and Withdraw Your Bond | ||
|
||
1. Sign & broadcast an exit message for each validator key you want to exit. Refer to the sub-sections/pages below. | ||
2. Wait for the validator key to be fully exited on the beacon chain. Check your validator ID pubkey on [beaconcha.in](https://beaconcha.in/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Wait for the validator key to be fully exited on the beacon chain. Check your validator ID pubkey on [beaconcha.in](https://beaconcha.in/). | |
2. Wait for the validator key to be fully exited on the beacon chain. Check your validator pubkey on [beaconcha.in](https://beaconcha.in/). |
sidebar_position: 1 | ||
--- | ||
|
||
# Patching your OS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really think that chrony belongs here. Can we add a section?
Please, go through these steps before you request a review:
📝 Describe your changes
🔎 Include source of truth for all changes that reference on-chain data (addresses, etc.)
Only references to onchain addresses are to the Lido Execution Layer and Withdrawal Vaults, of both Mainnet and Hoodi.