docs(x/accounts): improve comments (#22339)
This commit is contained in:
@@ -5851,8 +5851,7 @@ const (
|
||||
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
|
||||
)
|
||||
|
||||
// MsgInitLockupAccount defines a message that enables creating a lockup
|
||||
// account.
|
||||
// MsgInitLockupAccount defines a message that enables creating a lockup account.
|
||||
type MsgInitLockupAccount struct {
|
||||
state protoimpl.MessageState
|
||||
sizeCache protoimpl.SizeCache
|
||||
@@ -5860,9 +5859,9 @@ type MsgInitLockupAccount struct {
|
||||
|
||||
// owner of the vesting account
|
||||
Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
|
||||
// end of lockup
|
||||
// end_time is end of lockup
|
||||
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
|
||||
// start of lockup
|
||||
// start_time is start of lockup
|
||||
StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
|
||||
}
|
||||
|
||||
|
||||
@@ -8872,8 +8872,10 @@ type MsgInit struct {
|
||||
sizeCache protoimpl.SizeCache
|
||||
unknownFields protoimpl.UnknownFields
|
||||
|
||||
// members are the members of the multisig account.
|
||||
Members []*Member `protobuf:"bytes,1,rep,name=members,proto3" json:"members,omitempty"`
|
||||
Config *Config `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
|
||||
// config is the configuration of the multisig account.
|
||||
Config *Config `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
|
||||
}
|
||||
|
||||
func (x *MsgInit) Reset() {
|
||||
@@ -9275,8 +9277,10 @@ type Config struct {
|
||||
sizeCache protoimpl.SizeCache
|
||||
unknownFields protoimpl.UnknownFields
|
||||
|
||||
// threshold is the minimum weight required for a proposal to pass.
|
||||
Threshold int64 `protobuf:"varint,1,opt,name=threshold,proto3" json:"threshold,omitempty"`
|
||||
Quorum int64 `protobuf:"varint,2,opt,name=quorum,proto3" json:"quorum,omitempty"`
|
||||
// quorum is the minimum number of members that need to vote for a proposal to pass.
|
||||
Quorum int64 `protobuf:"varint,2,opt,name=quorum,proto3" json:"quorum,omitempty"`
|
||||
// voting_period is the duration in seconds for the voting period.
|
||||
VotingPeriod int64 `protobuf:"varint,3,opt,name=voting_period,json=votingPeriod,proto3" json:"voting_period,omitempty"`
|
||||
// revote defines if members can change their vote.
|
||||
@@ -9346,12 +9350,16 @@ type Proposal struct {
|
||||
sizeCache protoimpl.SizeCache
|
||||
unknownFields protoimpl.UnknownFields
|
||||
|
||||
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
|
||||
Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
|
||||
// title is the title of the proposal.
|
||||
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
|
||||
// summary is the summary of the proposal.
|
||||
Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
|
||||
// messages are the messages that will be executed
|
||||
Messages []*anypb.Any `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`
|
||||
// voting_period_end will be set by the account when the proposal is created.
|
||||
VotingPeriodEnd int64 `protobuf:"varint,4,opt,name=voting_period_end,json=votingPeriodEnd,proto3" json:"voting_period_end,omitempty"`
|
||||
Status ProposalStatus `protobuf:"varint,5,opt,name=status,proto3,enum=cosmos.accounts.defaults.multisig.v1.ProposalStatus" json:"status,omitempty"`
|
||||
VotingPeriodEnd int64 `protobuf:"varint,4,opt,name=voting_period_end,json=votingPeriodEnd,proto3" json:"voting_period_end,omitempty"`
|
||||
// status is the current status of the proposal.
|
||||
Status ProposalStatus `protobuf:"varint,5,opt,name=status,proto3,enum=cosmos.accounts.defaults.multisig.v1.ProposalStatus" json:"status,omitempty"`
|
||||
}
|
||||
|
||||
func (x *Proposal) Reset() {
|
||||
@@ -9506,8 +9514,10 @@ type QueryConfigResponse struct {
|
||||
sizeCache protoimpl.SizeCache
|
||||
unknownFields protoimpl.UnknownFields
|
||||
|
||||
// members are the current members of the account.
|
||||
Members []*Member `protobuf:"bytes,1,rep,name=members,proto3" json:"members,omitempty"`
|
||||
Config *Config `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
|
||||
// config is the current config of the account.
|
||||
Config *Config `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
|
||||
}
|
||||
|
||||
func (x *QueryConfigResponse) Reset() {
|
||||
|
||||
Reference in New Issue
Block a user