governance state

govStakerAccessor

newGovStakerAccessor

Config

Config represents the configuration of the governor contract All parameters in this struct can be modified through governance.

NewConfig

NewConfigPtr

NewConfigPtr constructs a Config and returns a pointer to it. The Config is allocated within the governance domain realm, satisfying realm allocation checks for callers (such as tests) that require a \*Config value.

NewDefaultConfig

NewConfigTree

Counter

Counter manages unique incrementing IDs.

NewCounter

NewCounter creates a new Counter starting at 0.

cloneInt64Slice

cloneAddressSlice

GetLatestConfigVersion

GetLatestConfigVersion returns the current config version.

GetCurrentProposalID

GetCurrentProposalID returns the current proposal ID counter.

GetMaxSmoothingPeriod

GetMaxSmoothingPeriod returns the maximum smoothing period for delegation history cleanup.

GetLatestConfig

GetLatestConfig returns the latest governance configuration.

GetConfig

GetConfig returns a specific governance configuration by version.

GetProposalCount

GetProposalCount returns the total number of proposals.

GetProposalIDs

GetProposalIDs returns a paginated list of proposal IDs.

ExistsProposal

ExistsProposal checks if a proposal exists.

GetProposal

GetProposal returns a proposal by ID. Returns a clone to prevent external modification.

GetProposerByProposalId

GetProposalTypeByProposalId

GetProposalTypeByProposalId returns the type of a proposal.

GetYeaByProposalId

GetYeaByProposalId returns the yes vote weight of a proposal.

GetNayByProposalId

GetNayByProposalId returns the no vote weight of a proposal.

GetConfigVersionByProposalId

GetConfigVersionByProposalId returns the config version used by a proposal.

GetQuorumAmountByProposalId

GetQuorumAmountByProposalId returns the quorum requirement for a proposal.

GetTitleByProposalId

GetTitleByProposalId returns the title of a proposal.

GetDescriptionByProposalId

GetDescriptionByProposalId returns the description of a proposal.

GetProposalStatusByProposalId

GetProposalStatusByProposalId returns the current status of a proposal.

GetProposalCreatedAt

GetProposalCreatedAt returns the creation timestamp of a proposal.

GetProposalCreatedHeight

GetProposalCreatedHeight returns the creation block height of a proposal.

GetVoteStatus

GetVoteStatus returns the vote status of a proposal. Returns: - quorum: minimum vote weight required for proposal to pass - maxVotingWeight: maximum possible voting weight - yesWeight: total weight of "yes" votes - noWeight: total weight of "no" votes

GetVotingInfoCount

GetVotingInfoCount returns the number of voters for a proposal.

GetVotingInfoAddresses

ExistsVotingInfo

ExistsVotingInfo checks if a voting info exists for a user on a proposal.

GetVotingInfo

GetVotingInfo returns the voting info for a user on a proposal. Returns a clone to prevent external modification.

GetVoteWeight

GetVoteWeight returns the voting weight of an address for a proposal.

GetVotedHeight

GetVotedHeight returns the block height when an address voted on a proposal.

GetVotedAt

GetVotedAt returns the timestamp when an address voted on a proposal.

GetProposalCommunityPoolSpendInfo

GetProposalCommunityPoolSpendInfo returns the community pool spend info for a proposal.

GetProposalExecutionInfo

GetProposalExecutionInfo returns the execution info for a proposal.

GetUserProposalCount

GetUserProposalCount returns the number of proposals created by a user.

GetUserProposalIDs

GetUserProposalIDs returns a paginated list of proposal IDs created by a user.

GetOldestActiveProposalSnapshotTime

GetOldestActiveProposalSnapshotTime returns the oldest snapshot time among active proposals.

GetCurrentVotingWeightSnapshot

GetCurrentVotingWeightSnapshot returns the current voting weight snapshot.

Proposal

Proposal represents a governance proposal with all its associated data and state. This is the core structure that tracks proposal lifecycle from creation to execution.

NewProposal

NewProposal creates a new proposal instance with the provided parameters. NewProposal is the main constructor for creating governance proposals. - metadata: proposal title and description - data: type-specific proposal data - proposerAddress: address of the proposal creator - configVersion: governance configuration version - snapshotTime: timestamp for voting weight snapshot lookup - createdHeight: creation block height Returns: - \*Proposal: newly created proposal instance

NewProposalTree

NewUserProposalTree

NewVotingInfoTree

NewProposalUserVotingInfoTree

ProposalActionStatus

ProposalActionStatus tracks the execution and cancellation status of a proposal. This structure manages the action-related state including who performed actions and when.

NewProposalActionStatus

NewProposalActionStatus creates a new action status for a proposal. Initializes the status with default values and the executable flag. Parameters: - executable: whether this proposal type can be executed Returns: - \*ProposalActionStatus: new action status instance

ProposalMetadata

ProposalMetadata contains descriptive information about a proposal. This includes the title and description that are displayed to voters.

NewProposalMetadata

NewProposalMetadata creates a new proposal metadata instance with trimmed input. Parameters: - title: proposal title - description: proposal description Returns: - \*ProposalMetadata: new metadata instance with trimmed whitespace

ProposalData

ProposalData contains the type-specific data for a proposal. This structure holds different data depending on the proposal type.

NewProposalData

NewProposalData creates a new proposal data instance with the specified components. Parameters: - proposalType: type of the proposal - communityPoolSpend: community pool spending information - execution: parameter change execution information Returns: - \*ProposalData: new proposal data instance

CommunityPoolSpendInfo

CommunityPoolSpendInfo contains information for community pool spending proposals.

NewCommunityPoolSpendInfo

ExecutionInfo

ExecutionInfo contains information for parameter change execution. Messages are encoded strings that specify function calls and parameters.

NewExecutionInfo

ParameterChangeInfo

ParameterChangeInfo represents a single parameter change to be executed.

NewParameterChangeInfo

ProposalScheduleStatus

ProposalScheduleStatus represents the pre-calculated time schedule for a proposal. This structure defines all the important timestamps in a proposal's lifecycle, from creation through voting to execution and expiration.

NewProposalScheduleStatus

ProposalStatusType

ProposalStatusType represents the current status of a proposal in its lifecycle. These statuses determine what actions are available for a proposal.

StatusUpcoming

// Proposal created but voting hasn't started yet

StatusActive

// Proposal is in voting period

StatusPassed

// Proposal has passed but hasn't been executed (or is text proposal)

StatusRejected

// Proposal failed to meet voting requirements

StatusExecutable

// Proposal can be executed (passed and in execution window)

StatusExecuted

// Proposal has been successfully executed

StatusExpired

// Proposal execution window has passed

StatusCanceled

// Proposal has been canceled

ProposalStatus

ProposalStatus manages the complete status of a proposal including scheduling, voting, and actions. This is the central status tracking structure that coordinates different aspects of proposal state.

NewProposalStatusBy

ProposalType

ProposalType defines the different types of proposals supported by the governance system. Each type has different execution behavior and validation requirements.

Text

// Informational proposals for community discussion

CommunityPoolSpend

CommunityPoolSpend returns the community pool spending information. Returns: - \*CommunityPoolSpendInfo: community pool spending details

ParameterChange

// Proposals to modify system parameters

ProposalVoteStatus

ProposalVoteStatus tracks the voting tallies and requirements for a proposal. This structure manages vote counting, quorum calculation, and voting outcome determination.

NewProposalVoteStatus

NewProposalVoteStatus creates a new vote status for a proposal. Initializes vote tallies to zero and calculates the quorum requirement. Parameters: - maxVotingWeight: maximum possible voting weight for this proposal - quorumAmount: quorum amount required for passage Returns: - \*ProposalVoteStatus: new vote status instance

ProposeText

ProposeText creates a new text proposal for general governance decisions. Parameters: - title: proposal title - description: detailed proposal description Returns: - int64: ID of the created proposal

ProposeCommunityPoolSpend

ProposeCommunityPoolSpend creates a new community pool spending proposal. Parameters: - title: proposal title - description: detailed proposal description - to: recipient address - tokenPath: token path to transfer - amount: amount to transfer Returns: - int64: ID of the created proposal

ProposeParameterChange

ProposeParameterChange creates a new parameter change proposal. Parameters: - title: proposal title - description: detailed proposal description - numToExecute: number of executions to perform - executions: encoded execution messages Returns: - int64: ID of the created proposal

Vote

Vote casts a vote on a proposal. Parameters: - proposalId: ID of the proposal to vote on - yes: true for yes vote, false for no vote Returns: - string: voting result information

Execute

Execute executes a passed proposal that is in the execution window. Parameters: - proposalId: ID of the proposal to execute Returns: - int64: execution result code

Cancel

Cancel cancels a proposal before voting begins. Only callable by the proposer. Parameters: - proposalId: ID of the proposal to cancel Returns: - int64: cancellation result code

Reconfigure

Reconfigure updates the governance configuration parameters. Only callable by admin or governance. Parameters: - votingStartDelay: delay before voting starts (seconds) - votingPeriod: voting duration (seconds) - votingWeightSmoothingDuration: weight smoothing duration (seconds) - quorum: minimum voting weight required (percentage) - proposalCreationThreshold: minimum weight to create proposal - executionDelay: delay before execution (seconds) - executionWindow: execution time window (seconds) Returns: - int64: new configuration version

ErrSpoofedRealm

currentAddress

domainPath

kvStore

versionManager

implementation

init.95

initializeDomainStore

getImplementation

updateImplementation

StoreKey

StoreKeyConfigCounter

// Config version counter

StoreKeyProposalCounter

// Proposal ID counter

StoreKeyConfigs

// Configurations BPTree

StoreKeyProposals

// Proposals BPTree

StoreKeyProposalUserVotingInfos

// Proposal voting infos BPTree

StoreKeyUserProposals

// User proposals mapping BPTree

governanceStore

NewGovernanceStore

NewGovernanceStore creates a new governance store instance with the provided KV store. This function is used by the upgrade system to create storage instances for each implementation.

formatInt64Key

formatInt64Key formats int64 identifiers for storage keys.

IGovernance

IGovernanceManager

IGovernanceGetter

IGovernanceGetter provides read-only access to governance data.

IGovernanceStore

GovStakerAccessor

GovStakerAccessor provides an interface for accessing gov staker functionality. This abstraction allows for easier testing by enabling mock implementations.

RegisterInitializer

RegisterInitializer registers a version-specific initializer. Each version (e.g. v1, v2) calls this function from its init body to plug itself into the proxy. The initializer constructs the version's IGovernance from the supplied IGovernanceStore and GovStakerAccessor. It receives a realm value that resolves to the governance proxy realm — the only address with write permission on the shared KV store — so any per-version store bootstrap performed inside the initializer passes the proxy's authorization check. Security: Only contracts within the domain path can register initializers. Each package path can only register once to prevent duplicate registrations.

UpgradeImpl

UpgradeImpl switches the active governance implementation to a different version. This function allows seamless upgrades from one version to another without data migration or downtime. Security: Only admin or governance can perform upgrades. The new implementation must have been previously registered via RegisterInitializer.

GetImplementationPackagePath

GetImplementationPackagePath returns the package path of the currently active implementation.

VotingInfo

VotingInfo tracks voting-related information for a specific user on a specific proposal. This structure maintains the user's voting eligibility, voting history, and voting power.

NewVotingInfo

NewVotingInfo creates a new voting information structure for a user. This constructor initializes the voting eligibility based on delegation snapshots. Parameters: - availableVoteWeight: total voting weight available to this user Returns: - \*VotingInfo: newly created voting information structure