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(x/auth): auth module can recognize x/accounts account #20002

Merged
merged 13 commits into from
Apr 11, 2024

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Apr 10, 2024

Description

This is to help lockup account execute delegate and undelegate. Bank module now can skip the TrackDelegation and TrackUndelegation process for legacy vesting account if the address belong to an accounts module account

thanks @likhita-809 ( i have to borrow some of your code 🙏 ) for easing my process of adding x/accounts depinject 🙏


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
  • 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.

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

    • Integrated a new accounts module to enhance account management capabilities.
    • Enhanced account verification to recognize and manage smart accounts effectively.
  • Enhancements

    • Expanded the app configuration to include new modules for better functionality.
  • Bug Fixes

    • Adjusted account checking logic to incorporate checks for smart account status, improving reliability.

@sontrinh16 sontrinh16 marked this pull request as ready for review April 10, 2024 23:04
@sontrinh16 sontrinh16 requested a review from a team as a code owner April 10, 2024 23:04
Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Walkthrough

Walkthrough

The changes involve enhancing the account management system by integrating an AccountsKeeper into the SimApp structure. These modifications impact various components of the application, including initialization functions, method additions for account checks, and updates to configurations across multiple files. The adjustments aim to improve account management by introducing checks for smart accounts and integrating new modules related to account functionalities.

Changes

Files Change Summary
simapp/app.go, simapp/app_di.go Added AccountsKeeper to SimApp and updated NewSimApp function with the new argument.
simapp/app_config.go Introduced imports and configurations for new accounts modules.
simapp/simd/cmd/testnet_test.go Added AccountsModule to configuration in the test setup, increasing the module count.
testutil/configurator/..., testutil/network/... Included a new AccountsModule function and updated configurations to incorporate accounts module settings.
x/accounts/..., x/auth/... Enhanced account management by adding methods and fields related to AccountsModKeeper, including checks for smart accounts in various functions.
x/auth/types/expected_keepers.go Defined a new interface AccountsModKeeper to facilitate interactions with the accounts module.

Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between df6ae24 and b62f90e.
Files selected for processing (1)
  • x/auth/keeper/keeper.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/auth/keeper/keeper.go

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

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: 3

Comment on lines 129 to 136
// IsAccountsModuleAccount check if an address belong to a smart account.
func (k Keeper) IsAccountsModuleAccount(
ctx context.Context,
accountAddr []byte,
) bool {
_, err := k.AccountByNumber.Get(ctx, accountAddr)
return err == nil
}
Copy link
Contributor

Choose a reason for hiding this comment

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

The method IsAccountsModuleAccount checks if an account number exists rather than verifying if the account is a "smart account". Please clarify the intended functionality or adjust the implementation to match the description.

x/auth/keeper/keeper_test.go Show resolved Hide resolved
x/auth/ante/testutil_test.go Show resolved Hide resolved
x/accounts/keeper.go Outdated Show resolved Hide resolved
@@ -439,6 +439,10 @@ func (k BaseKeeper) setSupply(ctx context.Context, coin sdk.Coin) {
func (k BaseKeeper) trackDelegation(ctx context.Context, addr sdk.AccAddress, balance, amt sdk.Coins) error {
acc := k.ak.GetAccount(ctx, addr)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if we should provide a way for GetAccount to work for x/accounts.

I think the way i'd handle this is:

  • GetAccount
  • try on x/auth state
  • If not exist:
    • check on x/accounts
    • fetch account type from x/accounts
      • if account type == "base_account" (the one living in default/base)
        • then convert it into BaseAccount struct
      • else: return it as a private implementation.

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah i was thinking of adding an query handler just for auth getAccount to return some type of usable account info struct

Copy link
Member Author

Choose a reason for hiding this comment

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

but for the sake of pushing this to unblock e2e test for auditing, we can move this to another PR

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

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

LGTM, but I'd take time to better handle the GetAccount case.

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

@@ -101,7 +103,10 @@ func createOldPolicyAccount(ctx sdk.Context, storeKey storetypes.StoreKey, cdc c
if err != nil {
return nil, nil, err
}
accountKeeper := authkeeper.NewAccountKeeper(runtime.NewEnvironment(runtime.NewKVStoreService(storeKey.(*storetypes.KVStoreKey)), log.NewNopLogger()), cdc, authtypes.ProtoBaseAccount, nil, addressCodec, sdk.Bech32MainPrefix, authorityStrAddr)
ctrl := gomock.NewController(&testing.T{})
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider passing a *testing.T instance to gomock.NewController instead of using &testing.T{} directly.

- ctrl := gomock.NewController(&testing.T{})
+ ctrl := gomock.NewController(t)

This change ensures that the mock controller is associated with the actual test case instance, allowing for proper handling of test failures and assertions.


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.

Suggested change
ctrl := gomock.NewController(&testing.T{})
ctrl := gomock.NewController(t)

@sontrinh16 sontrinh16 added this pull request to the merge queue Apr 11, 2024
Merged via the queue into main with commit a0d727e Apr 11, 2024
64 checks passed
@sontrinh16 sontrinh16 deleted the son/auth_recognizes_x/accounts branch April 11, 2024 10:04
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 15, 2024
* main: (25 commits)
  fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030)
  fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028)
  refactor(x/slashing)!: remove Accounts String (cosmos#20026)
  refactor(x/evidence)!: remove Address.String() (cosmos#20016)
  chore: make telemetry consistent (cosmos#20025)
  chore: prepare x/tx changelog (cosmos#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018)
  feat(x/bank): support depinject for send restrictions (cosmos#20014)
  feat: Conditionally emit metrics based on enablement (cosmos#19903)
  fix(store): fix the typo (cosmos#20011)
  docs(x/feegrant): fix allowance typo (cosmos#20000)
  chore(confix): update latest config value (cosmos#20012)
  refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002)
  fix(mempool): use no-op mempool as default (cosmos#19970)
  fix(simapp): add epoch store to upgrade (cosmos#20007)
  test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965)
  feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919)
  refactor(x/auth): use transaction service (cosmos#19967)
  fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976)
  ...
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.

4 participants