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.
7311: add GetReceiptsFromPeerTask (hyperledger#7638)
Signed-off-by: Matilda Clerke <[email protected]>
- Loading branch information
1 parent
f9f721c
commit db29df7
Showing
28 changed files
with
864 additions
and
53 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
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
135 changes: 135 additions & 0 deletions
135
...java/org/hyperledger/besu/ethereum/eth/manager/peertask/task/GetReceiptsFromPeerTask.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,135 @@ | ||
| /* | ||
| * 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.ethereum.eth.manager.peertask.task; | ||
|
|
||
| import static java.util.Collections.emptyList; | ||
|
|
||
| import org.hyperledger.besu.datatypes.Hash; | ||
| import org.hyperledger.besu.ethereum.core.BlockHeader; | ||
| import org.hyperledger.besu.ethereum.core.TransactionReceipt; | ||
| import org.hyperledger.besu.ethereum.eth.EthProtocol; | ||
| import org.hyperledger.besu.ethereum.eth.manager.EthPeer; | ||
| import org.hyperledger.besu.ethereum.eth.manager.peertask.InvalidPeerTaskResponseException; | ||
| import org.hyperledger.besu.ethereum.eth.manager.peertask.PeerTask; | ||
| import org.hyperledger.besu.ethereum.eth.messages.GetReceiptsMessage; | ||
| import org.hyperledger.besu.ethereum.eth.messages.ReceiptsMessage; | ||
| import org.hyperledger.besu.ethereum.mainnet.BodyValidation; | ||
| import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule; | ||
| import org.hyperledger.besu.ethereum.p2p.rlpx.wire.MessageData; | ||
| import org.hyperledger.besu.ethereum.p2p.rlpx.wire.SubProtocol; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.function.Predicate; | ||
|
|
||
| public class GetReceiptsFromPeerTask | ||
| implements PeerTask<Map<BlockHeader, List<TransactionReceipt>>> { | ||
|
|
||
| private final Collection<BlockHeader> blockHeaders; | ||
| private final ProtocolSchedule protocolSchedule; | ||
| private final Map<BlockHeader, List<TransactionReceipt>> receiptsByBlockHeader = new HashMap<>(); | ||
| private final Map<Hash, List<BlockHeader>> headersByReceiptsRoot = new HashMap<>(); | ||
| private final long requiredBlockchainHeight; | ||
|
|
||
| public GetReceiptsFromPeerTask( | ||
| final Collection<BlockHeader> blockHeaders, final ProtocolSchedule protocolSchedule) { | ||
| this.blockHeaders = new ArrayList<>(blockHeaders); | ||
| this.protocolSchedule = protocolSchedule; | ||
|
|
||
| // pre-fill any headers with an empty receipts root into the result map | ||
| this.blockHeaders.stream() | ||
| .filter(header -> header.getReceiptsRoot().equals(Hash.EMPTY_TRIE_HASH)) | ||
| .forEach(header -> receiptsByBlockHeader.put(header, emptyList())); | ||
| this.blockHeaders.removeAll(receiptsByBlockHeader.keySet()); | ||
|
|
||
| // group headers by their receipts root hash to reduce total number of receipts hashes requested | ||
| // for | ||
| this.blockHeaders.forEach( | ||
| header -> | ||
| headersByReceiptsRoot | ||
| .computeIfAbsent(header.getReceiptsRoot(), key -> new ArrayList<>()) | ||
| .add(header)); | ||
|
|
||
| // calculate the minimum required blockchain height a peer will need to be able to fulfil this | ||
| // request | ||
| requiredBlockchainHeight = | ||
| this.blockHeaders.stream() | ||
| .mapToLong(BlockHeader::getNumber) | ||
| .max() | ||
| .orElse(BlockHeader.GENESIS_BLOCK_NUMBER); | ||
| } | ||
|
|
||
| @Override | ||
| public SubProtocol getSubProtocol() { | ||
| return EthProtocol.get(); | ||
| } | ||
|
|
||
| @Override | ||
| public MessageData getRequestMessage() { | ||
| // Since we have to match up the data by receipt root, we only need to request receipts | ||
| // for one of the headers with each unique receipt root. | ||
| final List<Hash> blockHashes = | ||
| headersByReceiptsRoot.values().stream() | ||
| .map(headers -> headers.getFirst().getHash()) | ||
| .toList(); | ||
| return GetReceiptsMessage.create(blockHashes); | ||
| } | ||
|
|
||
| @Override | ||
| public Map<BlockHeader, List<TransactionReceipt>> processResponse(final MessageData messageData) | ||
| throws InvalidPeerTaskResponseException { | ||
| if (messageData == null) { | ||
| throw new InvalidPeerTaskResponseException(); | ||
| } | ||
| final ReceiptsMessage receiptsMessage = ReceiptsMessage.readFrom(messageData); | ||
| final List<List<TransactionReceipt>> receiptsByBlock = receiptsMessage.receipts(); | ||
| // take a copy of the pre-filled receiptsByBlockHeader, to ensure idempotency of subsequent | ||
| // calls to processResponse | ||
| final Map<BlockHeader, List<TransactionReceipt>> receiptsByHeader = | ||
| new HashMap<>(receiptsByBlockHeader); | ||
| if (!blockHeaders.isEmpty()) { | ||
| if (receiptsByBlock.isEmpty() || receiptsByBlock.size() > blockHeaders.size()) { | ||
| throw new InvalidPeerTaskResponseException(); | ||
| } | ||
|
|
||
| for (final List<TransactionReceipt> receiptsInBlock : receiptsByBlock) { | ||
| final List<BlockHeader> blockHeaders = | ||
| headersByReceiptsRoot.get(BodyValidation.receiptsRoot(receiptsInBlock)); | ||
| if (blockHeaders == null) { | ||
| // Contains receipts that we didn't request, so mustn't be the response we're looking for. | ||
| throw new InvalidPeerTaskResponseException(); | ||
| } | ||
| blockHeaders.forEach(header -> receiptsByHeader.put(header, receiptsInBlock)); | ||
| } | ||
| } | ||
| return receiptsByHeader; | ||
| } | ||
|
|
||
| @Override | ||
| public Predicate<EthPeer> getPeerRequirementFilter() { | ||
| return (ethPeer) -> | ||
| ethPeer.getProtocolName().equals(getSubProtocol().getName()) | ||
| && (protocolSchedule.anyMatch((ps) -> ps.spec().isPoS()) | ||
| || ethPeer.chainState().getEstimatedHeight() >= requiredBlockchainHeight); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isSuccess(final Map<BlockHeader, List<TransactionReceipt>> result) { | ||
| return !result.isEmpty(); | ||
| } | ||
| } |
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.