types

package
Version: v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

nolint

Index

Constants

View Source
const (
	MaxDescriptionLength int = 5000
	MaxTitleLength       int = 140
)

Constants pertaining to a Content object

View Source
const (
	DefaultCodespace sdk.CodespaceType = "gov"

	CodeUnknownProposal          sdk.CodeType = 1
	CodeInactiveProposal         sdk.CodeType = 2
	CodeAlreadyActiveProposal    sdk.CodeType = 3
	CodeAlreadyFinishedProposal  sdk.CodeType = 4
	CodeAddressNotStaked         sdk.CodeType = 5
	CodeInvalidContent           sdk.CodeType = 6
	CodeInvalidProposalType      sdk.CodeType = 7
	CodeInvalidVote              sdk.CodeType = 8
	CodeInvalidGenesis           sdk.CodeType = 9
	CodeInvalidProposalStatus    sdk.CodeType = 10
	CodeProposalHandlerNotExists sdk.CodeType = 11
)
View Source
const (
	EventTypeSubmitProposal   = "submit_proposal"
	EventTypeProposalDeposit  = "proposal_deposit"
	EventTypeProposalVote     = "proposal_vote"
	EventTypeProposalDaoVote  = "proposal_dao_vote"
	EventTypeInactiveProposal = "inactive_proposal"
	EventTypeActiveProposal   = "active_proposal"

	AttributeKeyProposalResult     = "proposal_result"
	AttributeKeyOption             = "option"
	AttributeKeyVoteAmount         = "vote_amount"
	AttributeKeyProposalID         = "proposal_id"
	AttributeKeyVotingPeriodStart  = "voting_period_start"
	AttributeValueCategory         = "governance"
	AttributeValueProposalDropped  = "proposal_dropped"  // didn't meet min deposit
	AttributeValueProposalPassed   = "proposal_passed"   // met vote quorum
	AttributeValueProposalRejected = "proposal_rejected" // didn't meet vote quorum
	AttributeValueProposalFailed   = "proposal_failed"   // error on proposal handler
)

Governance module event types

View Source
const (
	// ModuleName is the name of the module
	ModuleName = "gov"

	// StoreKey is the store key string for gov
	StoreKey = ModuleName

	// RouterKey is the message route for gov
	RouterKey = ModuleName

	// QuerierRoute is the querier route for gov
	QuerierRoute = ModuleName

	// DefaultParamspace default name for parameter store
	DefaultParamspace = ModuleName
)
View Source
const (
	TypeMsgDeposit        = "deposit"
	TypeMsgVote           = "vote"
	TypeMsgDaoVote        = "dao_vote"
	TypeMsgCancelDaoVote  = "cancel_dao_vote"
	TypeMsgSubmitProposal = "submit_proposal"
)

Governance message types and routes

View Source
const (
	QueryParams    = "params"
	QueryProposals = "proposals"
	QueryProposal  = "proposal"
	QueryDeposits  = "deposits"
	QueryDeposit   = "deposit"
	QueryVotes     = "votes"
	QueryVote      = "vote"
	QueryTally     = "tally"

	ParamDeposit  = "deposit"
	ParamVoting   = "voting"
	ParamTallying = "tallying"
)

query endpoints supported by the governance Querier

View Source
const (
	ProposalTypeText string = "Text"
)

Proposal types

Variables

View Source
var (
	ProposalsKeyPrefix          = []byte{0x00}
	ActiveProposalQueuePrefix   = []byte{0x01}
	InactiveProposalQueuePrefix = []byte{0x02}
	ProposalIDKey               = []byte{0x03}

	DepositsKeyPrefix = []byte{0x10}

	VotesKeyPrefix = []byte{0x20}

	DaoVotesKeyPrefix = []byte{0x30}
)

Keys for governance store Items are stored with the following key: values

- 0x00<proposalID_Bytes>: Proposal

- 0x01<endTime_Bytes><proposalID_Bytes>: activeProposalID

- 0x02<endTime_Bytes><proposalID_Bytes>: inactiveProposalID

- 0x03: nextProposalID

- 0x10<proposalID_Bytes><depositorAddr_Bytes>: Deposit

- 0x20<proposalID_Bytes><voterAddr_Bytes>: Voter

View Source
var (
	ParamStoreKeyDepositParams = []byte("depositparams")
	ParamStoreKeyVotingParams  = []byte("votingparams")
	ParamStoreKeyTallyParams   = []byte("tallyparams")
)

Parameter store key

View Source
var ModuleCdc = codec.New()

module codec

Functions

func ActiveProposalByTimeKey

func ActiveProposalByTimeKey(endTime time.Time) []byte

ActiveProposalByTimeKey gets the active proposal queue key by endTime

func ActiveProposalQueueKey

func ActiveProposalQueueKey(proposalID uint64, endTime time.Time) []byte

ActiveProposalQueueKey returns the key for a proposalID in the activeProposalQueue

func DaoVoteKey

func DaoVoteKey(proposalID uint64, voterAddr sdk.CUAddress) []byte

VoteKey key of a specific vote from the store

func DaoVotesKey

func DaoVotesKey(proposalID uint64) []byte

VotesKey gets the first part of the votes key based on the proposalID

func DepositKey

func DepositKey(proposalID uint64, depositorAddr sdk.CUAddress) []byte

DepositKey key of a specific deposit from the store

func DepositsKey

func DepositsKey(proposalID uint64) []byte

DepositsKey gets the first part of the deposits key based on the proposalID

func ErrAddressNotStaked

func ErrAddressNotStaked(codespace sdk.CodespaceType, address sdk.CUAddress) sdk.Error

func ErrAlreadyActiveProposal

func ErrAlreadyActiveProposal(codespace sdk.CodespaceType, proposalID uint64) sdk.Error

func ErrAlreadyFinishedProposal

func ErrAlreadyFinishedProposal(codespace sdk.CodespaceType, proposalID uint64) sdk.Error

func ErrInactiveProposal

func ErrInactiveProposal(codespace sdk.CodespaceType, proposalID uint64) sdk.Error

func ErrInvalidGenesis

func ErrInvalidGenesis(codespace sdk.CodespaceType, msg string) sdk.Error

func ErrInvalidProposalContent

func ErrInvalidProposalContent(cs sdk.CodespaceType, msg string) sdk.Error

func ErrInvalidProposalType

func ErrInvalidProposalType(codespace sdk.CodespaceType, proposalType string) sdk.Error

func ErrInvalidProposalVoteTime

func ErrInvalidProposalVoteTime(codespace sdk.CodespaceType, voteTime uint32) sdk.Error

func ErrInvalidVote

func ErrInvalidVote(codespace sdk.CodespaceType, voteOption VoteOption) sdk.Error

func ErrNoProposalHandlerExists

func ErrNoProposalHandlerExists(codespace sdk.CodespaceType, content interface{}) sdk.Error

func ErrUnknownProposal

func ErrUnknownProposal(codespace sdk.CodespaceType, proposalID uint64) sdk.Error

func InactiveProposalByTimeKey

func InactiveProposalByTimeKey(endTime time.Time) []byte

InactiveProposalByTimeKey gets the inactive proposal queue key by endTime

func InactiveProposalQueueKey

func InactiveProposalQueueKey(proposalID uint64, endTime time.Time) []byte

InactiveProposalQueueKey returns the key for a proposalID in the inactiveProposalQueue

func IsValidProposalType

func IsValidProposalType(ty string) bool

IsValidProposalType returns a boolean determining if the proposal type is valid.

NOTE: Modules with their own proposal types must register them.

func ParamKeyTable

func ParamKeyTable() params.KeyTable

Key declaration for parameters

func ProposalHandler

func ProposalHandler(_ sdk.Context, c Content) sdk.Result

ProposalHandler implements the Handler interface for governance module-based proposals (ie. TextProposal). Since these are merely signaling mechanisms at the moment and do not affect state, it performs a no-op.

func ProposalKey

func ProposalKey(proposalID uint64) []byte

ProposalKey gets a specific proposal from the store

func RegisterCodec

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers all the necessary types and interfaces for governance.

func RegisterProposalType

func RegisterProposalType(ty string)

RegisterProposalType registers a proposal type. It will panic if the type is already registered.

func RegisterProposalTypeCodec

func RegisterProposalTypeCodec(o interface{}, name string)

RegisterProposalTypeCodec registers an external proposal content type defined in another module for the internal ModuleCdc. This allows the MsgSubmitProposal to be correctly Amino encoded and decoded.

func SplitActiveProposalQueueKey

func SplitActiveProposalQueueKey(key []byte) (proposalID uint64, endTime time.Time)

SplitActiveProposalQueueKey split the active proposal key and returns the proposal id and endTime

func SplitInactiveProposalQueueKey

func SplitInactiveProposalQueueKey(key []byte) (proposalID uint64, endTime time.Time)

SplitInactiveProposalQueueKey split the inactive proposal key and returns the proposal id and endTime

func SplitKeyDeposit

func SplitKeyDeposit(key []byte) (proposalID uint64, depositorAddr sdk.CUAddress)

SplitKeyDeposit split the deposits key and returns the proposal id and depositor address

func SplitKeyVote

func SplitKeyVote(key []byte) (proposalID uint64, voterAddr sdk.CUAddress)

SplitKeyVote split the votes key and returns the proposal id and voter address

func SplitProposalKey

func SplitProposalKey(key []byte) (proposalID uint64)

SplitProposalKey split the proposal key and returns the proposal id

func ValidProposalStatus

func ValidProposalStatus(status ProposalStatus) bool

ValidProposalStatus returns true if the proposal status is valid and false otherwise.

func ValidVoteOption

func ValidVoteOption(option VoteOption) bool

ValidVoteOption returns true if the vote option is valid and false otherwise.

func ValidateAbstract

func ValidateAbstract(codespace sdk.CodespaceType, c Content) sdk.Error

ValidateAbstract validates a proposal's abstract contents returning an error if invalid.

func VoteKey

func VoteKey(proposalID uint64, voterAddr sdk.CUAddress) []byte

VoteKey key of a specific vote from the store

func VotesKey

func VotesKey(proposalID uint64) []byte

VotesKey gets the first part of the votes key based on the proposalID

Types

type Content

type Content interface {
	GetTitle() string
	GetDescription() string
	ProposalRoute() string
	ProposalType() string
	ProposalToken() string
	ValidateBasic() sdk.Error
	String() string
}

Content defines an interface that a proposal must implement. It contains information such as the title and description along with the type and routing information for the appropriate handler to process the proposal. Content can have additional fields, which will handled by a proposal's Handler.

func ContentFromProposalType

func ContentFromProposalType(title, desc, ty string) Content

ContentFromProposalType returns a Content object based on the proposal type.

func NewTextProposal

func NewTextProposal(title, description string) Content

type DaoVote

type DaoVote struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` //  proposalID of the proposal
	Voter      sdk.CUAddress `json:"voter" yaml:"voter"`             //  address of the voter
	VoteAmount sdk.Coins     `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
	Option     VoteOption    `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

func NewDaoVote

func NewDaoVote(proposalID uint64, voter sdk.CUAddress, voteAmount sdk.Coins, option VoteOption) DaoVote

NewDaoVote creates a new DaoVote instance

func (DaoVote) String

func (v DaoVote) String() string

type DaoVotes

type DaoVotes []DaoVote

DaoVotes is a collection of DaoVote objects

func (DaoVotes) String

func (v DaoVotes) String() string

type Deposit

type Deposit struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` //  proposalID of the proposal
	Depositor  sdk.CUAddress `json:"depositor" yaml:"depositor"`     //  Address of the depositor
	Amount     sdk.Coins     `json:"amount" yaml:"amount"`           //  Deposit amount
}

Deposit

func NewDeposit

func NewDeposit(proposalID uint64, depositor sdk.CUAddress, amount sdk.Coins) Deposit

NewDeposit creates a new Deposit instance

func (Deposit) Empty

func (d Deposit) Empty() bool

Empty returns whether a deposit is empty.

func (Deposit) Equals

func (d Deposit) Equals(comp Deposit) bool

Equals returns whether two deposits are equal.

func (Deposit) String

func (d Deposit) String() string

type DepositParams

type DepositParams struct {
	MinInitDeposit    sdk.Coins     `json:"min_init_deposit,omitempty" yaml:"min_init_deposit,omitempty"` // Minimum initial deposit for submitting  a proposal
	MinDeposit        sdk.Coins     `json:"min_deposit,omitempty" yaml:"min_deposit,omitempty"`           //  Minimum deposit for a proposal to enter voting period.
	MinDaoInitDeposit sdk.Coins     `json:"min_dao_init_deposit,omitempty" yaml:"min_dao_init_deposit,omitempty"`
	MinDaoDeposit     sdk.Coins     `json:"min_dao_deposit,omitempty" yaml:"min_dao_deposit,omitempty"`
	MaxDepositPeriod  time.Duration `json:"max_deposit_period,omitempty" yaml:"max_deposit_period,omitempty"` //  Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months
}

Param around deposits for governance

func NewDepositParams

func NewDepositParams(minInitDeposit, minDeposit, minDaoInitDeposit, minDaoDeposit sdk.Coins, maxDepositPeriod time.Duration) DepositParams

NewDepositParams creates a new DepositParams object

func (DepositParams) Equal

func (dp DepositParams) Equal(dp2 DepositParams) bool

Checks equality of DepositParams

func (DepositParams) String

func (dp DepositParams) String() string

type Deposits

type Deposits []Deposit

Deposits is a collection of Deposit objects

func (Deposits) String

func (d Deposits) String() string

type Handler

type Handler func(ctx sdk.Context, content Content) sdk.Result

Handler defines a function that handles a proposal after it has passed the governance process.

type MsgCancelDaoVote

type MsgCancelDaoVote struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` // ID of the proposal
	Voter      sdk.CUAddress `json:"voter" yaml:"voter"`             //  address of the voter
}

MsgCacelDaoVote

func NewMsgCancelDaoVote

func NewMsgCancelDaoVote(voter sdk.CUAddress, proposalID uint64) MsgCancelDaoVote

func (MsgCancelDaoVote) GetSignBytes

func (msg MsgCancelDaoVote) GetSignBytes() []byte

Implements Msg.

func (MsgCancelDaoVote) GetSigners

func (msg MsgCancelDaoVote) GetSigners() []sdk.CUAddress

Implements Msg.

func (MsgCancelDaoVote) Route

func (msg MsgCancelDaoVote) Route() string

Implements Msg. nolint

func (MsgCancelDaoVote) String

func (msg MsgCancelDaoVote) String() string

func (MsgCancelDaoVote) Type

func (msg MsgCancelDaoVote) Type() string

func (MsgCancelDaoVote) ValidateBasic

func (msg MsgCancelDaoVote) ValidateBasic() sdk.Error

Implements Msg.

type MsgDaoVote

type MsgDaoVote struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` // ID of the proposal
	Voter      sdk.CUAddress `json:"voter" yaml:"voter"`             //  address of the voter
	VoteAmount sdk.Coins     `json:"vote_amount" yaml:"vote_amount"` //  option amount by the voter
	Option     VoteOption    `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

MsgVote

func NewMsgDaoVote

func NewMsgDaoVote(voter sdk.CUAddress, proposalID uint64, voteAmount sdk.Coins, option VoteOption) MsgDaoVote

func (MsgDaoVote) GetSignBytes

func (msg MsgDaoVote) GetSignBytes() []byte

Implements Msg.

func (MsgDaoVote) GetSigners

func (msg MsgDaoVote) GetSigners() []sdk.CUAddress

Implements Msg.

func (MsgDaoVote) Route

func (msg MsgDaoVote) Route() string

Implements Msg. nolint

func (MsgDaoVote) String

func (msg MsgDaoVote) String() string

func (MsgDaoVote) Type

func (msg MsgDaoVote) Type() string

func (MsgDaoVote) ValidateBasic

func (msg MsgDaoVote) ValidateBasic() sdk.Error

Implements Msg.

type MsgDeposit

type MsgDeposit struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` // ID of the proposal
	Depositor  sdk.CUAddress `json:"depositor" yaml:"depositor"`     // Address of the depositor
	Amount     sdk.Coins     `json:"amount" yaml:"amount"`           // Coins to add to the proposal's deposit
}

MsgDeposit

func NewMsgDeposit

func NewMsgDeposit(depositor sdk.CUAddress, proposalID uint64, amount sdk.Coins) MsgDeposit

func (MsgDeposit) GetSignBytes

func (msg MsgDeposit) GetSignBytes() []byte

Implements Msg.

func (MsgDeposit) GetSigners

func (msg MsgDeposit) GetSigners() []sdk.CUAddress

Implements Msg.

func (MsgDeposit) Route

func (msg MsgDeposit) Route() string

Implements Msg. nolint

func (MsgDeposit) String

func (msg MsgDeposit) String() string

func (MsgDeposit) Type

func (msg MsgDeposit) Type() string

func (MsgDeposit) ValidateBasic

func (msg MsgDeposit) ValidateBasic() sdk.Error

Implements Msg.

type MsgSubmitProposal

type MsgSubmitProposal struct {
	Content        Content       `json:"content" yaml:"content"`
	InitialDeposit sdk.Coins     `json:"initial_deposit" yaml:"initial_deposit"` //  Initial deposit paid by sender. Must be strictly positive
	Proposer       sdk.CUAddress `json:"proposer" yaml:"proposer"`               //  Address of the proposer
	VoteTime       uint32        `json:"vote_time" yaml:"vote_time"`
}

MsgSubmitProposal

func NewMsgSubmitProposal

func NewMsgSubmitProposal(content Content, initialDeposit sdk.Coins, proposer sdk.CUAddress, voteTime uint32) MsgSubmitProposal

func (MsgSubmitProposal) GetSignBytes

func (msg MsgSubmitProposal) GetSignBytes() []byte

Implements Msg.

func (MsgSubmitProposal) GetSigners

func (msg MsgSubmitProposal) GetSigners() []sdk.CUAddress

Implements Msg.

func (MsgSubmitProposal) Route

func (msg MsgSubmitProposal) Route() string

nolint

func (MsgSubmitProposal) String

func (msg MsgSubmitProposal) String() string

func (MsgSubmitProposal) Type

func (msg MsgSubmitProposal) Type() string

func (MsgSubmitProposal) ValidateBasic

func (msg MsgSubmitProposal) ValidateBasic() sdk.Error

Implements Msg.

type MsgVote

type MsgVote struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` // ID of the proposal
	Voter      sdk.CUAddress `json:"voter" yaml:"voter"`             //  address of the voter
	Option     VoteOption    `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

MsgVote

func NewMsgVote

func NewMsgVote(voter sdk.CUAddress, proposalID uint64, option VoteOption) MsgVote

func (MsgVote) GetSignBytes

func (msg MsgVote) GetSignBytes() []byte

Implements Msg.

func (MsgVote) GetSigners

func (msg MsgVote) GetSigners() []sdk.CUAddress

Implements Msg.

func (MsgVote) Route

func (msg MsgVote) Route() string

Implements Msg. nolint

func (MsgVote) String

func (msg MsgVote) String() string

func (MsgVote) Type

func (msg MsgVote) Type() string

func (MsgVote) ValidateBasic

func (msg MsgVote) ValidateBasic() sdk.Error

Implements Msg.

type Params

type Params struct {
	VotingParams  VotingParams  `json:"voting_params" yaml:"voting_params"`
	TallyParams   TallyParams   `json:"tally_params" yaml:"tally_params"`
	DepositParams DepositParams `json:"deposit_params" yaml:"deposit_parmas"`
}

Params returns all of the governance params

func NewParams

func NewParams(vp VotingParams, tp TallyParams, dp DepositParams) Params

func (Params) String

func (gp Params) String() string

type Proposal

type Proposal struct {
	Content `json:"content" yaml:"content"` // Proposal content interface

	ProposalID       uint64         `json:"id" yaml:"id"`                                 //  ID of the proposal
	Status           ProposalStatus `json:"proposal_status" yaml:"proposal_status"`       // Status of the Proposal {Pending, Active, Passed, Rejected}
	FinalTallyResult TallyResult    `json:"final_tally_result" yaml:"final_tally_result"` // Result of Tallys

	SubmitTime     time.Time `json:"submit_time" yaml:"submit_time"`           // Time of the block where TxGovSubmitProposal was included
	DepositEndTime time.Time `json:"deposit_end_time" yaml:"deposit_end_time"` // Time that the Proposal would expire if deposit amount isn't met
	TotalDeposit   sdk.Coins `json:"total_deposit" yaml:"total_deposit"`       // Current deposit on this proposal. Initial value is set at InitialDeposit

	VoteTime        uint32    `json:"vote_time" yaml:"vote_time"`
	VotingStartTime time.Time `json:"voting_start_time" yaml:"voting_start_time"` // Time of the block where MinDeposit was reached. -1 if MinDeposit is not reached
	VotingEndTime   time.Time `json:"voting_end_time" yaml:"voting_end_time"`     // Time that the VotingPeriod for this proposal will end and votes will be tallied
}

Proposal defines a struct used by the governance module to allow for voting on network changes.

func NewProposal

func NewProposal(content Content, id uint64, submitTime, depositEndTime time.Time, voteTime uint32) Proposal

func (Proposal) String

func (p Proposal) String() string

nolint

type ProposalQueue

type ProposalQueue []uint64

ProposalQueue

type ProposalStatus

type ProposalStatus byte

ProposalStatus is a type alias that represents a proposal status as a byte

const (
	StatusNil           ProposalStatus = 0x00
	StatusDepositPeriod ProposalStatus = 0x01
	StatusVotingPeriod  ProposalStatus = 0x02
	StatusPassed        ProposalStatus = 0x03
	StatusRejected      ProposalStatus = 0x04
	StatusFailed        ProposalStatus = 0x05
)

nolint

func ProposalStatusFromString

func ProposalStatusFromString(str string) (ProposalStatus, error)

ProposalStatusToString turns a string into a ProposalStatus

func (ProposalStatus) Format

func (status ProposalStatus) Format(s fmt.State, verb rune)

Format implements the fmt.Formatter interface. nolint: errcheck

func (ProposalStatus) Marshal

func (status ProposalStatus) Marshal() ([]byte, error)

Marshal needed for protobuf compatibility

func (ProposalStatus) MarshalJSON

func (status ProposalStatus) MarshalJSON() ([]byte, error)

Marshals to JSON using string

func (ProposalStatus) String

func (status ProposalStatus) String() string

String implements the Stringer interface.

func (*ProposalStatus) Unmarshal

func (status *ProposalStatus) Unmarshal(data []byte) error

Unmarshal needed for protobuf compatibility

func (*ProposalStatus) UnmarshalJSON

func (status *ProposalStatus) UnmarshalJSON(data []byte) error

Unmarshals from JSON assuming Bech32 encoding

type Proposals

type Proposals []Proposal

Proposals is an array of proposal

func (Proposals) String

func (p Proposals) String() string

nolint

type QueryDepositParams

type QueryDepositParams struct {
	ProposalID uint64
	Depositor  sdk.CUAddress
}

Params for query 'custom/gov/deposit'

func NewQueryDepositParams

func NewQueryDepositParams(proposalID uint64, depositor sdk.CUAddress) QueryDepositParams

creates a new instance of QueryDepositParams

type QueryProposalParams

type QueryProposalParams struct {
	ProposalID uint64
}

Params for queries: - 'custom/gov/proposal' - 'custom/gov/deposits' - 'custom/gov/tally' - 'custom/gov/votes'

func NewQueryProposalParams

func NewQueryProposalParams(proposalID uint64) QueryProposalParams

creates a new instance of QueryProposalParams

type QueryProposalsParams

type QueryProposalsParams struct {
	Voter          sdk.CUAddress
	Depositor      sdk.CUAddress
	ProposalStatus ProposalStatus
	Limit          uint64
}

Params for query 'custom/gov/proposals'

func NewQueryProposalsParams

func NewQueryProposalsParams(status ProposalStatus, limit uint64, voter, depositor sdk.CUAddress) QueryProposalsParams

creates a new instance of QueryProposalsParams

type QueryVoteParams

type QueryVoteParams struct {
	ProposalID uint64
	Voter      sdk.CUAddress
}

Params for query 'custom/gov/vote'

func NewQueryVoteParams

func NewQueryVoteParams(proposalID uint64, voter sdk.CUAddress) QueryVoteParams

creates a new instance of QueryVoteParams

type TallyParams

type TallyParams struct {
	Quorum    sdk.Dec `json:"quorum,omitempty" yaml:"quorum,omitempty"`       //  Minimum percentage of total stake needed to vote for a result to be considered valid
	Threshold sdk.Dec `json:"threshold,omitempty" yaml:"threshold,omitempty"` //  Minimum proportion of Yes votes for proposal to pass. Initial value: 0.5
	Veto      sdk.Dec `json:"veto,omitempty" yaml:"veto,omitempty"`           //  Minimum value of Veto votes to Total votes ratio for proposal to be vetoed. Initial value: 1/3
}

Param around Tallying votes in governance

func NewTallyParams

func NewTallyParams(quorum, threshold, veto sdk.Dec) TallyParams

NewTallyParams creates a new TallyParams object

func (TallyParams) String

func (tp TallyParams) String() string

type TallyResult

type TallyResult struct {
	Yes        sdk.Int `json:"yes" yaml:"yes"`
	Abstain    sdk.Int `json:"abstain" yaml:"abstain"`
	No         sdk.Int `json:"no" yaml:"no"`
	NoWithVeto sdk.Int `json:"no_with_veto" yaml:"no_with_veto"`
}

Tally Results

func EmptyTallyResult

func EmptyTallyResult() TallyResult

EmptyTallyResult returns an empty TallyResult.

func NewTallyResult

func NewTallyResult(yes, abstain, no, noWithVeto sdk.Int) TallyResult

func NewTallyResultFromMap

func NewTallyResultFromMap(results map[VoteOption]sdk.Dec) TallyResult

func (TallyResult) Equals

func (tr TallyResult) Equals(comp TallyResult) bool

Equals returns if two proposals are equal.

func (TallyResult) String

func (tr TallyResult) String() string

type TextProposal

type TextProposal struct {
	Title       string `json:"title" yaml:"title"`
	Description string `json:"description" yaml:"description"`
}

Text Proposal

func (TextProposal) GetDescription

func (tp TextProposal) GetDescription() string

func (TextProposal) GetTitle

func (tp TextProposal) GetTitle() string

nolint

func (TextProposal) ProposalRoute

func (tp TextProposal) ProposalRoute() string

func (TextProposal) ProposalToken

func (tp TextProposal) ProposalToken() string

func (TextProposal) ProposalType

func (tp TextProposal) ProposalType() string

func (TextProposal) String

func (tp TextProposal) String() string

func (TextProposal) ValidateBasic

func (tp TextProposal) ValidateBasic() sdk.Error

type Vote

type Vote struct {
	ProposalID uint64        `json:"proposal_id" yaml:"proposal_id"` //  proposalID of the proposal
	Voter      sdk.CUAddress `json:"voter" yaml:"voter"`             //  address of the voter
	Option     VoteOption    `json:"option" yaml:"option"`           //  option from OptionSet chosen by the voter
}

Vote

func NewVote

func NewVote(proposalID uint64, voter sdk.CUAddress, option VoteOption) Vote

NewVote creates a new Vote instance

func (Vote) Empty

func (v Vote) Empty() bool

Empty returns whether a vote is empty.

func (Vote) Equals

func (v Vote) Equals(comp Vote) bool

Equals returns whether two votes are equal.

func (Vote) String

func (v Vote) String() string

type VoteOption

type VoteOption byte

VoteOption defines a vote option

const (
	OptionEmpty      VoteOption = 0x00
	OptionYes        VoteOption = 0x01
	OptionAbstain    VoteOption = 0x02
	OptionNo         VoteOption = 0x03
	OptionNoWithVeto VoteOption = 0x04
)

Vote options

func VoteOptionFromString

func VoteOptionFromString(str string) (VoteOption, error)

VoteOptionFromString returns a VoteOption from a string. It returns an error if the string is invalid.

func (VoteOption) Format

func (vo VoteOption) Format(s fmt.State, verb rune)

Format implements the fmt.Formatter interface. nolint: errcheck

func (VoteOption) Marshal

func (vo VoteOption) Marshal() ([]byte, error)

Marshal needed for protobuf compatibility.

func (VoteOption) MarshalJSON

func (vo VoteOption) MarshalJSON() ([]byte, error)

Marshals to JSON using string.

func (VoteOption) String

func (vo VoteOption) String() string

String implements the Stringer interface.

func (*VoteOption) Unmarshal

func (vo *VoteOption) Unmarshal(data []byte) error

Unmarshal needed for protobuf compatibility.

func (*VoteOption) UnmarshalJSON

func (vo *VoteOption) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes from JSON assuming Bech32 encoding.

type Votes

type Votes []Vote

Votes is a collection of Vote objects

func (Votes) String

func (v Votes) String() string

type VotingParams

type VotingParams struct {
	VotingPeriod time.Duration `json:"voting_period,omitempty" yaml:"voting_period,omitempty"` //  Length of the voting period.
}

Param around Voting in governance

func NewVotingParams

func NewVotingParams(votingPeriod time.Duration) VotingParams

NewVotingParams creates a new VotingParams object

func (VotingParams) String

func (vp VotingParams) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL