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

chore: Clean up {accept,implement}_interface #14476

Merged
merged 6 commits into from
Jan 4, 2023
Merged

chore: Clean up {accept,implement}_interface #14476

merged 6 commits into from
Jan 4, 2023

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Jan 4, 2023 •
edited
Loading

Description

Closes: #14353

cc @pyramation

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)

@amaury1093 amaury1093 added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Jan 4, 2023
@amaury1093 amaury1093 marked this pull request as ready for review January 4, 2023 11:33
@amaury1093 amaury1093 requested a review from a team as a code owner January 4, 2023 11:33
amaury1093
amaury1093 commented Jan 4, 2023
View reviewed changes
UPGRADING.md Outdated
+ "cosmos.feegrant.v1beta1.FeeAllowanceI"
```

Please also check that in your own app's proto files that there are no single-word names for those two proto annotations. If so, then replace them with fully-qualified names, even though those names don't actually resolve to an actual protobuf entity.
Copy link
Contributor Author

@amaury1093 amaury1093 Jan 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

With @pyramation, we decided to always use fully-scoped names. However, these names don't map to anything in protobuf. For example, cosmos.authz.v1beta1.Authorization is not defined anywhere in proto files. Is that fine?

There's an optional proposal to map them to some human-readable description here: https://github.com/cosmos/cosmos-sdk/pull/14280/files#r1047005098

Copy link
Contributor

Choose a reason for hiding this comment

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

IMO it's completely fine, but we can have some docs if necessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

docs that may need updating after this change:

Also, would be great if there is an ADR somewhere that may need updating? If we can describe that 1. these interfaces need to be fully-scoped, and also 2. won't be defined in any proto files, just so it's clear, that would be great.

I'd love to share the updated docs with a few teams and folks like @faddat and his team, so we can update protos everywhere.

@sonarcloud
Copy link

sonarcloud bot commented Jan 4, 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

julienrbrt
julienrbrt reviewed Jan 4, 2023
View reviewed changes
UPGRADING.md Outdated Show resolved Hide resolved
julienrbrt
julienrbrt reviewed Jan 4, 2023
View reviewed changes
cosmos/circuit/v1/tx.pb.go
@@ -0,0 +1,1703 @@
// Code generated by protoc-gen-gogo. DO NOT EDIT.
Copy link
Member

@julienrbrt julienrbrt Jan 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

note to the person that'll do the backport to 0.47. this folder can be removed. (please re-run make proto-gen)

julienrbrt
julienrbrt approved these changes Jan 4, 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.

lgtm!

@amaury1093 amaury1093 enabled auto-merge (squash) January 4, 2023 14:03
@amaury1093 amaury1093 merged commit b244ffb into main Jan 4, 2023
@amaury1093 amaury1093 deleted the am/14353-clean-proto-annotations branch January 4, 2023 14:23
@mergify mergify bot mentioned this pull request Jan 4, 2023
Merged
mergify bot pushed a commit that referenced this pull request Jan 4, 2023
@amaury1093 @mergify
chore: Clean up {accept,implement}_interface (#14476)
8979a64 
(cherry picked from commit b244ffb)

# Conflicts:
#	CHANGELOG.md
#	api/cosmos/auth/v1beta1/auth.pulsar.go
#	api/cosmos/bank/v1beta1/bank.pulsar.go
#	api/cosmos/gov/v1beta1/gov.pulsar.go
#	api/cosmos/gov/v1beta1/tx.pulsar.go
#	proto/cosmos/auth/v1beta1/auth.proto
#	proto/cosmos/evidence/v1beta1/tx.proto
#	proto/cosmos/gov/v1beta1/gov.proto
#	proto/cosmos/gov/v1beta1/tx.proto
#	x/auth/types/auth.pb.go
#	x/bank/types/bank.pb.go
#	x/gov/types/v1beta1/gov.pb.go
#	x/gov/types/v1beta1/tx.pb.go
tac0turtle added a commit that referenced this pull request Jan 4, 2023
@mergify @amaury1093
@tac0turtle @julienrbrt
chore: Clean up {accept,implement}_interface (backport #14476) (#14478
22e8aaa 
)

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@pyramation
Copy link
Contributor

pyramation commented Jan 4, 2023 •
edited
Loading

hey did we also update https://github.com/cosmos/ibc-go ?
cc @AmauryM @julienrbrt

cosmos/ibc-go#2977

This was referenced Jan 4, 2023
Closed
Closed
@pyramation pyramation mentioned this pull request Jan 14, 2023
Closed
@0xstepit 0xstepit mentioned this pull request Jul 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pyramation pyramation pyramation left review comments

@likhita-809 likhita-809 likhita-809 approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@aaronc aaronc Awaiting requested review from aaronc aaronc is a code owner

Assignees
No one assigned
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release C:x/auth C:x/authz C:x/bank C:x/evidence C:x/feegrant C:x/gov C:x/group C:x/staking Type: ADR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

some accepts/implements annotations don't resolve to existing scopes
4 participants
@amaury1093 @pyramation @julienrbrt @likhita-809