Keymanager APIs - get,post,delete graffiti

config/validator/service/proposer_settings.go

@@ -109,6 +109,7 @@ func (ps *ProposerSettings) ToPayload() *validatorpb.ProposerSettingsPayload {
 			if option.BuilderConfig != nil {
 				p.Builder = option.BuilderConfig.ToPayload()
 			}
+			p.Graffiti = option.Graffiti
 			payload.ProposerConfig[hexutil.Encode(key[:])] = p
 		}
 	}
@@ -120,6 +121,7 @@ func (ps *ProposerSettings) ToPayload() *validatorpb.ProposerSettingsPayload {
 		if ps.DefaultConfig.BuilderConfig != nil {
 			p.Builder = ps.DefaultConfig.BuilderConfig.ToPayload()
 		}
+		p.Graffiti = ps.DefaultConfig.Graffiti
 		payload.DefaultConfig = p
 	}
 	return payload
@@ -134,6 +136,7 @@ type FeeRecipientConfig struct {
 type ProposerOption struct {
 	FeeRecipientConfig *FeeRecipientConfig
 	BuilderConfig      *BuilderConfig
+	Graffiti           string
 }
 
 // Clone creates a deep copy of the proposer settings
@@ -211,5 +214,6 @@ func (po *ProposerOption) Clone() *ProposerOption {
 	if po.BuilderConfig != nil {
 		p.BuilderConfig = po.BuilderConfig.Clone()
 	}
+	p.Graffiti = po.Graffiti
 	return p
 }

proto/prysm/v1alpha1/validator-client/keymanager.proto

@@ -87,6 +87,7 @@ message SignResponse {
 message ProposerOptionPayload {
   string fee_recipient = 1;
   BuilderConfig builder = 2;
+  string graffiti = 3;
 }
 
 // BuilderConfig is a property of ProposerOptionPayload

validator/accounts/testing/BUILD.bazel

@@ -10,6 +10,7 @@ go_library(
         "//validator:__subpackages__",
     ],
     deps = [
+        "//config/fieldparams:go_default_library",
         "//config/validator/service:go_default_library",
         "//consensus-types/primitives:go_default_library",
         "//proto/prysm/v1alpha1:go_default_library",

validator/accounts/testing/mock.go

@@ -7,6 +7,7 @@ import (
 	"sync"
 	"time"
 
+	fieldparams "github.com/prysmaticlabs/prysm/v4/config/fieldparams"
 	validatorserviceconfig "github.com/prysmaticlabs/prysm/v4/config/validator/service"
 	"github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
 	ethpb "github.com/prysmaticlabs/prysm/v4/proto/prysm/v1alpha1"
@@ -90,6 +91,7 @@ func (_ *Wallet) InitializeKeymanager(_ context.Context, _ iface.InitKeymanagerC
 type Validator struct {
 	Km               keymanager.IKeymanager
 	proposerSettings *validatorserviceconfig.ProposerSettings
+	Graffiti         string
 }
 
 func (_ *Validator) LogSyncCommitteeMessagesSubmitted() {}
@@ -213,6 +215,26 @@ func (m *Validator) SetProposerSettings(_ context.Context, settings *validatorse
 	return nil
 }
 
+// GetGraffiti for mocking
+func (m *Validator) GetGraffiti(_ context.Context, _ [fieldparams.BLSPubkeyLength]byte) ([]byte, error) {
+	if m.Graffiti == "" {
+		return nil, errors.New("graffiti is missing ")
+	}
+	return []byte(m.Graffiti), nil
+}
+
+// SetGraffiti for mocking
+func (m *Validator) SetGraffiti(_ context.Context, _ [fieldparams.BLSPubkeyLength]byte, graffiti []byte) error {
+	m.Graffiti = string(graffiti)
+	return nil
+}
+
+// DeleteGraffiti for mocking
+func (m *Validator) DeleteGraffiti(_ context.Context, _ [fieldparams.BLSPubkeyLength]byte) error {
+	m.Graffiti = ""
+	return nil
+}
+
 func (_ *Validator) StartEventStream(_ context.Context) error {
 	panic("implement me")
 }

validator/client/iface/validator.go

@@ -64,6 +64,9 @@ type Validator interface {
 	SignValidatorRegistrationRequest(ctx context.Context, signer SigningFunc, newValidatorRegistration *ethpb.ValidatorRegistrationV1) (*ethpb.SignedValidatorRegistrationV1, error)
 	ProposerSettings() *validatorserviceconfig.ProposerSettings
 	SetProposerSettings(context.Context, *validatorserviceconfig.ProposerSettings) error
+	GetGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) ([]byte, error)
+	SetGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte, graffiti []byte) error
+	DeleteGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) error
 	StartEventStream(ctx context.Context) error
 	EventStreamIsRunning() bool
 	NodeIsHealthy(ctx context.Context) bool

validator/client/propose.go

@@ -6,12 +6,14 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/golang/protobuf/ptypes/timestamp"
 	"github.com/pkg/errors"
 	"github.com/prysmaticlabs/prysm/v4/async"
 	"github.com/prysmaticlabs/prysm/v4/beacon-chain/core/signing"
 	fieldparams "github.com/prysmaticlabs/prysm/v4/config/fieldparams"
 	"github.com/prysmaticlabs/prysm/v4/config/params"
+	validatorserviceconfig "github.com/prysmaticlabs/prysm/v4/config/validator/service"
 	"github.com/prysmaticlabs/prysm/v4/consensus-types/blocks"
 	"github.com/prysmaticlabs/prysm/v4/consensus-types/interfaces"
 	"github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
@@ -64,7 +66,7 @@ func (v *validator) ProposeBlock(ctx context.Context, slot primitives.Slot, pubK
 		return
 	}
 
-	g, err := v.getGraffiti(ctx, pubKey)
+	g, err := v.GetGraffiti(ctx, pubKey)
 	if err != nil {
 		// Graffiti is not a critical enough to fail block production and cause
 		// validator to miss block reward. When failed, validator should continue
@@ -382,9 +384,24 @@ func signVoluntaryExit(
 	return sig.Marshal(), nil
 }
 
-// Gets the graffiti from cli or file for the validator public key.
-func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) ([]byte, error) {
-	// When specified, default graffiti from the command line takes the first priority.
+// GetGraffiti Gets the graffiti from cli or file for the validator public key.
+func (v *validator) GetGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) ([]byte, error) {
+	// Check proposer settings first
+	if v.proposerSettings != nil {
+		if v.proposerSettings.ProposeConfig != nil {
+			option, ok := v.proposerSettings.ProposeConfig[pubKey]
+			if ok && option.Graffiti != "" {
+				return []byte(option.Graffiti), nil
+			}
+		}
+		if v.proposerSettings.DefaultConfig != nil {
+			if v.proposerSettings.DefaultConfig.Graffiti != "" {
+				return []byte(v.proposerSettings.DefaultConfig.Graffiti), nil
+			}
+		}
+	}
+
+	// When specified, default graffiti from the command line takes the second priority.
 	if len(v.graffiti) != 0 {
 		return bytesutil.PadTo(v.graffiti, 32), nil
 	}
@@ -393,7 +410,7 @@ func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubk
 		return nil, errors.New("graffitiStruct can't be nil")
 	}
 
-	// When specified, individual validator specified graffiti takes the second priority.
+	// When specified, individual validator specified graffiti takes the third priority.
 	idx, err := v.validatorClient.ValidatorIndex(ctx, &ethpb.ValidatorIndexRequest{PublicKey: pubKey[:]})
 	if err != nil {
 		return nil, err
@@ -403,7 +420,7 @@ func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubk
 		return bytesutil.PadTo([]byte(g), 32), nil
 	}
 
-	// When specified, a graffiti from the ordered list in the file take third priority.
+	// When specified, a graffiti from the ordered list in the file take fourth priority.
 	if v.graffitiOrderedIndex < uint64(len(v.graffitiStruct.Ordered)) {
 		graffiti := v.graffitiStruct.Ordered[v.graffitiOrderedIndex]
 		v.graffitiOrderedIndex = v.graffitiOrderedIndex + 1
@@ -414,7 +431,7 @@ func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubk
 		return bytesutil.PadTo([]byte(graffiti), 32), nil
 	}
 
-	// When specified, a graffiti from the random list in the file take fourth priority.
+	// When specified, a graffiti from the random list in the file take Fifth priority.
 	if len(v.graffitiStruct.Random) != 0 {
 		r := rand.NewGenerator()
 		r.Seed(time.Now().Unix())
@@ -429,3 +446,34 @@ func (v *validator) getGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubk
 
 	return []byte{}, nil
 }
+
+func (v *validator) SetGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte, graffiti []byte) error {
+	if v.proposerSettings != nil {
+		ps := v.proposerSettings.Clone()
+		if ps.ProposeConfig != nil {
+			var option *validatorserviceconfig.ProposerOption
+			option, ok := ps.ProposeConfig[pubKey]
+			if ok && option != nil {
+				option.Graffiti = string(graffiti)
+				return v.SetProposerSettings(ctx, ps) // save the proposer settings
+			}
+			return fmt.Errorf("attempted to set graffiti but proposer settings are missing for pubkey:%s", hexutil.Encode(pubKey[:]))
+		}
+	}
+	return errors.New("attempted to set graffiti without proposer settings, graffiti will default to flag options")
+}
+
+func (v *validator) DeleteGraffiti(ctx context.Context, pubKey [fieldparams.BLSPubkeyLength]byte) error {
+	if v.proposerSettings != nil {
+		ps := v.proposerSettings.Clone()
+		if ps.ProposeConfig != nil {
+			option, ok := ps.ProposeConfig[pubKey]
+			if ok && option != nil {
+				option.Graffiti = ""
+				return v.SetProposerSettings(ctx, ps) // save the proposer settings
+			}
+			return fmt.Errorf("graffiti not found in proposer settings for pubkey:%s", hexutil.Encode(pubKey[:]))
+		}
+	}
+	return errors.New("attempted to delete graffiti without proposer settings, graffiti will default to flag options")
+}