Get desktop application:
View/edit binary Protocol Buffers messages
Msg is the cosmos.group.v1 Msg service.
CreateGroup creates a new group with an admin account address, a list of members and some optional metadata.
MsgCreateGroup is the Msg/CreateGroup request type.
admin is the account address of the group admin.
members defines the group members.
metadata is any arbitrary metadata to attached to the group.
MsgCreateGroupResponse is the Msg/CreateGroup response type.
group_id is the unique ID of the newly created group.
UpdateGroupMembers updates the group members with given group id and admin address.
MsgUpdateGroupMembers is the Msg/UpdateGroupMembers request type.
admin is the account address of the group admin.
group_id is the unique ID of the group.
member_updates is the list of members to update, set weight to 0 to remove a member.
MsgUpdateGroupMembersResponse is the Msg/UpdateGroupMembers response type.
(message has no fields)
UpdateGroupAdmin updates the group admin with given group id and previous admin address.
MsgUpdateGroupAdmin is the Msg/UpdateGroupAdmin request type.
admin is the current account address of the group admin.
group_id is the unique ID of the group.
new_admin is the group new admin account address.
MsgUpdateGroupAdminResponse is the Msg/UpdateGroupAdmin response type.
(message has no fields)
UpdateGroupMetadata updates the group metadata with given group id and admin address.
MsgUpdateGroupMetadata is the Msg/UpdateGroupMetadata request type.
admin is the account address of the group admin.
group_id is the unique ID of the group.
metadata is the updated group's metadata.
MsgUpdateGroupMetadataResponse is the Msg/UpdateGroupMetadata response type.
(message has no fields)
CreateGroupPolicy creates a new group policy using given DecisionPolicy.
MsgCreateGroupPolicy is the Msg/CreateGroupPolicy request type.
admin is the account address of the group admin.
group_id is the unique ID of the group.
metadata is any arbitrary metadata attached to the group policy.
decision_policy specifies the group policy's decision policy.
MsgCreateGroupPolicyResponse is the Msg/CreateGroupPolicy response type.
address is the account address of the newly created group policy.
CreateGroupWithPolicy creates a new group with policy.
MsgCreateGroupWithPolicy is the Msg/CreateGroupWithPolicy request type.
admin is the account address of the group and group policy admin.
members defines the group members.
group_metadata is any arbitrary metadata attached to the group.
group_policy_metadata is any arbitrary metadata attached to the group policy.
group_policy_as_admin is a boolean field, if set to true, the group policy account address will be used as group and group policy admin.
decision_policy specifies the group policy's decision policy.
MsgCreateGroupWithPolicyResponse is the Msg/CreateGroupWithPolicy response type.
group_id is the unique ID of the newly created group with policy.
group_policy_address is the account address of the newly created group policy.
UpdateGroupPolicyAdmin updates a group policy admin.
MsgUpdateGroupPolicyAdmin is the Msg/UpdateGroupPolicyAdmin request type.
admin is the account address of the group admin.
group_policy_address is the account address of the group policy.
new_admin is the new group policy admin.
MsgUpdateGroupPolicyAdminResponse is the Msg/UpdateGroupPolicyAdmin response type.
(message has no fields)
UpdateGroupPolicyDecisionPolicy allows a group policy's decision policy to be updated.
MsgUpdateGroupPolicyDecisionPolicy is the Msg/UpdateGroupPolicyDecisionPolicy request type.
admin is the account address of the group admin.
group_policy_address is the account address of group policy.
decision_policy is the updated group policy's decision policy.
MsgUpdateGroupPolicyDecisionPolicyResponse is the Msg/UpdateGroupPolicyDecisionPolicy response type.
(message has no fields)
UpdateGroupPolicyMetadata updates a group policy metadata.
MsgUpdateGroupPolicyMetadata is the Msg/UpdateGroupPolicyMetadata request type.
admin is the account address of the group admin.
group_policy_address is the account address of group policy.
metadata is the group policy metadata to be updated.
MsgUpdateGroupPolicyMetadataResponse is the Msg/UpdateGroupPolicyMetadata response type.
(message has no fields)
SubmitProposal submits a new proposal.
MsgSubmitProposal is the Msg/SubmitProposal request type.
group_policy_address is the account address of group policy.
proposers are the account addresses of the proposers. Proposers signatures will be counted as yes votes.
metadata is any arbitrary metadata attached to the proposal.
messages is a list of `sdk.Msg`s that will be executed if the proposal passes.
exec defines the mode of execution of the proposal, whether it should be executed immediately on creation or not. If so, proposers signatures are considered as Yes votes.
title is the title of the proposal. Since: cosmos-sdk 0.47
summary is the summary of the proposal. Since: cosmos-sdk 0.47
MsgSubmitProposalResponse is the Msg/SubmitProposal response type.
proposal is the unique ID of the proposal.
WithdrawProposal withdraws a proposal.
MsgWithdrawProposal is the Msg/WithdrawProposal request type.
proposal is the unique ID of the proposal.
address is the admin of the group policy or one of the proposer of the proposal.
MsgWithdrawProposalResponse is the Msg/WithdrawProposal response type.
(message has no fields)
Vote allows a voter to vote on a proposal.
MsgVote is the Msg/Vote request type.
proposal is the unique ID of the proposal.
voter is the voter account address.
option is the voter's choice on the proposal.
metadata is any arbitrary metadata attached to the vote.
exec defines whether the proposal should be executed immediately after voting or not.
MsgVoteResponse is the Msg/Vote response type.
(message has no fields)
Exec executes a proposal.
MsgExec is the Msg/Exec request type.
proposal is the unique ID of the proposal.
executor is the account address used to execute the proposal.
MsgExecResponse is the Msg/Exec request type.
result is the final result of the proposal execution.
LeaveGroup allows a group member to leave the group.
MsgLeaveGroup is the Msg/LeaveGroup request type.
address is the account address of the group member.
group_id is the unique ID of the group.
MsgLeaveGroupResponse is the Msg/LeaveGroup response type.
(message has no fields)
Query is the cosmos.group.v1 Query service.
GroupInfo queries group info based on group id.
QueryGroupInfoRequest is the Query/GroupInfo request type.
group_id is the unique ID of the group.
QueryGroupInfoResponse is the Query/GroupInfo response type.
info is the GroupInfo of the group.
GroupPolicyInfo queries group policy info based on account address of group policy.
QueryGroupPolicyInfoRequest is the Query/GroupPolicyInfo request type.
address is the account address of the group policy.
QueryGroupPolicyInfoResponse is the Query/GroupPolicyInfo response type.
info is the GroupPolicyInfo of the group policy.
GroupMembers queries members of a group by group id.
QueryGroupMembersRequest is the Query/GroupMembers request type.
group_id is the unique ID of the group.
pagination defines an optional pagination for the request.
QueryGroupMembersResponse is the Query/GroupMembersResponse response type.
members are the members of the group with given group_id.
pagination defines the pagination in the response.
GroupsByAdmin queries groups by admin address.
QueryGroupsByAdminRequest is the Query/GroupsByAdmin request type.
admin is the account address of a group's admin.
pagination defines an optional pagination for the request.
QueryGroupsByAdminResponse is the Query/GroupsByAdminResponse response type.
groups are the groups info with the provided admin.
pagination defines the pagination in the response.
GroupPoliciesByGroup queries group policies by group id.
QueryGroupPoliciesByGroupRequest is the Query/GroupPoliciesByGroup request type.
group_id is the unique ID of the group policy's group.
pagination defines an optional pagination for the request.
QueryGroupPoliciesByGroupResponse is the Query/GroupPoliciesByGroup response type.
group_policies are the group policies info associated with the provided group.
pagination defines the pagination in the response.
GroupPoliciesByAdmin queries group policies by admin address.
QueryGroupPoliciesByAdminRequest is the Query/GroupPoliciesByAdmin request type.
admin is the admin address of the group policy.
pagination defines an optional pagination for the request.
QueryGroupPoliciesByAdminResponse is the Query/GroupPoliciesByAdmin response type.
group_policies are the group policies info with provided admin.
pagination defines the pagination in the response.
Proposal queries a proposal based on proposal id.
QueryProposalRequest is the Query/Proposal request type.
proposal_id is the unique ID of a proposal.
QueryProposalResponse is the Query/Proposal response type.
proposal is the proposal info.
ProposalsByGroupPolicy queries proposals based on account address of group policy.
QueryProposalsByGroupPolicyRequest is the Query/ProposalByGroupPolicy request type.
address is the account address of the group policy related to proposals.
pagination defines an optional pagination for the request.
QueryProposalsByGroupPolicyResponse is the Query/ProposalByGroupPolicy response type.
proposals are the proposals with given group policy.
pagination defines the pagination in the response.
VoteByProposalVoter queries a vote by proposal id and voter.
QueryVoteByProposalVoterRequest is the Query/VoteByProposalVoter request type.
proposal_id is the unique ID of a proposal.
voter is a proposal voter account address.
QueryVoteByProposalVoterResponse is the Query/VoteByProposalVoter response type.
vote is the vote with given proposal_id and voter.
VotesByProposal queries a vote by proposal id.
QueryVotesByProposalRequest is the Query/VotesByProposal request type.
proposal_id is the unique ID of a proposal.
pagination defines an optional pagination for the request.
QueryVotesByProposalResponse is the Query/VotesByProposal response type.
votes are the list of votes for given proposal_id.
pagination defines the pagination in the response.
VotesByVoter queries a vote by voter.
QueryVotesByVoterRequest is the Query/VotesByVoter request type.
voter is a proposal voter account address.
pagination defines an optional pagination for the request.
QueryVotesByVoterResponse is the Query/VotesByVoter response type.
votes are the list of votes by given voter.
pagination defines the pagination in the response.
GroupsByMember queries groups by member address.
QueryGroupsByMemberRequest is the Query/GroupsByMember request type.
address is the group member address.
pagination defines an optional pagination for the request.
QueryGroupsByMemberResponse is the Query/GroupsByMember response type.
groups are the groups info with the provided group member.
pagination defines the pagination in the response.
TallyResult returns the tally result of a proposal. If the proposal is still in voting period, then this query computes the current tally state, which might not be final. On the other hand, if the proposal is final, then it simply returns the `final_tally_result` state stored in the proposal itself.
QueryTallyResultRequest is the Query/TallyResult request type.
proposal_id is the unique id of a proposal.
QueryTallyResultResponse is the Query/TallyResult response type.
tally defines the requested tally.
Groups queries all groups in state. Since: cosmos-sdk 0.47.1
QueryGroupsRequest is the Query/Groups request type. Since: cosmos-sdk 0.47.1
pagination defines an optional pagination for the request.
QueryGroupsResponse is the Query/Groups response type. Since: cosmos-sdk 0.47.1
`groups` is all the groups present in state.
pagination defines the pagination in the response.
DecisionPolicyWindows defines the different windows for voting and execution.
Used in:
,voting_period is the duration from submission of a proposal to the end of voting period Within this times votes can be submitted with MsgVote.
min_execution_period is the minimum duration after the proposal submission where members can start sending MsgExec. This means that the window for sending a MsgExec transaction is: `[ submission + min_execution_period ; submission + voting_period + max_execution_period]` where max_execution_period is a app-specific config, defined in the keeper. If not set, min_execution_period will default to 0. Please make sure to set a `min_execution_period` that is smaller than `voting_period + max_execution_period`, or else the above execution window is empty, meaning that all proposals created with this decision policy won't be able to be executed.
EventCreateGroup is an event emitted when a group is created.
group_id is the unique ID of the group.
EventCreateGroupPolicy is an event emitted when a group policy is created.
address is the account address of the group policy.
EventExec is an event emitted when a proposal is executed.
proposal_id is the unique ID of the proposal.
result is the proposal execution result.
logs contains error logs in case the execution result is FAILURE.
EventLeaveGroup is an event emitted when group member leaves the group.
group_id is the unique ID of the group.
address is the account address of the group member.
EventProposalPruned is an event emitted when a proposal is pruned.
proposal_id is the unique ID of the proposal.
status is the proposal status (UNSPECIFIED, SUBMITTED, ACCEPTED, REJECTED, ABORTED, WITHDRAWN).
tally_result is the proposal tally result (when applicable).
EventSubmitProposal is an event emitted when a proposal is created.
proposal_id is the unique ID of the proposal.
EventUpdateGroup is an event emitted when a group is updated.
group_id is the unique ID of the group.
EventUpdateGroupPolicy is an event emitted when a group policy is updated.
address is the account address of the group policy.
EventVote is an event emitted when a voter votes on a proposal.
proposal_id is the unique ID of the proposal.
EventWithdrawProposal is an event emitted when a proposal is withdrawn.
proposal_id is the unique ID of the proposal.
Exec defines modes of execution of a proposal on creation or on new vote.
Used in:
,An empty value means that there should be a separate MsgExec request for the proposal to execute.
Try to execute the proposal immediately. If the proposal is not allowed per the DecisionPolicy, the proposal will still be open and could be executed at a later point.
GenesisState defines the group module's genesis state.
group_seq is the group table orm.Sequence, it is used to get the next group ID.
groups is the list of groups info.
group_members is the list of groups members.
group_policy_seq is the group policy table orm.Sequence, it is used to generate the next group policy account address.
group_policies is the list of group policies info.
proposal_seq is the proposal table orm.Sequence, it is used to get the next proposal ID.
proposals is the list of proposals.
votes is the list of votes.
GroupInfo represents the high-level on-chain information for a group.
Used in:
, , , ,id is the unique ID of the group.
admin is the account address of the group's admin.
metadata is any arbitrary metadata to attached to the group.
version is used to track changes to a group's membership structure that would break existing proposals. Whenever any members weight is changed, or any member is added or removed this version is incremented and will cause proposals based on older versions of this group to fail
total_weight is the sum of the group members' weights.
created_at is a timestamp specifying when a group was created.
GroupMember represents the relationship between a group and a member.
Used in:
,group_id is the unique ID of the group.
member is the member data.
GroupPolicyInfo represents the high-level on-chain information for a group policy.
Used in:
, , ,address is the account address of group policy.
group_id is the unique ID of the group.
admin is the account address of the group admin.
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
version is used to track changes to a group's GroupPolicyInfo structure that would create a different result on a running proposal.
decision_policy specifies the group policy's decision policy.
created_at is a timestamp specifying when a group policy was created.
Member represents a group member with an account address, non-zero weight, metadata and added_at timestamp.
Used in:
address is the member's account address.
weight is the member's voting weight that should be greater than 0.
metadata is any arbitrary metadata attached to the member.
added_at is a timestamp specifying when a member was added.
MemberRequest represents a group member to be used in Msg server requests. Contrary to `Member`, it doesn't have any `added_at` field since this field cannot be set as part of requests.
Used in:
, ,address is the member's account address.
weight is the member's voting weight that should be greater than 0.
metadata is any arbitrary metadata attached to the member.
PercentageDecisionPolicy is a decision policy where a proposal passes when it satisfies the two following conditions: 1. The percentage of all `YES` voters' weights out of the total group weight is greater or equal than the given `percentage`. 2. The voting and execution periods of the proposal respect the parameters given by `windows`.
percentage is the minimum percentage of the weighted sum of `YES` votes must meet for a proposal to succeed.
windows defines the different windows for voting and execution.
Proposal defines a group proposal. Any member of a group can submit a proposal for a group policy to decide upon. A proposal consists of a set of `sdk.Msg`s that will be executed if the proposal passes as well as some optional metadata associated with the proposal.
Used in:
, ,id is the unique id of the proposal.
group_policy_address is the account address of group policy.
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
proposers are the account addresses of the proposers.
submit_time is a timestamp specifying when a proposal was submitted.
group_version tracks the version of the group at proposal submission. This field is here for informational purposes only.
group_policy_version tracks the version of the group policy at proposal submission. When a decision policy is changed, existing proposals from previous policy versions will become invalid with the `ABORTED` status. This field is here for informational purposes only.
status represents the high level position in the life cycle of the proposal. Initial value is Submitted.
final_tally_result contains the sums of all weighted votes for this proposal for each vote option. It is empty at submission, and only populated after tallying, at voting period end or at proposal execution, whichever happens first.
voting_period_end is the timestamp before which voting must be done. Unless a successful MsgExec is called before (to execute a proposal whose tally is successful before the voting period ends), tallying will be done at this point, and the `final_tally_result`and `status` fields will be accordingly updated.
executor_result is the final result of the proposal execution. Initial value is NotRun.
messages is a list of `sdk.Msg`s that will be executed if the proposal passes.
title is the title of the proposal Since: cosmos-sdk 0.47
summary is a short summary of the proposal Since: cosmos-sdk 0.47
ProposalExecutorResult defines types of proposal executor results.
Used in:
, ,An empty value is not allowed.
We have not yet run the executor.
The executor was successful and proposed action updated state.
The executor returned an error and proposed action didn't update state.
ProposalStatus defines proposal statuses.
Used in:
,An empty value is invalid and not allowed.
Initial status of a proposal when submitted.
Final status of a proposal when the final tally is done and the outcome passes the group policy's decision policy.
Final status of a proposal when the final tally is done and the outcome is rejected by the group policy's decision policy.
Final status of a proposal when the group policy is modified before the final tally.
A proposal can be withdrawn before the voting start time by the owner. When this happens the final status is Withdrawn.
TallyResult represents the sum of weighted votes for each vote option.
Used in:
, ,yes_count is the weighted sum of yes votes.
abstain_count is the weighted sum of abstainers.
no_count is the weighted sum of no votes.
no_with_veto_count is the weighted sum of veto.
ThresholdDecisionPolicy is a decision policy where a proposal passes when it satisfies the two following conditions: 1. The sum of all `YES` voter's weights is greater or equal than the defined `threshold`. 2. The voting and execution periods of the proposal respect the parameters given by `windows`.
threshold is the minimum weighted sum of `YES` votes that must be met or exceeded for a proposal to succeed.
windows defines the different windows for voting and execution.
Vote represents a vote for a proposal.
Used in:
, , ,proposal is the unique ID of the proposal.
voter is the account address of the voter.
option is the voter's choice on the proposal.
metadata is any arbitrary metadata attached to the vote.
submit_time is the timestamp when the vote was submitted.
VoteOption enumerates the valid vote options for a given proposal.
Used in:
,VOTE_OPTION_UNSPECIFIED defines an unspecified vote option which will return an error.
VOTE_OPTION_YES defines a yes vote option.
VOTE_OPTION_ABSTAIN defines an abstain vote option.
VOTE_OPTION_NO defines a no vote option.
VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.