feat(testing): Introduce node-api E2E testing

build/scripts/testing.mk

@@ -276,10 +276,6 @@ test-unit-fuzz: ## run fuzz tests
 	go test ./mod/payload/pkg/cache/... -fuzz=FuzzPayloadIDCacheConcurrency -fuzztime=${SHORT_FUZZ_TIME}
 	go test -fuzz=FuzzHashTreeRoot ./mod/primitives/pkg/merkle -fuzztime=${MEDIUM_FUZZ_TIME}
 
-
-
-
-
 test-e2e: ## run e2e tests
 	@$(MAKE) build-docker VERSION=kurtosis-local test-e2e-no-build
 

kurtosis/src/nodes/consensus/beacond/launcher.star

@@ -9,6 +9,7 @@ COMETBFT_REST_PORT_NUM = 1317
 COMETBFT_PPROF_PORT_NUM = 6060
 METRICS_PORT_NUM = 26660
 ENGINE_RPC_PORT_NUM = 8551
+NODE_API_PORT_NUM = 3500
 
 # Port IDs
 COMETBFT_RPC_PORT_ID = "cometbft-rpc"
@@ -19,6 +20,7 @@ COMETBFT_PPROF_PORT_ID = "cometbft-pprof"
 ENGINE_RPC_PORT_ID = "engine-rpc"
 METRICS_PORT_ID = "metrics"
 METRICS_PATH = "/metrics"
+NODE_API_PORT_ID = "node-api"
 
 USED_PORTS = {
     COMETBFT_RPC_PORT_ID: shared_utils.new_port_spec(COMETBFT_RPC_PORT_NUM, shared_utils.TCP_PROTOCOL),
@@ -27,6 +29,7 @@ USED_PORTS = {
     COMETBFT_PPROF_PORT_ID: shared_utils.new_port_spec(COMETBFT_PPROF_PORT_NUM, shared_utils.TCP_PROTOCOL),
     # ENGINE_RPC_PORT_ID: shared_utils.new_port_spec(ENGINE_RPC_PORT_NUM, shared_utils.TCP_PROTOCOL),
     METRICS_PORT_ID: shared_utils.new_port_spec(METRICS_PORT_NUM, shared_utils.TCP_PROTOCOL, wait = None),
+    NODE_API_PORT_ID: shared_utils.new_port_spec(NODE_API_PORT_NUM, shared_utils.TCP_PROTOCOL),
 }
 
 def get_config(node_struct, engine_dial_url, entrypoint = [], cmd = [], persistent_peers = "", expose_ports = True, jwt_file = None, kzg_trusted_setup_file = None):

kurtosis/src/nodes/consensus/beacond/node.star

@@ -39,6 +39,9 @@ def start(persistent_peers, is_seed, validator_index, config_settings, app_setti
     --beacon-kit.kzg.implementation={} \
     --beacon-kit.engine.rpc-dial-url {} \
     --rpc.laddr tcp://0.0.0.0:26657 --api.address tcp://0.0.0.0:1317 \
+    --beacon-kit.block-store-service.enabled \
+    --beacon-kit.node-api.enabled --beacon-kit.node-api.logging \
+    --pruning=nothing \
     --api.enable {} {}".format(kzg_impl, "$BEACOND_ENGINE_DIAL_URL", seed_option, persistent_peers_option)
 
     return "{} && {} && {}".format(mv_genesis, set_config, start_node)

mod/node-api/backend/validator.go

@@ -55,7 +55,7 @@ func (b Backend[
 			Index:   index.Unwrap(),
 			Balance: balance.Unwrap(),
 		},
-		Status:    "active", // TODO: fix
+		Status:    "active_ongoing", // TODO: fix
 		Validator: validator,
 	}, nil
 }

mod/node-api/engines/echo/vaildator.go

@@ -32,6 +32,10 @@ import (
 	"github.com/labstack/echo/v4"
 )
 
+// TODO: these validators need to be un-janked to 1) not use `FieldLevel` for
+// repeated `.Field().String()` calls and 2) strongly type the allowed IDs,
+// putting validation logic on each type.
+
 // CustomValidator is a custom validator for the API.
 type CustomValidator struct {
 	Validator *validator.Validate

mod/node-api/handlers/beacon/historical.go

@@ -47,9 +47,7 @@ func (h *Handler[_, ContextT, _, _]) GetStateRoot(c ContextT) (any, error) {
 	return beacontypes.ValidatorResponse{
 		ExecutionOptimistic: false, // stubbed
 		Finalized:           false, // stubbed
-		Data: types.Wrap(
-			beacontypes.RootData{Root: stateRoot},
-		),
+		Data:                beacontypes.RootData{Root: stateRoot},
 	}, nil
 }
 

mod/node-api/handlers/node/handler.go

@@ -31,7 +31,7 @@ type Handler[ContextT context.Context] struct {
 
 func NewHandler[ContextT context.Context]() *Handler[ContextT] {
 	h := &Handler[ContextT]{
-		BaseHandler: handlers.NewBaseHandler[ContextT](
+		BaseHandler: handlers.NewBaseHandler(
 			handlers.NewRouteSet[ContextT](""),
 		),
 	}

mod/node-api/handlers/node/placeholders.go

@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package node
+
+// Syncing is a placeholder so that beacon API clients don't break.
+//
+// TODO: Implement with real data.
+func (h *Handler[ContextT]) Syncing(ContextT) (any, error) {
+	type SyncingResponse struct {
+		Data struct {
+			HeadSlot     string `json:"head_slot"`
+			SyncDistance string `json:"sync_distance"`
+			IsSyncing    bool   `json:"is_syncing"`
+			IsOptimistic bool   `json:"is_optimistic"`
+			ELOffline    bool   `json:"el_offline"`
+		} `json:"data"`
+	}
+
+	response := SyncingResponse{}
+	response.Data.HeadSlot = "0"
+	response.Data.SyncDistance = "1"
+	response.Data.IsSyncing = false
+	response.Data.IsOptimistic = true
+	response.Data.ELOffline = false
+
+	return response, nil
+}
+
+// Version is a placeholder so that beacon API clients don't break.
+//
+// TODO: Implement with real data.
+func (h *Handler[ContextT]) Version(ContextT) (any, error) {
+	type VersionResponse struct {
+		Data struct {
+			Version string `json:"version"`
+		} `json:"data"`
+	}
+
+	response := VersionResponse{}
+	response.Data.Version = "1.0.0"
+
+	return response, nil
+}

mod/node-api/handlers/node/routes.go

@@ -55,12 +55,12 @@ func (h *Handler[ContextT]) RegisterRoutes(
 		{
 			Method:  http.MethodGet,
 			Path:    "/eth/v1/node/version",
-			Handler: h.NotImplemented,
+			Handler: h.Version,
 		},
 		{
 			Method:  http.MethodGet,
 			Path:    "/eth/v1/node/syncing",
-			Handler: h.NotImplemented,
+			Handler: h.Syncing,
 		},
 		{
 			Method:  http.MethodGet,

mod/node-api/handlers/utils/id.go

@@ -28,6 +28,10 @@ import (
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
 )
 
+// TODO: define unique types for each of the query-able IDs (state & block from
+// spec, execution unique to beacon-kit). For each type define validation
+// functions and resolvers to slot number.
+
 // SlotFromStateID returns a slot from the state ID.
 //
 // NOTE: Right now, `stateID` only supports querying by "head" (all of "head",

testing/e2e/config/defaults.go

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package config
+
+// Consensus clients.
+const (
+	DefaultClient   = "cl-validator-beaconkit-0"
+	AlternateClient = "cl-validator-beaconkit-1"
+)
+
+// Deposits.
+const (
+	DepositContractAddress = "0x4242424242424242424242424242424242424242"
+	NumDepositsLoad        = 500
+)

testing/e2e/e2e_api_test.go

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package e2e_test
+
+import (
+	beaconapi "github.com/attestantio/go-eth2-client/api"
+	"github.com/berachain/beacon-kit/mod/node-api/handlers/utils"
+	"github.com/berachain/beacon-kit/testing/e2e/config"
+)
+
+// TestBeaconAPISuite tests that the api test suite is setup correctly with a
+// working beacon node-api client.
+func (s *BeaconKitE2ESuite) TestBeaconAPIStartup() {
+	// Wait for execution block 5.
+	err := s.WaitForFinalizedBlockNumber(5)
+	s.Require().NoError(err)
+
+	// Get the consensus client.
+	client := s.ConsensusClients()[config.DefaultClient]
+	s.Require().NotNil(client)
+
+	// Ensure the state root is not nil.
+	stateRootResp, err := client.BeaconStateRoot(
+		s.Ctx(),
+		&beaconapi.BeaconStateRootOpts{
+			State: utils.StateIDHead,
+		},
+	)
+	s.Require().NoError(err)
+	s.Require().NotEmpty(stateRootResp)
+	s.Require().False(stateRootResp.Data.IsZero())
+}

testing/e2e/e2e_staking_test.go

@@ -26,26 +26,19 @@ import (
 	"github.com/berachain/beacon-kit/mod/consensus-types/pkg/types"
 	"github.com/berachain/beacon-kit/mod/geth-primitives/pkg/deposit"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+	"github.com/berachain/beacon-kit/testing/e2e/config"
 	"github.com/berachain/beacon-kit/testing/e2e/suite"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	gethcommon "github.com/ethereum/go-ethereum/common"
 	coretypes "github.com/ethereum/go-ethereum/core/types"
 )
 
-const (
-	// DepositContractAddress is the address of the deposit contract.
-	DepositContractAddress = "0x4242424242424242424242424242424242424242"
-	DefaultClient          = "cl-validator-beaconkit-0"
-	AlternateClient        = "cl-validator-beaconkit-1"
-	NumDepositsLoad        = 500
-)
-
 func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 	// Get the consensus client.
-	client := s.ConsensusClients()[DefaultClient]
+	client := s.ConsensusClients()[config.DefaultClient]
 	s.Require().NotNil(client)
 
-	client2 := s.ConsensusClients()[AlternateClient]
+	client2 := s.ConsensusClients()[config.AlternateClient]
 	s.Require().NotNil(client2)
 
 	// Sender account
@@ -80,7 +73,7 @@ func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 
 	// Bind the deposit contract.
 	dc, err := deposit.NewBeaconDepositContract(
-		gethcommon.HexToAddress(DepositContractAddress),
+		gethcommon.HexToAddress(config.DepositContractAddress),
 		s.JSONRPCBalancer(),
 	)
 	s.Require().NoError(err)
@@ -99,7 +92,7 @@ func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 	tx, err = dc.AllowDeposit(&bind.TransactOpts{
 		From:   genesisAccount.Address(),
 		Signer: genesisAccount.SignerFunc(chainID),
-	}, sender.Address(), NumDepositsLoad)
+	}, sender.Address(), config.NumDepositsLoad)
 	s.Require().NoError(err)
 
 	// Wait for the transaction to be mined.
@@ -115,7 +108,7 @@ func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 	)
 	s.Require().NoError(err)
 
-	for i := range NumDepositsLoad {
+	for i := range config.NumDepositsLoad {
 		// Create a deposit transaction.
 		tx, err = s.generateNewDepositTx(
 			dc,
@@ -126,7 +119,7 @@ func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 		s.Require().NoError(err)
 		s.Logger().
 			Info("Deposit transaction created", "txHash", tx.Hash().Hex())
-		if i == NumDepositsLoad-1 {
+		if i == config.NumDepositsLoad-1 {
 			s.Logger().Info(
 				"Waiting for deposit transaction to be mined", "txHash",
 				tx.Hash().Hex(),
@@ -158,7 +151,9 @@ func (s *BeaconKitE2ESuite) TestDepositRobustness() {
 	// upper bound: 32ether * 500 + 1ether
 	// lower bound: 32ether * 500
 	oneEther := big.NewInt(1e18)
-	totalAmt := new(big.Int).Mul(oneEther, big.NewInt(NumDepositsLoad*32))
+	totalAmt := new(big.Int).Mul(
+		oneEther, big.NewInt(config.NumDepositsLoad*32),
+	)
 	upperBound := new(big.Int).Add(totalAmt, oneEther)
 	amtSpent := new(big.Int).Sub(balance, postDepositBalance)
 
@@ -197,7 +192,7 @@ func (s *BeaconKitE2ESuite) generateNewDepositTx(
 	nonce *big.Int,
 ) (*coretypes.Transaction, error) {
 	// Get the consensus client.
-	client := s.ConsensusClients()[DefaultClient]
+	client := s.ConsensusClients()[config.DefaultClient]
 	s.Require().NotNil(client)
 
 	pubkey, err := client.GetPubKey(s.Ctx())

testing/e2e/suite/setup.go

@@ -112,6 +112,7 @@ func (s *KurtosisE2ESuite) SetupSuiteWithOptions(opts ...Option) {
 		"num_full_nodes",
 		len(s.cfg.NetworkConfiguration.FullNodes.Nodes),
 	)
+
 	result, err := s.enclave.RunStarlarkPackageBlocking(
 		s.ctx,
 		"../../kurtosis",