Add network support for ephemery testnet

CHANGELOG.md

@@ -91,6 +91,7 @@ https://github.com/hyperledger/besu/releases/download/24.8.0/besu-24.8.0.zip / s
 - `--Xbonsai-parallel-tx-processing-enabled` option enables executing transactions in parallel during block processing for Bonsai nodes
 - Reduce default trie log pruning window size from 30,000 to 5,000 [#7365](https://github.com/hyperledger/besu/pull/7365)
 - Add option `--poa-discovery-retry-bootnodes` for PoA networks to always use bootnodes during peer refresh, not just on first start [#7314](https://github.com/hyperledger/besu/pull/7314)
+- Add network support for Ephemery Testnet [#7471](https://github.com/hyperledger/besu/pull/7471)
 
 ### Bug fixes
 - Fix `eth_call` deserialization to correctly ignore unknown fields in the transaction object. [#7323](https://github.com/hyperledger/besu/pull/7323)

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

@@ -19,6 +19,7 @@
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
 import static org.hyperledger.besu.cli.DefaultCommandValues.getDefaultBesuDataPath;
+import static org.hyperledger.besu.cli.config.NetworkName.EPHEMERY;
 import static org.hyperledger.besu.cli.config.NetworkName.MAINNET;
 import static org.hyperledger.besu.cli.util.CommandLineUtils.DEPENDENCY_WARNING_MSG;
 import static org.hyperledger.besu.cli.util.CommandLineUtils.isOptionSet;
@@ -196,6 +197,7 @@
 import org.hyperledger.besu.services.TransactionSelectionServiceImpl;
 import org.hyperledger.besu.services.TransactionSimulationServiceImpl;
 import org.hyperledger.besu.services.kvstore.InMemoryStoragePlugin;
+import org.hyperledger.besu.util.EphemeryGenesisFile;
 import org.hyperledger.besu.util.InvalidConfigurationException;
 import org.hyperledger.besu.util.LogConfigurator;
 import org.hyperledger.besu.util.NetworkUtility;
@@ -864,6 +866,7 @@ static class PrivacyOptionGroup {
   private Collection<EnodeURL> staticNodes;
   private BesuController besuController;
   private BesuConfigurationImpl pluginCommonConfiguration;
+  private EphemeryGenesisFile ephemeryGenesisFile;
 
   private BesuComponent besuComponent;
   private final Supplier<ObservableMetricsSystem> metricsSystem =
@@ -1090,6 +1093,11 @@ public void run() {
     if (network != null && network.isDeprecated()) {
       logger.warn(NetworkDeprecationMessage.generate(network));
     }
+    if (network.equals(EPHEMERY)) {
+      ephemeryGenesisFile =
+          new EphemeryGenesisFile(readGenesisConfigFile(), readGenesisConfigOptions());
+      ephemeryGenesisFile.updateGenesis();
+    }
     try {
       configureLogging(true);
 

besu/src/main/java/org/hyperledger/besu/cli/config/NetworkName.java

@@ -31,6 +31,12 @@ public enum NetworkName {
   /** LUKSO mainnet network name. */
   LUKSO("/lukso.json", BigInteger.valueOf(42)),
 
+  /**
+   * EPHEMERY network name. The networkId is the default networkId that will be used to make update
+   * to the most recent networkId.
+   */
+  EPHEMERY("/ephemery.json", BigInteger.valueOf(39438135)),
+
   /** Dev network name. */
   DEV("/dev.json", BigInteger.valueOf(2018), false),
   /** Future EIPs network name. */
@@ -43,7 +49,7 @@ public enum NetworkName {
   MORDOR("/mordor.json", BigInteger.valueOf(7));
 
   private final String genesisFile;
-  private final BigInteger networkId;
+  private BigInteger networkId;
   private final boolean canSnapSync;
   private final String deprecationDate;
 
@@ -77,6 +83,17 @@ public BigInteger getNetworkId() {
     return networkId;
   }
 
+  /**
+   * This method is called only by the Ephemery network. It is required to update the networkid.
+   *
+   * @param networkId Sets network id .
+   */
+  public void setNetworkId(final BigInteger networkId) {
+    if (this == EPHEMERY) {
+      this.networkId = networkId;
+    }
+  }
+
   /**
    * Can SNAP sync boolean.
    *

besu/src/main/java/org/hyperledger/besu/util/EphemeryGenesisFile.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright contributors to Hyperledger Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.util;
+
+import static org.hyperledger.besu.cli.config.NetworkName.EPHEMERY;
+
+import org.hyperledger.besu.config.GenesisConfigFile;
+import org.hyperledger.besu.config.GenesisConfigOptions;
+
+import java.io.IOException;
+import java.math.BigInteger;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * The Generate Ephemery Genesis File. Checks for update based on the set period and update the
+ * Ephemery genesis file in memory
+ */
+public class EphemeryGenesisFile {
+  private final GenesisConfigFile genesisConfigFile;
+  private final GenesisConfigOptions genesisConfigOptions;
+  private static final int PERIOD = 28;
+  private static final long PERIOD_IN_SECONDS = (PERIOD * 24 * 60 * 60);
+
+  /**
+   * Instantiates a new Generate Ephemery genesis file.
+   *
+   * @param genesisConfigFile the Genesis Config File
+   * @param genesisConfigOptions the Genesis Config Options
+   */
+  public EphemeryGenesisFile(
+      final GenesisConfigFile genesisConfigFile, final GenesisConfigOptions genesisConfigOptions) {
+    this.genesisConfigFile = genesisConfigFile;
+    this.genesisConfigOptions = genesisConfigOptions;
+  }
+
+  public void updateGenesis() {
+    try {
+      if (EPHEMERY.getGenesisFile() == null || genesisConfigOptions == null) {
+        throw new IOException("Genesis file or config options are null");
+      }
+
+      long genesisTimestamp = genesisConfigFile.getTimestamp();
+      Optional<BigInteger> genesisChainId = genesisConfigOptions.getChainId();
+      long currentTimestamp = Instant.now().getEpochSecond();
+      long periodsSinceGenesis =
+          ChronoUnit.DAYS.between(Instant.ofEpochSecond(genesisTimestamp), Instant.now()) / PERIOD;
+
+      long updatedTimestamp = genesisTimestamp + (periodsSinceGenesis * PERIOD_IN_SECONDS);
+      BigInteger updatedChainId =
+          genesisChainId
+              .orElseThrow(() -> new IllegalStateException("ChainId not present"))
+              .add(BigInteger.valueOf(periodsSinceGenesis));
+
+      if (currentTimestamp > (genesisTimestamp + PERIOD_IN_SECONDS)) {
+        EPHEMERY.setNetworkId(updatedChainId);
+        Map<String, String> overrides = new HashMap<>();
+        overrides.put("chainId", String.valueOf(updatedChainId));
+        overrides.put("timestamp", String.valueOf(updatedTimestamp));
+        genesisConfigFile.withOverrides(overrides);
+      }
+    } catch (IOException e) {
+      throw new RuntimeException("Error updating genesis file: " + e.getMessage(), e);
+    }
+  }
+}

besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java

@@ -19,6 +19,7 @@
 import static org.hamcrest.Matchers.is;
 import static org.hyperledger.besu.cli.config.NetworkName.CLASSIC;
 import static org.hyperledger.besu.cli.config.NetworkName.DEV;
+import static org.hyperledger.besu.cli.config.NetworkName.EPHEMERY;
 import static org.hyperledger.besu.cli.config.NetworkName.EXPERIMENTAL_EIPS;
 import static org.hyperledger.besu.cli.config.NetworkName.FUTURE_EIPS;
 import static org.hyperledger.besu.cli.config.NetworkName.HOLESKY;
@@ -339,8 +340,9 @@ public void callingWithConfigOptionButInvalidContentTomlFileShouldDisplayHelp()
     parseCommand("--config-file", tempConfigFile.toString());
 
     final String expectedOutputStart =
-        "Invalid TOML configuration: org.apache.tuweni.toml.TomlParseError: Unexpected '.', expected a-z, A-Z, 0-9, ', \", a table key, "
-            + "a newline, or end-of-input (line 1, column 1)";
+        "Invalid TOML configuration: org.apache.tuweni.toml.TomlParseError: Unexpected '.',"
+            + " expected a-z, A-Z, 0-9, ', \", a table key, a newline, or end-of-input (line 1,"
+            + " column 1)";
     assertThat(commandErrorOutput.toString(UTF_8)).startsWith(expectedOutputStart);
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
   }
@@ -367,8 +369,9 @@ public void callingWithConfigOptionButInvalidValueTomlFileShouldDisplayHelp() th
     parseCommand("--config-file", tempConfigFile.toString());
 
     final String expectedOutputStart =
-        "Invalid TOML configuration: org.apache.tuweni.toml.TomlParseError: Unexpected '=', expected ', \", ''', \"\"\", a number, "
-            + "a boolean, a date/time, an array, or a table (line 1, column 8)";
+        "Invalid TOML configuration: org.apache.tuweni.toml.TomlParseError: Unexpected '=',"
+            + " expected ', \", ''', \"\"\", a number, a boolean, a date/time, an array, or a table"
+            + " (line 1, column 8)";
     assertThat(commandErrorOutput.toString(UTF_8)).startsWith(expectedOutputStart);
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
   }
@@ -1184,7 +1187,8 @@ public void syncMode_invalid() {
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "Invalid value for option '--sync-mode': expected one of [FULL, FAST, SNAP, CHECKPOINT] (case-insensitive) but was 'bogus'");
+            "Invalid value for option '--sync-mode': expected one of [FULL, FAST, SNAP, CHECKPOINT]"
+                + " (case-insensitive) but was 'bogus'");
   }
 
   @Test
@@ -1340,7 +1344,9 @@ public void ethStatsContactOptionCannotBeUsedWithoutEthStatsServerProvided() {
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "The `--ethstats-contact` requires ethstats server URL to be provided. Either remove --ethstats-contact or provide a URL (via --ethstats=nodename:secret@host:port)");
+            "The `--ethstats-contact` requires ethstats server URL to be provided. Either remove"
+                + " --ethstats-contact or provide a URL (via"
+                + " --ethstats=nodename:secret@host:port)");
   }
 
   @Test
@@ -1450,7 +1456,8 @@ public void dnsUpdateEnabledOptionCannotBeUsedWithoutDnsEnabled() {
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "The `--Xdns-update-enabled` requires dns to be enabled. Either remove --Xdns-update-enabled or specify dns is enabled (--Xdns-enabled)");
+            "The `--Xdns-update-enabled` requires dns to be enabled. Either remove"
+                + " --Xdns-update-enabled or specify dns is enabled (--Xdns-enabled)");
   }
 
   @Test
@@ -1862,6 +1869,22 @@ public void luksoValuesAreUsed() {
     assertThat(commandErrorOutput.toString(UTF_8)).isEmpty();
   }
 
+  @Test
+  public void ephemeryValuesAreUsed() {
+    parseCommand("--network", "ephemery");
+
+    final ArgumentCaptor<EthNetworkConfig> networkArg =
+        ArgumentCaptor.forClass(EthNetworkConfig.class);
+
+    verify(mockControllerBuilderFactory).fromEthNetworkConfig(networkArg.capture(), any());
+    verify(mockControllerBuilder).build();
+
+    assertThat(networkArg.getValue()).isEqualTo(EthNetworkConfig.getNetworkConfig(EPHEMERY));
+
+    assertThat(commandOutput.toString(UTF_8)).isEmpty();
+    assertThat(commandErrorOutput.toString(UTF_8)).isEmpty();
+  }
+
   @Test
   public void classicValuesAreUsed() {
     parseCommand("--network", "classic");
@@ -2232,7 +2255,8 @@ public void assertThatCheckPortClashRejectsAsExpectedForEngineApi() throws Excep
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "Port number '8545' has been specified multiple times. Please review the supplied configuration.");
+            "Port number '8545' has been specified multiple times. Please review the supplied"
+                + " configuration.");
   }
 
   @Test
@@ -2337,7 +2361,8 @@ public void logsWarningWhenFailToLoadJemalloc() {
     verify(mockLogger)
         .warn(
             eq(
-                "BESU_USING_JEMALLOC is present but we failed to load jemalloc library to get the version"),
+                "BESU_USING_JEMALLOC is present but we failed to load jemalloc library to get the"
+                    + " version"),
             any(Throwable.class));
   }
 
@@ -2383,7 +2408,8 @@ public void checkpointPostMergeShouldFailWhenGenesisUsesCheckpointFromPreMerge()
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "PoS checkpoint sync requires a block with total difficulty greater or equal than the TTD");
+            "PoS checkpoint sync requires a block with total difficulty greater or equal than the"
+                + " TTD");
   }
 
   @Test
@@ -2517,7 +2543,8 @@ public void snapsyncForHealingFeaturesShouldFailWhenHealingIsNotEnabled() {
         "100");
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "--Xsnapsync-synchronizer-flat option can only be used when --Xbonsai-full-flat-db-enabled is true");
+            "--Xsnapsync-synchronizer-flat option can only be used when"
+                + " --Xbonsai-full-flat-db-enabled is true");
 
     parseCommand(
         "--Xbonsai-full-flat-db-enabled",
@@ -2526,7 +2553,8 @@ public void snapsyncForHealingFeaturesShouldFailWhenHealingIsNotEnabled() {
         "100");
     assertThat(commandErrorOutput.toString(UTF_8))
         .contains(
-            "--Xsnapsync-synchronizer-flat option can only be used when --Xbonsai-full-flat-db-enabled is true");
+            "--Xsnapsync-synchronizer-flat option can only be used when"
+                + " --Xbonsai-full-flat-db-enabled is true");
   }
 
   @Test

besu/src/test/java/org/hyperledger/besu/cli/NetworkDeprecationMessageTest.java

@@ -39,9 +39,7 @@ void shouldGenerateDeprecationMessageForDeprecatedNetworks(final NetworkName net
   @ParameterizedTest
   @EnumSource(
       value = NetworkName.class,
-      names = {
-        "MAINNET", "SEPOLIA", "DEV", "CLASSIC", "MORDOR", "HOLESKY", "LUKSO",
-      })
+      names = {"MAINNET", "SEPOLIA", "DEV", "CLASSIC", "MORDOR", "HOLESKY", "LUKSO", "EPHEMERY"})
   void shouldThrowErrorForNonDeprecatedNetworks(final NetworkName network) {
     assertThatThrownBy(() -> NetworkDeprecationMessage.generate(network))
         .isInstanceOf(AssertionError.class);