Merge branch 'develop' into feat/dashboards-lido

NethermindEth · Oct 7, 2024 · b774172 · b774172
2 parents 0a675f8 + f1d4580
commit b774172
Show file tree

Hide file tree

Showing 21 changed files with 8,542 additions and 15,730 deletions.
diff --git a/.github/workflows/check-version.yml b/.github/workflows/check-version.yml
@@ -13,17 +13,24 @@ jobs:
 
     steps:
       - name: Checkout Sedge repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Authenticate App
+        id: gh-app
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
 
       - name: Run update check script
         run: chmod +x ./scripts/check-image-updates.sh && ./scripts/check-image-updates.sh
         env:
-          PAT: ${{ secrets.REPOSITORY_DISPATCH_TOKEN }}
+          PAT: ${{ steps.gh-app.outputs.token }}
 
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:
-          token: ${{ secrets.REPOSITORY_DISPATCH_TOKEN }}
+          token: ${{ steps.gh-app.outputs.token }}
           commit-message: Update image versions to latest version.
           title: "[Update] Update image versions"
           reviewers: AntiD2ta, adriantpaez, stdevMac, cbermudez97 

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,39 @@
+name: CodeQL SAST
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+  schedule:
+    - cron: "23 9 * * 3"
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["go"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 #v4.2.0
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@5618c9fc1e675841ca52c1c6b1304f5255a905a0 #v2.19.0
+        with:
+          languages: ${{ matrix.language }}
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@5618c9fc1e675841ca52c1c6b1304f5255a905a0 #v2.19.0
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@5618c9fc1e675841ca52c1c6b1304f5255a905a0 #v2.19.0
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -120,10 +120,17 @@ jobs:
           chmod +x /home/runner/work/sedge/sedge/homebrew-sedge/scripts/update-homebrew.sh
           bash /home/runner/work/sedge/sedge/homebrew-sedge/scripts/update-homebrew.sh
 
+      - name: Authenticate App
+        id: gh-app
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:
-          token: ${{ secrets.REPOSITORY_DISPATCH_TOKEN }}
+          token: ${{ steps.gh-app.outputs.token }}
           commit-message: Update Homebrew to latest release
           title: "[Release] Update Homebrew"
           reviewers: AntiD2ta, cbermudez97, stdevMac, adriantpaez

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,12 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - New command `lido-status` to display data of Lido Node Operator.
 - Monitoring stack setup with Grafana, Prometheus, and Node Exporter.
+- Security policy.
 
 ### Changed
 - Update Go version from 1.21 to 1.22.
+- Update documentation versions and dependencies.
 
 ### Fixed
 -  Teku and Lighthouse import keys container error on Windows.
+-  Security issues on dependencies.
+-  Typos on documentation.
 
 ## [v1.5.0] - 2024-09-06
 

diff --git a/README.md b/README.md
@@ -267,6 +267,10 @@ Please check our [Contributing Guidelines](https://docs.sedge.nethermind.io/docs
 
 If you know of any good tricks for validator setup that other people could also use well, please consider adding it to Sedge. Your efforts will be greatly appreciated by the community.
 
+## 🛡️ Security 
+
+If you believe you have found a security vulnerability in our code, please report it to us as described in our [security policy](SECURITY.md).
+
 ## ⚠️ 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/SECURITY.md b/SECURITY.md
@@ -0,0 +1,10 @@
+# Security policy
+
+If you believe you have found a security vulnerability in our code, we encourage you to report it to us as soon as possible.
+We ask that you do not publicly disclose any details of the vulnerability until we have had an opportunity to investigate and address it. 
+
+## Reporting a vulnerability
+
+To report a security vulnerability, go to [Report a vulnerability](https://github.com/NethermindEth/sedge/security/advisories/new). This will create a draft advisory. Please provide as much detail as possible including steps to reproduce the issue and any potential impact it may have.
+
+Alternatively, you can also send an email to [email protected]. We will work to acknowledge your report within 24 hours and will keep you informed throughout our investigation and resolution process. 
diff --git a/cli/testdata/run_tests/no_env/docker-compose.yml b/cli/testdata/run_tests/no_env/docker-compose.yml
@@ -122,30 +122,11 @@ services:
           fi
         done
       "
-  validator-import:
-    container_name: validator-import-client
-    build:
-      context: github.com/NethermindEth/lighthouse-init-validator
-      args:
-        LH_VERSION: ${VL_IMAGE_VERSION}
-        NETWORK: ${NETWORK}
-    networks:
-    - sedge
-    volumes:
-    - ${KEYSTORE_DIR}:/keystore
-    - ${VL_DATA_DIR}:/data
-    logging:
-      driver: json-file
-      options:
-        max-size: 10m
-        max-file: "10"
   validator:
     container_name: validator-client
     image: ${VL_IMAGE_VERSION}
     restart: unless-stopped
     depends_on:
-      validator-import:
-        condition: service_completed_successfully
       validator-blocker:
         condition: service_completed_successfully
       consensus:

diff --git a/cli/testdata/run_tests/no_version/docker-compose.yml b/cli/testdata/run_tests/no_version/docker-compose.yml
@@ -121,30 +121,11 @@ services:
           fi
         done
       "
-  validator-import:
-    container_name: validator-import-client
-    build:
-      context: github.com/NethermindEth/lighthouse-init-validator
-      args:
-        LH_VERSION: ${VL_IMAGE_VERSION}
-        NETWORK: ${NETWORK}
-    networks:
-    - sedge
-    volumes:
-    - ${KEYSTORE_DIR}:/keystore
-    - ${VL_DATA_DIR}:/data
-    logging:
-      driver: json-file
-      options:
-        max-size: 10m
-        max-file: "10"
   validator:
     container_name: validator-client
     image: ${VL_IMAGE_VERSION}
     restart: unless-stopped
     depends_on:
-      validator-import:
-        condition: service_completed_successfully
       validator-blocker:
         condition: service_completed_successfully
       consensus:

diff --git a/cli/testdata/run_tests/valid/docker-compose.yml b/cli/testdata/run_tests/valid/docker-compose.yml
@@ -121,30 +121,11 @@ services:
           fi
         done
       "
-  validator-import:
-    container_name: validator-import-client
-    build:
-      context: github.com/NethermindEth/lighthouse-init-validator
-      args:
-        LH_VERSION: ${VL_IMAGE_VERSION}
-        NETWORK: ${NETWORK}
-    networks:
-    - sedge
-    volumes:
-    - ${KEYSTORE_DIR}:/keystore
-    - ${VL_DATA_DIR}:/data
-    logging:
-      driver: json-file
-      options:
-        max-size: 10m
-        max-file: "10"
   validator:
     container_name: validator-client
     image: ${VL_IMAGE_VERSION}
     restart: unless-stopped
     depends_on:
-      validator-import:
-        condition: service_completed_successfully
       validator-blocker:
         condition: service_completed_successfully
       consensus:

diff --git a/docs/Makefile b/docs/Makefile
@@ -13,5 +13,10 @@ docs-serve: ## Serves the built website locally
 docs-publish: ## Publishes the website to GitHub pages
 	npm deploy
 
+install-deps: ## Install dependencies
+	sudo apt-get update
+	sudo apt-get install -y nodejs npm
+	npm install
+
 help: ## Show this help
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
diff --git a/docs/docs/quickstart/lido.mdx b/docs/docs/quickstart/lido.mdx
@@ -21,7 +21,8 @@ If you are interested in becoming a Lido node operator, make sure to read the [N
 
 :::info
 
-Lido CSM is **currently available on the Holesky testnet for [early adopters](https://operatorportal.lido.fi/modules/community-staking-module#block-ef60a1fa96ae4c7995dd7794de2a3e22)**. Check your eligibility on the Early Adoption program [here](https://lidofinance.github.io/csm-ea-checker/). The Mainnet launch is expected soon.
+Lido CSM is **[currently live and permissionless on the Holesky testnet](https://operatorportal.lido.fi/modules/community-staking-module)**.
+The Mainnet launch is expected soon. You can check your eligibility for the Early Adoption program on Mainnet [here](https://lidofinance.github.io/csm-ea-checker/).
 
 :::
 
@@ -146,4 +147,4 @@ Using the Lido CSM Widget, it allows you to:
 Remember to keep your node running smoothly and follow the Lido protocol rules to avoid any penalties or bond confiscation.
 
 For more detailed information on managing your Node Operator, refer to the
-[Lido CSM documentation](https://operatorportal.lido.fi/modules/community-staking-module#block-d3ad2b2bd3994a06b19dccc0794ac8d6).
+[Lido CSM documentation](https://operatorportal.lido.fi/modules/community-staking-module#block-d3ad2b2bd3994a06b19dccc0794ac8d6).
diff --git a/docs/docs/quickstart/samples/custom-bootnodes.mdx b/docs/docs/quickstart/samples/custom-bootnodes.mdx
@@ -36,7 +36,7 @@ sedge generate full-node --consensus-bootnodes enr:-<bootnode-enr-1>,enr:-<bootn
 ```
 
 Those examples can be applied to the Sedge commands that generate a node, such as `sedge generate consensus` or
-`sedge geneate execution`, setting in each case the bootnodes for the corresponding client, for
+`sedge generate execution`, setting in each case the bootnodes for the corresponding client, for
 
 ```
 sedge generate consensus --consensus-bootnodes enr:-<bootnode-enr-1>,enr:-<bootnode-enr-2>,enr:-<bootnode-enr-3>

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,8 +1,7 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+import {themes as prismThemes} from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -120,8 +119,8 @@ const config = {
         copyright: `Copyright © ${new Date().getFullYear()} Nethermind. Built with Docusaurus.`,
       },
       prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
       },
       algolia: {
         // The application ID provided by Algolia
@@ -147,4 +146,4 @@ const config = {
     }),
 };
 
-module.exports = config;
+export default config;