use correct supply when determining proportions #1389

joe-bowman · 2024-04-04T13:13:59Z

1. Summary

Fixes #1388

2.Type of change

Bug fix (non-breaking change which fixes an issue)

3. Implementation details

Use supply of zone.LocalDenom and not zone.BaseDenom to determine how to distribute rewards.

Summary by CodeRabbit

Refactor
- Modified the supply retrieval process in interchain staking to enhance accuracy and efficiency.

vercel · 2024-04-04T13:14:05Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
quicksilver	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 8, 2024 4:19pm

coderabbitai · 2024-04-04T13:14:08Z

Walkthrough

This update involves a crucial fix in the HandleMsgTransfer function within the ibc_packet_handlers.go file, specifically in the way the DistributeToClaimants function retrieves supply information. The modification transitions from using zone.BaseDenom to zone.LocalDenom when interacting with BankKeeper, addressing a critical divide by zero error encountered during IBC transfer packet delivery.

Changes

File	Change Summary
`x/interchainstaking/keeper/ibc_packet_handlers.go`	Modified `DistributeToClaimants` to use `zone.LocalDenom` for supply retrieval from `BankKeeper`.

Assessment against linked issues

Objective	Addressed	Explanation
#1388: Fix divide by zero error during IBC transfer packet delivery	✅

A Bunny's Ode to Code

In the realm of chains that intertwine,
A bug did lurk, unseen, malign.
'Twas a rabbit, swift and keen,
Who found the glitch, wiped the slate clean.
With a hop and a skip, the code did align,
🌟 "No more errors, all is fine!"
Cheers to the devs, with minds so divine.

🐇🎉

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: 4

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cacb972 and 8833564.

Files selected for processing (1)

x/interchainstaking/keeper/ibc_packet_handlers.go (1 hunks)

x/interchainstaking/keeper/ibc_packet_handlers.go

coderabbitai

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8833564 and d1da428.

Files selected for processing (1)

x/interchainstaking/keeper/ibc_packet_handlers_test.go (5 hunks)

codecov · 2024-04-05T02:28:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.60%. Comparing base (1683da8) to head (6eaac54).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1389   +/-   ##
=======================================
  Coverage   63.60%   63.60%           
=======================================
  Files         171      171           
  Lines       11652    11652           
=======================================
  Hits         7411     7411           
  Misses       3497     3497           
  Partials      744      744

Flag	Coverage Δ
unittests	`63.60% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
x/interchainstaking/keeper/ibc_packet_handlers.go	`65.25% <100.00%> (ø)`

tuantran1702

LGTM

joe-bowman · 2024-04-08T16:22:51Z

This pull request has been deployed to Vercel.

Latest commit:	`6eaac54`
✅ Preview:	https://pr-1389.app-dev.quicksilver.zone
🔍 Inspect:	https://vercel.com/quicksilver/quicksilver/7kn33QzC47ohCZobSUyAQEMZhhAu

View Workflow Logs

* fix undefined window error (#1396) * chore(deps): bump github.com/cosmos/ibc-go/v5 from 5.3.2 to 5.4.0 (#1398) Bumps [github.com/cosmos/ibc-go/v5](https://github.com/cosmos/ibc-go) from 5.3.2 to 5.4.0. - [Release notes](https://github.com/cosmos/ibc-go/releases) - [Changelog](https://github.com/cosmos/ibc-go/blob/v5.4.0/CHANGELOG.md) - [Commits](cosmos/ibc-go@v5.3.2...v5.4.0) --- updated-dependencies: - dependency-name: github.com/cosmos/ibc-go/v5 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump golang.org/x/tools from 0.19.0 to 0.20.0 (#1392) Bumps [golang.org/x/tools](https://github.com/golang/tools) from 0.19.0 to 0.20.0. - [Release notes](https://github.com/golang/tools/releases) - [Commits](golang/tools@v0.19.0...v0.20.0) --- updated-dependencies: - dependency-name: golang.org/x/tools dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump google.golang.org/grpc from 1.62.1 to 1.63.0 (#1383) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.62.1 to 1.63.0. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.62.1...v1.63.0) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joe Bowman <[email protected]> * use correct supply when determining proportions (#1389) * use correct supply when determining proportions * fix HandleMsgTransfer tests --------- Co-authored-by: Tuan Tran <[email protected]> * Reinstate the TestAggregateIntentWithPRClaims (#1320) * fix(intent-test): fix the claim to match the supply * refactor: enable some tests and convert them to keeper tests * fix int64 to sdkmath.Int * rename alias to sdkmath to avoid confusion * fix claim to match supply * remove balance * add unclaimedRatio * add multi claim, less than 100% supply * add tests, write comment for reasoning expected output * fix tests failing due to #1345 * fix test --------- Co-authored-by: Jacob Gadikian <[email protected]> Co-authored-by: Joe Bowman <[email protected]> * fix: Withdrawal records should not exist with 0 burnAmount (#1284) * add guard to ```AddWithdrawalRecord``` and ```SetWithdrawalRecord``` * fix tests missing BurnAmount field * return error instead of panic for ```SetwithdrawalRecord``` and ```AddWithdrawalRecord``` * fix linting * return error * refactor to check for error * add missing BurnAmount field in TestGetRatio * refactor test * add old function for testing upgrade handler * add upgrade handler and test * add Upgrade handler to testnet upgrades * Update x/interchainstaking/keeper/withdrawal_record.go comment Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * add test for set withdrawal records * refactor: remove old code from keeper * linting * linting * resolve conflict, fix upgrade name * linting --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Jacob Gadikian <[email protected]> Co-authored-by: Joe Bowman <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Joseph Chalabi <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joe Bowman <[email protected]> Co-authored-by: Tuan Tran <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

use correct supply when determining proportions

8833564

joe-bowman requested review from faddat, minhngoc274 and tuantran1702 as code owners April 4, 2024 13:14

joe-bowman temporarily deployed to Preview April 4, 2024 13:16 Inactive

coderabbitai bot reviewed Apr 4, 2024

View reviewed changes

x/interchainstaking/keeper/ibc_packet_handlers.go Show resolved Hide resolved

x/interchainstaking/keeper/ibc_packet_handlers.go Show resolved Hide resolved

joe-bowman added the deployed label Apr 4, 2024

fix HandleMsgTransfer tests

d1da428

vercel bot temporarily deployed to Preview April 5, 2024 02:17 Inactive

joe-bowman temporarily deployed to Preview April 5, 2024 02:18 Inactive

coderabbitai bot reviewed Apr 5, 2024

View reviewed changes

Merge branch 'main' into fix-supply-calc

8ccf0bf

tuantran1702 approved these changes Apr 5, 2024

View reviewed changes

vercel bot temporarily deployed to Preview April 5, 2024 02:30 Inactive

joe-bowman temporarily deployed to Preview April 5, 2024 02:30 Inactive

Merge branch 'main' into fix-supply-calc

0ec4d19

joe-bowman temporarily deployed to Preview April 8, 2024 07:34 Inactive

Merge branch 'main' into fix-supply-calc

6eaac54

vercel bot temporarily deployed to Preview April 8, 2024 16:19 Inactive

joe-bowman temporarily deployed to Preview April 8, 2024 16:20 Inactive

joe-bowman merged commit 0e8a129 into main Apr 8, 2024
26 checks passed

joe-bowman deleted the fix-supply-calc branch April 8, 2024 16:30

faddat mentioned this pull request Apr 11, 2024

faddat/resolve v47 conflicts #1413

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use correct supply when determining proportions #1389

use correct supply when determining proportions #1389

joe-bowman commented Apr 4, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Apr 4, 2024 •

edited

Loading

coderabbitai bot commented Apr 4, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

codecov bot commented Apr 5, 2024 •

edited

Loading

tuantran1702 left a comment

joe-bowman commented Apr 8, 2024

use correct supply when determining proportions #1389

use correct supply when determining proportions #1389

Conversation

joe-bowman commented Apr 4, 2024 • edited by coderabbitai bot Loading

1. Summary

2.Type of change

3. Implementation details

Summary by CodeRabbit

vercel bot commented Apr 4, 2024 • edited Loading

coderabbitai bot commented Apr 4, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 5, 2024 • edited Loading

Codecov Report

tuantran1702 left a comment

Choose a reason for hiding this comment

joe-bowman commented Apr 8, 2024

joe-bowman commented Apr 4, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Apr 4, 2024 •

edited

Loading

coderabbitai bot commented Apr 4, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Apr 5, 2024 •

edited

Loading