Add an option to disable syncing the deposit contract logs for non-validator nodes (Consensys#8178)

Author: StefanBratanov

CHANGELOG.md

@@ -13,6 +13,8 @@ the [releases page](https://github.com/Consensys/teku/releases).
 
 ### Additions and Improvements
 - Increased the executor queue default maximum size to 40_000 (previously 20_000), and other queues to 10_000 (previously 5_000). If you have custom settings for these queues, check to ensure they're still required.
-- Added `peers_direction_current` LIBP2P metric for the number of peers by direction including inbound and outbound.
+- Added `peers_direction_current` libp2p metric to track the number of peers by direction (inbound and outbound).
+- Deposit tree snapshots will be loaded from database as a default unless custom snapshot has been provided.
+- Added hidden option `--Xdeposit-contract-logs-syncing-enabled` to allow disabling the syncing of the deposit contract logs from the EL. This is useful when running a non-validating node. It is advisable to be used alongside with `--Xeth1-missing-deposits-event-logging-enabled=false` to avoid unnecessary logging of missing deposits.
 
 ### Bug Fixes

ethereum/spec/src/main/java/tech/pegasys/teku/spec/logic/versions/electra/block/BlockProcessorElectra.java

@@ -90,7 +90,7 @@ protected void processOperationsNoValidation(
     safelyProcess(
         () ->
             processDepositReceipts(
-                MutableBeaconStateElectra.required(state),
+                state,
                 body.getOptionalExecutionPayload()
                     .flatMap(ExecutionPayload::toVersionElectra)
                     .map(ExecutionPayloadElectra::getDepositReceipts)

ethereum/spec/src/test/java/tech/pegasys/teku/spec/logic/versions/electra/block/BlockProcessorElectraTest.java

@@ -129,7 +129,7 @@ public void processesDepositReceipts() throws BlockProcessingException {
                         UInt64.valueOf(firstElectraDepositReceiptIndex + i)))
             .toList();
 
-    final BeaconState state =
+    final BeaconStateElectra state =
         BeaconStateElectra.required(
             preState.updated(
                 mutableState ->
@@ -139,7 +139,7 @@ public void processesDepositReceipts() throws BlockProcessingException {
                             depositReceiptsSchema.createFromElements(depositReceipts))));
 
     // verify deposit_receipts_start_index has been set
-    assertThat(BeaconStateElectra.required(state).getDepositReceiptsStartIndex())
+    assertThat(state.getDepositReceiptsStartIndex())
         .isEqualTo(UInt64.valueOf(firstElectraDepositReceiptIndex));
     // verify validators have been added to the state
     assertThat(state.getValidators().size())

infrastructure/logging/src/main/java/tech/pegasys/teku/infrastructure/logging/ColorConsolePrinter.java

@@ -33,25 +33,15 @@ public static String print(final String message, final Color color) {
   }
 
   private static String colorCode(final Color color) {
-    switch (color) {
-      case BLACK:
-        return "\u001b[30m";
-      case RED:
-        return "\u001b[31m";
-      case GREEN:
-        return "\u001b[32m";
-      case YELLOW:
-        return "\u001b[33m";
-      case BLUE:
-        return "\u001b[34m";
-      case PURPLE:
-        return "\u001b[35m";
-      case CYAN:
-        return "\u001b[36m";
-      case WHITE:
-        return "\u001b[37m";
-      default:
-        return "";
-    }
+    return switch (color) {
+      case BLACK -> "\u001b[30m";
+      case RED -> "\u001b[31m";
+      case GREEN -> "\u001b[32m";
+      case YELLOW -> "\u001b[33m";
+      case BLUE -> "\u001b[34m";
+      case PURPLE -> "\u001b[35m";
+      case CYAN -> "\u001b[36m";
+      case WHITE -> "\u001b[37m";
+    };
   }
 }

infrastructure/logging/src/main/java/tech/pegasys/teku/infrastructure/logging/EventLogger.java

@@ -309,6 +309,12 @@ public void executionLayerStubEnabled() {
         Color.RED);
   }
 
+  public void depositContractLogsSyncingDisabled() {
+    warn(
+        "Deposit contract logs syncing from the Execution Client has been disabled! You WILL not be able to produce blocks.",
+        Color.YELLOW);
+  }
+
   public void builderBidNotHonouringGasLimit(
       final UInt64 parentGasLimit, final UInt64 proposedGasLimit, final UInt64 preferredGasLimit) {
     String reorgEventLog =

services/powchain/src/main/java/tech/pegasys/teku/services/powchain/PowchainConfiguration.java

@@ -31,6 +31,7 @@ public class PowchainConfiguration {
   public static final int DEFAULT_ETH1_LOGS_MAX_BLOCK_RANGE = 10_000;
   public static final boolean DEFAULT_USE_MISSING_DEPOSIT_EVENT_LOGGING = false;
   public static final boolean DEFAULT_DEPOSIT_SNAPSHOT_ENABLED = true;
+  public static final boolean DEFAULT_DEPOSIT_CONTRACT_LOGS_SYNCING_ENABLED = true;
   public static final String DEPOSIT_SNAPSHOT_URL_PATH = "/eth/v1/beacon/deposit_snapshot";
 
   private final Spec spec;
@@ -40,6 +41,7 @@ public class PowchainConfiguration {
   private final DepositTreeSnapshotConfiguration depositTreeSnapshotConfiguration;
   private final int eth1LogsMaxBlockRange;
   private final boolean useMissingDepositEventLogging;
+  private final boolean depositContractLogsSyncingEnabled;
 
   private PowchainConfiguration(
       final Spec spec,
@@ -48,14 +50,16 @@ private PowchainConfiguration(
       final Optional<UInt64> depositContractDeployBlock,
       final DepositTreeSnapshotConfiguration depositTreeSnapshotConfiguration,
       final int eth1LogsMaxBlockRange,
-      final boolean useMissingDepositEventLogging) {
+      final boolean useMissingDepositEventLogging,
+      final boolean depositContractLogsSyncingEnabled) {
     this.spec = spec;
     this.eth1Endpoints = eth1Endpoints;
     this.depositContract = depositContract;
     this.depositContractDeployBlock = depositContractDeployBlock;
     this.depositTreeSnapshotConfiguration = depositTreeSnapshotConfiguration;
     this.eth1LogsMaxBlockRange = eth1LogsMaxBlockRange;
     this.useMissingDepositEventLogging = useMissingDepositEventLogging;
+    this.depositContractLogsSyncingEnabled = depositContractLogsSyncingEnabled;
   }
 
   public static Builder builder() {
@@ -94,6 +98,10 @@ public boolean useMissingDepositEventLogging() {
     return useMissingDepositEventLogging;
   }
 
+  public boolean isDepositContractLogsSyncingEnabled() {
+    return depositContractLogsSyncingEnabled;
+  }
+
   public static class Builder {
     private Spec spec;
     private List<String> eth1Endpoints = new ArrayList<>();
@@ -105,6 +113,8 @@ public static class Builder {
     private int eth1LogsMaxBlockRange = DEFAULT_ETH1_LOGS_MAX_BLOCK_RANGE;
     private boolean useMissingDepositEventLogging = DEFAULT_USE_MISSING_DEPOSIT_EVENT_LOGGING;
     private boolean depositSnapshotEnabled = DEFAULT_DEPOSIT_SNAPSHOT_ENABLED;
+    private boolean depositContractLogsSyncingEnabled =
+        DEFAULT_DEPOSIT_CONTRACT_LOGS_SYNCING_ENABLED;
 
     private Builder() {}
 
@@ -125,7 +135,8 @@ public PowchainConfiguration build() {
               bundledDepositSnapshotPath,
               isBundledSnapshotEnabled),
           eth1LogsMaxBlockRange,
-          useMissingDepositEventLogging);
+          useMissingDepositEventLogging,
+          depositContractLogsSyncingEnabled);
     }
 
     private void validate() {
@@ -211,6 +222,12 @@ public Builder depositSnapshotEnabled(final boolean depositSnapshotEnabled) {
       return this;
     }
 
+    public Builder depositContractLogsSyncingEnabled(
+        final boolean depositContractLogsSyncingEnabled) {
+      this.depositContractLogsSyncingEnabled = depositContractLogsSyncingEnabled;
+      return this;
+    }
+
     public Builder eth1LogsMaxBlockRange(final int eth1LogsMaxBlockRange) {
       if (eth1LogsMaxBlockRange < 0) {
         throw new InvalidConfigurationException(

teku/src/main/java/tech/pegasys/teku/cli/options/DepositOptions.java

@@ -68,6 +68,18 @@ public class DepositOptions {
       fallbackValue = "true")
   private boolean depositSnapshotEnabled = PowchainConfiguration.DEFAULT_DEPOSIT_SNAPSHOT_ENABLED;
 
+  @Option(
+      names = {"--Xdeposit-contract-logs-syncing-enabled"},
+      paramLabel = "<BOOLEAN>",
+      description =
+          "Enable syncing of deposit contract logs from the Execution Engine node. This is required for block production.",
+      hidden = true,
+      showDefaultValue = Visibility.ALWAYS,
+      arity = "0..1",
+      fallbackValue = "true")
+  private boolean depositContractLogsSyncingEnabled =
+      PowchainConfiguration.DEFAULT_DEPOSIT_CONTRACT_LOGS_SYNCING_ENABLED;
+
   public void configure(final TekuConfiguration.Builder builder) {
     builder.powchain(
         b -> {
@@ -76,6 +88,7 @@ public void configure(final TekuConfiguration.Builder builder) {
           b.useMissingDepositEventLogging(useMissingDepositEventLogging);
           b.customDepositSnapshotPath(depositSnapshotPath);
           b.depositSnapshotEnabled(depositSnapshotEnabled);
+          b.depositContractLogsSyncingEnabled(depositContractLogsSyncingEnabled);
         });
   }
 }

teku/src/main/java/tech/pegasys/teku/services/BeaconNodeServiceController.java

@@ -13,6 +13,8 @@
 
 package tech.pegasys.teku.services;
 
+import static tech.pegasys.teku.infrastructure.logging.EventLogger.EVENT_LOG;
+
 import java.util.Optional;
 import java.util.function.Supplier;
 import tech.pegasys.teku.config.TekuConfiguration;
@@ -98,6 +100,12 @@ private Optional<PowchainService> powchainService(
         || (!tekuConfig.powchain().isEnabled() && maybeExecutionWeb3jClientProvider.isEmpty())) {
       return Optional.empty();
     }
+    if (!tekuConfig.powchain().isDepositContractLogsSyncingEnabled()) {
+      // PowchainService is only used for deposit contract logs syncing, so no need to initialize it
+      // if disabled
+      EVENT_LOG.depositContractLogsSyncingDisabled();
+      return Optional.empty();
+    }
     final PowchainService powchainService =
         new PowchainService(
             serviceConfig,

teku/src/test/java/tech/pegasys/teku/cli/options/DepositOptionsTest.java

@@ -183,4 +183,11 @@ public void shouldSetCheckpointSyncDepositSnapshotUrlWhenUsingCheckpointSyncUrl(
     assertThat(depositTreeSnapshotConfiguration.getCustomDepositSnapshotPath())
         .hasValue("/foo/bar");
   }
+
+  @Test
+  public void shouldHaveDepositContractLogsSyncingEnabledByDefault() {
+    final String[] args = {};
+    final TekuConfiguration config = getTekuConfigurationFromArguments(args);
+    assertThat(config.powchain().isDepositContractLogsSyncingEnabled()).isTrue();
+  }
 }