debug trace alignment: storage encoding (#10117)

macfarla · web-flow · commit 4790c97bf557 · 2026-03-27T18:13:24.000+10:00
* error field type is String not String[]

* storage key/value encoding: 0x prefix and zero-padding

Signed-off-by: Sally MacFarlane &lt;macfarla.github@gmail.com&gt;

---------

Signed-off-by: Sally MacFarlane &lt;macfarla.github@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Upcoming Release
 
+### Breaking Changes
+- `debug_traceTransaction` and `debug_traceBlockByNumber`: the `error` field in `StructLog` entries is now serialized as a plain string (e.g. `"INVALID_JUMP_DESTINATION"`) instead of an array of strings, aligning with the execution-apis opcode tracer spec. [#10117](https://github.com/besu-eth/besu/pull/10117)
+
 ### Bug fixes
 - Upgrade besu-native libraries version to 1.5.0. This fixes the issue of besu-native/secp256r1 exporting OpenSSL
   symbols in JVM space. [besu-native #308](https://github.com/besu-eth/besu-native/pull/308)
diff --git a/ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLog.java b/ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLog.java
@@ -68,11 +68,28 @@ public StructLog(final TraceFrame traceFrame) {
 
   private static Map<String, String> formatStorage(final Map<UInt256, UInt256> storage) {
     final Map<String, String> formattedStorage = new TreeMap<>();
-    storage.forEach(
-        (key, value) -> formattedStorage.put(toCompactHex(key, false), toCompactHex(value, false)));
+    storage.forEach((key, value) -> formattedStorage.put(toBytes32Hex(key), toBytes32Hex(value)));
     return formattedStorage;
   }
 
+  /**
+   * Encodes bytes as a 0x-prefixed, zero-padded 32-byte hex string (always 66 chars). Used for
+   * memory words and storage keys/values per the execution-apis opcode tracer spec.
+   */
+  public static String toBytes32Hex(final Bytes abytes) {
+    final byte[] raw = abytes.toArrayUnsafe();
+    final StringBuilder sb = new StringBuilder(66);
+    sb.append("0x");
+    for (int i = raw.length; i < 32; i++) {
+      sb.append("00");
+    }
+    for (final byte b : raw) {
+      sb.append(hexChars[(b >> 4) & 0xF]);
+      sb.append(hexChars[b & 0xF]);
+    }
+    return sb.toString();
+  }
+
   @JsonGetter("depth")
   public int depth() {
     return depth;
diff --git a/ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLogWithError.java b/ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLogWithError.java
@@ -14,22 +14,24 @@
  */
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.results;
 
+import org.hyperledger.besu.evm.frame.ExceptionalHaltReason;
 import org.hyperledger.besu.evm.tracing.TraceFrame;
 
 import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonInclude;
 
 public class StructLogWithError extends StructLog {
 
-  private final String[] error;
+  private final String error;
 
   StructLogWithError(final TraceFrame traceFrame) {
     super(traceFrame);
-    error =
-        traceFrame.getExceptionalHaltReason().map(ehr -> new String[] {ehr.name()}).orElse(null);
+    error = traceFrame.getExceptionalHaltReason().map(ExceptionalHaltReason::name).orElse(null);
   }
 
   @JsonGetter("error")
-  public String[] getError() {
+  @JsonInclude(JsonInclude.Include.NON_NULL)
+  public String getError() {
     return error;
   }
 }
diff --git a/ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLogTest.java b/ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/StructLogTest.java
@@ -108,8 +108,10 @@ public void constructorShouldInitializeFields() throws Exception {
     assertThat(structLog.storage())
         .isEqualTo(
             Map.of(
-                "1", "2233333",
-                "2", "4455667"));
+                "0x0000000000000000000000000000000000000000000000000000000000000001",
+                "0x0000000000000000000000000000000000000000000000000000000002233333",
+                "0x0000000000000000000000000000000000000000000000000000000000000002",
+                "0x0000000000000000000000000000000000000000000000000000000004455667"));
     assertThat(structLog.reason()).isEqualTo("0x1");
   }
 
@@ -170,7 +172,7 @@ public void shouldGenerateJsonCorrectly() throws Exception {
             + "\"depth\":1,"
             + "\"stack\":[\"0x0\",\"0x1\",\"0x2\",\"0x3\"],"
             + "\"memory\":[\"0x1\",\"0x2\",\"0x23\",\"0x4\",\"0xe5\",\"0x0\"],"
-            + "\"storage\":{\"1\":\"2233333\",\"2\":\"4455667\"},"
+            + "\"storage\":{\"0x0000000000000000000000000000000000000000000000000000000000000001\":\"0x0000000000000000000000000000000000000000000000000000000002233333\",\"0x0000000000000000000000000000000000000000000000000000000000000002\":\"0x0000000000000000000000000000000000000000000000000000000004455667\"},"
             + "\"reason\":\"0x53756e696665642066756e6473\""
             + "}";
 
diff --git a/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_default.json b/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_default.json
@@ -70,7 +70,7 @@
                 "0x1"
               ],
               "storage":{
-                "1":"1"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"
               }
             },
             {
@@ -83,7 +83,7 @@
 
               ],
               "storage":{
-                "1":"1"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"
               }
             },
             {
@@ -96,7 +96,7 @@
                 "0x60"
               ],
               "storage":{
-                "1":"1"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"
               }
             },
             {
@@ -109,7 +109,7 @@
                 "0x2"
               ],
               "storage":{
-                "1":"1"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"
               }
             },
             {
@@ -123,7 +123,7 @@
                 "0x40"
               ],
               "storage":{
-                "1":"1"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"
               }
             },
             {
@@ -137,8 +137,8 @@
                 "0x2"
               ],
               "storage":{
-                "1":"1",
-                "2":"2"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001",
+                "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000002"
               }
             },
             {
@@ -151,8 +151,8 @@
 
               ],
               "storage":{
-                "1":"1",
-                "2":"2"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001",
+                "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000002"
               }
             }
           ]
@@ -217,7 +217,7 @@
                 "0x1"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -230,7 +230,7 @@
 
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -243,7 +243,7 @@
                 "0x60"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -256,7 +256,7 @@
                 "0x4"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -270,7 +270,7 @@
                 "0x40"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -284,8 +284,8 @@
                 "0x2"
               ],
               "storage":{
-                "1":"3",
-                "2":"4"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003",
+                "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000004"
               }
             },
             {
@@ -298,8 +298,8 @@
 
               ],
               "storage":{
-                "1":"3",
-                "2":"4"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003",
+                "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000004"
               }
             }
           ]
@@ -364,7 +364,7 @@
                 "0x1"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -377,7 +377,7 @@
 
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -390,7 +390,7 @@
                 "0x60"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -403,7 +403,7 @@
                 "0x0"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -417,7 +417,7 @@
                 "0x40"
               ],
               "storage":{
-                "1":"3"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"
               }
             },
             {
@@ -431,7 +431,7 @@
                 "0x1"
               ],
               "storage":{
-                "1":"0"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000000"
               }
             },
             {
@@ -444,7 +444,7 @@
 
               ],
               "storage":{
-                "1":"0"
+                "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000000"
               }
             }
           ]
diff --git a/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_disableMemory.json b/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_disableMemory.json
diff --git a/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_disableStack.json b/ethereum/api/src/test/resources/org/hyperledger/besu/ethereum/api/jsonrpc/debug/trace-block/debug_traceBlock_disableStack.json

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@`
`70`	`70`	`"0x1"`
`71`	`71`	`],`
`72`	`72`	`"storage":{`
`73`		`- "1":"1"`
	`73`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"`
`74`	`74`	`}`
`75`	`75`	`},`
`76`	`76`	`{`
`@@ -83,7 +83,7 @@`
`83`	`83`
`84`	`84`	`],`
`85`	`85`	`"storage":{`
`86`		`- "1":"1"`
	`86`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"`
`87`	`87`	`}`
`88`	`88`	`},`
`89`	`89`	`{`
`@@ -96,7 +96,7 @@`
`96`	`96`	`"0x60"`
`97`	`97`	`],`
`98`	`98`	`"storage":{`
`99`		`- "1":"1"`
	`99`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"`
`100`	`100`	`}`
`101`	`101`	`},`
`102`	`102`	`{`
`@@ -109,7 +109,7 @@`
`109`	`109`	`"0x2"`
`110`	`110`	`],`
`111`	`111`	`"storage":{`
`112`		`- "1":"1"`
	`112`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"`
`113`	`113`	`}`
`114`	`114`	`},`
`115`	`115`	`{`
`@@ -123,7 +123,7 @@`
`123`	`123`	`"0x40"`
`124`	`124`	`],`
`125`	`125`	`"storage":{`
`126`		`- "1":"1"`
	`126`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001"`
`127`	`127`	`}`
`128`	`128`	`},`
`129`	`129`	`{`
`@@ -137,8 +137,8 @@`
`137`	`137`	`"0x2"`
`138`	`138`	`],`
`139`	`139`	`"storage":{`
`140`		`- "1":"1",`
`141`		`- "2":"2"`
	`140`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001",`
	`141`	`+ "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000002"`
`142`	`142`	`}`
`143`	`143`	`},`
`144`	`144`	`{`
`@@ -151,8 +151,8 @@`
`151`	`151`
`152`	`152`	`],`
`153`	`153`	`"storage":{`
`154`		`- "1":"1",`
`155`		`- "2":"2"`
	`154`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000001",`
	`155`	`+ "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000002"`
`156`	`156`	`}`
`157`	`157`	`}`
`158`	`158`	`]`
`@@ -217,7 +217,7 @@`
`217`	`217`	`"0x1"`
`218`	`218`	`],`
`219`	`219`	`"storage":{`
`220`		`- "1":"3"`
	`220`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`221`	`221`	`}`
`222`	`222`	`},`
`223`	`223`	`{`
`@@ -230,7 +230,7 @@`
`230`	`230`
`231`	`231`	`],`
`232`	`232`	`"storage":{`
`233`		`- "1":"3"`
	`233`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`234`	`234`	`}`
`235`	`235`	`},`
`236`	`236`	`{`
`@@ -243,7 +243,7 @@`
`243`	`243`	`"0x60"`
`244`	`244`	`],`
`245`	`245`	`"storage":{`
`246`		`- "1":"3"`
	`246`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`247`	`247`	`}`
`248`	`248`	`},`
`249`	`249`	`{`
`@@ -256,7 +256,7 @@`
`256`	`256`	`"0x4"`
`257`	`257`	`],`
`258`	`258`	`"storage":{`
`259`		`- "1":"3"`
	`259`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`260`	`260`	`}`
`261`	`261`	`},`
`262`	`262`	`{`
`@@ -270,7 +270,7 @@`
`270`	`270`	`"0x40"`
`271`	`271`	`],`
`272`	`272`	`"storage":{`
`273`		`- "1":"3"`
	`273`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`274`	`274`	`}`
`275`	`275`	`},`
`276`	`276`	`{`
`@@ -284,8 +284,8 @@`
`284`	`284`	`"0x2"`
`285`	`285`	`],`
`286`	`286`	`"storage":{`
`287`		`- "1":"3",`
`288`		`- "2":"4"`
	`287`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003",`
	`288`	`+ "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000004"`
`289`	`289`	`}`
`290`	`290`	`},`
`291`	`291`	`{`
`@@ -298,8 +298,8 @@`
`298`	`298`
`299`	`299`	`],`
`300`	`300`	`"storage":{`
`301`		`- "1":"3",`
`302`		`- "2":"4"`
	`301`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003",`
	`302`	`+ "0x0000000000000000000000000000000000000000000000000000000000000002":"0x0000000000000000000000000000000000000000000000000000000000000004"`
`303`	`303`	`}`
`304`	`304`	`}`
`305`	`305`	`]`
`@@ -364,7 +364,7 @@`
`364`	`364`	`"0x1"`
`365`	`365`	`],`
`366`	`366`	`"storage":{`
`367`		`- "1":"3"`
	`367`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`368`	`368`	`}`
`369`	`369`	`},`
`370`	`370`	`{`
`@@ -377,7 +377,7 @@`
`377`	`377`
`378`	`378`	`],`
`379`	`379`	`"storage":{`
`380`		`- "1":"3"`
	`380`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`381`	`381`	`}`
`382`	`382`	`},`
`383`	`383`	`{`
`@@ -390,7 +390,7 @@`
`390`	`390`	`"0x60"`
`391`	`391`	`],`
`392`	`392`	`"storage":{`
`393`		`- "1":"3"`
	`393`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`394`	`394`	`}`
`395`	`395`	`},`
`396`	`396`	`{`
`@@ -403,7 +403,7 @@`
`403`	`403`	`"0x0"`
`404`	`404`	`],`
`405`	`405`	`"storage":{`
`406`		`- "1":"3"`
	`406`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`407`	`407`	`}`
`408`	`408`	`},`
`409`	`409`	`{`
`@@ -417,7 +417,7 @@`
`417`	`417`	`"0x40"`
`418`	`418`	`],`
`419`	`419`	`"storage":{`
`420`		`- "1":"3"`
	`420`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000003"`
`421`	`421`	`}`
`422`	`422`	`},`
`423`	`423`	`{`
`@@ -431,7 +431,7 @@`
`431`	`431`	`"0x1"`
`432`	`432`	`],`
`433`	`433`	`"storage":{`
`434`		`- "1":"0"`
	`434`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000000"`
`435`	`435`	`}`
`436`	`436`	`},`
`437`	`437`	`{`
`@@ -444,7 +444,7 @@`
`444`	`444`
`445`	`445`	`],`
`446`	`446`	`"storage":{`
`447`		`- "1":"0"`
	`447`	`+ "0x0000000000000000000000000000000000000000000000000000000000000001":"0x0000000000000000000000000000000000000000000000000000000000000000"`
`448`	`448`	`}`
`449`	`449`	`}`
`450`	`450`	`]`