package
1.0.15
Repository: https://github.com/netcloth/netcloth-chain.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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
NewDepositParams creates a new DepositParams object.
NewGenesisState creates a new genesis state for the governance module.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
creates a new instance of QueryDepositParams.
creates a new instance of QueryProposalParams.
creates a new instance of QueryProposalsParams.
creates a new instance of QueryVoteParams.
NewRouter creates a new Router interface instance.
No description provided by the author
NewTallyParams creates a new TallyParams object.
No description provided by the author
No description provided by the author
No description provided by the author
NewVote creates a new Vote instance.
NewVotingParams creates a new VotingParams object.
Key declaration for parameters.
ProposalHandler implements the Handler interface for governance module-based proposals (ie.
ProposalKey gets a specific proposal from the store.
ProposalStatusToString turns a string into a ProposalStatus.
RegisterCodec registers all the necessary types and interfaces for governance.
RegisterProposalType registers a proposal type.
RegisterProposalTypeCodec registers an external proposal content type defined in another module for the internal ModuleCdc.
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.
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.

# Constants

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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultParamspace default name for parameter store.
2 days.
No description provided by the author
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 options.
Vote options.
Vote options.
Vote options.
Vote options.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
Proposal types.
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.
nolint.
nolint.
nolint.
nolint.
nolint.
nolint.
StoreKey is the store key string for gov.
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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddr_Bytes>: Voter.
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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><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><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddr_Bytes>: Voter.

# Structs

Deposit.
Param around deposits for governance.
GenesisState - all staking state that must be provided at genesis.
MsgDeposit.
MsgSubmitProposal.
MsgVote.
Params returns all of the governance params.
Proposal defines a struct used by the governance module to allow for voting on network changes.
Params for query 'custom/gov/deposit'.
Params for queries: - 'custom/gov/proposal' - 'custom/gov/deposits' - 'custom/gov/tally' - 'custom/gov/votes'.
Params for query 'custom/gov/proposals'.
Params for query 'custom/gov/vote'.
Software Upgrade Proposals TODO: We have to add fields for SUP specific arguments e.g.
Param around Tallying votes in governance.
Tally Results.
Text Proposal.
Vote.
Param around Voting in governance.

# Interfaces

AccountKeeper defines the expected account keeper (noalias).
Content defines an interface that a proposal must implement.
ParamSubspace defines the expected Subspace interface for parameters (noalias).
Router implements a governance Handler router.
StakingKeeper expected staking keeper (Validator and Delegator sets).
SupplyKeeper defines the expected supply keeper for module accounts (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.
No description provided by the author
Proposals is an array of proposal.
No description provided by the author
VoteOption defines a vote option.
Votes is a collection of Vote objects.