Graffiti hex support

validator/graffiti/BUILD.bazel

@@ -3,13 +3,17 @@ load("@prysm//tools/go:def.bzl", "go_library")
 
 go_library(
     name = "go_default_library",
-    srcs = ["parse_graffiti.go"],
+    srcs = [
+        "log.go",
+        "parse_graffiti.go"
+    ],
     importpath = "github.com/prysmaticlabs/prysm/validator/graffiti",
     visibility = ["//validator:__subpackages__"],
     deps = [
         "//shared/hashutil:go_default_library",
         "@com_github_prysmaticlabs_eth2_types//:go_default_library",
         "@in_gopkg_yaml_v2//:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
     ],
 )
 
@@ -21,5 +25,6 @@ go_test(
         "//shared/hashutil:go_default_library",
         "//shared/testutil/require:go_default_library",
         "@com_github_prysmaticlabs_eth2_types//:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
     ],
 )

validator/graffiti/log.go

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

validator/graffiti/parse_graffiti.go

@@ -1,7 +1,9 @@
 package graffiti
 
 import (
+	"encoding/hex"
 	"io/ioutil"
+	"strings"
 
 	types "github.com/prysmaticlabs/eth2-types"
 	"github.com/prysmaticlabs/prysm/shared/hashutil"
@@ -19,6 +21,15 @@ type Graffiti struct {
 
 // ParseGraffitiFile parses the graffiti file and returns the graffiti struct.
 func ParseGraffitiFile(f string) (*Graffiti, error) {
+	// helper function to avoid coding this twice while parsing the Ordered and Random fields of the graffiti struct
+	parseGraffitiStrings := func(input []string) []string {
+		output := make([]string, len(input))
+		for _, i := range input {
+			output = append(output, ParseHexGraffiti(i))
+		}
+		return output
+	}
+
 	yamlFile, err := ioutil.ReadFile(f)
 	if err != nil {
 		return nil, err
@@ -27,6 +38,47 @@ func ParseGraffitiFile(f string) (*Graffiti, error) {
 	if err := yaml.Unmarshal(yamlFile, g); err != nil {
 		return nil, err
 	}
+
+	specific := make(map[types.ValidatorIndex]string, len(g.Specific))
+	for i, o := range g.Specific {
+		specific[types.ValidatorIndex(i)] = ParseHexGraffiti(o)
+	}
+
+	g.Specific = specific
+	g.Default = ParseHexGraffiti(g.Default)
+	g.Ordered = parseGraffitiStrings(g.Ordered)
+	g.Random = parseGraffitiStrings(g.Random)
 	g.Hash = hashutil.Hash(yamlFile)
 	return g, nil
 }
+
+// ParseHexGraffiti checks if a graffiti input is being represented in hex and converts it to ASCII if so
+func ParseHexGraffiti(rawGraffiti string) string {
+	splitGraffiti := strings.SplitN(rawGraffiti, ":", 2)
+	if strings.ToLower(splitGraffiti[0]) == "hex" {
+		target := splitGraffiti[1]
+		if target == "" {
+			log.Debug("Blank hex tag to be interpreted as itself")
+			return rawGraffiti
+		}
+
+		if len(target) > 3 {
+			if target[:2] == "0x" {
+				target = target[2:]
+			}
+		}
+
+		if target == "" {
+			log.Debug("Nothing after 0x prefix, hex tag to be interpreted as itself")
+			return rawGraffiti
+		}
+
+		graffiti, err := hex.DecodeString(target)
+		if err != nil {
+			log.WithError(err).Debug("Error while decoding hex string")
+			return rawGraffiti
+		}
+		return string(graffiti)
+	}
+	return rawGraffiti
+}

validator/graffiti/parse_graffiti_test.go

@@ -8,6 +8,7 @@ import (
 
 	types "github.com/prysmaticlabs/eth2-types"
 	"github.com/prysmaticlabs/prysm/shared/hashutil"
+	"github.com/prysmaticlabs/prysm/shared/testutil/assert"
 	"github.com/prysmaticlabs/prysm/shared/testutil/require"
 )
 
@@ -123,7 +124,7 @@ ordered:
   - "Mr F was here"
 
 specific:
-  1234: Yolo
+  1234: "hex:796f6c6f"
   555: "What's up"
   703727: Meow`)
 
@@ -157,3 +158,64 @@ specific:
 	}
 	require.DeepEqual(t, wanted, got)
 }
+
+func TestParseHexGraffiti(t *testing.T) {
+	tests := []struct {
+		name  string
+		want  string
+		input string
+	}{
+		{
+			name:  "standard",
+			want:  "hola mundo!",
+			input: "hola mundo!",
+		},
+		{
+			name:  "standard with hex tag",
+			want:  "hola mundo!",
+			input: "hex:686f6c61206d756e646f21",
+		},
+		{
+			name:  "irregularly cased hex tag",
+			want:  "hola mundo!",
+			input: "HEX:686f6c61206d756e646f21",
+		},
+		{
+			name:  "hex tag without accompanying data",
+			want:  "hex:",
+			input: "hex:",
+		},
+		{
+			name:  "Passing non-hex data with hex tag",
+			want:  "hex:hola mundo!",
+			input: "hex:hola mundo!",
+		},
+		{
+			name:  "unmarked hex input",
+			want:  "0x686f6c61206d756e646f21",
+			input: "0x686f6c61206d756e646f21",
+		},
+		{
+			name:  "Properly tagged hex data with 0x prefix",
+			want:  "hola mundo!",
+			input: "hex:0x686f6c61206d756e646f21",
+		},
+		{
+			name:  "hex tag with 0x prefix and no other data",
+			want:  "hex:0x",
+			input: "hex:0x",
+		},
+		{
+			name:  "hex tag with 0x prefix and invalid hex data",
+			want:  "hex:0xhola mundo",
+			input: "hex:0xhola mundo",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			out := ParseHexGraffiti(tt.input)
+			assert.Equal(t, out, tt.want)
+		})
+	}
+}

validator/node/node.go

@@ -409,7 +409,7 @@ func (c *ValidatorClient) registerValidatorService(
 		LogValidatorBalances:       logValidatorBalances,
 		EmitAccountMetrics:         emitAccountMetrics,
 		CertFlag:                   cert,
-		GraffitiFlag:               graffiti,
+		GraffitiFlag:               g.ParseHexGraffiti(graffiti),
 		GrpcMaxCallRecvMsgSizeFlag: maxCallRecvMsgSize,
 		GrpcRetriesFlag:            grpcRetries,
 		GrpcRetryDelay:             grpcRetryDelay,
@@ -421,10 +421,10 @@ func (c *ValidatorClient) registerValidatorService(
 		GraffitiStruct:             gStruct,
 		LogDutyCountDown:           c.cliCtx.Bool(flags.EnableDutyCountDown.Name),
 	})
-
 	if err != nil {
 		return errors.Wrap(err, "could not initialize validator service")
 	}
+
 	return c.services.RegisterService(v)
 }
 func (c *ValidatorClient) registerSlasherService() error {