getter.gno

gnoswap/contract/r/gnoswap/gov/governance/v1/getter.gno at main · gnoswap-labs/gnoswapGitHub

ExistsProposal

func ExistsProposal(
	proposalID int64
) bool

ExistsProposal checks if a proposal exists.

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal

Return Values

Name	Type	Description
exists	bool	true if proposal exists

---

ExistsVotingInfo

func ExistsVotingInfo(
	proposalID int64,
	addr address
) bool

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

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal
addr	address	voter address

Return Values

Name	Type	Description
exists	bool	true if voting info exists

---

GetLatestConfigVersion

func GetLatestConfigVersion() int64

GetLatestConfigVersion returns the current config version.

Return Values

Name	Type	Description
version	int64	current config version number

---

GetCurrentProposalID

func GetCurrentProposalID() int64

GetCurrentProposalID returns the current proposal ID counter.

Return Values

Name	Type	Description
proposalId	int64	current proposal ID counter

---

GetMaxSmoothingPeriod

func GetMaxSmoothingPeriod() int64

GetMaxSmoothingPeriod returns the maximum smoothing period for delegation history cleanup.

Return Values

Name	Type	Description
period	int64	maximum smoothing period in seconds

---

GetProposalCount

func GetProposalCount() int

GetProposalCount returns the total number of proposals.

Return Values

Name	Type	Description
count	int	total number of proposals

---

GetProposalIDs

func GetProposalIDs(
	offset int,
	count int
) []int64

GetProposalIDs returns a paginated list of proposal IDs.

Parameters

Name	Type	Description
offset	int	starting index
count	int	number of IDs to return

Return Values

Name	Type	Description
proposalIds	[]int64	list of proposal IDs

---

GetProposerByProposalId

func GetProposerByProposalId(
	proposalId int64
) (address, error)

GetProposerByProposalId returns the proposer address of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
proposer	address	proposer address
err	error	error if not found

---

GetYeaByProposalId

func GetYeaByProposalId(
	proposalId int64
) (int64, error)

GetYeaByProposalId returns the yes vote weight of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
yea	int64	total yes vote weight
err	error	error if not found

---

GetNayByProposalId

func GetNayByProposalId(
	proposalId int64
) (int64, error)

GetNayByProposalId returns the no vote weight of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
nay	int64	total no vote weight
err	error	error if not found

---

GetConfigVersionByProposalId

func GetConfigVersionByProposalId(
	proposalId int64
) (int64, error)

GetConfigVersionByProposalId returns the config version used by a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
configVersion	int64	config version number
err	error	error if not found

---

GetQuorumAmountByProposalId

func GetQuorumAmountByProposalId(
	proposalId int64
) (int64, error)

GetQuorumAmountByProposalId returns the quorum requirement for a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
quorum	int64	required quorum amount
err	error	error if not found

---

GetTitleByProposalId

func GetTitleByProposalId(
	proposalId int64
) (string, error)

GetTitleByProposalId returns the title of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
title	string	proposal title
err	error	error if not found

---

GetDescriptionByProposalId

func GetDescriptionByProposalId(
	proposalId int64
) (string, error)

GetDescriptionByProposalId returns the description of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
description	string	proposal description
err	error	error if not found

---

GetProposalStatusByProposalId

func GetProposalStatusByProposalId(
	proposalId int64
) (string, error)

GetProposalStatusByProposalId returns the current status of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
status	string	proposal status string
err	error	error if not found

---

GetProposalCreatedAt

func GetProposalCreatedAt(
	proposalId int64
) (int64, error)

GetProposalCreatedAt returns the creation timestamp of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
timestamp	int64	creation timestamp
err	error	error if not found

---

GetProposalCreatedHeight

func GetProposalCreatedHeight(
	proposalId int64
) (int64, error)

GetProposalCreatedHeight returns the creation block height of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
height	int64	creation block height
err	error	error if not found

---

GetVoteStatus

func GetVoteStatus(
	proposalId int64
) (quorum int64, maxVotingWeight int64, yesWeight int64, noWeight int64, err error)

GetVoteStatus returns the vote status of a proposal.

Parameters

Name	Type	Description
proposalId	int64	ID of the proposal

Return Values

Name	Type	Description
quorum	int64	minimum vote weight required for proposal to pass
maxVotingWeight	int64	maximum possible voting weight
yesWeight	int64	total weight of "yes" votes
noWeight	int64	total weight of "no" votes
err	error	error if not found

---

GetVotingInfoCount

func GetVotingInfoCount(
	proposalID int64
) int

GetVotingInfoCount returns the number of voters for a proposal.

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal

Return Values

Name	Type	Description
count	int	number of voters

---

GetVotingInfoAddresses

func GetVotingInfoAddresses(
	proposalID int64,
	offset int,
	count int
) []address

GetVotingInfoAddresses returns a paginated list of voter addresses for a proposal.

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal
offset	int	starting index
count	int	number of addresses to return

Return Values

Name	Type	Description
addresses	[]address	list of voter addresses

---

GetVoteWeight

func GetVoteWeight(
	proposalID int64,
	addr address
) (int64, error)

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

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal
addr	address	voter address

Return Values

Name	Type	Description
weight	int64	voting weight
err	error	error if not found

---

GetVotedHeight

func GetVotedHeight(
	proposalID int64,
	addr address
) (int64, error)

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

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal
addr	address	voter address

Return Values

Name	Type	Description
height	int64	block height when voted
err	error	error if not found

---

GetVotedAt

func GetVotedAt(
	proposalID int64,
	addr address
) (int64, error)

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

Parameters

Name	Type	Description
proposalID	int64	ID of the proposal
addr	address	voter address

Return Values

Name	Type	Description
timestamp	int64	time when voted
err	error	error if not found

---

GetUserProposalCount

func GetUserProposalCount(
	user address
) int

GetUserProposalCount returns the number of proposals created by a user.

Parameters

Name	Type	Description
user	address	user address

Return Values

Name	Type	Description
count	int	number of proposals created by user

---

GetUserProposalIDs

func GetUserProposalIDs(
	user address,
	offset int,
	count int
) []int64

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

Parameters

Name	Type	Description
user	address	user address
offset	int	starting index
count	int	number of IDs to return

Return Values

Name	Type	Description
proposalIds	[]int64	list of proposal IDs

---

GetOldestActiveProposalSnapshotTime

func GetOldestActiveProposalSnapshotTime() (int64, bool)

GetOldestActiveProposalSnapshotTime returns the oldest snapshot time among active proposals.

Return Values

Name	Type	Description
snapshotTime	int64	oldest snapshot timestamp
exists	bool	true if active proposals exist

---

GetCurrentVotingWeightSnapshot

func GetCurrentVotingWeightSnapshot() (int64, int64, error)

GetCurrentVotingWeightSnapshot returns the current voting weight snapshot.

Return Values

Name	Type	Description
snapshotHeight	int64	snapshot block height
snapshotTime	int64	snapshot timestamp
err	error	error if retrieval fails