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.

Sign up for GitHub

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

Jump to bottom

refactor: Move x/auth's AccountI and ModuleAccountI interfaces to types package #13937

Merged
merged 37 commits into from
Jan 3, 2023
Merged

refactor: Move x/auth's AccountI and ModuleAccountI interfaces to types package #13937

merged 37 commits into from
Jan 3, 2023

Conversation

likhita-809
Copy link
Contributor

@likhita-809 likhita-809 commented Nov 21, 2022 •
edited
Loading

Description

ref: #13025

This PR moves AccountI and ModuleAccountI interface to types package which removes few dependencies from x/auth module.

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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@github-actions github-actions bot added the C:Rosetta Issues and PR related to Rosetta label Nov 21, 2022
tac0turtle
tac0turtle reviewed Dec 16, 2022
View reviewed changes
x/auth/types/account.go
// and a pubkey for authentication purposes.
//
// Many complex conditions can be used in the concrete struct which implements AccountI.
type AccountI interface {
Copy link
Member

Choose a reason for hiding this comment

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

we should provide an alias here but mark it as deprecated

Copy link
Member

Choose a reason for hiding this comment

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

Are we actually even willing to move given: #13211?

Copy link
Member

Choose a reason for hiding this comment

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

When will that land?

Copy link
Member

Choose a reason for hiding this comment

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

It's up to us when that lands

Copy link
Member

Choose a reason for hiding this comment

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

the issue proposed seems like a large refactor. anyways touched base with likhita on next steps here for leaving the interface here as a wrapper of the interface in types, then we call this one deprecated. I think the issue we can start on, but its unclear how long it will take us

tac0turtle
tac0turtle reviewed Dec 22, 2022
View reviewed changes
x/auth/types/account.go
// and a pubkey for authentication purposes.
//
// Many complex conditions can be used in the concrete struct which implements AccountI.
type AccountI interface {
Copy link
Member

Choose a reason for hiding this comment

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

lets leave this as a wrapper of the interface for backwards compatibility for now

@likhita-809 likhita-809 changed the title refactor: Move x/auth's AccountI interface to types package refactor: Move x/auth's AccountI and ModuleAccountI interfaces to types package Dec 28, 2022
@github-actions github-actions bot removed the C:Store label Dec 29, 2022
@likhita-809 likhita-809 marked this pull request as ready for review January 2, 2023 07:35
@likhita-809 likhita-809 requested a review from a team as a code owner January 2, 2023 07:35
julienrbrt
julienrbrt approved these changes Jan 2, 2023
View reviewed changes
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.

I don't like the name of types/dependencies.go as it does not convey what there is inside it.
Otherwise, lgtm!

@julienrbrt
Copy link
Member

Can you look into the rosetta test failure as well? It seems related to this PR.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 3, 2023

[Cosmos SDK - SimApp] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 3, 2023

[Cosmos SDK - Rosetta] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 3, 2023

[Cosmos SDK] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tac0turtle tac0turtle merged commit 3606995 into main Jan 3, 2023
@tac0turtle tac0turtle deleted the likhita/remove-cyclic-deps-auth branch January 3, 2023 10:25
@atheeshp atheeshp mentioned this pull request Jan 11, 2023
Closed
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
@likhita-809
refactor: Move x/auth's AccountI and ModuleAccountI interfaces to typ…
74fecab 
…es package (cosmos#13937)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronc aaronc aaronc left review comments

@julienrbrt julienrbrt julienrbrt approved these changes

@atheeshp atheeshp Awaiting requested review from atheeshp

@tac0turtle tac0turtle Awaiting requested review from tac0turtle

Assignees

@tac0turtle tac0turtle

@julienrbrt julienrbrt

Labels
C:Rosetta Issues and PR related to Rosetta C:Simulations C:x/auth C:x/authz C:x/bank C:x/consensus C:x/distribution distribution module related C:x/evidence C:x/feegrant C:x/genutil genutil module issues C:x/gov C:x/group C:x/mint C:x/nft C:x/slashing C:x/staking
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@likhita-809 @tac0turtle @julienrbrt @aaronc @atheeshp