cosmos-sdk/x/group/msgs.go

681 lines
18 KiB
Go

package group
import (
"fmt"
proto "github.com/gogo/protobuf/proto"
"github.com/cosmos/cosmos-sdk/codec/types"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"github.com/cosmos/cosmos-sdk/types/tx"
errors "github.com/cosmos/cosmos-sdk/x/group/errors"
"github.com/cosmos/cosmos-sdk/x/group/internal/math"
)
// Group message types and routes
const (
TypeMsgCreateGroup = "create_group"
TypeMsgUpdateGroupAdmin = "update_group_admin"
TypeMsgUpdateGroupComment = "update_group_comment"
TypeMsgUpdateGroupMembers = "update_group_members"
TypeMsgCreateGroupPolicy = "create_group_policy"
TypeMsgUpdateGroupPolicyAdmin = "update_group_policy_admin"
TypeMsgUpdateGroupPolicyDecisionPolicy = "update_group_policy_decision_policy"
TypeMsgUpdateGroupPolicyComment = "update_group_policy_comment"
TypeMsgCreateProposal = "create_proposal"
TypeMsgVote = "vote"
TypeMsgExec = "exec"
)
var _ sdk.Msg = &MsgCreateGroup{}
// Route Implements Msg.
func (m MsgCreateGroup) Route() string { return RouterKey }
// Type Implements Msg.
func (m MsgCreateGroup) Type() string { return TypeMsgCreateGroup }
// GetSignBytes Implements Msg.
func (m MsgCreateGroup) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgCreateGroup.
func (m MsgCreateGroup) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgCreateGroup) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
members := Members{Members: m.Members}
if err := members.ValidateBasic(); err != nil {
return sdkerrors.Wrap(err, "members")
}
for i := range m.Members {
member := m.Members[i]
if _, err := math.NewDecFromString(member.Weight); err != nil {
// if _, err := math.ParsePositiveDecimal(member.Weight); err != nil {
return sdkerrors.Wrap(err, "member weight")
}
}
return nil
}
func (m Member) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Address)
if err != nil {
return sdkerrors.Wrap(err, "address")
}
if _, err := math.NewDecFromString(m.Weight); err != nil {
// if _, err := math.ParseNonNegativeDecimal(m.Weight); err != nil {
return sdkerrors.Wrap(err, "weight")
}
return nil
}
var _ sdk.Msg = &MsgUpdateGroupAdmin{}
// Route Implements Msg.
func (m MsgUpdateGroupAdmin) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupAdmin) Type() string { return TypeMsgUpdateGroupAdmin }
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupAdmin) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgUpdateGroupAdmin.
func (m MsgUpdateGroupAdmin) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupAdmin) ValidateBasic() error {
if m.GroupId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "group")
}
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
newAdmin, err := sdk.AccAddressFromBech32(m.NewAdmin)
if err != nil {
return sdkerrors.Wrap(err, "new admin")
}
if admin.Equals(newAdmin) {
return sdkerrors.Wrap(errors.ErrInvalid, "new and old admin are the same")
}
return nil
}
func (m *MsgUpdateGroupAdmin) GetGroupID() uint64 {
return m.GroupId
}
var _ sdk.Msg = &MsgUpdateGroupMetadata{}
// Route Implements Msg.
func (m MsgUpdateGroupMetadata) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupMetadata) Type() string { return TypeMsgUpdateGroupComment }
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupMetadata) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgUpdateGroupMetadata.
func (m MsgUpdateGroupMetadata) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupMetadata) ValidateBasic() error {
if m.GroupId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "group")
}
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
return nil
}
func (m *MsgUpdateGroupMetadata) GetGroupID() uint64 {
return m.GroupId
}
var _ sdk.Msg = &MsgUpdateGroupMembers{}
// Route Implements Msg.
func (m MsgUpdateGroupMembers) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupMembers) Type() string { return TypeMsgUpdateGroupMembers }
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupMembers) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
var _ sdk.Msg = &MsgUpdateGroupMembers{}
// GetSigners returns the expected signers for a MsgUpdateGroupMembers.
func (m MsgUpdateGroupMembers) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupMembers) ValidateBasic() error {
if m.GroupId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "group")
}
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
if len(m.MemberUpdates) == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "member updates")
}
members := Members{Members: m.MemberUpdates}
if err := members.ValidateBasic(); err != nil {
return sdkerrors.Wrap(err, "members")
}
return nil
}
func (m *MsgUpdateGroupMembers) GetGroupID() uint64 {
return m.GroupId
}
var _ sdk.Msg = &MsgCreateGroupPolicy{}
// Route Implements Msg.
func (m MsgCreateGroupPolicy) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgCreateGroupPolicy) Type() string { return TypeMsgCreateGroupPolicy }
// GetSignBytes Implements Msg.
func (m MsgCreateGroupPolicy) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgCreateGroupPolicy.
func (m MsgCreateGroupPolicy) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgCreateGroupPolicy) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
if m.GroupId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "group")
}
policy := m.GetDecisionPolicy()
if policy == nil {
return sdkerrors.Wrap(errors.ErrEmpty, "decision policy")
}
if err := policy.ValidateBasic(); err != nil {
return sdkerrors.Wrap(err, "decision policy")
}
return nil
}
var _ sdk.Msg = &MsgUpdateGroupPolicyAdmin{}
// Route Implements Msg.
func (m MsgUpdateGroupPolicyAdmin) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupPolicyAdmin) Type() string { return TypeMsgUpdateGroupPolicyAdmin }
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupPolicyAdmin) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgUpdateGroupPolicyAdmin.
func (m MsgUpdateGroupPolicyAdmin) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupPolicyAdmin) ValidateBasic() error {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
newAdmin, err := sdk.AccAddressFromBech32(m.NewAdmin)
if err != nil {
return sdkerrors.Wrap(err, "new admin")
}
_, err = sdk.AccAddressFromBech32(m.Address)
if err != nil {
return sdkerrors.Wrap(err, "group policy")
}
if admin.Equals(newAdmin) {
return sdkerrors.Wrap(errors.ErrInvalid, "new and old admin are the same")
}
return nil
}
var _ sdk.Msg = &MsgUpdateGroupPolicyDecisionPolicy{}
var _ types.UnpackInterfacesMessage = MsgUpdateGroupPolicyDecisionPolicy{}
func NewMsgUpdateGroupPolicyDecisionPolicyRequest(admin sdk.AccAddress, address sdk.AccAddress, decisionPolicy DecisionPolicy) (*MsgUpdateGroupPolicyDecisionPolicy, error) {
m := &MsgUpdateGroupPolicyDecisionPolicy{
Admin: admin.String(),
Address: address.String(),
}
err := m.SetDecisionPolicy(decisionPolicy)
if err != nil {
return nil, err
}
return m, nil
}
func (m *MsgUpdateGroupPolicyDecisionPolicy) SetDecisionPolicy(decisionPolicy DecisionPolicy) error {
msg, ok := decisionPolicy.(proto.Message)
if !ok {
return fmt.Errorf("can't proto marshal %T", msg)
}
any, err := types.NewAnyWithValue(msg)
if err != nil {
return err
}
m.DecisionPolicy = any
return nil
}
// Route Implements Msg.
func (m MsgUpdateGroupPolicyDecisionPolicy) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupPolicyDecisionPolicy) Type() string {
return TypeMsgUpdateGroupPolicyDecisionPolicy
}
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupPolicyDecisionPolicy) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgUpdateGroupPolicyDecisionPolicy.
func (m MsgUpdateGroupPolicyDecisionPolicy) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupPolicyDecisionPolicy) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
_, err = sdk.AccAddressFromBech32(m.Address)
if err != nil {
return sdkerrors.Wrap(err, "group policy")
}
policy := m.GetDecisionPolicy()
if policy == nil {
return sdkerrors.Wrap(errors.ErrEmpty, "decision policy")
}
if err := policy.ValidateBasic(); err != nil {
return sdkerrors.Wrap(err, "decision policy")
}
return nil
}
func (m *MsgUpdateGroupPolicyDecisionPolicy) GetDecisionPolicy() DecisionPolicy {
decisionPolicy, ok := m.DecisionPolicy.GetCachedValue().(DecisionPolicy)
if !ok {
return nil
}
return decisionPolicy
}
// UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces
func (m MsgUpdateGroupPolicyDecisionPolicy) UnpackInterfaces(unpacker types.AnyUnpacker) error {
var decisionPolicy DecisionPolicy
return unpacker.UnpackAny(m.DecisionPolicy, &decisionPolicy)
}
var _ sdk.Msg = &MsgUpdateGroupPolicyMetadata{}
// Route Implements Msg.
func (m MsgUpdateGroupPolicyMetadata) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgUpdateGroupPolicyMetadata) Type() string { return TypeMsgUpdateGroupPolicyComment }
// GetSignBytes Implements Msg.
func (m MsgUpdateGroupPolicyMetadata) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgUpdateGroupPolicyMetadata.
func (m MsgUpdateGroupPolicyMetadata) GetSigners() []sdk.AccAddress {
admin, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
panic(err)
}
return []sdk.AccAddress{admin}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgUpdateGroupPolicyMetadata) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Admin)
if err != nil {
return sdkerrors.Wrap(err, "admin")
}
_, err = sdk.AccAddressFromBech32(m.Address)
if err != nil {
return sdkerrors.Wrap(err, "group policy")
}
return nil
}
var _ sdk.Msg = &MsgCreateGroupPolicy{}
var _ types.UnpackInterfacesMessage = MsgCreateGroupPolicy{}
// NewMsgCreateGroupPolicy creates a new MsgCreateGroupPolicy.
func NewMsgCreateGroupPolicy(admin sdk.AccAddress, group uint64, metadata []byte, decisionPolicy DecisionPolicy) (*MsgCreateGroupPolicy, error) {
m := &MsgCreateGroupPolicy{
Admin: admin.String(),
GroupId: group,
Metadata: metadata,
}
err := m.SetDecisionPolicy(decisionPolicy)
if err != nil {
return nil, err
}
return m, nil
}
func (m *MsgCreateGroupPolicy) GetAdmin() string {
return m.Admin
}
func (m *MsgCreateGroupPolicy) GetGroupID() uint64 {
return m.GroupId
}
func (m *MsgCreateGroupPolicy) GetMetadata() []byte {
return m.Metadata
}
func (m *MsgCreateGroupPolicy) GetDecisionPolicy() DecisionPolicy {
decisionPolicy, ok := m.DecisionPolicy.GetCachedValue().(DecisionPolicy)
if !ok {
return nil
}
return decisionPolicy
}
func (m *MsgCreateGroupPolicy) SetDecisionPolicy(decisionPolicy DecisionPolicy) error {
msg, ok := decisionPolicy.(proto.Message)
if !ok {
return fmt.Errorf("can't proto marshal %T", msg)
}
any, err := types.NewAnyWithValue(msg)
if err != nil {
return err
}
m.DecisionPolicy = any
return nil
}
// UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces
func (m MsgCreateGroupPolicy) UnpackInterfaces(unpacker types.AnyUnpacker) error {
var decisionPolicy DecisionPolicy
return unpacker.UnpackAny(m.DecisionPolicy, &decisionPolicy)
}
var _ sdk.Msg = &MsgCreateProposal{}
// NewMsgCreateProposalRequest creates a new MsgCreateProposal.
func NewMsgCreateProposalRequest(address string, proposers []string, msgs []sdk.Msg, metadata []byte, exec Exec) (*MsgCreateProposal, error) {
m := &MsgCreateProposal{
Address: address,
Proposers: proposers,
Metadata: metadata,
Exec: exec,
}
err := m.SetMsgs(msgs)
if err != nil {
return nil, err
}
return m, nil
}
// Route Implements Msg.
func (m MsgCreateProposal) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgCreateProposal) Type() string { return TypeMsgCreateProposal }
// GetSignBytes Implements Msg.
func (m MsgCreateProposal) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgCreateProposal.
func (m MsgCreateProposal) GetSigners() []sdk.AccAddress {
addrs := make([]sdk.AccAddress, len(m.Proposers))
for i, proposer := range m.Proposers {
addr, err := sdk.AccAddressFromBech32(proposer)
if err != nil {
panic(err)
}
addrs[i] = addr
}
return addrs
}
// ValidateBasic does a sanity check on the provided data
func (m MsgCreateProposal) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Address)
if err != nil {
return sdkerrors.Wrap(err, "group policy")
}
if len(m.Proposers) == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "proposers")
}
addrs := make([]sdk.AccAddress, len(m.Proposers))
for i, proposer := range m.Proposers {
addr, err := sdk.AccAddressFromBech32(proposer)
if err != nil {
return sdkerrors.Wrap(err, "proposers")
}
addrs[i] = addr
}
if err := AccAddresses(addrs).ValidateBasic(); err != nil {
return sdkerrors.Wrap(err, "proposers")
}
msgs := m.GetMsgs()
for i, msg := range msgs {
if err := msg.ValidateBasic(); err != nil {
return sdkerrors.Wrapf(err, "msg %d", i)
}
}
return nil
}
// SetMsgs packs msgs into Any's
func (m *MsgCreateProposal) SetMsgs(msgs []sdk.Msg) error {
anys, err := tx.SetMsgs(msgs)
if err != nil {
return err
}
m.Msgs = anys
return nil
}
// GetMsgs unpacks m.Msgs Any's into sdk.Msg's
func (m MsgCreateProposal) GetMsgs() []sdk.Msg {
msgs, err := tx.GetMsgs(m.Msgs, "proposal")
if err != nil {
panic(err)
}
return msgs
}
// UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces
func (m MsgCreateProposal) UnpackInterfaces(unpacker types.AnyUnpacker) error {
return tx.UnpackInterfaces(unpacker, m.Msgs)
}
var _ sdk.Msg = &MsgVote{}
// Route Implements Msg.
func (m MsgVote) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgVote) Type() string { return TypeMsgVote }
// GetSignBytes Implements Msg.
func (m MsgVote) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgVote.
func (m MsgVote) GetSigners() []sdk.AccAddress {
addr, err := sdk.AccAddressFromBech32(m.Voter)
if err != nil {
panic(err)
}
return []sdk.AccAddress{addr}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgVote) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Voter)
if err != nil {
return sdkerrors.Wrap(err, "voter")
}
if m.ProposalId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "proposal")
}
if m.Choice == Choice_CHOICE_UNSPECIFIED {
return sdkerrors.Wrap(errors.ErrEmpty, "choice")
}
if _, ok := Choice_name[int32(m.Choice)]; !ok {
return sdkerrors.Wrap(errors.ErrInvalid, "choice")
}
return nil
}
var _ sdk.Msg = &MsgExec{}
// Route Implements Msg.
func (m MsgExec) Route() string {
return RouterKey
}
// Type Implements Msg.
func (m MsgExec) Type() string { return TypeMsgExec }
// GetSignBytes Implements Msg.
func (m MsgExec) GetSignBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&m))
}
// GetSigners returns the expected signers for a MsgExec.
func (m MsgExec) GetSigners() []sdk.AccAddress {
signer, err := sdk.AccAddressFromBech32(m.Signer)
if err != nil {
panic(err)
}
return []sdk.AccAddress{signer}
}
// ValidateBasic does a sanity check on the provided data
func (m MsgExec) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(m.Signer)
if err != nil {
return sdkerrors.Wrap(err, "signer")
}
if m.ProposalId == 0 {
return sdkerrors.Wrap(errors.ErrEmpty, "proposal")
}
return nil
}