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

refactor(genutil): Use sdk types genesis validator #21678

Merged
merged 54 commits into from
Oct 9, 2024

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Sep 12, 2024

Description

follow up to: #21382


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

  • New Features

    • Introduced a new interface for handling public keys from JSON data.
    • Enhanced the application state export to include consensus validators.
    • Added functionality for migrating legacy genesis files to a new format.
    • Integrated staking functionalities into the application.
    • Added new methods for querying application state based on specific versions.
    • Improved compatibility with the Cosmos SDK through standardized validator handling.
  • Bug Fixes

    • Improved robustness in handling validator initialization during tests.
  • Refactor

    • Simplified validator handling by replacing custom structures with standardized SDK types.
    • Streamlined the export process for genesis files.
    • Enhanced state management capabilities with new query functionality.

Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Caution

Review failed

The head commit changed during the review from 687866d to 9b397f0.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new JSONPubKey interface for handling public keys in JSON format, modify the ExportAppStateAndValidators function to include validator information, and replace a custom GenesisValidator struct with sdk.GenesisValidator. These modifications enhance public key management and validator handling across various files, ensuring better integration with the Cosmos SDK while maintaining compatibility with existing structures.

Changes

Files Change Summary
crypto/types/types.go Added a new JSONPubKey interface for JSON-parsed public keys, including methods for address retrieval, byte representation, signature verification, and key type identification.
crypto/codec/pubkey.go Introduced PubKeyToProto and PubKeyFromProto functions for converting between JSONPubkey and cryptotypes.PubKey, ensuring compatibility across different public key formats.
crypto/keys/jsonkey.go Added JSONPubkey type for representing public keys parsed from JSON, with methods for address computation and byte representation.
runtime/v2/app.go Added a Query method to the App struct for querying state at a specific version, enhancing state management capabilities.
simapp/v2/app_di.go Introduced StakingKeeper field in SimApp struct to manage staking functionalities, updating the initialization function accordingly.
simapp/v2/export.go Modified ExportAppStateAndValidators to include a new Validators field populated by current bonded validators, enhancing the export functionality.
types/staking.go Added GenesisValidator struct to represent initial validators with relevant attributes, enhancing the staking module's functionality.
x/genutil/migration/v052/migrate.go Introduced migration utilities for converting legacy genesis files to a new format, ensuring compatibility with updated application structures.
x/genutil/migration/v052/migrate_test.go Added unit tests for the migration of application genesis files, ensuring the integrity of the migration process.
x/genutil/types/genesis.go Updated to use sdk.GenesisValidator instead of cmttypes.GenesisValidator, enhancing compatibility with the SDK's expectations.
x/staking/genesis.go Removed custom GenesisValidator struct, replacing it with sdk.GenesisValidator, simplifying the code and improving integration with the Cosmos SDK.

Possibly related PRs

Suggested reviewers

  • facundomedica
  • testinginprod
  • julienrbrt
  • akhilkumarpilli
  • sontrinh16

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.

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.

@github-actions github-actions bot added C:x/staking C:x/genutil genutil module issues labels Sep 12, 2024
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 13, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

If you can re-add the new GenesisValdiator struct in genutil/v2, then it will solve this as well: #21634

@sontrinh16
Copy link
Member Author

genutil/v2,

i will added it in, just need to fix it to work with json unmarshal

@github-actions github-actions bot added the C:CLI label Sep 17, 2024
@github-actions github-actions bot removed the C:CLI label Sep 18, 2024
@sontrinh16 sontrinh16 marked this pull request as ready for review September 19, 2024 08:35
@julienrbrt julienrbrt added S:blocked Status: Blocked and removed S: DO NOT MERGE Status: DO NOT MERGE labels Oct 7, 2024
@julienrbrt julienrbrt mentioned this pull request Oct 8, 2024
12 tasks
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: 0

🧹 Outside diff range and nitpick comments (2)
runtime/v2/app.go (1)

106-112: LGTM: New Query method implemented correctly.

The Query method is well-implemented and consistent with the codebase. It correctly handles state retrieval and delegates to stf.Query. Good use of context.Context for better control over the operation.

A minor suggestion for improvement:

Consider wrapping the error returned from db.StateAt to provide more context:

 state, err := a.db.StateAt(version)
 if err != nil {
-    return nil, err
+    return nil, fmt.Errorf("failed to get state at version %d: %w", version, err)
 }

This change would make debugging easier by providing more information about the error's origin.

x/genutil/client/cli/migrate.go (1)

65-73: LGTM with suggestion: Consider further refactoring to reduce duplication.

The new code block correctly handles the v0.52 migration differently and uses the v52 constant for comparison, which is good practice. The error handling is consistent with the rest of the function.

However, there's still some duplication in the error handling. Consider further refactoring to reduce this duplication:

var err error
var appGenesis *types.AppGenesis

if target == v52 {
    appGenesis, err = v052.MigrateGenesisFile(importGenesis)
} else {
    appGenesis, err = types.AppGenesisFromFile(importGenesis)
}

if err != nil {
    return err
}

This refactoring would consolidate the error handling and further reduce code duplication.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 496627d and 2d40cef.

📒 Files selected for processing (3)
  • runtime/v2/app.go (2 hunks)
  • simapp/v2/app_di.go (3 hunks)
  • x/genutil/client/cli/migrate.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • simapp/v2/app_di.go
🧰 Additional context used
📓 Path-based instructions (2)
runtime/v2/app.go (1)

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

x/genutil/client/cli/migrate.go (1)

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

🔇 Additional comments (5)
runtime/v2/app.go (1)

4-4: LGTM: Import statement added correctly.

The addition of the context package import is necessary for the new Query method and follows the Uber Go Style Guide for import grouping.

x/genutil/client/cli/migrate.go (4)

16-16: LGTM: Import statement is correct and follows style guidelines.

The new import statement for the v0.52 migration package is correctly aliased and follows the Uber Go Style Guide for imports.


21-21: LGTM: Constant declaration improves code maintainability.

The new constant v52 is well-named and follows the Uber Go Style Guide. Using a constant instead of a string literal improves maintainability. This change also addresses the previous review comment suggesting to use a constant instead of a string.


24-26: LGTM: MigrationMap correctly updated with v0.52 migration.

The MigrationMap has been properly updated to include the v0.52 migration. It correctly uses the newly defined v52 constant and follows Go conventions for map initialization.


63-64: LGTM: Improved organization of flag retrieval.

Moving the outputDocument flag retrieval earlier in the function improves code organization by grouping flag retrievals together. This change doesn't affect functionality and potentially enhances readability.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Could you merge main and run make lint fix?

@sontrinh16
Copy link
Member Author

question, do we still keeps prepForZeroHeightGenesis for v2, i saw it was mentioned soon to be deprecated. If not, how will we handle jailAllowedAddrs as its only being use in prepForZeroHeightGenesis cc @julienrbrt

@julienrbrt
Copy link
Member

question, do we still keeps prepForZeroHeightGenesis for v2, i saw it was mentioned soon to be deprecated. If not, how will we handle jailAllowedAddrs as its only being use in prepForZeroHeightGenesis cc @julienrbrt

I guess we don't need to do all the genesis cleanup we did in v1. That should do it to demonstrate how to export a genesis file.

@julienrbrt
Copy link
Member

Maybe we can just add a comment saying that export may need to be extended at the user discretion for ending in a cleaner genesis state.

if ok {
state, err := writerMap.GetWriter(g.actor)
if err != nil {
panic(err)

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
}

func (r readonlyKVStore) Set(key, value []byte) error {
panic("tried to call Set on a readonly store")

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
}

func (r readonlyKVStore) Delete(key []byte) error {
panic("tried to call Delete on a readonly store")

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
@julienrbrt julienrbrt added this pull request to the merge queue Oct 9, 2024
Merged via the queue into main with commit 4aeb053 Oct 9, 2024
74 of 75 checks passed
@julienrbrt julienrbrt deleted the son/use_sdk_genesis_validator branch October 9, 2024 05:23
julienrbrt pushed a commit that referenced this pull request Oct 9, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Matt Kocubinski <mkocubinski@gmail.com>
julienrbrt added a commit that referenced this pull request Oct 9, 2024
…22183)

Co-authored-by: son trinh <trinhleson2000@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Matt Kocubinski <mkocubinski@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:CLI C:x/genutil genutil module issues C:x/staking S:blocked Status: Blocked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

server/v2: failed to restart node with exported genesis
9 participants