Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gov

package

Go to main page

Versions in this module

v1

v1.3.1

Jan 7, 2021

v1.3.0

Dec 22, 2020

v1.2.1

Nov 12, 2020

v1.2.0

Jun 5, 2020

v1.1.2

May 29, 2020

v1.1.1

May 20, 2020

v1.1.0

Apr 29, 2020

v1.0.1

Apr 17, 2020

v1.0.0

Feb 28, 2020

v0

v0.3.0

Jan 8, 2020

v0.2.1

Dec 25, 2019

v0.2.0

Dec 24, 2019

v0.1.0

Dec 18, 2019

Changes in this version

+ const CodeAddressNotStaked

+ const CodeAlreadyActiveProposal

+ const CodeAlreadyFinishedProposal

+ const CodeAlreadyVote

+ const CodeInactiveProposal

+ const CodeInvalidDescription

+ const CodeInvalidGenesis

+ const CodeInvalidInput

+ const CodeInvalidProposal

+ const CodeInvalidProposalStatus

+ const CodeInvalidProposalType

+ const CodeInvalidTitle

+ const CodeInvalidUpgradeParams

+ const CodeInvalidVersion

+ const CodeInvalidVote

+ const CodeNotEnoughInitialDeposit

+ const CodeOnlyValidatorVote

+ const CodeSwitchPeriodInProcess

+ const CodeUnknownProposal

+ const DefaultCodespace

+ const DefaultParamspace

+ const DefaultPeriod

+ const MaxDescriptionLength

+ const MaxTitleLength

+ const MetricsSubsystem

+ const ModuleName

+ const ParamDeposit

+ const ParamKeyLabel

+ const ParamTallying

+ const ParamVoting

+ const ProposalIDLabel

+ const QuerierRoute

+ const QueryDeposit

+ const QueryDeposits

+ const QueryParams

+ const QueryProposal

+ const QueryProposals

+ const QueryTally

+ const QueryVote

+ const QueryVotes

+ const RouterKey

+ const StoreKey

+ const TypeMsgDeposit

+ const TypeMsgSubmitProposal

+ const TypeMsgVote

+ const ValidatorLabel

+ var BurnedDepositCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("govBurnedDepositCoins")))

+ var DepositedCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("govDepositedCoins")))

+ var KeyCriticalProposal = []byte("CriticalProposal")

+ var KeyDelimiter = []byte(":")

+ var KeyImportantProposalNum = []byte("ImportantProposalNum")

+ var KeyNextProposalID = []byte("newProposalID")

+ var KeyNormalProposalNum = []byte("NormalProposalNum")

+ var KeySystemHaltHeight = []byte("SystemHaltHeight")

+ var ParamStoreKeyDepositParams = []byte("depositparams")

+ var ParamStoreKeyTallyParams = []byte("tallyparams")

+ var ParamStoreKeyVotingParams = []byte("votingparams")

+ var PrefixActiveProposalQueue = []byte("activeProposalQueue")

+ var PrefixInactiveProposalQueue = []byte("inactiveProposalQueue")

+ var PrefixValidatorSet = []byte("vs")

+ func EndBlocker(ctx sdk.Context, keeper Keeper) sdk.Tags

+ func ErrAddressNotStaked(codespace sdk.CodespaceType, address sdk.AccAddress) sdk.Error

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

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

+ func ErrAlreadyVote(codespace sdk.CodespaceType, address sdk.AccAddress, proposalID uint64) sdk.Error

+ func ErrCodeInvalidSwitchHeight(codespace sdk.CodespaceType, blockHeight uint64, switchHeight uint64) sdk.Error

+ func ErrCodeInvalidVersion(codespace sdk.CodespaceType, version uint64) sdk.Error

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

+ func ErrInvalidDescription(codespace sdk.CodespaceType, errorMsg string) sdk.Error

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

+ func ErrInvalidProposalType(codespace sdk.CodespaceType, proposalType ProposalKind) sdk.Error

+ func ErrInvalidTitle(codespace sdk.CodespaceType, errorMsg string) sdk.Error

+ func ErrInvalidUpgradeThreshold(codespace sdk.CodespaceType, Threshold sdk.Dec) sdk.Error

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

+ func ErrNotEnoughInitialDeposit(codespace sdk.CodespaceType, initialDeposit sdk.Coins, minDeposit sdk.Coins) sdk.Error

+ func ErrNotProfiler(codespace sdk.CodespaceType, profiler sdk.AccAddress) sdk.Error

+ func ErrNotTrustee(codespace sdk.CodespaceType, trustee sdk.AccAddress) sdk.Error

+ func ErrOnlyValidatorVote(codespace sdk.CodespaceType, address sdk.AccAddress) sdk.Error

+ func ErrSwitchPeriodInProcess(codespace sdk.CodespaceType) sdk.Error

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

+ func Execute(ctx sdk.Context, gk Keeper, p ProposalContent) (err error)

+ func InitGenesis(ctx sdk.Context, k Keeper, data GenesisState)

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

+ func KeyDeposit(proposalID uint64, depositorAddr sdk.AccAddress) []byte

+ func KeyDepositsSubspace(proposalID uint64) []byte

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

+ func KeyProposal(proposalID uint64) []byte

+ func KeyValidatorSet(proposalID uint64) []byte

+ func KeyVote(proposalID uint64, voterAddr sdk.AccAddress) []byte

+ func KeyVotesSubspace(proposalID uint64) []byte

+ func NewHandler(keeper Keeper) sdk.Handler

+ func NewQuerier(keeper Keeper) sdk.Querier

+ func ParamKeyTable() params.KeyTable

+ func PrefixActiveProposalQueueTime(endTime time.Time) []byte

+ func PrefixInactiveProposalQueueTime(endTime time.Time) []byte

+ func PrepForZeroHeightGenesis(ctx sdk.Context, k Keeper)

+ func ProposalEqual(proposalA ProposalContent, proposalB ProposalContent) bool

+ func RegisterCodec(cdc *codec.Codec)

+ func SetParameterMetrics(metrics *Metrics, key string, value interface{})

+ func SoftwareUpgradeProposalExecute(ctx sdk.Context, gk Keeper, sp *SoftwareUpgradeProposal) error

+ func SortAddresses(addrs []sdk.AccAddress)

+ func SortByteArrays(src [][]byte) [][]byte

+ func SortValAddresses(addrs []sdk.ValAddress)

+ func ValidateGenesis(data GenesisState) error

+ type BankKeeper interface

+ GetCoins func(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins

+ SendCoins func(ctx sdk.Context, fromAddr sdk.AccAddress, toAddr sdk.AccAddress, amt sdk.Coins) (sdk.Tags, sdk.Error)

+ SetSendEnabled func(ctx sdk.Context, enabled bool)

+ type Deposit struct

+ Amount sdk.Coins

+ Depositor sdk.AccAddress

+ ProposalID uint64

+ func (d Deposit) Empty() bool

+ func (d Deposit) Equals(comp Deposit) bool

+ func (d Deposit) String() string

+ type DepositParams struct

+ MaxDepositPeriod time.Duration

+ MinDeposit sdk.Coins

+ func (dp DepositParams) Equal(dp2 DepositParams) bool

+ func (dp DepositParams) String() string

+ type DepositWithMetadata struct

+ Deposit Deposit

+ ProposalID uint64

+ type Deposits []Deposit

+ func (d Deposits) String() string

+ type GenesisState struct

+ DepositParams DepositParams

+ Deposits []DepositWithMetadata

+ Proposals []ProposalContent

+ StartingProposalID uint64

+ TallyParams TallyParams

+ Votes []VoteWithMetadata

+ VotingParams VotingParams

+ func DefaultGenesisState() GenesisState

+ func ExportGenesis(ctx sdk.Context, k Keeper) GenesisState

+ func NewGenesisState(startingProposalID uint64, dp DepositParams, vp VotingParams, tp TallyParams) GenesisState

+ func (data GenesisState) Equal(data2 GenesisState) bool

+ func (data GenesisState) IsEmpty() bool

+ type Keeper struct

+ func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, paramsKeeper params.Keeper, ...) Keeper

+ func (keeper Keeper) ActiveProposalQueueIterator(ctx sdk.Context, endTime time.Time) sdk.Iterator

+ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress, ...) (sdk.Error, bool)

+ func (keeper Keeper) AddInitialDeposit(ctx sdk.Context, proposal ProposalContent, depositorAddr sdk.AccAddress, ...) (sdk.Error, bool)

+ func (keeper Keeper) AddVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress, ...) sdk.Error

+ func (keeper Keeper) DeleteDeposits(ctx sdk.Context, proposalID uint64)

+ func (keeper Keeper) DeleteProposal(ctx sdk.Context, proposalID uint64)

+ func (keeper Keeper) DeleteValidatorSet(ctx sdk.Context, proposalID uint64)

+ func (keeper Keeper) GetDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress) (Deposit, bool)

+ func (keeper Keeper) GetDepositParams(ctx sdk.Context) DepositParams

+ func (keeper Keeper) GetDeposits(ctx sdk.Context, proposalID uint64) sdk.Iterator

+ func (keeper Keeper) GetLastProposalID(ctx sdk.Context) (proposalID uint64)

+ func (keeper Keeper) GetProposal(ctx sdk.Context, proposalID uint64) (proposal ProposalContent, ok bool)

+ func (keeper Keeper) GetProposalsFiltered(ctx sdk.Context, voterAddr sdk.AccAddress, depositorAddr sdk.AccAddress, ...) []ProposalContent

+ func (keeper Keeper) GetTallyParams(ctx sdk.Context) TallyParams

+ func (keeper Keeper) GetValidatorSet(ctx sdk.Context, proposalID uint64) []sdk.ValAddress

+ func (keeper Keeper) GetVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress) (Vote, bool)

+ func (keeper Keeper) GetVotes(ctx sdk.Context, proposalID uint64) sdk.Iterator

+ func (keeper Keeper) GetVotingParams(ctx sdk.Context) VotingParams

+ func (keeper Keeper) InactiveProposalQueueIterator(ctx sdk.Context, endTime time.Time) sdk.Iterator

+ func (keeper Keeper) InsertActiveProposalQueue(ctx sdk.Context, endTime time.Time, proposalID uint64)

+ func (keeper Keeper) InsertInactiveProposalQueue(ctx sdk.Context, endTime time.Time, proposalID uint64)

+ func (keeper Keeper) NewSoftwareUpgradeProposal(ctx sdk.Context, msg MsgSubmitSoftwareUpgradeProposal) ProposalContent

+ func (keeper Keeper) RefundDeposits(ctx sdk.Context, proposalID uint64)

+ func (keeper Keeper) RemoveFromActiveProposalQueue(ctx sdk.Context, endTime time.Time, proposalID uint64)

+ func (keeper Keeper) RemoveFromInactiveProposalQueue(ctx sdk.Context, endTime time.Time, proposalID uint64)

+ func (keeper Keeper) SetProposal(ctx sdk.Context, proposal ProposalContent)

+ func (keeper Keeper) SetValidatorSet(ctx sdk.Context, proposalID uint64)

+ func (keeper Keeper) SubmitProposal(ctx sdk.Context, content ProposalContent) (proposal ProposalContent, err sdk.Error)

+ type Metrics struct

+ Param metrics.Gauge

+ ProposalStatus metrics.Gauge

+ Vote metrics.Gauge

+ func NopMetrics() *Metrics

+ func PrometheusMetrics(config *cfg.InstrumentationConfig) *Metrics

+ type MsgDeposit struct

+ Amount sdk.Coins

+ Depositor sdk.AccAddress

+ ProposalID uint64

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

+ func (msg MsgDeposit) GetSignBytes() []byte

+ func (msg MsgDeposit) GetSigners() []sdk.AccAddress

+ func (msg MsgDeposit) Route() string

+ func (msg MsgDeposit) String() string

+ func (msg MsgDeposit) Type() string

+ func (msg MsgDeposit) ValidateBasic() sdk.Error

+ type MsgSubmitProposal struct

+ Description string

+ InitialDeposit sdk.Coins

+ ProposalType ProposalKind

+ Proposer sdk.AccAddress

+ Title string

+ func NewMsgSubmitProposal(title, description string, proposalType ProposalKind, proposer sdk.AccAddress, ...) MsgSubmitProposal

+ func (msg MsgSubmitProposal) GetSignBytes() []byte

+ func (msg MsgSubmitProposal) GetSigners() []sdk.AccAddress

+ func (msg MsgSubmitProposal) Route() string

+ func (msg MsgSubmitProposal) String() string

+ func (msg MsgSubmitProposal) Type() string

+ func (msg MsgSubmitProposal) ValidateBasic() sdk.Error

+ type MsgSubmitSoftwareUpgradeProposal struct

+ Software string

+ SwitchHeight uint64

+ Threshold sdk.Dec

+ Version uint64

+ func NewMsgSubmitSoftwareUpgradeProposal(msgSubmitProposal MsgSubmitProposal, version uint64, software string, ...) MsgSubmitSoftwareUpgradeProposal

+ func (msg MsgSubmitSoftwareUpgradeProposal) GetSignBytes() []byte

+ func (msg MsgSubmitSoftwareUpgradeProposal) ValidateBasic() sdk.Error

+ type MsgVote struct

+ Option VoteOption

+ ProposalID uint64

+ Voter sdk.AccAddress

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

+ func (msg MsgVote) GetSignBytes() []byte

+ func (msg MsgVote) GetSigners() []sdk.AccAddress

+ func (msg MsgVote) Route() string

+ func (msg MsgVote) String() string

+ func (msg MsgVote) Type() string

+ func (msg MsgVote) ValidateBasic() sdk.Error

+ type Params struct

+ DepositParams DepositParams

+ TallyParams TallyParams

+ VotingParams VotingParams

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

+ func (gp Params) String() string

+ type Proposal struct

+ DepositEndTime time.Time

+ Description string

+ FinalTallyResult TallyResult

+ ProposalID uint64

+ ProposalType ProposalKind

+ Status ProposalStatus

+ SubmitTime time.Time

+ Title string

+ TotalDeposit sdk.Coins

+ VotingEndTime time.Time

+ VotingStartTime time.Time

+ func (p Proposal) String() string

+ func (tp *Proposal) SetDepositEndTime(depositEndTime time.Time)

+ func (tp *Proposal) SetDescription(description string)

+ func (tp *Proposal) SetProposalID(proposalID uint64)

+ func (tp *Proposal) SetProposalType(proposalType ProposalKind)

+ func (tp *Proposal) SetProtocolDefinition(sdk.ProtocolDefinition)

+ func (tp *Proposal) SetStatus(status ProposalStatus)

+ func (tp *Proposal) SetSubmitTime(submitTime time.Time)

+ func (tp *Proposal) SetTallyResult(tallyResult TallyResult)

+ func (tp *Proposal) SetTitle(title string)

+ func (tp *Proposal) SetTotalDeposit(totalDeposit sdk.Coins)

+ func (tp *Proposal) SetVotingEndTime(votingEndTime time.Time)

+ func (tp *Proposal) SetVotingStartTime(votingStartTime time.Time)

+ func (tp Proposal) GetDepositEndTime() time.Time

+ func (tp Proposal) GetDescription() string

+ func (tp Proposal) GetProposalID() uint64

+ func (tp Proposal) GetProposalType() ProposalKind

+ func (tp Proposal) GetProtocolDefinition() sdk.ProtocolDefinition

+ func (tp Proposal) GetStatus() ProposalStatus

+ func (tp Proposal) GetSubmitTime() time.Time

+ func (tp Proposal) GetTallyResult() TallyResult

+ func (tp Proposal) GetTitle() string

+ func (tp Proposal) GetTotalDeposit() sdk.Coins

+ func (tp Proposal) GetVotingEndTime() time.Time

+ func (tp Proposal) GetVotingStartTime() time.Time

+ type ProposalContent interface

+ GetDepositEndTime func() time.Time

+ GetDescription func() string

+ GetProposalID func() uint64

+ GetProposalType func() ProposalKind

+ GetProtocolDefinition func() sdk.ProtocolDefinition

+ GetStatus func() ProposalStatus

+ GetSubmitTime func() time.Time

+ GetTallyResult func() TallyResult

+ GetTitle func() string

+ GetTotalDeposit func() sdk.Coins

+ GetVotingEndTime func() time.Time

+ GetVotingStartTime func() time.Time

+ SetDepositEndTime func(time.Time)

+ SetDescription func(string)

+ SetProposalID func(uint64)

+ SetProposalType func(ProposalKind)

+ SetProtocolDefinition func(sdk.ProtocolDefinition)

+ SetStatus func(ProposalStatus)

+ SetSubmitTime func(time.Time)

+ SetTallyResult func(TallyResult)

+ SetTitle func(string)

+ SetTotalDeposit func(sdk.Coins)

+ SetVotingEndTime func(time.Time)

+ SetVotingStartTime func(time.Time)

+ String func() string

+ type ProposalKind byte

+ const ProposalTypeNil

+ const ProposalTypeParameterChange

+ const ProposalTypeSoftwareUpgrade

+ const ProposalTypeText

+ func ProposalTypeFromString(str string) (ProposalKind, error)

+ func (pt *ProposalKind) Unmarshal(data []byte) error

+ func (pt *ProposalKind) UnmarshalJSON(data []byte) error

+ func (pt ProposalKind) Format(s fmt.State, verb rune)

+ func (pt ProposalKind) Marshal() ([]byte, error)

+ func (pt ProposalKind) MarshalJSON() ([]byte, error)

+ func (pt ProposalKind) String() string

+ type ProposalQueue []uint64

+ type ProposalResult string

+ const PASS

+ const REJECT

+ const REJECTVETO

+ type ProposalStatus byte

+ const StatusDepositPeriod

+ const StatusNil

+ const StatusPassed

+ const StatusRejected

+ const StatusVotingPeriod

+ func ProposalStatusFromString(str string) (ProposalStatus, error)

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

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

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

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

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

+ func (status ProposalStatus) String() string

+ type Proposals []ProposalContent

+ func (p Proposals) String() string

+ type QueryDepositParams struct

+ Depositor sdk.AccAddress

+ ProposalID uint64

+ func NewQueryDepositParams(proposalID uint64, depositor sdk.AccAddress) QueryDepositParams

+ type QueryProposalParams struct

+ ProposalID uint64

+ func NewQueryProposalParams(proposalID uint64) QueryProposalParams

+ type QueryProposalsParams struct

+ Depositor sdk.AccAddress

+ Limit uint64

+ ProposalStatus ProposalStatus

+ Voter sdk.AccAddress

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

+ type QueryVoteParams struct

+ ProposalID uint64

+ Voter sdk.AccAddress

+ func NewQueryVoteParams(proposalID uint64, voter sdk.AccAddress) QueryVoteParams

+ type SoftwareUpgradeProposal struct

+ ProtocolDefinition sdk.ProtocolDefinition

+ func (sp *SoftwareUpgradeProposal) SetProtocolDefinition(upgrade sdk.ProtocolDefinition)

+ func (sp SoftwareUpgradeProposal) GetProtocolDefinition() sdk.ProtocolDefinition

+ func (sp SoftwareUpgradeProposal) ProposalType() sdk.ProtocolDefinition

+ type TallyParams struct

+ Penalty sdk.Dec

+ Quorum sdk.Dec

+ Threshold sdk.Dec

+ Veto sdk.Dec

+ func (tp TallyParams) String() string

+ type TallyResult struct

+ Abstain sdk.Int

+ No sdk.Int

+ NoWithVeto sdk.Int

+ Yes sdk.Int

+ func EmptyTallyResult() TallyResult

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

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

+ func (tr TallyResult) Equals(comp TallyResult) bool

+ func (tr TallyResult) String() string

+ type TextProposal struct

+ Description string

+ Title string

+ func NewTextProposal(title, description string) *TextProposal

+ func (tp TextProposal) GetDescription() string

+ func (tp TextProposal) GetTitle() string

+ func (tp TextProposal) ProposalType() ProposalKind

+ type Vote struct

+ Option VoteOption

+ ProposalID uint64

+ Voter sdk.AccAddress

+ func (v Vote) Empty() bool

+ func (v Vote) Equals(comp Vote) bool

+ func (v Vote) String() string

+ type VoteOption byte

+ const OptionAbstain

+ const OptionEmpty

+ const OptionNo

+ const OptionNoWithVeto

+ const OptionYes

+ func VoteOptionFromString(str string) (VoteOption, error)

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

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

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

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

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

+ func (vo VoteOption) String() string

+ type VoteWithMetadata struct

+ ProposalID uint64

+ Vote Vote

+ type Votes []Vote

+ func (v Votes) String() string

+ type VotingParams struct

+ VotingPeriod time.Duration

+ func (vp VotingParams) String() string