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

feat(core): Add get module accounts service to core appmodule #22138

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Oct 7, 2024

Description

  • Quick one to get a psuedo core version from main

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 data structure for managing module accounts, enhancing the ability to retrieve and manage account information.
    • Added an interface to facilitate access to module accounts.

These updates improve the overall functionality and flexibility of the application for users interacting with module accounts.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

📝 Walkthrough

Walkthrough

The changes introduce a new type ModuleAccount and a new interface HasModuleAccounts in the appmodulev2 package. The ModuleAccount type consists of two fields: Name and Address. The HasModuleAccounts interface mandates the implementation of a method GetModuleAccounts() that returns a slice of ModuleAccount. These additions enhance the module's ability to manage and retrieve module account information while preserving the existing interfaces.

Changes

File Path Change Summary
core/appmodule/v2/module.go - New type ModuleAccount defined with fields Name (string) and Address (byte slice).
- New interface HasModuleAccounts added, requiring GetModuleAccounts() method returning a slice of ModuleAccount.

Sequence Diagram(s)

sequenceDiagram
    participant Module as Module
    participant HasModuleAccounts as HasModuleAccounts Interface
    participant ModuleAccount as ModuleAccount Type

    Module->>HasModuleAccounts: GetModuleAccounts()
    HasModuleAccounts-->>Module: Return []ModuleAccount
Loading

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.

Copy link
Contributor

github-actions bot commented Oct 7, 2024

@sontrinh16 your pull request is missing a changelog!

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 (1)
core/appmodule/v2/module.go (1)

107-117: Consider grouping related interfaces and structs

While the implementation is correct, consider grouping the ModuleAccount struct and HasModuleAccounts interface with other related types for better code organization. This could improve readability and maintainability of the file.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7ff7454 and 2540190.

📒 Files selected for processing (1)
  • core/appmodule/v2/module.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
core/appmodule/v2/module.go (1)

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

🔇 Additional comments (2)
core/appmodule/v2/module.go (2)

108-112: LGTM: ModuleAccount struct is well-defined

The ModuleAccount struct is correctly implemented with appropriate field types and follows Go naming conventions. The comment provides a clear description of its purpose.


114-117: LGTM: HasModuleAccounts interface is well-defined

The HasModuleAccounts interface is correctly implemented with a clear and descriptive method. It follows Go naming conventions and is properly documented.

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 we are going this way (which I am not sure we were long term), I would put this as a service and not an app appmodule interface.

@@ -104,3 +104,14 @@ type ValidatorUpdate struct {
type HasRegisterInterfaces interface {
RegisterInterfaces(registry.InterfaceRegistrar)
}

// ModuleAccount defines a module account info get from the module.
type ModuleAccount struct {
Copy link
Member

Choose a reason for hiding this comment

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

It seems this is only would be for genesis module accounts. when a chain creates them dynamically this would fail because it may not be present correct? Maybe we name is something to identify genesis accounts or put it in the go doc

Copy link
Member Author

Choose a reason for hiding this comment

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

wdym create them dynamically, like we create new module accounts besides the genesis one ?

@sontrinh16
Copy link
Member Author

If we were going this way (which I am sure we were long term). I would put this as a service and not an app appmodule interface.

a service in runtime right ?

@julienrbrt
Copy link
Member

If we were going this way (which I am sure we were long term). I would put this as a service and not an app appmodule interface.

a service in runtime right ?

A service in core, implemented by runtime yes.

@sontrinh16 sontrinh16 marked this pull request as draft October 7, 2024 09:08
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.

3 participants