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 (x/accounts): Fix genesis condition check #20645

Merged
merged 13 commits into from
Jun 12, 2024
Merged

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Jun 12, 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 (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
    • Improved the initialization process by checking the length of genesis accounts, ensuring accurate account number settings.

@sontrinh16 sontrinh16 requested a review from a team as a code owner June 12, 2024 15:38
Copy link
Contributor

coderabbitai bot commented Jun 12, 2024

Warning

Rate limit exceeded

@sontrinh16 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 32 minutes and 49 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 6ba785b and a690caa.

Walkthrough

The change in the ImportState function of the Keeper in x/accounts/genesis.go involves modifying the logic to check the length of genState.Accounts instead of checking for its nil value. This ensures that the function accurately determines the presence of genesis accounts before setting the latest account number.

Changes

File Path Change Summary
x/accounts/genesis.go Updated ImportState function to check the length of genState.Accounts instead of its nil value.

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.

@sontrinh16 sontrinh16 assigned sontrinh16 and unassigned sontrinh16 Jun 12, 2024
@sontrinh16 sontrinh16 changed the title refactor (x/accounts): Fix genesis contion check refactor (x/accounts): Fix genesis condition check Jun 12, 2024
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

can we modify a test case to make sure this isnt changed in the future

@sontrinh16
Copy link
Member Author

can we modify a test case to make sure this isnt changed in the future

gotcha

@tac0turtle tac0turtle changed the title refactor (x/accounts): Fix genesis condition check fix (x/accounts): Fix genesis condition check Jun 12, 2024
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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 40492cd and 6ba785b.

Files selected for processing (1)
  • x/accounts/genesis.go (1 hunks)
Additional context used
Path-based instructions (1)
x/accounts/genesis.go (1)

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

Additional comments not posted (1)
x/accounts/genesis.go (1)

77-77: The change from checking if genState.Accounts is nil to checking its length is a logical improvement. It ensures that the function behaves correctly even when genState.Accounts is an empty slice, not just nil.

@@ -74,7 +74,7 @@ func (k Keeper) ImportState(ctx context.Context, genState *v1.GenesisState) erro

// we set the latest account number only if there were any genesis accounts, otherwise
// we leave it unset.
if genState.Accounts != nil {
if len(genState.Accounts) != 0 {
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider enhancing the error message formatting to include more context about the error, which could help in debugging. For example, including the account number along with the address might provide quicker insights during issues.

- return fmt.Errorf("%w: %s", err, acc.Address)
+ return fmt.Errorf("error importing account %d (%s): %w", acc.AccountNumber, acc.Address, err)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if len(genState.Accounts) != 0 {
if len(genState.Accounts) != 0 {
for _, acc := range genState.Accounts {
if err := k.importAccount(ctx, acc); err != nil {
return fmt.Errorf("error importing account %d (%s): %w", acc.AccountNumber, acc.Address, err)
}
}
}

Copy link
Contributor

@sontrinh16 your pull request is missing a changelog!

@sontrinh16
Copy link
Member Author

can we modify a test case to make sure this isnt changed in the future

done

@testinginprod testinginprod added this pull request to the merge queue Jun 12, 2024
Merged via the queue into main with commit abeb7ee Jun 12, 2024
64 of 66 checks passed
@testinginprod testinginprod deleted the fix_fail_system_test branch June 12, 2024 16:29
alpe added a commit that referenced this pull request Jun 13, 2024
* main:
  fix(x/staking): stop validators from rotating to the same key on the same block (#20649)
  perf: add cache to address codec (#20122)
  build(deps): Bump google.golang.org/protobuf from 1.34.1 to 1.34.2 (#20632)
  fix: remove recipient amount from map (#20625)
  fix(proto): remove conditional preventing proper generated file placement (#20650)
  (serverv2/cometbft) Read config from commands & handle `FlagNode` (#20621)
  fix(x/consensus): fix .proto file placement (#20646)
  fix(store): avoid nil error on not exhausted payload stream (#20644)
  fix (x/accounts): Fix genesis condition check (#20645)
  feat(accounts): add genesis account initialization (#20642)
  fix(x/gov): limit execution in gov (#20348)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants