Validate `TransactionArgs` passed in `eth_estimateGas` & `eth_call` JSON-RPC endpoints #320

m-Peter · 2024-06-26T12:45:07Z

Work towards: #117

Description

Perform the applicable validation rules from https://github.com/onflow/go-ethereum/blob/master/signer/fourbyte/validation.go#L29-L32 .
The same rules are also applied to the transaction payload in eth_sendRawTransaction.

For contributor use:

Targeted PR against master branch
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the standards mentioned here.
Updated relevant documentation
Re-reviewed Files changed in the Github PR explorer
Added appropriate labels

Summary by CodeRabbit

New Features
- Introduced validation logic for transaction data in the blockchain API.
- Added error handling for invalid transaction arguments.
Tests
- Added test cases for validating transaction scenarios to ensure data integrity and compliance.

coderabbitai · 2024-06-26T12:45:16Z

Warning

Rate limit exceeded

@m-Peter has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 49 minutes and 54 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b7e8d6c and f3c8beb.

Walkthrough

The recent changes enhance validation and error handling within the BlockChainAPI methods in api/api.go and their corresponding unit tests in api/models_test.go. Specifically, validation logic for transaction arguments is improved, with a new Validate() method implemented in TransactionArgs to ensure data integrity, validate addresses, and comply with transaction data formats. Additionally, new tests are introduced to ensure the robustness of these validations.

Changes

Files	Change Summary
`api/api.go`	Updated `Call` and `EstimateGas` methods with enhanced argument validation and error handling.
`api/models.go`	Added `Validate()` method to `TransactionArgs` for comprehensive transaction validation.
`api/models_test.go`	Introduced `TestValidateTransaction` to ensure the correctness of `TransactionArgs` validation.

Poem

In the code where data flows,
A rabbit hops, with care it shows. 🐇
Transactions checked, errors caught,
Through the blockchain, progress sought.
With tests to guard, our code stands tall,
For validation's now the call.

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>.
- 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 show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f46da1f and 046e386.

Files selected for processing (3)

api/api.go (2 hunks)
api/models.go (2 hunks)
api/models_test.go (1 hunks)

Additional comments not posted (3)

api/models_test.go (1)

14-149: Comprehensive Testing for Transaction Validation

The TestValidateTransaction function is well-implemented, covering a broad range of scenarios from valid transactions to various error conditions like conflicting inputs and invalid transaction data. The use of table-driven tests enhances the maintainability and readability of the test code.

api/models.go (1)

41-107: Robust Validation Logic in TransactionArgs.Validate

The Validate method in the TransactionArgs struct is robust, covering crucial checks against ambiguous inputs, contract creation conditions, and transaction data format compliance. This method is critical for ensuring the integrity of transactions processed by the system.

api/api.go (1)

490-493: Proper Validation and Error Handling in BlockChainAPI.Call

The addition of args.Validate() at the beginning of the Call method is a good practice. It ensures that the transaction arguments are verified before any further processing, which is crucial for maintaining the integrity and reliability of the API.

devbugging · 2024-06-26T15:41:44Z

api/models.go

@@ -33,6 +38,75 @@ type TransactionArgs struct {
 	ChainID    *hexutil.Big      `json:"chainId,omitempty"`
 }

+func (txArgs TransactionArgs) Validate() error {


devbugging · 2024-06-26T15:42:01Z

api/models_test.go

+	gasLimit := uint64(125_000)
+
+	nonce := uint64(1)
+	tests := map[string]struct {


devbugging

Nice!

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 046e386 and b7e8d6c.

Files selected for processing (2)

api/api.go (2 hunks)
api/models.go (2 hunks)

Files skipped from review as they are similar to previous changes (2)

api/api.go
api/models.go

…C endpoints

m-Peter added Improvement EVM labels Jun 26, 2024

m-Peter added this to the Flow-EVM-M2 milestone Jun 26, 2024

m-Peter self-assigned this Jun 26, 2024

m-Peter requested review from devbugging and peterargue as code owners June 26, 2024 12:45

coderabbitai bot reviewed Jun 26, 2024

View reviewed changes

devbugging reviewed Jun 26, 2024

View reviewed changes

api/models_test.go

gasLimit := uint64(125_000)

nonce := uint64(1)

tests := map[string]struct {

Copy link

Contributor

devbugging Jun 26, 2024

Choose a reason for hiding this comment

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

🧡

devbugging approved these changes Jun 26, 2024

View reviewed changes

coderabbitai bot reviewed Jun 26, 2024

View reviewed changes

Validate TransactionArgs passed in eth_estimateGas & eth_call JSON-RP…

f3c8beb

…C endpoints

m-Peter force-pushed the validate-tx-args branch from b7e8d6c to f3c8beb Compare June 26, 2024 17:13

m-Peter merged commit 54dc306 into main Jun 26, 2024
2 checks passed

m-Peter deleted the validate-tx-args branch June 26, 2024 17:28

coderabbitai bot mentioned this pull request Sep 9, 2024

Fix flaky E2E test for EVM state building #532

Merged

6 tasks

coderabbitai bot mentioned this pull request Feb 18, 2025

Consolidate the validations for max TX gas limit #759

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate `TransactionArgs` passed in `eth_estimateGas` & `eth_call` JSON-RPC endpoints #320

Validate `TransactionArgs` passed in `eth_estimateGas` & `eth_call` JSON-RPC endpoints #320

m-Peter commented Jun 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 26, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

devbugging Jun 26, 2024

devbugging Jun 26, 2024

devbugging left a comment

coderabbitai bot left a comment

Validate TransactionArgs passed in eth_estimateGas & eth_call JSON-RPC endpoints #320

Validate TransactionArgs passed in eth_estimateGas & eth_call JSON-RPC endpoints #320

Conversation

m-Peter commented Jun 26, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

coderabbitai bot commented Jun 26, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

devbugging Jun 26, 2024

Choose a reason for hiding this comment

devbugging Jun 26, 2024

Choose a reason for hiding this comment

devbugging left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

Validate `TransactionArgs` passed in `eth_estimateGas` & `eth_call` JSON-RPC endpoints #320

Validate `TransactionArgs` passed in `eth_estimateGas` & `eth_call` JSON-RPC endpoints #320

m-Peter commented Jun 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 26, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)