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

Consider reverting sdk.Msg#GetSigners(): string back to sdk.AccAddress #9885

Closed
4 tasks
amaury1093 opened this issue Aug 9, 2021 · 2 comments · Fixed by #9915
Closed
4 tasks

Consider reverting sdk.Msg#GetSigners(): string back to sdk.AccAddress #9885

amaury1093 opened this issue Aug 9, 2021 · 2 comments · Fixed by #9915
Assignees

Comments

@amaury1093
Copy link
Contributor

amaury1093 commented Aug 9, 2021

Summary

Revert this breaking change introduced in v0.44

type sdk.Msg interface {
  GetSigners() string
}

back to what was in <=0.43

type sdk.Msg interface {
  GetSigners() []sdk.AccAddress
}

introduced in #9239

Problem Definition

Part of the x/auth refactor WG (#7091), we were discussing how to work on it with minimal breaking changes on 0.44. But in 0.44 (master) we introduced #9239, which is a pretty huge API-breaking change.

Proposal

Revert #9239 on master for 0.44.

Then, in the future (0.45+), create a new issue part of the WG to define a new Msg interface

Preliminary ideas
  1. Deprecate sdk.Msg
  2. In the spirit of moving to core, create core/tx package with:
type Msg interface {
  ValidateBasic() error
  GetSignerAddresses() string
}

and slowly replace sdk.Msg with tx.Msg. More details to be ironed out.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@aaronc
Copy link
Member

aaronc commented Aug 9, 2021

This is probably a good idea... unfortunately.

@amaury1093
Copy link
Contributor Author

I'm triaging this into the ready column for subteams to take on it.

@technicallyty technicallyty self-assigned this Aug 11, 2021
@mergify mergify bot closed this as completed in #9915 Aug 13, 2021
mergify bot pushed a commit that referenced this issue Aug 13, 2021
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description
Changes the `sdk.Msg` interface method `GetSigners() []string` to `GetSigners() []sdk.AccAddress`

Closes: #9885 


+change GetSigner return type
+defer address checking to each msg's `ValidateBasic`  method
+clean up consistency/redundancy issues in validate basic


---

### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants