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

Remove IBC-rate limits descendant recheck calls #8420

Merged
merged 2 commits into from
Jun 20, 2024

Conversation

ValarDragon
Copy link
Member

@ValarDragon ValarDragon commented Jun 20, 2024

Please note that this is generally, not the best solution, but all we risk is wasted compute getting on-chain at the trade-off of better mempools.

I have whitebox examined, that for Acknowledgement we are gaining nothing. This is running all of PFM's logic and all of the main IBC-go logic. This is not needed for the redundant relay goal.

image

@ValarDragon ValarDragon added V:state/compatible/backport State machine compatible PR, should be backported A:no-changelog A:backport/v25.x backport patches to v25.x branch labels Jun 20, 2024
Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

The recent updates focus on optimizing the IBCModule in ibc_module.go by altering the behavior of the OnAcknowledgementPacket function, which now returns nil instead of invoking im.app.OnAcknowledgementPacket under specific conditions. Additionally, an unnecessary IBC acknowledgements time has been removed from CheckTx/RecheckTx, as noted in the v25.1.2 release of the CHANGELOG.md.

Changes

File Change Summary
x/ibc-rate-limit/ibc_module.go Altered OnAcknowledgementPacket to return nil under certain conditions instead of calling another function
CHANGELOG.md Added note about removing unnecessary IBC acknowledgements time from CheckTx/RecheckTx in v25.1.2

Poem

Amidst the code, where packets roam,
Acknowledgements now find their home.
In CheckTx, time we save,
For efficiency, changes we gave.
With subtle tweaks and lines anew,
Our swift module, proud and true! 🐇📜


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f121350 and 9f55873.

Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional context used
Markdownlint
CHANGELOG.md

1089-1089: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1101-1101: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1110-1110: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1115-1115: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


1167-1167: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time


428-428: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading


691-691: null (MD034, no-bare-urls)
Bare URL used


749-749: null (MD034, no-bare-urls)
Bare URL used


1330-1330: null (MD042, no-empty-links)
No empty links

Additional comments not posted (1)
CHANGELOG.md (1)

55-56: The update in the changelog for removing IBC acknowledgements is clear and concise.


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

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Comment on lines +165 to +166
return nil
// return im.app.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer)
Copy link
Contributor

Choose a reason for hiding this comment

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

Change in transaction handling logic in OnAcknowledgementPacket.

The modification to return nil during IsCheckTx or IsReCheckTx contexts changes the flow significantly. While this may be intended for performance optimization, it's crucial to ensure it doesn't bypass necessary checks or state updates that should occur even in these contexts. Please confirm if all implications of this change have been thoroughly tested.

@ValarDragon ValarDragon merged commit 97b35a8 into main Jun 20, 2024
1 check passed
@ValarDragon ValarDragon deleted the dev/remove_ibc_ack_recheck branch June 20, 2024 22:05
mergify bot pushed a commit that referenced this pull request Jun 20, 2024
* Remove IBC-rate limits descendant recheck calls

* Add Changelog

(cherry picked from commit 97b35a8)
PaddyMc pushed a commit that referenced this pull request Jun 20, 2024
* Remove IBC-rate limits descendant recheck calls

* Add Changelog

(cherry picked from commit 97b35a8)

Co-authored-by: Dev Ojha <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v25.x backport patches to v25.x branch V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants