feat: enable creation of traces output directory on GenerateConflated…

…TracesV2 RPC endpoint and set it up as a CLI option (#830) Resolves: #829 Signed-off-by: Tsvetan Dimitrov <[email protected]>
Consensys · Jul 9, 2024 · 419f654 · 419f654
1 parent 9ed01f5
commit 419f654
Show file tree

Hide file tree

Showing 35 changed files with 107 additions and 81 deletions.
diff --git a/...ys/linea/AbstractLineaRequiredPlugin.java → .../plugins/AbstractLineaRequiredPlugin.java b/...ys/linea/AbstractLineaRequiredPlugin.java → .../plugins/AbstractLineaRequiredPlugin.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea;
+package net.consensys.linea.plugins;
 
 import lombok.extern.slf4j.Slf4j;
 import org.hyperledger.besu.plugin.BesuContext;

diff --git a/...nea/AbstractLineaSharedOptionsPlugin.java → ...ins/AbstractLineaSharedOptionsPlugin.java b/...nea/AbstractLineaSharedOptionsPlugin.java → ...ins/AbstractLineaSharedOptionsPlugin.java
@@ -13,11 +13,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea;
+package net.consensys.linea.plugins;
 
 import lombok.extern.slf4j.Slf4j;
-import net.consensys.linea.config.LineaTracerCliOptions;
-import net.consensys.linea.config.LineaTracerConfiguration;
+import net.consensys.linea.plugins.config.LineaTracerCliOptions;
+import net.consensys.linea.plugins.config.LineaTracerConfiguration;
 import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;

diff --git a/...nea/config/LineaL1L2BridgeCliOptions.java → ...ins/config/LineaL1L2BridgeCliOptions.java b/...nea/config/LineaL1L2BridgeCliOptions.java → ...ins/config/LineaL1L2BridgeCliOptions.java
@@ -13,11 +13,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.config;
+package net.consensys.linea.plugins.config;
 
 import com.google.common.base.MoreObjects;
-import net.consensys.linea.config.converters.AddressConverter;
-import net.consensys.linea.config.converters.BytesConverter;
+import net.consensys.linea.plugins.config.converters.AddressConverter;
+import net.consensys.linea.plugins.config.converters.BytesConverter;
 import org.apache.tuweni.bytes.Bytes;
 import org.hyperledger.besu.datatypes.Address;
 import picocli.CommandLine;

diff --git a/.../config/LineaL1L2BridgeConfiguration.java → .../config/LineaL1L2BridgeConfiguration.java b/.../config/LineaL1L2BridgeConfiguration.java → .../config/LineaL1L2BridgeConfiguration.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.config;
+package net.consensys.linea.plugins.config;
 
 import lombok.Builder;
 import org.apache.tuweni.bytes.Bytes;

diff --git a/...s/linea/config/LineaTracerCliOptions.java → ...plugins/config/LineaTracerCliOptions.java b/...s/linea/config/LineaTracerCliOptions.java → ...plugins/config/LineaTracerCliOptions.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.config;
+package net.consensys.linea.plugins.config;
 
 import com.google.common.base.MoreObjects;
 import picocli.CommandLine;
@@ -21,6 +21,8 @@ public class LineaTracerCliOptions {
 
   public static final String MODULE_LIMIT_FILE_PATH = "--plugin-linea-module-limit-file-path";
   public static final String DEFAULT_MODULE_LIMIT_FILE_PATH = "moduleLimitFile.toml";
+  public static final String CONFLATED_TRACE_GENERATION_TRACES_OUTPUT_PATH =
+      "--plugin-linea-conflated-trace-generation-traces-output-path";
 
   @CommandLine.Option(
       names = {MODULE_LIMIT_FILE_PATH},
@@ -30,6 +32,13 @@ public class LineaTracerCliOptions {
           "Path to the toml file containing the module limits (default: ${DEFAULT-VALUE})")
   private String moduleLimitFilePath = DEFAULT_MODULE_LIMIT_FILE_PATH;
 
+  @CommandLine.Option(
+      names = {CONFLATED_TRACE_GENERATION_TRACES_OUTPUT_PATH},
+      hidden = true,
+      paramLabel = "<PATH>",
+      description = "Path to where traces will be written")
+  private String tracesOutputPath = null;
+
   private LineaTracerCliOptions() {}
 
   /**
@@ -50,6 +59,7 @@ public static LineaTracerCliOptions create() {
   public static LineaTracerCliOptions fromConfig(final LineaTracerConfiguration config) {
     final LineaTracerCliOptions options = create();
     options.moduleLimitFilePath = config.moduleLimitsFilePath();
+    options.tracesOutputPath = config.tracesOutputPath();
     return options;
   }
 
@@ -59,13 +69,17 @@ public static LineaTracerCliOptions fromConfig(final LineaTracerConfiguration co
    * @return the Linea factory configuration
    */
   public LineaTracerConfiguration toDomainObject() {
-    return LineaTracerConfiguration.builder().moduleLimitsFilePath(moduleLimitFilePath).build();
+    return LineaTracerConfiguration.builder()
+        .tracesOutputPath(tracesOutputPath)
+        .moduleLimitsFilePath(moduleLimitFilePath)
+        .build();
   }
 
   @Override
   public String toString() {
     return MoreObjects.toStringHelper(this)
         .add(MODULE_LIMIT_FILE_PATH, moduleLimitFilePath)
+        .add(CONFLATED_TRACE_GENERATION_TRACES_OUTPUT_PATH, tracesOutputPath)
         .toString();
   }
 }
diff --git a/...inea/config/LineaTracerConfiguration.java → ...gins/config/LineaTracerConfiguration.java b/...inea/config/LineaTracerConfiguration.java → ...gins/config/LineaTracerConfiguration.java
@@ -13,10 +13,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.config;
+package net.consensys.linea.plugins.config;
 
 import lombok.Builder;
 
 /** The Linea tracer configuration. */
 @Builder(toBuilder = true)
-public record LineaTracerConfiguration(String moduleLimitsFilePath) {}
+public record LineaTracerConfiguration(String moduleLimitsFilePath, String tracesOutputPath) {}
diff --git a/...a/config/converters/AddressConverter.java → ...s/config/converters/AddressConverter.java b/...a/config/converters/AddressConverter.java → ...s/config/converters/AddressConverter.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.config.converters;
+package net.consensys.linea.plugins.config.converters;
 
 import org.hyperledger.besu.datatypes.Address;
 import picocli.CommandLine;

diff --git a/...nea/config/converters/BytesConverter.java → ...ins/config/converters/BytesConverter.java b/...nea/config/converters/BytesConverter.java → ...ins/config/converters/BytesConverter.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.config.converters;
+package net.consensys.linea.plugins.config.converters;
 
 import org.apache.tuweni.bytes.Bytes;
 import picocli.CommandLine;

diff --git a/...linea/config/converters/WeiConverter.java → ...ugins/config/converters/WeiConverter.java b/...linea/config/converters/WeiConverter.java → ...ugins/config/converters/WeiConverter.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.config.converters;
+package net.consensys.linea.plugins.config.converters;
 
 import java.math.BigInteger;
 

diff --git a/...ea/continoustracing/ContinuousTracer.java → ...ns/continoustracing/ContinuousTracer.java b/...ea/continoustracing/ContinuousTracer.java → ...ns/continoustracing/ContinuousTracer.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -21,10 +21,10 @@
 import java.util.Optional;
 
 import lombok.extern.slf4j.Slf4j;
-import net.consensys.linea.continoustracing.exception.InvalidBlockTraceException;
-import net.consensys.linea.continoustracing.exception.TraceOutputException;
-import net.consensys.linea.continoustracing.exception.TraceVerificationException;
 import net.consensys.linea.corset.CorsetValidator;
+import net.consensys.linea.plugins.exception.InvalidBlockTraceException;
+import net.consensys.linea.plugins.exception.TraceOutputException;
+import net.consensys.linea.plugins.exception.TraceVerificationException;
 import net.consensys.linea.zktracer.ZkTracer;
 import org.apache.commons.io.FileUtils;
 import org.hyperledger.besu.datatypes.Hash;

diff --git a/.../ContinuousTracingBlockAddedListener.java → .../ContinuousTracingBlockAddedListener.java b/.../ContinuousTracingBlockAddedListener.java → .../ContinuousTracingBlockAddedListener.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -22,10 +22,10 @@
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
-import net.consensys.linea.continoustracing.exception.InvalidBlockTraceException;
-import net.consensys.linea.continoustracing.exception.InvalidTraceHandlerException;
-import net.consensys.linea.continoustracing.exception.TraceVerificationException;
 import net.consensys.linea.corset.CorsetValidator;
+import net.consensys.linea.plugins.exception.InvalidBlockTraceException;
+import net.consensys.linea.plugins.exception.InvalidTraceHandlerException;
+import net.consensys.linea.plugins.exception.TraceVerificationException;
 import net.consensys.linea.zktracer.ZkTracer;
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.plugin.data.AddedBlockContext;

diff --git a/...stracing/ContinuousTracingCliOptions.java → ...stracing/ContinuousTracingCliOptions.java b/...stracing/ContinuousTracingCliOptions.java → ...stracing/ContinuousTracingCliOptions.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import com.google.common.base.MoreObjects;
 import picocli.CommandLine;
@@ -24,7 +24,7 @@ public class ContinuousTracingCliOptions {
       "--plugin-linea-continuous-tracing-zk-evm-bin";
 
   public static final String CONTINUOUS_TRACING_TRACES_DIR =
-      "--plugin-linea-continuous-tracing-traces-dir";
+      "--plugin-linea-continuous-tracing-traces-output-path";
 
   @CommandLine.Option(
       names = {CONTINUOUS_TRACING_ENABLED},
@@ -45,7 +45,7 @@ public class ContinuousTracingCliOptions {
       hidden = true,
       paramLabel = "<PATH>",
       description = "Path to where traces will be written")
-  private String tracesDir = null;
+  private String tracesOutputPath = null;
 
   private ContinuousTracingCliOptions() {}
 
@@ -54,15 +54,15 @@ public static ContinuousTracingCliOptions create() {
   }
 
   public ContinuousTracingConfiguration toDomainObject() {
-    return new ContinuousTracingConfiguration(continuousTracingEnabled, zkEvmBin, tracesDir);
+    return new ContinuousTracingConfiguration(continuousTracingEnabled, zkEvmBin, tracesOutputPath);
   }
 
   @Override
   public String toString() {
     return MoreObjects.toStringHelper(this)
         .add(CONTINUOUS_TRACING_ENABLED, continuousTracingEnabled)
         .add(CONTINUOUS_TRACING_ZK_EVM_BIN, zkEvmBin)
-        .add(CONTINUOUS_TRACING_TRACES_DIR, tracesDir)
+        .add(CONTINUOUS_TRACING_TRACES_DIR, tracesOutputPath)
         .toString();
   }
 }
diff --git a/...acing/ContinuousTracingConfiguration.java → ...acing/ContinuousTracingConfiguration.java b/...acing/ContinuousTracingConfiguration.java → ...acing/ContinuousTracingConfiguration.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 public record ContinuousTracingConfiguration(
     boolean continuousTracing, String zkEvmBin, String tracesDir) {}
diff --git a/...inoustracing/ContinuousTracingPlugin.java → ...inoustracing/ContinuousTracingPlugin.java b/...inoustracing/ContinuousTracingPlugin.java → ...inoustracing/ContinuousTracingPlugin.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import java.util.Optional;
 

diff --git a/...noustracing/SlackNotificationService.java → ...noustracing/SlackNotificationService.java b/...noustracing/SlackNotificationService.java → ...noustracing/SlackNotificationService.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import static com.slack.api.model.block.Blocks.asBlocks;
 import static com.slack.api.model.block.Blocks.divider;

diff --git a/...continoustracing/TraceFailureHandler.java → ...continoustracing/TraceFailureHandler.java b/...continoustracing/TraceFailureHandler.java → ...continoustracing/TraceFailureHandler.java
@@ -12,13 +12,13 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing;
+package net.consensys.linea.plugins.continoustracing;
 
 import java.io.IOException;
 
 import lombok.extern.slf4j.Slf4j;
-import net.consensys.linea.continoustracing.exception.InvalidTraceHandlerException;
 import net.consensys.linea.corset.CorsetValidator;
+import net.consensys.linea.plugins.exception.InvalidTraceHandlerException;
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.plugin.data.BlockHeader;
 

diff --git a/...exception/InvalidBlockTraceException.java → ...exception/InvalidBlockTraceException.java b/...exception/InvalidBlockTraceException.java → ...exception/InvalidBlockTraceException.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing.exception;
+package net.consensys.linea.plugins.exception;
 
 import org.hyperledger.besu.datatypes.Hash;
 

diff --git a/...ception/InvalidTraceHandlerException.java → ...ception/InvalidTraceHandlerException.java b/...ception/InvalidTraceHandlerException.java → ...ception/InvalidTraceHandlerException.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing.exception;
+package net.consensys.linea.plugins.exception;
 
 public class InvalidTraceHandlerException extends Throwable {
   public InvalidTraceHandlerException(Throwable t) {

diff --git a/...acing/exception/TraceOutputException.java → ...ugins/exception/TraceOutputException.java b/...acing/exception/TraceOutputException.java → ...ugins/exception/TraceOutputException.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing.exception;
+package net.consensys.linea.plugins.exception;
 
 public class TraceOutputException extends RuntimeException {
   public TraceOutputException(final String message) {

diff --git a/...exception/TraceVerificationException.java → ...exception/TraceVerificationException.java b/...exception/TraceVerificationException.java → ...exception/TraceVerificationException.java
@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package net.consensys.linea.continoustracing.exception;
+package net.consensys.linea.plugins.exception;
 
 import org.hyperledger.besu.datatypes.Hash;
 

diff --git a/.../consensys/linea/rpc/capture/Capture.java → ...ys/linea/plugins/rpc/capture/Capture.java b/.../consensys/linea/rpc/capture/Capture.java → ...ys/linea/plugins/rpc/capture/Capture.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.capture;
+package net.consensys.linea.plugins.rpc.capture;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 

diff --git a/...capture/CaptureEndpointServicePlugin.java → ...capture/CaptureEndpointServicePlugin.java b/...capture/CaptureEndpointServicePlugin.java → ...capture/CaptureEndpointServicePlugin.java
@@ -13,13 +13,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.capture;
+package net.consensys.linea.plugins.rpc.capture;
 
 import java.util.Optional;
 
 import com.google.auto.service.AutoService;
 import lombok.extern.slf4j.Slf4j;
-import net.consensys.linea.AbstractLineaRequiredPlugin;
+import net.consensys.linea.plugins.AbstractLineaRequiredPlugin;
 import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;

diff --git a/...nsys/linea/rpc/capture/CaptureParams.java → ...ea/plugins/rpc/capture/CaptureParams.java b/...nsys/linea/rpc/capture/CaptureParams.java → ...ea/plugins/rpc/capture/CaptureParams.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.capture;
+package net.consensys.linea.plugins.rpc.capture;
 
 import java.security.InvalidParameterException;
 

diff --git a/...nsys/linea/rpc/capture/CaptureToFile.java → ...ea/plugins/rpc/capture/CaptureToFile.java b/...nsys/linea/rpc/capture/CaptureToFile.java → ...ea/plugins/rpc/capture/CaptureToFile.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.capture;
+package net.consensys.linea.plugins.rpc.capture;
 
 import com.google.common.base.Stopwatch;
 import lombok.extern.slf4j.Slf4j;

diff --git a/...onsensys/linea/rpc/counters/Counters.java → .../linea/plugins/rpc/counters/Counters.java b/...onsensys/linea/rpc/counters/Counters.java → .../linea/plugins/rpc/counters/Counters.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.counters;
+package net.consensys.linea.plugins.rpc.counters;
 
 import java.util.Map;
 

diff --git a/...unters/CountersEndpointServicePlugin.java → ...unters/CountersEndpointServicePlugin.java b/...unters/CountersEndpointServicePlugin.java → ...unters/CountersEndpointServicePlugin.java
@@ -13,10 +13,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.counters;
+package net.consensys.linea.plugins.rpc.counters;
 
 import com.google.auto.service.AutoService;
-import net.consensys.linea.AbstractLineaSharedOptionsPlugin;
+import net.consensys.linea.plugins.AbstractLineaSharedOptionsPlugin;
 import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;

diff --git a/...a/rpc/counters/CountersRequestParams.java → ...s/rpc/counters/CountersRequestParams.java b/...a/rpc/counters/CountersRequestParams.java → ...s/rpc/counters/CountersRequestParams.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.counters;
+package net.consensys.linea.plugins.rpc.counters;
 
 import java.security.InvalidParameterException;
 

diff --git a/...inea/rpc/counters/GenerateCountersV2.java → ...gins/rpc/counters/GenerateCountersV2.java b/...inea/rpc/counters/GenerateCountersV2.java → ...gins/rpc/counters/GenerateCountersV2.java
@@ -13,7 +13,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package net.consensys.linea.rpc.counters;
+package net.consensys.linea.plugins.rpc.counters;
 
 import java.security.InvalidParameterException;
 import java.util.Map;