gov: add metadata field to proposal #10490
Assignees
Labels
Comments
19 tasks
|
As discussed in the last gov working group, we want to add a limit to the amount of bytes in this Ref: #10972 |
This was referenced Jan 20, 2022
mergify bot
pushed a commit
that referenced
this issue
Jan 25, 2022
## Description Closes: #10490 --- ### 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)
|
After a SIGN_MODE_TEXTUAL call, I'm reviving this issue to discuss if we could change the In TEXTUAL, we'll show bytes as base64-encoded. If we put a url, a JSON blob, an IPFS cid, it won't be human-friendly. Changing Any objections? |
|
That sounds right to me. Should also make sure it's consistent with groups metadata encoding. |
|
@atheeshp will work on migrating group/gov metadata fields to string |
19 tasks
This was referenced Feb 28, 2022
mergify bot
pushed a commit
that referenced
this issue
Mar 1, 2022
## Description ref: #10490 [comment](#10490 (comment)) --- ### 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)
|
Completed via #11269 |
larry0x
pushed a commit
to larry0x/cosmos-sdk
that referenced
this issue
May 22, 2023
## Description Closes: cosmos#10490 --- ### 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
Summary
Ref: #9438
This is a follow up issue from the original work in replacing proposal
Contentwith an array ofsdk.Msg(#9810). Part of this work removes title and description to proposals. The ability for a proposer to not only state their proposal but to be able to justify it is an important aspect of governance. This process is costly on-chain and far better suits being somewhere off-chain where further discussion around the proposal can be accommodated.Proposal
This topic was discussed in the gov working group. The proposal is to add a
forumormetadatafield toProposalthat is made from an array of bytes (similar to proposals in the group module). This is serve as a canonicalized reference to the place where the proposal is being discussed, explained and debated. A good example would be as an IPFS CID. Keeping the type abstract means that application developers could deploy their own way of linking the on-chain proposal to the off-chain discussion.An important consideration is that much of the value in the Cosmos SDK comes from standardized usage which means clients such as wallets and explorers can seamlessly work across multiple chains. It should be on the Cosmos SDK to provide a standardised way that clients can parse the
metadatafield and query the link to get the following fields: title, description, and authors.NOTE: This new field has an intended use but given that it is an arbitrary array of bytes could be used for anything else. I think it may be better to be a little more restrictive and add cap the size of field.
cc: @blushi, @aaronc, @hxrts
For Admin Use
The text was updated successfully, but these errors were encountered: