coinbase is an updatable parameter

Signed-off-by: Fabio Di Fabio <[email protected]>
fab-10 · Oct 17, 2023 · 2be8c7d · 2be8c7d
1 parent c6b56d2
commit 2be8c7d
Show file tree

Hide file tree

Showing 29 changed files with 90 additions and 102 deletions.
diff --git a/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java b/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java
@@ -30,6 +30,7 @@
 import org.hyperledger.besu.ethereum.api.tls.FileBasedPasswordProvider;
 import org.hyperledger.besu.ethereum.core.AddressHelpers;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters;
+import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.UpdatableInitValues;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.p2p.config.NetworkingConfiguration;
@@ -56,7 +57,10 @@ public class BesuNodeConfigurationBuilder {
   private String name;
   private Optional<Path> dataPath = Optional.empty();
   private MiningParameters miningParameters =
-      ImmutableMiningParameters.builder().coinbase(AddressHelpers.ofValue(1)).build();
+      ImmutableMiningParameters.builder()
+          .updatableInitValues(
+              UpdatableInitValues.builder().coinbase(AddressHelpers.ofValue(1)).build())
+          .build();
 
   private JsonRpcConfiguration jsonRpcConfiguration = JsonRpcConfiguration.createDefault();
   private JsonRpcConfiguration engineRpcConfiguration = JsonRpcConfiguration.createEngineDefault();

diff --git a/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java b/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java
@@ -310,8 +310,8 @@ public BesuNode createNodeWithMultiTenantedPrivacy(
                 UpdatableInitValues.builder()
                     .isMiningEnabled(true)
                     .minTransactionGasPrice(Wei.ZERO)
+                    .coinbase(AddressHelpers.ofValue(1))
                     .build())
-            .coinbase(AddressHelpers.ofValue(1))
             .build();
 
     return create(

diff --git a/...ests/src/test/java/org/hyperledger/besu/tests/acceptance/bft/BftMiningAcceptanceTest.java b/...ests/src/test/java/org/hyperledger/besu/tests/acceptance/bft/BftMiningAcceptanceTest.java
@@ -66,8 +66,8 @@ public void shouldMineOnSingleNodeWithFreeGas_Berlin() throws Exception {
                 UpdatableInitValues.builder()
                     .isMiningEnabled(true)
                     .minTransactionGasPrice(Wei.ZERO)
+                    .coinbase(AddressHelpers.ofValue(1))
                     .build())
-            .coinbase(AddressHelpers.ofValue(1))
             .build();
     minerNode.setMiningParameters(zeroGasMiningParams);
 

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/options/stable/MiningOptions.java b/besu/src/main/java/org/hyperledger/besu/cli/options/stable/MiningOptions.java
@@ -30,6 +30,7 @@
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.datatypes.Wei;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters;
+import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.UpdatableInitValues;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 
 import java.util.List;
@@ -262,7 +263,7 @@ static MiningOptions fromConfig(final MiningParameters miningParameters) {
   @Override
   public MiningParameters toDomainObject() {
     final var updatableInitValuesBuilder =
-        ImmutableMiningParameters.UpdatableInitValues.builder()
+        UpdatableInitValues.builder()
             .isMiningEnabled(isMiningEnabled)
             .extraData(extraData)
             .minTransactionGasPrice(minTransactionGasPrice)
@@ -271,6 +272,9 @@ public MiningParameters toDomainObject() {
     if (targetGasLimit != null) {
       updatableInitValuesBuilder.targetGasLimit(targetGasLimit);
     }
+    if (coinbase != null) {
+      updatableInitValuesBuilder.coinbase(coinbase);
+    }
 
     final var miningParametersBuilder =
         ImmutableMiningParameters.builder()
@@ -290,10 +294,6 @@ public MiningParameters toDomainObject() {
                         unstableOptions.posBlockCreationRepetitionMinDuration)
                     .build());
 
-    if (coinbase != null) {
-      miningParametersBuilder.coinbase(coinbase);
-    }
-
     return miningParametersBuilder.build();
   }
 

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/subcommands/blocks/BlocksSubCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/subcommands/blocks/BlocksSubCommand.java
@@ -275,8 +275,8 @@ private MiningParameters getMiningParameters() {
                   .nonceGenerator(new IncrementingNonceGenerator(0))
                   .extraData(extraData)
                   .minTransactionGasPrice(minTransactionGasPrice)
+                  .coinbase(coinbase)
                   .build())
-          .coinbase(coinbase)
           .build();
     }
 

diff --git a/besu/src/main/java/org/hyperledger/besu/controller/IbftBesuControllerBuilder.java b/besu/src/main/java/org/hyperledger/besu/controller/IbftBesuControllerBuilder.java
@@ -145,6 +145,7 @@ protected MiningCoordinator createMiningCoordinator(
 
     final Address localAddress = Util.publicKeyToAddress(nodeKey.getPublicKey());
     final BftProtocolSchedule bftProtocolSchedule = (BftProtocolSchedule) protocolSchedule;
+    miningParameters.setCoinbase(localAddress);
     final BftBlockCreatorFactory<?> blockCreatorFactory =
         new BftBlockCreatorFactory<>(
             transactionPool,

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java b/besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java
@@ -71,6 +71,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.ethereum.api.tls.TlsConfiguration;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters;
+import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.UpdatableInitValues;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.eth.sync.SyncMode;
@@ -902,7 +903,10 @@ public void envVariableOverridesValueFromConfigFile() {
     verify(mockControllerBuilder)
         .miningParameters(
             ImmutableMiningParameters.builder()
-                .coinbase(Address.fromHexString(expectedCoinbase))
+                .updatableInitValues(
+                    UpdatableInitValues.builder()
+                        .coinbase(Address.fromHexString(expectedCoinbase))
+                        .build())
                 .build());
   }
 
@@ -916,7 +920,10 @@ public void cliOptionOverridesEnvVariableAndConfig() {
     verify(mockControllerBuilder)
         .miningParameters(
             ImmutableMiningParameters.builder()
-                .coinbase(Address.fromHexString(expectedCoinbase))
+                .updatableInitValues(
+                    UpdatableInitValues.builder()
+                        .coinbase(Address.fromHexString(expectedCoinbase))
+                        .build())
                 .build());
   }
 

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/options/stable/MiningOptionsTest.java b/besu/src/test/java/org/hyperledger/besu/cli/options/stable/MiningOptionsTest.java
@@ -322,8 +322,8 @@ protected MiningParameters createCustomizedDomainObject() {
                 .isMiningEnabled(true)
                 .extraData(Bytes.fromHexString("0xabc321"))
                 .minBlockOccupancyRatio(0.5)
+                .coinbase(Address.ZERO)
                 .build())
-        .coinbase(Address.ZERO)
         .isStratumMiningEnabled(true)
         .unstable(Unstable.builder().posBlockCreationMaxTime(1000).build())
         .build();

diff --git a/...src/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreator.java b/...src/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreator.java
@@ -23,7 +23,6 @@
 import org.hyperledger.besu.consensus.common.EpochManager;
 import org.hyperledger.besu.consensus.common.validator.ValidatorVote;
 import org.hyperledger.besu.cryptoservices.NodeKey;
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.ethereum.ProtocolContext;
 import org.hyperledger.besu.ethereum.blockcreation.AbstractBlockCreator;
@@ -49,7 +48,6 @@ public class CliqueBlockCreator extends AbstractBlockCreator {
    * Instantiates a new Clique block creator.
    *
    * @param miningParameters the mining parameters
-   * @param coinbase the coinbase
    * @param extraDataCalculator the extra data calculator
    * @param transactionPool the pending transactions
    * @param protocolContext the protocol context
@@ -60,7 +58,6 @@ public class CliqueBlockCreator extends AbstractBlockCreator {
    */
   public CliqueBlockCreator(
       final MiningParameters miningParameters,
-      final Address coinbase,
       final ExtraDataCalculator extraDataCalculator,
       final TransactionPool transactionPool,
       final ProtocolContext protocolContext,
@@ -70,7 +67,6 @@ public CliqueBlockCreator(
       final EpochManager epochManager) {
     super(
         miningParameters,
-        coinbase,
         __ -> Util.publicKeyToAddress(nodeKey.getPublicKey()),
         extraDataCalculator,
         transactionPool,

diff --git a/...rc/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutor.java b/...rc/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutor.java
@@ -71,6 +71,7 @@ public CliqueMinerExecutor(
     this.nodeKey = nodeKey;
     this.localAddress = Util.publicKeyToAddress(nodeKey.getPublicKey());
     this.epochManager = epochManager;
+    miningParams.setCoinbase(localAddress);
   }
 
   @Override
@@ -82,7 +83,6 @@ public CliqueBlockMiner createMiner(
         (header) ->
             new CliqueBlockCreator(
                 miningParameters,
-                localAddress, // TOOD(tmm): This can be removed (used for voting not coinbase).
                 this::calculateExtraData,
                 transactionPool,
                 protocolContext,
@@ -103,7 +103,7 @@ public CliqueBlockMiner createMiner(
 
   @Override
   public Optional<Address> getCoinbase() {
-    return Optional.of(localAddress);
+    return miningParameters.getCoinbase();
   }
 
   /**

diff --git a/...test/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreatorTest.java b/...test/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreatorTest.java
@@ -141,7 +141,6 @@ public void proposerAddressCanBeExtractFromAConstructedBlock() {
     final CliqueBlockCreator blockCreator =
         new CliqueBlockCreator(
             miningParameters,
-            coinbase,
             parent -> extraData,
             createTransactionPool(),
             protocolContext,
@@ -170,7 +169,6 @@ public void insertsValidVoteIntoConstructedBlock() {
     final CliqueBlockCreator blockCreator =
         new CliqueBlockCreator(
             miningParameters,
-            coinbase,
             parent -> extraData,
             createTransactionPool(),
             protocolContext,
@@ -204,7 +202,6 @@ public void insertsNoVoteWhenAtEpoch() {
     final CliqueBlockCreator blockCreator =
         new CliqueBlockCreator(
             miningParameters,
-            coinbase,
             parent -> extraData,
             createTransactionPool(),
             protocolContext,
@@ -252,8 +249,8 @@ private static MiningParameters createMiningParameters(
                     .extraData(extraData)
                     .targetGasLimit(10_000_000L)
                     .minTransactionGasPrice(Wei.ZERO)
+                    .coinbase(coinbase)
                     .build())
-            .coinbase(coinbase)
             .build();
     return miningParameters;
   }

diff --git a/...est/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutorTest.java b/...est/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutorTest.java
@@ -240,8 +240,8 @@ private static MiningParameters createMiningParameters(final Bytes vanityData) {
             UpdatableInitValues.builder()
                 .extraData(vanityData)
                 .minTransactionGasPrice(Wei.ZERO)
+                .coinbase(AddressHelpers.ofValue(1))
                 .build())
-        .coinbase(AddressHelpers.ofValue(1))
         .build();
   }
 }
diff --git a/...rc/main/java/org/hyperledger/besu/consensus/common/bft/blockcreation/BftBlockCreator.java b/...rc/main/java/org/hyperledger/besu/consensus/common/bft/blockcreation/BftBlockCreator.java
@@ -63,7 +63,6 @@ public BftBlockCreator(
       final BftExtraDataCodec bftExtraDataCodec) {
     super(
         miningParameters,
-        localAddress,
         miningBeneficiaryCalculator(localAddress, forksSchedule),
         extraDataCalculator,
         transactionPool,

diff --git a/...integration-test/java/org/hyperledger/besu/consensus/ibft/support/TestContextBuilder.java b/...integration-test/java/org/hyperledger/besu/consensus/ibft/support/TestContextBuilder.java
@@ -312,8 +312,8 @@ private static ControllerAndState createControllerAndFinalState(
                     .isMiningEnabled(true)
                     .minTransactionGasPrice(Wei.ZERO)
                     .extraData(Bytes.wrap("Ibft Int tests".getBytes(UTF_8)))
+                    .coinbase(AddressHelpers.ofValue(1))
                     .build())
-            .coinbase(AddressHelpers.ofValue(1))
             .build();
 
     final StubGenesisConfigOptions genesisConfigOptions = new StubGenesisConfigOptions();

diff --git a/.../src/test/java/org/hyperledger/besu/consensus/ibft/blockcreation/BftBlockCreatorTest.java b/.../src/test/java/org/hyperledger/besu/consensus/ibft/blockcreation/BftBlockCreatorTest.java
@@ -165,8 +165,8 @@ public BlockHeaderValidator.Builder createBlockHeaderRuleset(
                                 0,
                                 initialValidatorList)))
                     .minTransactionGasPrice(Wei.ZERO)
+                    .coinbase(AddressHelpers.ofValue(1))
                     .build())
-            .coinbase(AddressHelpers.ofValue(1))
             .build();
 
     final BftBlockCreator blockCreator =

diff --git a/...e/src/main/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeBlockCreator.java b/...e/src/main/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeBlockCreator.java
@@ -44,7 +44,6 @@ class MergeBlockCreator extends AbstractBlockCreator {
    * @param transactionPool the pending transactions
    * @param protocolContext the protocol context
    * @param protocolSchedule the protocol schedule
-   * @param miningBeneficiary the mining beneficiary
    * @param parentHeader the parent header
    */
   public MergeBlockCreator(
@@ -53,13 +52,11 @@ public MergeBlockCreator(
       final TransactionPool transactionPool,
       final ProtocolContext protocolContext,
       final ProtocolSchedule protocolSchedule,
-      final Address miningBeneficiary,
       final BlockHeader parentHeader,
       final Optional<Address> depositContractAddress) {
     super(
         miningParameters,
-        miningBeneficiary,
-        __ -> miningBeneficiary,
+        __ -> miningParameters.getCoinbase().orElseThrow(),
         extraDataCalculator,
         transactionPool,
         protocolContext,

diff --git a/...ge/src/main/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeCoordinator.java b/...ge/src/main/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeCoordinator.java
@@ -118,6 +118,9 @@ public MergeCoordinator(
     this.mergeContext = protocolContext.getConsensusContext(MergeContext.class);
     this.backwardSyncContext = backwardSyncContext;
 
+    if (miningParams.getCoinbase().isEmpty()) {
+      miningParams.setCoinbase(Address.ZERO);
+    }
     if (miningParams.getTargetGasLimit().isEmpty()) {
       miningParams.setTargetGasLimit(30000000L);
     }
@@ -133,7 +136,6 @@ public MergeCoordinator(
                 transactionPool,
                 protocolContext,
                 protocolSchedule,
-                address.or(miningParameters::getCoinbase).orElse(Address.ZERO),
                 parentHeader,
                 depositContractAddress);
 

diff --git a/...rc/test/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeCoordinatorTest.java b/...rc/test/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeCoordinatorTest.java
@@ -57,6 +57,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeaderTestFixture;
 import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters;
+import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.Unstable;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.UpdatableInitValues;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.TransactionTestFixture;
@@ -134,9 +135,9 @@ public class MergeCoordinatorTest implements MergeGenesisConfigHelper {
 
   MiningParameters miningParameters =
       ImmutableMiningParameters.builder()
-          .coinbase(coinbase)
+          .updatableInitValues(UpdatableInitValues.builder().coinbase(coinbase).build())
           .unstable(
-              ImmutableMiningParameters.Unstable.builder()
+              Unstable.builder()
                   .posBlockCreationRepetitionMinDuration(REPETITION_MIN_DURATION)
                   .build())
           .build();
@@ -285,7 +286,6 @@ public void exceptionDuringBuildingBlockShouldNotBeInvalid()
                       transactionPool,
                       protocolContext,
                       protocolSchedule,
-                      address.or(miningParameters::getCoinbase).orElse(Address.ZERO),
                       parentHeader,
                       Optional.empty()));
 
@@ -551,8 +551,7 @@ public void shouldStopRetryBlockCreationIfTimeExpired() throws InterruptedExcept
     miningParameters =
         ImmutableMiningParameters.builder()
             .from(miningParameters)
-            .unstable(
-                ImmutableMiningParameters.Unstable.builder().posBlockCreationMaxTime(100).build())
+            .unstable(Unstable.builder().posBlockCreationMaxTime(100).build())
             .build();
     doAnswer(
             invocation -> {

diff --git a/...erge/src/test/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeReorgTest.java b/...erge/src/test/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeReorgTest.java
@@ -34,6 +34,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeaderTestFixture;
 import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters;
+import org.hyperledger.besu.ethereum.core.ImmutableMiningParameters.UpdatableInitValues;
 import org.hyperledger.besu.ethereum.eth.sync.backwardsync.BackwardSyncContext;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
 import org.hyperledger.besu.ethereum.mainnet.BlockHeaderValidator;
@@ -93,7 +94,9 @@ public void setUp() {
             mockProtocolSchedule,
             CompletableFuture::runAsync,
             mockTransactionPool,
-            ImmutableMiningParameters.builder().coinbase(coinbase).build(),
+            ImmutableMiningParameters.builder()
+                .updatableInitValues(UpdatableInitValues.builder().coinbase(coinbase).build())
+                .build(),
             mock(BackwardSyncContext.class),
             Optional.empty());
     mergeContext.setIsPostMerge(genesisState.getBlock().getHeader().getDifficulty());

diff --git a/...integration-test/java/org/hyperledger/besu/consensus/qbft/support/TestContextBuilder.java b/...integration-test/java/org/hyperledger/besu/consensus/qbft/support/TestContextBuilder.java
@@ -372,8 +372,8 @@ private static ControllerAndState createControllerAndFinalState(
                     .isMiningEnabled(true)
                     .minTransactionGasPrice(Wei.ZERO)
                     .extraData(Bytes.wrap("Qbft Int tests".getBytes(UTF_8)))
+                    .coinbase(AddressHelpers.ofValue(1))
                     .build())
-            .coinbase(AddressHelpers.ofValue(1))
             .build();
 
     final StubGenesisConfigOptions genesisConfigOptions = new StubGenesisConfigOptions();