fix(sims): Skip sims test when running dry on validators

[alpe]

Description

Closes: #16525

---

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 (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

• Bug Fixes

  • Resolved an issue where the simulation loop would run without available validators, preventing potential errors.

• New Features

  • Updated the Mempool interface to accept decoded transactions directly, streamlining transaction processing.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces changes to the Cosmos SDK to address issues with the simulation loop when no validators are available. It updates the x/simulation/simulate.go file to include checks for empty validator sets, preventing potential errors during simulations. Additionally, the types/mempool module's interface is modified to accept decoded transactions directly, streamlining transaction handling.

Changes

File(s)	Change Summary
CHANGELOG.md	Updated to reflect a bug fix for the simulation loop and an API-breaking change in types/mempool.
x/simulation/simulate.go	Added checks for empty validator sets in the SimulateFromSeedX function to prevent simulation errors.

Assessment against linked issues

Objective	Addressed	Explanation
Simulations fail because validator set is empty in the genesis before chain init (#[16525])	✅

Possibly related PRs

• fix(sims): Skip sims test when running dry on validators #21906: Addresses a bug fix related to skipping the simulation loop when there are no available validators.
• refactor(mempool)!: match server/v2/cometbft and sdk mempool interface #21744: Modifies the Mempool interface to accept decoded transactions directly, aligning with changes in this PR.

Suggested labels

backport/v0.52.x

Suggested reviewers

• kocubinski
• sontrinh16
• auricom
• tac0turtle
• julienrbrt

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2294708 and 44d6473.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• x/simulation/simulate.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• CHANGELOG.md
• x/simulation/simulate.go

---

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

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

x/simulation/simulate.go (2)

133-136: Approve the check for empty validator set with a minor suggestion.

The addition of this check addresses the issue of simulations panicking due to an empty validator set. This is a good defensive programming practice.

However, for better code clarity, consider combining the skip and return statements:

 if len(nextValidators) == 0 {
-	tb.Skip("skipping: empty validator set")
-	return
+	return params, accs, tb.Skip("skipping: empty validator set")
 }

This change maintains the same functionality while making the code more concise.

🧰 Tools

GitHub Check: golangci-lint

[failure] 135-135:
naked return in func SimulateFromSeedX with 207 lines of code (nakedret)

---

Line range hint 1-574: Overall assessment: Changes effectively address the simulation issue.

The modifications successfully prevent simulations from panicking or entering an infinite loop when faced with an empty validator set. These changes align well with the PR objectives and the linked issue (#16525).

Regarding the static analysis hint about a naked return in the SimulateFromSeedX function:

return exportedParams, accs, err

While this is flagged due to the function's length (207 lines), it's not directly related to the changes made in this PR. However, for future refactoring, consider breaking down this large function into smaller, more manageable pieces to improve readability and maintainability.

🧰 Tools

GitHub Check: golangci-lint

[failure] 135-135:
naked return in func SimulateFromSeedX with 207 lines of code (nakedret)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d54f6fa and 2294708.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• x/simulation/simulate.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

x/simulation/simulate.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

GitHub Check: golangci-lint

x/simulation/simulate.go

[failure] 135-135:
naked return in func SimulateFromSeedX with 207 lines of code (nakedret)

🔇 Additional comments not posted (7)

x/simulation/simulate.go (1)

271-274: Approve the additional check for empty validator set with a query.

This additional check for an empty validator set is consistent with the earlier change and provides an extra layer of safety in the simulation loop. Returning the current state (exportedParams and accs) is appropriate.

However, could you please clarify the purpose of the err variable being returned here? It's not immediately clear where this variable is set or what it represents in this context. Consider adding a comment explaining its significance or remove it if it's not necessary.

CHANGELOG.md (6)

Line range hint 1-14: Comprehensive changelog for v0.47.0

The changelog provides a detailed overview of the changes in v0.47.0, including new features, improvements, and breaking changes. This is helpful for users and developers to understand what has changed and how it might affect their applications.

---

Line range hint 16-26: New features enhance SDK capabilities

The Features section introduces several important additions:

1. Support for SIGN_MODE_TEXTUAL in x/auth
2. New gRPC query handler for accessing module account info by module name
3. Ability to create permanent locked accounts
4. Support for pruning expired authorizations

These features expand the functionality of the SDK and provide developers with more tools for building applications.

---

Line range hint 28-43: Significant improvements across various components

The Improvements section highlights several optimizations and enhancements:

1. Performance improvements in store operations and coin handling
2. Enhanced error messages and logging
3. Updates to dependencies, including CometBFT
4. Refactoring of various components for better efficiency and maintainability

These improvements should lead to better performance and developer experience when using the SDK.

---

Line range hint 45-52: Critical bug fixes

The Bug Fixes section addresses several important issues:

1. Fix for a security vulnerability related to feegrant allowances
2. Corrections to various module behaviors, including gov, bank, and baseapp
3. Improvements to error handling and panic recovery

These fixes are crucial for maintaining the stability and security of applications built with the SDK.

---

Line range hint 1-7160: Well-maintained and informative changelog

The CHANGELOG.md file for the Cosmos SDK v0.47.0 is comprehensive, well-organized, and provides valuable information for users and developers. It clearly outlines new features, improvements, bug fixes, and breaking changes across various components of the SDK. The level of detail and organization makes it easier for developers to understand the impact of the new version on their applications and plan for any necessary updates or migrations.

---

Line range hint 54-62: Breaking changes require attention

The changelog includes sections for State Machine Breaking, API Breaking, and Client Breaking changes. Developers should pay close attention to these sections when upgrading to v0.47.0, as they may require modifications to existing applications.

✅ Verification successful

Breaking changes are appropriately handled with existing migration scripts and upgrade handlers.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any migration scripts or upgrade handlers in the codebase
grep -R "MigrateStore" .
grep -R "UpgradeHandler" .

Length of output: 14834

[julienrbrt]

utACK