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

# Functions

DefaultGenesisState defines the default governance genesis state.
DefaultParams returns the default governance params.
EmptyTallyResult returns an empty TallyResult.
LegacyContentFromMessage extracts the legacy Content interface from a MsgExecLegacyContent.
NewDeposit creates a new Deposit instance nolint:interfacer.
Deprecated: NewDepositParams creates a new DepositParams object.
NewGenesisState creates a new genesis state for the governance module.
NewLegacyContent creates a new MsgExecLegacyContent from a legacy Content interface.
No description provided by the author
NewMsgDeposit creates a new MsgDeposit instance nolint:interfacer.
NewMsgExecLegacyContent creates a new MsgExecLegacyContent instance nolint:interfacer.
No description provided by the author
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.
NewNonSplitVoteOption creates a single option vote with weight 1.
NewParams creates a new Params instance with given values.
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.
No description provided by the author
Deprecated: NewTallyParams creates a new TallyParams object.
NewTallyResult creates a new TallyResult instance.
NewTallyResultFromMap creates a new TallyResult instance from a Option -> Dec map.
NewVote creates a new Vote instance nolint:interfacer.
Deprecated: NewVotingParams creates a new VotingParams object.
No description provided by the author
Deprecated: ParamKeyTable - Key declaration for parameters.
ProposalStatusFromString turns a string into a ProposalStatus.
RegisterInterfaces registers the interfaces types with the Interface Registry.
RegisterLegacyAminoCodec registers all the necessary types and interfaces for the governance module.
No description provided by the author
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
ValidateGenesis checks if gov genesis state is valid ranges It checks if params are in valid ranges It also makes sure that the provided proposal IDs are unique and that there are no duplicate deposit or vote records and no vote or deposits for non-existent proposals.
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.
VoteOptionFromString returns a VoteOption from a string.
WeightedVoteOptionsFromString returns weighted vote options from string.

# Constants

14 days.
DefaultStartingProposalID is 1.
21 days.
21 days.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
query endpoints supported by the governance Querier.
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_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_UNSPECIFIED defines the default proposal status.
PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
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.
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
VOTE_OPTION_ABSTAIN defines an abstain vote option.
VOTE_OPTION_NO defines a no vote option.
VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
VOTE_OPTION_YES defines a yes vote option.

# Variables

set to false to replicate behavior of when this change was made (0.47).
set to false to replicate behavior of when this change was made (0.47).
Default governance params.
Default governance params.
Default governance params.
Default governance params.
disabled by default (DefaultQuorumCheckCount must be set to a non-zero value to enable).
NOTE: backport from v50.
Default governance params.
Default governance params.
Default governance params.
disabled by default (0 means no check).
disabled by default (DefaultQuorumCheckCount must be set to a non-zero value to enable).
Default governance params.
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
Parameter store key.
Parameter store key.
Parameter store key.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# 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.
MsgExecLegacyContent is used to wrap the legacy content field into a message.
MsgExecLegacyContentResponse defines the Msg/ExecLegacyContent response type.
MsgConstitutionAmendment is the Msg/ProposeConstitutionAmendment request type.
MsgProposeConstitutionAmendmentResponse defines the response structure for executing a MsgProposeConstitutionAmendment message.
MsgLaw is the Msg/ProposeLaw request type.
MsgProposeLawResponse defines the response structure for executing a MsgProposeLaw message.
MsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary proposal Content.
MsgSubmitProposalResponse defines the Msg/SubmitProposal response type.
MsgUpdateParams is the Msg/UpdateParams request type.
MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.
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 defines the parameters for the x/gov module.
Proposal defines the core field members of a governance proposal.
QueryConstitutionRequest is the request type for the Query/Constitution RPC method.
QueryConstitutionResponse is the response type for the Query/Constitution RPC method.
QueryDepositParams is used to 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 is used 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 is used to 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 is used to query '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 is used to 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.
QuorumCheckQueueEntry defines a quorum check queue entry.
TallyParams defines the params for tallying votes on governance proposals.
TallyResult defines a standard tally for a governance proposal.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
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

MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.

# Type aliases

Deposits is a collection of Deposit objects.
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.