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(audit): use block gas limit in block context #171

Merged
merged 3 commits into from
Feb 27, 2025
Merged

Conversation

djm07073
Copy link
Contributor

@djm07073 djm07073 commented Feb 27, 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

  • Refactor
    • Streamlined the approach for determining the block gas limit, shifting to a more direct retrieval method.
    • Enhanced the system’s handling of gas limits to improve consistency and efficiency during block processing.

@djm07073 djm07073 requested a review from a team as a code owner February 27, 2025 06:50
Copy link
Member

@beer-1 beer-1 left a comment

Choose a reason for hiding this comment

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

LGTM

@beer-1
Copy link
Member

beer-1 commented Feb 27, 2025

hmm need to fix test setup part to fix build & test

Copy link

coderabbitai bot commented Feb 27, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request modifies the gas limit calculation in the EVM module. The buildBlockContext function in the keeper now obtains the gas limit by calling a new utility function instead of performing a custom calculation. In parallel, a new function, BlockGasLimit, has been added to the types package. This function evaluates the block gas meter and consensus parameters to determine the appropriate gas limit, thereby streamlining the context-building process. No changes were made to any exported interfaces.

Changes

File(s) Change Summary
x/evm/keeper/context.go Updated the buildBlockContext function to replace the previous gas limit calculation (k.computeGasLimit(sdkCtx)) with a direct call to types.BlockGasLimit(sdkCtx).
x/evm/types/gas.go Added a new function BlockGasLimit(ctx sdk.Context) uint64 that determines the gas limit by first checking the block gas meter and, if unavailable or invalid, falling back to consensus parameters. Also updated the import statements to include the math package and the Cosmos SDK types.

Sequence Diagram(s)

sequenceDiagram
    participant K as Keeper
    participant B as buildBlockContext
    participant G as BlockGasLimit
    participant CP as ConsensusParams/BlockGasMeter

    K->>B: Initiate block context building
    B->>G: Call BlockGasLimit(sdkCtx)
    alt Block gas meter available and valid
      G->>CP: Check gas meter limit
      CP-->>G: Return gas meter limit
    else Block gas meter unavailable/invalid
      G->>CP: Retrieve consensus parameters
      CP-->>G: Return MaxGas value or indicate nil block
    end
    G-->>B: Return determined gas limit
    B-->>K: Complete block context with new gas limit
Loading

Poem

I'm a rabbit coding in the glen,
Hopping through gas limits again,
A new function lights my way,
In context, it makes my day,
Code carrots crunch with every run,
Celebrating changes, oh what fun! 🐰🌿

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package injective: could not load export data: no export data for "github.com/cosmos/relayer/v2/relayer/codecs/injective""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package injective: could not load export data: no export data for "github.com/cosmos/relayer/v2/relayer/codecs/injective""


📜 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 20fdf0a and 8a75887.

📒 Files selected for processing (2)
  • x/evm/keeper/context.go (1 hunks)
  • x/evm/types/gas.go (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
  • @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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2439b3e and cd323c5.

📒 Files selected for processing (1)
  • x/evm/keeper/context.go (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Build & Test
x/evm/keeper/context.go

[error] 70-70: Test_NotSpendingGasForTxWithFeeDenom failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_SkipSequenceCheck failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_onAckIcs20Packet_noMemo failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_NotSpendingGasForTxWithFeeDenom failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_FloodingQuery failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_NewPendingTransactionFilter_FullTx failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_SetDenomMetadata failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_AllowLongCosmosAddress failed: runtime error: invalid memory address or nil pointer dereference.


[error] 70-70: Test_SnapshotRevert failed: runtime error: invalid memory address or nil pointer dereference.

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Minitiad

@beer-1 beer-1 merged commit 316533e into main Feb 27, 2025
6 of 8 checks passed
@beer-1 beer-1 deleted the fix/gas-limit branch February 27, 2025 08:41
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.

2 participants