Skip to content

Commit

Permalink
fix: make amino msg name consistent across all modules (#77)
Browse files Browse the repository at this point in the history
## Description

Following Cosmos SDK's convention, this PR changes amino message names
in `*.proto` files to `milkyway/{moduleName}/{messageName}` format and
names in `codec.go` files to `milkyway/{messageName}` unless the message
is `MsgUpdateParams`. This difference is because there's a 39-characters
limit on amino message name that can be used with `RegisterAminoMsg`.
Cosmos SDK does the same and sometimes it uses abbreviations such as
`cosmos-sdk/distr/MsgDepositValRewards` to work around with this limit.

Closes: MILK-56

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

---

### 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/milkyway-labs/milkyway/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/milkyway-labs/milkyway/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)
  • Loading branch information
hallazzang authored Aug 12, 2024
1 parent edee487 commit 2b69540
Show file tree
Hide file tree
Showing 59 changed files with 73,150 additions and 2,694 deletions.
1,534 changes: 1,534 additions & 0 deletions api/milkyway/operators/v1/genesis.pulsar.go

Large diffs are not rendered by default.

4,413 changes: 4,413 additions & 0 deletions api/milkyway/operators/v1/messages.pulsar.go

Large diffs are not rendered by default.

257 changes: 257 additions & 0 deletions api/milkyway/operators/v1/messages_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2b69540

Please sign in to comment.