Backward compatible trielog format for shomei (#62)

* do not export zkTracer comparison metadata when exporting to shomei, so trielogs are backward compatible with older shomei instances
* bump minor version to reflect trielog format difference

Signed-off-by: garyschulte <[email protected]>

Author: garyschulte

gradle.properties

@@ -1,3 +1,3 @@
-releaseVersion=0.7.8-SNAPSHOT
-besuVersion=25.10.0-RC1-linea2
-arithmetizationVersion=beta-v4.0-rc18
+releaseVersion=0.8.0-SNAPSHOT
+besuVersion=25.10.0-linea3
+arithmetizationVersion=beta-v4.0-rc20

src/main/java/net/consensys/shomei/rpc/methods/ShomeiGetTrieLog.java

@@ -45,7 +45,7 @@ public Object execute(PluginRpcRequest rpcRequest) {
     return ctx.getTrieLogService()
         .getTrieLogProvider()
         .getTrieLogLayer(blockNumber)
-        .map(t -> Bytes.wrap(ctx.getZkTrieLogFactory().serialize(t)).toHexString())
+        .map(t -> Bytes.wrap(ctx.getZkTrieLogFactory().serializeWithoutMetadata(t)).toHexString())
         .orElse("");
   }
 }

src/main/java/net/consensys/shomei/rpc/response/TrieLogJson.java

@@ -23,6 +23,10 @@
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.plugin.services.trielogs.TrieLogProvider;
 
+/**
+ * JSON response object for TrieLog data. Note: This class serializes TrieLogs WITHOUT zktracer
+ * comparison feature metadata.
+ */
 public class TrieLogJson {
 
   @JsonProperty("blockHash")
@@ -39,7 +43,8 @@ public TrieLogJson(
       final TrieLogProvider.TrieLogRangeTuple tuple, final ZkTrieLogFactory trieLogFactory) {
     this.blockHash = tuple.blockHash();
     this.blockNumber = tuple.blockNumber();
-    this.trieLog = Bytes.wrap(trieLogFactory.serialize(tuple.trieLog())).toHexString();
+    this.trieLog =
+        Bytes.wrap(trieLogFactory.serializeWithoutMetadata(tuple.trieLog())).toHexString();
   }
 
   public TrieLogJson(Hash blockHash, long blockNumber, String trieLog) {

src/main/java/net/consensys/shomei/trielog/ZkTrieLogFactory.java

@@ -266,11 +266,18 @@ static Map<Address, Map<StorageSlotKey, LogTuple<UInt256>>> decorateStorage(
   @Override
   public byte[] serialize(final TrieLog layer) {
     final BytesValueRLPOutput rlpLog = new BytesValueRLPOutput();
-    writeTo(layer, rlpLog);
+    writeTo(layer, rlpLog, true);
     return rlpLog.encoded().toArrayUnsafe();
   }
 
-  public static void writeTo(final TrieLog layer, final RLPOutput output) {
+  public byte[] serializeWithoutMetadata(final TrieLog layer) {
+    final BytesValueRLPOutput rlpLog = new BytesValueRLPOutput();
+    writeTo(layer, rlpLog, false);
+    return rlpLog.encoded().toArrayUnsafe();
+  }
+
+  private static void writeTo(
+      final TrieLog layer, final RLPOutput output, final boolean includeMetadata) {
     layer.freeze();
 
     final Set<Address> addresses = new TreeSet<>();
@@ -328,7 +335,7 @@ public static void writeTo(final TrieLog layer, final RLPOutput output) {
     }
 
     // optionally write zkTraceComparisonFeature
-    if (layer instanceof PluginTrieLogLayer pluginLayer) {
+    if (includeMetadata && layer instanceof PluginTrieLogLayer pluginLayer) {
       pluginLayer.zkTraceComparisonFeature().ifPresent(output::writeInt);
     }
     output.endList(); // container
@@ -361,7 +368,7 @@ public static PluginTrieLogLayer readFrom(final RLPInput input) {
             .filter(isPresent -> isPresent)
             .map(__ -> input.readLongScalar());
 
-    while (!input.isEndOfCurrentList()) {
+    while (!input.isEndOfCurrentList() && input.nextIsList()) {
       input.enterList();
       final Address address = Address.readFrom(input);