Merge branch 'main' into merge-main

NethermindEth · Oct 21, 2024 · ec5801d · ec5801d
2 parents 7dd449e + 7ceb31f
commit ec5801d
Show file tree

Hide file tree

Showing 14 changed files with 43 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v1.6.0] - 2024-10-18
+
 ### Added
 - New command `lido-status` to display data of Lido Node Operator.
 - New command `monitoring` to run monitoring stack setup with Grafana, Prometheus, Node Exporter and Lido Exporter.
@@ -66,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Update client images to Dencun-ready versions.
+- Update client images to Dencun-ready versions. 
 
 ## [v1.3.1] - 2024-02-14
 

diff --git a/README.md b/README.md
@@ -263,7 +263,7 @@ The following roadmap covers the main features and ideas we want to implement bu
 - [x] Support Erigon on Gnosis
 - [x] Support for Lido CSM
 - [x] Support for Nimbus client as Consensus and Validator
-- [ ] Include monitoring tool for alerting, tracking validator balance, and tracking sync progress and status of nodes
+- [x] Include monitoring tool for alerting, tracking validator balance, and tracking sync progress and status of nodes
 - [ ] More tests!!!
 
 
@@ -279,4 +279,4 @@ If you believe you have found a security vulnerability in our code, please repor
 
 ## ⚠️ License
 
-Sedge is a Nethermind free and open-source software licensed under the [Apache 2.0 License](https://github.com/NethermindEth/sedge/blob/main/LICENSE).
+Sedge is a Nethermind free and open-source software licensed under the [Apache 2.0 License](https://github.com/NethermindEth/sedge/blob/main/LICENSE).
diff --git a/cmd/lido-exporter/README.md b/cmd/lido-exporter/README.md
@@ -12,15 +12,25 @@ Lido Exporter is a service that exports data from the Lido CSM smart contracts a
 
 ### Running with Docker
 
-1. Build the Docker image:
-   ```
-   docker build -t lido-exporter .
-   ```
+You can easily run the Lido Exporter using Docker. There is a published Docker image available, which eliminates the need to build the image yourself.
 
-2. Run the Docker container:
-   ```
-   docker run -d -p 8080:8080 -e LIDO_EXPORTER_NODE_OPERATOR_ID=<your_node_operator_id> -e LIDO_EXPORTER_NETWORK=<network_name> lido-exporter
-   ```
+1. Pull the Docker image:
+
+    ```bash
+    docker pull nethermindeth/lido-exporter:latest
+    ```
+
+2. Run the Docker container with the necessary environment variables:
+
+    ```bash
+    docker run -d -p 8080:8080 \
+      -e LIDO_EXPORTER_NODE_OPERATOR_ID=<your_node_operator_id> \
+      -e LIDO_EXPORTER_NETWORK=<network_name> \
+      nethermindeth/lido-exporter:latest
+    ```
+
+- The container listens on port `8080` by default, but you can change this using the `LIDO_EXPORTER_PORT` environment variable.
+- The metrics will be available at `http://localhost:8080/metrics`.
 
 ### Running as a CLI Application
 

diff --git a/docs/docs/commands/cli.mdx b/docs/docs/commands/cli.mdx
@@ -43,7 +43,7 @@ This is an example of what you can expect:
 ```
 $ sedge cli
 2024-10-16 17:51:44 -- [INFO] [Logger Init] Log level: info
-2024-10-16 17:51:46 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2024-10-16 17:51:46 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 ? Select node setup ethereum-node
 ? Select network mainnet
 ? Select node type full-node

diff --git a/docs/docs/commands/deps.mdx b/docs/docs/commands/deps.mdx
@@ -75,7 +75,7 @@ The execution of `sedge deps check` will result in an output like this if everyt
 ```
 $ sedge deps check
 2023-03-21 02:56:04 -- [INFO] [Logger Init] Log level: info
-2023-03-21 02:56:05 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-03-21 02:56:05 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2023-03-21 02:56:05 -- [INFO] docker is installed
 2023-03-21 02:56:06 -- [INFO] All dependencies are installed and running
 ```
diff --git a/docs/docs/commands/down.mdx b/docs/docs/commands/down.mdx
@@ -38,7 +38,7 @@ The execution of `sedge down` will close and remove all the opened containers an
 ```
 $ sedge down
 2022-00-00 00:00:00 -- [INFO] [Logger Init] Log level: info
-2022-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2022-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 [sudo] password for maceo:
 [+] Running 7/7
  ⠿ Container execution-client                            Removed                                                                 93.8s

diff --git a/docs/docs/commands/importKey.mdx b/docs/docs/commands/importKey.mdx
@@ -79,7 +79,7 @@ To import the validator keys, and start the validator client after the import, r
 ```shell
 $ sedge import-key --from keystore -n sepolia --start-validator prysm
 2023-01-26 11:59:34 -- [INFO] [Logger Init] Log level: info
-2023-01-26 11:59:34 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-26 11:59:34 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-26 11:59:34 -- [WARN] The keys path is not the default one, copying the keys to the default path /root/sedge/example/sedge-data/keystore
 2023-01-26 11:59:34 -- [INFO] Importing validator keys

diff --git a/docs/docs/commands/networks.mdx b/docs/docs/commands/networks.mdx
@@ -28,7 +28,7 @@ Global Flags:
 ```
 $ sedge networks
 2024-07-09 12:23:02 -- [INFO] [Logger Init] Log level: info
-2024-07-09 12:23:03 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2024-07-09 12:23:03 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2024-07-09 12:23:03 -- [INFO] Listing supported networks
 
 

diff --git a/docs/docs/commands/run.mdx b/docs/docs/commands/run.mdx
@@ -59,7 +59,7 @@ the following command to start all services in the default generation path
 $ sedge run
 Using config file: /root/.sedge.yaml
 2022-12-29 19:55:55 -- [INFO] [Logger Init] Logging configuration: {Level:debug}
-2022-12-29 19:55:55 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2022-12-29 19:55:55 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2022-12-29 20:40:24 -- [INFO] Checking dependencies: docker
 2022-12-29 20:40:24 -- [INFO] All dependencies are installed on host machine
 2022-12-29 19:55:55 -- [INFO] Setting up containers
@@ -110,7 +110,7 @@ start the validator.
 $ sedge run --services execution,consensus
 Using config file: /root/.sedge.yaml
 2022-12-29 21:03:29 -- [INFO] [Logger Init] Logging configuration: {Level:debug}
-2022-12-29 21:03:29 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2022-12-29 21:03:29 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2022-12-29 21:03:29 -- [INFO] Checking dependencies: docker
 2022-12-29 21:03:29 -- [INFO] All dependencies are installed on host machine
 2022-12-29 21:03:29 -- [INFO] Setting up containers
@@ -155,7 +155,7 @@ Now you can start the validator client like follow:
 $ sedge run --services validator
 Using config file: /root/.sedge.yaml
 2022-12-29 21:24:12 -- [INFO] [Logger Init] Logging configuration: {Level:debug}
-2022-12-29 21:24:12 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2022-12-29 21:24:12 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2022-12-29 21:24:12 -- [INFO] Checking dependencies: docker
 2022-12-29 21:24:12 -- [INFO] All dependencies are installed on host machine
 2022-12-29 21:24:12 -- [INFO] Setting up containers

diff --git a/docs/docs/commands/show.mdx b/docs/docs/commands/show.mdx
@@ -29,7 +29,7 @@ Global Flags:
 ```
 $ sedge show
 2023-00-00 00:00:00 -- [INFO] [Logger Init] Log level: info
-2023-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2023-00-00 00:00:00 -- [INFO] Showing existing containers information
 2023-00-00 00:00:00 -- [INFO] containers:
     - name: sedge-execution-client

diff --git a/docs/docs/commands/slashingExport.mdx b/docs/docs/commands/slashingExport.mdx
@@ -58,7 +58,7 @@ This is an example of exporting slashing protection data from a setup using sepo
 ```shell
 $ sedge slashing-export lighthouse -n sepolia --out slashing-protection.json
 2023-01-06 15:47:56 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:47:57 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:47:57 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2023-01-06 15:47:57 -- [INFO] Exporting slashing data from client lighthouse
 # highlight-next-line
 2023-01-06 15:47:57 -- [INFO] The slashing protection container is starting...
@@ -71,7 +71,7 @@ Notice in this case the validator client remains stopped because it has been sto
 ```shell
 $ sedge slashing-export lighthouse -n sepolia --out slashing-protection.json --start-validator
 2023-01-06 15:51:11 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:51:11 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:51:11 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2023-01-06 15:51:11 -- [INFO] Exporting slashing data from client lighthouse
 2023-01-06 15:51:11 -- [INFO] The slashing protection container is starting...
 2023-01-06 15:51:12 -- [INFO] The slashing container ends successfully.
@@ -86,7 +86,7 @@ Another case may be exporting the slashing data protection when the validator is
 ```shell
 $ sedge slashing-export lighthouse -n sepolia --out slashing-protection.json                  
 2023-01-06 15:51:46 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:51:46 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:51:46 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-06 15:51:46 -- [INFO] Stopping validator client
 # highlight-next-line
@@ -107,7 +107,7 @@ In this case, the validator client is stopped before the export and started agai
  ```shell
 $ sedge slashing-export lighthouse -n sepolia --out slashing-protection.json --stop-validator
 2023-01-06 15:52:07 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:52:07 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:52:07 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-06 15:52:07 -- [INFO] Stopping validator client
 # highlight-next-line

diff --git a/docs/docs/commands/slashingImport.mdx b/docs/docs/commands/slashingImport.mdx
@@ -56,7 +56,7 @@ This is an example of importing slashing protection data to a setup using sepoli
 ```shell
 $ sedge slashing-import prysm -f slashing-export.json -n sepolia
 2023-01-06 14:59:11 -- [INFO] [Logger Init] Log level: info
-2023-01-06 14:59:11 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 14:59:11 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-06 14:59:11 -- [INFO] Importing slashing data to client prysm from slashing-export.json
 # highlight-next-line
@@ -70,7 +70,7 @@ Notice in this case the validator client remains stopped because it has been sto
 ```shell
 $ sedge slashing-import prysm -f slashing-export.json -n sepolia --start-validator
 2023-01-06 15:08:05 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:08:06 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:08:06 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 2023-01-06 15:08:06 -- [INFO] Importing slashing data to client prysm from slashing-export.json
 2023-01-06 15:08:06 -- [INFO] The slashing protection container is starting...
 2023-01-06 15:08:06 -- [INFO] The slashing container ends successfully.
@@ -85,7 +85,7 @@ Another case may be importing the slashing data protection when the validator is
 ```shell
 $ sedge slashing-import prysm -f slashing-export.json -n sepolia 
 2023-01-06 15:10:27 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:10:27 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:10:27 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-06 15:10:27 -- [INFO] Stopping validator client...
 # highlight-next-line
@@ -106,7 +106,7 @@ In this case, the validator client is stopped before the import and started agai
  ```shell
 $ sedge slashing-import prysm -f slashing-export.json -n sepolia --stop-validator
 2023-01-06 15:12:22 -- [INFO] [Logger Init] Log level: info
-2023-01-06 15:12:22 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2023-01-06 15:12:22 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 # highlight-next-line
 2023-01-06 15:12:22 -- [INFO] Stopping validator client...
 # highlight-next-line

diff --git a/docs/docs/commands/version.mdx b/docs/docs/commands/version.mdx
@@ -29,6 +29,6 @@ Global Flags:
 ```
 $ sedge version
 2022-00-00 00:00:00 -- [INFO] [Logger Init] Log level: info
-2022-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.5.0
+2022-00-00 00:00:00 -- [INFO] You are running the latest version of sedge. Version:  v1.6.0
 sedge v0.5.1
 ```
diff --git a/docs/docs/quickstart/complete-guide.mdx b/docs/docs/quickstart/complete-guide.mdx
@@ -41,14 +41,14 @@ want to use another installation method:
   <TabItem value="curl" label="curl">
 
   ```
-  curl -L https://github.com/NethermindEth/sedge/releases/download/v1.5.0/sedge-v1.5.0-linux-amd64 --output sedge
+  curl -L https://github.com/NethermindEth/sedge/releases/download/v1.6.0/sedge-v1.6.0-linux-amd64 --output sedge
   ```
 
   </TabItem>
   <TabItem value="wget" label="wget">
 
   ```
-  wget https://github.com/NethermindEth/sedge/releases/download/v1.5.0/sedge-v1.5.0-linux-amd64 -O sedge
+  wget https://github.com/NethermindEth/sedge/releases/download/v1.6.0/sedge-v1.6.0-linux-amd64 -O sedge
   ```
 
   </TabItem>