forked from hyperledger/besu
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
post-merge sync and peering fix (hyperledger#4116)
* add a merge-specific definiton of bestPeer and the supporting plumbing Signed-off-by: garyschulte <garyschulte@gmail.com> * set reached TTD when finishing a fast sync if appropriate Signed-off-by: garyschulte <garyschulte@gmail.com> * spdx header Signed-off-by: garyschulte <garyschulte@gmail.com> * fix BetterSyncTargetEvaluatorTest tests Signed-off-by: garyschulte <garyschulte@gmail.com>
- Loading branch information
1 parent
1b2f15f
commit 235bd25
Showing
12 changed files
with
238 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
...erge/src/main/java/org/hyperledger/besu/consensus/merge/TransitionBestPeerComparator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * 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.merge; | ||
|
|
||
| import static org.hyperledger.besu.ethereum.eth.manager.EthPeers.CHAIN_HEIGHT; | ||
|
|
||
| import org.hyperledger.besu.ethereum.core.Difficulty; | ||
| import org.hyperledger.besu.ethereum.eth.manager.EthPeer; | ||
|
|
||
| import java.math.BigInteger; | ||
| import java.util.Comparator; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import java.util.function.BiFunction; | ||
|
|
||
| public class TransitionBestPeerComparator implements Comparator<EthPeer>, MergeStateHandler { | ||
|
|
||
| private static final AtomicReference<Difficulty> terminalTotalDifficulty = | ||
| new AtomicReference<>(); | ||
|
|
||
| static final BiFunction<EthPeer, Difficulty, BigInteger> distanceFromTTD = | ||
| (a, ttd) -> | ||
| a.chainState() | ||
| .getEstimatedTotalDifficulty() | ||
| .getAsBigInteger() | ||
| .subtract(ttd.getAsBigInteger()) | ||
| .abs() | ||
| .negate(); | ||
|
|
||
| public static final Comparator<EthPeer> EXACT_DIFFICULTY = | ||
| (a, b) -> { | ||
| var ttd = terminalTotalDifficulty.get(); | ||
| var aDelta = distanceFromTTD.apply(a, ttd); | ||
| var bDelta = distanceFromTTD.apply(b, ttd); | ||
| return aDelta.compareTo(bDelta); | ||
| }; | ||
|
|
||
| public static final Comparator<EthPeer> BEST_MERGE_CHAIN = | ||
| EXACT_DIFFICULTY.thenComparing(CHAIN_HEIGHT); | ||
|
|
||
| public TransitionBestPeerComparator(final Difficulty configuredTerminalTotalDifficulty) { | ||
| terminalTotalDifficulty.set(configuredTerminalTotalDifficulty); | ||
| } | ||
|
|
||
| @Override | ||
| public void mergeStateChanged( | ||
| final boolean isPoS, final Optional<Difficulty> difficultyStoppedAt) { | ||
| if (isPoS && difficultyStoppedAt.isPresent()) { | ||
| terminalTotalDifficulty.set(difficultyStoppedAt.get()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public int compare(final EthPeer o1, final EthPeer o2) { | ||
| return BEST_MERGE_CHAIN.compare(o1, o2); | ||
| } | ||
| } |
66 changes: 66 additions & 0 deletions
66
.../src/test/java/org/hyperledger/besu/consensus/merge/TransitionBestPeerComparatorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| /* | ||
| * 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.merge; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import org.hyperledger.besu.ethereum.core.Difficulty; | ||
| import org.hyperledger.besu.ethereum.eth.manager.EthPeer; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Answers; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
|
|
||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class TransitionBestPeerComparatorTest { | ||
|
|
||
| @Mock(answer = Answers.RETURNS_DEEP_STUBS) | ||
| EthPeer a; | ||
|
|
||
| @Mock(answer = Answers.RETURNS_DEEP_STUBS) | ||
| EthPeer b; | ||
|
|
||
| @Test | ||
| public void assertDistanceFromTTDPrecedence() { | ||
| var comparator = new TransitionBestPeerComparator(Difficulty.of(5000)); | ||
| when(a.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(5002)); | ||
| when(b.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(4995)); | ||
| // a has less distance from TTD: | ||
| assertThat(comparator.compare(a, b)).isEqualTo(1); | ||
| when(b.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(5001)); | ||
| // b has less distance from TTD: | ||
| assertThat(comparator.compare(a, b)).isEqualTo(-1); | ||
| when(b.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(5002)); | ||
| // a and b are equi-distant | ||
| assertThat(comparator.compare(a, b)).isEqualTo(0); | ||
| } | ||
|
|
||
| @Test | ||
| public void assertHandlesNewTTD() { | ||
| var comparator = new TransitionBestPeerComparator(Difficulty.of(5000)); | ||
| when(a.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(5002)); | ||
| when(b.chainState().getEstimatedTotalDifficulty()).thenReturn(Difficulty.of(4999)); | ||
| assertThat(comparator.compare(a, b)).isEqualTo(-1); | ||
|
|
||
| // update TTD with actual value | ||
| comparator.mergeStateChanged(true, Optional.of(Difficulty.of(5002))); | ||
| assertThat(comparator.compare(a, b)).isEqualTo(1); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.