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: fix the inflows sum adding when sender chain is source chain #2417

Merged
merged 11 commits into from
Feb 8, 2024

Conversation

gsk967
Copy link
Collaborator

@gsk967 gsk967 commented Feb 2, 2024

Description

We are not storing ibc inflow amount when the sender chain is source chain.


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
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Bug Fixes
    • Fixed an issue where registered tokens were incorrectly stored during IBC inflows from the sender chain when it is the source chain. This ensures accurate tracking and verification of tokens across chains.

@gsk967 gsk967 requested a review from a team as a code owner February 2, 2024 15:39
Copy link
Contributor

coderabbitai bot commented Feb 2, 2024

Walkthrough

The recent update primarily addresses a bug in the handling of IBC (Inter-Blockchain Communication) inflows, specifically correcting the logic to accurately determine if the sender chain is the source chain. This ensures that registered tokens are stored correctly during such transactions. Additionally, the update includes code enhancements related to token inflow recording and testing adjustments to reflect these changes accurately.

Changes

File Path Change Summary
x/uibc/quota/quota.go Fixed logic in RecordIBCInflow to accurately identify the sender chain as the source. Added new import for app parameters.
x/uibc/quota/intest/quota_test.go Updated comments and modified inflowBaseDenom to better handle different token types in inflow recording tests.

🐇✨
In the land of code, where the data rivers flow,
A bug was caught, in the IBC's glow.
With a hop and a fix, the chains align once more,
Tokens in place, as they were before.
🌟🐾

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-tests for this file.
  • 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

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 001dab9 and 1b55a2f.
Files selected for processing (1)
  • x/uibc/quota/quota.go (1 hunks)
Additional comments: 1
x/uibc/quota/quota.go (1)
  • 236-236: The logic correction in the RecordIBCInflow function to accurately check if the sender chain is the source chain is crucial for ensuring that inflows are correctly recorded when the sender and source chains are the same. This change addresses the previously inverted logic, aligning with the PR's objective to fix inflow summing issues in such scenarios. The implementation appears to correctly use ics20types.SenderChainIsSource for this purpose, which is a standard approach in IBC-related logic.

@gsk967 gsk967 requested a review from robert-zaremba February 2, 2024 15:42
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1b55a2f and 26c3534.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional comments: 1
CHANGELOG.md (1)

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 26c3534 and be81c97.
Files selected for processing (1)
  • x/uibc/quota/intest/quota_test.go (1 hunks)
Additional comments: 2
x/uibc/quota/intest/quota_test.go (2)
  • 154-156: The comments added in lines 154-156 clarify the scenarios for atomToken creation based on the sender chain. This improves the readability and understanding of the test case.
  • 158-158: The modification of inflowBaseDenom to a specific IBC hash value is consistent with the test scenario where the sender chain is the source chain. This change aligns with the PR's objective to fix inflow summing when the sender chain is the source chain.

Copy link

codecov bot commented Feb 5, 2024

Codecov Report

Attention: 173 lines in your changes are missing coverage. Please review.

Comparison is base (7f05ad4) 75.38% compared to head (75960b6) 69.26%.
Report is 372 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2417      +/-   ##
==========================================
- Coverage   75.38%   69.26%   -6.13%     
==========================================
  Files         100      181      +81     
  Lines        8025    10741    +2716     
==========================================
+ Hits         6050     7440    +1390     
- Misses       1589     2692    +1103     
- Partials      386      609     +223     
Files Coverage Δ
ante/ante.go 74.19% <100.00%> (+25.97%) ⬆️
ante/fee.go 80.82% <100.00%> (+2.47%) ⬆️
ante/spam_prevention.go 81.39% <ø> (+5.46%) ⬆️
app/inflation/inflation.go 100.00% <100.00%> (ø)
app/upgradev3/migrations.go 86.66% <ø> (+8.40%) ⬆️
sdkclient/tx/sign.go 0.00% <ø> (ø)
util/coin/utoken.go 100.00% <100.00%> (ø)
util/genmap/genmap.go 100.00% <100.00%> (ø)
util/ibc/ibc.go 64.28% <ø> (+5.46%) ⬆️
util/sdkutil/events.go 0.00% <ø> (ø)
... and 44 more

... and 138 files with indirect coverage changes

Copy link
Member

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

We need to add few more use cases:

  1. receiving uumee (the native token)
  2. receiving a source token
  3. receiving external token

x/uibc/quota/quota.go Outdated Show resolved Hide resolved
x/uibc/quota/quota.go Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between be81c97 and 5d63dbb.
Files selected for processing (1)
  • x/uibc/quota/quota.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/uibc/quota/quota.go

@robert-zaremba robert-zaremba force-pushed the sai/fix_inflows_calculation branch from 5d63dbb to 13ec153 Compare February 5, 2024 21:39
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between be81c97 and 918ed52.
Files selected for processing (2)
  • x/uibc/quota/intest/quota_test.go (4 hunks)
  • x/uibc/quota/quota.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • x/uibc/quota/intest/quota_test.go
  • x/uibc/quota/quota.go

@gsk967 gsk967 requested a review from robert-zaremba February 7, 2024 10:23
Copy link
Member

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

pre-approving. let's add one more test with the native token inflow

x/uibc/quota/quota.go Outdated Show resolved Hide resolved
x/uibc/quota/quota.go Outdated Show resolved Hide resolved
x/uibc/quota/quota.go Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 918ed52 and 098e6b7.
Files selected for processing (1)
  • x/uibc/quota/quota.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/uibc/quota/quota.go

@gsk967 gsk967 enabled auto-merge February 7, 2024 14:06
@robert-zaremba robert-zaremba merged commit 02ddb58 into main Feb 8, 2024
25 of 27 checks passed
@robert-zaremba robert-zaremba deleted the sai/fix_inflows_calculation branch February 8, 2024 14:53
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.

2 participants