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(sender): nonce update #1570

Merged
merged 4 commits into from
Dec 12, 2024
Merged

fix(sender): nonce update #1570

merged 4 commits into from
Dec 12, 2024

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Dec 10, 2024

Purpose or design rationale of this PR

Only updating nonce when sending transaction success.

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • fix: A bug fix

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change

Summary by CodeRabbit

  • New Features

    • Updated version number to v4.4.82, reflecting the latest release.
    • Improved transaction sending logic to directly manage nonce, enhancing transaction reliability.
  • Bug Fixes

    • Enhanced error handling and logging for transaction creation and sending processes.
  • Tests

    • Updated tests to ensure correct nonce usage and transaction status tracking across various scenarios.

@colinlyguo colinlyguo added the bump-version Bump the version tag for deployment label Dec 10, 2024
Copy link

coderabbitai bot commented Dec 10, 2024

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 : could not load export data: no export data for "scroll-tech/rollup/mock_bridge""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package : could not load export data: no export data for "scroll-tech/rollup/mock_bridge""

Walkthrough

The changes in this pull request involve updating the version tag in the common/version/version.go file from "v4.4.81" to "v4.4.82" to reflect a new release. Additionally, modifications were made to the sender package in rollup/internal/controller/sender/sender.go, which include changes to the transaction sending logic, specifically regarding nonce handling. The corresponding tests in rollup/internal/controller/sender/sender_test.go were also updated to ensure proper functionality and reliability of the transaction sending process.

Changes

File Change Summary
common/version/version.go Updated version tag from "v4.4.81" to "v4.4.82".
rollup/internal/controller/sender/sender.go Updated SendTransaction and createTx methods to handle nonce directly as a uint64 instead of a pointer.
rollup/internal/controller/sender/sender_test.go Updated tests to ensure correct nonce usage in transaction creation and improved assertions for transaction status.

Possibly related PRs

Suggested reviewers

  • georgehao
  • 0xmountaintop

🐇 In the code, we hop and play,
With versions changing day by day.
From four point four to eighty-two,
Our transactions now are swift and true!
With nonce in hand, we send with glee,
A brighter future, wait and see! 🌟


📜 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 bc1e9ad and 99f9020.

📒 Files selected for processing (1)
  • rollup/internal/controller/sender/sender.go (3 hunks)
🔇 Additional comments (4)
rollup/internal/controller/sender/sender.go (4)

219-219: LGTM: Improved nonce handling

The change from pointer-based nonce to direct value passing makes the nonce handling more explicit and thread-safe.


250-251: LGTM: Correct nonce update placement

The nonce is now correctly updated only after successful transaction send, using the transaction's nonce value directly. This is a robust approach that prevents nonce gaps and ensures consistency.


255-256: LGTM: Simplified method signature

The method signature change to accept a direct nonce value instead of a pointer aligns well with the improved nonce handling strategy.


Line range hint 484-488: Verify resubmission flow with new nonce handling

The resubmission logic correctly adapts to the new createTx signature. Let's verify the entire resubmission flow to ensure nonce consistency.

✅ Verification successful

Let me gather more information about the nonce handling in the createTx function and its usage.


Based on the comprehensive results, I can now provide the final response:

Resubmission flow correctly handles nonces with proper safeguards

The resubmission flow maintains nonce consistency through several mechanisms:

  • Nonce is explicitly passed to createTx from the original transaction
  • Transaction status updates track nonce conflicts
  • Proper error handling for nonce-related issues including "nonce too low" cases
  • Database transactions ensure atomicity when updating transaction statuses
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the resubmission flow handles nonces correctly

# Search for all places where transactions are resubmitted
rg -A 5 "resubmit transaction" --type go

# Search for nonce handling in resubmission logic
rg -A 10 "currentNonce.*originalTx.Nonce" --type go

Length of output: 3522


Script:

#!/bin/bash
# Search for createTx function implementation and its nonce handling
ast-grep --pattern 'func (s *Sender) createTx($$$) ($$$) {
  $$$
}'

# Search for nonce-related error handling in the sender
rg -B 2 -A 5 "nonce.*err" --type go

# Search for transaction status updates related to nonce
rg -A 5 "UpdateTxStatus.*nonce" --type go

Length of output: 22379


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>, 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. (Experiment)
  • @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.

georgehao
georgehao previously approved these changes Dec 10, 2024
@colinlyguo colinlyguo requested a review from georgehao December 12, 2024 05:41
@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.04%. Comparing base (4cfc551) to head (4d00ab8).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1570      +/-   ##
===========================================
- Coverage    52.06%   52.04%   -0.03%     
===========================================
  Files          157      157              
  Lines        12472    12462      -10     
===========================================
- Hits          6494     6486       -8     
+ Misses        5418     5416       -2     
  Partials       560      560              
Flag Coverage Δ
rollup 57.06% <100.00%> (-0.09%) ⬇️

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.

@colinlyguo colinlyguo merged commit 51c930d into develop Dec 12, 2024
6 checks passed
@colinlyguo colinlyguo deleted the fix-sender-nonce-update branch December 12, 2024 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump-version Bump the version tag for deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants