v036

Documentation

Overview

DONTCOVER

Index

• Constants
• func ErrInvalidProposalContent(msg string) error
• func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
• func ValidateAbstract(c Content) error
• type Content
  • func NewTextProposal(title, description string) Content
• type GenesisState
  • func Migrate(oldGenState v034gov.GenesisState) GenesisState
  • func NewGenesisState(startingProposalID uint64, deposits v034gov.Deposits, votes v034gov.Votes, ...) GenesisState
• type Proposal
• type ProposalQueue
• type Proposals
• type TextProposal
  • func (tp TextProposal) GetDescription() string
  • func (tp TextProposal) GetTitle() string
  • func (tp TextProposal) ProposalRoute() string
  • func (tp TextProposal) ProposalType() string
  • func (tp TextProposal) String() string
  • func (tp TextProposal) ValidateBasic() error

Constants

const (
	ModuleName = "gov"
	RouterKey  = ModuleName

	ProposalTypeText string = "Text"

	MaxDescriptionLength int = 5000
	MaxTitleLength       int = 140
)

Functions

func ErrInvalidProposalContent

func ErrInvalidProposalContent(msg string) error

func RegisterLegacyAminoCodec

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

func ValidateAbstract

func ValidateAbstract(c Content) error

Types

type Content

type Content interface {
	GetTitle() string
	GetDescription() string
	ProposalRoute() string
	ProposalType() string
	ValidateBasic() error
	String() string
}

func NewTextProposal

func NewTextProposal(title, description string) Content

type GenesisState

type GenesisState struct {
	StartingProposalID uint64                `json:"starting_proposal_id"`
	Deposits           v034gov.Deposits      `json:"deposits"`
	Votes              v034gov.Votes         `json:"votes"`
	Proposals          []Proposal            `json:"proposals"`
	DepositParams      v034gov.DepositParams `json:"deposit_params"`
	VotingParams       v034gov.VotingParams  `json:"voting_params"`
	TallyParams        v034gov.TallyParams   `json:"tally_params"`
}

func Migrate

func Migrate(oldGenState v034gov.GenesisState) GenesisState

Migrate accepts exported genesis state from v0.34 and migrates it to v0.36 genesis state. This migration flattens the deposits and votes and updates the proposal content to the new

func NewGenesisState

func NewGenesisState(
	startingProposalID uint64, deposits v034gov.Deposits, votes v034gov.Votes, proposals []Proposal,
	depositParams v034gov.DepositParams, votingParams v034gov.VotingParams, tallyParams v034gov.TallyParams,
) GenesisState

type Proposal

type Proposal struct {
	Content `json:"content"`

	ProposalID       uint64                 `json:"id"`
	Status           v034gov.ProposalStatus `json:"proposal_status"`
	FinalTallyResult v034gov.TallyResult    `json:"final_tally_result"`

	SubmitTime     time.Time `json:"submit_time"`
	DepositEndTime time.Time `json:"deposit_end_time"`
	TotalDeposit   sdk.Coins `json:"total_deposit"`

	VotingStartTime time.Time `json:"voting_start_time"`
	VotingEndTime   time.Time `json:"voting_end_time"`
}

type ProposalQueue

type ProposalQueue []uint64

type Proposals

type Proposals []Proposal

type TextProposal

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

func (TextProposal) GetDescription

func (tp TextProposal) GetDescription() string

func (TextProposal) GetTitle

func (tp TextProposal) GetTitle() string

func (TextProposal) ProposalRoute

func (tp TextProposal) ProposalRoute() string

func (TextProposal) ProposalType

func (tp TextProposal) ProposalType() string

func (TextProposal) String

func (tp TextProposal) String() string

func (TextProposal) ValidateBasic

func (tp TextProposal) ValidateBasic() error