Keymanager APIs - get,post,delete graffiti (#13474)

* wip * adding set and delete graffiti * fixing mock * fixing mock linting and putting in scaffolds for unit tests * adding some tests * gaz * adding tests * updating missing unit test * fixing unit test * Update validator/rpc/handlers_keymanager.go Co-authored-by: Sammy Rosso <[email protected]> * Update validator/client/propose.go Co-authored-by: Radosław Kapka <[email protected]> * Update validator/rpc/handlers_keymanager.go Co-authored-by: Radosław Kapka <[email protected]> * Update validator/client/propose.go Co-authored-by: Radosław Kapka <[email protected]> * radek's feedback * fixing tests * using wrapper for graffiti * fixing linting * wip * fixing setting proposer settings * more partial fixes to tests * gaz * fixing tests and setting logic * changing keymanager * fixing tests and making graffiti optional in the proposer file * remove unneeded lines * reverting unintended changes * Update validator/client/propose.go Co-authored-by: Manu NALEPA <[email protected]> * addressing feedback * removing uneeded line * fixing bad merge resolution * gofmt * gaz --------- Co-authored-by: Sammy Rosso <[email protected]> Co-authored-by: Radosław Kapka <[email protected]> Co-authored-by: Manu NALEPA <[email protected]>
prysmaticlabs · Mar 18, 2024 · 7f931bf · 7f931bf
1 parent fda4589
commit 7f931bf
Show file tree

Hide file tree

Showing 19 changed files with 666 additions and 79 deletions.
diff --git a/config/proposer/loader/loader_test.go b/config/proposer/loader/loader_test.go
@@ -49,6 +49,82 @@ func TestProposerSettingsLoader(t *testing.T) {
 		validatorRegistrationEnabled bool
 		skipDBSavedCheck             bool
 	}{
+		{
+			name: "graffiti in db without fee recipient",
+			args: args{
+				proposerSettingsFlagValues: &proposerSettingsFlag{
+					dir:        "",
+					url:        "",
+					defaultfee: "",
+				},
+			},
+			want: func() *proposer.Settings {
+				key1, err := hexutil.Decode("0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a")
+				require.NoError(t, err)
+				return &proposer.Settings{
+					ProposeConfig: map[[fieldparams.BLSPubkeyLength]byte]*proposer.Option{
+						bytesutil.ToBytes48(key1): {
+							GraffitiConfig: &proposer.GraffitiConfig{
+								Graffiti: "specific graffiti",
+							},
+						},
+					},
+				}
+			},
+			withdb: func(db iface.ValidatorDB) error {
+				key1, err := hexutil.Decode("0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a")
+				require.NoError(t, err)
+				settings := &proposer.Settings{
+					ProposeConfig: map[[fieldparams.BLSPubkeyLength]byte]*proposer.Option{
+						bytesutil.ToBytes48(key1): {
+							GraffitiConfig: &proposer.GraffitiConfig{
+								Graffiti: "specific graffiti",
+							},
+						},
+					},
+				}
+				return db.SaveProposerSettings(context.Background(), settings)
+			},
+		},
+		{
+			name: "graffiti from file",
+			args: args{
+				proposerSettingsFlagValues: &proposerSettingsFlag{
+					dir:        "./testdata/good-graffiti-settings.json",
+					url:        "",
+					defaultfee: "",
+				},
+			},
+			want: func() *proposer.Settings {
+				key1, err := hexutil.Decode("0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a")
+				require.NoError(t, err)
+				return &proposer.Settings{
+					ProposeConfig: map[[fieldparams.BLSPubkeyLength]byte]*proposer.Option{
+						bytesutil.ToBytes48(key1): {
+							FeeRecipientConfig: &proposer.FeeRecipientConfig{
+								FeeRecipient: common.HexToAddress("0x50155530FCE8a85ec7055A5F8b2bE214B3DaeFd3"),
+							},
+							GraffitiConfig: &proposer.GraffitiConfig{
+								Graffiti: "some graffiti",
+							},
+							BuilderConfig: &proposer.BuilderConfig{
+								Enabled:  true,
+								GasLimit: validator.Uint64(30000000),
+							},
+						},
+					},
+					DefaultConfig: &proposer.Option{
+						FeeRecipientConfig: &proposer.FeeRecipientConfig{
+							FeeRecipient: common.HexToAddress("0x6e35733c5af9B61374A128e6F85f553aF09ff89A"),
+						},
+						BuilderConfig: &proposer.BuilderConfig{
+							Enabled:  true,
+							GasLimit: validator.Uint64(40000000),
+						},
+					},
+				}
+			},
+		},
 		{
 			name: "db settings override file settings if file default config is missing",
 			args: args{
@@ -875,6 +951,8 @@ func TestProposerSettingsLoader(t *testing.T) {
 				if tt.wantErr != "" {
 					require.ErrorContains(t, tt.wantErr, err)
 					return
+				} else {
+					require.NoError(t, err)
 				}
 				if tt.wantLog != "" {
 					assert.LogsContain(t, hook,

diff --git a/config/proposer/loader/testdata/good-graffiti-settings.json b/config/proposer/loader/testdata/good-graffiti-settings.json
@@ -0,0 +1,19 @@
+{
+  "proposer_config": {
+    "0xa057816155ad77931185101128655c0191bd0214c201ca48ed887f6c4c6adf334070efcd75140eada5ac83a92506dd7a": {
+      "fee_recipient": "0x50155530FCE8a85ec7055A5F8b2bE214B3DaeFd3",
+      "graffiti": "some graffiti",
+      "builder": {
+        "enabled": true,
+        "gas_limit": "30000000"
+      }
+    }
+  },
+  "default_config": {
+    "fee_recipient": "0x6e35733c5af9B61374A128e6F85f553aF09ff89A",
+    "builder": {
+      "enabled": true,
+      "gas_limit": 40000000
+    }
+  }
+}
diff --git a/config/proposer/settings.go b/config/proposer/settings.go
@@ -19,23 +19,22 @@ func SettingFromConsensus(ps *validatorpb.ProposerSettingsPayload) (*Settings, e
 	if ps.ProposerConfig != nil && len(ps.ProposerConfig) != 0 {
 		settings.ProposeConfig = make(map[[fieldparams.BLSPubkeyLength]byte]*Option)
 		for key, optionPayload := range ps.ProposerConfig {
-			if optionPayload.FeeRecipient == "" {
-				continue
-			}
 			decodedKey, err := hexutil.Decode(key)
 			if err != nil {
 				return nil, errors.Wrap(err, fmt.Sprintf("cannot decode public key %s", key))
 			}
 			if len(decodedKey) != fieldparams.BLSPubkeyLength {
 				return nil, fmt.Errorf("%v is not a bls public key", key)
 			}
-			if err := verifyOption(key, optionPayload); err != nil {
-				return nil, err
+			p := &Option{}
+			if optionPayload.Graffiti != nil {
+				p.GraffitiConfig = &GraffitiConfig{*optionPayload.Graffiti}
 			}
-			p := &Option{
-				FeeRecipientConfig: &FeeRecipientConfig{
-					FeeRecipient: common.HexToAddress(optionPayload.FeeRecipient),
-				},
+			if optionPayload.FeeRecipient != "" {
+				if err := verifyOption(key, optionPayload); err != nil {
+					return nil, err
+				}
+				p.FeeRecipientConfig = &FeeRecipientConfig{FeeRecipient: common.HexToAddress(optionPayload.FeeRecipient)}
 			}
 			if optionPayload.Builder != nil {
 				p.BuilderConfig = BuilderConfigFromConsensus(optionPayload.Builder)
@@ -141,10 +140,16 @@ type FeeRecipientConfig struct {
 	FeeRecipient common.Address
 }
 
+// GraffitiConfig is a prysm internal representation to see if the graffiti was set.
+type GraffitiConfig struct {
+	Graffiti string
+}
+
 // Option is a Prysm internal representation of the ProposerOptionPayload on the validator client in bytes format instead of hex.
 type Option struct {
 	FeeRecipientConfig *FeeRecipientConfig
 	BuilderConfig      *BuilderConfig
+	GraffitiConfig     *GraffitiConfig
 }
 
 // Clone creates a deep copy of proposer option
@@ -159,6 +164,9 @@ func (po *Option) Clone() *Option {
 	if po.BuilderConfig != nil {
 		p.BuilderConfig = po.BuilderConfig.Clone()
 	}
+	if po.GraffitiConfig != nil {
+		p.GraffitiConfig = po.GraffitiConfig.Clone()
+	}
 	return p
 }
 
@@ -173,6 +181,9 @@ func (po *Option) ToConsensus() *validatorpb.ProposerOptionPayload {
 	if po.BuilderConfig != nil {
 		p.Builder = po.BuilderConfig.ToConsensus()
 	}
+	if po.GraffitiConfig != nil {
+		p.Graffiti = &po.GraffitiConfig.Graffiti
+	}
 	return p
 }
 
@@ -222,6 +233,14 @@ func (bc *BuilderConfig) Clone() *BuilderConfig {
 	return c
 }
 
+// Clone creates a deep copy of graffiti config
+func (gc *GraffitiConfig) Clone() *GraffitiConfig {
+	if gc == nil {
+		return nil
+	}
+	return &GraffitiConfig{gc.Graffiti}
+}
+
 // ToConsensus converts Builder Config to the protobuf object
 func (bc *BuilderConfig) ToConsensus() *validatorpb.BuilderConfig {
 	if bc == nil {

diff --git a/config/proposer/settings_test.go b/config/proposer/settings_test.go
@@ -76,26 +76,14 @@ func Test_Proposer_Setting_Cloning(t *testing.T) {
 		require.Equal(t, option.FeeRecipientConfig.FeeRecipient.Hex(), potion.FeeRecipient)
 		require.Equal(t, settings.DefaultConfig.FeeRecipientConfig.FeeRecipient.Hex(), payload.DefaultConfig.FeeRecipient)
 		require.Equal(t, settings.DefaultConfig.BuilderConfig.Enabled, payload.DefaultConfig.Builder.Enabled)
-		potion.FeeRecipient = ""
+		potion.FeeRecipient = fee
 		newSettings, err := SettingFromConsensus(payload)
 		require.NoError(t, err)
-
-		// when converting to settings if a fee recipient is empty string then it will be skipped
 		noption, ok := newSettings.ProposeConfig[bytesutil.ToBytes48(key1)]
-		require.Equal(t, false, ok)
-		require.Equal(t, true, noption == nil)
-		require.DeepEqual(t, newSettings.DefaultConfig, settings.DefaultConfig)
-
-		// if fee recipient is set it will not skip
-		potion.FeeRecipient = fee
-		newSettings, err = SettingFromConsensus(payload)
-		require.NoError(t, err)
-		noption, ok = newSettings.ProposeConfig[bytesutil.ToBytes48(key1)]
 		require.Equal(t, true, ok)
 		require.Equal(t, option.FeeRecipientConfig.FeeRecipient.Hex(), noption.FeeRecipientConfig.FeeRecipient.Hex())
 		require.Equal(t, option.BuilderConfig.GasLimit, option.BuilderConfig.GasLimit)
 		require.Equal(t, option.BuilderConfig.Enabled, option.BuilderConfig.Enabled)
-
 	})
 }
 

diff --git a/proto/prysm/v1alpha1/validator-client/BUILD.bazel b/proto/prysm/v1alpha1/validator-client/BUILD.bazel
@@ -29,6 +29,7 @@ proto_library(
         "@com_google_protobuf//:any_proto",
         "@com_google_protobuf//:descriptor_proto",
         "@com_google_protobuf//:empty_proto",
+        "@com_google_protobuf//:wrappers_proto",
         "@com_google_protobuf//:timestamp_proto",
         "@googleapis//google/api:annotations_proto",
     ],
@@ -53,6 +54,7 @@ go_proto_library(
         "@googleapis//google/api:annotations_go_proto",
         "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
         "@io_bazel_rules_go//proto/wkt:empty_go_proto",
+        "@org_golang_google_protobuf//types/known/wrapperspb:go_default_library",
         "@io_bazel_rules_go//proto/wkt:timestamp_go_proto",
         "@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
         "@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
@@ -78,6 +80,7 @@ go_proto_library(
         "@googleapis//google/api:annotations_go_proto",
         "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
         "@io_bazel_rules_go//proto/wkt:empty_go_proto",
+        "@io_bazel_rules_go//proto/wkt:wrappers_go_proto",
         "@io_bazel_rules_go//proto/wkt:timestamp_go_proto",
     ],
 )