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(accounts): init accounts module #17443

Merged
merged 8 commits into from
Aug 19, 2023
Merged

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Aug 18, 2023

Description

Closes: #17444


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
  • run make lint and make test
  • 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)

@testinginprod testinginprod marked this pull request as ready for review August 18, 2023 10:04
@testinginprod testinginprod requested a review from a team as a code owner August 18, 2023 10:04
@github-prbot github-prbot requested review from a team, facundomedica and atheeshp and removed request for a team August 18, 2023 10:11
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.

Could you follow this too:

cosmos-sdk/CONTRIBUTING.md

Lines 198 to 207 in 7b7be7e

* Add a CHANGELOG.md / README.md under the new package folder
* Add the package in [`labeler.yml`](./.github/labeler.yml)
* Add the package in [`go.work.example`](./go.work.example)
* Add weekly dependabot checks (see [dependabot.yml](./.github/dependabot.yml))
* Add tests to github workflow [test.yml](.github/workflows/test.yml) (under submodules)
* Configure SonarCloud
* Add `sonar-projects.properties` (see math [sonar-projects.properties](./math/sonar-projects.properties) for example)
* Add a GitHub Workflow entry for running the scans (see [test.yml](.github/workflows/test.yml))
* Ask the team to add the project to SonarCloud
* (optional) Configure a `cosmossdk.io` vanity url by submitting a PR to [cosmos/vanity](https://github.com/cosmos/vanity).

@sonarqubecloud
Copy link

[Cosmos SDK - x/accounts] 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

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

Lgtm

x/accounts/CHANGELOG.md Outdated Show resolved Hide resolved
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.

lgtm! two nits.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

have a failing test, lets get that fixed so this can merge

@testinginprod
Copy link
Contributor Author

have a failing test, lets get that fixed so this can merge

it's unrelated to the PR

@julienrbrt
Copy link
Member

julienrbrt commented Aug 18, 2023

have a failing test, lets get that fixed so this can merge

it's unrelated to the PR

Yeah it's flaky. Weirdly it's only flaky since today. I've opened an issue for it already.

@julienrbrt julienrbrt mentioned this pull request Aug 18, 2023
20 tasks
@testinginprod testinginprod added this pull request to the merge queue Aug 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 19, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Aug 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 19, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Aug 19, 2023
Merged via the queue into main with commit 46bab63 Aug 19, 2023
@julienrbrt julienrbrt deleted the tip/accounts/init_protos branch August 19, 2023 08:38
syntax="proto3";

package cosmos.accounts.v1;
option go_package = "cosmossdk.io/x/accounts/v1";
Copy link
Member

Choose a reason for hiding this comment

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

Just realized, the types here should just be generated in the root of the module: https://docs.cosmos.network/v0.50/building-modules/structure#structure, without that /v1.
Or is this on purpose for handling multiple future versions?

Copy link
Contributor Author

@testinginprod testinginprod Aug 19, 2023

Choose a reason for hiding this comment

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

Copy link
Member

@julienrbrt julienrbrt Aug 19, 2023

Choose a reason for hiding this comment

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

Yeah the proto structure is good. My point is about the go packages.

For gov I think it is under /types and for newer modules directly in the root.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah @julienrbrt, now I understood your comment better, but I think we should always prepend package versions to protobuf generated files, because if we do a bump to v2, then would end up either moving the "old" v1 files in a v1 package (breaking change), or create a v2 package with v2 files (not breaking, but inconsistent).

I do not have a strong preference, I can also amend what I did. LMK what you think.

Copy link
Member

Choose a reason for hiding this comment

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

Right, that makes sense. We should maybe have it under a /types folder like gov for consistency with other modules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(accounts): init the accounts module
3 participants