ReferenceTestProtocolSchedules.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.ethereum.referencetests;

import org.hyperledger.besu.config.GenesisConfigOptions;
import org.hyperledger.besu.config.StubGenesisConfigOptions;
import org.hyperledger.besu.ethereum.chain.BadBlockManager;
import org.hyperledger.besu.ethereum.core.MiningParameters;
import org.hyperledger.besu.ethereum.core.PrivacyParameters;
import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
import org.hyperledger.besu.ethereum.mainnet.ProtocolScheduleBuilder;
import org.hyperledger.besu.ethereum.mainnet.ProtocolSpecAdapters;
import org.hyperledger.besu.evm.internal.EvmConfiguration;
import org.hyperledger.besu.evm.precompile.KZGPointEvalPrecompiledContract;

import java.math.BigInteger;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

import com.google.common.collect.ImmutableMap;

public class ReferenceTestProtocolSchedules {

  private static final BigInteger CHAIN_ID = BigInteger.ONE;

  private static final List<String> SPECS_PRIOR_TO_DELETING_EMPTY_ACCOUNTS =
      Arrays.asList("Frontier", "Homestead", "EIP150");

  public static ReferenceTestProtocolSchedules create() {
    return create(new StubGenesisConfigOptions());
  }

  public static ReferenceTestProtocolSchedules create(final StubGenesisConfigOptions genesisStub) {
    final ImmutableMap.Builder<String, ProtocolSchedule> builder = ImmutableMap.builder();
    builder.put("Frontier", createSchedule(genesisStub.clone()));
    builder.put("FrontierToHomesteadAt5", createSchedule(genesisStub.clone().homesteadBlock(5)));
    builder.put("Homestead", createSchedule(genesisStub.clone().homesteadBlock(0)));
    builder.put(
        "HomesteadToEIP150At5",
        createSchedule(genesisStub.clone().homesteadBlock(0).eip150Block(5)));
    builder.put(
        "HomesteadToDaoAt5", createSchedule(genesisStub.clone().homesteadBlock(0).daoForkBlock(5)));
    builder.put("EIP150", createSchedule(genesisStub.clone().eip150Block(0)));
    builder.put("EIP158", createSchedule(genesisStub.clone().eip158Block(0)));
    builder.put(
        "EIP158ToByzantiumAt5",
        createSchedule(genesisStub.clone().eip158Block(0).byzantiumBlock(5)));
    builder.put("Byzantium", createSchedule(genesisStub.clone().byzantiumBlock(0)));
    builder.put("Constantinople", createSchedule(genesisStub.clone().constantinopleBlock(0)));
    builder.put("ConstantinopleFix", createSchedule(genesisStub.clone().petersburgBlock(0)));
    builder.put("Petersburg", createSchedule(genesisStub.clone().petersburgBlock(0)));
    builder.put("Istanbul", createSchedule(genesisStub.clone().istanbulBlock(0)));
    builder.put("MuirGlacier", createSchedule(genesisStub.clone().muirGlacierBlock(0)));
    builder.put("Berlin", createSchedule(genesisStub.clone().berlinBlock(0)));

    // the following schedules activate EIP-1559, but may have non-default
    if (genesisStub.getBaseFeePerGas().isEmpty()) {
      genesisStub.baseFeePerGas(0x0a);
    }
    builder.put("London", createSchedule(genesisStub.clone().londonBlock(0)));
    builder.put("ArrowGlacier", createSchedule(genesisStub.clone().arrowGlacierBlock(0)));
    builder.put("GrayGlacier", createSchedule(genesisStub.clone().grayGlacierBlock(0)));
    builder.put("Merge", createSchedule(genesisStub.clone().mergeNetSplitBlock(0)));
    builder.put("Paris", createSchedule(genesisStub.clone().mergeNetSplitBlock(0)));
    builder.put("Shanghai", createSchedule(genesisStub.clone().shanghaiTime(0)));
    builder.put(
        "ShanghaiToCancunAtTime15k",
        createSchedule(genesisStub.clone().shanghaiTime(0).cancunTime(15000)));
    builder.put("Cancun", createSchedule(genesisStub.clone().cancunTime(0)));
    // also load KZG file for mainnet
    KZGPointEvalPrecompiledContract.init();
    builder.put("Prague", createSchedule(genesisStub.clone().pragueTime(0)));
    builder.put("Future_EIPs", createSchedule(genesisStub.clone().futureEipsTime(0)));
    builder.put("Experimental_EIPs", createSchedule(genesisStub.clone().experimentalEipsTime(0)));
    return new ReferenceTestProtocolSchedules(builder.build());
  }

  private final Map<String, ProtocolSchedule> schedules;

  private ReferenceTestProtocolSchedules(final Map<String, ProtocolSchedule> schedules) {
    this.schedules = schedules;
  }

  public ProtocolSchedule getByName(final String name) {
    return schedules.get(name);
  }

  private static ProtocolSchedule createSchedule(final GenesisConfigOptions options) {
    return new ProtocolScheduleBuilder(
            options,
            CHAIN_ID,
            ProtocolSpecAdapters.create(0, Function.identity()),
            PrivacyParameters.DEFAULT,
            false,
            EvmConfiguration.DEFAULT,
            MiningParameters.MINING_DISABLED,
            new BadBlockManager())
        .createProtocolSchedule();
  }

  public static boolean shouldClearEmptyAccounts(final String fork) {
    return !SPECS_PRIOR_TO_DELETING_EMPTY_ACCOUNTS.contains(fork);
  }
}