imp: add updateClientCheckTx to redunant relayer ante decorator by damiannolan · Pull Request #6279 · cosmos/ibc-go

damiannolan · 2024-05-08T14:30:12Z

Description

Adds checkTxUpdateClient to ante decorator.

Performs client msg verification and state update only
Omits misbehaviour checks for ante handler checks

Can be released as patch on v7.5.x and v8.3.x but requires additional changes for patching on earlier releases

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Summary by CodeRabbit

New Features
- Enhanced transaction handling for IBC client updates.
Refactor
- Optimized transaction logic for improved performance and reliability.

coderabbitai · 2024-05-08T14:30:18Z

Walkthrough

The update enhances IBC client update handling in the RedundantRelayDecorator to boost transaction check efficiency, especially during CheckTx and RecheckTx.

Changes

File Path	Change Summary
`modules/core/ante/ante.go`	- Imported `errorsmod "cosmossdk.io/errors"` - Added import `github.com/cosmos/ibc-go/v8/modules/core/exported` - Refactored `AnteHandle` function to use `checkTxUpdateClient` for `MsgUpdateClient` processing - Added `checkTxUpdateClient` function for IBC client update logic
`modules/core/ante/ante_test.go`	- Added import `ibctm "github.com/cosmos/ibc-go/v8/modules/light-clients/07-tendermint"` - Included new test cases for `MsgUpdateClient` messages with various scenarios.

Possibly related issues

Speedup RedundantRelayDecorator for Check and RecheckTx #6232: The changes in this PR could potentially address performance concerns noted in the issue by optimizing client update checks in the AnteHandle function, aligning with the proposal to modify handling in CheckTx and RecheckTx.

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

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 edd41da and 0d9c6c5.

Files selected for processing (1)

modules/core/ante/ante.go (3 hunks)

Additional Context Used

Path-based Instructions (1)

modules/core/ante/ante.go (1)

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

Additional comments not posted (2)

modules/core/ante/ante.go (2)

76-76: Integration of checkTxUpdateClient in AnteHandle looks correct and aligns with the PR's objectives.

96-125: The new function checkTxUpdateClient is well-implemented and adheres to the PR's objectives by focusing on verification and state updates without performing misbehavior checks.

coderabbitai

Actionable comments posted: 1

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d9c6c5 and 88229c2.

Files selected for processing (1)

modules/core/ante/ante_test.go (2 hunks)

Additional Context Used

Path-based Instructions (1)

modules/core/ante/ante_test.go (2)

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

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

modules/core/ante/ante_test.go

colin-axner

Thanks for adding the tests!

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 88229c2 and 94d424d.

Files selected for processing (1)

modules/core/ante/ante.go (3 hunks)

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

modules/core/ante/ante.go

sonarqubecloud · 2024-05-13T13:49:55Z

Quality Gate passed for 'ibc-go'

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

* imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx (cherry picked from commit 3da4830) # Conflicts: # modules/core/ante/ante.go # modules/core/ante/ante_test.go

* imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx (cherry picked from commit 3da4830)

* imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx

…6306) * imp: add updateClientCheckTx to redunant relayer ante decorator (#6279) * imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx * refactor: ignore misbehaviour types for UpdateState in ante handler * chore: make lint-fix * test: add misbehaviour testcases to ante handler * lint * chore: add changelog entry --------- Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

…port #6279) (#6304) * imp: add updateClientCheckTx to redunant relayer ante decorator (#6279) * imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx (cherry picked from commit 3da4830) # Conflicts: # modules/core/ante/ante.go # modules/core/ante/ante_test.go * resolve conflicts and add changelog * rm wasm dir * chore: mv changelog * Update modules/core/ante/ante.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

…port #6279) (#6305) * imp: add updateClientCheckTx to redunant relayer ante decorator (#6279) * imp: add checkTxUpdateClient to redunant relayer ante decorator * chore: update godoc and duplicate imports * test: add coverage for checkTxUpdateClient func * chore: rename ante func to updateClientCheckTx (cherry picked from commit 3da4830) * Update modules/core/ante/ante.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

imp: add checkTxUpdateClient to redunant relayer ante decorator

12b939a

damiannolan mentioned this pull request May 8, 2024

Speedup RedundantRelayDecorator for Check and RecheckTx #6232

Closed

3 tasks

chore: update godoc and duplicate imports

0d9c6c5

damiannolan marked this pull request as ready for review May 8, 2024 14:48

damiannolan requested review from AdityaSripal, chatton and colin-axner as code owners May 8, 2024 14:48

colin-axner added backport-to-v8.3.x priority PRs that need prompt reviews labels May 8, 2024

coderabbitai bot reviewed May 8, 2024

View reviewed changes

test: add coverage for checkTxUpdateClient func

88229c2

coderabbitai bot reviewed May 8, 2024

View reviewed changes

modules/core/ante/ante_test.go Show resolved Hide resolved

colin-axner approved these changes May 13, 2024

View reviewed changes

damiannolan requested review from crodriguezvega May 13, 2024 12:55

damiannolan added 2 commits May 13, 2024 15:07

Merge branch 'main' into damian/6232-update-client-checktx

daaa030

chore: rename ante func to updateClientCheckTx

94d424d

damiannolan changed the title ~~imp: add checkTxUpdateClient to redunant relayer ante decorator~~ imp: add updateClientCheckTx to redunant relayer ante decorator May 13, 2024

coderabbitai bot reviewed May 13, 2024

View reviewed changes

colin-axner mentioned this pull request May 13, 2024

perf: Speedup ante-handler's update client check, by only checking in first CheckTx #6241

Closed

10 tasks

Merge branch 'main' into damian/6232-update-client-checktx

46fc826

damiannolan merged commit 3da4830 into main May 14, 2024

damiannolan deleted the damian/6232-update-client-checktx branch May 14, 2024 07:42

mergify bot mentioned this pull request May 14, 2024

imp: add updateClientCheckTx to redunant relayer ante decorator (backport #6279) #6304

Merged

10 tasks

mergify bot mentioned this pull request May 14, 2024

imp: add updateClientCheckTx to redunant relayer ante decorator (backport #6279) #6305

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

imp: add updateClientCheckTx to redunant relayer ante decorator#6279

imp: add updateClientCheckTx to redunant relayer ante decorator#6279
damiannolan merged 6 commits intomainfrom
damian/6232-update-client-checktx

damiannolan commented May 8, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 8, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

colin-axner left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

sonarqubecloud bot commented May 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

damiannolan commented May 8, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

colin-axner left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented May 13, 2024

Quality Gate passed for 'ibc-go'

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

damiannolan commented May 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 8, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)