mirror of https://github.com/hyperledger/besu
[Issue 3115] Support mining beneficiary transitions (#3505)
Signed-off-by: Meredith Baxter <meredith.baxter@palm.io>pull/3433/head
mbaxter
3 years ago
committed by
GitHub
parent
6947a6c34d
commit
6efdd94a69
@ -0,0 +1,130 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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.config; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static org.assertj.core.api.Assertions.assertThatThrownBy; |
||||
|
||||
import org.hyperledger.besu.datatypes.Address; |
||||
|
||||
import java.util.Collections; |
||||
import java.util.Map; |
||||
|
||||
import com.fasterxml.jackson.databind.node.ObjectNode; |
||||
import org.junit.Test; |
||||
|
||||
public class BFTForkTest { |
||||
private final String BENEFICIARY = "0x1111111111111111111111111111111111111111"; |
||||
private final String TRUNCATED_BENEFICIARY = BENEFICIARY.substring(0, BENEFICIARY.length() - 2); |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_fromEmptyConfig() { |
||||
ObjectNode config = JsonUtil.objectNodeFromMap(Collections.emptyMap()); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.getMiningBeneficiary()).isEmpty(); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withValidAddress() { |
||||
ObjectNode config = |
||||
JsonUtil.objectNodeFromMap(Map.of(BftFork.MINING_BENEFICIARY_KEY, BENEFICIARY)); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.getMiningBeneficiary().map(Address::toHexString)).contains(BENEFICIARY); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withValidAddressMissingPrefix() { |
||||
ObjectNode config = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.MINING_BENEFICIARY_KEY, BENEFICIARY.substring(2))); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.getMiningBeneficiary().map(Address::toHexString)).contains(BENEFICIARY); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withValidAddressAndEmptySpace() { |
||||
ObjectNode config = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.MINING_BENEFICIARY_KEY, "\t" + BENEFICIARY + " ")); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.getMiningBeneficiary().map(Address::toHexString)).contains(BENEFICIARY); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withInvalidValue() { |
||||
final String beneficiary = "random"; |
||||
testGetMiningBeneficiaryWithInvalidAddress(beneficiary); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withInvalidAddress() { |
||||
testGetMiningBeneficiaryWithInvalidAddress(TRUNCATED_BENEFICIARY); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_withInvalidAddressAndWhitespace() { |
||||
final String beneficiary = TRUNCATED_BENEFICIARY + " "; |
||||
testGetMiningBeneficiaryWithInvalidAddress(beneficiary); |
||||
} |
||||
|
||||
private void testGetMiningBeneficiaryWithInvalidAddress(final String miningBeneficiary) { |
||||
ObjectNode config = |
||||
JsonUtil.objectNodeFromMap(Map.of(BftFork.MINING_BENEFICIARY_KEY, miningBeneficiary)); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThatThrownBy(bftFork::getMiningBeneficiary) |
||||
.isInstanceOf(IllegalArgumentException.class) |
||||
.hasMessageContaining( |
||||
"Mining beneficiary in transition config is not a valid ethereum address"); |
||||
} |
||||
|
||||
@Test |
||||
public void getMiningBeneficiary_whenEmptyValueIsProvided() { |
||||
ObjectNode config = JsonUtil.objectNodeFromMap(Map.of(BftFork.MINING_BENEFICIARY_KEY, " ")); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.getMiningBeneficiary()).isEmpty(); |
||||
} |
||||
|
||||
@Test |
||||
public void isMiningBeneficiaryConfigured_noKeySet() { |
||||
final String jsonStr = "{}"; |
||||
final ObjectNode config = JsonUtil.objectNodeFromString(jsonStr); |
||||
final BftFork bftFork = new BftFork(config); |
||||
|
||||
assertThat(bftFork.isMiningBeneficiaryConfigured()).isFalse(); |
||||
} |
||||
|
||||
@Test |
||||
public void isMiningBeneficiaryConfigured_whenEmptyValueIsProvided() { |
||||
ObjectNode config = JsonUtil.objectNodeFromMap(Map.of(BftFork.MINING_BENEFICIARY_KEY, "")); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.isMiningBeneficiaryConfigured()).isTrue(); |
||||
} |
||||
|
||||
@Test |
||||
public void isMiningBeneficiaryConfigured_whenNonEmptyValueIsProvided() { |
||||
ObjectNode config = |
||||
JsonUtil.objectNodeFromMap(Map.of(BftFork.MINING_BENEFICIARY_KEY, BENEFICIARY)); |
||||
|
||||
final BftFork bftFork = new BftFork(config); |
||||
assertThat(bftFork.isMiningBeneficiaryConfigured()).isTrue(); |
||||
} |
||||
} |
||||
@ -0,0 +1,182 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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.consensus.common.bft; |
||||
|
||||
import static org.assertj.core.api.AssertionsForClassTypes.assertThat; |
||||
import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy; |
||||
|
||||
import org.hyperledger.besu.config.BftConfigOptions; |
||||
import org.hyperledger.besu.config.BftFork; |
||||
import org.hyperledger.besu.config.GenesisConfigOptions; |
||||
import org.hyperledger.besu.config.JsonUtil; |
||||
import org.hyperledger.besu.consensus.common.ForkSpec; |
||||
import org.hyperledger.besu.consensus.common.ForksSchedule; |
||||
import org.hyperledger.besu.datatypes.Address; |
||||
|
||||
import java.util.Map; |
||||
import java.util.Optional; |
||||
import java.util.function.Consumer; |
||||
|
||||
import com.fasterxml.jackson.databind.node.ObjectNode; |
||||
import org.junit.Test; |
||||
|
||||
public abstract class BaseForksSchedulesFactoryTest< |
||||
C extends BftConfigOptions, M extends MutableBftConfigOptions> { |
||||
|
||||
@Test |
||||
public void createsScheduleForJustGenesisConfig() { |
||||
final C configOptions = createBftOptions(); |
||||
final ForkSpec<C> expectedForkSpec = new ForkSpec<>(0, createBftOptions()); |
||||
final GenesisConfigOptions genesisConfigOptions = createGenesisConfig(configOptions); |
||||
|
||||
final ForksSchedule<C> forksSchedule = createForkSchedule(genesisConfigOptions); |
||||
assertThat(forksSchedule.getFork(0)).usingRecursiveComparison().isEqualTo(expectedForkSpec); |
||||
assertThat(forksSchedule.getFork(1)).usingRecursiveComparison().isEqualTo(expectedForkSpec); |
||||
assertThat(forksSchedule.getFork(2)).usingRecursiveComparison().isEqualTo(expectedForkSpec); |
||||
} |
||||
|
||||
@Test |
||||
public void createsScheduleThatChangesMiningBeneficiary_beneficiaryInitiallyEmpty() { |
||||
final Address beneficiaryAddress = |
||||
Address.fromHexString("0x1111111111111111111111111111111111111111"); |
||||
final C qbftConfigOptions = createBftOptions(); |
||||
|
||||
final ObjectNode forkWithBeneficiary = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of( |
||||
BftFork.FORK_BLOCK_KEY, |
||||
1, |
||||
BftFork.MINING_BENEFICIARY_KEY, |
||||
beneficiaryAddress.toHexString())); |
||||
final ObjectNode forkWithNoBeneficiary = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 2, BftFork.MINING_BENEFICIARY_KEY, "")); |
||||
|
||||
final GenesisConfigOptions genesisConfigOptions = |
||||
createGenesisConfig(qbftConfigOptions, forkWithBeneficiary, forkWithNoBeneficiary); |
||||
final ForksSchedule<C> forksSchedule = createForkSchedule(genesisConfigOptions); |
||||
|
||||
assertThat(forksSchedule.getFork(0).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(1).getValue().getMiningBeneficiary()) |
||||
.contains(beneficiaryAddress); |
||||
assertThat(forksSchedule.getFork(2).getValue().getMiningBeneficiary()).isEmpty(); |
||||
} |
||||
|
||||
@Test |
||||
public void createsScheduleThatChangesMiningBeneficiary_beneficiaryInitiallyNonEmpty() { |
||||
final Address beneficiaryAddress = |
||||
Address.fromHexString("0x1111111111111111111111111111111111111111"); |
||||
final Address beneficiaryAddress2 = Address.fromHexString("0x02"); |
||||
final C qbftConfigOptions = |
||||
createBftOptions(o -> o.setMiningBeneficiary(Optional.of(beneficiaryAddress))); |
||||
|
||||
final ObjectNode forkWithBeneficiary = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 1, BftFork.MINING_BENEFICIARY_KEY, "")); |
||||
final ObjectNode forkWithNoBeneficiary = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of( |
||||
BftFork.FORK_BLOCK_KEY, |
||||
2, |
||||
BftFork.MINING_BENEFICIARY_KEY, |
||||
beneficiaryAddress2.toUnprefixedHexString())); |
||||
|
||||
final GenesisConfigOptions genesisConfigOptions = |
||||
createGenesisConfig(qbftConfigOptions, forkWithBeneficiary, forkWithNoBeneficiary); |
||||
final ForksSchedule<C> forksSchedule = createForkSchedule(genesisConfigOptions); |
||||
|
||||
assertThat(forksSchedule.getFork(0).getValue().getMiningBeneficiary()) |
||||
.contains(beneficiaryAddress); |
||||
assertThat(forksSchedule.getFork(1).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(2).getValue().getMiningBeneficiary()) |
||||
.contains(beneficiaryAddress2); |
||||
} |
||||
|
||||
@Test |
||||
public void |
||||
createsScheduleThatChangesMiningBeneficiary_shouldNotModifyBeneficiaryUnlessExplicitlyConfigured() { |
||||
final Address initialBeneficiaryAddress = |
||||
Address.fromHexString("0x1111111111111111111111111111111111111111"); |
||||
final Address beneficiaryAddress2 = Address.fromHexString("0x02"); |
||||
final C qbftConfigOptions = |
||||
createBftOptions(o -> o.setMiningBeneficiary(Optional.of(initialBeneficiaryAddress))); |
||||
|
||||
ObjectNode[] forks = { |
||||
// No change to beneficiary
|
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 1, BftFork.BLOCK_PERIOD_SECONDS_KEY, 2)), |
||||
// Clear beneficiary
|
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 3, BftFork.MINING_BENEFICIARY_KEY, "")), |
||||
// No change to beneficiary
|
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 5, BftFork.BLOCK_PERIOD_SECONDS_KEY, 4)), |
||||
// Set beneficiary
|
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of( |
||||
BftFork.FORK_BLOCK_KEY, |
||||
7, |
||||
BftFork.MINING_BENEFICIARY_KEY, |
||||
beneficiaryAddress2.toUnprefixedHexString())) |
||||
}; |
||||
|
||||
final GenesisConfigOptions genesisConfigOptions = createGenesisConfig(qbftConfigOptions, forks); |
||||
final ForksSchedule<C> forksSchedule = createForkSchedule(genesisConfigOptions); |
||||
|
||||
assertThat(forksSchedule.getFork(0).getValue().getMiningBeneficiary()) |
||||
.contains(initialBeneficiaryAddress); |
||||
assertThat(forksSchedule.getFork(1).getValue().getMiningBeneficiary()) |
||||
.contains(initialBeneficiaryAddress); |
||||
assertThat(forksSchedule.getFork(2).getValue().getMiningBeneficiary()) |
||||
.contains(initialBeneficiaryAddress); |
||||
assertThat(forksSchedule.getFork(3).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(4).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(5).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(6).getValue().getMiningBeneficiary()).isEmpty(); |
||||
assertThat(forksSchedule.getFork(7).getValue().getMiningBeneficiary()) |
||||
.contains(beneficiaryAddress2); |
||||
assertThat(forksSchedule.getFork(8).getValue().getMiningBeneficiary()) |
||||
.contains(beneficiaryAddress2); |
||||
} |
||||
|
||||
@Test |
||||
public void createsScheduleWithInvalidMiningBeneficiary_shouldThrow() { |
||||
final C qbftConfigOptions = createBftOptions(); |
||||
|
||||
final ObjectNode invalidFork = |
||||
JsonUtil.objectNodeFromMap( |
||||
Map.of(BftFork.FORK_BLOCK_KEY, 1, BftFork.MINING_BENEFICIARY_KEY, "bla")); |
||||
|
||||
final GenesisConfigOptions genesisConfigOptions = |
||||
createGenesisConfig(qbftConfigOptions, invalidFork); |
||||
|
||||
assertThatThrownBy(() -> createForkSchedule(genesisConfigOptions)) |
||||
.isInstanceOf(IllegalArgumentException.class) |
||||
.hasMessageContaining( |
||||
"Mining beneficiary in transition config is not a valid ethereum address"); |
||||
} |
||||
|
||||
protected abstract C createBftOptions(final Consumer<M> optionModifier); |
||||
|
||||
protected C createBftOptions() { |
||||
return createBftOptions(__ -> {}); |
||||
} |
||||
|
||||
protected abstract GenesisConfigOptions createGenesisConfig( |
||||
final C configOptions, final ObjectNode... forks); |
||||
|
||||
protected abstract ForksSchedule<C> createForkSchedule( |
||||
final GenesisConfigOptions genesisConfigOptions); |
||||
} |
||||
Loading…
Reference in new issue