getter.gno

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

CollectableEmissionReward

func CollectableEmissionReward(
	positionId uint64
) int64

CollectableEmissionReward returns the claimable internal reward amount.

Parameters

Name	Type	Description
positionId	uint64	ID of the staked position

Return Values

Name	Type	Description
reward	int64	claimable internal reward amount

---

CollectableExternalIncentiveReward

func CollectableExternalIncentiveReward(
	positionId uint64,
	incentiveId string
) int64

CollectableExternalIncentiveReward returns the claimable external reward amount.

Parameters

Name	Type	Description
positionId	uint64	ID of the staked position
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
reward	int64	claimable external reward amount

---

GetAllowedTokens

func GetAllowedTokens() []string

GetAllowedTokens returns the allowed external incentive tokens.

Return Values

Name	Type	Description
tokens	[]string	list of allowed token paths

---

GetCreatedHeightOfIncentive

func GetCreatedHeightOfIncentive(
	poolPath string,
	incentiveId string
) int64

GetCreatedHeightOfIncentive returns the block height when an incentive was created.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
height	int64	block height at creation

---

GetDepositCollectedExternalReward

func GetDepositCollectedExternalReward(
	lpTokenId uint64,
	incentiveId string
) int64

GetDepositCollectedExternalReward returns the collected external reward amount of a position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	int64	collected external reward amount

---

GetDepositCollectedInternalReward

func GetDepositCollectedInternalReward(
	lpTokenId uint64
) int64

GetDepositCollectedInternalReward returns the collected internal reward amount of a position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
amount	int64	collected internal reward amount

---

GetDepositExternalIncentiveIdList

func GetDepositExternalIncentiveIdList(
	lpTokenId uint64
) []string

GetDepositExternalIncentiveIdList returns external incentive IDs for a deposit.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
incentiveIds	[]string	list of external incentive IDs

---

GetDepositExternalRewardLastCollectTimestamp

func GetDepositExternalRewardLastCollectTimestamp(
	lpTokenId uint64,
	incentiveId string
) int64

GetDepositExternalRewardLastCollectTimestamp returns the last external reward collection time for a position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
timestamp	int64	last collection timestamp

---

GetDepositGnsAmount

func GetDepositGnsAmount() int64

GetDepositGnsAmount returns the required GNS deposit amount for staking.

Return Values

Name	Type	Description
amount	int64	required GNS deposit amount

---

GetDepositInternalRewardLastCollectTimestamp

func GetDepositInternalRewardLastCollectTimestamp(
	lpTokenId uint64
) int64

GetDepositInternalRewardLastCollectTimestamp returns the last internal reward collection time for a position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
timestamp	int64	last collection timestamp

---

GetDepositLiquidity

func GetDepositLiquidity(
	lpTokenId uint64
) *u256.Uint

GetDepositLiquidity returns the liquidity amount of a staked position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
liquidity	*u256.Uint	liquidity amount

---

GetDepositLiquidityAsString

func GetDepositLiquidityAsString(
	lpTokenId uint64
) string

GetDepositLiquidityAsString returns the liquidity amount of a staked position as string.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
liquidity	string	liquidity amount as string

---

GetDepositOwner

func GetDepositOwner(
	lpTokenId uint64
) address

GetDepositOwner returns the owner of a staked position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
owner	address	owner address

---

GetDepositStakeTime

func GetDepositStakeTime(
	lpTokenId uint64
) int64

GetDepositStakeTime returns the staking duration of a position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
stakeTime	int64	staking timestamp

---

GetDepositTargetPoolPath

func GetDepositTargetPoolPath(
	lpTokenId uint64
) string

GetDepositTargetPoolPath returns the pool path of a staked position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
poolPath	string	target pool path

---

GetDepositTickLower

func GetDepositTickLower(
	lpTokenId uint64
) int32

GetDepositTickLower returns the lower tick of a staked position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
tickLower	int32	lower tick boundary

---

GetDepositTickUpper

func GetDepositTickUpper(
	lpTokenId uint64
) int32

GetDepositTickUpper returns the upper tick of a staked position.

Parameters

Name	Type	Description
lpTokenId	uint64	ID of the LP token position

Return Values

Name	Type	Description
tickUpper	int32	upper tick boundary

---

GetIncentiveCreatedTimestamp

func GetIncentiveCreatedTimestamp(
	poolPath string,
	incentiveId string
) int64

GetIncentiveCreatedTimestamp returns the creation timestamp of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
timestamp	int64	creation timestamp

---

GetIncentiveDepositGnsAmount

func GetIncentiveDepositGnsAmount(
	poolPath string,
	incentiveId string
) int64

GetIncentiveDepositGnsAmount returns the deposited GNS amount of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	int64	deposited GNS amount

---

GetIncentiveDistributedRewardAmount

func GetIncentiveDistributedRewardAmount(
	poolPath string,
	incentiveId string
) int64

GetIncentiveDistributedRewardAmount returns the distributed reward amount of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	int64	distributed reward amount

---

GetIncentiveEndTimestamp

func GetIncentiveEndTimestamp(
	poolPath string,
	incentiveId string
) int64

GetIncentiveEndTimestamp returns the end timestamp of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
timestamp	int64	end timestamp

---

GetIncentiveRefunded

func GetIncentiveRefunded(
	poolPath string,
	incentiveId string
) bool

GetIncentiveRefunded returns whether an incentive has been refunded.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
refunded	bool	true if incentive has been refunded

---

GetIncentiveRefundee

func GetIncentiveRefundee(
	poolPath string,
	incentiveId string
) address

GetIncentiveRefundee returns the refundee address of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
refundee	address	refundee address

---

GetIncentiveRemainingRewardAmount

func GetIncentiveRemainingRewardAmount(
	poolPath string,
	incentiveId string
) int64

GetIncentiveRemainingRewardAmount returns the remaining reward amount of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	int64	remaining reward amount

---

GetIncentiveRewardAmount

func GetIncentiveRewardAmount(
	poolPath string,
	incentiveId string
) *u256.Uint

GetIncentiveRewardAmount returns the total reward amount of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	*u256.Uint	total reward amount

---

GetIncentiveRewardAmountAsString

func GetIncentiveRewardAmountAsString(
	poolPath string,
	incentiveId string
) string

GetIncentiveRewardAmountAsString returns the total reward amount of an incentive as string.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	string	total reward amount as string

---

GetIncentiveRewardPerSecond

func GetIncentiveRewardPerSecond(
	poolPath string,
	incentiveId string
) int64

GetIncentiveRewardPerSecond returns the reward rate per second of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
rate	int64	reward per second

---

GetIncentiveRewardToken

func GetIncentiveRewardToken(
	poolPath string,
	incentiveId string
) string

GetIncentiveRewardToken returns the reward token of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
tokenPath	string	reward token path

---

GetIncentiveStartTimestamp

func GetIncentiveStartTimestamp(
	poolPath string,
	incentiveId string
) int64

GetIncentiveStartTimestamp returns the start timestamp of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
timestamp	int64	start timestamp

---

GetIncentiveTotalRewardAmount

func GetIncentiveTotalRewardAmount(
	poolPath string,
	incentiveId string
) int64

GetIncentiveTotalRewardAmount returns the total reward amount of an incentive.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
amount	int64	total reward amount

---

GetMinimumRewardAmount

func GetMinimumRewardAmount() int64

GetMinimumRewardAmount returns the minimum reward amount to distribute.

Return Values

Name	Type	Description
amount	int64	minimum reward amount

---

GetMinimumRewardAmountForToken

func GetMinimumRewardAmountForToken(
	tokenPath string
) int64

GetMinimumRewardAmountForToken returns the minimum reward amount for a specific token.

Parameters

Name	Type	Description
tokenPath	string	path of the token

Return Values

Name	Type	Description
amount	int64	minimum reward amount for the token

---

GetPoolGlobalRewardRatioAccumulation

func GetPoolGlobalRewardRatioAccumulation(
	poolPath string,
	timestamp uint64
) *u256.Uint

GetPoolGlobalRewardRatioAccumulation returns the global reward ratio accumulation at a specific timestamp for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
timestamp	uint64	accumulation timestamp

Return Values

Name	Type	Description
ratio	*u256.Uint	global reward ratio accumulation

---

GetPoolGlobalRewardRatioAccumulationCount

func GetPoolGlobalRewardRatioAccumulationCount(
	poolPath string
) uint64

GetPoolGlobalRewardRatioAccumulationCount returns the number of global reward ratio accumulation entries for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
count	uint64	number of accumulation entries

---

GetPoolGlobalRewardRatioAccumulationIDs

func GetPoolGlobalRewardRatioAccumulationIDs(
	poolPath string,
	offset int,
	count int
) []uint64

GetPoolGlobalRewardRatioAccumulationIDs returns a paginated list of timestamps for global reward ratio accumulation entries.

Parameters

Name	Type	Description
poolPath	string	path of the pool
offset	int	starting index
count	int	number of entries to return

Return Values

Name	Type	Description
timestamps	[]uint64	list of accumulation timestamps

---

GetPoolHistoricalTick

func GetPoolHistoricalTick(
	poolPath string,
	tick uint64
) int32

GetPoolHistoricalTick returns the historical tick at a specific timestamp for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
tick	uint64	tick index

Return Values

Name	Type	Description
tick	int32	historical tick value

---

GetPoolHistoricalTickCount

func GetPoolHistoricalTickCount(
	poolPath string
) uint64

GetPoolHistoricalTickCount returns the number of historical tick entries for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
count	uint64	number of historical tick entries

---

GetPoolHistoricalTickIDs

func GetPoolHistoricalTickIDs(
	poolPath string,
	offset int,
	count int
) []int32

GetPoolHistoricalTickIDs returns a paginated list of historical tick values for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
offset	int	starting index
count	int	number of entries to return

Return Values

Name	Type	Description
ticks	[]int32	list of historical tick values

---

GetPoolIncentiveCount

func GetPoolIncentiveCount(
	poolPath string
) uint64

GetPoolIncentiveCount returns the number of incentives for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
count	uint64	number of incentives

---

GetPoolIncentiveIDs

func GetPoolIncentiveIDs(
	poolPath string,
	offset int,
	count int
) []string

GetPoolIncentiveIDs returns a paginated list of incentive IDs for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
offset	int	starting index
count	int	number of IDs to return

Return Values

Name	Type	Description
incentiveIds	[]string	list of incentive IDs

---

GetPoolIncentiveIdList

func GetPoolIncentiveIdList(
	poolPath string
) []string

GetPoolIncentiveIdList returns all incentive IDs for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
incentiveIds	[]string	list of incentive IDs

---

GetPoolReward

func GetPoolReward(
	tier uint64
) int64

GetPoolReward returns the reward amount for a tier.

Parameters

Name	Type	Description
tier	uint64	tier level

Return Values

Name	Type	Description
reward	int64	reward amount for the tier

---

GetPoolRewardCache

func GetPoolRewardCache(
	poolPath string,
	timestamp uint64
) int64

GetPoolRewardCache returns the reward cache value at a specific timestamp for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
timestamp	uint64	cache timestamp

Return Values

Name	Type	Description
reward	int64	cached reward value

---

GetPoolRewardCacheCount

func GetPoolRewardCacheCount(
	poolPath string
) uint64

GetPoolRewardCacheCount returns the number of reward cache entries for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
count	uint64	number of reward cache entries

---

GetPoolRewardCacheIDs

func GetPoolRewardCacheIDs(
	poolPath string,
	offset int,
	count int
) []int64

GetPoolRewardCacheIDs returns a paginated list of reward cache timestamps for a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool
offset	int	starting index
count	int	number of entries to return

Return Values

Name	Type	Description
timestamps	[]int64	list of reward cache timestamps

---

GetPoolStakedLiquidity

func GetPoolStakedLiquidity(
	poolPath string
) string

GetPoolStakedLiquidity returns the current total staked liquidity of a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
liquidity	string	total staked liquidity as string

---

GetPoolTier

func GetPoolTier(
	poolPath string
) uint64

GetPoolTier returns the tier of a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
tier	uint64	tier level

---

GetPoolTierCount

func GetPoolTierCount(
	tier uint64
) uint64

GetPoolTierCount returns the number of pools in a tier.

Parameters

Name	Type	Description
tier	uint64	tier level

Return Values

Name	Type	Description
count	uint64	number of pools

---

GetPoolTierRatio

func GetPoolTierRatio(
	poolPath string
) uint64

GetPoolTierRatio returns the reward ratio of a pool.

Parameters

Name	Type	Description
poolPath	string	path of the pool

Return Values

Name	Type	Description
ratio	uint64	reward ratio

---

GetPoolsByTier

func GetPoolsByTier(
	tier uint64
) []string

GetPoolsByTier returns the pool list for a tier.

Parameters

Name	Type	Description
tier	uint64	tier level

Return Values

Name	Type	Description
pools	[]string	list of pool paths

---

GetSpecificTokenMinimumRewardAmount

func GetSpecificTokenMinimumRewardAmount(
	tokenPath string
) (int64, bool)

GetSpecificTokenMinimumRewardAmount returns the minimum reward amount for a specific token.

Parameters

Name	Type	Description
tokenPath	string	path of the token

Return Values

Name	Type	Description
amount	int64	minimum reward amount
exists	bool	true if token has specific minimum

---

GetStakedPositionsByUser

func GetStakedPositionsByUser(
	owner address,
	offset int,
	count int
) []uint64

GetStakedPositionsByUser returns staked position IDs for a user with pagination.

Parameters

Name	Type	Description
owner	address	owner address
offset	int	starting index
count	int	number of positions to return

Return Values

Name	Type	Description
positionIds	[]uint64	list of staked position IDs

---

GetTargetPoolPathByIncentiveId

func GetTargetPoolPathByIncentiveId(
	poolPath string,
	incentiveId string
) string

GetTargetPoolPathByIncentiveId returns the pool path for an incentive ID.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
targetPoolPath	string	target pool path

---

GetTotalEmissionSent

func GetTotalEmissionSent() int64

GetTotalEmissionSent returns the total GNS emission sent.

Return Values

Name	Type	Description
amount	int64	total GNS emission sent

---

GetTotalStakedUserCount

func GetTotalStakedUserCount() uint64

GetTotalStakedUserCount returns the total number of staked users.

Return Values

Name	Type	Description
count	uint64	total number of users with staked positions

---

GetTotalStakedUserPositionCount

func GetTotalStakedUserPositionCount(
	user address
) uint64

GetTotalStakedUserPositionCount returns the staked position count for a user.

Parameters

Name	Type	Description
user	address	user address

Return Values

Name	Type	Description
count	uint64	number of staked positions

---

GetUnstakingFee

func GetUnstakingFee() int64

GetUnstakingFee returns the unstaking fee percentage.

Return Values

Name	Type	Description
fee	int64	unstaking fee percentage

---

IsIncentiveActive

func IsIncentiveActive(
	poolPath string,
	incentiveId string
) bool

IsIncentiveActive returns whether an incentive is active.

Parameters

Name	Type	Description
poolPath	string	path of the pool
incentiveId	string	ID of the incentive

Return Values

Name	Type	Description
active	bool	true if incentive is active

---

IsStaked

func IsStaked(
	positionId uint64
) bool

IsStaked returns whether a position is staked.

Parameters

Name	Type	Description
positionId	uint64	ID of the position

Return Values

Name	Type	Description
staked	bool	true if position is staked