getter.gno

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

GetPoolCount

func GetPoolCount() int

GetPoolCount returns the total number of pools.

Return Values

Name	Type	Description
count	int	total number of pools

GetPoolPaths

func GetPoolPaths(
	offset int,
	count int
) []string

GetPoolPaths returns a paginated list of pool paths.

Parameters

Name	Type	Description
offset	int	starting index for pagination
count	int	maximum number of pool paths to return

Return Values

Name	Type	Description
poolPaths	[]string	pool paths for the requested page

ExistsPoolPath

func ExistsPoolPath(
	poolPath string
) bool

ExistsPoolPath checks if a pool exists at the given path.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
exists	bool	true if the pool exists

GetBalances

func GetBalances(
	poolPath string
) (string, string)

GetBalances returns the balances of the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
balance0	string	balance of token0
balance1	string	balance of token1

GetBalanceToken0

func GetBalanceToken0(
	poolPath string
) string

GetBalanceToken0 returns the balance of token0 in the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
balance0	string	balance of token0

GetBalanceToken1

func GetBalanceToken1(
	poolPath string
) string

GetBalanceToken1 returns the balance of token1 in the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
balance1	string	balance of token1

GetFee

func GetFee(
	poolPath string
) uint32

GetFee returns the fee tier of the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
fee	uint32	pool fee tier

GetFeeAmountTickSpacing

func GetFeeAmountTickSpacing(
	fee uint32
) (spacing int32)

GetFeeAmountTickSpacing returns the tick spacing for a given fee tier.

Parameters

Name	Type	Description
fee	uint32	pool fee tier

Return Values

Name	Type	Description
spacing	int32	tick spacing for the fee tier

GetFeeAmountTickSpacings

func GetFeeAmountTickSpacings() map[uint32]int32

GetFeeAmountTickSpacings returns all fee tier to tick spacing mappings.

Return Values

Name	Type	Description
feeAmountTickSpacings	map[uint32]int32	mapping of fee tier to tick spacing

GetFeeGrowthGlobal0X128

func GetFeeGrowthGlobal0X128(
	poolPath string
) string

GetFeeGrowthGlobal0X128 returns the global fee growth for token0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
feeGrowthGlobal0X128	string	fee growth for token0 as Q128.128

GetFeeGrowthGlobal1X128

func GetFeeGrowthGlobal1X128(
	poolPath string
) string

GetFeeGrowthGlobal1X128 returns the global fee growth for token1.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
feeGrowthGlobal1X128	string	fee growth for token1 as Q128.128

GetFeeGrowthGlobalX128

func GetFeeGrowthGlobalX128(
	poolPath string
) (*u256.Uint, *u256.Uint)

GetFeeGrowthGlobalX128 returns the global fee growth for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
feeGrowthGlobal0X128	*u256.Uint	fee growth for token0 as Q128.128
feeGrowthGlobal1X128	*u256.Uint	fee growth for token1 as Q128.128

GetFeeGrowthGlobals

func GetFeeGrowthGlobals(
	poolPath string
) (string, string)

GetFeeGrowthGlobals returns the global fee growth for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
feeGrowthGlobal0X128	string	fee growth for token0 as Q128.128
feeGrowthGlobal1X128	string	fee growth for token1 as Q128.128

GetLiquidity

func GetLiquidity(
	poolPath string
) string

GetLiquidity returns the current liquidity in the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
liquidity	string	current liquidity as a decimal string

GetMaxLiquidityPerTick

func GetMaxLiquidityPerTick(
	poolPath string
) string

GetMaxLiquidityPerTick returns the maximum liquidity per tick for the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
maxLiquidityPerTick	string	max liquidity per tick as a decimal string

GetObservation

func GetObservation(
	poolPath string,
	secondsAgo int64
) (tickCumulative int64, liquidityCumulative string, secondsPerLiquidityCumulativeX128 string, blockTimestamp int64)

GetObservation returns observation data for calculating time-weighted averages.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
secondsAgo	int64	time window to look back from current block timestamp

Return Values

Name	Type	Description
tickCumulative	int64	tick cumulative
liquidityCumulative	string	liquidity cumulative
secondsPerLiquidityCumulativeX128	string	seconds per liquidity cumulative (Q128.128)
blockTimestamp	int64	block timestamp of the observation

GetPoolCreationFee

func GetPoolCreationFee() int64

GetPoolCreationFee returns the current pool creation fee.

Return Values

Name	Type	Description
poolCreationFee	int64	pool creation fee

GetInitializedTicksInRange

func GetInitializedTicksInRange(
	poolPath string,
	tickLower int32,
	tickUpper int32
) []int32

GetInitializedTicksInRange returns initialized ticks within the given range.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tickLower	int32	lower tick boundary
tickUpper	int32	upper tick boundary

Return Values

Name	Type	Description
ticks	[]int32	initialized tick indices within the range

GetPoolPositionCount

func GetPoolPositionCount(
	poolPath string
) int

GetPoolPositionCount returns the number of positions in a pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
count	int	number of positions in the pool

---

GetPoolPositionKeys

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

GetPoolPositionKeys returns a paginated list of position keys in a pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
offset	int	starting index for pagination
count	int	maximum number of keys to return

Return Values

Name	Type	Description
keys	[]string	position keys for the requested page

---

GetPositionFeeGrowthInside0LastX128

func GetPositionFeeGrowthInside0LastX128(
	poolPath string,
	key string
) string

GetPositionFeeGrowthInside0LastX128 returns the last recorded fee growth inside for token0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
feeGrowthInside0LastX128	string	fee growth for token0 inside the position

---

GetPositionFeeGrowthInside1LastX128

func GetPositionFeeGrowthInside1LastX128(
	poolPath string,
	key string
) string

GetPositionFeeGrowthInside1LastX128 returns the last recorded fee growth inside for token1.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
feeGrowthInside1LastX128	string	fee growth for token1 inside the position

---

GetPositionFeeGrowthInsideLastX128

func GetPositionFeeGrowthInsideLastX128(
	poolPath string,
	key string
) (*u256.Uint, *u256.Uint)

GetPositionFeeGrowthInsideLastX128 returns the last recorded fee growth inside for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
feeGrowthInside0LastX128	*u256.Uint	fee growth for token0 inside the position
feeGrowthInside1LastX128	*u256.Uint	fee growth for token1 inside the position

---

GetPositionFeeGrowthInsideLasts

func GetPositionFeeGrowthInsideLasts(
	poolPath string,
	key string
) (string, string)

GetPositionFeeGrowthInsideLasts returns the last recorded fee growth inside for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
feeGrowthInside0LastX128	string	fee growth for token0 inside the position
feeGrowthInside1LastX128	string	fee growth for token1 inside the position

---

GetPositionLiquidity

func GetPositionLiquidity(
	poolPath string,
	key string
) *u256.Uint

GetPositionLiquidity returns the liquidity of a position.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
liquidity	*u256.Uint	position liquidity

---

GetPositionTokensOwed

func GetPositionTokensOwed(
	poolPath string,
	key string
) (string, string)

GetPositionTokensOwed returns the amount of tokens owed for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
tokensOwed0	string	amount of token0 owed to the position
tokensOwed1	string	amount of token1 owed to the position

---

GetPositionTokensOwed0

func GetPositionTokensOwed0(
	poolPath string,
	key string
) string

GetPositionTokensOwed0 returns the amount of token0 owed to a position.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
tokensOwed0	string	amount of token0 owed to the position

---

GetPositionTokensOwed1

func GetPositionTokensOwed1(
	poolPath string,
	key string
) string

GetPositionTokensOwed1 returns the amount of token1 owed to a position.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
key	string	position key

Return Values

Name	Type	Description
tokensOwed1	string	amount of token1 owed to the position

---

GetProtocolFeesToken0

func GetProtocolFeesToken0(
	poolPath string
) string

GetProtocolFeesToken0 returns accumulated protocol fees for token0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
protocolFeesToken0	string	accumulated protocol fees for token0

---

GetProtocolFeesToken1

func GetProtocolFeesToken1(
	poolPath string
) string

GetProtocolFeesToken1 returns accumulated protocol fees for token1.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
protocolFeesToken1	string	accumulated protocol fees for token1

---

GetProtocolFeesTokens

func GetProtocolFeesTokens(
	poolPath string
) (string, string)

GetProtocolFeesTokens returns the accumulated protocol fees for both tokens.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
protocolFeesToken0	string	accumulated protocol fees for token0
protocolFeesToken1	string	accumulated protocol fees for token1

---

GetSlot0FeeProtocol

func GetSlot0FeeProtocol(
	poolPath string
) uint8

GetSlot0FeeProtocol returns the protocol fee rate from slot0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
feeProtocol	uint8	protocol fee rate packed in slot0

---

GetSlot0SqrtPriceX96

func GetSlot0SqrtPriceX96(
	poolPath string
) *u256.Uint

GetSlot0SqrtPriceX96 returns the current sqrt price from slot0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
sqrtPriceX96	*u256.Uint	sqrt price in Q64.96 format

---

GetSlot0Tick

func GetSlot0Tick(
	poolPath string
) int32

GetSlot0Tick returns the current tick from slot0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
tick	int32	current tick

---

GetSlot0Unlocked

func GetSlot0Unlocked(
	poolPath string
) bool

GetSlot0Unlocked returns the locked status from slot0.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
unlocked	bool	true if pool is unlocked

---

GetTWAP

func GetTWAP(
	poolPath string,
	secondsAgo uint32
) (int32, *u256.Uint, error)

GetTWAP returns the time-weighted average price for a pool. Returns arithmetic mean tick and harmonic mean liquidity over the time period.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
secondsAgo	uint32	lookback window in seconds

Return Values

Name	Type	Description
meanTick	int32	arithmetic mean tick
meanLiquidity	*u256.Uint	harmonic mean liquidity
err	error	non-nil on failure

---

GetTickBitmaps

func GetTickBitmaps(
	poolPath string,
	wordPos int16
) (*u256.Uint, error)

GetTickBitmaps returns the tick bitmap for a given word position.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
wordPos	int16	bitmap word position

Return Values

Name	Type	Description
tickBitmap	*u256.Uint	tick bitmap copy
err	error	non-nil if the bitmap cannot be loaded

---

GetTickCumulativeOutside

func GetTickCumulativeOutside(
	poolPath string,
	tick int32
) int64

GetTickCumulativeOutside returns the tick cumulative value outside a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
tickCumulativeOutside	int64	tick cumulative outside the tick

---

GetTickFeeGrowthOutside0X128

func GetTickFeeGrowthOutside0X128(
	poolPath string,
	tick int32
) string

GetTickFeeGrowthOutside0X128 returns fee growth outside for token0 at a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
feeGrowthOutside0X128	string	fee growth outside for token0 as Q128.128

---

GetTickFeeGrowthOutside1X128

func GetTickFeeGrowthOutside1X128(
	poolPath string,
	tick int32
) string

GetTickFeeGrowthOutside1X128 returns fee growth outside for token1 at a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
feeGrowthOutside1X128	string	fee growth outside for token1 as Q128.128

---

GetTickFeeGrowthOutsideX128

func GetTickFeeGrowthOutsideX128(
	poolPath string,
	tick int32
) (*u256.Uint, *u256.Uint)

GetTickFeeGrowthOutsideX128 returns fee growth outside for both tokens at a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
feeGrowthOutside0X128	*u256.Uint	fee growth outside for token0 as Q128.128
feeGrowthOutside1X128	*u256.Uint	fee growth outside for token1 as Q128.128

---

GetTickFeeGrowthOutsides

func GetTickFeeGrowthOutsides(
	poolPath string,
	tick int32
) (string, string)

GetTickFeeGrowthOutsides returns fee growth outside for both tokens at a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
feeGrowthOutside0X128	string	fee growth outside for token0 as Q128.128
feeGrowthOutside1X128	string	fee growth outside for token1 as Q128.128

---

GetTickInitialized

func GetTickInitialized(
	poolPath string,
	tick int32
) bool

GetTickInitialized returns whether a tick is initialized.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
initialized	bool	true if the tick is initialized

---

GetTickLiquidityGross

func GetTickLiquidityGross(
	poolPath string,
	tick int32
) string

GetTickLiquidityGross returns the total liquidity that references a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
liquidityGross	string	gross liquidity for the tick

---

GetTickLiquidityNet

func GetTickLiquidityNet(
	poolPath string,
	tick int32
) string

GetTickLiquidityNet returns the net liquidity change at a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
liquidityNet	string	net liquidity change at the tick

---

GetTickSecondsOutside

func GetTickSecondsOutside(
	poolPath string,
	tick int32
) uint32

GetTickSecondsOutside returns seconds spent outside a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
secondsOutside	uint32	seconds spent outside the tick

---

GetTickSecondsPerLiquidityOutsideX128

func GetTickSecondsPerLiquidityOutsideX128(
	poolPath string,
	tick int32
) string

GetTickSecondsPerLiquidityOutsideX128 returns seconds per liquidity outside a tick.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form
tick	int32	tick index

Return Values

Name	Type	Description
secondsPerLiquidityOutsideX128	string	seconds per liquidity outside the tick as Q128.128

---

GetTickSpacing

func GetTickSpacing(
	poolPath string
) int32

GetTickSpacing returns the tick spacing of the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
tickSpacing	int32	tick spacing

---

GetToken0Path

func GetToken0Path(
	poolPath string
) string

GetToken0Path returns the path of token0 in the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
token0Path	string	token0 path

---

GetToken1Path

func GetToken1Path(
	poolPath string
) string

GetToken1Path returns the path of token1 in the pool.

Parameters

Name	Type	Description
poolPath	string	pool identifier in token0:token1:fee form

Return Values

Name	Type	Description
token1Path	string	token1 path

---

GetWithdrawalFee

func GetWithdrawalFee() uint64

GetWithdrawalFee returns the current withdrawal fee rate.

Return Values

Name	Type	Description
withdrawalFee	uint64	withdrawal fee in basis points