feat(rpc-params): rename RPC endpoints and modify their params representations (#770)

Resolves: #769 
Signed-off-by: Tsvetan Dimitrov <[email protected]>

Author: powerslider

tracer/arithmetization/build.gradle

@@ -58,7 +58,6 @@ dependencies {
   implementation 'io.tmio:tuweni-bytes'
   implementation 'io.tmio:tuweni-units'
   implementation 'io.tmio:tuweni-toml'
-
   implementation 'org.bouncycastle:bcprov-jdk18on'
   implementation 'org.hibernate.validator:hibernate-validator'
 

tracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/CountersEndpointServicePlugin.java

@@ -26,7 +26,7 @@
  *
  * <p>The CountersEndpointServicePlugin registers an RPC endpoint named
  * 'getTracesCountersByBlockNumberV0' under the 'rollup' namespace. When this endpoint is called,
- * returns trace counters based on the provided request parameters. See {@link GenerateCountersV0}
+ * returns trace counters based on the provided request parameters. See {@link GenerateCountersV2}
  */
 @AutoService(BesuPlugin.class)
 public class CountersEndpointServicePlugin extends AbstractLineaSharedOptionsPlugin {
@@ -54,7 +54,7 @@ public void register(final BesuContext context) {
   @Override
   public void beforeExternalServices() {
     super.beforeExternalServices();
-    GenerateCountersV0 method = new GenerateCountersV0(besuContext);
+    GenerateCountersV2 method = new GenerateCountersV2(besuContext);
     createAndRegister(method, rpcEndpointService);
   }
 
@@ -65,7 +65,7 @@ public void beforeExternalServices() {
    * @param rpcEndpointService the RpcEndpointService to be registered.
    */
   private void createAndRegister(
-      final GenerateCountersV0 method, final RpcEndpointService rpcEndpointService) {
+      final GenerateCountersV2 method, final RpcEndpointService rpcEndpointService) {
     rpcEndpointService.registerRPCEndpoint(
         method.getNamespace(), method.getName(), method::execute);
   }

tracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/CountersRequestParams.java

@@ -20,34 +20,14 @@
 import net.consensys.linea.zktracer.ZkTracer;
 
 /** Holds needed parameters for sending an execution trace generation request. */
-@SuppressWarnings("unused")
-public record CountersRequestParams(long blockNumber, String runtimeVersion) {
-  private static final int EXPECTED_PARAMS_SIZE = 2;
-
-  /**
-   * Parses a list of params to a {@link CountersRequestParams} object.
-   *
-   * @param params an array of parameters.
-   * @return a parsed {@link CountersRequestParams} object..
-   */
-  public static CountersRequestParams createTraceParams(final Object[] params) {
-    // validate params size
-    if (params.length != EXPECTED_PARAMS_SIZE) {
-      throw new InvalidParameterException(
-          String.format("Expected %d parameters but got %d", EXPECTED_PARAMS_SIZE, params.length));
-    }
-
-    long blockNumber = Long.parseLong(params[0].toString());
-    String version = params[1].toString();
-
-    if (!version.equals(getTracerRuntime())) {
+public record CountersRequestParams(long blockNumber, String expectedTracesEngineVersion) {
+  public void validateTracerVersion() {
+    if (!expectedTracesEngineVersion.equals(getTracerRuntime())) {
       throw new InvalidParameterException(
           String.format(
               "INVALID_TRACES_VERSION: Runtime version is %s, requesting version %s",
-              getTracerRuntime(), version));
+              getTracerRuntime(), expectedTracesEngineVersion));
     }
-
-    return new CountersRequestParams(blockNumber, version);
   }
 
   private static String getTracerRuntime() {

…nea/rpc/counters/GenerateCountersV0.java …nea/rpc/counters/GenerateCountersV2.javatracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/GenerateCountersV0.java renamed to tracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/GenerateCountersV2.java tracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/GenerateCountersV0.java renamed to tracer/arithmetization/src/main/java/net/consensys/linea/rpc/counters/GenerateCountersV2.java

@@ -15,13 +15,16 @@
 
 package net.consensys.linea.rpc.counters;
 
+import java.security.InvalidParameterException;
 import java.util.Map;
 
 import com.google.common.base.Stopwatch;
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import net.consensys.linea.zktracer.ZkTracer;
+import net.consensys.linea.zktracer.json.JsonConverter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
 import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.services.TraceService;
@@ -30,29 +33,22 @@
 
 /** This class is used to generate trace counters. */
 @Slf4j
-public class GenerateCountersV0 {
+@RequiredArgsConstructor
+public class GenerateCountersV2 {
+  private static final JsonConverter CONVERTER = JsonConverter.builder().build();
   private static final int CACHE_SIZE = 10_000;
-  static final Cache<Long, Map<String, Integer>> cache =
+  private static final Cache<Long, Map<String, Integer>> CACHE =
       CacheBuilder.newBuilder().maximumSize(CACHE_SIZE).build();
 
   private final BesuContext besuContext;
   private TraceService traceService;
 
-  /**
-   * Constructor for RollupGenerateCountersV0.
-   *
-   * @param besuContext the BesuContext to be used.
-   */
-  public GenerateCountersV0(final BesuContext besuContext) {
-    this.besuContext = besuContext;
-  }
-
   public String getNamespace() {
     return "rollup";
   }
 
   public String getName() {
-    return "getTracesCountersByBlockNumberV0";
+    return "getBlockTracesCountersV2";
   }
 
   /**
@@ -72,15 +68,28 @@ public Counters execute(final PluginRpcRequest request) {
 
     try {
       final Stopwatch sw = Stopwatch.createStarted();
+
+      final Object[] rawParams = request.getParams();
+
+      // validate params size
+      if (rawParams.length != 1) {
+        throw new InvalidParameterException(
+            "Expected a single params object in the params array but got %d"
+                .formatted(rawParams.length));
+      }
+
       final CountersRequestParams params =
-          CountersRequestParams.createTraceParams(request.getParams());
+          CONVERTER.fromJson(CONVERTER.toJson(rawParams[0]), CountersRequestParams.class);
+
+      params.validateTracerVersion();
+
       final long requestedBlockNumber = params.blockNumber();
 
       final Counters r =
           new Counters(
-              params.runtimeVersion(),
+              params.expectedTracesEngineVersion(),
               requestedBlockNumber,
-              cache
+              CACHE
                   .asMap()
                   .computeIfAbsent(
                       requestedBlockNumber,
@@ -95,7 +104,7 @@ public Counters execute(final PluginRpcRequest request) {
 
                         return tracer.getModulesLineCount();
                       }));
-      log.info("counters for {} returned in {}", requestedBlockNumber, sw);
+      log.info("Line count for {} returned in {}", requestedBlockNumber, sw);
       return r;
     } catch (Exception ex) {
       throw new PluginRpcEndpointException(RpcErrorType.PLUGIN_INTERNAL_ERROR, ex.getMessage());

…eneration/GenerateConflatedTracesV0.java …eneration/GenerateConflatedTracesV2.javatracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/GenerateConflatedTracesV0.java renamed to tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/GenerateConflatedTracesV2.java tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/GenerateConflatedTracesV0.java renamed to tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/GenerateConflatedTracesV2.java

@@ -18,10 +18,13 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.security.InvalidParameterException;
 
 import com.google.common.base.Stopwatch;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import net.consensys.linea.zktracer.ZkTracer;
+import net.consensys.linea.zktracer.json.JsonConverter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
 import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.services.BesuConfiguration;
@@ -36,21 +39,20 @@
  * based on the provided request parameters and writes them to a file.
  */
 @Slf4j
-public class GenerateConflatedTracesV0 {
+@RequiredArgsConstructor
+public class GenerateConflatedTracesV2 {
+  private static final JsonConverter CONVERTER = JsonConverter.builder().build();
+
   private final BesuContext besuContext;
   private Path tracesPath;
   private TraceService traceService;
 
-  public GenerateConflatedTracesV0(final BesuContext besuContext) {
-    this.besuContext = besuContext;
-  }
-
   public String getNamespace() {
     return "rollup";
   }
 
   public String getName() {
-    return "generateConflatedTracesToFileV0";
+    return "generateConflatedTracesToFileV2";
   }
 
   /**
@@ -68,11 +70,23 @@ public TraceFile execute(final PluginRpcRequest request) {
       this.tracesPath = getTracesPath();
     }
 
+    final Object[] rawParams = request.getParams();
+
+    // validate params size
+    if (rawParams.length != 1) {
+      throw new InvalidParameterException(
+          "Expected a single params object in the params array but got %d"
+              .formatted(rawParams.length));
+    }
+
     try {
-      TraceRequestParams params = TraceRequestParams.createTraceParams(request.getParams());
+      TraceRequestParams params =
+          CONVERTER.fromJson(CONVERTER.toJson(rawParams[0]), TraceRequestParams.class);
+
+      params.validateTracerVersion();
 
-      final long fromBlock = params.fromBlock();
-      final long toBlock = params.toBlock();
+      final long fromBlock = params.startBlockNumber();
+      final long toBlock = params.endBlockNumber();
       final ZkTracer tracer = new ZkTracer();
       traceService.trace(
           fromBlock,
@@ -82,9 +96,9 @@ public TraceFile execute(final PluginRpcRequest request) {
           tracer);
       log.info("[TRACING] trace for {}-{} computed in {}", fromBlock, toBlock, sw);
       sw.reset().start();
-      final String path = writeTraceToFile(tracer, params.runtimeVersion());
+      final String path = writeTraceToFile(tracer, params.expectedTracesEngineVersion());
       log.info("[TRACING] trace for {}-{} serialized to {} in {}", path, toBlock, fromBlock, sw);
-      return new TraceFile(params.runtimeVersion(), path);
+      return new TraceFile(params.expectedTracesEngineVersion(), path);
     } catch (Exception ex) {
       throw new PluginRpcEndpointException(RpcErrorType.PLUGIN_INTERNAL_ERROR, ex.getMessage());
     }

tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/TraceFile.java

@@ -20,4 +20,4 @@
 /** FileTrace represents an execution trace. */
 public record TraceFile(
     @JsonProperty("tracesEngineVersion") String tracesEngineVersion,
-    @JsonProperty("traceFileName") String traceFileName) {}
+    @JsonProperty("conflatedTracesFileName") String conflatedTracesFileName) {}

tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/TraceRequestParams.java

@@ -20,35 +20,16 @@
 import net.consensys.linea.zktracer.ZkTracer;
 
 /** Holds needed parameters for sending an execution trace generation request. */
-@SuppressWarnings("unused")
-public record TraceRequestParams(long fromBlock, long toBlock, String runtimeVersion) {
-  private static final int EXPECTED_PARAMS_SIZE = 3;
+public record TraceRequestParams(
+    long startBlockNumber, long endBlockNumber, String expectedTracesEngineVersion) {
 
-  /**
-   * Parses a list of params to a {@link TraceRequestParams} object.
-   *
-   * @param params an array of parameters.
-   * @return a parsed {@link TraceRequestParams} object..
-   */
-  public static TraceRequestParams createTraceParams(final Object[] params) {
-    // validate params size
-    if (params.length != EXPECTED_PARAMS_SIZE) {
-      throw new InvalidParameterException(
-          String.format("Expected %d parameters but got %d", EXPECTED_PARAMS_SIZE, params.length));
-    }
-
-    long fromBlock = Long.parseLong(params[0].toString());
-    long toBlock = Long.parseLong(params[1].toString());
-    String version = params[2].toString();
-
-    if (!version.equals(getTracerRuntime())) {
+  public void validateTracerVersion() {
+    if (!expectedTracesEngineVersion.equals(getTracerRuntime())) {
       throw new InvalidParameterException(
           String.format(
               "INVALID_TRACES_VERSION: Runtime version is %s, requesting version %s",
-              getTracerRuntime(), version));
+              getTracerRuntime(), expectedTracesEngineVersion));
     }
-
-    return new TraceRequestParams(fromBlock, toBlock, version);
   }
 
   private static String getTracerRuntime() {

tracer/arithmetization/src/main/java/net/consensys/linea/rpc/tracegeneration/TracesEndpointServicePlugin.java

@@ -25,7 +25,7 @@
 /**
  * Registers RPC endpoints .This class provides an RPC endpoint named
  * 'generateConflatedTracesToFileV0' under the 'rollup' namespace. It uses {@link
- * GenerateConflatedTracesV0} to generate conflated file traces. This class provides an RPC endpoint
+ * GenerateConflatedTracesV2} to generate conflated file traces. This class provides an RPC endpoint
  * named 'generateConflatedTracesToFileV0' under the 'rollup' namespace.
  */
 @AutoService(BesuPlugin.class)
@@ -55,7 +55,7 @@ public void register(final BesuContext context) {
   @Override
   public void beforeExternalServices() {
     super.beforeExternalServices();
-    GenerateConflatedTracesV0 method = new GenerateConflatedTracesV0(besuContext);
+    GenerateConflatedTracesV2 method = new GenerateConflatedTracesV2(besuContext);
 
     createAndRegister(method, rpcEndpointService);
   }
@@ -67,7 +67,7 @@ public void beforeExternalServices() {
    * @param rpcEndpointService the RpcEndpointService to be registered.
    */
   private void createAndRegister(
-      final GenerateConflatedTracesV0 method, final RpcEndpointService rpcEndpointService) {
+      final GenerateConflatedTracesV2 method, final RpcEndpointService rpcEndpointService) {
     rpcEndpointService.registerRPCEndpoint(
         method.getNamespace(), method.getName(), method::execute);
   }

tracer/arithmetization/src/main/java/net/consensys/linea/zktracer/json/JsonConverter.java

@@ -16,11 +16,13 @@
 package net.consensys.linea.zktracer.json;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import lombok.Getter;
+import lombok.SneakyThrows;
 
 /** A wrapper class handling Jackson's {@link ObjectMapper} configuration. */
 public class JsonConverter {
@@ -39,9 +41,9 @@ private JsonConverter(Builder builder) {
    *
    * @param object the object to be serialized
    * @return a JSON string representing the object's data
-   * @throws JsonProcessingException n case of a serialization failure
    */
-  public String toJson(Object object) throws JsonProcessingException {
+  @SneakyThrows(JsonProcessingException.class)
+  public String toJson(Object object) {
     if (prettyPrintEnabled) {
       return objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(object);
     }
@@ -56,12 +58,25 @@ public String toJson(Object object) throws JsonProcessingException {
    * @param clazz class type of the type for deserialization
    * @param <T> the deserialization type
    * @return an instance of the deserialized type
-   * @throws JsonProcessingException in case of a deserialization failure
    */
-  public <T> T fromJson(String jsonString, Class<T> clazz) throws JsonProcessingException {
+  @SneakyThrows(JsonProcessingException.class)
+  public <T> T fromJson(String jsonString, Class<T> clazz) {
     return objectMapper.readValue(jsonString, clazz);
   }
 
+  /**
+   * Deserializes a JSON string to a specified type.
+   *
+   * @param jsonString JSON string to be deserialized
+   * @param clazz class type of the type for deserialization
+   * @param <T> the deserialization type
+   * @return an instance of the deserialized type
+   */
+  @SneakyThrows(JsonProcessingException.class)
+  public <T> T fromJson(String jsonString) {
+    return objectMapper.readValue(jsonString, new TypeReference<>() {});
+  }
+
   /**
    * A factory for the {@link Builder} instance.
    *