Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional withdrawals to the NewPayload log #5021

Merged
merged 4 commits into from
Jan 30, 2023
Merged

Add optional withdrawals to the NewPayload log #5021

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7fc571
Add optional withdrawals to the NewPayload log
siladu Jan 30, 2023
02cde40
Missed final
siladu Jan 30, 2023
95ab2a5
Tidy up
siladu Jan 30, 2023
5504c00
Minor format tweak
siladu Jan 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions ...perledger/besu/ethereum/api/jsonrpc/internal/methods/engine/AbstractEngineNewPayload.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import org.hyperledger.besu.ethereum.trie.MerkleTrieException;
import org.hyperledger.besu.plugin.services.exception.StorageException;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
Expand Down Expand Up @@ -320,16 +321,24 @@ protected EngineStatus getInvalidBlockHashStatus() {
}

private void logImportedBlockInfo(final Block block, final double timeInS) {
LOG.info(
String.format(
"Imported #%,d / %d tx / base fee %s / %,d (%01.1f%%) gas / (%s) in %01.3fs. Peers: %d",
block.getHeader().getNumber(),
block.getBody().getTransactions().size(),
final StringBuilder message = new StringBuilder();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not add it all the time and just have "N/A" if it's not present? This is what happened with BaseFee. Then we can keep the log line in one string, which will increase readability.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For non-mainnet cases, there would always be an irrelevant portion of log and I think there's value in keeping this printout as small as possible for readability in the log.
IMO baseFee should be optional too, although it's tied to the london fee market which private networks might still use.

I am not opposed to favouring dev readability instead, if anyone decided to open another PR to change this.

message.append("Imported #%,d / %d tx");
final List<Object> messageArgs =
new ArrayList<>(
List.of(block.getHeader().getNumber(), block.getBody().getTransactions().size()));
if (block.getBody().getWithdrawals().isPresent()) {
message.append(" / %d ws");
messageArgs.add(block.getBody().getWithdrawals().get().size());
}
message.append(" / base fee %s / %,d (%01.1f%%) gas / (%s) in %01.3fs. Peers: %d");
messageArgs.addAll(
List.of(
block.getHeader().getBaseFee().map(Wei::toHumanReadableString).orElse("N/A"),
block.getHeader().getGasUsed(),
(block.getHeader().getGasUsed() * 100.0) / block.getHeader().getGasLimit(),
block.getHash().toHexString(),
timeInS,
ethPeers.peerCount()));
LOG.info(String.format(message.toString(), messageArgs.toArray()));
}
}