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(auth): decouple auth from x/accounts account abstraction types #20875

Merged
merged 5 commits into from
Jul 8, 2024

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Jul 4, 2024

Description

This PR decouples the x/auth module from the x/accounts types


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

    • Expanded functionality for account authentication with additional parameters.
  • Dependency Updates

    • Removed dependency on cosmossdk.io/x/accounts across multiple modules.
    • Updated dependencies for cosmossdk.io/x/bank and cosmossdk.io/x/staking.
  • Testing Improvements

    • Enhanced control flow in TestBaseAccount by refining the sendTx function.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

Walkthrough

The changes primarily involve the removal of the dependency on cosmossdk.io/x/accounts across various modules and tests, suggesting a significant shift away from using the x/accounts module. Additionally, updates to dependencies like cosmossdk.io/x/bank, cosmossdk.io/x/staking, and others are evident. Modifications to the AuthenticateAccount function in x/accounts/keeper_account_abstraction.go and adjustments to associated methods in x/auth/ante/sigverify.go reflect the underlying architectural changes.

Changes

File/Path Change Summary
client/v2/go.mod Removed dependency on cosmossdk.io/x/accounts
go.mod Removed dependency on cosmossdk.io/x/accounts
server/v2/cometbft/go.mod Removed cosmossdk.io/x/accounts and updated cosmossdk.io/x/bank and cosmossdk.io/x/staking dependencies
tests/e2e/accounts/base_account_test.go Modified sendTx function, impacting TestBaseAccount control flow
tests/go.mod Added cosmossdk.io/store module, replaced with ../store
x/accounts/keeper_account_abstraction.go Modified AuthenticateAccount function to accept additional parameters bundler, rawTx, protoTx, and signIndex
x/auth/ante/sigverify.go Updated AuthenticateAccount interface method and SigVerificationDecorator function
x/auth/go.mod Removed cosmossdk.io/x/accounts dependency
x/authz/go.mod Removed cosmossdk.io/x/accounts dependency
x/bank/go.mod Removed cosmossdk.io/x/accounts dependency
x/circuit/go.mod Removed cosmossdk.io/x/accounts dependency, added cosmossdk.io/x/bank
x/consensus/go.mod Removed cosmossdk.io/x/accounts and updated cosmossdk.io/x/auth and cosmossdk.io/x/bank dependencies
x/distribution/go.mod Removed cosmossdk.io/x/accounts dependency
x/epochs/go.mod Removed cosmossdk.io/x/accounts dependency
x/evidence/go.mod Removed cosmossdk.io/x/accounts dependency
x/feegrant/go.mod Removed cosmossdk.io/x/accounts dependency
x/gov/go.mod Removed cosmossdk.io/x/accounts and updated cosmossdk.io/x/auth dependencies
x/mint/go.mod Removed cosmossdk.io/x/accounts dependency
x/nft/go.mod Removed cosmossdk.io/x/accounts dependency
x/params/go.mod Removed cosmossdk.io/x/accounts dependency
x/protocolpool/go.mod Removed cosmossdk.io/x/accounts, added cosmossdk.io/x/bank dependency
x/slashing/go.mod Removed cosmossdk.io/x/accounts, added cosmossdk.io/x/bank dependency
x/staking/go.mod Removed cosmossdk.io/x/accounts dependency
x/upgrade/go.mod Removed cosmossdk.io/x/accounts dependency

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Keeper
    Client->>Server: sendTx
    Server->>Keeper: AuthenticateAccount
    Keeper->>Server: Return Auth result
    Server->>Client: Return Tx result
Loading

Possibly related issues

  • cosmos/cosmos-sdk#17786: This epic on x/accounts tracks the overall development, and the changes in this PR directly relate to the evolution described in the issue.

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

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

Outside diff range and nitpick comments (2)
x/accounts/keeper_account_abstraction.go (1)

41-48: Ensure comprehensive error handling.

The function appears well-implemented, but consider logging the error before returning it for better traceability.

if err != nil {
  log.Errorf("Authentication failed for signer %s: %v", signer, err)
  return fmt.Errorf("%w: %w", ErrAuthentication, err)
}
x/auth/ante/sigverify.go (1)

436-450: Ensure comprehensive error handling.

The function appears well-implemented, but consider logging the error before returning it for better traceability.

if err != nil {
  log.Errorf("Failed to authenticate abstracted account for signer %s: %v", signer, err)
  return err
}
Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9df6019 and 21e9b0e.

Files ignored due to path filters (1)
  • tests/go.sum is excluded by !**/*.sum
Files selected for processing (24)
  • client/v2/go.mod (1 hunks)
  • go.mod (1 hunks)
  • server/v2/cometbft/go.mod (1 hunks)
  • tests/e2e/accounts/base_account_test.go (1 hunks)
  • tests/go.mod (1 hunks)
  • x/accounts/keeper_account_abstraction.go (2 hunks)
  • x/auth/ante/sigverify.go (3 hunks)
  • x/auth/go.mod (1 hunks)
  • x/authz/go.mod (1 hunks)
  • x/bank/go.mod (1 hunks)
  • x/circuit/go.mod (1 hunks)
  • x/consensus/go.mod (1 hunks)
  • x/distribution/go.mod (1 hunks)
  • x/epochs/go.mod (1 hunks)
  • x/evidence/go.mod (1 hunks)
  • x/feegrant/go.mod (1 hunks)
  • x/gov/go.mod (1 hunks)
  • x/mint/go.mod (1 hunks)
  • x/nft/go.mod (1 hunks)
  • x/params/go.mod (1 hunks)
  • x/protocolpool/go.mod (1 hunks)
  • x/slashing/go.mod (1 hunks)
  • x/staking/go.mod (1 hunks)
  • x/upgrade/go.mod (1 hunks)
Files skipped from review due to trivial changes (22)
  • client/v2/go.mod
  • go.mod
  • server/v2/cometbft/go.mod
  • tests/e2e/accounts/base_account_test.go
  • tests/go.mod
  • x/auth/go.mod
  • x/authz/go.mod
  • x/bank/go.mod
  • x/circuit/go.mod
  • x/consensus/go.mod
  • x/distribution/go.mod
  • x/epochs/go.mod
  • x/evidence/go.mod
  • x/feegrant/go.mod
  • x/gov/go.mod
  • x/mint/go.mod
  • x/nft/go.mod
  • x/params/go.mod
  • x/protocolpool/go.mod
  • x/slashing/go.mod
  • x/staking/go.mod
  • x/upgrade/go.mod
Additional context used
Path-based instructions (2)
x/accounts/keeper_account_abstraction.go (1)

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

x/auth/ante/sigverify.go (1)

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

Additional comments not posted (1)
x/auth/ante/sigverify.go (1)

54-54: LGTM! Ensure consistency with x/accounts/keeper_account_abstraction.go.

The method signature change is consistent with the implementation in x/accounts/keeper_account_abstraction.go.

@facundomedica facundomedica self-assigned this Jul 8, 2024
Copy link
Contributor

@hieuvubk hieuvubk left a comment

Choose a reason for hiding this comment

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

LGTM

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 21e9b0e and 17cafa9.

Files selected for processing (1)
  • x/accounts/keeper_account_abstraction.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/accounts/keeper_account_abstraction.go

@testinginprod testinginprod added this pull request to the merge queue Jul 8, 2024
Merged via the queue into main with commit acfd1ac Jul 8, 2024
89 checks passed
@testinginprod testinginprod deleted the tip/auth/remove_acc_dep branch July 8, 2024 14:19
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