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

Problem: max-tx-gas-wanted is checked in consensus logic #1697

Merged
merged 3 commits into from
Nov 18, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Nov 18, 2024

Solution:

  • revert the change to check-tx mode only
  • release v1.4.0-rc5 breaking upgrade.

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

Release Notes for Version v1.4.0-rc5

  • New Features

    • Introduced a new upgrade handler for the testnet environment, simplifying the upgrade process.
  • Improvements

    • Updated changelog to highlight significant changes in transaction processing related to max-tx-gas-wanted.
    • Enhanced dependency management by updating several package versions for improved stability and performance.

These changes aim to enhance the overall functionality and reliability of the system.

Solution:
- revert the change to check-tx mode only
@yihuang yihuang requested a review from a team as a code owner November 18, 2024 00:36
@yihuang yihuang requested review from JayT106 and leejw51crypto and removed request for a team November 18, 2024 00:36
Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

This pull request introduces several changes, including an update to the changelog for version v1.4.0-rc5, which highlights a significant modification in the state machine regarding the max-tx-gas-wanted parameter, now only checked in CheckTx mode. Additionally, a new upgrade handler for a hotfix upgrade plan named "v1.4.0-rc5-testnet" is added to app/upgrades.go. The go.mod file is updated to reflect various dependency version changes and replacements.

Changes

File Change Summary
CHANGELOG.md Added entry for version v1.4.0-rc5 regarding changes to max-tx-gas-wanted handling in the state machine.
app/upgrades.go Introduced new upgrade handler for "v1.4.0-rc5-testnet" in RegisterUpgradeHandlers method.
go.mod Updated dependency versions and added replacements for several packages, including github.com/evmos/ethermint.

Possibly related PRs

Suggested reviewers

  • devashishdxt
  • thomas-nguy

🐰 In the code, I hop and play,
With gas limits, I find my way.
A new handler joins the fun,
Upgrades now can swiftly run!
Changelog bright, with changes clear,
In the land of code, we cheer! 🎉

Warning

Rate limit exceeded

@yihuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 50 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

Reviewing files that changed from the base of the PR and between ce797fa and d0388e4.

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

level=warning msg="The linter 'exportloopref' is deprecated (since v1.60.2) due to: Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar."


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

CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: yihuang <[email protected]>
CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: yihuang <[email protected]>
@yihuang yihuang requested a review from mmsqe November 18, 2024 00:38
Copy link

codecov bot commented Nov 18, 2024

Codecov Report

Attention: Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 35.47%. Comparing base (a3c2f70) to head (d0388e4).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
app/upgrades.go 25.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1697       +/-   ##
===========================================
+ Coverage   16.87%   35.47%   +18.59%     
===========================================
  Files          72      124       +52     
  Lines        6163    11897     +5734     
===========================================
+ Hits         1040     4220     +3180     
- Misses       5000     7253     +2253     
- Partials      123      424      +301     
Files with missing lines Coverage Δ
app/upgrades.go 44.30% <25.00%> (+38.97%) ⬆️

... and 70 files with indirect coverage changes

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

🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)

3-10: LGTM with a minor suggestion to improve clarity.

The changelog entry is well-structured and properly categorized. The description could be slightly more descriptive to better explain the impact of the change.

Consider expanding the description to:

-* [#1697](https://github.com/crypto-org-chain/cronos/pull/1697) Check max-tx-gas-wanted only in CheckTx mode.
+* [#1697](https://github.com/crypto-org-chain/cronos/pull/1697) Move max-tx-gas-wanted validation to CheckTx mode only, removing it from consensus logic to improve transaction processing efficiency.
🧰 Tools
🪛 Markdownlint

3-3: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ce797fa and d0388e4.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • app/upgrades.go (1 hunks)
  • go.mod (1 hunks)
🧰 Additional context used
🪛 Markdownlint
CHANGELOG.md

3-3: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🪛 GitHub Check: codecov/patch
app/upgrades.go

[warning] 48-49: app/upgrades.go#L48-L49
Added lines #L48 - L49 were not covered by tests

🔇 Additional comments (3)
app/upgrades.go (2)

45-49: Add documentation and tests for the hotfix upgrade handler

While the implementation is straightforward, it would benefit from:

  1. A comment explaining why this hotfix is needed and what migrations it runs
  2. Unit tests to verify the upgrade handler's behavior

Add a documentation comment above the handler:

+	// hotfixPlanName defines a testnet-specific upgrade handler that only runs migrations
+	// without modifying any parameters. This is used to test the v1.4.0-rc5 upgrade process
+	// in a controlled environment before mainnet deployment.
 	hotfixPlanName := "v1.4.0-rc5-testnet"
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 48-49: app/upgrades.go#L48-L49
Added lines #L48 - L49 were not covered by tests


47-49: Verify the max-tx-gas-wanted modification

The PR objectives mention moving the max-tx-gas-wanted check to check-tx mode, but this change isn't directly visible in the upgrade handler. Please clarify:

  1. Is this change handled through the migrations?
  2. Are there additional files that implement this change?
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 48-49: app/upgrades.go#L48-L49
Added lines #L48 - L49 were not covered by tests

go.mod (1)

276-276: Verify the changes in the new ethermint version

The update to ethermint version v0.6.1-0.20241118003049-cd93407bcf05 aligns with the PR objective of fixing the max-tx-gas-wanted check in consensus logic.

Let's verify the changes in the new ethermint version:

@yihuang yihuang enabled auto-merge November 18, 2024 01:01
@yihuang yihuang added this pull request to the merge queue Nov 18, 2024
Merged via the queue into crypto-org-chain:main with commit 1c31276 Nov 18, 2024
46 checks passed
@yihuang yihuang deleted the bump_ethermint branch November 18, 2024 01:35
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