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(auth): support accounts from auth #21688

Merged
merged 27 commits into from
Sep 17, 2024
Merged

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Sep 12, 2024

Description

This PR allows x/accounts to be queriable from the auth's gRPC query service, specifically AccountInfo and Account methods.


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 backward-compatible account querying with QueryLegacyAccount and QueryLegacyAccountResponse in the Cosmos SDK.
    • Enhanced gRPC endpoints for querying account information, improving accessibility and interaction with account data.
  • Bug Fixes

    • Improved error handling for account queries, including legacy accounts.
  • Documentation

    • Updated README to include guidance on supporting custom account types and their integration with existing wallets.
  • Tests

    • Added integration tests to ensure compatibility between legacy and new account systems.
    • Enhanced mock capabilities for testing account-related queries.

Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

Walkthrough

The changes introduce new message types for querying account information in the Cosmos SDK, specifically aimed at maintaining backward compatibility with legacy systems. The modifications include updates to various files, implementing new methods, and enhancing the functionality of existing modules. Additionally, several dependencies have been updated, and new tests have been added to ensure the integrity and compatibility of the account management functionalities.

Changes

Files Change Summary
api/cosmos/auth/v1beta1/accounts.pulsar.go Introduced QueryLegacyAccount and QueryLegacyAccountResponse message types for account queries, implementing reflection methods for serialization.
scripts/mockgen.sh Activated lines to generate mock implementations for keepers in x/auth/types and x/auth/vesting/types.
simapp/go.mod, simapp/v2/go.mod, tests/go.mod Updated cosmossdk.io/x/accounts dependency version and added cosmossdk.io/x/accounts/defaults/base as a new dependency.
tests/integration/auth/keeper/accounts_retro_compatibility_test.go Added integration tests for compatibility between legacy and new account queries, validating various scenarios.
tests/integration/auth/keeper/fixture_test.go Created a fixture for integration testing, encapsulating application context and necessary modules for account and banking interactions.
tests/integration/auth/keeper/msg_server_test.go Removed a fixture struct and its initialization logic, simplifying the test setup.
x/accounts/README.md Added guidelines for supporting custom account types within the x/auth gRPC server, including implementation requirements for compatibility.
x/accounts/accountstd/exports.go Introduced ErrInvalidType, modified ExecModule and QueryModule functions to use generics, and added assertOrErr for type assertions.
x/accounts/defaults/base/account.go Added AuthRetroCompatibility method for legacy account queries and streamlined the getNumber method.
x/accounts/defaults/base/go.mod, x/accounts/defaults/lockup/go.mod, x/accounts/defaults/multisig/go.mod Introduced new go.mod files for base, lockup, and multisig modules, establishing dependencies and local paths for development.
x/accounts/go.mod Added cosmossdk.io/x/accounts/defaults/base dependency and updated the version for github.com/decred/dcrd/dcrec/secp256k1/v4.
x/auth/CHANGELOG.md Documented new features for querying x/accounts through gRPC endpoints and other updates related to transaction validation.
x/auth/keeper/grpc_query.go Enhanced account query logic to support legacy accounts when primary account retrieval fails, introducing new error handling.
x/auth/proto/cosmos/auth/v1beta1/accounts.proto Defined protocol buffer messages QueryLegacyAccount and QueryLegacyAccountResponse for querying legacy account information.
x/auth/testutil/expected_keepers_mocks.go Added a Query method to MockAccountsModKeeper for mocking account queries.
x/auth/types/expected_keepers.go Added a Query method to the AccountsModKeeper interface for querying accounts.
x/auth/vesting/testutil/expected_keepers_mocks.go Removed MockAccountsModKeeper and related methods, indicating a change in mocking strategy.
x/auth/vesting/types/expected_keepers.go Removed the AccountsModKeeper interface from the vesting module, simplifying dependencies.
x/auth/vesting/types/vesting_account_test.go Changed the source of the mock accounts module keeper to align with the authentication module's testing utilities.

Possibly related PRs

  • fix(x/accounts/lockup): prevent double withdraw #21619: Addresses a bug in the lockup functionality of the accounts module, related to the changes for querying account information.
  • docs(x/authz): update grant docs #21677: The documentation updates clarify the deprecation of vesting accounts in favor of the x/accounts module, which aligns with the focus on enhancing account management functionalities.
  • docs(x/auth): vesting #21715: Discusses the removal of vesting account messages and the shift to using x/accounts for account management, directly connecting to the introduction of new message types for account queries.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9280c12 and ee91b4f.

Files selected for processing (1)
  • x/auth/keeper/grpc_query_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/auth/keeper/grpc_query_test.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>, 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 generate interesting stats about this repository and render them as a table.
    -- @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.

@testinginprod testinginprod added backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release labels Sep 12, 2024
api/cosmos/auth/v1beta1/accounts.pulsar.go Dismissed Show dismissed Hide dismissed
@julienrbrt julienrbrt mentioned this pull request Sep 16, 2024
10 tasks
@testinginprod testinginprod marked this pull request as ready for review September 17, 2024 09:50
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.

ACK!

@testinginprod testinginprod added this pull request to the merge queue Sep 17, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 17, 2024
@testinginprod testinginprod added this pull request to the merge queue Sep 17, 2024
Merged via the queue into main with commit 81ec7ea Sep 17, 2024
74 checks passed
@testinginprod testinginprod deleted the tip/auth/get_from_accounts branch September 17, 2024 18:18
mergify bot pushed a commit that referenced this pull request Sep 17, 2024
(cherry picked from commit 81ec7ea)

# Conflicts:
#	simapp/go.mod
#	simapp/v2/go.mod
#	tests/go.mod
#	x/accounts/go.mod
#	x/group/go.mod
julienrbrt added a commit that referenced this pull request Sep 17, 2024
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