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

test: Fix total supply bug in test util GenesisStateWithValSet #23072

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

migueldingli1997
Copy link
Contributor

@migueldingli1997 migueldingli1997 commented Dec 24, 2024

Description

Very small change, so it's easier to check the files changed.


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 (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

Summary by CodeRabbit

  • Bug Fixes
    • Updated the calculation for the total amount of coins in the bonded pool module account to reflect the total bonded amount across all delegations.

@migueldingli1997 migueldingli1997 requested a review from a team as a code owner December 24, 2024 09:29
Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the GenesisStateWithValSet function in the testutil/sims/app_helpers.go file. The key change involves adjusting the coin amount calculation for the bonded pool module account. Instead of using a fixed bondAmt, the new implementation multiplies bondAmt by the number of delegations, effectively scaling the total coin supply to reflect the cumulative bonded amount across all delegations.

Changes

File Change Summary
testutil/sims/app_helpers.go Updated coin amount calculation in GenesisStateWithValSet function to multiply bondAmt by delegation count

Possibly related PRs

Suggested labels

backport/v0.52.x

Suggested reviewers

  • akhilkumarpilli
  • sontrinh16

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2f8d and 715d88b.

📒 Files selected for processing (1)
  • testutil/sims/app_helpers.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
testutil/sims/app_helpers.go (1)

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

🔇 Additional comments (1)
testutil/sims/app_helpers.go (1)

276-276: Ensure the multiplied bonded amount matches the updated total supply

Multiplying bondAmt by the number of delegations correctly reflects the total bonded amount in the bonded pool. This change aligns with the PR objective of scaling the total coin supply based on the delegations. However, to avoid unintended issues if a large number of delegations exists, confirm that:

  1. The total supply logic remains consistent with this multiplication.
  2. There are no downstream assumptions depending on the original single bondAmt approach.

Consider running the following quick check to confirm the usage of the updated GenesisStateWithValSet function across the repo:

✅ Verification successful

Let me gather more information about the total supply and bonded pool logic.


Multiplication of bondAmt by delegations count is correctly implemented

The verification shows that the total supply calculation is properly handled in the GenesisStateWithValSet function:

  1. The total supply is tracked and updated for each validator: totalSupply = totalSupply.Add(sdk.NewCoin(sdk.DefaultBondDenom, bondAmt))
  2. The bonded pool balance is correctly set with the multiplied amount: bondAmt.MulRaw(int64(len(delegations)))
  3. The final bank genesis state is created with the correct total supply: bankGenesis := banktypes.NewGenesisState(..., balances, totalSupply, ...)

The implementation maintains consistency between the bonded pool balance and total supply, and the function is used appropriately in test utilities across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Quickly search for references to GenesisStateWithValSet and show context.
rg -A 5 'GenesisStateWithValSet'

Length of output: 1610


Script:

#!/bin/bash
# Check for any supply or bonded pool related code in the test utilities
rg -A 5 "bondAmt|BondDenom|TotalSupply|BondedPool" testutil/

# Check for any genesis state modifications related to bonding
ast-grep --pattern 'func GenesisStateWithValSet($$$) {
  $$$
}'

Length of output: 4756


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@@ -273,7 +273,7 @@ func GenesisStateWithValSet(
// add bonded amount to bonded pool module account
balances = append(balances, banktypes.Balance{
Address: authtypes.NewModuleAddress(stakingtypes.BondedPoolName).String(),
Coins: sdk.Coins{sdk.NewCoin(sdk.DefaultBondDenom, bondAmt)},
Coins: sdk.Coins{sdk.NewCoin(sdk.DefaultBondDenom, bondAmt.MulRaw(int64(len(delegations))))},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Before, was assuming that there is only one delegation (to one validator). But if multiple validators are specified, they get one delegation each.

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