feat(gov,group): improve metadata checks and add docs (#16235)

This commit is contained in:
Julien Robert
2023-05-22 11:54:42 +00:00
committed by GitHub
parent 38f27e3d1a
commit 2c702e6563
11 changed files with 127 additions and 16 deletions
+3 -1
View File
@@ -7118,6 +7118,7 @@ type Proposal struct {
// voting_end_time is the end time of voting on a proposal.
VotingEndTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=voting_end_time,json=votingEndTime,proto3" json:"voting_end_time,omitempty"`
// metadata is any arbitrary metadata attached to the proposal.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#proposal-3
Metadata string `protobuf:"bytes,10,opt,name=metadata,proto3" json:"metadata,omitempty"`
// title is the title of the proposal
//
@@ -7332,7 +7333,8 @@ type Vote struct {
Voter string `protobuf:"bytes,2,opt,name=voter,proto3" json:"voter,omitempty"`
// options is the weighted vote options.
Options []*WeightedVoteOption `protobuf:"bytes,4,rep,name=options,proto3" json:"options,omitempty"`
// metadata is any arbitrary metadata to attached to the vote.
// metadata is any arbitrary metadata to attached to the vote.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#vote-5
Metadata string `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
}
+5 -1
View File
@@ -7832,6 +7832,7 @@ type GroupInfo struct {
// admin is the account address of the group's admin.
Admin string `protobuf:"bytes,2,opt,name=admin,proto3" json:"admin,omitempty"`
// metadata is any arbitrary metadata to attached to the group.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#group-1
Metadata string `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// version is used to track changes to a group's membership structure that
// would break existing proposals. Whenever any members weight is changed,
@@ -7965,6 +7966,7 @@ type GroupPolicyInfo struct {
// admin is the account address of the group admin.
Admin string `protobuf:"bytes,3,opt,name=admin,proto3" json:"admin,omitempty"`
// metadata is any arbitrary metadata attached to the group policy.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#decision-policy-1
Metadata string `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// version is used to track changes to a group's GroupPolicyInfo structure that
// would create a different result on a running proposal.
@@ -8058,6 +8060,7 @@ type Proposal struct {
// group_policy_address is the account address of group policy.
GroupPolicyAddress string `protobuf:"bytes,2,opt,name=group_policy_address,json=groupPolicyAddress,proto3" json:"group_policy_address,omitempty"`
// metadata is any arbitrary metadata attached to the proposal.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#proposal-4
Metadata string `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// proposers are the account addresses of the proposers.
Proposers []string `protobuf:"bytes,4,rep,name=proposers,proto3" json:"proposers,omitempty"`
@@ -8280,7 +8283,7 @@ func (x *TallyResult) GetNoWithVetoCount() string {
return ""
}
// Vote represents a vote for a proposal.
// Vote represents a vote for a proposal.string metadata
type Vote struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
@@ -8293,6 +8296,7 @@ type Vote struct {
// option is the voter's choice on the proposal.
Option VoteOption `protobuf:"varint,3,opt,name=option,proto3,enum=cosmos.group.v1.VoteOption" json:"option,omitempty"`
// metadata is any arbitrary metadata attached to the vote.
// the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#vote-2
Metadata string `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// submit_time is the timestamp when the vote was submitted.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`