Handle ErrHeightOutOfRange errors in EstimateGas

[m-Peter]

Description

Just like we do for Call / GetNonce / GetCode / GetBalance, we should handle ErrHeightOutOfRange in EstimateGas as well.

---

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
  • Enhanced logging functionality for better readability and interpretability of logged data.
  • Improved error handling by filtering specific error types in the gas estimation process.
  • Updated logging messages to include additional contextual information for successful gas estimations.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve enhancements to the logging functionality in the Call and EstimateGas methods of the EVM struct within the services/requester/requester.go file. The logging of the data parameter is now encoded in hexadecimal format, and error logging is refined to exclude specific error types. Additionally, successful gas estimation logs now include more contextual information regarding the heights involved.

Changes

File Path	Change Summary
services/requester/requester.go	Updated logging in Call method to use hexadecimal encoding for data. Enhanced error logging in EstimateGas to filter specific errors and include additional context in success logs.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant EVM
    participant Logger

    Client->>EVM: Call(data)
    EVM->>Logger: Log hex-encoded data
    Logger-->>EVM: Log entry created

    Client->>EVM: EstimateGas(data)
    EVM->>Logger: Check error type
    alt Error not ErrHeightOutOfRange
        EVM->>Logger: Log error details with hex data and heights
    end
    EVM->>Logger: Log success with evm-height and cadence-height
    Logger-->>EVM: Log entry created

Loading

Poem

🐰 In the meadow where data flows,
Hexagons dance, and the logging glows.
Errors filtered, clear as day,
With heights in logs, they guide the way.
Hooray for changes, let’s hop and cheer,
For clarity blooms, and the path is clear! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Early access features: disabled

We are currently testing the following features in early access:

• Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues on the discussion post.

[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 c50ffde and 54ff0cc.

Files selected for processing (1)

• services/requester/requester.go (3 hunks)

Additional comments not posted (2)

services/requester/requester.go (2)

481-481: Approved: Enhanced logging in Call method.

The change to log the data parameter in hexadecimal format enhances readability and is consistent with the PR's objectives.

---

Line range hint 531-554: Approved with suggestions: Enhanced error handling in EstimateGas.

The introduction of specific error handling for ErrHeightOutOfRange aligns with the PR's objectives. Ensure that this new logic correctly filters out the specified error while allowing other errors to be logged appropriately.

Verification successful

---

Verified: Error handling for ErrHeightOutOfRange is correctly implemented and tested.

The error handling logic for ErrHeightOutOfRange is consistently applied across the codebase, and corresponding tests verify its behavior. This confirms that the changes align with the intended objectives of the PR.

• The error handling logic is implemented in services/requester/requester.go.
• Tests in services/requester/cross-spork_client_test.go verify the behavior.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the error handling logic in the `EstimateGas` method.

# Test: Search for the error handling implementation. Expect: Only occurrences of the new logic.
rg --type go -A 5 $'errs.ErrHeightOutOfRange'

Length of output: 3930