5.8 KiB
Msg Service
Msg/CreateGroup
A new group can be created with the MsgCreateGroup, which has an admin address, a list of members and some optional metadata bytes.
The metadata has a maximum length that is chosen by the app developer, and passed into the group keeper as a config.
+++ 6f58963e7f/proto/cosmos/group/v1beta1/tx.proto (L54-L65)
It's expecting to fail if metadata length is greater than MaxMetadataLen config.
Msg/UpdateGroupMembers
Group members can be updated with the UpdateGroupMembers.
+++9aef070625/proto/cosmos/group/v1beta1/tx.proto (L74-L86)
In the list of MemberUpdates, an existing member can be removed by setting its weight to 0.
It's expecting to fail if the signer is not the admin of the group.
Msg/UpdateGroupAdmin
The UpdateGroupAdmin can be used to update a group admin.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L91-L102)
It's expecting to fail if the signer is not the admin of the group.
Msg/UpdateGroupMetadata
The UpdateGroupMetadata can be used to update a group metadata.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L107-L118)
It's expecting to fail if:
- new metadata length is greater than
MaxMetadataLenconfig. - the signer is not the admin of the group.
Msg/CreateGroupPolicy
A new group policy can be created with the MsgCreateGroupPolicy, which has an admin address, a group id, a decision policy and some optional metadata bytes.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L127-L142)
It's expecting to fail if metadata length is greater than MaxMetadataLen config.
Msg/CreateGroupWithPolicy
A new group with policy can be created with the MsgCreateGroupWithPolicy, which has an admin address, a list of members, a decision policy, a group policy as admin field to optionally set group and group policy admin with group policy address and some optional metadata bytes for group and group policy.
It's expecting to fail if group metadata or group policy metadata length is greater than some MaxMetadataLength.
Msg/UpdateGroupPolicyAdmin
The UpdateGroupPolicyAdmin can be used to update a group policy admin.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L151-L162)
It's expecting to fail if the signer is not the admin of the group policy.
Msg/UpdateGroupPolicyDecisionPolicy
The UpdateGroupPolicyDecisionPolicy can be used to update a decision policy.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L167-L179)
It's expecting to fail if the signer is not the admin of the group policy.
Msg/UpdateGroupPolicyMetadata
The UpdateGroupPolicyMetadata can be used to update a group policy metadata.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L184-L195)
It's expecting to fail if:
- new metadata length is greater than
MaxMetadataLenconfig. - the signer is not the admin of the group.
Msg/CreateProposal
A new proposal can be created with the MsgCreateProposal, which has a group policy account address, a list of proposers addresses, a list of messages to execute if the proposal is accepted and some optional metadata bytes.
An optional Exec value can be provided to try to execute the proposal immediately after proposal creation. Proposers signatures are considered as yes votes in this case.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L218-L239)
It's expecting to fail if metadata length is greater than MaxMetadataLen config.
Msg/WithdrawProposal
A proposal can be withdrawn using MsgWithdrawProposal which has a address (can be either proposer or policy admin) and a proposal_id (which has to be withdrawn).
+++ f2d6f0e4bb/proto/cosmos/group/v1beta1/tx.proto (L251-L258)
It's expecting to fail if:
- the signer is neither policy address nor proposer of the proposal.
- the proposal is already closed or aborted.
Msg/Vote
A new vote can be created with the MsgVote, given a proposal id, a voter address, a choice (yes, no, veto or abstain) and some optional metadata bytes.
An optional Exec value can be provided to try to execute the proposal immediately after voting.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L248-L265)
It's expecting to fail if metadata length is greater than MaxMetadataLen config.
Msg/Exec
A proposal can be executed with the MsgExec.
+++ 9aef070625/proto/cosmos/group/v1beta1/tx.proto (L270-L278)
The messages that are part of this proposal won't be executed if:
- the group has been modified before tally.
- the group policy has been modified before tally.
- the proposal has not been accepted.
- the proposal status is not closed.
- the proposal has already been successfully executed.
Msg/LeaveGroup
The MsgLeaveGroup allows group member to leave a group.
+++ a635fd7866/proto/cosmos/group/v1beta1/tx.proto (L352-L361)
It's expecting to fail if:
- the group member is not part of the group.