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(orm)!: support core genesis #14822

Merged
merged 7 commits into from
Feb 7, 2023
Merged

refactor(orm)!: support core genesis #14822

merged 7 commits into from
Feb 7, 2023

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Jan 27, 2023

Description

This refactors the ORM's JSON code to support the core API genesis. Module's using the ORM would just need to embed to do something like this:

type Keeper struct {
  appmodule.HasGenesis
  ...
}

func NewKeeper(db ormdb.ModuleDB) *Keeper {
  ...
  return &Keeper{HasGenesis: db.AppModuleGenesis(), ...}
}

This also fixes a broken test introduced in #14796. Maybe something is broken in CI??


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
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • 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 ! in the type prefix if API or client breaking change
  • 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)

@github-actions github-actions bot added the C:orm label Jan 27, 2023
// func NewKeeper(db ModuleDB) *Keeper {
// return &Keeper{HasGenesis: db.AppModuleGenesis()}
// }
AppModuleGenesis() appmodule.HasGenesis
Copy link
Member Author

Choose a reason for hiding this comment

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

Or maybe simply:

Suggested change
AppModuleGenesis() appmodule.HasGenesis
Genesis() appmodule.HasGenesis

Copy link
Member Author

Choose a reason for hiding this comment

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

Renamed to GenesisHandler. That feels a bit better

@aaronc aaronc marked this pull request as ready for review January 27, 2023 17:55
@aaronc aaronc requested a review from a team as a code owner January 27, 2023 17:55
Copy link
Member

@facundomedica facundomedica left a comment

Choose a reason for hiding this comment

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

LGTM, we might need a changelog entry

@aaronc
Copy link
Member Author

aaronc commented Feb 6, 2023

Added a CHANGELOG.md. Going to enable auto-merge unless anyone has any objections

@aaronc aaronc enabled auto-merge (squash) February 6, 2023 17:47
@aaronc aaronc merged commit 85e5896 into main Feb 7, 2023
@aaronc aaronc deleted the aaronc/orm-core-genesis branch February 7, 2023 15:24
tsenart pushed a commit to meka-dev/cosmos-sdk that referenced this pull request Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants