Sedge
A one click setup tool for PoS network/chain validators. Currently, Sedge is designed primarily for solo stakers and testnet devs of Ethereum. Sedge generates docker-compose scripts for the entire on-premise validator setup based on the chosen client.
The project is still on beta and although it should be stable enough, it might still have some issues. Sedge has not been audited yet.
- Sedge
⚙️ Installation
Dependencies
Sedge dependencies are docker with docker compose plugin, but if you don't have those installed, Sedge will show instructions to install them, or install them for you. Check the docs for more details.
Installation methods
Check our installation guide for detailed instructions on the supported methods:
- Download binary from release page
- Using the Homebrew package manager
- Using the Go programmning language
- Build from source
Disclaimer
Downloading any binary from the internet comes with the risk of downloading files which malicious, third-party actors have injected with malware. All users should check that they are downloading the correct, clean binary, from a reputable source.
📜 Documentation
For further details, you can check the documentation.
⚡️ Quick start
With sedge cli you can go through the entire workflow setup:
- Check dependencies
- Generate jwtsecret (not for mainnet)
- Generate a
docker-composescript with randomized clients selection and.env - Execute the
docker-composescript (only execution and consensus nodes will be executed by default) - Validator client will be executed automatically after execution and consensus nodes are synced.
Between steps 4 and 5 you can generate the validator(s) keystore folder using sedge keys.
The entire process is interactive, although you can use the -y flag to run Sedge without prompts.
Check all the options and flags with sedge cli --help. More instructions or guides about sedge's features will come soon!
💥 How this all started?
As people who actively work on The Merge, we know how hard it is to set up an Ethereum validator:
- You need to procure at least three (compatible) nodes: an execution node (geth, nethermind, etc), a consensus node, and a validator node (lighthouse, prysm, etc)
- You then need to execute them, connect them, monitor them, and secure the validator keys (which includes staking 32 ETH).
- There may be several valid combinations of clients to choose for your setup, so you need to go through each of the client's docs, evaluate it, get instructions for it and test it. You also need to feel comfortable executing commands in the cli, know docker, and understand basics of networking. On top of this, there are many different settings you must read up on and consider for your client node.
- In the case of working with the Ethereum Mainnet, you are working with real money that can potentially be lost in the event of having downtime or being slashed. To avoid losing real value, you must be aware of and follow best practices on the validator setup, and correctly monitor your nodes.
- Have you heard of MEV? Flashbots is working on an MEV-Boost component which will take your validator to another level of awesomeness. You most likely want to always be running the latest version, but you also most likely don’t have the time to understand the MEV-Boost architecture in and out, or how to successfully implement it into your environment.
Enter sedge
We want Sedge to take care of all of the above for you. With just a few clicks or steps, Sedge can create an entire ethereum staking architecture that supports client diversity and Ethereum's latest features, while being completely free and open source. We want Sedge to save you from making costly mistakes in this complex setup; along with hours or days of research, reading and testing. We want you to be able to stake easily with or without blockchain knowledge by giving you the tools to help this amazing community (and earn some good money of course 😉).
We want to share our knowledge in this topic and create something that allows everyone to easily and safely set up lots of diverse validators.
We don't want to stop at Ethereum. We also want to help stakers of other PoS networks/chains, so if your favourite chain is not here, you are more than welcome to contribute!
🔥 What can you do with sedge today?
- Select an execution, consensus and validator node (manually or automatically) and generate a
docker-composescript with production-tested configurations to run the setup you want. - Don't remember
docker-composecommands or flags for your setup? Check docker logs of the running services withsedge logs, and shut them down withsedge down - Generate the keystore folder using the staking-deposit-cli tool with
sedge keys
Disclaimer: Users acknowledge that staking-deposit-cli is an external tool, which means that Nethermind exercises no control over its functioning and does not accept any liability for any issues that may arise from the use of the tool.
The setup is currently designed to start all three nodes required to run a full local validator (execution, consensus and validator node). Soon, Sedge will let you connect to a public or remote node for the execution and consensus layers. Once the consensus node is synced, a validator node will be executed automatically. We suggest that you make use of the initial time taken to sync to prepare the keystore file and make the deposit for your staked ether.
If you are familiar with docker, docker compose, and the validator setup, then you can use Sedge to generate a base docker-compose script with the recommended settings, stop Sedge instead of letting it execute the script, and then edit the script as much as you want. Is a lot more easier than doing everything from scratch!
Although Sedge supports several clients, is still on beta. Some settings may not work because -at least on the testnets- the clients are constantly evolving. Please let us know any issues you encounter!
Disclaimer
While Sedge assists in installing the validator, it is not designed to register or maintain it. Users are solely responsible for ensuring that they monitor and maintain the validator as required, so that they do not incur penalties and/or financial losses. This includes promptly updating the tool to ensure the latest stable releases of clients are used.
Users acknowledge that no warranty is being made of a successful installation. Sedge is a tool and ultimately depends on you to use it correctly and following all the best practice guidance, as found in this README and documentation.
Supported networks and clients
Mainnet
| Execution | Consensus | Validator |
|---|---|---|
| Geth | Lighthouse | Lighthouse |
| Nethermind | Lodestar | Lodestar |
| Prysm | Prysm | |
| Teku | Teku |
Ropsten
| Execution | Consensus | Validator |
|---|---|---|
| Geth | Lighthouse | Lighthouse |
| Nethermind | Lodestar | Lodestar |
| Prysm | Prysm | |
| Teku | Teku |
Sepolia
| Execution | Consensus | Validator |
|---|---|---|
| Geth | Lighthouse | Lighthouse |
| Nethermind | Lodestar | Lodestar |
| Prysm | Prysm | |
| Teku | Teku |
Goerli
| Execution | Consensus | Validator |
|---|---|---|
| Geth | Lighthouse | Lighthouse |
| Nethermind | Lodestar | Lodestar |
| Prysm | Prysm | |
| Teku | Teku |
Gnosis
| Execution | Consensus | Validator |
|---|---|---|
| Nethermind | Lighthouse | Lighthouse |
| Lodestar | Lodestar | |
| Prysm | Prysm | |
| Teku | Teku |
Chiado (Gnosis testnet)
| Execution | Consensus | Validator |
|---|---|---|
| Nethermind | Lighthouse | Lighthouse |
| Lodestar | Lodestar | |
| Prysm | Prysm | |
| Teku | Teku |
Denver (Gnosis testnet)
| Execution | Consensus | Validator |
|---|---|---|
| Nethermind | Lighthouse | Lighthouse |
| Lodestar | Lodestar | |
| Prysm | Prysm | |
| Teku | Teku |
CL clients with Mev-Boost
| Client | Mev-Boost | Networks |
|---|---|---|
| Lighthouse | yes | Ropsten, Goerli |
| Lodestar | yes | Goerli |
| Prysm | no* | Goerli |
| Teku | yes | Ropsten, Goerli |
Settings for Prysm with mev-boost are quite ready, we are waiting for an official and stable Prysm docker image with mev-boost support
Supported Linux flavours for dependency installation
| OS | Versions |
|---|---|
| Ubuntu | 22.04, 20.04 |
| Debian | 11,10,9,8 |
| Fedora | 35,34 |
| CentOS | 8 |
| Arch | - |
| Amazon Linux 2 | - |
| Alpine | 3.15,3.14,3.14.3 |
✅ Roadmap
The following roadmap covers the main features and ideas we want to implement but doesn't cover everything we are planning for this tool. Stay in touch if you are interested, a lot of improvements are coming in the next two months. Please note that this Roadmap is continually changing until version 1.0.
Version 0.1
- Generate
docker-composescripts and.envfiles for selected clients with a cli tool - Generate keystore folder with the cli
- Test coverage (unit tests)
- Integrate Kiln network
- Integrate MEV-Boost as an option
- Integrate Ropsten network
Version 0.2
- Integrate Goerli/Prater network
- Integrate Sepolia network
- Documentation with examples
Version 0.3 (Actual)
- Integrate Gnosis network
- Prepare for the Merge
Version 0.4
- Set up and run only one node (execution/consensus/validator)
- Grafana and Prometheus support for the clients
- Besu and Erigon support
- Include monitoring tool for alerting, tracking validator balance, and tracking sync progress and status of nodes
Version 0.X
- TUI for guided and more interactive setup (better UX)
- Off-premise setup support
- Cross platform support and documentation
- More tests!!!
- Support for Nimbus client
- Integrate other PoS networks
Version 1.0
Full Ethereum 2 support with MEV-Boost
💪 Want to contribute?
Please check our Contributing Guidelines, Code of Conduct and our issues. In case you want to report or suggest something (any help is welcome) please file an issue first so the main team is aware and it can be discussed.
If you know of any good tricks for validator setup that other people could make good use of as well, please consider adding it to Sedge. Your efforts will be greatly appreciated by the community.
⚠️ License
Sedge is a Nethermind free and open-source software licensed under the Apache 2.0 License.