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.

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

fix: return proper response for tx jsonrpc endpoint #97

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Conversation

beer-1
Copy link
Collaborator

@beer-1 beer-1 commented Nov 1, 2024

Description

method state response
eth_getTransactionByHash pending pending tx
eth_getTransactionByHash queued pending tx
eth_getTransactionByHash included tx
eth_getTransactionReceipt pending TxIndexingError
eth_getTransactionReceipt queued TxIndexingError
eth_getTransactionReceipt included tx

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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced transaction management in the mempool, allowing for more detailed transaction information.
    • Improved error handling and transaction processing logic in the JSON RPC backend.
  • Bug Fixes

    • Streamlined retrieval of chain ID for transactions, improving overall reliability.
  • Documentation

    • Updated method signatures to reflect changes in transaction handling and error management.

@beer-1 beer-1 requested a review from a team as a code owner November 1, 2024 10:47
Copy link

coderabbitai bot commented Nov 1, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant modifications to the transaction handling and indexing mechanisms within the codebase. Key changes include updates to the EVMIndexer interface and its implementation, specifically altering the return types of methods to provide more detailed transaction information. The TxInMempool method now returns pointers to rpctypes.RPCTransaction, enhancing transaction data management. Additionally, the retrieval of chain IDs has been streamlined across various methods, directly utilizing the Ethereum transaction objects. Overall, the changes improve transaction processing, error handling, and data storage in the mempool and JSON RPC backend.

Changes

File Path Change Summary
indexer/abci.go Modified ListenFinalizeBlock in EVMIndexerImpl to replace chain ID conversion with direct retrieval from ethTx.ChainId(). Maintained existing error handling and control flow.
indexer/indexer.go Updated EVMIndexer interface method TxInMempool to return *rpctypes.RPCTransaction instead of bool. Changed txPendingMap to store pointers to RPCTransaction. Adjusted instantiation in NewEVMIndexer.
indexer/mempool.go Changed TxInMempool to return *rpctypes.RPCTransaction. Updated Insert method to use ethTx.ChainId() for chain ID retrieval and store rpcTx in txPendingMap. Adjusted debug logging accordingly.
jsonrpc/backend/tx.go Enhanced error handling in methods like GetTransactionByHash, GetTransactionReceipt, and PendingTransactions. Updated to use ethTx.ChainId() for chain ID retrieval in transaction processing.
jsonrpc/backend/txpool.go Removed chainID variable and replaced it with ethTx.ChainId() in TxPoolContent. Other methods remain unchanged.

Possibly related PRs

🐇 In the code, we hop and play,
With transactions bright as day.
Chain IDs now come with ease,
Mempool's secrets, we can seize!
A joyful leap, our work is done,
In the world of code, we have our fun! 🐇


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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

@beer-1 beer-1 merged commit d4ed4ae into main Nov 1, 2024
5 of 6 checks passed
@beer-1 beer-1 deleted the fix/jsonrpc-tx branch November 1, 2024 10:49
beer-1 added a commit that referenced this pull request Nov 1, 2024
Copy link

codecov bot commented Nov 1, 2024

Codecov Report

Attention: Patch coverage is 0% with 38 lines in your changes missing coverage. Please review.

Project coverage is 28.08%. Comparing base (44e2bb9) to head (7938f43).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
jsonrpc/backend/tx.go 0.00% 26 Missing ⚠️
indexer/mempool.go 0.00% 8 Missing ⚠️
jsonrpc/backend/txpool.go 0.00% 2 Missing ⚠️
indexer/abci.go 0.00% 1 Missing ⚠️
indexer/indexer.go 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #97      +/-   ##
==========================================
+ Coverage   28.07%   28.08%   +0.01%     
==========================================
  Files         126      126              
  Lines       14021    14016       -5     
==========================================
  Hits         3937     3937              
+ Misses       9531     9526       -5     
  Partials      553      553              
Files with missing lines Coverage Δ
indexer/abci.go 0.00% <0.00%> (ø)
indexer/indexer.go 0.00% <0.00%> (ø)
jsonrpc/backend/txpool.go 0.00% <0.00%> (ø)
indexer/mempool.go 0.00% <0.00%> (ø)
jsonrpc/backend/tx.go 0.00% <0.00%> (ø)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant