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: add tx protected check at eth_sendRawTranasaction api #144

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

beer-1
Copy link
Member

@beer-1 beer-1 commented Jan 15, 2025

Description

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

  • 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

  • Security Enhancement
    • Implemented stricter transaction validation for RPC transactions.
    • Only allow EIP-155 replay-protected transactions to be processed.
    • Added error handling to prevent submission of non-compliant transactions.
  • Documentation
    • Updated the description of the eth_sendRawTransaction API to clarify that only replay-protected (EIP-155) transactions are accepted.
  • Tests
    • Added a new test to validate error handling for non-compliant transactions related to EIP-155.

@beer-1 beer-1 self-assigned this Jan 15, 2025
@beer-1 beer-1 requested a review from a team as a code owner January 15, 2025 16:12
Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces a new validation check in the SendRawTransaction method of the JSONRPCBackend class. The modification focuses on enforcing EIP-155 replay protection standards by adding a conditional check that prevents non-protected transactions from being processed via RPC. This change aims to improve transaction security by ensuring only compliant, replay-protected transactions can be submitted through the JSON-RPC backend.

Changes

File Change Summary
jsonrpc/backend/tx.go Added EIP-155 transaction protection check in SendRawTransaction method, returning an error for non-protected transactions.
jsonrpc/README.md Updated description of eth_sendRawTransaction to specify that only replay-protected (EIP-155) transactions are accepted.
jsonrpc/backend/tx_test.go Added test function Test_SendRawTransaction_EIP155 to validate error handling for non-compliant transactions.

Suggested reviewers

  • djm07073

Possibly related PRs

Poem

🐰 A Rabbit's Ode to Transaction Protection 🛡️

In the realm of bytes and cryptic flow,
EIP-155 stands proud and bold,
No unprotected tx shall pass,
Our RPC guards with rabbit class!
Safe transactions, our noble quest! 🚀

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
jsonrpc/backend/tx.go (1)

34-34: Enhance the error message with more details.

Consider providing more context in the error message to help API consumers understand and resolve the issue.

-        return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC")
+        return common.Hash{}, fmt.Errorf("transaction rejected: only replay-protected (EIP-155) transactions allowed over RPC. Please ensure your transaction has a valid chain ID")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0ac1947 and ab19d9d.

📒 Files selected for processing (1)
  • jsonrpc/backend/tx.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run test and upload codecov

jsonrpc/backend/tx.go Show resolved Hide resolved
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.98%. Comparing base (0ac1947) to head (bb6d958).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #144      +/-   ##
==========================================
+ Coverage   56.96%   56.98%   +0.01%     
==========================================
  Files         110      110              
  Lines       10150    10154       +4     
==========================================
+ Hits         5782     5786       +4     
  Misses       3529     3529              
  Partials      839      839              
Files with missing lines Coverage Δ
jsonrpc/backend/tx.go 54.47% <100.00%> (+0.48%) ⬆️

@beer-1 beer-1 requested a review from djm07073 January 15, 2025 16:35
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
jsonrpc/README.md (1)

37-37: Documentation update looks good! Consider adding a reference link.

The clarification about EIP-155 replay protection requirement is accurate and aligns well with the implementation. To make it even more helpful for users, consider adding a reference link to the EIP-155 specification.

-| eth       | eth_sendRawTransaction                     | ✅        | Sends a signed transaction to the network. Only replay-protected (EIP-155) transactions are accepted.                                                                |
+| eth       | eth_sendRawTransaction                     | ✅        | Sends a signed transaction to the network. Only replay-protected ([EIP-155](https://eips.ethereum.org/EIPS/eip-155)) transactions are accepted.                                                                |
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab19d9d and c835f51.

📒 Files selected for processing (1)
  • jsonrpc/README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: golangci-lint
  • GitHub Check: Run test and upload codecov
  • GitHub Check: Minitiad
  • GitHub Check: Analyze (go)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
jsonrpc/backend/tx_test.go (2)

19-19: Document the hardcoded transaction hex.

The hardcoded transaction hex should be documented to explain its components and why it's non-protected. This helps maintainers understand the test data.

Consider adding a detailed comment:

+// Transaction hex breakdown:
+// - First byte (0xf8): RLP list marker
+// - Next bytes: nonce, gasPrice, gasLimit, to, value, data
+// - Last 65 bytes: signature (v=27/28, r, s) indicating non-EIP-155 format
 txBz, err := hexutil.Decode("0xf8a58085174876e800830186a08080b853604580600e600039806000f350fe7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf31ba02222222222222222222222222222222222222222222222222222222222222222a02222222222222222222222222222222222222222222222222222222222222222")

22-23: Consider adding assertion for specific error type.

The test only checks for the error message substring. Consider asserting the specific error type if available.

 	_, err = input.backend.SendRawTransaction(txBz)
-	require.ErrorContains(t, err, "EIP-155")
+	var expectedErr *evmtypes.ErrTxNotProtected // assuming this type exists
+	require.ErrorAs(t, err, &expectedErr)
+	require.ErrorContains(t, err, "EIP-155")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c835f51 and bb6d958.

📒 Files selected for processing (1)
  • jsonrpc/backend/tx_test.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run test and upload codecov

jsonrpc/backend/tx_test.go Show resolved Hide resolved
@beer-1 beer-1 merged commit cf697fb into main Jan 16, 2025
10 checks passed
@beer-1 beer-1 deleted the fix/tx-protection-check branch January 16, 2025 03:42
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