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

docs: add ante precision #18709

Merged
merged 2 commits into from
Dec 13, 2023
Merged

docs: add ante precision #18709

merged 2 commits into from
Dec 13, 2023

Conversation

julienrbrt
Copy link
Member

Description

related #18637

A-26


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

@julienrbrt julienrbrt added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Dec 12, 2023
@julienrbrt julienrbrt requested a review from a team as a code owner December 12, 2023 17:30
Copy link
Contributor

coderabbitai bot commented Dec 12, 2023

Walkthrough

The recent updates involve clarifications on how transaction handlers process nested messages within a blockchain framework. Specifically, the documentation now explains that ante handlers only execute on the outermost message of a transaction, while inner messages bypass this step and go directly to the message router. Additionally, the behavior of the CircuitBreakerDecorator is clarified, noting that it does not examine inner messages, which could allow certain transactions to pass the ante handler but will still be caught by the message router.

Changes

File Path Change Summary
docs/learn/beginner/01-tx-lifecycle.md Added a warning about ante handlers only running on the outer message of transactions with multiple messages.
x/circuit/README.md Clarified that CircuitBreakerDecorator does not inspect inner messages but this does not affect the circuit breaker's functionality due to the message router check.

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 X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment from CodeRabbit.
  • You can also chat with CodeRabbit bot directly around the specific lines of code or files in the PR by tagging @coderabbitai in a new comment.
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase.

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

@@ -112,6 +112,10 @@ A copy of the cached context is provided to the `AnteHandler`, which performs li

For example, the [`auth`](https://github.com/cosmos/cosmos-sdk/tree/main/x/auth) module `AnteHandler` checks and increments sequence numbers, checks signatures and account numbers, and deducts fees from the first signer of the transaction - all state changes are made using the `checkState`.

:::warning
Note that ante handlers only run on a transaction. If a transaction embed multiple messages (like some x/authz, x/gov txs for instance), the ante handlers will run on the outer message. Inner messages are mostly directly routed to the [message router](https://docs.cosmos.network/main/learn/advanced/baseapp#msg-service-router) and skip the ante handler. This is something to keep in mind when designing your own ante handler.
Copy link
Contributor

Choose a reason for hiding this comment

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

... the ante handlers will run on the outer message.

I would perhaps consider rephrasing this. I think what you mean to say is that the AnteHandler chain has context or awareness of only the outer messages, not that it runs or processes them. I just want to avoid ambiguity or confusion.

Copy link
Contributor

@atheeshp atheeshp left a comment

Choose a reason for hiding this comment

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

lgtm

@julienrbrt julienrbrt added this pull request to the merge queue Dec 13, 2023
Merged via the queue into main with commit 49825ea Dec 13, 2023
48 of 53 checks passed
@julienrbrt julienrbrt deleted the julien/docs-ante branch December 13, 2023 06:55
mergify bot pushed a commit that referenced this pull request Dec 13, 2023
(cherry picked from commit 49825ea)

# Conflicts:
#	x/circuit/README.md
mergify bot pushed a commit that referenced this pull request Dec 13, 2023
(cherry picked from commit 49825ea)

# Conflicts:
#	x/circuit/README.md
julienrbrt added a commit that referenced this pull request Dec 13, 2023
julienrbrt added a commit that referenced this pull request Dec 13, 2023
@faddat faddat mentioned this pull request Mar 20, 2024
12 tasks
emidev98 pushed a commit to terra-money/cosmos-sdk that referenced this pull request Mar 21, 2024
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants