Merge branch 'arith-dev' into gauravahuja/shomei-node

Author: gauravahuja

.github/actions/setup-go-corset/action.yml

@@ -9,4 +9,4 @@ runs:
 
     - name: Install Go Corset
       shell: bash
-      run: go install github.com/consensys/go-corset/cmd/[email protected].3
+      run: go install github.com/consensys/go-corset/cmd/[email protected].7

.gitignore

@@ -37,5 +37,5 @@ reference-tests/src/test/java/net/consensys/linea/generated/*
 arithmetization/bin/
 acceptance-tests/bin/
 reference-tests/bin/
-**/*Trace.java
+**/*Trace*.java
 **/*GlobalConstants.java

arithmetization/src/main/java/net/consensys/linea/corset/GoCorsetValidator.java

@@ -16,6 +16,7 @@
 package net.consensys.linea.corset;
 
 import static net.consensys.linea.zktracer.ChainConfig.MAINNET_LONDON_TESTCONFIG;
+import static net.consensys.linea.zktracer.Trace.*;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -52,7 +53,7 @@ public class GoCorsetValidator extends AbstractExecutable {
   @Getter private boolean active = false;
 
   /** Details chain configuration. */
-  private ChainConfig chain;
+  private final ChainConfig chain;
 
   /**
    * Aggregation of all coverage reports generated by go-corset. If GOCORSET_COVERAGE is set, then
@@ -154,6 +155,16 @@ private List<String> buildCommandLine(Path traceFile, String zkEvmBin) {
    * @param options
    */
   private void setChainConstants(List<String> options) {
+    final int fork =
+        switch (chain.fork) {
+          case LONDON -> EVM_LONDON;
+            // case PARIS -> EVM_PARIS;
+          case SHANGHAI -> EVM_SHANGHAI;
+          case CANCUN -> EVM_CANCUN;
+          case PRAGUE -> EVM_PRAGUE;
+          default -> throw new IllegalArgumentException("unknown fork \"" + chain.fork + "\"");
+        };
+    options.add("-SEVM_FORK=" + fork);
     if (chain != MAINNET_LONDON_TESTCONFIG) {
       options.add("-Sblockdata.GAS_LIMIT_MINIMUM=" + chain.gasLimitMinimum.toString());
       options.add("-Sblockdata.GAS_LIMIT_MAXIMUM=" + chain.gasLimitMaximum.toString());

arithmetization/src/main/java/net/consensys/linea/zktracer/ChainConfig.java

@@ -35,24 +35,17 @@ public class ChainConfig {
    * Represents Linea mainnet as it stands today which enforces the block gas limit (currently two
    * billion). As the name suggest, this is only intended for testing purposes.
    */
-  public static final ChainConfig MAINNET_LONDON_TESTCONFIG =
-      new ChainConfig(
-          LONDON,
-          LINEA_CHAIN_ID,
-          true,
-          BigInteger.valueOf(LINEA_GAS_LIMIT_MINIMUM),
-          BigInteger.valueOf(LINEA_GAS_LIMIT_MAXIMUM),
-          LineaL1L2BridgeSharedConfiguration.TEST_DEFAULT);
+  public static final ChainConfig MAINNET_LONDON_TESTCONFIG = MAINNET_TESTCONFIG(LONDON);
 
-  /** Represents Ethereum mainnet for the purposes of running reference tests. */
-  public static final ChainConfig ETHEREUM_LONDON =
-      new ChainConfig(
-          LONDON,
-          1,
-          false,
-          BigInteger.valueOf(ETHEREUM_GAS_LIMIT_MINIMUM),
-          ETHEREUM_GAS_LIMIT_MAXIMUM,
-          LineaL1L2BridgeSharedConfiguration.TEST_DEFAULT);
+  public static final ChainConfig MAINNET_TESTCONFIG(final Fork fork) {
+    return new ChainConfig(
+        fork,
+        LINEA_CHAIN_ID,
+        true,
+        BigInteger.valueOf(LINEA_GAS_LIMIT_MINIMUM),
+        BigInteger.valueOf(LINEA_GAS_LIMIT_MAXIMUM),
+        LineaL1L2BridgeSharedConfiguration.TEST_DEFAULT);
+  }
 
   /**
    * Represents Linea mainnet prior to the block gas limit being enforced for the purposes of
@@ -162,4 +155,20 @@ public static ChainConfig FORK_LINEA_CHAIN(
         BigInteger.valueOf(LINEA_GAS_LIMIT_MAXIMUM),
         bridgeConfig);
   }
+
+  /**
+   * Construct a suitable configuration representing a specific fork of Ethereum mainnet.
+   *
+   * @param fork
+   * @return
+   */
+  public static ChainConfig ETHEREUM_CHAIN(String fork) {
+    return new ChainConfig(
+        Fork.fromString(fork),
+        1,
+        false,
+        BigInteger.valueOf(ETHEREUM_GAS_LIMIT_MINIMUM),
+        ETHEREUM_GAS_LIMIT_MAXIMUM,
+        LineaL1L2BridgeSharedConfiguration.TEST_DEFAULT);
+  }
 }

arithmetization/src/main/java/net/consensys/linea/zktracer/Fork.java

@@ -17,22 +17,36 @@
 
 public enum Fork {
   LONDON,
+  PARIS,
   SHANGHAI,
   CANCUN,
   PRAGUE;
 
   public static String toString(Fork fork) {
     return switch (fork) {
       case LONDON -> "london";
+      case PARIS -> "paris";
       case SHANGHAI -> "shanghai";
       case CANCUN -> "cancun";
       case PRAGUE -> "prague";
     };
   }
 
+  /**
+   * Construct a fork instance from the name of a fork (e.g. "London", "Shanghai", etc). Observe
+   * that case does not matter here. Hence, "LONDON", "London", "london", "lonDon" are all suitable
+   * aliases for the LONDON instance.
+   *
+   * @param fork
+   * @return
+   */
+  public static Fork fromString(String fork) {
+    return Fork.valueOf(fork.toUpperCase());
+  }
+
   public static boolean isPostShanghai(Fork fork) {
     return switch (fork) {
-      case LONDON -> false;
+      case LONDON, PARIS -> false;
       case SHANGHAI, CANCUN, PRAGUE -> true;
     };
   }

arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java

@@ -27,8 +27,6 @@
 import java.util.Optional;
 import java.util.Set;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.ObjectWriter;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import net.consensys.linea.plugins.config.LineaL1L2BridgeSharedConfiguration;
@@ -53,14 +51,17 @@
 @Slf4j
 public class ZkTracer implements ConflationAwareOperationTracer {
 
+  /** Construct trace object. */
+  private final Trace trace;
+
   @Getter private final Hub hub;
   private final Optional<DebugMode> debugMode;
 
   /** Accumulate all the exceptions that happened at tracing time. */
   @Getter private final List<Exception> tracingExceptions = new FiniteList<>(50);
 
   // Fields for metadata
-  private final ChainConfig chain;
+  @Getter private final ChainConfig chain;
 
   /**
    * Construct a ZkTracer for a given bridge configuration and chainId. This is used, for example,
@@ -88,41 +89,46 @@ public ZkTracer(ChainConfig chain) {
     this.hub =
         switch (chain.fork) {
           case LONDON -> new LondonHub(chain);
+          case PARIS -> new ParisHub(chain);
           case SHANGHAI -> new ShanghaiHub(chain);
           case CANCUN -> new CancunHub(chain);
           case PRAGUE -> new PragueHub(chain);
         };
+    this.trace =
+        switch (chain.fork) {
+          default -> new TraceLondon();
+            // case SHANGHAI -> new TraceShanghai();
+        };
     final DebugMode.PinLevel debugLevel = new DebugMode.PinLevel();
     this.debugMode =
         debugLevel.none() ? Optional.empty() : Optional.of(new DebugMode(debugLevel, this.hub));
   }
 
   public void writeToFile(final Path filename, long startBlock, long endBlock) {
     maybeThrowTracingExceptions();
-
     final List<Module> modulesToTrace = hub.getModulesToTrace();
     final List<Trace.ColumnHeader> headers =
-        modulesToTrace.stream().flatMap(m -> m.columnHeaders().stream()).toList();
+        modulesToTrace.stream().flatMap(m -> m.columnHeaders(trace).stream()).toList();
     // Configure metadata
-    final Map<String, Object> metadata = Trace.metadata();
-    metadata.put("releaseVersion", ZkTracer.class.getPackage().getSpecificationVersion());
-    metadata.put("chainId", this.chain.id.toString());
-    metadata.put("l2L1LogSmcAddress", this.chain.bridgeConfiguration.contract().toString());
-    metadata.put("l2L1LogTopic", this.chain.bridgeConfiguration.topic().toString());
+    trace.addMetadata("releaseVersion", ZkTracer.class.getPackage().getSpecificationVersion());
+    trace.addMetadata("chainId", this.chain.id.toString());
+    trace.addMetadata("l2L1LogSmcAddress", this.chain.bridgeConfiguration.contract().toString());
+    trace.addMetadata("l2L1LogTopic", this.chain.bridgeConfiguration.topic().toString());
     // include block range
     final Map<String, String> range = new HashMap<>();
     range.put("start", Long.toString(startBlock));
     range.put("end", Long.toString(endBlock));
-    metadata.put("conflation", range);
+    trace.addMetadata("conflation", range);
     // include line counts
     final Map<String, String> lineCounts = new HashMap<>();
     for (Module m : hub.getTracelessModules()) {
       lineCounts.put(m.moduleKey(), Integer.toString(m.lineCount()));
     }
-    metadata.put("lineCounts", lineCounts);
+    trace.addMetadata("lineCounts", lineCounts);
     //
     try (RandomAccessFile file = new RandomAccessFile(filename.toString(), "rw")) {
-      final Trace trace = Trace.of(file, headers, getMetadataBytes(metadata));
+      // Open trace for writing
+      trace.open(file, headers);
       // Commit each module
       for (Module m : modulesToTrace) {
         m.commit(trace);
@@ -317,19 +323,12 @@ public Map<String, Integer> getModulesLineCount() {
     final HashMap<String, Integer> modulesLineCount = new HashMap<>();
 
     for (Module m : hub.getModulesToCount()) {
-      modulesLineCount.put(m.moduleKey(), m.lineCount() + m.spillage());
+      modulesLineCount.put(m.moduleKey(), m.lineCount() + m.spillage(this.trace));
     }
     //
     return modulesLineCount;
   }
 
-  /** Object writer is used for generating JSON byte strings. */
-  private static final ObjectWriter objectWriter = new ObjectMapper().writer();
-
-  public static byte[] getMetadataBytes(Map<String, Object> metadata) throws IOException {
-    return objectWriter.writeValueAsBytes(metadata);
-  }
-
   public Set<Address> getAddressesSeenByHubForRelativeBlock(final int relativeBlockNumber) {
     return hub.blockStack().getBlockByRelativeBlockNumber(relativeBlockNumber).addressesSeenByHub();
   }

arithmetization/src/main/java/net/consensys/linea/zktracer/container/module/CountingOnlyModule.java

@@ -41,7 +41,7 @@ default int lineCount() {
   }
 
   @Override
-  default int spillage() {
+  default int spillage(Trace trace) {
     return 0;
   }
 
@@ -51,7 +51,7 @@ default void updateTally(final int count) {
   }
 
   @Override
-  default List<Trace.ColumnHeader> columnHeaders() {
+  default List<Trace.ColumnHeader> columnHeaders(Trace trace) {
     throw new IllegalStateException("should never be called");
   }
 

arithmetization/src/main/java/net/consensys/linea/zktracer/container/module/Module.java

@@ -80,9 +80,9 @@ default void tracePreOpcode(MessageFrame frame, OpCode opcode) {}
    *
    * @return
    */
-  int spillage();
+  int spillage(Trace trace);
 
-  List<Trace.ColumnHeader> columnHeaders();
+  List<Trace.ColumnHeader> columnHeaders(Trace trace);
 
   default void commit(Trace trace) {
     throw new UnsupportedOperationException();

arithmetization/src/main/java/net/consensys/linea/zktracer/module/add/Add.java

@@ -58,20 +58,20 @@ public void tracePreOpcode(MessageFrame frame, OpCode opcode) {
   }
 
   @Override
-  public List<Trace.ColumnHeader> columnHeaders() {
-    return Trace.Add.headers(this.lineCount());
+  public List<Trace.ColumnHeader> columnHeaders(Trace trace) {
+    return trace.add().headers(this.lineCount());
   }
 
   @Override
-  public int spillage() {
-    return Trace.Add.SPILLAGE;
+  public int spillage(Trace trace) {
+    return trace.add().spillage();
   }
 
   @Override
   public void commit(Trace trace) {
     int stamp = 0;
     for (AddOperation op : sortOperations(new AddOperationComparator())) {
-      op.trace(++stamp, trace.add);
+      op.trace(++stamp, trace.add());
     }
   }
 

arithmetization/src/main/java/net/consensys/linea/zktracer/module/bin/Bin.java

@@ -64,20 +64,20 @@ public void tracePreOpcode(MessageFrame frame, OpCode opcode) {
   }
 
   @Override
-  public List<Trace.ColumnHeader> columnHeaders() {
-    return Trace.Bin.headers(this.lineCount());
+  public List<Trace.ColumnHeader> columnHeaders(Trace trace) {
+    return trace.bin().headers(this.lineCount());
   }
 
   @Override
-  public int spillage() {
-    return Trace.Bin.SPILLAGE;
+  public int spillage(Trace trace) {
+    return trace.bin().spillage();
   }
 
   @Override
   public void commit(Trace trace) {
     int stamp = 0;
     for (BinOperation op : operations.sortOperations(new BinOperationComparator())) {
-      op.traceBinOperation(++stamp, trace.bin);
+      op.traceBinOperation(++stamp, trace.bin());
     }
   }
 }

arithmetization/src/main/java/net/consensys/linea/zktracer/module/blake2fmodexpdata/BlakeModexpData.java

@@ -67,20 +67,20 @@ private void callWcpForIdCheck(final int operationID) {
   }
 
   @Override
-  public List<Trace.ColumnHeader> columnHeaders() {
-    return Trace.Blake2fmodexpdata.headers(this.lineCount());
+  public List<Trace.ColumnHeader> columnHeaders(Trace trace) {
+    return trace.blake2fmodexpdata().headers(this.lineCount());
   }
 
   @Override
-  public int spillage() {
-    return Trace.Blake2fmodexpdata.SPILLAGE;
+  public int spillage(Trace trace) {
+    return trace.blake2fmodexpdata().spillage();
   }
 
   @Override
   public void commit(Trace trace) {
     int stamp = 0;
     for (BlakeModexpDataOperation o : operations.getAll()) {
-      o.trace(trace.blake2fmodexpdata, ++stamp);
+      o.trace(trace.blake2fmodexpdata(), ++stamp);
     }
   }
 }