Builder ssz (#14976)

* wip

* refactoring functions for easier readability

* allow ssz for register validator

* changelog

* adding in blinded block submission tests

* adding in tests for header ssz

* fixing linting and tests

* adding in custom errors and fixing ssz validator registration

* Update api/client/builder/client.go

Co-authored-by: Manu NALEPA <[email protected]>

* Update api/client/builder/client.go

Co-authored-by: Manu NALEPA <[email protected]>

* manu's feedback

* linting

* adding in info log to notify that this setting was turned on

* fixing linting

* manu's feedback

* fixing import

---------

Co-authored-by: Manu NALEPA <[email protected]>

Author: 2 people

api/client/builder/client.go

@@ -15,3 +15,9 @@ var ErrBadRequest = errors.Wrap(ErrNotOK, "recv 400 BadRequest response from API
 // ErrNoContent specifically means that a '204 - No Content' response was received from the API.
 // Typically, a 204 is a success but in this case for the Header API means No header is available
 var ErrNoContent = errors.New("recv 204 no content response from API, No header is available")
+
+// ErrUnsupportedMediaType specifically means that a '415 - Unsupported Media Type' was received from the API.
+var ErrUnsupportedMediaType = errors.Wrap(ErrNotOK, "The media type in \"Content-Type\" header is unsupported, and the request has been rejected. This occurs when a HTTP request supplies a payload in a content-type that the server is not able to handle.")
+
+// ErrNotAcceptable specifically means that a '406 - Not Acceptable' was received from the API.
+var ErrNotAcceptable = errors.Wrap(ErrNotOK, "The accept header value is not acceptable")

api/client/builder/client_test.go

@@ -3,6 +3,7 @@ load("@prysm//tools/go:def.bzl", "go_library", "go_test")
 go_library(
     name = "go_default_library",
     srcs = [
+        "log.go",
         "metric.go",
         "option.go",
         "service.go",

api/client/builder/errors.go

@@ -0,0 +1,5 @@
+package builder
+
+import "github.com/sirupsen/logrus"
+
+var log = logrus.WithField("prefix", "builder")

beacon-chain/builder/BUILD.bazel

@@ -14,10 +14,16 @@ type Option func(s *Service) error
 // FlagOptions for builder service flag configurations.
 func FlagOptions(c *cli.Context) ([]Option, error) {
 	endpoint := c.String(flags.MevRelayEndpoint.Name)
+	sszEnabled := c.Bool(flags.EnableBuilderSSZ.Name)
 	var client *builder.Client
 	if endpoint != "" {
+		var opts []builder.ClientOpt
+		if sszEnabled {
+			log.Info("Using APIs with SSZ enabled")
+			opts = append(opts, builder.WithSSZ())
+		}
 		var err error
-		client, err = builder.NewClient(endpoint)
+		client, err = builder.NewClient(endpoint, opts...)
 		if err != nil {
 			return nil, err
 		}

beacon-chain/builder/log.go

@@ -17,7 +17,6 @@ import (
 	"github.com/prysmaticlabs/prysm/v5/monitoring/tracing/trace"
 	v1 "github.com/prysmaticlabs/prysm/v5/proto/engine/v1"
 	ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
-	log "github.com/sirupsen/logrus"
 )
 
 // ErrNoBuilder is used when builder endpoint is not configured.

beacon-chain/builder/option.go

@@ -0,0 +1,3 @@
+### Added
+
+- enable SSZ for builder API calls

beacon-chain/builder/service.go

@@ -28,6 +28,14 @@ var (
 		Usage: "A MEV builder relay string http endpoint, this will be used to interact MEV builder network using API defined in: https://ethereum.github.io/builder-specs/#/Builder",
 		Value: "",
 	}
+
+	// EnableBuilderSSZ enables Builder APIs to send and receive in SSZ format
+	EnableBuilderSSZ = &cli.BoolFlag{
+		Name:    "enable-builder-ssz",
+		Aliases: []string{"builder-ssz"},
+		Usage:   "Enables Builder APIs to send and receive in SSZ format",
+	}
+
 	MaxBuilderConsecutiveMissedSlots = &cli.IntFlag{
 		Name:  "max-builder-consecutive-missed-slots",
 		Usage: "Number of consecutive skip slot to fallback from using relay/builder to local execution engine for block construction",

changelog/james-prysm_builder-ssz.md

@@ -84,6 +84,7 @@ var appFlags = []cli.Flag{
 	flags.MinBuilderDiff,
 	flags.BeaconDBPruning,
 	flags.PrunerRetentionEpochs,
+	flags.EnableBuilderSSZ,
 	cmd.BackupWebhookOutputDir,
 	cmd.MinimalConfigFlag,
 	cmd.E2EConfigFlag,