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

refactor(x/auth/ante): migrate antehandlers to use execmode #19161

Merged
merged 8 commits into from
Jan 24, 2024

Conversation

tac0turtle
Copy link
Member

Description

This pr migrates antehandlers to use execmode from context instead of the passed simulate


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

Comment on lines 884 to 890
// performance benefits, but it'll be more difficult to get right.
anteCtx, msCache = app.cacheTxContext(ctx, txBytes)
anteCtx = anteCtx.WithEventManager(sdk.NewEventManager())
if mode == execModeSimulate {
anteCtx = anteCtx.WithExecMode(sdk.ExecMode(execModeSimulate))
}
newCtx, err := app.anteHandler(anteCtx, tx, mode == execModeSimulate)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change potentially affects state.

Call sequence:

(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).runTx (baseapp/baseapp.go:814)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).deliverTx (baseapp/baseapp.go:744)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).internalFinalizeBlock (baseapp/baseapp.go:713)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).FinalizeBlock (baseapp/baseapp.go:874)

@tac0turtle tac0turtle marked this pull request as ready for review January 22, 2024 19:49
@tac0turtle tac0turtle requested a review from a team as a code owner January 22, 2024 19:49
Copy link
Contributor

coderabbitai bot commented Jan 22, 2024

Walkthrough

The overall change involves a transition in the codebase from using specific boolean fields (checkTx and recheckTx) to a more versatile execMode field within the Context struct. This new field standardizes the way execution modes are checked across various functions, particularly affecting transaction simulation, gas metering, and signature verification processes. By deprecating the old fields and introducing a unified execution mode check, the codebase simplifies context checks and aligns with a future version upgrade.

Changes

File(s) Change Summary
baseapp/baseapp.go Introduced a conditional modification to anteCtx adding an execution mode based on the mode parameter.
types/context.go Deprecated checkTx and recheckTx fields in favor of execMode, which will be removed after version 0.51.
x/auth/ante/basic.go, x/auth/ante/validator_tx_fee.go Replaced checks for simulate and transaction types with ctx.ExecMode() comparisons.
x/auth/ante/basic_test.go Added setting of execution mode to simulate in the TestConsumeGasForTxSize function.
x/auth/ante/setup.go, x/auth/ante/fee.go Updated functions to use ctx.ExecMode() for gas metering, fee deduction, and validation logic.
x/auth/ante/sigverify.go Removed simulate parameter from functions, replacing it with context-based execution mode checks.
x/auth/ante/ante_test.go, x/auth/ante/fee_test.go Modified test functions to align with the updated context-based execution mode handling.
x/auth/CHANGELOG.md Removed StdTxConfig and simulate from SetGasMeter, indicating potential alterations to the API and consensus functionality.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, thanks @tac0turtle

@julienrbrt julienrbrt changed the title chore(auth/ante): migrate antehandlers to use execmode refactor(x/auth/ante): migrate antehandlers to use execmode Jan 22, 2024
x/auth/ante/setup.go Outdated Show resolved Hide resolved
x/auth/ante/sigverify.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@tac0turtle tac0turtle added this pull request to the merge queue Jan 24, 2024
Merged via the queue into main with commit 9945d31 Jan 24, 2024
55 of 58 checks passed
@tac0turtle tac0turtle deleted the marko/ante_execmode branch January 24, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants