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

Submitter: don't bump transactions without sufficient gas #2664

Merged
merged 6 commits into from
Jun 8, 2024

Conversation

dwasse
Copy link
Collaborator

@dwasse dwasse commented Jun 4, 2024

Summary by CodeRabbit

  • New Features

    • Added gas balance check before bumping transactions to ensure sufficient gas.
    • Introduced a configuration option for setting minimum gas balance required for transaction submission.
  • Bug Fixes

    • Updated transaction handling logic to consider the gas balance check, preventing transactions from being bumped if gas is insufficient.

@dwasse dwasse requested a review from trajan0x as a code owner June 4, 2024 17:36
@github-actions github-actions bot added go Pull requests that update Go code size/s labels Jun 4, 2024
Copy link

cloudflare-workers-and-pages bot commented Jun 4, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6db0af4
Status: ✅  Deploy successful!
Preview URL: https://3ceecd90.sanguine-fe.pages.dev
Branch Preview URL: https://feat-submitter-no-bump.sanguine-fe.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Jun 4, 2024

Walkthrough

The recent changes add a hasSufficientGas function to check for sufficient gas balance before bumping transactions in the chain_queue.go file. Additionally, the ChainConfig struct in config.go now includes a MinGasBalance field, and a corresponding method GetMinGasBalance has been added to the IConfig interface.

Changes

Files Change Summary
ethergo/submitter/chain_queue.go Introduced hasSufficientGas to check gas balance before bumping transactions, updated transaction handling logic.
ethergo/submitter/config/config.go Added MinGasBalance field to ChainConfig struct and GetMinGasBalance method.
ethergo/submitter/config/iconfig_generated.go Added GetMinGasBalance method to IConfig interface.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant ParentCtx as Parent Context
    participant TxSubmitter as txSubmitterImpl
    participant ChainQueue as chainQueue
    participant Config as Config

    ParentCtx->>TxSubmitter: chainPendingQueue(chainID, txes)
    TxSubmitter->>ChainQueue: hasSufficientGas()
    ChainQueue->>Config: GetMinGasBalance()
    Config-->>ChainQueue: MinGasBalance
    ChainQueue-->>TxSubmitter: sufficient/insufficient
    alt sufficient gas
        TxSubmitter->>ChainQueue: bump transactions
    else insufficient gas
        TxSubmitter-->>ParentCtx: no bump
    end
Loading

Poem

In code we trust, with gas in sight,
Transactions bump, a coder's delight.
With balance checked, and fields anew,
Our chains now flow, robust and true.
A rabbit's joy, in every byte,
Code runs smooth, through day and night.


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.

Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.56510%. Comparing base (8721ba0) to head (6db0af4).
Report is 5 commits behind head on master.

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #2664         +/-   ##
===================================================
+ Coverage   39.80451%   40.56510%   +0.76059%     
===================================================
  Files            180         197         +17     
  Lines          14732       16068       +1336     
  Branches          80          80                 
===================================================
+ Hits            5864        6518        +654     
- Misses          8102        8717        +615     
- Partials         766         833         +67     
Flag Coverage Δ
cctp-relayer 44.68619% <ø> (?)
committee 63.75176% <ø> (ø)
omnirpc 53.15110% <ø> (ø)
promexporter 75.91241% <ø> (?)
rfq 31.60465% <ø> (-0.02944%) ⬇️
scribe 52.02703% <ø> (ø)
sin-executor 63.56589% <ø> (+4.13437%) ⬆️
stiprelayer 3.33333% <ø> (ø)
tools 21.98661% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8721ba0 and 368a18c.

Files selected for processing (3)
  • ethergo/submitter/chain_queue.go (3 hunks)
  • ethergo/submitter/config/config.go (2 hunks)
  • ethergo/submitter/config/iconfig_generated.go (1 hunks)
Additional context used
golangci-lint
ethergo/submitter/chain_queue.go

29-29: undefined: txSubmitterImpl (typecheck)


50-50: undefined: txSubmitterImpl (typecheck)


144-144: undefined: txSubmitterImpl (typecheck)


167-167: c.db undefined (type *chainQueue has no field or method db) (typecheck)


185-185: c.db undefined (type *chainQueue has no field or method db) (typecheck)


196-196: c.metrics undefined (type *chainQueue has no field or method metrics) (typecheck)


203-203: c.signer undefined (type *chainQueue has no field or method signer) (typecheck)


218-218: c.txTypeForChain undefined (type *chainQueue has no field or method txTypeForChain) (typecheck)


223-223: c.metrics undefined (type *chainQueue has no field or method metrics) (typecheck)


228-228: c.getGasEstimate undefined (type *chainQueue has no field or method getGasEstimate) (typecheck)


233-233: c.signer undefined (type *chainQueue has no field or method signer) (typecheck)


242-242: c.setGasPrice undefined (type *chainQueue has no field or method setGasPrice) (typecheck)


278-278: undefined: txToAttributes (typecheck)


305-305: c.config undefined (type *chainQueue has no field or method config) (typecheck)


312-312: c.metrics undefined (type *chainQueue has no field or method metrics) (typecheck)


320-320: c.signer undefined (type *chainQueue has no field or method signer) (typecheck)


342-342: c.db undefined (type *chainQueue has no field or method db) (typecheck)


357-357: c.config undefined (type *chainQueue has no field or method config) (typecheck)

Additional comments not posted (3)
ethergo/submitter/config/iconfig_generated.go (1)

34-35: The addition of GetMinGasBalance method aligns well with the existing interface structure and provides necessary functionality for gas management.

ethergo/submitter/config/config.go (1)

48-49: The addition of the MinGasBalance field and the GetMinGasBalance method are correctly implemented to handle chain-specific configurations. This enhances the flexibility and functionality of the gas management system.

Also applies to: 205-212

ethergo/submitter/chain_queue.go (1)

350-374: The implementation of hasSufficientGas method is robust, using both configuration data and live blockchain state to determine gas sufficiency. This is a critical addition for managing transaction costs effectively.

Tools
golangci-lint

357-357: c.config undefined (type *chainQueue has no field or method config) (typecheck)

@github-actions github-actions bot added size/xs and removed size/s labels Jun 5, 2024
Copy link
Contributor

@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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 368a18c and 6db0af4.

Files selected for processing (1)
  • ethergo/submitter/chain_queue.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • ethergo/submitter/chain_queue.go

@trajan0x trajan0x merged commit 8430f37 into master Jun 8, 2024
55 of 58 checks passed
@trajan0x trajan0x deleted the feat/submitter-no-bump branch June 8, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants