gov

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2021 License: Apache-2.0 Imports: 32 Imported by: 6

Documentation

Overview

nolint DONTCOVER

Index

Constants

View Source 
const (
	MaxDescriptionLength  = types.MaxDescriptionLength
	MaxTitleLength        = types.MaxTitleLength
	DefaultPeriod         = types.DefaultPeriod
	ModuleName            = types.ModuleName
	StoreKey              = types.StoreKey
	RouterKey             = types.RouterKey
	QuerierRoute          = types.QuerierRoute
	DefaultParamspace     = types.DefaultParamspace
	TypeMsgDeposit        = types.TypeMsgDeposit
	TypeMsgVote           = types.TypeMsgVote
	TypeMsgSubmitProposal = types.TypeMsgSubmitProposal
	StatusNil             = types.StatusNil
	StatusDepositPeriod   = types.StatusDepositPeriod
	StatusVotingPeriod    = types.StatusVotingPeriod
	StatusPassed          = types.StatusPassed
	StatusRejected        = types.StatusRejected
	StatusFailed          = types.StatusFailed
	ProposalTypeText      = types.ProposalTypeText
	QueryParams           = types.QueryParams
	QueryProposals        = types.QueryProposals
	QueryProposal         = types.QueryProposal
	QueryDeposits         = types.QueryDeposits
	QueryDeposit          = types.QueryDeposit
	QueryVotes            = types.QueryVotes
	QueryVote             = types.QueryVote
	QueryTally            = types.QueryTally
	ParamDeposit          = types.ParamDeposit
	ParamVoting           = types.ParamVoting
	ParamTallying         = types.ParamTallying
	OptionEmpty           = types.OptionEmpty
	OptionYes             = types.OptionYes
	OptionAbstain         = types.OptionAbstain
	OptionNo              = types.OptionNo
	OptionNoWithVeto      = types.OptionNoWithVeto
)

Variables

View Source 
var (
	// functions aliases
	RegisterInvariants            = keeper.RegisterInvariants
	AllInvariants                 = keeper.AllInvariants
	ModuleAccountInvariant        = keeper.ModuleAccountInvariant
	NewKeeper                     = keeper.NewKeeper
	NewQuerier                    = keeper.NewQuerier
	RegisterCodec                 = types.RegisterCodec
	RegisterProposalTypeCodec     = types.RegisterProposalTypeCodec
	ValidateAbstract              = types.ValidateAbstract
	NewDeposit                    = types.NewDeposit
	ErrUnknownProposal            = types.ErrUnknownProposal
	ErrInactiveProposal           = types.ErrInactiveProposal
	ErrAlreadyActiveProposal      = types.ErrAlreadyActiveProposal
	ErrInvalidProposalContent     = types.ErrInvalidProposalContent
	ErrInvalidProposalType        = types.ErrInvalidProposalType
	ErrInvalidVote                = types.ErrInvalidVote
	ErrInvalidGenesis             = types.ErrInvalidGenesis
	ErrNoProposalHandlerExists    = types.ErrNoProposalHandlerExists
	NewGenesisState               = types.NewGenesisState
	DefaultGenesisState           = types.DefaultGenesisState
	ValidateGenesis               = types.ValidateGenesis
	GetProposalIDBytes            = types.GetProposalIDBytes
	GetProposalIDFromBytes        = types.GetProposalIDFromBytes
	ProposalKey                   = types.ProposalKey
	ActiveProposalByTimeKey       = types.ActiveProposalByTimeKey
	ActiveProposalQueueKey        = types.ActiveProposalQueueKey
	InactiveProposalByTimeKey     = types.InactiveProposalByTimeKey
	InactiveProposalQueueKey      = types.InactiveProposalQueueKey
	DepositsKey                   = types.DepositsKey
	DepositKey                    = types.DepositKey
	VotesKey                      = types.VotesKey
	VoteKey                       = types.VoteKey
	SplitProposalKey              = types.SplitProposalKey
	SplitActiveProposalQueueKey   = types.SplitActiveProposalQueueKey
	SplitInactiveProposalQueueKey = types.SplitInactiveProposalQueueKey
	SplitKeyDeposit               = types.SplitKeyDeposit
	SplitKeyVote                  = types.SplitKeyVote
	NewMsgSubmitProposal          = types.NewMsgSubmitProposal
	NewMsgDeposit                 = types.NewMsgDeposit
	NewMsgVote                    = types.NewMsgVote
	ParamKeyTable                 = types.ParamKeyTable
	NewDepositParams              = types.NewDepositParams
	NewTallyParams                = types.NewTallyParams
	NewVotingParams               = types.NewVotingParams
	NewParams                     = types.NewParams
	NewProposal                   = types.NewProposal
	NewRouter                     = types.NewRouter
	ProposalStatusFromString      = types.ProposalStatusFromString
	ValidProposalStatus           = types.ValidProposalStatus
	NewTextProposal               = types.NewTextProposal
	RegisterProposalType          = types.RegisterProposalType
	ContentFromProposalType       = types.ContentFromProposalType
	IsValidProposalType           = types.IsValidProposalType
	ProposalHandler               = types.ProposalHandler
	NewQueryProposalParams        = types.NewQueryProposalParams
	NewQueryDepositParams         = types.NewQueryDepositParams
	NewQueryVoteParams            = types.NewQueryVoteParams
	NewQueryProposalsParams       = types.NewQueryProposalsParams
	NewValidatorGovInfo           = types.NewValidatorGovInfo
	NewTallyResult                = types.NewTallyResult
	NewTallyResultFromMap         = types.NewTallyResultFromMap
	EmptyTallyResult              = types.EmptyTallyResult
	NewVote                       = types.NewVote
	VoteOptionFromString          = types.VoteOptionFromString
	ValidVoteOption               = types.ValidVoteOption

	// variable aliases
	ModuleCdc                   = types.ModuleCdc
	ProposalsKeyPrefix          = types.ProposalsKeyPrefix
	ActiveProposalQueuePrefix   = types.ActiveProposalQueuePrefix
	InactiveProposalQueuePrefix = types.InactiveProposalQueuePrefix
	ProposalIDKey               = types.ProposalIDKey
	DepositsKeyPrefix           = types.DepositsKeyPrefix
	VotesKeyPrefix              = types.VotesKeyPrefix
	ParamStoreKeyDepositParams  = types.ParamStoreKeyDepositParams
	ParamStoreKeyVotingParams   = types.ParamStoreKeyVotingParams
	ParamStoreKeyTallyParams    = types.ParamStoreKeyTallyParams
)

Functions

func EndBlocker 

func EndBlocker(ctx sdk.Context, keeper Keeper)

EndBlocker called every block, process inflation, update validator set.

func InitGenesis 

func InitGenesis(ctx sdk.Context, k Keeper, supplyKeeper types.SupplyKeeper, data GenesisState)

InitGenesis - store genesis parameters

func NewHandler 

func NewHandler(keeper Keeper) sdk.Handler

NewHandler creates an sdk.Handler for all the gov type messages

func SortAddresses 

func SortAddresses(addrs []sdk.AccAddress)

SortAddresses - Sorts Addresses

func SortByteArrays 

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

SortByteArrays - sorts the provided byte array

Types

type AppModule 

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule implements an application module for the gov module.

func NewAppModule 

func NewAppModule(keeper Keeper, accountKeeper types.AccountKeeper, supplyKeeper types.SupplyKeeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock 

func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)

BeginBlock performs a no-op.

func (AppModule) EndBlock 

func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate

EndBlock returns the end blocker for the gov module. It returns no validator updates.

func (AppModule) ExportGenesis 

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

ExportGenesis returns the exported genesis state as raw bytes for the gov module.

func (AppModule) GenerateGenesisState 

func (AppModule) GenerateGenesisState(simState *module.SimulationState)

GenerateGenesisState creates a randomized GenState of the gov module.

func (AppModule) InitGenesis 

func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

InitGenesis performs genesis initialization for the gov module. It returns no validator updates.

func (AppModule) Name 

func (AppModule) Name() string

Name returns the gov module's name.

func (AppModule) NewHandler 

func (am AppModule) NewHandler() sdk.Handler

NewHandler returns an sdk.Handler for the gov module.

func (AppModule) NewQuerierHandler 

func (am AppModule) NewQuerierHandler() sdk.Querier

NewQuerierHandler returns no sdk.Querier.

func (AppModule) ProposalContents 

func (AppModule) ProposalContents(_ module.SimulationState) []sim.WeightedProposalContent

ProposalContents returns all the gov content functions used to simulate governance proposals.

func (AppModule) QuerierRoute 

func (AppModule) QuerierRoute() string

QuerierRoute returns the gov module's querier route name.

func (AppModule) RandomizedParams 

func (AppModule) RandomizedParams(r *rand.Rand) []sim.ParamChange

RandomizedParams creates randomized gov param changes for the simulator.

func (AppModule) RegisterInvariants 

func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)

RegisterInvariants registers module invariants

func (AppModule) RegisterStoreDecoder 

func (AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry)

RegisterStoreDecoder registers a decoder for gov module's types

func (AppModule) Route 

func (AppModule) Route() string

Route returns the message routing key for the gov module.

func (AppModule) WeightedOperations 

func (am AppModule) WeightedOperations(simState module.SimulationState) []sim.WeightedOperation

WeightedOperations returns the all the gov module operations with their respective weights.

type AppModuleBasic 

type AppModuleBasic struct {
	// contains filtered or unexported fields
}

AppModuleBasic defines the basic application module used by the gov module.

func NewAppModuleBasic 

func NewAppModuleBasic(proposalHandlers ...client.ProposalHandler) AppModuleBasic

NewAppModuleBasic creates a new AppModuleBasic object

func (AppModuleBasic) DefaultGenesis 

func (AppModuleBasic) DefaultGenesis() json.RawMessage

DefaultGenesis returns default genesis state as raw bytes for the gov module.

func (AppModuleBasic) GetQueryCmd 

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

GetQueryCmd returns the root query command for the gov module.

func (AppModuleBasic) GetTxCmd 

func (a AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

GetTxCmd returns the root tx command for the gov module.

func (AppModuleBasic) Name 

func (AppModuleBasic) Name() string

Name returns the gov module's name.

func (AppModuleBasic) RegisterCodec 

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

RegisterCodec registers the gov module's types for the given codec.

func (AppModuleBasic) RegisterRESTRoutes 

func (a AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

RegisterRESTRoutes registers the REST routes for the gov module.

func (AppModuleBasic) ValidateGenesis 

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the gov module.

type Content 

type Content = types.Content

type Deposit 

type Deposit = types.Deposit

type DepositParams 

type DepositParams = types.DepositParams

type Deposits 

type Deposits = types.Deposits

type GenesisState 

type GenesisState = types.GenesisState

func ExportGenesis 

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

ExportGenesis - output genesis parameters

type Handler 

type Handler = types.Handler

type Keeper 

type Keeper = keeper.Keeper

type MsgDeposit 

type MsgDeposit = types.MsgDeposit

type MsgSubmitProposal 

type MsgSubmitProposal = types.MsgSubmitProposal

type MsgVote 

type MsgVote = types.MsgVote

type Params 

type Params = types.Params

type Proposal 

type Proposal = types.Proposal

type ProposalQueue 

type ProposalQueue = types.ProposalQueue

type ProposalStatus 

type ProposalStatus = types.ProposalStatus

type Proposals 

type Proposals = types.Proposals

type QueryDepositParams 

type QueryDepositParams = types.QueryDepositParams

type QueryProposalParams 

type QueryProposalParams = types.QueryProposalParams

type QueryProposalsParams 

type QueryProposalsParams = types.QueryProposalsParams

type QueryVoteParams 

type QueryVoteParams = types.QueryVoteParams

type TallyParams 

type TallyParams = types.TallyParams

type TallyResult 

type TallyResult = types.TallyResult

type TextProposal 

type TextProposal = types.TextProposal

type ValidatorGovInfo 

type ValidatorGovInfo = types.ValidatorGovInfo

type Vote 

type Vote = types.Vote

type VoteOption 

type VoteOption = types.VoteOption

type Votes 

type Votes = types.Votes

type VotingParams 

type VotingParams = types.VotingParams

Source Files

View all Source files

Directories

Path Synopsis
cli
rest
utils
nolint
 nolint
legacy
v0_34
DONTCOVER nolint
 DONTCOVER nolint
v0_36
DONTCOVER nolint
 DONTCOVER nolint

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.