package
1.0.4
Repository: https://github.com/atomone-hub/govgen.git
Documentation: pkg.go.dev

# Functions

ActiveProposalByTimeKey gets the active proposal queue key by endTime.
ActiveProposalQueueKey returns the key for a proposalID in the activeProposalQueue.
ContentFromProposalType returns a Content object based on the proposal type.
DefaultDepositParams default parameters for deposits.
DefaultGenesisState defines the default governance genesis state.
DefaultParams default governance params.
DefaultTallyParams default parameters for tallying.
DefaultVotingParams default parameters for voting.
DepositKey key of a specific deposit from the store.
DepositsKey gets the first part of the deposits key based on the proposalID.
EmptyTallyResult returns an empty TallyResult.
GetProposalIDBytes returns the byte representation of the proposalID.
GetProposalIDFromBytes returns proposalID in uint64 format from a byte array.
InactiveProposalByTimeKey gets the inactive proposal queue key by endTime.
InactiveProposalQueueKey returns the key for a proposalID in the inactiveProposalQueue.
IsValidProposalType returns a boolean determining if the proposal type is valid.
NewDeposit creates a new Deposit instance nolint:interfacer.
NewDepositParams creates a new DepositParams object.
NewGenesisState creates a new genesis state for the governance module.
No description provided by the author
NewMsgDeposit creates a new MsgDeposit instance nolint:interfacer.
NewMsgSubmitProposal creates a new MsgSubmitProposal.
NewMsgVote creates a message to cast a vote on an active proposal nolint:interfacer.
NewMsgVoteWeighted creates a message to cast a vote on an active proposal nolint:interfacer.
No description provided by the author
NewNonSplitVoteOption creates a single option vote with weight 1.
NewParams creates a new gov Params instance.
NewProposal creates a new Proposal instance.
No description provided by the author
NewQueryDepositParams creates a new instance of QueryDepositParams.
NewQueryProposalParams creates a new instance of QueryProposalParams.
NewQueryProposalsParams creates a new instance of QueryProposalsParams.
NewQueryProposalVotesParams creates new instance of the QueryProposalVotesParams.
NewQueryVoteParams creates a new instance of QueryVoteParams.
NewRouter creates a new Router interface instance.
NewTallyParams creates a new TallyParams object.
NewTallyResult creates a new TallyResult instance.
NewTallyResultFromMap creates a new TallyResult instance from a Option -> Dec map.
NewTextProposal creates a text proposal Content.
NewValidatorGovInfo creates a ValidatorGovInfo instance.
NewVote creates a new Vote instance nolint:interfacer.
NewVotingParams creates a new VotingParams object.
ParamKeyTable - Key declaration for parameters.
ProposalHandler implements the Handler interface for governance module-based proposals (ie.
ProposalKey gets a specific proposal from the store.
ProposalStatusFromString turns a string into a ProposalStatus.
No description provided by the author
RegisterLegacyAminoCodec registers all the necessary types and interfaces for the governance module.
No description provided by the author
RegisterProposalType registers a proposal type.
RegisterProposalTypeCodec registers an external proposal content type defined in another module for the internal ModuleCdc.
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
SplitActiveProposalQueueKey split the active proposal key and returns the proposal id and endTime.
SplitInactiveProposalQueueKey split the inactive proposal key and returns the proposal id and endTime.
SplitKeyDeposit split the deposits key and returns the proposal id and depositor address.
SplitKeyVote split the votes key and returns the proposal id and voter address.
SplitProposalKey split the proposal key and returns the proposal id.
ValidateAbstract validates a proposal's abstract contents returning an error if invalid.
ValidateGenesis checks if parameters are within valid ranges.
ValidProposalStatus returns true if the proposal status is valid and false otherwise.
ValidVoteOption returns true if the vote option is valid and false otherwise.
ValidWeightedVoteOption returns true if the sub vote is valid and false otherwise.
VoteKey key of a specific vote from the store.
VoteOptionFromString returns a VoteOption from a string.
VotesKey gets the first part of the votes key based on the proposalID.
WeightedVoteOptionsFromString returns weighted vote options from string.
WrapHandler converts a Cosmos SDK gov Handler to GovGen gov Handler.

# Constants

Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
didn't meet min deposit.
error on proposal handler.
met vote quorum.
didn't meet vote quorum.
2 days.
2 weeks.
4 weeks.
1 year.
DefaultStartingProposalID is 1.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Constants pertaining to a Content object.
Constants pertaining to a Content object.
ModuleName is the name of the module.
VOTE_OPTION_ABSTAIN defines an abstain vote option.
VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
VOTE_OPTION_NO defines a no vote option.
VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
VOTE_OPTION_YES defines a yes vote option.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
Proposal types.
QuerierRoute is the querier route for gov.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
RouterKey is the message route for gov.
PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
StoreKey is the store key string for gov.
Governance message types and routes.
Governance message types and routes.
Governance message types and routes.
Governance message types and routes.

# Variables

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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.
Default governance params.
Default governance params.
Default governance params.
Default governance params.
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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.
x/gov module sentinel errors.
x/gov module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/gov module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/gov module sentinel errors.
x/gov module sentinel errors.
x/gov module sentinel errors.
x/gov module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/gov module sentinel errors.
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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.
ModuleCdc references the global x/gov module codec.
Parameter store key.
Parameter store key.
Parameter store key.
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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.
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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter.

# Structs

Deposit defines an amount deposited by an account address to an active proposal.
DepositParams defines the params for deposits on governance proposals.
GenesisState defines the gov module's genesis state.
MsgDeposit defines a message to submit a deposit to an existing proposal.
MsgDepositResponse defines the Msg/Deposit response type.
MsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary proposal Content.
MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.
MsgVote defines a message to cast a vote.
MsgVoteResponse defines the Msg/Vote response type.
MsgVoteWeighted defines a message to cast a vote.
MsgVoteWeightedResponse defines the Msg/VoteWeighted response type.
Params returns all of the governance params.
Proposal defines the core field members of a governance proposal.
QueryDepositParams params for query 'custom/gov/deposit'.
QueryDepositRequest is the request type for the Query/Deposit RPC method.
QueryDepositResponse is the response type for the Query/Deposit RPC method.
QueryDepositsRequest is the request type for the Query/Deposits RPC method.
QueryDepositsResponse is the response type for the Query/Deposits RPC method.
QueryParamsRequest is the request type for the Query/Params RPC method.
QueryParamsResponse is the response type for the Query/Params RPC method.
QueryProposalParams Params for queries: - 'custom/gov/proposal' - 'custom/gov/deposits' - 'custom/gov/tally'.
QueryProposalRequest is the request type for the Query/Proposal RPC method.
QueryProposalResponse is the response type for the Query/Proposal RPC method.
QueryProposalsParams Params for query 'custom/gov/proposals'.
QueryProposalsRequest is the request type for the Query/Proposals RPC method.
QueryProposalsResponse is the response type for the Query/Proposals RPC method.
QueryProposalVotesParams used for queries to 'custom/gov/votes'.
QueryTallyResultRequest is the request type for the Query/Tally RPC method.
QueryTallyResultResponse is the response type for the Query/Tally RPC method.
QueryVoteParams Params for query 'custom/gov/vote'.
QueryVoteRequest is the request type for the Query/Vote RPC method.
QueryVoteResponse is the response type for the Query/Vote RPC method.
QueryVotesRequest is the request type for the Query/Votes RPC method.
QueryVotesResponse is the response type for the Query/Votes RPC method.
TallyParams defines the params for tallying votes on governance proposals.
TallyResult defines a standard tally for a governance proposal.
TextProposal defines a standard text proposal whose changes need to be manually updated in case of approval.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
ValidatorGovInfo used for tallying.
Vote defines a vote on a governance proposal.
VotingParams defines the params for voting on governance proposals.
WeightedVoteOption defines a unit of vote for vote split.

# Interfaces

AccountKeeper defines the expected account keeper (noalias).
BankKeeper defines the expected interface needed to retrieve account balances.
Content defines an interface that a proposal must implement.
GovHooks event hooks for governance proposal object (noalias).
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
ParamSubspace defines the expected Subspace interface for parameters (noalias).
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
Router implements a governance Handler router.
StakingKeeper expected staking keeper (Validator and Delegator sets) (noalias).

# Type aliases

Deposits is a collection of Deposit objects.
Handler defines a function that handles a proposal after it has passed the governance process.
combine multiple governance hooks, all hook functions are run in array sequence.
No description provided by the author
Proposals is an array of proposal.
ProposalStatus enumerates the valid statuses of a proposal.
VoteOption enumerates the valid vote options for a given governance proposal.
Votes is a collection of Vote objects.
WeightedVoteOptions describes array of WeightedVoteOptions.