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

fix: use cache context at ibc hook #288

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Conversation

beer-1
Copy link
Contributor

@beer-1 beer-1 commented Oct 18, 2024

Description

Closes: #XXXX


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, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • 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

@beer-1 beer-1 self-assigned this Oct 18, 2024
@beer-1 beer-1 marked this pull request as ready for review October 18, 2024 08:54
@beer-1 beer-1 requested a review from a team as a code owner October 18, 2024 08:54
Copy link

coderabbitai bot commented Oct 18, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the MoveHooks struct's methods in the receive.go file. Key updates include enhancements to the handling of the Receiver field in packet data for both ICS20 and ICS721 packets, which are now assigned from the intermediateSender. Additionally, the execMsg method has been updated to incorporate a caching mechanism for message execution, ensuring that state changes only occur upon successful execution.

Changes

File Path Change Summary
x/ibc-hooks/move-hooks/receive.go Updated onRecvIcs20Packet and onRecvIcs721Packet to assign Receiver from intermediateSender. Modified onRecvIcs721Packet to change Data field handling. Altered execMsg to implement a caching mechanism for message execution.

Poem

In the land where packets flow,
A rabbit hops with joy aglow.
With caching tricks and fields anew,
The hooks now dance, a lively crew!
Hooray for changes, swift and bright,
In the code, we find delight! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 85a29a9 and acbe07f.

📒 Files selected for processing (1)
  • x/ibc-hooks/move-hooks/receive.go (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
x/ibc-hooks/move-hooks/receive.go (1)

127-138: Correct implementation of cached context to safeguard state changes

The use of ctx.CacheContext() effectively ensures that any state modifications resulting from moveMsgServer.Execute are only committed if the execution is successful. This approach prevents unintended state changes in case of execution failures, enhancing the robustness of the code.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 70.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 40.68%. Comparing base (f05fdbd) to head (acbe07f).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
x/ibc-hooks/move-hooks/receive.go 70.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #288      +/-   ##
==========================================
+ Coverage   40.64%   40.68%   +0.03%     
==========================================
  Files         267      267              
  Lines       25415    25432      +17     
==========================================
+ Hits        10331    10347      +16     
- Misses      13499    13500       +1     
  Partials     1585     1585              
Files with missing lines Coverage Δ
x/ibc-hooks/move-hooks/receive.go 59.55% <70.00%> (+0.80%) ⬆️

... and 1 file with indirect coverage changes

@beer-1 beer-1 merged commit 2c304ca into main Oct 21, 2024
11 checks passed
@beer-1 beer-1 deleted the fix/ibc-hook-cache-context branch October 21, 2024 02:25
beer-1 added a commit that referenced this pull request Oct 23, 2024
beer-1 added a commit that referenced this pull request Oct 24, 2024
* support multisend

* bump movevm to v0.5.1

* add missing stargate query support (#285)

* fix nil memory access on authz (#281)

* fix: allow to be failed with invalid message without error (#283)

* allow to failed with invalid message

* set reason

* fix to consider movevm gas scale when we use infinity gas meter (#287)

* fix to use cache context at ibc hook (#288)

* feat: enable whitelist stableswap (#289)

* enable whitelist stableswap

* check division by zero and handle default values for balancer

* remove unnecessary slices.Copy

* ignore error

* fix test

* apply coderabbit comment

* emit same events with cosmos-sdk interface

* create account if not exists
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant