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

Add URI x/bank denom metadata #9502

Closed
4 tasks done
robert-zaremba opened this issue Jun 11, 2021 · 1 comment · Fixed by #9618
Closed
4 tasks done

Add URI x/bank denom metadata #9502

robert-zaremba opened this issue Jun 11, 2021 · 1 comment · Fixed by #9618
Assignees
Labels
T: ADR An issue or PR relating to an architectural decision record

Comments

@robert-zaremba
Copy link
Collaborator

Summary

Many projects store extensive metadata in a separate link, usually IPFS URI. We can add explicitly that field to x/bank denom metadata structure.

Problem Definition

Tools benefit from a clear structure. This is especially important for tokens, which in Cosmos SDK are organized through denom classes. Adding extensive metadata on a distribute storage is very popular. Not having explicit attribute causes either omission of that possibility or burden in Description attribute

URI is also required by the NFT standard: #9329

Proposal

Extend x/bank.Metadata proto message by adding string URI.
For the validation check we can enforce max length of 300 characters.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@robert-zaremba robert-zaremba added T: ADR An issue or PR relating to an architectural decision record S:needs architecture review To discuss on the next architecture review call to come to alignment labels Jun 11, 2021
@robert-zaremba robert-zaremba added this to the v0.44 milestone Jun 11, 2021
@aaronc
Copy link
Member

aaronc commented Jun 14, 2021

Makes sense and this is simple to do 👍

@robert-zaremba robert-zaremba self-assigned this Jul 1, 2021
@mergify mergify bot closed this as completed in #9618 Jul 1, 2021
mergify bot pushed a commit that referenced this issue Jul 1, 2021
## Description

Closes: #9502

---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] 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`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] 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)
@robert-zaremba robert-zaremba removed the S:needs architecture review To discuss on the next architecture review call to come to alignment label Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: ADR An issue or PR relating to an architectural decision record
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants