github/prysm
1
1
Fork 0
mirror of https://github.com/OffchainLabs/prysm.git synced 2026-01-10 16:08:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

add space for readability

Browse Source
This commit is contained in:
satushh
2025-12-19 12:47:10 +05:30
parent 433054d82a
commit fcc1795497
2 changed files with 61 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
beacon-chain/execution/graffiti_info.go
View File

@@ -34,14 +34,14 @@ func (g *GraffitiInfo) UpdateFromEngine(code, commit string) {
// GenerateGraffiti generates graffiti using the flexible standard
// with the provided user graffiti from the validator client request.
// It packs as much client info as space allows after user graffiti.
// It packs as much client info as space allows, followed by a space and user graffiti.
//
// Available Space | Format
// ≥12 bytes | EL(2)+commit(4)+CL(2)+commit(4)+user
// 8-11 bytes | EL(2)+commit(2)+CL(2)+commit(2)+user
// 4-7 bytes | EL(2)+CL(2)+user
// 2-3 bytes | EL(2)+user
// <2 bytes | user only
// Available Space | Format (space added before user graffiti if present)
// ≥13 bytes | EL(2)+commit(4)+CL(2)+commit(4)+space+user e.g. "GEabcdPRxxxx Sushi"
// 9-12 bytes | EL(2)+commit(2)+CL(2)+commit(2)+space+user e.g. "GEabPRxx Sushi"
// 5-8 bytes | EL(2)+CL(2)+space+user e.g. "GEPR Sushi"
// 3-4 bytes | code(2)+space+user e.g. "GE Sushi" or "PR Sushi"
// <3 bytes | user only e.g. "Sushi"
func (g *GraffitiInfo) GenerateGraffiti(userGraffiti []byte) [32]byte {
g.mu.RLock()
defer g.mu.RUnlock()
@@ -53,8 +53,11 @@ func (g *GraffitiInfo) GenerateGraffiti(userGraffiti []byte) [32]byte {
userStr = userStr[:len(userStr)-1]
}
userLen := len(userStr)
available := 32 - userLen
// Prepend space to user graffiti for readability
if len(userStr) > 0 {
userStr = " " + userStr
}
available := 32 - len(userStr)
clCommit := version.GetCommitPrefix()
clCommit4 := truncateCommit(clCommit, 4)
@@ -70,24 +73,25 @@ func (g *GraffitiInfo) GenerateGraffiti(userGraffiti []byte) [32]byte {
var graffiti string
switch {
case available >= 12:
// Full: EL(2)+commit(4)+CL(2)+commit(4)+user
// Full: EL(2)+commit(4)+CL(2)+commit(4)+space+user
graffiti = g.elCode + elCommit4 + CLCode + clCommit4 + userStr
case available >= 8:
// Reduced commits: EL(2)+commit(2)+CL(2)+commit(2)+user
// Reduced commits: EL(2)+commit(2)+CL(2)+commit(2)+space+user
graffiti = g.elCode + elCommit2 + CLCode + clCommit2 + userStr
case available >= 4:
// Codes only: EL(2)+CL(2)+user
// Codes only: EL(2)+CL(2)+space+user
graffiti = g.elCode + CLCode + userStr
case available >= 2:
// EL code only (or CL code if no EL): code(2)+user
// EL code only (or CL code if no EL): code(2)+space+user
if g.elCode != "" {
graffiti = g.elCode + userStr
} else {
graffiti = CLCode + userStr
}
default:
// User graffiti only
graffiti = userStr
// User graffiti only (no space needed since no version prefix)
// Remove the prepended space since we can't fit any version info
graffiti = userStr[1:]
}
copy(result[:], graffiti)

70
beacon-chain/execution/graffiti_info_test.go
View File

@@ -15,42 +15,49 @@ func TestGraffitiInfo_GenerateGraffiti(t *testing.T) {
wantPrefix string
wantSuffix string // for checking user graffiti is appended
}{
// No EL info cases
// No EL info cases (CL info "PR" + commit still included when space allows)
{
name: "No EL - empty user graffiti",
elCode: "",
elCommit: "",
userGraffiti: []byte{},
wantPrefix: "PR", // CL code still included
wantPrefix: "PR", // CL code, no trailing space since no user graffiti
},
{
name: "No EL - short user graffiti",
elCode: "",
elCommit: "",
userGraffiti: []byte("my validator"),
wantPrefix: "PR",
wantSuffix: "my validator",
wantPrefix: "PR", // CL code + commit + space + user
wantSuffix: " my validator", // space before user graffiti
},
{
name: "No EL - 29 char user graffiti (3 bytes available)",
name: "No EL - 28 char user graffiti (3 bytes available after space)",
elCode: "",
elCommit: "",
userGraffiti: []byte("12345678901234567890123456789"),
wantPrefix: "PR", // CL code fits in 2 bytes
userGraffiti: []byte("1234567890123456789012345678"), // 28 chars
wantPrefix: "PR ", // CL code + space (3 bytes)
},
{
name: "No EL - 30 char user graffiti (2 bytes available)",
name: "No EL - 29 char user graffiti (2 bytes available after space)",
elCode: "",
elCommit: "",
userGraffiti: []byte("123456789012345678901234567890"),
wantPrefix: "PR", // CL code exactly fits
userGraffiti: []byte("12345678901234567890123456789"), // 29 chars, 2 bytes available = fits PR
wantPrefix: "PR ", // CL code (2 bytes) + space fits exactly
},
{
name: "No EL - 31 char user graffiti (1 byte available)",
name: "No EL - 30 char user graffiti (1 byte available after space)",
elCode: "",
elCommit: "",
userGraffiti: []byte("123456789012345678901234567890"), // 30 chars, 1 byte available = not enough for code+space
wantPrefix: "123456789012345678901234567890", // User only
},
{
name: "No EL - 31 char user graffiti (0 bytes available after space)",
elCode: "",
elCommit: "",
userGraffiti: []byte("1234567890123456789012345678901"),
wantPrefix: "1234567890123456789012345678901", // No space for CL code
wantPrefix: "1234567890123456789012345678901", // User only
},
// With EL info - flexible standard format cases
{
@@ -58,43 +65,50 @@ func TestGraffitiInfo_GenerateGraffiti(t *testing.T) {
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte{},
wantPrefix: "GEabcdPR", // EL(2)+commit(4)+CL(2)+commit(4)
wantPrefix: "GEabcdPR", // No trailing space when no user graffiti
},
{
name: "With EL - full format (short user graffiti)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("Bob"),
wantPrefix: "GEabcdPR",
wantSuffix: "Bob",
wantPrefix: "GEabcdPR", // EL(2)+commit(4)+CL(2)+commit(4)
wantSuffix: " Bob", // space before user graffiti
},
{
name: "With EL - full format (20 char user, 12 bytes available)",
name: "With EL - full format (18 char user, 13 bytes available after space)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("12345678901234567890"),
wantPrefix: "GEabcdPR",
userGraffiti: []byte("123456789012345678"), // 18 chars, need 19 with space, leaves 13
wantPrefix: "GEabcdPR", // Full format fits (12 bytes)
},
{
name: "With EL - reduced commits (24 char user, 8 bytes available)",
name: "With EL - reduced commits (22 char user, 9 bytes available after space)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("123456789012345678901234"),
wantPrefix: "GEabPR", // EL(2)+commit(2)+CL(2)+commit(2)
userGraffiti: []byte("1234567890123456789012"), // 22 chars, need 23 with space, leaves 9
wantPrefix: "GEabPR", // Reduced format (8 bytes)
},
{
name: "With EL - codes only (28 char user, 4 bytes available)",
name: "With EL - codes only (26 char user, 5 bytes available after space)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("1234567890123456789012345678"),
wantPrefix: "GEPR", // EL(2)+CL(2)
userGraffiti: []byte("12345678901234567890123456"), // 26 chars, need 27 with space, leaves 5
wantPrefix: "GEPR ", // Codes only (4 bytes) + space
},
{
name: "With EL - EL code only (30 char user, 2 bytes available)",
name: "With EL - EL code only (28 char user, 3 bytes available after space)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("123456789012345678901234567890"),
wantPrefix: "GE", // EL(2) only
userGraffiti: []byte("1234567890123456789012345678"), // 28 chars, need 29 with space, leaves 3
wantPrefix: "GE ", // EL code (2 bytes) + space
},
{
name: "With EL - user only (30 char user, 1 byte available after space)",
elCode: "GE",
elCommit: "abcd1234",
userGraffiti: []byte("123456789012345678901234567890"), // 30 chars, need 31 with space, leaves 1
wantPrefix: "123456789012345678901234567890", // Not enough for code+space, user only
},
{
name: "With EL - user only (32 char user, 0 bytes available)",
@@ -110,7 +124,7 @@ func TestGraffitiInfo_GenerateGraffiti(t *testing.T) {
elCommit: "abcd1234",
userGraffiti: append([]byte("test"), 0, 0, 0),
wantPrefix: "GEabcdPR",
wantSuffix: "test",
wantSuffix: " test",
},
}