Skip to content

Commit

Permalink
Merge branch 'main' into release/0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
AntiD2ta authored Nov 29, 2022
2 parents ac26cf7 + 50dad91 commit a41c7b7
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 83 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[![Discord](https://user-images.githubusercontent.com/7288322/34471967-1df7808a-efbb-11e7-9088-ed0b04151291.png)](https://discord.com/invite/PaCMRFdvWT)
[![codecov](https://codecov.io/gh/NethermindEth/sedge/branch/main/graph/badge.svg?token=8FERO4PO1V)](https://codecov.io/gh/NethermindEth/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.
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.
The project **is still on beta** and although it should be stable enough, it still might have some issues. Sedge has not been audited yet.

- [Sedge](#sedge)
- [⚙️ Installation](#️-installation)
Expand Down Expand Up @@ -55,7 +55,7 @@ Check our [installation guide](https://docs.sedge.nethermind.io/docs/quickstart/

### **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.
Downloading any binary from the internet comes with the risk of downloading files that 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

Expand All @@ -75,9 +75,9 @@ Between steps 4 and 5 you can generate the validator(s) keystore folder using `s

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!
Check all the options and flags with `sedge cli --help`. More instructions or guides about Sedge's features are coming soon!

## 💥 How this all started?
## 💥 Why did we start Sedge?

As people who actively deployed validators way before The Merge, we know how hard it is to set up an Ethereum validator:

Expand All @@ -89,33 +89,33 @@ As people who actively deployed validators way before The Merge, we know how har

> 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 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?
## 🔥 What can you do with Sedge today?

- Select an execution, consensus and validator client node (manually or automatically) and generate a `docker-compose` script with production-tested configurations to run the setup you want.
- Don't remember `docker-compose` commands or flags for your setup? Check docker logs of the running services with `sedge logs`, and shut them down with `sedge down`
- Generate the keystore folder with `sedge keys` for mainnet using the [staking-deposit-cli](https://github.com/ethereum/staking-deposit-cli) tool or for the rest of supported networks using our own experimental code.

> **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.
> **Disclaimer:** Users acknowledge that generating the keystore for other network apart from mainnet is an experimental and not audited feature. Nethermind takes no responsibility for any malfunctioning or lost money derived from an unexpected behavior during keystore generation.
> **Disclaimer:** Users acknowledge that generating the keystore for any network other than the mainnet is an experimental and unaudited feature of Sedge. Nethermind provides this feature on an ‘as is’ basis and makes no warranties regarding its proper functioning. The use of this feature is at the user’s own risk - Nethermind excludes all liability for any malfunction or loss of money that may occur as the result of an unexpected behavior during the keystore generation.
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!
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. It 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!
> 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 about 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.
Users acknowledge that no warranty is being made of a successful installation. Sedge is a tool and it ultimately depends on you to use it correctly and follow all the best practice guidance, as found in this README and documentation.

## Supported networks and clients

Expand Down Expand Up @@ -242,7 +242,7 @@ Full Ethereum PoS support with MEV-Boost
- [ ] Off-premise setup support
## 💪 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.
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 that the main team is aware and can discuss it.

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.

Expand Down
20 changes: 11 additions & 9 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ sidebar_position: 1

# Introduction

**Sedge** is a one click setup tool for PoS network/chain validators and nodes written entirely in the [Go programming language](https://golang.org/). **Sedge** takes care of the entire on-premise full node setup based on the chosen client; using generated docker-compose scripts based on the desired configuration. The following list shows some of the use cases for Sedge:
**Sedge** is a one-click setup tool for PoS network/chain validators and nodes written entirely in the [Go programming language](https://golang.org/). **Sedge** takes care of the entire on-premise full node setup based on the chosen client, using generated docker-compose scripts based on the desired configuration. The following list shows some of the use cases for Sedge:

- **Staking**. You can use use Sedge to set up and deploy an Ethereum and Gnosis full node, including a validator node and with mev-boost. The on-premise setup design Sedge uses favors solo stakers but it can also be integrated in other staking solutions.
- **Automated testing**. If you need to set up nodes very often to test your application or node, you can integrate Sedge to an automated solution, taking advantage that Sedge can set up a full node very quickly in just one step. This can be the case for protocol and dapps developers.
- **API and Checkpoint Sync endpoints**. Sedge allows you to set up a full node without a validator so that you can use this node either to expose the execution JSON-RPC API or the Beacon Chain HTTP API, or to expose a [Checkpoint Sync](concepts/checkpoint-sync.md) endpoint.
- **Staking**. You can use Sedge to set up and deploy an Ethereum or a Gnosis full node, including a validator node and nodes with mev-boost. Sedge's on-premise setup design favors solo stakers but can also be integrated with other staking solutions.
- **Automated testing**. If you need to set up nodes very often to test your application or node, you can integrate Sedge to an automated solution and make use of Sedge as a one-click tool with which you can quickly set up a full node in just a single step. This can be the case for protocol and dapps developers.
- **API and Checkpoint Sync endpoints**. Sedge allows you to set up a full node without a validator so that you can use this node to either expose the execution JSON-RPC API or the Beacon Chain HTTP API, or expose a [Checkpoint Sync](concepts/checkpoint-sync.md) endpoint.

> If you set up a node with or without a validator, exposing or not the API, you would be contributing to the network anyway, which is amazing.
> Whether or not you choose to set up a node with a validator, and whether or not you are exposing the API, you are contributing to the network, which is great!
:::caution Disclaimer

Expand All @@ -20,13 +20,15 @@ While Sedge assists in installing the validator, it is not designed to register

:::caution Disclaimer

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 the project's README and this documentation.
Users acknowledge that no warranty is being made of a successful installation. Sedge is a tool and it depends on you to use it correctly and follow all the best practice guidance, as found in the project's README and this documentation.

:::

## Why would you use Sedge
## Why you should try Sedge

Sedge focus on ease of use and little to none background to run a node or validator. You don't need to be a highly technical person to run a node using Sedge. This creates a lower barrier for people to get involved in the ecosystem. However, if you are have enough technical knowledge you can take advantage of sedge capabilities, as you can generate the setup files and modify them according to your needs and also integrate Sedge on other solutions. Today you can setup a full node or a validator in Ethereum in just one step using Sedge and in less than 5 minutes! Don't know which client to choose? No problem! Let Sedge choose it for you.
Sedge is a tool that focuses on ease of use and, as such, lowers the entry barrier for non-technical users. With Sedge, you can run a node or a validator on Ethereum with little to no technical background and set it all up in less than 5 minutes! Don't know which client to choose? No problem! Let Sedge choose it for you.

Sedge codebase design allow us to create many features in a way Sedge will be able to satisfy most of your needs: automated updates, cross platform support, alerting mechanisms, off-premise setup, setup a single node or a full node, improved UI/UX, other networks and much more. Stay tuned to get the most of these features as soon as we ship them.
If you have enough technical knowledge, you can also take advantage of Sedge and its features. You can generate the setup files, modify them according to your needs, and integrate Sedge with other solutions.

The Sedge codebase design allows us to create many features and support you with setting up a single node or a full node, cross-platform support, alerting mechanisms, support for other networks, and much more. [Stay tuned](https://twitter.com/nethermindeth) to find out when they’re shipped!

2 changes: 1 addition & 1 deletion docs/docs/quickstart/by-yourself.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ id: by-yourself

Once you use `sedge cli` to generate the `docker-compose.yml` file, you can handle it by yourself. This guide show you how.

There are several reasons why you would need to manage the setup after using Sedge for generating the setup files. You might want to modify the `.env` or `docker-compose.yml` file to change the setup configuration, or simply copy these files to another machine. Currently, Sedge runs the docker compose stack that was just generated, there is no way of using sedge to run an arbitrary `docker-compose.yml`. You can still use `sedge logs` and `sedge down` on any `docker-compose.yml` though.
There are several reasons why you would need to manage the setup after using Sedge for generating the setup files. You might want to modify the `.env` or `docker-compose.yml` file to change the setup configuration, or simply copy these files to another machine. Currently, Sedge runs the docker compose stack that was just generated, there is no way of using Sedge to run an arbitrary `docker-compose.yml`. You can still use `sedge logs` and `sedge down` on any `docker-compose.yml` though.

:::caution

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/quickstart/chiado.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ sidebar_position: 8
id: chiado
---

# Run a Validator or Full Node on Chiado
# Run a Validator or a Full Node on Chiado

Validators and Full Nodes, protect the network by validating transactions and blocks. They are the backbone of the
network and are responsible for the security of the network. This guide shows you how to use Sedge to setup a full node or a validator in Chiado, a Gnosis testnet.
Validators and Full Nodes protect the network by validating transactions and blocks. They are the backbone of the
network and are responsible for the security of the network. This guide shows you how to use Sedge to set up a full node or a validator on Chiado, a Gnosis testnet.

:::info

Expand Down Expand Up @@ -113,7 +113,7 @@ The hardware requirements you are about to see are for Gnosis. Chiado is a light

:::tip

We recommend use `Lighthouse` or `Teku` while using Sedge for Chiado, as they are the most stable and tested clients.
We recommend using `Lighthouse` or `Teku` while using Sedge for Chiado as they are the most stable and tested clients.

:::

Expand All @@ -123,7 +123,7 @@ Sedge supports Prysm for Chiado, but Prysm version for this network is not stabl

:::

For a more detailed description, you can look on the [Beacon Chain Node Requirements](https://docs.gnosischain.com/node/consensus-layer-validator#beacon-chain-node-requirements) at the Gnosis Chain documentation.
For a more detailed description, you can look at the [Beacon Chain Node Requirements](https://docs.gnosischain.com/node/consensus-layer-validator#beacon-chain-node-requirements) in the Gnosis Chain documentation.

## Execution Client Requirements

Expand All @@ -133,7 +133,7 @@ For a more detailed description, you can look on the [Beacon Chain Node Requirem
- RAM: 8GB
- Disk: 500gb SSD

For a more detailed description, you can look on the [Guide for Run a Gnosis Execution Layer Node](https://docs.gnosischain.com/node/execution-layer-validator)
For a more detailed description, you can look at the [Guide for Run a Gnosis Execution Layer Node](https://docs.gnosischain.com/node/execution-layer-validator)

## Useful data

Expand Down
Loading

0 comments on commit a41c7b7

Please sign in to comment.