Add telemetry for beacon and eth version (#2176)

Co-authored-by: Cal Bera <[email protected]>

beacond/cmd/defaults.go

@@ -104,7 +104,9 @@ func DefaultComponents() []any {
 			*BeaconBlockHeader, *BeaconState, *BeaconStateMarshallable,
 			*ExecutionPayload, *ExecutionPayloadHeader, *KVStore, *Logger,
 		],
-		components.ProvideReportingService[*Logger],
+		components.ProvideReportingService[
+			*ExecutionPayload, *PayloadAttributes, *Logger,
+		],
 		components.ProvideCometBFTService[*Logger],
 		components.ProvideServiceRegistry[
 			*AvailabilityStore,

beacond/cmd/types.go

@@ -162,7 +162,10 @@ type (
 	NodeAPIServer = server.Server[NodeAPIContext]
 
 	// ReportingService is a type alias for the reporting service.
-	ReportingService = version.ReportingService
+	ReportingService = version.ReportingService[
+		*ExecutionPayload,
+		*PayloadAttributes,
+	]
 
 	// SidecarFactory is a type alias for the sidecar factory.
 	SidecarFactory = dablob.SidecarFactory[

mod/execution/pkg/client/client.go

@@ -24,6 +24,7 @@ import (
 	"context"
 	"math/big"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/berachain/beacon-kit/mod/errors"
@@ -51,6 +52,10 @@ type EngineClient[
 	metrics *clientMetrics
 	// capabilities is a map of capabilities that the execution client has.
 	capabilities map[string]struct{}
+	// connected will be set to true when we have successfully connected
+	// to the execution client.
+	connectedMu sync.RWMutex
+	connected   bool
 }
 
 // New creates a new engine client EngineClient.
@@ -82,6 +87,7 @@ func New[
 		capabilities: make(map[string]struct{}),
 		eth1ChainID:  eth1ChainID,
 		metrics:      newClientMetrics(telemetrySink, logger),
+		connected:    false,
 	}
 }
 
@@ -130,11 +136,25 @@ func (s *EngineClient[
 				}
 				continue
 			}
+			s.connectedMu.Lock()
+			s.connected = true
+			s.connectedMu.Unlock()
 			return nil
 		}
 	}
 }
 
+func (s *EngineClient[_, _]) IsConnected() bool {
+	s.connectedMu.RLock()
+	defer s.connectedMu.RUnlock()
+	return s.connected
+}
+
+func (s *EngineClient[_, _]) HasCapability(capability string) bool {
+	_, ok := s.capabilities[capability]
+	return ok
+}
+
 /* -------------------------------------------------------------------------- */
 /*                                   Helpers                                  */
 /* -------------------------------------------------------------------------- */

mod/execution/pkg/client/engine.go

@@ -188,7 +188,7 @@ func (s *EngineClient[
 
 	// Log the capabilities that the execution client does not have.
 	for _, capability := range ethclient.BeaconKitSupportedCapabilities() {
-		if _, exists := s.capabilities[capability]; !exists {
+		if !s.HasCapability(capability) {
 			s.logger.Warn(
 				"Your execution client may require an update 🚸",
 				"unsupported_capability", capability,

mod/execution/pkg/client/ethclient/engine.go

@@ -27,6 +27,7 @@ import (
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/eip4844"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/version"
+	"github.com/ethereum/go-ethereum/beacon/engine"
 )
 
 /* -------------------------------------------------------------------------- */
@@ -180,8 +181,12 @@ func (s *Client[ExecutionPayloadT]) GetClientVersionV1(
 	ctx context.Context,
 ) ([]engineprimitives.ClientVersionV1, error) {
 	result := make([]engineprimitives.ClientVersionV1, 0)
+
+	// NOTE: although the ethereum spec does not require us passing a
+	// clientversion as param, it seems some clients require it and even
+	// enforce a valid Code.
 	if err := s.Call(
-		ctx, &result, GetClientVersionV1, nil,
+		ctx, &result, GetClientVersionV1, engine.ClientVersionV1{Code: "GE"},
 	); err != nil {
 		return nil, err
 	}

mod/node-core/pkg/components/reporting_service.go

@@ -22,28 +22,41 @@ package components
 
 import (
 	"cosmossdk.io/depinject"
+	"github.com/berachain/beacon-kit/mod/execution/pkg/client"
 	"github.com/berachain/beacon-kit/mod/log"
 	"github.com/berachain/beacon-kit/mod/node-core/pkg/components/metrics"
 	"github.com/berachain/beacon-kit/mod/node-core/pkg/services/version"
+	"github.com/berachain/beacon-kit/mod/primitives/pkg/constraints"
 	sdkversion "github.com/cosmos/cosmos-sdk/version"
 )
 
 type ReportingServiceInput[
+	ExecutionPayloadT constraints.EngineType[ExecutionPayloadT],
+	PayloadAttributesT client.PayloadAttributes,
 	LoggerT log.AdvancedLogger[LoggerT],
 ] struct {
 	depinject.In
 	Logger        LoggerT
 	TelemetrySink *metrics.TelemetrySink
+	EngineClient  *client.EngineClient[
+		ExecutionPayloadT,
+		PayloadAttributesT,
+	]
 }
 
 func ProvideReportingService[
+	ExecutionPayloadT constraints.EngineType[ExecutionPayloadT],
+	PayloadAttributesT client.PayloadAttributes,
 	LoggerT log.AdvancedLogger[LoggerT],
 ](
-	in ReportingServiceInput[LoggerT],
-) *ReportingService {
-	return version.NewReportingService(
+	in ReportingServiceInput[ExecutionPayloadT, PayloadAttributesT, LoggerT],
+) *version.ReportingService[ExecutionPayloadT, PayloadAttributesT] {
+	return version.NewReportingService[
+		ExecutionPayloadT, PayloadAttributesT,
+	](
 		in.Logger.With("service", "reporting"),
 		in.TelemetrySink,
 		sdkversion.Version,
+		in.EngineClient,
 	)
 }

mod/node-core/pkg/components/service_registry.go

@@ -35,6 +35,7 @@ import (
 	"github.com/berachain/beacon-kit/mod/node-api/server"
 	"github.com/berachain/beacon-kit/mod/node-core/pkg/components/metrics"
 	service "github.com/berachain/beacon-kit/mod/node-core/pkg/services/registry"
+	"github.com/berachain/beacon-kit/mod/node-core/pkg/services/version"
 	"github.com/berachain/beacon-kit/mod/observability/pkg/telemetry"
 )
 
@@ -101,7 +102,10 @@ type ServiceRegistryInput[
 	]
 	Logger           LoggerT
 	NodeAPIServer    *server.Server[NodeAPIContextT]
-	ReportingService *ReportingService
+	ReportingService *version.ReportingService[
+		ExecutionPayloadT,
+		*engineprimitives.PayloadAttributes[WithdrawalT],
+	]
 	TelemetrySink    *metrics.TelemetrySink
 	TelemetryService *telemetry.Service
 	ValidatorService *validator.Service[

mod/node-core/pkg/components/types.go

@@ -27,7 +27,6 @@ import (
 	consruntimetypes "github.com/berachain/beacon-kit/mod/consensus/pkg/types"
 	engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
 	"github.com/berachain/beacon-kit/mod/node-core/pkg/components/signer"
-	"github.com/berachain/beacon-kit/mod/node-core/pkg/services/version"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/async"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/transition"
 	"github.com/berachain/beacon-kit/mod/storage/pkg/manager"
@@ -40,9 +39,6 @@ import (
 type (
 	// DBManager is a type alias for the database manager.
 	DBManager = manager.DBManager
-
-	// ReportingService is a type alias for the reporting service.
-	ReportingService = version.ReportingService
 )
 
 /* -------------------------------------------------------------------------- */

mod/node-core/pkg/services/version/types.go

@@ -25,4 +25,7 @@ type TelemetrySink interface {
 	// IncrementCounter increments a counter metric identified by the provided
 	// keys.
 	IncrementCounter(key string, args ...string)
+	// SetGauge sets a gauge metric to the specified value, identified by the
+	// provided keys.
+	SetGauge(key string, value int64, args ...string)
 }