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: Add module accounts service #22312

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

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Oct 18, 2024

Description

Closes: #XXXX

WIP, want to get comments about the approach before fully committing to it.

type Service interface {
	Register(string) error
	Address(name string) []byte
	Account(ctx context.Context, name string) (sdk.ModuleAccountI, error)
	AllAccounts() map[string][]byte
}

Right now calling Register in a tx call could lead to unexpected behavior, it's only meant to be called during setup. This can change if we stop keeping any kind of state on module accounts.

Account uses x/auth as the backend for now, to not change the current behavior. This is because we do SetModuleAccount (SetAccount), but I think we could just avoid creating any module accounts, I don't see why we would need it at all.

Permissions have been partially removed.

Remaining deps after this PR, which I don't think we can remove as of right now:

// x/bank
type AccountKeeper interface {
	AddressCodec() address.Codec

	GetAccount(ctx context.Context, addr sdk.AccAddress) sdk.AccountI
	HasAccount(ctx context.Context, addr sdk.AccAddress) bool
	SetAccount(ctx context.Context, acc sdk.AccountI)
}

// x/group

type AccountKeeper interface {
	AddressCodec() address.Codec

	// NewAccount returns a new account with the next account number. Does not save the new account to the store.
	NewAccount(context.Context, sdk.AccountI) sdk.AccountI

	// GetAccount retrieves an account from the store.
	GetAccount(context.Context, sdk.AccAddress) sdk.AccountI

	// SetAccount sets an account in the store.
	SetAccount(context.Context, sdk.AccountI)

	// RemoveAccount Remove an account in the store.
	RemoveAccount(ctx context.Context, acc sdk.AccountI)
}

// x/simulation

// AccountKeeper defines the expected account keeper used for simulations (noalias)
type AccountKeeper interface {
	GetAccount(ctx context.Context, addr sdk.AccAddress) sdk.AccountI
}

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

x/auth/keeper/keeper.go Fixed Show fixed Hide fixed
x/staking/keeper/pool.go Fixed Show fixed Hide fixed
Comment on lines 9 to 17
type Service interface {
Register(string) error
Address(name string) []byte
Account(ctx context.Context, name string) (sdk.ModuleAccountI, error)
AllAccounts() map[string][]byte

GetModuleAddress(moduleName string) sdk.AccAddress // TODO: @facu tmp, so I don't have to modify a bunch of things in sims right now
GetAccount(ctx context.Context, addr sdk.AccAddress) sdk.AccountI // TODO: same as above
}
Copy link
Member

Choose a reason for hiding this comment

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

do we need all this? how does ibc use module accounts? do they assume they are created or create them on the fly in the auth module?

Copy link
Member Author

Choose a reason for hiding this comment

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

IBC doesn't seem to be using module accounts on anything that is dynamic (like ICAs).


	GetModuleAddress(moduleName string) sdk.AccAddress                // TODO: @facu tmp, so I don't have to modify a bunch of things in sims right now
	GetAccount(ctx context.Context, addr sdk.AccAddress) sdk.AccountI // TODO: same as above

these are just so it's a drop-in replacement in sims, need to be removed once we change sims.

	Register(string) error
	Address(name string) []byte
	AllAccounts() map[string][]byte

These 3 are the ones required

Account(ctx context.Context, name string) (sdk.ModuleAccountI, error)

I'm looking into removing this one, there are a bunch of places in which we do this call just to get the address, or check if the account it registered.

@julienrbrt julienrbrt self-assigned this Oct 21, 2024
@github-actions github-actions bot added C:x/evidence C:x/genutil genutil module issues labels Oct 21, 2024
Comment on lines +37 to +41
for name, v := range m.accounts {
if bytes.Equal(addr, v.addr) {
return name
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
@github-actions github-actions bot added the C:CLI label Oct 23, 2024
Comment on lines +68 to +70
for k, v := range m.accounts {
accs[k] = v.addr
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines 140 to 146
for _, addr := range moduleAccountsService.AllAccounts() {
addrStr, err := addrCdc.BytesToString(addr)
if err != nil {
panic(err)
}
blockedAddresses[addrStr] = true
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

Comment on lines +36 to +40
for name, v := range m.accounts {
if bytes.Equal(addr, v.addr) {
return name
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines +67 to +69
for k, v := range m.accounts {
accs[k] = v.addr
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
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