158 lines
4.2 KiB
Go
158 lines
4.2 KiB
Go
package types
|
|
|
|
import (
|
|
"gopkg.in/yaml.v2"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
)
|
|
|
|
// Governance message types and routes
|
|
const (
|
|
TypeMsgDeposit = "deposit"
|
|
TypeMsgVote = "vote"
|
|
TypeMsgSubmitProposal = "submit_proposal"
|
|
)
|
|
|
|
var _, _, _ sdk.Msg = MsgSubmitProposalBase{}, MsgDeposit{}, MsgVote{}
|
|
|
|
// MsgSubmitProposal defines the specific interface a concrete message must
|
|
// implement in order to process governance proposals. The concrete MsgSubmitProposal
|
|
// must be defined at the application-level.
|
|
type MsgSubmitProposal interface {
|
|
sdk.Msg
|
|
|
|
GetContent() Content
|
|
GetInitialDeposit() sdk.Coins
|
|
GetProposer() sdk.AccAddress
|
|
}
|
|
|
|
// NewMsgSubmitProposalBase creates a new MsgSubmitProposalBase.
|
|
func NewMsgSubmitProposalBase(initialDeposit sdk.Coins, proposer sdk.AccAddress) MsgSubmitProposalBase {
|
|
return MsgSubmitProposalBase{
|
|
InitialDeposit: initialDeposit,
|
|
Proposer: proposer,
|
|
}
|
|
}
|
|
|
|
// Route implements Msg
|
|
func (msg MsgSubmitProposalBase) Route() string { return RouterKey }
|
|
|
|
// Type implements Msg
|
|
func (msg MsgSubmitProposalBase) Type() string { return TypeMsgSubmitProposal }
|
|
|
|
// ValidateBasic implements Msg
|
|
func (msg MsgSubmitProposalBase) ValidateBasic() error {
|
|
if msg.Proposer.Empty() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidAddress, msg.Proposer.String())
|
|
}
|
|
if !msg.InitialDeposit.IsValid() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, msg.InitialDeposit.String())
|
|
}
|
|
if msg.InitialDeposit.IsAnyNegative() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, msg.InitialDeposit.String())
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// GetSignBytes implements Msg
|
|
func (msg MsgSubmitProposalBase) GetSignBytes() []byte {
|
|
bz := ModuleCdc.MustMarshalJSON(msg)
|
|
return sdk.MustSortJSON(bz)
|
|
}
|
|
|
|
// GetSigners implements Msg
|
|
func (msg MsgSubmitProposalBase) GetSigners() []sdk.AccAddress {
|
|
return []sdk.AccAddress{msg.Proposer}
|
|
}
|
|
|
|
// String implements the Stringer interface
|
|
func (msg MsgSubmitProposalBase) String() string {
|
|
out, _ := yaml.Marshal(msg)
|
|
return string(out)
|
|
}
|
|
|
|
// NewMsgDeposit creates a new MsgDeposit instance
|
|
func NewMsgDeposit(depositor sdk.AccAddress, proposalID uint64, amount sdk.Coins) MsgDeposit {
|
|
return MsgDeposit{proposalID, depositor, amount}
|
|
}
|
|
|
|
// Route implements Msg
|
|
func (msg MsgDeposit) Route() string { return RouterKey }
|
|
|
|
// Type implements Msg
|
|
func (msg MsgDeposit) Type() string { return TypeMsgDeposit }
|
|
|
|
// ValidateBasic implements Msg
|
|
func (msg MsgDeposit) ValidateBasic() error {
|
|
if msg.Depositor.Empty() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidAddress, msg.Depositor.String())
|
|
}
|
|
if !msg.Amount.IsValid() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, msg.Amount.String())
|
|
}
|
|
if msg.Amount.IsAnyNegative() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, msg.Amount.String())
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// String implements the Stringer interface
|
|
func (msg MsgDeposit) String() string {
|
|
out, _ := yaml.Marshal(msg)
|
|
return string(out)
|
|
}
|
|
|
|
// GetSignBytes implements Msg
|
|
func (msg MsgDeposit) GetSignBytes() []byte {
|
|
bz := ModuleCdc.MustMarshalJSON(msg)
|
|
return sdk.MustSortJSON(bz)
|
|
}
|
|
|
|
// GetSigners implements Msg
|
|
func (msg MsgDeposit) GetSigners() []sdk.AccAddress {
|
|
return []sdk.AccAddress{msg.Depositor}
|
|
}
|
|
|
|
// NewMsgVote creates a message to cast a vote on an active proposal
|
|
func NewMsgVote(voter sdk.AccAddress, proposalID uint64, option VoteOption) MsgVote {
|
|
return MsgVote{proposalID, voter, option}
|
|
}
|
|
|
|
// Route implements Msg
|
|
func (msg MsgVote) Route() string { return RouterKey }
|
|
|
|
// Type implements Msg
|
|
func (msg MsgVote) Type() string { return TypeMsgVote }
|
|
|
|
// ValidateBasic implements Msg
|
|
func (msg MsgVote) ValidateBasic() error {
|
|
if msg.Voter.Empty() {
|
|
return sdkerrors.Wrap(sdkerrors.ErrInvalidAddress, msg.Voter.String())
|
|
}
|
|
if !ValidVoteOption(msg.Option) {
|
|
return sdkerrors.Wrap(ErrInvalidVote, msg.Option.String())
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// String implements the Stringer interface
|
|
func (msg MsgVote) String() string {
|
|
out, _ := yaml.Marshal(msg)
|
|
return string(out)
|
|
}
|
|
|
|
// GetSignBytes implements Msg
|
|
func (msg MsgVote) GetSignBytes() []byte {
|
|
bz := ModuleCdc.MustMarshalJSON(msg)
|
|
return sdk.MustSortJSON(bz)
|
|
}
|
|
|
|
// GetSigners implements Msg
|
|
func (msg MsgVote) GetSigners() []sdk.AccAddress {
|
|
return []sdk.AccAddress{msg.Voter}
|
|
}
|