refactoring how proposer settings load into validator client (#13645)

* refactoring how proposer settings load

* fixing tests and moving test data

* fixing linting and adding comments

* accidently removed a function, adding it back in

* fixing usage of dependency

* gaz

* fixing package visibility

* gaz

* iface config gaz

* adding visibility for db

* fix ineffectual assignment to err

* adding in log for when the builder is set but ignored due to no fee recipient

* Update config/validator/service/proposer_settings.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/validator/service/proposer_settings.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update validator/client/validator.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/validator/service/proposer_settings.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/proposer/loader.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/proposer/loader.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/proposer/loader.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/proposer/loader.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/proposer/loader.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/validator/service/proposer_settings.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update config/util.go

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* some of the review feedback

* more review comments

* adding more test coverage

* Update config/proposer/loader.go

Co-authored-by: Manu NALEPA <enalepa@offchainlabs.com>

* Update config/proposer/loader.go

Co-authored-by: Manu NALEPA <enalepa@offchainlabs.com>

* Update config/proposer/loader.go

Co-authored-by: Manu NALEPA <enalepa@offchainlabs.com>

* Update config/proposer/loader.go

Co-authored-by: Manu NALEPA <enalepa@offchainlabs.com>

* updating based on feedback

* renaming variable

* fixing unhandled errors

* fixing tests

* gaz

* adding in gaslimit log

* fixing log

* some more review comments

* renaming and moving proposer settings file

---------

Co-authored-by: Radosław Kapka <rkapka@wp.pl>
Co-authored-by: Manu NALEPA <enalepa@offchainlabs.com>

validator/db/iface/BUILD.bazel

@@ -5,10 +5,13 @@ go_library(
     srcs = ["interface.go"],
     importpath = "github.com/prysmaticlabs/prysm/v5/validator/db/iface",
     # Other packages must use github.com/prysmaticlabs/prysm/v5/validator/db.Database alias.
-    visibility = ["//validator:__subpackages__"],
+    visibility = [
+        "//config:__subpackages__",
+        "//validator:__subpackages__",
+    ],
     deps = [
         "//config/fieldparams:go_default_library",
-        "//config/validator/service:go_default_library",
+        "//config/proposer:go_default_library",
         "//consensus-types/primitives:go_default_library",
         "//monitoring/backup:go_default_library",
         "//proto/prysm/v1alpha1:go_default_library",

validator/db/iface/interface.go

@@ -6,7 +6,7 @@ import (
 	"io"
 
 	fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
-	validatorServiceConfig "github.com/prysmaticlabs/prysm/v5/config/validator/service"
+	"github.com/prysmaticlabs/prysm/v5/config/proposer"
 	"github.com/prysmaticlabs/prysm/v5/consensus-types/primitives"
 	"github.com/prysmaticlabs/prysm/v5/monitoring/backup"
 	ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
@@ -65,9 +65,7 @@ type ValidatorDB interface {
 	GraffitiOrderedIndex(ctx context.Context, fileHash [32]byte) (uint64, error)
 
 	// ProposerSettings related methods
-	ProposerSettings(context.Context) (*validatorServiceConfig.ProposerSettings, error)
+	ProposerSettings(context.Context) (*proposer.Settings, error)
 	ProposerSettingsExists(ctx context.Context) (bool, error)
-	UpdateProposerSettingsDefault(context.Context, *validatorServiceConfig.ProposerOption) error
-	UpdateProposerSettingsForPubkey(context.Context, [fieldparams.BLSPubkeyLength]byte, *validatorServiceConfig.ProposerOption) error
-	SaveProposerSettings(ctx context.Context, settings *validatorServiceConfig.ProposerSettings) error
+	SaveProposerSettings(ctx context.Context, settings *proposer.Settings) error
 }

validator/db/kv/BUILD.bazel

@@ -30,7 +30,7 @@ go_library(
         "//config/features:go_default_library",
         "//config/fieldparams:go_default_library",
         "//config/params:go_default_library",
-        "//config/validator/service:go_default_library",
+        "//config/proposer:go_default_library",
         "//consensus-types/primitives:go_default_library",
         "//encoding/bytesutil:go_default_library",
         "//io/file:go_default_library",
@@ -70,7 +70,7 @@ go_test(
     deps = [
         "//config/fieldparams:go_default_library",
         "//config/params:go_default_library",
-        "//config/validator/service:go_default_library",
+        "//config/proposer:go_default_library",
         "//consensus-types/primitives:go_default_library",
         "//consensus-types/validator:go_default_library",
         "//crypto/hash:go_default_library",

validator/db/kv/proposer_settings.go

@@ -2,11 +2,9 @@ package kv
 
 import (
 	"context"
-	"fmt"
 
 	"github.com/pkg/errors"
-	fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
-	validatorServiceConfig "github.com/prysmaticlabs/prysm/v5/config/validator/service"
+	"github.com/prysmaticlabs/prysm/v5/config/proposer"
 	validatorpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1/validator-client"
 	bolt "go.etcd.io/bbolt"
 	"go.opencensus.io/trace"
@@ -16,74 +14,9 @@ import (
 // ErrNoProposerSettingsFound is an error thrown when no settings are found in bucket
 var ErrNoProposerSettingsFound = errors.New("no proposer settings found in bucket")
 
-// UpdateProposerSettingsForPubkey updates the existing settings for an internal representation of the proposers settings file at a particular public key
-func (s *Store) UpdateProposerSettingsForPubkey(ctx context.Context, pubkey [fieldparams.BLSPubkeyLength]byte, options *validatorServiceConfig.ProposerOption) error {
-	_, span := trace.StartSpan(ctx, "validator.db.UpdateProposerSettingsForPubkey")
-	defer span.End()
-	err := s.db.Update(func(tx *bolt.Tx) error {
-		bkt := tx.Bucket(proposerSettingsBucket)
-		b := bkt.Get(proposerSettingsKey)
-		if len(b) == 0 {
-			return fmt.Errorf("no proposer settings found in bucket")
-		}
-		to := &validatorpb.ProposerSettingsPayload{}
-		if err := proto.Unmarshal(b, to); err != nil {
-			return errors.Wrap(err, "failed to unmarshal proposer settings")
-		}
-		settings, err := validatorServiceConfig.ToSettings(to)
-		if err != nil {
-			return errors.Wrap(err, "failed to convert payload to proposer settings")
-		}
-		if settings.ProposeConfig == nil {
-			settings.ProposeConfig = make(map[[fieldparams.BLSPubkeyLength]byte]*validatorServiceConfig.ProposerOption)
-		}
-		settings.ProposeConfig[pubkey] = options
-		m, err := proto.Marshal(settings.ToPayload())
-		if err != nil {
-			return errors.Wrap(err, "failed to marshal proposer settings")
-		}
-		return bkt.Put(proposerSettingsKey, m)
-	})
-	return err
-}
-
-// UpdateProposerSettingsDefault updates the existing default settings for proposer settings
-func (s *Store) UpdateProposerSettingsDefault(ctx context.Context, options *validatorServiceConfig.ProposerOption) error {
-	_, span := trace.StartSpan(ctx, "validator.db.UpdateProposerSettingsDefault")
-	defer span.End()
-	if options == nil {
-		return errors.New("proposer settings option was empty")
-	}
-	if options.FeeRecipientConfig == nil {
-		return errors.New("fee recipient cannot be empty")
-	}
-	err := s.db.Update(func(tx *bolt.Tx) error {
-		bkt := tx.Bucket(proposerSettingsBucket)
-		b := bkt.Get(proposerSettingsKey)
-		if len(b) == 0 {
-			return ErrNoProposerSettingsFound
-		}
-		to := &validatorpb.ProposerSettingsPayload{}
-		if err := proto.Unmarshal(b, to); err != nil {
-			return errors.Wrap(err, "failed to unmarshal proposer settings")
-		}
-		settings, err := validatorServiceConfig.ToSettings(to)
-		if err != nil {
-			return errors.Wrap(err, "failed to convert payload to proposer settings")
-		}
-		settings.DefaultConfig = options
-		m, err := proto.Marshal(settings.ToPayload())
-		if err != nil {
-			return errors.Wrap(err, "failed to marshal proposer settings")
-		}
-		return bkt.Put(proposerSettingsKey, m)
-	})
-	return err
-}
-
 // ProposerSettings gets the current proposer settings
-func (s *Store) ProposerSettings(ctx context.Context) (*validatorServiceConfig.ProposerSettings, error) {
-	_, span := trace.StartSpan(ctx, "validator.db.ProposerSettings")
+func (s *Store) ProposerSettings(ctx context.Context) (*proposer.Settings, error) {
+	_, span := trace.StartSpan(ctx, "validator.db.Settings")
 	defer span.End()
 	to := &validatorpb.ProposerSettingsPayload{}
 	if err := s.db.View(func(tx *bolt.Tx) error {
@@ -99,7 +32,7 @@ func (s *Store) ProposerSettings(ctx context.Context) (*validatorServiceConfig.P
 	}); err != nil {
 		return nil, err
 	}
-	return validatorServiceConfig.ToSettings(to)
+	return proposer.SettingFromConsensus(to)
 }
 
 // ProposerSettingsExists returns true or false if the settings exist or not
@@ -118,7 +51,7 @@ func (s *Store) ProposerSettingsExists(ctx context.Context) (bool, error) {
 }
 
 // SaveProposerSettings saves the entire proposer setting overriding the existing settings
-func (s *Store) SaveProposerSettings(ctx context.Context, settings *validatorServiceConfig.ProposerSettings) error {
+func (s *Store) SaveProposerSettings(ctx context.Context, settings *proposer.Settings) error {
 	_, span := trace.StartSpan(ctx, "validator.db.SaveProposerSettings")
 	defer span.End()
 	// nothing to save
@@ -128,7 +61,7 @@ func (s *Store) SaveProposerSettings(ctx context.Context, settings *validatorSer
 	}
 	return s.db.Update(func(tx *bolt.Tx) error {
 		bkt := tx.Bucket(proposerSettingsBucket)
-		m, err := proto.Marshal(settings.ToPayload())
+		m, err := proto.Marshal(settings.ToConsensus())
 		if err != nil {
 			return errors.Wrap(err, "failed to marshal proposer settings")
 		}

validator/db/kv/proposer_settings_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
 	"github.com/prysmaticlabs/prysm/v5/config/params"
-	validatorServiceConfig "github.com/prysmaticlabs/prysm/v5/config/validator/service"
+	"github.com/prysmaticlabs/prysm/v5/config/proposer"
 	"github.com/prysmaticlabs/prysm/v5/consensus-types/validator"
 	"github.com/prysmaticlabs/prysm/v5/encoding/bytesutil"
 	"github.com/prysmaticlabs/prysm/v5/testing/require"
@@ -20,23 +20,23 @@ func TestStore_ProposerSettings_ReadAndWrite(t *testing.T) {
 		db := setupDB(t, [][fieldparams.BLSPubkeyLength]byte{})
 		key1, err := hexutil.Decode("0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a")
 		require.NoError(t, err)
-		settings := &validatorServiceConfig.ProposerSettings{
-			ProposeConfig: map[[fieldparams.BLSPubkeyLength]byte]*validatorServiceConfig.ProposerOption{
+		settings := &proposer.Settings{
+			ProposeConfig: map[[fieldparams.BLSPubkeyLength]byte]*proposer.Option{
 				bytesutil.ToBytes48(key1): {
-					FeeRecipientConfig: &validatorServiceConfig.FeeRecipientConfig{
+					FeeRecipientConfig: &proposer.FeeRecipientConfig{
 						FeeRecipient: common.HexToAddress("0x50155530FCE8a85ec7055A5F8b2bE214B3DaeFd3"),
 					},
-					BuilderConfig: &validatorServiceConfig.BuilderConfig{
+					BuilderConfig: &proposer.BuilderConfig{
 						Enabled:  true,
 						GasLimit: validator.Uint64(40000000),
 					},
 				},
 			},
-			DefaultConfig: &validatorServiceConfig.ProposerOption{
-				FeeRecipientConfig: &validatorServiceConfig.FeeRecipientConfig{
+			DefaultConfig: &proposer.Option{
+				FeeRecipientConfig: &proposer.FeeRecipientConfig{
 					FeeRecipient: common.HexToAddress("0x6e35733c5af9B61374A128e6F85f553aF09ff89A"),
 				},
-				BuilderConfig: &validatorServiceConfig.BuilderConfig{
+				BuilderConfig: &proposer.BuilderConfig{
 					Enabled:  false,
 					GasLimit: validator.Uint64(params.BeaconConfig().DefaultBuilderGasLimit),
 				},
@@ -54,12 +54,12 @@ func TestStore_ProposerSettings_ReadAndWrite(t *testing.T) {
 		db := setupDB(t, [][fieldparams.BLSPubkeyLength]byte{})
 		key1, err := hexutil.Decode("0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a")
 		require.NoError(t, err)
-		settings := &validatorServiceConfig.ProposerSettings{
-			DefaultConfig: &validatorServiceConfig.ProposerOption{
-				FeeRecipientConfig: &validatorServiceConfig.FeeRecipientConfig{
+		settings := &proposer.Settings{
+			DefaultConfig: &proposer.Option{
+				FeeRecipientConfig: &proposer.FeeRecipientConfig{
 					FeeRecipient: common.HexToAddress("0x6e35733c5af9B61374A128e6F85f553aF09ff89A"),
 				},
-				BuilderConfig: &validatorServiceConfig.BuilderConfig{
+				BuilderConfig: &proposer.BuilderConfig{
 					Enabled:  false,
 					GasLimit: validator.Uint64(params.BeaconConfig().DefaultBuilderGasLimit),
 				},
@@ -67,38 +67,41 @@ func TestStore_ProposerSettings_ReadAndWrite(t *testing.T) {
 		}
 		err = db.SaveProposerSettings(ctx, settings)
 		require.NoError(t, err)
-		upatedDefault := &validatorServiceConfig.ProposerOption{
-			FeeRecipientConfig: &validatorServiceConfig.FeeRecipientConfig{
+		updatedDefault := &proposer.Option{
+			FeeRecipientConfig: &proposer.FeeRecipientConfig{
 				FeeRecipient: common.HexToAddress("0x9995733c5af9B61374A128e6F85f553aF09ff89B"),
 			},
-			BuilderConfig: &validatorServiceConfig.BuilderConfig{
+			BuilderConfig: &proposer.BuilderConfig{
 				Enabled:  true,
 				GasLimit: validator.Uint64(params.BeaconConfig().DefaultBuilderGasLimit),
 			},
 		}
-		err = db.UpdateProposerSettingsDefault(ctx, upatedDefault)
+		settings.DefaultConfig = updatedDefault
+		err = db.SaveProposerSettings(ctx, settings)
 		require.NoError(t, err)
 
 		dbSettings, err := db.ProposerSettings(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, dbSettings)
-		require.DeepEqual(t, dbSettings.DefaultConfig, upatedDefault)
-		option := &validatorServiceConfig.ProposerOption{
-			FeeRecipientConfig: &validatorServiceConfig.FeeRecipientConfig{
+		require.DeepEqual(t, dbSettings.DefaultConfig, updatedDefault)
+		option := &proposer.Option{
+			FeeRecipientConfig: &proposer.FeeRecipientConfig{
 				FeeRecipient: common.HexToAddress("0x50155530FCE8a85ec7055A5F8b2bE214B3DaeFd3"),
 			},
-			BuilderConfig: &validatorServiceConfig.BuilderConfig{
+			BuilderConfig: &proposer.BuilderConfig{
 				Enabled:  true,
 				GasLimit: validator.Uint64(40000000),
 			},
 		}
-		err = db.UpdateProposerSettingsForPubkey(ctx, bytesutil.ToBytes48(key1), option)
+
+		dbSettings.ProposeConfig = map[[fieldparams.BLSPubkeyLength]byte]*proposer.Option{bytesutil.ToBytes48(key1): option}
+		err = db.SaveProposerSettings(ctx, dbSettings)
 		require.NoError(t, err)
 
 		newSettings, err := db.ProposerSettings(ctx)
 		require.NoError(t, err)
 		require.NotNil(t, newSettings)
-		require.DeepEqual(t, newSettings.DefaultConfig, upatedDefault)
+		require.DeepEqual(t, newSettings.DefaultConfig, updatedDefault)
 		op, ok := newSettings.ProposeConfig[bytesutil.ToBytes48(key1)]
 		require.Equal(t, ok, true)
 		require.DeepEqual(t, op, option)

validator/db/testing/BUILD.bazel

@@ -6,6 +6,7 @@ go_library(
     importpath = "github.com/prysmaticlabs/prysm/v5/validator/db/testing",
     visibility = [
         "//cmd:__subpackages__",
+        "//config:__subpackages__",
         "//validator:__subpackages__",
     ],
     deps = [