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

Log index is counted per block, not per transaction #4355

Merged
merged 4 commits into from
Oct 5, 2022
Merged

Log index is counted per block, not per transaction #4355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54dadc8
log index is counted per block, not per transaction
daniellehrner Sep 7, 2022
035dd3a
Merge branch 'main' into fix_log_index_for_getLogs
macfarla Oct 4, 2022
cc3fc02
Merge branch 'main' into fix_log_index_for_getLogs
mark-terry Oct 5, 2022
c621e99
PR fixes and changelog.
mark-terry Oct 5, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- Add Mainnet to merged networks [#4463](https://github.com/hyperledger/besu/pull/4463)

### Bug Fixes
- Fixed logIndex value returned by eth_getLogs RPC call [#4355](https://github.com/hyperledger/besu/pull/4355)
### Download Links

## 22.7.4
Expand Down
22 changes: 15 additions & 7 deletions ...va/org/hyperledger/besu/ethereum/api/graphql/internal/pojoadapter/TransactionAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
import org.hyperledger.besu.ethereum.api.query.TransactionReceiptWithMetadata;
import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
import org.hyperledger.besu.ethereum.core.BlockHeader;
import org.hyperledger.besu.ethereum.core.LogWithMetadata;
import org.hyperledger.besu.ethereum.core.Transaction;
import org.hyperledger.besu.ethereum.core.TransactionReceipt;
Expand Down Expand Up @@ -168,18 +169,25 @@ public Optional<AccountAdapter> getCreatedContract(final DataFetchingEnvironment
public List<LogAdapter> getLogs(final DataFetchingEnvironment environment) {
final BlockchainQueries query = getBlockchainQueries(environment);
final Hash hash = transactionWithMetadata.getTransaction().getHash();

final Optional<BlockHeader> maybeBlockHeader =
transactionWithMetadata.getBlockNumber().flatMap(query::getBlockHeaderByNumber);

if (maybeBlockHeader.isEmpty()) {
throw new RuntimeException(
"Cannot get block ("
+ transactionWithMetadata.getBlockNumber()
+ ") for transaction "
+ transactionWithMetadata.getTransaction().getHash());
}

final Optional<TransactionReceiptWithMetadata> maybeTransactionReceiptWithMetadata =
query.transactionReceiptByTransactionHash(hash);
final List<LogAdapter> results = new ArrayList<>();
if (maybeTransactionReceiptWithMetadata.isPresent()) {
final List<LogWithMetadata> logs =
LogWithMetadata.generate(
maybeTransactionReceiptWithMetadata.get().getReceipt(),
transactionWithMetadata.getBlockNumber().get(),
transactionWithMetadata.getBlockHash().get(),
hash,
transactionWithMetadata.getTransactionIndex().get(),
false);
query.matchingLogs(
maybeBlockHeader.get().getBlockHash(), transactionWithMetadata, () -> true);
for (final LogWithMetadata log : logs) {
results.add(new LogAdapter(log));
}
Expand Down
132 changes: 105 additions & 27 deletions ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/query/BlockchainQueries.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
Expand Down Expand Up @@ -752,43 +753,33 @@ private List<LogWithMetadata> matchingLogsCached(
public List<LogWithMetadata> matchingLogs(
final Hash blockHash, final LogsQuery query, final Supplier<Boolean> isQueryAlive) {
try {
final Optional<BlockHeader> blockHeader =
BackendQuery.runIfAlive(
"matchingLogs - getBlockHeader",
() -> blockchain.getBlockHeader(blockHash),
isQueryAlive);
final Optional<BlockHeader> blockHeader = getBlockHeader(blockHash, isQueryAlive);
if (blockHeader.isEmpty()) {
return Collections.emptyList();
}
// receipts and transactions should exist if the header exists, so throwing is ok.
final List<TransactionReceipt> receipts =
BackendQuery.runIfAlive(
"matchingLogs - getTxReceipts",
() -> blockchain.getTxReceipts(blockHash).orElseThrow(),
isQueryAlive);
final List<Transaction> transactions =
BackendQuery.runIfAlive(
"matchingLogs - getBlockBody",
() -> blockchain.getBlockBody(blockHash).orElseThrow().getTransactions(),
isQueryAlive);
final List<TransactionReceipt> receipts = getReceipts(blockHash, isQueryAlive);
final List<Transaction> transactions = getTransactions(blockHash, isQueryAlive);
final long number = blockHeader.get().getNumber();
final boolean removed =
BackendQuery.runIfAlive(
"matchingLogs - blockIsOnCanonicalChain",
() -> !blockchain.blockIsOnCanonicalChain(blockHash),
isQueryAlive);
final boolean removed = getRemoved(blockHash, isQueryAlive);

final AtomicInteger logIndexOffset = new AtomicInteger();
Copy link
Contributor

Choose a reason for hiding this comment

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

Why an AtomicInteger here? it seems that a plain int is enough

return IntStream.range(0, receipts.size())
.mapToObj(
i -> {
try {
BackendQuery.stopIfExpired(isQueryAlive);
return LogWithMetadata.generate(
receipts.get(i),
number,
blockHash,
transactions.get(i).getHash(),
i,
removed);
final List<LogWithMetadata> result =
LogWithMetadata.generate(
logIndexOffset.intValue(),
receipts.get(i),
number,
blockHash,
transactions.get(i).getHash(),
i,
removed);
logIndexOffset.addAndGet(receipts.get(i).getLogs().size());
return result;
} catch (final Exception e) {
throw new RuntimeException(e);
}
Expand All @@ -801,6 +792,47 @@ public List<LogWithMetadata> matchingLogs(
}
}

public List<LogWithMetadata> matchingLogs(
final Hash blockHash,
final TransactionWithMetadata transactionWithMetaData,
final Supplier<Boolean> isQueryAlive) {
if (transactionWithMetaData.getTransactionIndex().isEmpty()) {
throw new RuntimeException(
"Cannot find logs because transaction "
+ transactionWithMetaData.getTransaction().getHash()
+ " does not have a transaction index");
}

try {
final Optional<BlockHeader> blockHeader = getBlockHeader(blockHash, isQueryAlive);
if (blockHeader.isEmpty()) {
return Collections.emptyList();
}
// receipts and transactions should exist if the header exists, so throwing is ok.
final List<TransactionReceipt> receipts = getReceipts(blockHash, isQueryAlive);
final List<Transaction> transactions = getTransactions(blockHash, isQueryAlive);
final long number = blockHeader.get().getNumber();
final boolean removed = getRemoved(blockHash, isQueryAlive);

final int transactionIndex = transactionWithMetaData.getTransactionIndex().get();
final int logIndexOffset =
logIndexOffset(
transactionWithMetaData.getTransaction().getHash(), receipts, transactions);

return LogWithMetadata.generate(
logIndexOffset,
receipts.get(transactionIndex),
number,
blockHash,
transactions.get(transactionIndex).getHash(),
transactionIndex,
removed);

} catch (final Exception e) {
throw new RuntimeException(e);
}
}

/**
* Returns the world state for the corresponding block number
*
Expand Down Expand Up @@ -889,4 +921,50 @@ private List<TransactionWithMetadata> formatTransactions(
private boolean outsideBlockchainRange(final long blockNumber) {
return blockNumber > headBlockNumber() || blockNumber < BlockHeader.GENESIS_BLOCK_NUMBER;
}

private Boolean getRemoved(final Hash blockHash, final Supplier<Boolean> isQueryAlive)
throws Exception {
return BackendQuery.runIfAlive(
"matchingLogs - blockIsOnCanonicalChain",
() -> !blockchain.blockIsOnCanonicalChain(blockHash),
isQueryAlive);
}

private List<Transaction> getTransactions(
final Hash blockHash, final Supplier<Boolean> isQueryAlive) throws Exception {
return BackendQuery.runIfAlive(
"matchingLogs - getBlockBody",
() -> blockchain.getBlockBody(blockHash).orElseThrow().getTransactions(),
isQueryAlive);
}

private List<TransactionReceipt> getReceipts(
final Hash blockHash, final Supplier<Boolean> isQueryAlive) throws Exception {
return BackendQuery.runIfAlive(
"matchingLogs - getTxReceipts",
() -> blockchain.getTxReceipts(blockHash).orElseThrow(),
isQueryAlive);
}

private Optional<BlockHeader> getBlockHeader(
final Hash blockHash, final Supplier<Boolean> isQueryAlive) throws Exception {
return BackendQuery.runIfAlive(
"matchingLogs - getBlockHeader", () -> blockchain.getBlockHeader(blockHash), isQueryAlive);
}

private int logIndexOffset(
final Hash transactionHash,
final List<TransactionReceipt> receipts,
final List<Transaction> transactions) {
int logIndexOffset = 0;
for (int i = 0; i < receipts.size(); i++) {
if (transactions.get(i).getHash().equals(transactionHash)) {
break;
}

logIndexOffset += receipts.get(i).getLogs().size();
}

return logIndexOffset;
}
}
25 changes: 17 additions & 8 deletions ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/query/PrivacyQueries.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import java.util.stream.LongStream;
Expand Down Expand Up @@ -83,16 +84,24 @@ public List<LogWithMetadata> matchingLogs(
final long blockNumber = blockHeader.get().getNumber();
final boolean removed = !blockchainQueries.blockIsOnCanonicalChain(blockHash);

final AtomicInteger logIndexOffset = new AtomicInteger();
Copy link
Contributor

Choose a reason for hiding this comment

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

same as above

return IntStream.range(0, privateTransactionReceiptList.size())
.mapToObj(
i ->
LogWithMetadata.generate(
privateTransactionReceiptList.get(i),
blockNumber,
blockHash,
privateTransactionMetadataList.get(i).getPrivateMarkerTransactionHash(),
findPMTIndex(pmtHashList.get(i)),
removed))
i -> {
final List<LogWithMetadata> result =
LogWithMetadata.generate(
logIndexOffset.intValue(),
privateTransactionReceiptList.get(i),
blockNumber,
blockHash,
privateTransactionMetadataList.get(i).getPrivateMarkerTransactionHash(),
findPMTIndex(pmtHashList.get(i)),
removed);

logIndexOffset.addAndGet(privateTransactionReceiptList.get(i).getLogs().size());

return result;
})
.flatMap(Collection::stream)
.filter(query::matches)
.collect(Collectors.toList());
Expand Down
2 changes: 1 addition & 1 deletion ...org/hyperledger/besu/ethereum/api/jsonrpc/internal/filter/FilterManagerLogFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public void shouldUseBlockHashWhenCheckingLogsForChangesForPrivateFiltersOnly()

final Hash blockAddedHash = recordBlockEvents(1).get(0).getBlock().getHash();

verify(blockchainQueries, never()).matchingLogs(any(), any(), any());
verify(blockchainQueries, never()).matchingLogs(any(Hash.class), any(LogsQuery.class), any());
verify(privacyQueries).matchingLogs(eq(PRIVACY_GROUP_ID), eq(blockAddedHash), eq(logsQuery()));
}

Expand Down
37 changes: 23 additions & 14 deletions ...er/besu/ethereum/api/jsonrpc/websocket/subscription/logs/LogsSubscriptionServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ public void singleMatchingLogEvent() {
final List<TransactionReceipt> receipts = blockWithReceipts.getReceipts();

final int txIndex = 1;
final int logIndex = 1;
final Log targetLog = receipts.get(txIndex).getLogsList().get(logIndex);
final int logIndexInTransaction = 1;
final int logIndexInBlock = 3; // third log in the block
final Log targetLog = receipts.get(txIndex).getLogsList().get(logIndexInTransaction);

final LogsSubscription subscription = createSubscription(targetLog.getLogger());
registerSubscriptions(subscription);
Expand All @@ -104,7 +105,8 @@ public void singleMatchingLogEvent() {

assertThat(logResults).hasSize(1);
final LogResult result = logResults.get(0);
assertLogResultMatches(result, block, receipts, txIndex, logIndex, false);
assertLogResultMatches(
result, block, receipts, txIndex, logIndexInTransaction, logIndexInBlock, false);
}

@Test
Expand All @@ -115,8 +117,8 @@ public void singleMatchingLogEmittedThenRemovedInReorg() {
final List<TransactionReceipt> receipts = blockWithReceipts.getReceipts();

final int txIndex = 1;
final int logIndex = 1;
final Log targetLog = receipts.get(txIndex).getLogsList().get(logIndex);
final int logListIndex = 1;
final Log targetLog = receipts.get(txIndex).getLogsList().get(logListIndex);

final LogsSubscription subscription = createSubscription(targetLog.getLogger());
registerSubscriptions(subscription);
Expand All @@ -138,9 +140,11 @@ public void singleMatchingLogEmittedThenRemovedInReorg() {

assertThat(logResults).hasSize(2);
final LogResult firstLog = logResults.get(0);
assertLogResultMatches(firstLog, block, receipts, txIndex, logIndex, false);
// third log in the block
assertLogResultMatches(firstLog, block, receipts, txIndex, logListIndex, 3, false);
final LogResult secondLog = logResults.get(1);
assertLogResultMatches(secondLog, block, receipts, txIndex, logIndex, true);
// third log in the block, but was removed
assertLogResultMatches(secondLog, block, receipts, txIndex, logListIndex, 3, true);
}

@Test
Expand All @@ -151,8 +155,8 @@ public void singleMatchingLogEmittedThenMovedInReorg() {
final List<TransactionReceipt> receipts = blockWithReceipts.getReceipts();

final int txIndex = 1;
final int logIndex = 1;
final Log targetLog = receipts.get(txIndex).getLogsList().get(logIndex);
final int logListIndex = 1;
final Log targetLog = receipts.get(txIndex).getLogsList().get(logListIndex);

final LogsSubscription subscription = createSubscription(targetLog.getLogger());
registerSubscriptions(subscription);
Expand Down Expand Up @@ -181,12 +185,12 @@ public void singleMatchingLogEmittedThenMovedInReorg() {

assertThat(logResults).hasSize(3);
final LogResult originalLog = logResults.get(0);
assertLogResultMatches(originalLog, block, receipts, txIndex, logIndex, false);
assertLogResultMatches(originalLog, block, receipts, txIndex, logListIndex, 3, false);
final LogResult removedLog = logResults.get(1);
assertLogResultMatches(removedLog, block, receipts, txIndex, logIndex, true);
assertLogResultMatches(removedLog, block, receipts, txIndex, logListIndex, 3, true);
final LogResult updatedLog = logResults.get(2);
assertLogResultMatches(
updatedLog, newBlockWithLog.getBlock(), newBlockWithLog.getReceipts(), 0, 0, false);
updatedLog, newBlockWithLog.getBlock(), newBlockWithLog.getReceipts(), 0, 0, 0, false);
}

@Test
Expand Down Expand Up @@ -218,6 +222,9 @@ public void multipleMatchingLogsEmitted() {

// Verify all logs are emitted
assertThat(logResults).hasSize(targetBlocks.size() * txCount);

final List<Integer> expectedLogIndex = Arrays.asList(0, 2);

for (int i = 0; i < targetBlocks.size(); i++) {
final BlockWithReceipts targetBlock = targetBlocks.get(i);
for (int j = 0; j < txCount; j++) {
Expand All @@ -228,6 +235,7 @@ public void multipleMatchingLogsEmitted() {
targetBlock.getReceipts(),
j,
0,
expectedLogIndex.get(j),
false);
}
}
Expand Down Expand Up @@ -259,7 +267,7 @@ public void multipleSubscriptionsForSingleMatchingLog() {

assertThat(logResults).hasSize(1);
final LogResult result = logResults.get(0);
assertLogResultMatches(result, block, receipts, txIndex, logIndex, false);
assertLogResultMatches(result, block, receipts, txIndex, logIndex, 3, false);
}
}

Expand Down Expand Up @@ -332,10 +340,11 @@ private void assertLogResultMatches(
final Block block,
final List<TransactionReceipt> receipts,
final int txIndex,
final int logListIndex,
final int logIndex,
final boolean isRemoved) {
final Transaction expectedTransaction = block.getBody().getTransactions().get(txIndex);
final Log expectedLog = receipts.get(txIndex).getLogsList().get(logIndex);
final Log expectedLog = receipts.get(txIndex).getLogsList().get(logListIndex);

assertThat(result.getLogIndex()).isEqualTo(Quantity.create(logIndex));
assertThat(result.getTransactionIndex()).isEqualTo(Quantity.create(txIndex));
Expand Down
Loading