feat(testing): Integrate beacon-kit with CometBFTs e2e framework

.github/workflows/berachain_release.asc

@@ -1,13 +1,13 @@
 -----BEGIN PGP PUBLIC KEY BLOCK-----
 
-mDMEZ+LjPBYJKwYBBAHaRw8BAQdAUC2qlsvItL8t4akbGGnW4Qejm065ZF6E1Xgr
-si3fELe0IGFCZWFyIChyaykgPGFiZWFyQGJlcmFjaGFpbi5jb20+iJkEExYKAEEW
-IQSFe1Hdzfli8ODkZR5h2onr6vnIPgUCZ+LjPAIbAwUJAE8aAAULCQgHAgIiAgYV
-CgkICwIEFgIDAQIeBwIXgAAKCRBh2onr6vnIPimlAP9mjBwKkVVURdiXhT/OwhRP
-tIoveDnEAQCvZAfvLZot9wD8DOVkyNAK5EJRG3z91YwAEghIx7TQEQXXwDTR7yJR
-EgG4OARn4uM8EgorBgEEAZdVAQUBAQdAEpsRaZZxPghURnbHFsfDDZfQw/doSZ3A
-ejTMsnk6uwoDAQgHiH4EGBYKACYWIQSFe1Hdzfli8ODkZR5h2onr6vnIPgUCZ+Lj
-PAIbDAUJAE8aAAAKCRBh2onr6vnIPiQZAP0bf/FX33JAI2hELAfMu6Chj6//zLp/
-0Qx6ZzNPqRVkYgD+O53oMVoLJIxf1apXll/H0MVbWq8Gk4G/CUclVCpO/A4=
-=wqSB
+mDMEaIky1hYJKwYBBAHaRw8BAQdAnxP3mNWC+miF0OKvOg4+BzzswbrTWLbluSJU
++NBib3q0H2NhbGJlcmEgPGNhbGJlcmFAYmVyYWNoYWluLmNvbT6ImQQTFgoAQRYh
+BPzFjSePGuMIYGS4P/GUiPGD4kvxBQJoiTLWAhsDBQkAdqcABQsJCAcCAiICBhUK
+CQgLAgQWAgMBAh4HAheAAAoJEPGUiPGD4kvxA9oBANZQa+Q6UlhDPLOOhchdPSi7
+lmBE+za+5u5Q3bA7ZO8rAP46R+a1AxHqeLrShhkTvJwTG+qGvfS/LtHfNYLHqOQw
+Bbg4BGiJMtYSCisGAQQBl1UBBQEBB0A6onCspxjhXI7X13LHlUYQxYVyzUDamgVP
+hXYTLZ1QEAMBCAeIfgQYFgoAJhYhBPzFjSePGuMIYGS4P/GUiPGD4kvxBQJoiTLW
+AhsMBQkAdqcAAAoJEPGUiPGD4kvxWOAA/0IedfbPuCJU/IWo+gxCZMl9Fb7oVA4L
+v9lMBtnspGsxAQDRX3fFP/Bv96wHlUWQHg01TSaWNyTQa5dTpjEcLxnXCQ==
+=L8oL
 -----END PGP PUBLIC KEY BLOCK-----

.github/workflows/comet_e2e.yml

@@ -0,0 +1,32 @@
+name: Run Multiple Single Network
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  run-multiple-single:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.23.6"
+
+      - name: Show Docker and Docker Compose version
+        run: |
+          docker --version
+          docker compose version
+
+      - name: Build cmt-e2e
+        run: make build-cmt-e2e
+
+      - name: Run run-multiple.sh with ci.toml
+        run: make test-e2e-ci-no-build

.github/workflows/pipeline.yml

@@ -115,14 +115,6 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage-merged.txt
 
-      # Upload coverage for forge tests
-      - name: Upload Forge Test Coverage to Codecov
-        if: ${{ matrix.args == 'test-forge-cover' }}
-        uses: codecov/codecov-action@v2
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: test-forge-cover.txt
-
   # -------------------------------------------------------------------------- #
   #                                 E2E Testing                                #
   # -------------------------------------------------------------------------- #
@@ -195,6 +187,8 @@ jobs:
     permissions:
       id-token: write
       contents: read
+      packages: write
+      attestations: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -229,7 +223,7 @@ jobs:
         with:
           registry: ${{ env.GHCR_REGISTRY }}
           username: ${{ github.actor }}
-          password: ${{ secrets.GHCR_TOKEN }}
+          password: ${{ secrets.GITHUB_TOKEN }}
 
       - if: ${{ env.PUSH_DOCKER_IMAGE == 'true' }}
         name: Push Docker image

.gitignore

@@ -51,6 +51,9 @@ go.work.sum
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
+# Version files created during code generation
+v*.*.*
+
 ###########
 # Windows #
 ###########
@@ -238,3 +241,11 @@ temp-test-unit-cover.txt
 
 # server dev env for Air
 .air.toml
+
+# e2e framework
+testing/monitoring/data-grafana/
+testing/monitoring/data-prometheus/
+testing/monitoring/prometheus.yml
+testing/networks/single/
+testing/networks/simple/
+testing/networks/ci/

.golangci.yaml

@@ -13,6 +13,10 @@ run:
   timeout: 3m
   build-tags: ["test"]
 
+  skip-dirs:
+    - ^testing/cmt_e2e/runner # skip all runner content, mainly copies of cometbft/e2e/runner
+    - ^testing/cmt_e2e/test # temporary: TODO: run linter over tests
+
 
 # This file contains only configs which differ from defaults.
 # All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml

.mockery.yaml

@@ -75,3 +75,13 @@ packages:
       recursive: False
       with-expecter: true
       include-regex: ExecutionEngine
+  github.com/berachain/beacon-kit/beacon/blockchain:
+    config:
+      recursive: False
+      with-expecter: true
+      include-regex: LocalBuilder
+  github.com/berachain/beacon-kit/node-api/handlers/beacon:
+    config:
+      recursive: False
+      with-expecter: true
+      include-regex: ^Backend$

Dockerfile.e2e

@@ -0,0 +1,68 @@
+# syntax=docker/dockerfile:1
+# check=skip=SecretsUsedInArgOrEnv
+#
+# Copyright (C) 2022, Berachain Foundation. All rights reserved.
+# See the file LICENSE for licensing terms.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#######################################################
+###           Stage 0 - Build Arguments             ###
+#######################################################
+
+ARG IMAGE_NAME=beacond
+ARG VERSION=local-version
+
+FROM ${IMAGE_NAME}:${VERSION}
+
+###########################################################################
+###         Stage 1 - Add entrypoint_cmt_e2e.sh requirements to beacond         ###
+###########################################################################
+
+# Copy beacond because entrypoint_cmt_e2e.sh searches in ./build/bin
+RUN mkdir -p /build/bin && cp /usr/bin/beacond /build/bin 
+
+# Add files used by entrypoint_cmt_e2e.sh. Start the build process from the testing folder.
+COPY files/ /testing/files/
+COPY networks/ /testing/networks/
+COPY files/entrypoint_cmt_e2e.sh /usr/bin/entrypoint-builtin
+RUN chmod +x /usr/bin/entrypoint-builtin
+
+# Configure entrypoint_cmt_e2e.sh
+ENV RPC_PREFIX="http://"
+ENV RPC_DIAL_URL="172.17.0.1:8551"
+# For local runs on macos:
+#"host.docker.internal:8551" 
+# for CI this is the address of the docker host:
+#"172.17.0.1:8551" 
+
+ENV NON_INTERACTIVE=1
+ENV JWT_SECRET_PATH="/testing/files/jwt.hex"
+
+###########################################################################
+###         Stage 2 - Add consensus e2e test details to beacond         ###
+###########################################################################
+
+# Add iputils-ping and iproute2 for simulated network delay.
+RUN apk add --no-cache iputils-ping iproute2
+
+# Set up runtime directory.
+WORKDIR /
+VOLUME /cometbft
+ENV CMTHOME=/cometbft
+ENV HOMEDIR=/cometbft
+ENV GORACE="halt_on_error=1"
+
+EXPOSE 26656 26657 26660 6060 3500
+ENTRYPOINT ["/testing/files/entrypoint_cmt_e2e.sh"]
+CMD ["devnet"]
+STOPSIGNAL SIGTERM

Dockerfile.polycli

@@ -0,0 +1,42 @@
+# syntax=docker/dockerfile:1
+#
+# Copyright (C) 2022, Berachain Foundation. All rights reserved.
+# See the file LICENSE for licensing terms.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#######################################################
+###           Stage 0 - Build Arguments             ###
+#######################################################
+
+FROM alpine
+ARG VERSION=v0.1.82
+ARG AMD64_SHA=3f9a84cee678d0c0f568f1744040e337662782dce6c8054d1ca2fbbfbbcadf46
+
+###########################################################################
+###                  Stage 1 - Download polycli release                 ###
+###########################################################################
+
+RUN echo "${AMD64_SHA}  polycli_${VERSION}_linux_amd64.tar.gz" > amd64.sha && \
+    wget https://github.com/0xPolygon/polygon-cli/releases/download/${VERSION}/polycli_${VERSION}_linux_amd64.tar.gz && \
+    sha256sum -c amd64.sha && \
+    tar -xvzf polycli_${VERSION}_linux_amd64.tar.gz -C /usr/bin && \
+    mv /usr/bin/polycli_${VERSION}_linux_amd64 /usr/bin/polycli && \
+    rm -f polycli_${VERSION}_linux_amd64.tar.gz amd64.sha
+
+###########################################################################
+###                        Stage 2 - Run polycli                        ###
+###########################################################################
+
+ENTRYPOINT ["/usr/bin/polycli"]
+CMD ["--help"]
+STOPSIGNAL SIGTERM

README.md

@@ -30,14 +30,10 @@ The framework offers the most user-friendly way to build and operate an EVM bloc
 ## Supported Execution Clients
 
 Through utilizing the [Ethereum Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine)
-BeaconKit is able to support all 6 major Ethereum execution clients:
+BeaconKit supports the following execution clients:
 
-- [**Geth**](https://geth.ethereum.org/): Official Go implementation of the Ethereum protocol.
-- [**Erigon**](https://erigon.tech/): More performant, feature-rich client forked from `go-ethereum`.
-- [**Nethermind**](https://www.nethermind.io/): .NET based client with full support for Ethereum protocols.
-- [**Besu**](https://www.lfdecentralizedtrust.org/projects/besu): Enterprise-grade client, Apache 2.0 licensed, written in Java.
-- [**Reth**](https://reth.rs/): Rust-based client focusing on performance and reliability.
-- [**Ethereumjs**](https://ethereumjs.readthedocs.io/en/latest/#): Javascript based client managed by the Ethereum Foundation.
+- [**Bera-Geth**](https://github.com/berachain/bera-geth): Official Go implementation of the Berachain protocol.
+- [**Bera-Reth**](https://github.com/berachain/bera-reth): Rust-based client focusing on performance and reliability.
 
 ## Running a Local Development Network
 
@@ -63,7 +59,7 @@ eth-genesis file used by the Execution Client.
 
 ```bash
 # Start an Ethereum Execution Client:
-make start-reth # or start-geth start-besu start-erigon start-nethermind start-ethereumjs
+make start-reth # or start-geth
 ```
 
 The account with