FullSync Future should stop when total terminal difficulty is reached

Signed-off-by: Jiri Peinlich <jiri.peinlich@gmail.com>
hyperledger · Feb 16, 2022 · 9eb1598 · 9eb1598
1 parent 5643dd9
commit 9eb1598
Show file tree

Hide file tree

Showing 10 changed files with 257 additions and 13 deletions.
diff --git a/besu/src/main/java/org/hyperledger/besu/controller/BesuControllerBuilder.java b/besu/src/main/java/org/hyperledger/besu/controller/BesuControllerBuilder.java
@@ -32,6 +32,7 @@
 import org.hyperledger.besu.ethereum.chain.DefaultBlockchain;
 import org.hyperledger.besu.ethereum.chain.GenesisState;
 import org.hyperledger.besu.ethereum.chain.MutableBlockchain;
+import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Synchronizer;
@@ -371,7 +372,8 @@ public BesuController build() {
  syncState,
  dataDirectory,
  clock,
- metricsSystem);
+ metricsSystem,
+ getTerminalTotalDifficulty());
 
  final MiningCoordinator miningCoordinator =
  createMiningCoordinator(
@@ -416,6 +418,10 @@ public BesuController build() {
  additionalPluginServices);
  }
 
+ protected Optional<Difficulty> getTerminalTotalDifficulty() {
+ return genesisConfig.getConfigOptions().getTerminalTotalDifficulty().map(Difficulty::of);
+ }
+
  protected void prepForBuild() {}
 
  protected JsonRpcMethods createAdditionalJsonRpcMethodFactory(

diff --git a/ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/sync/DefaultSynchronizer.java b/ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/sync/DefaultSynchronizer.java
@@ -17,6 +17,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.core.Synchronizer;
 import org.hyperledger.besu.ethereum.eth.manager.EthContext;
 import org.hyperledger.besu.ethereum.eth.sync.fastsync.FastDownloaderFactory;
@@ -66,7 +67,8 @@ public DefaultSynchronizer(
  final SyncState syncState,
  final Path dataDirectory,
  final Clock clock,
- final MetricsSystem metricsSystem) {
+ final MetricsSystem metricsSystem,
+ final Optional<Difficulty> terminalTotalDifficulty) {
  this.maybePruner = maybePruner;
  this.syncState = syncState;
 
@@ -91,7 +93,13 @@ public DefaultSynchronizer(
 
  this.fullSyncDownloader =
  new FullSyncDownloader(
- syncConfig, protocolSchedule, protocolContext, ethContext, syncState, metricsSystem);
+ syncConfig,
+ protocolSchedule,
+ protocolContext,
+ ethContext,
+ syncState,
+ metricsSystem,
+ terminalTotalDifficulty);
  this.fastSyncDownloader =
  FastDownloaderFactory.create(
  syncConfig,

diff --git a/...rc/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloader.java b/...rc/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloader.java
@@ -15,6 +15,7 @@
 package org.hyperledger.besu.ethereum.eth.sync.fullsync;
 
 import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.eth.manager.EthContext;
 import org.hyperledger.besu.ethereum.eth.sync.ChainDownloader;
 import org.hyperledger.besu.ethereum.eth.sync.PipelineChainDownloader;
@@ -23,6 +24,8 @@
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 
+import java.util.Optional;
+
 public class FullSyncChainDownloader {
  private FullSyncChainDownloader() {}
 
@@ -32,11 +35,17 @@ public static ChainDownloader create(
  final ProtocolContext protocolContext,
  final EthContext ethContext,
  final SyncState syncState,
- final MetricsSystem metricsSystem) {
+ final MetricsSystem metricsSystem,
+ final Optional<Difficulty> terminalTotalDifficulty) {
 
  final FullSyncTargetManager syncTargetManager =
  new FullSyncTargetManager(
- config, protocolSchedule, protocolContext, ethContext, metricsSystem);
+ config,
+ protocolSchedule,
+ protocolContext,
+ ethContext,
+ metricsSystem,
+ terminalTotalDifficulty);
 
  return new PipelineChainDownloader(
  syncState,

diff --git a/...eth/src/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncDownloader.java b/...eth/src/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncDownloader.java
@@ -15,6 +15,7 @@
 package org.hyperledger.besu.ethereum.eth.sync.fullsync;
 
 import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.eth.manager.EthContext;
 import org.hyperledger.besu.ethereum.eth.sync.ChainDownloader;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
@@ -23,6 +24,8 @@
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 
+import java.util.Optional;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -40,14 +43,21 @@ public FullSyncDownloader(
  final ProtocolContext protocolContext,
  final EthContext ethContext,
  final SyncState syncState,
- final MetricsSystem metricsSystem) {
+ final MetricsSystem metricsSystem,
+ final Optional<Difficulty> terminalTotalDifficulty) {
  this.syncConfig = syncConfig;
  this.protocolContext = protocolContext;
  this.syncState = syncState;
 
  this.chainDownloader =
  FullSyncChainDownloader.create(
- syncConfig, protocolSchedule, protocolContext, ethContext, syncState, metricsSystem);
+ syncConfig,
+ protocolSchedule,
+ protocolContext,
+ ethContext,
+ syncState,
+ metricsSystem,
+ terminalTotalDifficulty);
  }
 
  public void start() {

diff --git a/.../src/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncTargetManager.java b/.../src/main/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncTargetManager.java
@@ -19,6 +19,7 @@
 import org.hyperledger.besu.ethereum.ProtocolContext;
 import org.hyperledger.besu.ethereum.chain.MutableBlockchain;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
+import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.eth.manager.EthContext;
 import org.hyperledger.besu.ethereum.eth.manager.EthPeer;
 import org.hyperledger.besu.ethereum.eth.sync.SyncTargetManager;
@@ -39,16 +40,19 @@ class FullSyncTargetManager extends SyncTargetManager {
  private static final Logger LOG = LoggerFactory.getLogger(FullSyncTargetManager.class);
  private final ProtocolContext protocolContext;
  private final EthContext ethContext;
+ private final Optional<Difficulty> terminalTotalDifficulty;
 
  FullSyncTargetManager(
  final SynchronizerConfiguration config,
  final ProtocolSchedule protocolSchedule,
  final ProtocolContext protocolContext,
  final EthContext ethContext,
- final MetricsSystem metricsSystem) {
+ final MetricsSystem metricsSystem,
+ final Optional<Difficulty> terminalTotalDifficulty) {
  super(config, protocolSchedule, protocolContext, ethContext, metricsSystem);
  this.protocolContext = protocolContext;
  this.ethContext = ethContext;
+ this.terminalTotalDifficulty = terminalTotalDifficulty;
  }
 
  @Override
@@ -105,6 +109,9 @@ private boolean isSyncTargetReached(final EthPeer peer) {
 
  @Override
  public boolean shouldContinueDownloading() {
- return true;
+ return terminalTotalDifficulty.isEmpty()
+ || terminalTotalDifficulty
+ .get()
+ .greaterThan(protocolContext.getBlockchain().getChainHead().getTotalDifficulty());
  }
 }
diff --git a/...java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloaderForkTest.java b/...java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloaderForkTest.java
@@ -35,6 +35,8 @@
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 
+import java.util.Optional;
+
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -80,7 +82,13 @@ public void tearDown() {
 
  private ChainDownloader downloader(final SynchronizerConfiguration syncConfig) {
  return FullSyncChainDownloader.create(
- syncConfig, protocolSchedule, protocolContext, ethContext, syncState, metricsSystem);
+ syncConfig,
+ protocolSchedule,
+ protocolContext,
+ ethContext,
+ syncState,
+ metricsSystem,
+ Optional.empty());
  }
 
  private ChainDownloader downloader() {

diff --git a/...est/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloaderTest.java b/...est/java/org/hyperledger/besu/ethereum/eth/sync/fullsync/FullSyncChainDownloaderTest.java
@@ -117,7 +117,13 @@ public void tearDown() {
 
  private ChainDownloader downloader(final SynchronizerConfiguration syncConfig) {
  return FullSyncChainDownloader.create(
- syncConfig, protocolSchedule, protocolContext, ethContext, syncState, metricsSystem);
+ syncConfig,
+ protocolSchedule,
+ protocolContext,
+ ethContext,
+ syncState,
+ metricsSystem,
+ Optional.empty());
  }
 
  private ChainDownloader downloader() {