Add eth_getBlockReceipts() JSON/RPC method #5771

matthew1001 · 2023-08-18T12:22:36Z

PR description

Adds eth_getBlockReceipts JSON/RPC method as described by Ethereum API specification ethereum/execution-apis#438

Notes for PR reviewer & docs:

The specification says that the correct response for a block that cannot be found is an empty array, e.g. https://github.com/ethereum/execution-apis/blob/main/tests/eth_getBlockReceipts/get-block-receipts-future.io Besu appears to have a convention of returning a -32000 error code with message Block not found for such cases. I have done the same with this new JSON/RPC method but welcome any thoughts on this from the PR reviewer.
I don't think this query requires any changes/additions to graphql. The current schema covers the basic EVM objects (block, transaction, log etc) and is already designed to provide an alternative way of doing what this new JSON/RPC method adds (getting all receipts for a block in a single call) so I haven't made any graphql changes.

Fixed Issue(s)

Closes #5751

github-actions · 2023-08-18T12:34:49Z

I thought about documentation and added the doc-change-required label to this PR if updates are required.
I thought about the changelog and included a changelog update if required.
If my PR includes database changes (e.g. KeyValueSegmentIdentifier) I have thought about compatibility and performed forwards and backwards compatibility tests

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

Signed-off-by: Matt Whitehead <matthew1001@gmail.com>

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

CHANGELOG.md

macfarla · 2023-08-23T03:24:58Z

...java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthGetBlockReceiptsTest.java

+
+  @Test
+  public void blockNotFoundForRandomHash() {
+    /* Valid random hash - should result in block not found (effectively impossible for it to be a valid block) */


the risk is low but this still makes me uneasy

Yeah fair point, I'll remove that test for now.

macfarla · 2023-08-23T03:32:38Z

...java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthGetBlockReceiptsTest.java

+    TransactionReceiptResult tx1 = result.getResults().get(0);
+    assertThat(tx1.getBlockNumber()).isEqualTo("0x1");
+    assertThat(tx1.getEffectiveGasPrice()).isEqualTo("0x4a7ebf2e");
+    assertThat(tx1.getTo()).isEqualTo("0x6ada2e11049e5fc54fcdf2a97996d9b2aa80fe71");


I think we don't want the tx values hard coded in the test since it makes it brittle - eg if you change the BLOCKCHAIN_LENGTH, these tests will fail. you can get the values from the generated blockchain itself

final Transaction expectedTx1 = blockchain.getBlockByNumber(BLOCKCHAIN_LENGTH - 1).get().getBody().getTransactions().get(0); // Check TX1 receipt is correct TransactionReceiptResult tx1 = result.getResults().get(0); assertThat(tx1.getBlockNumber()).isEqualTo("0x"+(BLOCKCHAIN_LENGTH-1)); assertThat(tx1.getEffectiveGasPrice()).isNotEmpty(); assertThat(tx1.getType()).isEqualTo(expectedTx1.getType()); assertThat(tx1.getTo()).isEqualTo(expectedTx1.getTo().get().toString());

Yeah that's a good point. I'll make those suggested changes so the test is more reliable.

The latest commit updates the unit tests as you've suggested @macfarla. I added getEthSerializedType() to TransactionType so there is a single place in the codebase where FRONTIER transactions are mapped from their enum value of 0xf8 to their eth serialized value of 0x00.

macfarla · 2023-08-23T04:28:54Z

...java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthGetBlockReceiptsTest.java

also have a look at EthJsonRpcHttpBySpecTest - maybe add some "by spec" tests

Thanks for the pointer. I'd found the graphql spec tests but not spotted general JSON/RPC spec tests. Latest commit adds a variety to cover by hash, by number, and by tag.

...java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthGetBlockReceiptsTest.java

…sonrpc/internal/methods/EthGetBlockReceiptsTest.java Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com>

Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com>

…sactions at runtime. Add getEthSerializedType() utility to TransactionType. Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

matthew1001 · 2023-08-23T16:54:02Z

I think all of the latest comments are addressed @macfarla I'm away for a few days now, feel free to merge if you're happy or if you have more comments I'm happy to take a look when I'm back.

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

* Initial commit with new JSON/RPC method Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Update CHANGELOG.md Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> * Update unit tests to check receipts against generated blockchain transactions at runtime. Add getEthSerializedType() utility to TransactionType. Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Add spec JSON/RPC tests Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> --------- Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>

* Initial commit with new JSON/RPC method Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Update CHANGELOG.md Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> * Update unit tests to check receipts against generated blockchain transactions at runtime. Add getEthSerializedType() utility to TransactionType. Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Add spec JSON/RPC tests Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> --------- Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: garyschulte <garyschulte@gmail.com>

* Initial commit with new JSON/RPC method Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Update CHANGELOG.md Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> * Update unit tests to check receipts against generated blockchain transactions at runtime. Add getEthSerializedType() utility to TransactionType. Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Add spec JSON/RPC tests Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> --------- Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>

Initial commit with new JSON/RPC method

335e2da

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

matthew1001 force-pushed the get-block-receipts branch from 25d5686 to 335e2da Compare August 18, 2023 14:39

Add unit tests

da1a323

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

matthew1001 added the doc-change-required Indicates an issue or PR that requires doc to be updated label Aug 21, 2023

matthew1001 added 2 commits August 21, 2023 11:56

Merge branch 'main' into get-block-receipts

80c0dcb

Signed-off-by: Matt Whitehead <matthew1001@gmail.com>

New copyright header

21727e8

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

matthew1001 force-pushed the get-block-receipts branch 3 times, most recently from 468ddd8 to 084c740 Compare August 21, 2023 16:07

matthew1001 changed the title ~~Initial commit with new JSON/RPC method~~ Add eth_getBlockReceipts() JSON/RPC method Aug 21, 2023

matthew1001 force-pushed the get-block-receipts branch from 084c740 to 21727e8 Compare August 22, 2023 09:39

matthew1001 added 2 commits August 22, 2023 11:28

Update unit tests

8e6565c

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

Merge branch 'main' into get-block-receipts

5f6df78

matthew1001 marked this pull request as ready for review August 22, 2023 10:30

Fix unit tests

6b33163

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

macfarla reviewed Aug 23, 2023

View reviewed changes

matthew1001 and others added 4 commits August 23, 2023 08:40

Update ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/j…

b7cdfa4

…sonrpc/internal/methods/EthGetBlockReceiptsTest.java Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com>

Update CHANGELOG.md

a78e7ac

Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com>

Merge branch 'main' into get-block-receipts

76ba390

Update unit tests to check receipts against generated blockchain tran…

b5cb902

…sactions at runtime. Add getEthSerializedType() utility to TransactionType. Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

matthew1001 force-pushed the get-block-receipts branch from ff2bfd6 to b5cb902 Compare August 23, 2023 09:37

Add spec JSON/RPC tests

a355fcf

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>

merge

393e8a1

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

macfarla approved these changes Aug 24, 2023

View reviewed changes

macfarla enabled auto-merge (squash) August 24, 2023 01:50

macfarla merged commit 9a0f35c into hyperledger:main Aug 24, 2023
19 checks passed

bgravenorst mentioned this pull request Aug 31, 2023

Document the eth_getBlockReceipts() API metrhod hyperledger/besu-docs#1394

Closed

bgravenorst removed the doc-change-required Indicates an issue or PR that requires doc to be updated label Aug 31, 2023

macfarla mentioned this pull request Sep 28, 2023

Refactor eth_getBlockReceipts to use getTxReceipts(blockHash) #5962

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add eth_getBlockReceipts() JSON/RPC method #5771

Add eth_getBlockReceipts() JSON/RPC method #5771

matthew1001 commented Aug 18, 2023 •

edited

github-actions bot commented Aug 18, 2023 •

edited by matthew1001

macfarla Aug 23, 2023

matthew1001 Aug 23, 2023

macfarla Aug 23, 2023

macfarla Aug 23, 2023

matthew1001 Aug 23, 2023

matthew1001 Aug 23, 2023

macfarla Aug 23, 2023

matthew1001 Aug 23, 2023

matthew1001 commented Aug 23, 2023

Add eth_getBlockReceipts() JSON/RPC method #5771

Add eth_getBlockReceipts() JSON/RPC method #5771

Conversation

matthew1001 commented Aug 18, 2023 • edited

PR description

Fixed Issue(s)

github-actions bot commented Aug 18, 2023 • edited by matthew1001

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthew1001 commented Aug 23, 2023

matthew1001 commented Aug 18, 2023 •

edited

github-actions bot commented Aug 18, 2023 •

edited by matthew1001