fix: correctly assign execModeSimulate to context for simulateTx

[damiannolan]

Description

Correctly assigns context execMode when simulating txs to execModeSimulate.
Fixes out-of-gas errors propagated from relayers in ibc e2e tests in: cosmos/ibc-go#6278

Tested e2es locally by checking out release/v0.50.x and using go mod replace for cosmos-sdk with the diff in this PR.

---

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

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

• Enhancements
  • Improved context handling for transactions to better support simulation modes.

[coderabbitai]

Walkthrough

Walkthrough

The modification involves updating the getContextForTx function in the BaseApp to set the execution mode to execModeSimulate when the mode is specified as such. This change ensures that the context reflects the correct execution mode during simulation processes.

Changes

File Path	Change Summary
baseapp/.../baseapp.go	In getContextForTx, added a line to update context with execModeSimulate when the mode is execModeSimulate.

---

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

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[damiannolan]

If possible would be great to backport this to v0.47 and v0.50! 🙏🏻

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 03dc8bd and 59d96cc.

Files selected for processing (1)

• baseapp/baseapp.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

baseapp/baseapp.go (1)

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

Additional comments not posted (1)

baseapp/baseapp.go (1)

683-683: Ensure the new context setting for execModeSimulate does not affect other transaction modes.

Verification successful

---

The implementation of getContextForTx in baseapp.go confirms that the context modifications for execModeSimulate are isolated within a specific conditional block. This ensures that the changes do not affect other transaction modes such as execModeReCheck or execModeFinalize. The isolation of these changes minimizes the risk of unintended side effects, affirming that the new context setting for execModeSimulate is correctly implemented.

• Location: baseapp/baseapp.go, lines 681-683

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that the new context setting for `execModeSimulate` does not affect other transaction modes.

# Test: Search for usage of `getContextForTx` in other contexts. Expect: No unexpected side effects.
rg --type go $'getContextForTx'

Length of output: 347

---

---

Script:

#!/bin/bash
# Description: Examine the implementation of `getContextForTx` to verify mode-specific handling.

# Test: Retrieve the implementation of `getContextForTx` to ensure that the setting for `execModeSimulate` does not affect other modes.
ast-grep --lang go --pattern $'func (app *BaseApp) getContextForTx(mode execMode, txBytes []byte) sdk.Context {
  $$$
}'

Length of output: 1539

[github-actions]

@damiannolan your pull request is missing a changelog!

[tac0turtle]

this was missed in a recent refactor. its only present on main.

[julienrbrt]

We should backport:
https://github.com/cosmos/cosmos-sdk/blob/v0.50.6/baseapp/baseapp.go#L676-L678

[damiannolan]

Thanks for quick merge. Is there any equivalent in v0.47 of ctx.ExecMode() in any way to check if we are in runTxModeSimulate?