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: fix tx by receipt #206

Merged
merged 2 commits into from
Feb 10, 2025
Merged

fix: fix tx by receipt #206

merged 2 commits into from
Feb 10, 2025

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Feb 10, 2025

Closes: #XXX

Description


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

Summary by CodeRabbit

  • Bug Fixes
    • Improved transaction processing reliability with enhanced error handling during sender address verification, leading to smoother transaction confirmations.
  • Tests
    • Strengthened test validations to ensure consistent, robust behavior when processing transactions under error conditions.

Copy link

coderabbitai bot commented Feb 10, 2025

📝 Walkthrough

Walkthrough

The pull request updates the sender address retrieval logic across several components. In the backend methods, calls to retrieve the sender are modified to include a chain ID parameter and enhanced error handling. Correspondingly, the MsgEthereumTx struct’s GetSender method now accepts a chain ID and returns an error if sender recovery fails, with this change reflected in both production and test code. These adjustments improve diagnostic capabilities without altering the principal control flow of the methods.

Changes

File(s) Change Summary
rpc/backend/tx_info.go
rpc/backend/utils.go
Replaced direct sender retrieval with calls including chainID as a parameter; added error handling and debug logging if sender extraction fails.
x/evm/types/msg.go
x/evm/types/msg_test.go
Updated the GetSender method to accept a chainID *big.Int parameter and return an error; modified test cases to handle and assert the new error handling in sender recovery.

Sequence Diagram(s)

sequenceDiagram
    participant Backend
    participant EthereumTx as MsgEthereumTx
    participant Logger

    Backend->>EthereumTx: GetSender(chainID)
    alt Successful sender retrieval
        EthereumTx-->>Backend: senderAddress
    else Error encountered
        EthereumTx-->>Backend: error
        Backend->>Logger: Log debug error ("failed to parse from")
    end
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ecd3d5 and c8cb0fa.

📒 Files selected for processing (4)
  • rpc/backend/tx_info.go (1 hunks)
  • rpc/backend/utils.go (1 hunks)
  • x/evm/types/msg.go (1 hunks)
  • x/evm/types/msg_test.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: integration_tests
🔇 Additional comments (4)
rpc/backend/utils.go (1)

106-109: LGTM! Enhanced error handling for sender retrieval.

The changes improve error handling by adding debug logging for sender retrieval failures, which will help with diagnostics.

x/evm/types/msg.go (1)

247-259: LGTM! Improved sender recovery with proper error handling.

The changes enhance the GetSender method by:

  1. Adding chain ID parameter for proper sender recovery.
  2. Adding error handling for recovery failures.
  3. Caching the recovered sender address in the From field.
rpc/backend/tx_info.go (1)

197-200: LGTM! Enhanced error handling for transaction receipts.

The changes improve error handling by adding debug logging for sender retrieval failures in transaction receipts.

x/evm/types/msg_test.go (1)

535-536: LGTM! Updated test to handle errors properly.

The test has been updated to use the new GetSender method signature and properly handle potential errors.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 26.31579% with 14 lines in your changes missing coverage. Please review.

Project coverage is 49.00%. Comparing base (7ecd3d5) to head (c8cb0fa).

Files with missing lines Patch % Lines
x/evm/types/msg.go 36.36% 7 Missing ⚠️
rpc/backend/utils.go 0.00% 4 Missing ⚠️
rpc/backend/tx_info.go 25.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #206      +/-   ##
==========================================
- Coverage   49.04%   49.00%   -0.04%     
==========================================
  Files         170      170              
  Lines       16995    17008      +13     
==========================================
  Hits         8335     8335              
- Misses       8088     8100      +12     
- Partials      572      573       +1     
Files with missing lines Coverage Δ
rpc/backend/tx_info.go 64.76% <25.00%> (-0.85%) ⬇️
rpc/backend/utils.go 44.06% <0.00%> (-0.76%) ⬇️
x/evm/types/msg.go 63.98% <36.36%> (-1.50%) ⬇️

Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

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

LGTM outside of doing live test for checking the change

@skosito skosito merged commit fca73ef into main Feb 10, 2025
26 of 27 checks passed
@skosito skosito deleted the fix-tx-by-receipt branch February 10, 2025 18:26
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.

4 participants