getter.gno

gnoswap/contract/r/gnoswap/position/v1/getter.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

gnoswap/contract/r/gnoswap/position/getter.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

GetPositionFeeGrowthInside0LastX128

func GetPositionFeeGrowthInside0LastX128(
	positionId uint64
) (string, error)

GetPositionFeeGrowthInside0LastX128 returns the last fee-growth checkpoint inside the position's range for token0.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose token0 fee-growth checkpoint is queried

Return Values

Name	Type	Description
feeGrowthInside0LastX128	string	token0 fee-growth checkpoint, represented as a decimal string
err	error	non-nil when positionId cannot be resolved

source

GetPositionFeeGrowthInside1LastX128

func GetPositionFeeGrowthInside1LastX128(
	positionId uint64
) (string, error)

GetPositionFeeGrowthInside1LastX128 returns the last fee-growth checkpoint inside the position's range for token1.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose token1 fee-growth checkpoint is queried

Return Values

Name	Type	Description
feeGrowthInside1LastX128	string	token1 fee-growth checkpoint, represented as a decimal string
err	error	non-nil when positionId cannot be resolved

source

GetPositionFeeGrowthInsideLastX128

func GetPositionFeeGrowthInsideLastX128(
	positionId uint64
) (string, string, error)

GetPositionFeeGrowthInsideLastX128 returns the last fee-growth checkpoints inside the position's range for both tokens.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose fee-growth checkpoints are queried

Return Values

Name	Type	Description
feeGrowthInside0LastX128	string	token0 fee-growth checkpoint, represented as a decimal string
feeGrowthInside1LastX128	string	token1 fee-growth checkpoint, represented as a decimal string
err	error	non-nil when positionId cannot be resolved

source

GetPositionLiquidity

func GetPositionLiquidity(
	positionId uint64
) (string, error)

GetPositionLiquidity returns the stored liquidity amount of a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose liquidity is queried

Return Values

Name	Type	Description
liquidity	string	position liquidity, represented as a decimal string
err	error	non-nil when positionId cannot be resolved

source

GetPositionOperator

func GetPositionOperator(
	positionId uint64
) (address, error)

GetPositionOperator returns the approved operator address for a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose operator is queried

Return Values

Name	Type	Description
operator	address	approved operator address; the zero address means no operator is set
err	error	non-nil when positionId cannot be resolved

source

GetPositionOwner

func GetPositionOwner(
	positionId uint64
) (address, error)

GetPositionOwner returns the owner address of a position NFT.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose owner is queried

Return Values

Name	Type	Description
owner	address	address that owns the position NFT
err	error	non-nil when the NFT owner lookup fails

source

GetPositionPoolKey

func GetPositionPoolKey(
	positionId uint64
) (string, error)

GetPositionPoolKey returns the pool key associated with a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose pool association is queried

Return Values

Name	Type	Description
poolKey	string	canonical pool key used by the position
err	error	non-nil when positionId cannot be resolved

source

GetPositionTickLower

func GetPositionTickLower(
	positionId uint64
) (int32, error)

GetPositionTickLower returns the lower tick boundary of a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose lower tick is queried

Return Values

Name	Type	Description
tickLower	int32	lower tick boundary of the position's price range
err	error	non-nil when positionId cannot be resolved

source

GetPositionTickUpper

func GetPositionTickUpper(
	positionId uint64
) (int32, error)

GetPositionTickUpper returns the upper tick boundary of a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose upper tick is queried

Return Values

Name	Type	Description
tickUpper	int32	upper tick boundary of the position's price range
err	error	non-nil when positionId cannot be resolved

source

GetPositionTicks

func GetPositionTicks(
	positionId uint64
) (int32, int32, error)

GetPositionTicks returns the lower and upper tick boundaries of a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose tick range is queried

Return Values

Name	Type	Description
tickLower	int32	lower tick boundary of the position's price range
tickUpper	int32	upper tick boundary of the position's price range
err	error	non-nil when positionId cannot be resolved

source

GetPositionToken0Balance

func GetPositionToken0Balance(
	positionId uint64
) (int64, error)

GetPositionToken0Balance returns the token0 balance associated with a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID

Return Values

Name	Type	Description
balance	int64	token0 balance
err	error	non-nil when positionId cannot be resolved

source

GetPositionToken1Balance

func GetPositionToken1Balance(
	positionId uint64
) (int64, error)

GetPositionToken1Balance returns the token1 balance associated with a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID

Return Values

Name	Type	Description
balance	int64	token1 balance
err	error	non-nil when positionId cannot be resolved

source

GetPositionTokenBalances

func GetPositionTokenBalances(
	positionId uint64
) (int64, int64, error)

GetPositionTokenBalances calculates the current token0/token1 balances for a position from its liquidity, tick range, and pool price.

These are derived balances, not permanently stored token amounts.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID

Return Values

Name	Type	Description
balance0	int64	current token0 balance
balance1	int64	current token1 balance
err	error	non-nil when positionId cannot be resolved

source

GetPositionTokensOwed

func GetPositionTokensOwed(
	positionId uint64
) (int64, int64, error)

GetPositionTokensOwed returns the token0 and token1 amounts accrued and owed to a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose accrued token debt is queried

Return Values

Name	Type	Description
tokensOwed0	int64	token0 amount currently owed to the position
tokensOwed1	int64	token1 amount currently owed to the position
err	error	non-nil when positionId cannot be resolved

source

GetPositionTokensOwed0

func GetPositionTokensOwed0(
	positionId uint64
) (int64, error)

GetPositionTokensOwed0 returns the token0 amount accrued and owed to a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose token0 debt is queried

Return Values

Name	Type	Description
tokensOwed0	int64	token0 amount currently owed to the position
err	error	non-nil when positionId cannot be resolved

source

GetPositionTokensOwed1

func GetPositionTokensOwed1(
	positionId uint64
) (int64, error)

GetPositionTokensOwed1 returns the token1 amount accrued and owed to a position.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose token1 debt is queried

Return Values

Name	Type	Description
tokensOwed1	int64	token1 amount currently owed to the position
err	error	non-nil when positionId cannot be resolved

source

GetPositions

func GetPositions() *rotree.ReadOnlyTree

GetPositions returns a read-only view of all positions.

Return Values

Name	Type	Description
positions	*rotree.ReadOnlyTree	read-only tree keyed by decimal position ID; callers paginate with IterateByOffset

source

GetUnclaimedFee

func GetUnclaimedFee(
	positionId uint64
) (string, string, error)

GetUnclaimedFee returns the unclaimed fees for both tokens of a position as decimal strings.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID whose unclaimed fees are queried

Return Values

Name	Type	Description
fee0	string	unclaimed token0 fee amount, represented as a decimal string
fee1	string	unclaimed token1 fee amount, represented as a decimal string
err	error	non-nil when positionId or the associated pool fee-growth data cannot be resolved

source

IsBurned

func IsBurned(
	positionId uint64
) (bool, error)

IsBurned reports whether the position's empty-position marker is set.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID

Return Values

Name	Type	Description
burned	bool	whether the position's empty-position marker is set
err	error	non-nil when positionId cannot be resolved

source

IsInRange

func IsInRange(
	positionId uint64
) (bool, error)

IsInRange reports whether a position's ticks contain the current pool tick.

Parameters

Name	Type	Description
positionId	uint64	position NFT token ID

Return Values

Name	Type	Description
inRange	bool	whether the position is currently in range
err	error	non-nil when positionId cannot be resolved or the associated pool tick cannot be read

source