imp(rpc): increase performance of eth_headerByHash #2856

fedekunze · 2024-09-16T15:29:51Z

Description

CometRPC now supports querying the Header by hash, improving perf since we no longer need to query the entire block.

Other minor improvements were included

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

tackled an existing issue or discussed with a team member
left instructions on how to review the changes
targeted the correct branch (see PR Targeting)

Reviewers Checklist

All items are required.
Please add a note if the item is not applicable
and please add your handle next to the items reviewed
if you only reviewed selected items.

I have...

added a relevant changelog entry to the Unreleased section in CHANGELOG.md
confirmed all author checklist items have been addressed
confirmed that this PR does not change production code
reviewed content
tested instructions (if applicable)
confirmed all CI checks have passed

Summary by CodeRabbit

New Features
- Introduced a new method to retrieve transaction logs based on transaction hash.
- Enhanced the GetPendingTransactions method to accurately fetch the chain ID from the backend.
Bug Fixes
- Resolved an issue where the community pool was nil, ensuring correct inflation mechanism operation.
Refactor
- Streamlined block retrieval methods to enhance clarity and consistency.
- Simplified the GetTransactionLogs method for improved efficiency.
- Consolidated backend responsibilities to improve transaction handling.
Style
- Improved code readability by reformatting function signatures.

coderabbitai · 2024-09-16T15:30:03Z

Walkthrough

The recent changes to the codebase involve significant updates to the Ethereum backend functionality. Key modifications include enhancements to the eth_headerByHash function for improved performance, updates to the Interpreter interface to support custom Opcodes, and the introduction of a new method for retrieving transaction logs. Additionally, several refactoring efforts were made to streamline the backend interfaces and methods, focusing on the use of a new RPC client for block and transaction data retrieval.

Changes

File	Change Summary
`CHANGELOG.md`	Documented updates including performance improvements to `eth_headerByHash`, `Interpreter` interface updates, bug fixes, and removal of duplicates.
`rpc/backend/backend.go`	Removed `CosmosBackend` interface, added `GetTransactionLogs` method, and included `rpcClient` in `Backend` struct.
`rpc/backend/blocks.go`	Refactored block retrieval methods to use `rpcClient`, simplifying logic and enhancing maintainability.
`rpc/backend/client_test.go`	Added functions to simulate various scenarios for header retrieval by hash, improving test coverage and robustness.
`tests/nix_tests/test_no_abci_resp.py`	Modified error handling in `test_gas_eth_tx` to assert for a different error message regarding block result not found.

Possibly related PRs

imp(core/vm): custom opcodes definition #2837: This PR updates the Interpreter interface to support custom Opcodes, aligning with the changes made in the main PR regarding the Interpreter interface.

Poem

In the code where rabbits hop,
Changes made, we’ll never stop.
With logs and blocks, we dance and play,
Optimized paths lead the way.
Custom Opcodes, a joyful cheer,
Ethereum shines, our goals are clear! 🐇✨

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ef83fbe and bd2a402.

Files selected for processing (1)

tests/nix_tests/test_no_abci_resp.py (1 hunks)

Additional comments not posted (1)

tests/nix_tests/test_no_abci_resp.py (1)

60-60: LGTM!

The updated assertion message aligns with the expected error condition and provides a clearer indication of the test's focus on error handling. The change is valid and does not introduce any issues.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-- I pushed a fix in commit <commit_id>, please review it.
-- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
-- @coderabbitai generate unit testing code for this file.
-- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
-- @coderabbitai generate interesting stats about this repository and render them as a table.
-- @coderabbitai read src/utils.ts and generate unit testing code.
-- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

GAtom22

Thanks @fedekunze!!

Left a few comments
Also, unit tests are failing, looking into these...

rpc/backend/backend.go

rpc/backend/blocks.go

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c07228d and c3e9c4f.

Files selected for processing (3)

rpc/backend/backend_suite_test.go (1 hunks)
rpc/backend/blocks_test.go (18 hunks)
rpc/backend/client_test.go (2 hunks)

Additional context used

GitHub Check: Run golangci-lint

rpc/backend/client_test.go

[failure] 264-264:
unused-parameter: parameter 'tx' seems to be unused, consider removing or renaming it as _ (revive)

Additional comments not posted (6)

rpc/backend/backend_suite_test.go (1)

81-82: LGTM!

The changes to the SetupTest function look good. The addition of WithClient(mocks.NewClient(suite.T())) enhances the test suite's ability to simulate client interactions during tests by setting up a mock client. The removal of the previous line that set suite.backend.clientCtx.Client to a new mock client indicates a shift in how the client context is managed within the test setup. These changes streamline the client configuration process and ensure that the test suite uses the appropriate mock implementations for its operations.

rpc/backend/client_test.go (3)

261-277: LGTM!

The function correctly sets up a mock response for testing the HeaderByHash RPC method.

Tools

GitHub Check: Run golangci-lint

[failure] 264-264:
unused-parameter: parameter 'tx' seems to be unused, consider removing or renaming it as _ (revive)

279-282: LGTM!

The function correctly sets up a mock error response for testing the HeaderByHash RPC method.

284-287: LGTM!

The function correctly sets up a mock response for testing the HeaderByHash RPC method when the header is not found.

rpc/backend/blocks_test.go (2)

676-677: Approve the refactoring to use a mocked client.

The change to use a mocked client for retrieving block results is a good refactoring that improves the test isolation and control over the test environment. The overall logic flow remains intact.

Line range hint 717-727: Approve the change to use specific header mocking methods.

The change to use RegisterHeaderByHashError and RegisterHeaderByHash methods for mocking the client responses is a good refactoring that improves the specificity of the mocks. The overall logic flow and test cases remain the same.

rpc/backend/client_test.go

GAtom22 · 2024-09-19T12:41:55Z

https://github.com/Mergifyio backport rama/release-v20

mergify · 2024-09-19T12:42:01Z

backport rama/release-v20

✅ Backports have been created

#2870 imp(rpc): increase performance of eth_headerByHash (backport #2856) has been created for branch rama/release-v20

* imp(rpc): increase performance of eth_headerByHash * c++ * update unit tests * address review comments --------- Co-authored-by: tom <tomasguerraalda@hotmail.com> (cherry picked from commit 1f0432f)

…2870) * imp(rpc): increase performance of eth_headerByHash (#2856) * imp(rpc): increase performance of eth_headerByHash * c++ * update unit tests * address review comments --------- Co-authored-by: tom <tomasguerraalda@hotmail.com> (cherry picked from commit 1f0432f) * update chlog --------- Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> Co-authored-by: tom <tomasguerraalda@hotmail.com>

imp(rpc): increase performance of eth_headerByHash

f65af1c

fedekunze temporarily deployed to release September 16, 2024 15:29 — with GitHub Actions Inactive

github-actions bot added the tests label Sep 16, 2024

c++

c07228d

fedekunze temporarily deployed to release September 16, 2024 15:33 — with GitHub Actions Inactive

fedekunze marked this pull request as ready for review September 16, 2024 15:33

fedekunze requested a review from a team as a code owner September 16, 2024 15:33

fedekunze requested review from MalteHerrmann, 0xstepit, GAtom22 and ramacarlucho and removed request for a team September 16, 2024 15:33

GAtom22 reviewed Sep 16, 2024

View reviewed changes

rpc/backend/backend.go Outdated Show resolved Hide resolved

rpc/backend/backend.go Outdated Show resolved Hide resolved

GAtom22 reviewed Sep 16, 2024

View reviewed changes

rpc/backend/backend.go Outdated Show resolved Hide resolved

GAtom22 reviewed Sep 16, 2024

View reviewed changes

rpc/backend/blocks.go Show resolved Hide resolved

update unit tests

c3e9c4f

GAtom22 temporarily deployed to release September 16, 2024 20:19 — with GitHub Actions Inactive

coderabbitai bot reviewed Sep 16, 2024

View reviewed changes

rpc/backend/client_test.go Outdated Show resolved Hide resolved

address review comments

ef83fbe

GAtom22 temporarily deployed to release September 16, 2024 20:44 — with GitHub Actions Inactive

fedekunze enabled auto-merge (squash) September 17, 2024 06:10

update exp err msg

bd2a402

GAtom22 temporarily deployed to release September 17, 2024 11:45 — with GitHub Actions Inactive

GAtom22 approved these changes Sep 17, 2024

View reviewed changes

ramacarlucho approved these changes Sep 17, 2024

View reviewed changes

fedekunze merged commit 1f0432f into main Sep 17, 2024
50 of 52 checks passed

fedekunze deleted the fedekunze/header-by-hash branch September 17, 2024 12:29

mergify bot mentioned this pull request Sep 19, 2024

imp(rpc): increase performance of eth_headerByHash (backport #2856) #2870

Merged

9 tasks

This was referenced Sep 30, 2024

feat(app): add feemarket wrapper. Change basefee to dec #2878

Merged

chore(evm): add scaling on buildTx fees #2906

Merged

coderabbitai bot mentioned this pull request Oct 9, 2024

chore(dist-prec): convert balance change entries #2929

Merged

9 tasks

coderabbitai bot mentioned this pull request Oct 31, 2024

chore(chlog): update with v20 #2960

Merged

9 tasks

coderabbitai bot mentioned this pull request Dec 8, 2024

refactor: unify the error handling methods in the crypto package that are different from the project style & use errors.New to replace fmt.Errorf with no parameters #3017

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

imp(rpc): increase performance of eth_headerByHash #2856

imp(rpc): increase performance of eth_headerByHash #2856

Uh oh!

fedekunze commented Sep 16, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 16, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

GAtom22 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

GAtom22 commented Sep 19, 2024

Uh oh!

mergify bot commented Sep 19, 2024 •

edited

Loading

Uh oh!

Uh oh!

imp(rpc): increase performance of eth_headerByHash #2856

imp(rpc): increase performance of eth_headerByHash #2856

Uh oh!

Conversation

fedekunze commented Sep 16, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

GAtom22 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

GAtom22 commented Sep 19, 2024

Uh oh!

mergify bot commented Sep 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Uh oh!

fedekunze commented Sep 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 16, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mergify bot commented Sep 19, 2024 •

edited

Loading