7536 use head for snap sync

CHANGELOG.md

@@ -18,7 +18,8 @@
 - Add configuration of Consolidation Request Contract Address via genesis configuration [#7647](https://github.com/hyperledger/besu/pull/7647)
 - Interrupt pending transaction processing on block creation timeout [#7673](https://github.com/hyperledger/besu/pull/7673)
 - Align gas cap calculation for transaction simulation to Geth approach [#7703](https://github.com/hyperledger/besu/pull/7703)
-- Expose chainId in the `BlockchainService` [#7702](https://github.com/hyperledger/besu/pull/7702)
+- Expose chainId in the `BlockchainService` [7702](https://github.com/hyperledger/besu/pull/7702)
+- Use head block instead of safe block for snap sync [7536](https://github.com/hyperledger/besu/issues/7536)
 - Add support for `chainId` in `CallParameters` [#7720](https://github.com/hyperledger/besu/pull/7720)
 
 ### Bug fixes

besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java

@@ -2738,6 +2738,7 @@ && getDataStorageConfiguration().getBonsaiLimitTrieLogsEnabled()) {
 
     builder.setSnapServerEnabled(this.unstableSynchronizerOptions.isSnapsyncServerEnabled());
     builder.setSnapSyncBftEnabled(this.unstableSynchronizerOptions.isSnapSyncBftEnabled());
+    builder.setSnapSyncToHeadEnabled(this.unstableSynchronizerOptions.isSnapSyncToHeadEnabled());
 
     builder.setTxPoolImplementation(buildTransactionPoolConfiguration().getTxPoolImplementation());
     builder.setWorldStateUpdateMode(unstableEvmOptions.toDomainObject().worldUpdaterMode());

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

@@ -57,6 +57,7 @@ public class ConfigurationOverviewBuilder {
   private Integer trieLogsPruningWindowSize = null;
   private boolean isSnapServerEnabled = false;
   private boolean isSnapSyncBftEnabled = false;
+  private boolean isSnapSyncToHeadEnabled = true;
   private TransactionPoolConfiguration.Implementation txPoolImplementation;
   private EvmConfiguration.WorldUpdaterMode worldStateUpdateMode;
   private Map<String, String> environment;
@@ -245,6 +246,18 @@ public ConfigurationOverviewBuilder setSnapSyncBftEnabled(final boolean snapSync
     return this;
   }
 
+  /**
+   * Sets snap sync to head enabled/disabled
+   *
+   * @param snapSyncToHeadEnabled bool to indicate if snap sync to head is enabled
+   * @return the builder
+   */
+  public ConfigurationOverviewBuilder setSnapSyncToHeadEnabled(
+      final boolean snapSyncToHeadEnabled) {
+    isSnapSyncToHeadEnabled = snapSyncToHeadEnabled;
+    return this;
+  }
+
   /**
    * Sets trie logs pruning window size
    *
@@ -373,6 +386,10 @@ public String build() {
       lines.add("Experimental Snap Sync for BFT enabled");
     }
 
+    if (isSnapSyncToHeadEnabled) {
+      lines.add("Snap Sync to Head enabled");
+    }
+
     if (isBonsaiLimitTrieLogsEnabled) {
       final StringBuilder trieLogPruningString = new StringBuilder();
       trieLogPruningString

besu/src/main/java/org/hyperledger/besu/cli/options/unstable/SynchronizerOptions.java

@@ -87,6 +87,8 @@ public class SynchronizerOptions implements CLIOptions<SynchronizerConfiguration
 
   private static final String SNAP_SYNC_BFT_ENABLED_FLAG = "--Xsnapsync-bft-enabled";
 
+  private static final String SNAP_SYNC_TO_HEAD_ENABLED_FLAG = "--Xsnapsync-to-head-enabled";
+
   /**
    * Parse block propagation range.
    *
@@ -314,6 +316,15 @@ public void parseBlockPropagationRange(final String arg) {
       description = "Snap sync enabled for BFT chains (default: ${DEFAULT-VALUE})")
   private Boolean snapsyncBftEnabled = SnapSyncConfiguration.DEFAULT_SNAP_SYNC_BFT_ENABLED;
 
+  @CommandLine.Option(
+      names = SNAP_SYNC_TO_HEAD_ENABLED_FLAG,
+      hidden = true,
+      paramLabel = "<Boolean>",
+      arity = "0..1",
+      description = "Snap sync to head enabled (default: ${DEFAULT-VALUE})")
+  private Boolean snapsyncToHeadEnabled =
+      SnapSyncConfiguration.DEFAULT_SNAP_SYNC_TO_HEAD_ENABLED_FLAG;
+
   @CommandLine.Option(
       names = {"--Xpeertask-system-enabled"},
       hidden = true,
@@ -341,6 +352,15 @@ public boolean isSnapSyncBftEnabled() {
     return snapsyncBftEnabled;
   }
 
+  /**
+   * Flag to know if Snap sync should sync to head instead of safe block
+   *
+   * @return true if snap sync should sync to head
+   */
+  public boolean isSnapSyncToHeadEnabled() {
+    return snapsyncToHeadEnabled;
+  }
+
   /**
    * Flag to indicate whether the peer task system should be used where available
    *
@@ -401,6 +421,7 @@ public static SynchronizerOptions fromConfig(final SynchronizerConfiguration con
     options.checkpointPostMergeSyncEnabled = config.isCheckpointPostMergeEnabled();
     options.snapsyncServerEnabled = config.getSnapSyncConfiguration().isSnapServerEnabled();
     options.snapsyncBftEnabled = config.getSnapSyncConfiguration().isSnapSyncBftEnabled();
+    options.snapsyncToHeadEnabled = config.getSnapSyncConfiguration().isSnapSyncToHeadEnabled();
     return options;
   }
 
@@ -434,6 +455,7 @@ public SynchronizerConfiguration.Builder toDomainObject() {
             .localFlatStorageCountToHealPerRequest(snapsyncFlatStorageHealedCountPerRequest)
             .isSnapServerEnabled(snapsyncServerEnabled)
             .isSnapSyncBftEnabled(snapsyncBftEnabled)
+            .isSnapSyncToHeadEnabled(snapsyncToHeadEnabled)
             .build());
     builder.checkpointPostMergeEnabled(checkpointPostMergeSyncEnabled);
     builder.isPeerTaskSystemEnabled(isPeerTaskSystemEnabled);
@@ -493,7 +515,9 @@ public List<String> getCLIOptions() {
             SNAP_SERVER_ENABLED_FLAG,
             OptionParser.format(snapsyncServerEnabled),
             SNAP_SYNC_BFT_ENABLED_FLAG,
-            OptionParser.format(snapsyncBftEnabled));
+            OptionParser.format(snapsyncBftEnabled),
+            SNAP_SYNC_TO_HEAD_ENABLED_FLAG,
+            OptionParser.format(snapsyncToHeadEnabled));
     return value;
   }
 }

besu/src/main/java/org/hyperledger/besu/controller/BesuControllerBuilder.java

@@ -65,6 +65,7 @@
 import org.hyperledger.besu.ethereum.eth.sync.PivotBlockSelector;
 import org.hyperledger.besu.ethereum.eth.sync.SyncMode;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
+import org.hyperledger.besu.ethereum.eth.sync.fastsync.PivotSelectorFromHeadBlock;
 import org.hyperledger.besu.ethereum.eth.sync.fastsync.PivotSelectorFromPeers;
 import org.hyperledger.besu.ethereum.eth.sync.fastsync.PivotSelectorFromSafeBlock;
 import org.hyperledger.besu.ethereum.eth.sync.fastsync.checkpoint.Checkpoint;
@@ -890,14 +891,27 @@ private PivotBlockSelector createPivotSelector(
             LOG.info("Initial sync done, unsubscribe forkchoice supplier");
           };
 
-      return new PivotSelectorFromSafeBlock(
-          protocolContext,
-          protocolSchedule,
-          ethContext,
-          metricsSystem,
-          genesisConfigOptions,
-          unverifiedForkchoiceSupplier,
-          unsubscribeForkchoiceListener);
+      if (syncConfig.getSnapSyncConfiguration().isSnapSyncToHeadEnabled()) {
+        LOG.info("Using head block for sync.");
+        return new PivotSelectorFromHeadBlock(
+            protocolContext,
+            protocolSchedule,
+            ethContext,
+            metricsSystem,
+            genesisConfigOptions,
+            unverifiedForkchoiceSupplier,
+            unsubscribeForkchoiceListener);
+      } else {
+        LOG.info("Using safe block for sync.");
+        return new PivotSelectorFromSafeBlock(
+            protocolContext,
+            protocolSchedule,
+            ethContext,
+            metricsSystem,
+            genesisConfigOptions,
+            unverifiedForkchoiceSupplier,
+            unsubscribeForkchoiceListener);
+      }
     } else {
       LOG.info("TTD difficulty is not present, creating initial sync phase for PoW");
       return new PivotSelectorFromPeers(ethContext, syncConfig, syncState, metricsSystem);

besu/src/test/java/org/hyperledger/besu/controller/MergeBesuControllerBuilderTest.java

@@ -45,6 +45,8 @@
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.eth.EthProtocolConfiguration;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
+import org.hyperledger.besu.ethereum.eth.sync.fastsync.PivotSelectorFromHeadBlock;
+import org.hyperledger.besu.ethereum.eth.sync.fastsync.PivotSelectorFromSafeBlock;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockHeaderFunctions;
 import org.hyperledger.besu.ethereum.mainnet.feemarket.BaseFeeMarket;
@@ -74,12 +76,15 @@
 import org.apache.tuweni.bytes.Bytes;
 import org.apache.tuweni.bytes.Bytes32;
 import org.apache.tuweni.units.bigints.UInt256;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.io.TempDir;
 import org.mockito.Answers;
 import org.mockito.Mock;
+import org.mockito.MockedConstruction;
+import org.mockito.Mockito;
 import org.mockito.junit.jupiter.MockitoExtension;
 
 @ExtendWith(MockitoExtension.class)
@@ -90,7 +95,10 @@ public class MergeBesuControllerBuilderTest {
 
   @Mock GenesisConfigFile genesisConfigFile;
   @Mock GenesisConfigOptions genesisConfigOptions;
-  @Mock SynchronizerConfiguration synchronizerConfiguration;
+
+  @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+  SynchronizerConfiguration synchronizerConfiguration;
+
   @Mock EthProtocolConfiguration ethProtocolConfiguration;
   @Mock CheckpointConfigOptions checkpointConfigOptions;
 
@@ -146,6 +154,9 @@ public void setup() {
     lenient().when(synchronizerConfiguration.getDownloaderParallelism()).thenReturn(1);
     lenient().when(synchronizerConfiguration.getTransactionsParallelism()).thenReturn(1);
     lenient().when(synchronizerConfiguration.getComputationParallelism()).thenReturn(1);
+    lenient()
+        .when(synchronizerConfiguration.getSnapSyncConfiguration().isSnapSyncToHeadEnabled())
+        .thenReturn(false);
 
     lenient()
         .when(synchronizerConfiguration.getBlockPropagationRange())
@@ -291,6 +302,32 @@ public void assertFinalizedBlockIsPresentWhenStored() {
     assertThat(mergeContext.getFinalized().get()).isEqualTo(finalizedHeader);
   }
 
+  @Test
+  public void assertPivotSelectorFromSafeBlockIsCreated() {
+    MockedConstruction<PivotSelectorFromSafeBlock> mocked =
+        Mockito.mockConstruction(PivotSelectorFromSafeBlock.class);
+    lenient()
+        .when(synchronizerConfiguration.getSnapSyncConfiguration().isSnapSyncToHeadEnabled())
+        .thenReturn(false);
+
+    visitWithMockConfigs(new MergeBesuControllerBuilder()).build();
+
+    Assertions.assertEquals(1, mocked.constructed().size());
+  }
+
+  @Test
+  public void assertPivotSelectorFromHeadBlockIsCreated() {
+    MockedConstruction<PivotSelectorFromHeadBlock> mocked =
+        Mockito.mockConstruction(PivotSelectorFromHeadBlock.class);
+    lenient()
+        .when(synchronizerConfiguration.getSnapSyncConfiguration().isSnapSyncToHeadEnabled())
+        .thenReturn(true);
+
+    visitWithMockConfigs(new MergeBesuControllerBuilder()).build();
+
+    Assertions.assertEquals(1, mocked.constructed().size());
+  }
+
   private BlockHeader finalizedBlockHeader() {
     final long blockNumber = 42;
     final Hash magicHash = Hash.wrap(Bytes32.leftPad(Bytes.ofUnsignedInt(42)));