Add ephemery network config

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [Unreleased]
+- Added `--ephemery` network support for Ephemery Testnet [#7563](https://github.com/hyperledger/besu/pull/7563) thanks to [@gconnect](https://github.com/gconnect)
 
 ### Upcoming Breaking Changes
 
@@ -4440,6 +4441,15 @@ Specify `*` or `all` for `--host-whitelist` to effectively disable host protecti
  - Added `--banned-nodeids` option to prevent connection to specific nodes (PR [#254](https://github.com/PegaSysEng/pantheon/pull/254))
  - Send client quitting disconnect message to peers on shutdown (PR [#253](https://github.com/PegaSysEng/pantheon/pull/253))
  - Improved error message for port conflict error (PR [#232](https://github.com/PegaSysEng/pantheon/pull/232))
+ - Improved documentation by adding the following pages:
+    * [Getting Started](https://github.com/PegaSysEng/pantheon/wiki/Getting-Started)
+    * [Network ID and Chain ID](https://github.com/PegaSysEng/pantheon/wiki/NetworkID-And-ChainID)
+    * [Node Keys](https://github.com/PegaSysEng/pantheon/wiki/Node-Keys)
+    * [Networking](https://github.com/PegaSysEng/pantheon/wiki/Networking)
+    * [Accounts for Testing](https://github.com/PegaSysEng/pantheon/wiki/Accounts-for-Testing)
+    * [Logging](https://github.com/PegaSysEng/pantheon/wiki/Logging)
+    * [Proof of Authority](https://github.com/PegaSysEng/pantheon/wiki/Proof-of-Authority)
+    * [Passing JVM Options](https://github.com/PegaSysEng/pantheon/wiki/Passing-JVM-Options)
 
 
  ### Technical Improvements

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;
@@ -195,6 +196,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;
@@ -1651,11 +1653,14 @@ private void validateChainDataPruningParams() {
   }
 
   private GenesisConfigFile readGenesisConfigFile() {
-    final GenesisConfigFile effectiveGenesisFile =
-        genesisFile != null
-            ? GenesisConfigFile.fromSource(genesisConfigSource(genesisFile))
-            : GenesisConfigFile.fromResource(
-                Optional.ofNullable(network).orElse(MAINNET).getGenesisFile());
+    GenesisConfigFile effectiveGenesisFile;
+    effectiveGenesisFile =
+        network.equals(EPHEMERY)
+            ? EphemeryGenesisFile.updateGenesis(genesisConfigOverrides)
+            : genesisFile != null
+                ? GenesisConfigFile.fromSource(genesisConfigSource(genesisFile))
+                : GenesisConfigFile.fromResource(
+                    Optional.ofNullable(network).orElse(MAINNET).getGenesisFile());
     return effectiveGenesisFile.withOverrides(genesisConfigOverrides);
   }
 

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;
 
@@ -68,6 +74,17 @@ public String getGenesisFile() {
     return genesisFile;
   }
 
+  /**
+   * 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;
+    }
+  }
+
   /**
    * Gets network id.
    *

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

@@ -0,0 +1,66 @@
+/*
+ * 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 java.io.IOException;
+import java.math.BigInteger;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+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 static final int PERIOD = 28;
+  private static final long PERIOD_IN_SECONDS = (PERIOD * 24 * 60 * 60);
+
+  public static GenesisConfigFile updateGenesis(final Map<String, String> overrides)
+      throws RuntimeException {
+    GenesisConfigFile genesisConfigFile;
+    try {
+      if (EPHEMERY.getGenesisFile() == null) {
+        throw new IOException("Genesis file or config options are null");
+      }
+      genesisConfigFile = GenesisConfigFile.fromResource(EPHEMERY.getGenesisFile());
+      long genesisTimestamp = genesisConfigFile.getTimestamp();
+      Optional<BigInteger> genesisChainId = genesisConfigFile.getConfigOptions().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)) {
+        overrides.put("chainId", String.valueOf(updatedChainId));
+        overrides.put("timestamp", String.valueOf(updatedTimestamp));
+        genesisConfigFile = genesisConfigFile.withOverrides(overrides);
+      }
+      return 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;
@@ -1862,6 +1863,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");

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);

besu/src/test/java/org/hyperledger/besu/util/EphemeryGenesisFileTest.java

@@ -0,0 +1,136 @@
+/*
+ * 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.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.hyperledger.besu.cli.config.NetworkName.EPHEMERY;
+import static org.hyperledger.besu.config.GenesisConfigFile.fromConfig;
+
+import org.hyperledger.besu.config.GenesisConfigFile;
+
+import java.math.BigInteger;
+import java.util.Map;
+import java.util.Optional;
+import java.util.TreeMap;
+
+import io.vertx.core.json.JsonObject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+@ExtendWith(MockitoExtension.class)
+public class EphemeryGenesisFileTest {
+  private static final int GENESIS_CONFIG_TEST_CHAINID = 39438135;
+  private static final long GENESIS_TEST_TIMESTAMP = 1720119600;
+  private static final long CURRENT_TIMESTAMP = 1712041200;
+  private static final long CURRENT_TIMESTAMP_HIGHER = 1922041200;
+  private static final long PERIOD_IN_SECONDS = 28 * 24 * 60 * 60;
+  private static final long PERIOD_SINCE_GENESIS = 3;
+
+  private static final JsonObject VALID_GENESIS_JSON =
+      (new JsonObject())
+          .put("config", (new JsonObject()).put("chainId", GENESIS_CONFIG_TEST_CHAINID))
+          .put("timestamp", GENESIS_TEST_TIMESTAMP);
+
+  private static final GenesisConfigFile INVALID_GENESIS_JSON = fromConfig("{}");
+  private static final JsonObject INVALID_GENESIS_JSON_WITHOUT_CHAINID =
+      (new JsonObject()).put("timestamp", GENESIS_TEST_TIMESTAMP);
+
+  private static final JsonObject INVALID_GENESIS_JSON_WITHOUT_TIMESTAMP =
+      new JsonObject()
+          .put("config", (new JsonObject()).put("chainId", GENESIS_CONFIG_TEST_CHAINID));
+
+  @Test
+  public void testEphemeryWhenChainIdIsAbsent() {
+    final GenesisConfigFile config =
+        GenesisConfigFile.fromConfig(INVALID_GENESIS_JSON_WITHOUT_CHAINID.toString());
+    Optional<BigInteger> chainId = config.getConfigOptions().getChainId();
+    assertThat(chainId).isNotPresent();
+  }
+
+  @Test
+  public void testShouldDefaultTimestampToZero() {
+    final GenesisConfigFile config =
+        GenesisConfigFile.fromConfig(INVALID_GENESIS_JSON_WITHOUT_TIMESTAMP.toString());
+    assertThat(config.getTimestamp()).isZero();
+  }
+
+  @Test
+  public void testEphemeryWhenGenesisJsonIsInvalid() {
+    assertThatThrownBy(INVALID_GENESIS_JSON::getDifficulty)
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessageContaining("Invalid genesis block configuration");
+  }
+
+  @Test
+  public void testEphemeryWhenGenesisJsonIsValid() {
+    final GenesisConfigFile config = GenesisConfigFile.fromConfig(VALID_GENESIS_JSON.toString());
+    assertThat(String.valueOf(config.getTimestamp())).isNotNull();
+    assertThat(String.valueOf(config.getTimestamp())).isNotEmpty();
+    assertThat(String.valueOf(config.getConfigOptions().getChainId())).isNotNull();
+    assertThat(String.valueOf(config.getConfigOptions().getChainId())).isNotEmpty();
+  }
+
+  @Test
+  public void testEphemeryNotYetDueForUpdate() {
+    final GenesisConfigFile config = GenesisConfigFile.fromConfig(VALID_GENESIS_JSON.toString());
+    assertThat(CURRENT_TIMESTAMP).isLessThan(config.getTimestamp() + PERIOD_IN_SECONDS);
+  }
+
+  @Test
+  void testOverrideWithUpdatedChainIdAndTimeStamp() {
+    BigInteger expectedChainId =
+        BigInteger.valueOf(GENESIS_CONFIG_TEST_CHAINID)
+            .add(BigInteger.valueOf(PERIOD_SINCE_GENESIS));
+
+    long expectedGenesisTimestamp =
+        GENESIS_TEST_TIMESTAMP + (PERIOD_SINCE_GENESIS * PERIOD_IN_SECONDS);
+
+    final GenesisConfigFile config = GenesisConfigFile.fromResource("/ephemery.json");
+
+    final Map<String, String> override = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
+    override.put("chainId", String.valueOf(expectedChainId));
+    override.put("timestamp", String.valueOf(expectedGenesisTimestamp));
+
+    assertThat(config.withOverrides(override).getConfigOptions().getChainId()).isPresent();
+    assertThat(config.withOverrides(override).getTimestamp()).isNotNull();
+  }
+
+  @Test
+  public void testEphemeryWhenSuccessful() {
+    final GenesisConfigFile config = GenesisConfigFile.fromConfig(VALID_GENESIS_JSON.toString());
+
+    BigInteger expectedChainId =
+        BigInteger.valueOf(GENESIS_CONFIG_TEST_CHAINID)
+            .add(BigInteger.valueOf(PERIOD_SINCE_GENESIS));
+
+    long expectedGenesisTimestamp =
+        GENESIS_TEST_TIMESTAMP + (PERIOD_SINCE_GENESIS * PERIOD_IN_SECONDS);
+
+    EPHEMERY.setNetworkId(expectedChainId);
+
+    final Map<String, String> override = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
+    override.put("chainId", String.valueOf(expectedChainId));
+    override.put("timestamp", String.valueOf(expectedGenesisTimestamp));
+    config.withOverrides(override);
+
+    assertThat(CURRENT_TIMESTAMP_HIGHER)
+        .isGreaterThan(Long.parseLong(String.valueOf(GENESIS_TEST_TIMESTAMP + PERIOD_IN_SECONDS)));
+
+    assertThat(override.get("timestamp")).isEqualTo(String.valueOf(expectedGenesisTimestamp));
+    assertThat(override.get("chainId")).isEqualTo(expectedChainId.toString());
+  }
+}