Log constructed and block BALs on mismatch (#9402)

Signed-off-by: Miroslav Kovar <[email protected]>

Author: mirgee

app/src/main/java/org/hyperledger/besu/cli/ConfigurationOverviewBuilder.java

@@ -72,7 +72,8 @@ public class ConfigurationOverviewBuilder {
   private RocksDBCLIOptions.BlobDBSettings blobDBSettings;
   private Long targetGasLimit;
   private boolean isBalOptimizationEnabled = true;
-  private boolean isBalLenientOnMismatch = false;
+  private boolean isBalLenientOnStateRootMismatch = false;
+  private boolean shouldLogBalsOnMismatch = false;
   private boolean isBalApiEnabled = false;
   private Duration balStateRootTimeout = Duration.ofSeconds(1);
 
@@ -395,7 +396,8 @@ public ConfigurationOverviewBuilder setTargetGasLimit(final Long targetGasLimit)
    */
   public ConfigurationOverviewBuilder setBalConfiguration(final BalConfiguration balConfiguration) {
     this.isBalOptimizationEnabled = balConfiguration.isBalOptimisationEnabled();
-    this.isBalLenientOnMismatch = balConfiguration.isBalLenientOnMismatch();
+    this.isBalLenientOnStateRootMismatch = balConfiguration.isBalLenientOnStateRootMismatch();
+    this.shouldLogBalsOnMismatch = balConfiguration.shouldLogBalsOnMismatch();
     this.isBalApiEnabled = balConfiguration.isBalApiEnabled();
     this.balStateRootTimeout = balConfiguration.getBalStateRootTimeout();
     return this;
@@ -474,7 +476,10 @@ public String build() {
     }
 
     lines.add("BAL optimizations " + (isBalOptimizationEnabled ? "enabled" : "disabled"));
-    lines.add("BAL mismatch leniency " + (isBalLenientOnMismatch ? "enabled" : "disabled"));
+    lines.add(
+        "BAL state root mismatch leniency "
+            + (isBalLenientOnStateRootMismatch ? "enabled" : "disabled"));
+    lines.add("BAL logging on BAL mismatch " + (shouldLogBalsOnMismatch ? "enabled" : "disabled"));
     lines.add("BAL API " + (isBalApiEnabled ? "enabled" : "disabled"));
     lines.add("BAL state root timeout: " + balStateRootTimeout.toMillis() + " ms");
 

app/src/main/java/org/hyperledger/besu/cli/options/BalConfigurationOptions.java

@@ -33,11 +33,17 @@ public BalConfigurationOptions() {}
   boolean balOptimizationEnabled = true;
 
   @CommandLine.Option(
-      names = {"--Xbal-lenient-on-mismatch"},
+      names = {"--Xbal-lenient-on-state-root-mismatch"},
       hidden = true,
       description =
           "Log an error instead of throwing when the BAL-computed state root does not match the synchronously computed root.")
-  boolean balLenientOnMismatch = true;
+  boolean balLenientOnStateRootMismatch = true;
+
+  @CommandLine.Option(
+      names = {"--Xbal-log-bals-on-mismatch"},
+      hidden = true,
+      description = "Log the constructed and block's BAL when they differ.")
+  boolean balLogBalsOnMismatch = false;
 
   @CommandLine.Option(
       names = {"--Xbal-api-enabled"},
@@ -62,7 +68,8 @@ public BalConfiguration toDomainObject() {
     return ImmutableBalConfiguration.builder()
         .isBalApiEnabled(balApiEnabled)
         .isBalOptimisationEnabled(balOptimizationEnabled)
-        .isBalLenientOnMismatch(balLenientOnMismatch)
+        .shouldLogBalsOnMismatch(balLogBalsOnMismatch)
+        .isBalLenientOnStateRootMismatch(balLenientOnStateRootMismatch)
         .balStateRootTimeout(Duration.ofMillis(balStateRootTimeoutMs))
         .build();
   }

app/src/test/java/org/hyperledger/besu/cli/ConfigurationOverviewBuilderTest.java

@@ -286,14 +286,16 @@ void setBalConfiguration() {
     builder.setBalConfiguration(
         ImmutableBalConfiguration.builder()
             .isBalOptimisationEnabled(false)
-            .isBalLenientOnMismatch(true)
+            .isBalLenientOnStateRootMismatch(true)
+            .shouldLogBalsOnMismatch(true)
             .isBalApiEnabled(true)
             .balStateRootTimeout(Duration.ofMillis(2500))
             .build());
 
     final String configuration = builder.build();
     assertThat(configuration).contains("BAL optimizations disabled");
-    assertThat(configuration).contains("BAL mismatch leniency enabled");
+    assertThat(configuration).contains("BAL state root mismatch leniency enabled");
+    assertThat(configuration).contains("BAL logging on BAL mismatch enabled");
     assertThat(configuration).contains("BAL API enabled");
     assertThat(configuration).contains("BAL state root timeout: 2500 ms");
   }

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/tracing/flat/RewardTraceGeneratorTest.java

@@ -26,6 +26,7 @@
 import org.hyperledger.besu.ethereum.core.BlockDataGenerator;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.mainnet.AbstractBlockProcessor;
+import org.hyperledger.besu.ethereum.mainnet.BalConfiguration;
 import org.hyperledger.besu.ethereum.mainnet.ClassicBlockProcessor;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockProcessor;
 import org.hyperledger.besu.ethereum.mainnet.MainnetTransactionProcessor;
@@ -91,7 +92,8 @@ public void assertThatTraceGeneratorReturnValidRewardsForMainnetBlockProcessor()
             blockReward,
             BlockHeader::getCoinbase,
             true,
-            protocolSchedule);
+            protocolSchedule,
+            BalConfiguration.DEFAULT);
     when(protocolSpec.getBlockProcessor()).thenReturn(blockProcessor);
 
     final Stream<Trace> traceStream =
@@ -151,7 +153,8 @@ public void assertThatTraceGeneratorReturnValidRewardsForClassicBlockProcessor()
             BlockHeader::getCoinbase,
             true,
             eraRounds,
-            protocolSchedule);
+            protocolSchedule,
+            BalConfiguration.DEFAULT);
     when(protocolSpec.getBlockProcessor()).thenReturn(blockProcessor);
 
     final Stream<Trace> traceStream =

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/AbstractBlockProcessor.java

@@ -85,6 +85,7 @@ TransactionReceipt create(
 
   protected final boolean skipZeroBlockRewards;
   private final ProtocolSchedule protocolSchedule;
+  private final BalConfiguration balConfiguration;
 
   protected final MiningBeneficiaryCalculator miningBeneficiaryCalculator;
   private BlockImportTracerProvider blockImportTracerProvider = null;
@@ -95,13 +96,15 @@ protected AbstractBlockProcessor(
       final Wei blockReward,
       final MiningBeneficiaryCalculator miningBeneficiaryCalculator,
       final boolean skipZeroBlockRewards,
-      final ProtocolSchedule protocolSchedule) {
+      final ProtocolSchedule protocolSchedule,
+      final BalConfiguration balConfiguration) {
     this.transactionProcessor = transactionProcessor;
     this.transactionReceiptFactory = transactionReceiptFactory;
     this.blockReward = blockReward;
     this.miningBeneficiaryCalculator = miningBeneficiaryCalculator;
     this.skipZeroBlockRewards = skipZeroBlockRewards;
     this.protocolSchedule = protocolSchedule;
+    this.balConfiguration = balConfiguration;
   }
 
   private BlockAwareOperationTracer getBlockImportTracer(
@@ -410,6 +413,21 @@ public BlockProcessingResult processBlock(
                       "Block access list hash mismatch, calculated: %s header: %s",
                       expectedHash.toHexString(), headerBalHash.get().toHexString());
               LOG.error(errorMessage);
+
+              if (balConfiguration.shouldLogBalsOnMismatch()) {
+                final String constructedBalStr = bal.toString();
+                final String blockBalStr =
+                    blockBody
+                        .getBlockAccessList()
+                        .map(Object::toString)
+                        .orElse("<no BAL present in block body>");
+                LOG.error(
+                    "--- BAL constructed during execution ---\n{}\n"
+                        + "--- BAL from block body ---\n{}",
+                    constructedBalStr,
+                    blockBalStr);
+              }
+
               if (worldState instanceof BonsaiWorldState) {
                 ((BonsaiWorldStateUpdateAccumulator) worldState.updater()).reset();
               }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/BalConfiguration.java

@@ -41,10 +41,16 @@ default boolean isBalOptimisationEnabled() {
    * an error instead of throwing an exception.
    */
   @Value.Default
-  default boolean isBalLenientOnMismatch() {
+  default boolean isBalLenientOnStateRootMismatch() {
     return true;
   }
 
+  /** Returns whether the BALs should be logged when a constructed and block's BALs mismatch. */
+  @Value.Default
+  default boolean shouldLogBalsOnMismatch() {
+    return false;
+  }
+
   /** Returns the timeout to use when waiting for the BAL-computed state root. */
   @Value.Default
   default Duration getBalStateRootTimeout() {

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/ClassicBlockProcessor.java

@@ -42,14 +42,16 @@ public ClassicBlockProcessor(
       final MiningBeneficiaryCalculator miningBeneficiaryCalculator,
       final boolean skipZeroBlockRewards,
       final OptionalLong eraLen,
-      final ProtocolSchedule protocolSchedule) {
+      final ProtocolSchedule protocolSchedule,
+      final BalConfiguration balConfiguration) {
     super(
         transactionProcessor,
         transactionReceiptFactory,
         blockReward,
         miningBeneficiaryCalculator,
         skipZeroBlockRewards,
-        protocolSchedule);
+        protocolSchedule,
+        balConfiguration);
     eraLength = eraLen.orElse(DEFAULT_ERA_LENGTH);
   }
 

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/ClassicProtocolSpecs.java

@@ -144,15 +144,17 @@ public static ProtocolSpecBuilder gothamDefinition(
                 blockReward,
                 miningBeneficiaryCalculator,
                 skipZeroBlockRewards,
-                protocolSchedule) ->
+                protocolSchedule,
+                balConfig) ->
                 new ClassicBlockProcessor(
                     transactionProcessor,
                     transactionReceiptFactory,
                     blockReward,
                     miningBeneficiaryCalculator,
                     skipZeroBlockRewards,
                     genesisConfigOptions.getEcip1017EraRounds(),
-                    protocolSchedule))
+                    protocolSchedule,
+                    balConfig))
         .hardforkId(GOTHAM);
   }
 

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetBlockProcessor.java

@@ -36,14 +36,16 @@ public MainnetBlockProcessor(
       final Wei blockReward,
       final MiningBeneficiaryCalculator miningBeneficiaryCalculator,
       final boolean skipZeroBlockRewards,
-      final ProtocolSchedule protocolSchedule) {
+      final ProtocolSchedule protocolSchedule,
+      final BalConfiguration balConfiguration) {
     super(
         transactionProcessor,
         transactionReceiptFactory,
         blockReward,
         miningBeneficiaryCalculator,
         skipZeroBlockRewards,
-        protocolSchedule);
+        protocolSchedule,
+        balConfiguration);
   }
 
   @Override

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetProtocolSpecs.java

@@ -202,6 +202,7 @@ public static ProtocolSpecBuilder frontierDefinition(
         .blockReward(FRONTIER_BLOCK_REWARD)
         .skipZeroBlockRewards(false)
         .isBlockAccessListEnabled(balConfiguration.isBalApiEnabled())
+        .balConfiguration(balConfiguration)
         .blockProcessorBuilder(
             isParallelTxProcessingEnabled
                 ? new MainnetParallelBlockProcessor.ParallelBlockProcessorBuilder(metricsSystem)
@@ -291,7 +292,8 @@ public static ProtocolSpecBuilder daoRecoveryInitDefinition(
                 blockReward,
                 miningBeneficiaryCalculator,
                 skipZeroBlockRewards,
-                protocolSchedule) ->
+                protocolSchedule,
+                balConfig) ->
                 new DaoBlockProcessor(
                     isParallelTxProcessingEnabled
                         ? new MainnetParallelBlockProcessor(
@@ -301,14 +303,16 @@ public static ProtocolSpecBuilder daoRecoveryInitDefinition(
                             miningBeneficiaryCalculator,
                             skipZeroBlockRewards,
                             protocolSchedule,
+                            balConfig,
                             metricsSystem)
                         : new MainnetBlockProcessor(
                             transactionProcessor,
                             transactionReceiptFactory,
                             blockReward,
                             miningBeneficiaryCalculator,
                             skipZeroBlockRewards,
-                            protocolSchedule)))
+                            protocolSchedule,
+                            balConfig)))
         .hardforkId(DAO_RECOVERY_INIT);
   }