Categorygithub.com/atomone-hub/atomonexgovtypes
package
1.0.0
Repository: https://github.com/atomone-hub/atomone.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
12
Files
522 SLOC

# Packages

Package v1 is a reverse proxy.
Package v1beta1 is a reverse proxy.

# Functions

ActiveProposalByTimeKey gets the active proposal queue key by endTime.
ActiveProposalQueueKey returns the key for a proposalID in the activeProposalQueue.
ApplyUnifiedDiff applies a unified diff patch to the src string and returns the result.
DefaultConfig returns the default config for gov.
DepositKey key of a specific deposit from the store.
DepositsKey gets the first part of the deposits key based on the proposalID.
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.
No description provided by the author
ParseUnifiedDiff parses the unified diff string into hunks with validation.
ProposalKey gets a specific proposal from the store.
QuorumCheckByTimeKey gets the quorum check queue key by endTime.
QuorumCheckQueueKey returns the key for a proposalID in the quorumCheckQueue.
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.
SplitQuorumQueueKey split the quorum queue key and returns the proposal id and endTime.
VoteKey key of a specific vote from the store.
VotesKey gets the first part of the votes key based on the proposalID.
VotingPeriodProposalKey gets if a proposal is in voting period.

# Constants

Governance module event types.
Governance module event types.
Msg type_urls in the proposal.
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.
skipped quorum check.
met quorum.
didn't meet quorum.
didn't meet vote quorum.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
Governance module event types.
ModuleName is the name of the module.
RouterKey is the message route for gov.
StoreKey is the store key string for gov.

# 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: Params.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
nolint:staticcheck.
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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: Params.
KeyConstitution is the key string used to store the chain's constitution.
ParamsKey is the key to query all gov 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: 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 - 0x04<proposalID_Bytes>: []byte{0x01} if proposalID is in the voting period - 0x10<proposalID_Bytes><depositorAddrLen (1 Byte)><depositorAddr_Bytes>: Deposit - 0x20<proposalID_Bytes><voterAddrLen (1 Byte)><voterAddr_Bytes>: Voter - 0x30: Params.

# Structs

Config is a config struct used for intialising the gov module to avoid using globals.
No description provided by the author
Hunk represents a single change hunk in a unified diff.
ProposalMetadata is the metadata of a proposal This metadata is supposed to live off-chain when submitted in a proposal.

# Interfaces

AccountKeeper defines the expected account keeper (noalias).
BankKeeper defines the expected interface needed to retrieve account balances.
GovHooks event hooks for governance proposal object (noalias).
ParamSubspace defines the expected Subspace interface for parameters (noalias).
StakingKeeper expected staking keeper (Validator and Delegator sets) (noalias).

# Type aliases

combine multiple governance hooks, all hook functions are run in array sequence.