gno.land/r/gnoswap/pool/v1

Realm

Overview

Kind: Realm (renderable)
Name: v1
Namespace: gnoswap / pool
Files: 24 (README)(gnomod.toml)
Exported functions: 3
Module: gno.land/r/gnoswap/pool/v1
gno: 0.9

Files (24)

tick_bitmap.gnogno

1package pool23import (4	"gno.land/p/gnoswap/gnsmath/v1"5	u256 "gno.land/p/gnoswap/uint256/v1"6	pl "gno.land/r/gnoswap/pool"7)8

Functions

GetPoolPath(token0Path string, token1Path string, fee uint32) string
NewPoolV1(store interface {GetFeeAmountTickSpacing func() map[uint32]int32; GetObservations func() *gno.land/p/nt/bptree/v0.BPTree; GetPendingProtocolFee func(string) int64; GetPendingProtocolFees func() map[string]int64; GetPoolCreationFee func() int64; GetPools func() *gno.land/p/nt/bptree/v0.BPTree; GetSlot0FeeProtocol func() uint8; GetSwapEndHook func() func(.uverse.realm, string) .uverse.error; GetSwapStartHook func() func(.uverse.realm, string, int64); GetTickCrossHook func() func(.uverse.realm, string, int32, bool, int64); GetUnlocked func() bool; GetWithdrawalFeeBPS func() uint64; HasFeeAmountTickSpacing func() bool; HasObservations func() bool; HasPendingProtocolFees func() bool; HasPoolCreationFee func() bool; HasPools func() bool; HasSlot0FeeProtocol func() bool; HasSwapEndHook func() bool; HasSwapStartHook func() bool; HasTickCrossHook func() bool; HasUnlocked func() bool; HasWithdrawalFeeBPS func() bool; RemovePendingProtocolFee func(int, .uverse.realm, string) .uverse.error; SetFeeAmountTickSpacing func(int, .uverse.realm, map[uint32]int32) .uverse.error; SetObservations func(int, .uverse.realm, *gno.land/p/nt/bptree/v0.BPTree) .uverse.error; SetPendingProtocolFee func(int, .uverse.realm, string, int64) .uverse.error; SetPendingProtocolFees func(int, .uverse.realm, map[string]int64) .uverse.error; SetPoolCreationFee func(int, .uverse.realm, int64) .uverse.error; SetPools func(int, .uverse.realm, *gno.land/p/nt/bptree/v0.BPTree) .uverse.error; SetSlot0FeeProtocol func(int, .uverse.realm, uint8) .uverse.error; SetSwapEndHook func(int, .uverse.realm, func(.uverse.realm, string) .uverse.error) .uverse.error; SetSwapStartHook func(int, .uverse.realm, func(.uverse.realm, string, int64)) .uverse.error; SetTickCrossHook func(int, .uverse.realm, func(.uverse.realm, string, int32, bool, int64)) .uverse.error; SetUnlocked func(int, .uverse.realm, bool) .uverse.error; SetWithdrawalFeeBPS func(int, .uverse.realm, uint64) .uverse.error}) interface {Burn func(int, .uverse.realm, string, string, uint32, int32, int32, string, .uverse.address) (string, string); Collect func(int, .uverse.realm, string, string, uint32, .uverse.address, int32, int32, string, string) (string, string); CollectProtocol func(int, .uverse.realm, string, string, uint32, .uverse.address, string, string) (string, string); CollectSwapFee func(int, .uverse.realm, string, string, uint32, .uverse.address, int32, int32, string, string) (string, string, string, string); CreatePool func(int, .uverse.realm, string, string, uint32, string); DrySwap func(string, string, uint32, bool, string, string) (string, string, .uverse.error); ExistsPoolPath func(string) bool; GetBalanceToken0 func(string) (int64, .uverse.error); GetBalanceToken1 func(string) (int64, .uverse.error); GetFee func(string) (uint32, .uverse.error); GetFeeAmountTickSpacing func(uint32) (int32, .uverse.error); GetFeeAmountTickSpacings func() map[uint32]int32; GetFeeGrowthGlobal0X128 func(string) (*gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); GetFeeGrowthGlobal1X128 func(string) (*gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); GetFeeGrowthGlobalX128 func(string) (*gno.land/p/gnoswap/uint256/v1.Uint, *gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); GetInitializedTicksInRange func(string, int32, int32) ([]int32, .uverse.error); GetLiquidity func(string) (*gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); GetObservationAt func(string, uint16) (gno.land/r/gnoswap/pool.Observation, .uverse.error); GetPendingProtocolFees func() map[string]int64; GetPoolCreationFee func() int64; GetPoolPositions func(string) *gno.land/p/nt/bptree/rotree/v0.ReadOnlyTree; GetPools func() *gno.land/p/nt/bptree/rotree/v0.ReadOnlyTree; GetPositionFeeGrowthInside0LastX128 func(string, string) (string, .uverse.error); GetPositionFeeGrowthInside1LastX128 func(string, string) (string, .uverse.error); GetPositionFeeGrowthInsideLastX128 func(string, string) (string, string, .uverse.error); GetPositionLiquidity func(string, string) (string, .uverse.error); GetPositionTokensOwed0 func(string, string) (int64, .uverse.error); GetPositionTokensOwed1 func(string, string) (int64, .uverse.error); GetProtocolFeesToken0 func(string) (int64, .uverse.error); GetProtocolFeesToken1 func(string) (int64, .uverse.error); GetSlot0 func(string) gno.land/r/gnoswap/pool.Slot0; GetSlot0FeeProtocol func(string) (uint8, .uverse.error); GetSlot0SqrtPriceX96 func(string) (*gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); GetSlot0Tick func(string) (int32, .uverse.error); GetSlot0Unlocked func(string) (bool, .uverse.error); GetTickBitmaps func(string, int16) (string, .uverse.error); GetTickCumulativeOutside func(string, int32) (int64, .uverse.error); GetTickFeeGrowthOutside0X128 func(string, int32) (string, .uverse.error); GetTickFeeGrowthOutside1X128 func(string, int32) (string, .uverse.error); GetTickFeeGrowthOutsideX128 func(string, int32) (string, string, .uverse.error); GetTickInfo func(string, int32) (gno.land/r/gnoswap/pool.TickInfo, .uverse.error); GetTickInitialized func(string, int32) (bool, .uverse.error); GetTickLiquidityGross func(string, int32) (string, .uverse.error); GetTickLiquidityNet func(string, int32) (string, .uverse.error); GetTickSecondsOutside func(string, int32) (uint32, .uverse.error); GetTickSecondsPerLiquidityOutsideX128 func(string, int32) (string, .uverse.error); GetTickSpacing func(string) (int32, .uverse.error); GetToken0Path func(string) (string, .uverse.error); GetToken1Path func(string) (string, .uverse.error); GetWithdrawalFee func() uint64; IncreaseObservationCardinalityNext func(int, .uverse.realm, string, string, uint32, uint16); Mint func(int, .uverse.realm, string, string, uint32, int32, int32, string, .uverse.address) (string, string); Observe func(string, []uint32) ([]int64, []string, .uverse.error); OracleConsult func(string, uint32) (int32, *gno.land/p/gnoswap/uint256/v1.Uint, .uverse.error); Render func(string) string; SetFeeProtocol func(int, .uverse.realm, uint8, uint8); SetPoolCreationFee func(int, .uverse.realm, int64); SetSwapEndHook func(int, .uverse.realm, func(.uverse.realm, string) .uverse.error); SetSwapStartHook func(int, .uverse.realm, func(.uverse.realm, string, int64)); SetTickCrossHook func(int, .uverse.realm, func(.uverse.realm, string, int32, bool, int64)); SetWithdrawalFee func(int, .uverse.realm, uint64); SnapshotCumulativesInside func(string, int32, int32) (int64, *gno.land/p/gnoswap/uint256/v1.Uint, uint32, .uverse.error); Swap func(int, .uverse.realm, string, string, uint32, .uverse.address, bool, string, string, func(.uverse.realm, int64, int64, *gno.land/r/gnoswap/pool.CallbackMarker) .uverse.error) (string, string)}
NewTickEventInfo(tickID int32, tickInfo struct{liquidityGross string; liquidityNet string; feeGrowthOutside0X128 string; feeGrowthOutside1X128 string; tickCumulativeOutside int64; secondsPerLiquidityOutsideX128 string; secondsOutside uint32; initialized bool}) *gno.land/r/gnoswap/pool/v1.tickEventInfo

Signatures reconstructed verbatim from vm/qfuncs — interface params keep their inline definitions.

Rendered

Rendered Raw gnoweb ↗

This realm does not provide renderable output (vm/qrender → NoRenderDeclError). View on gnoweb ↗

vm/qrender output, sanitized (docs/render-security.md) and displayed in an empty-sandbox iframe — scripts, forms and popups cannot run. Links stay inert in-preview; right-click to open.

9// bitMask8 is used for efficient modulo 256 operations

10const bitMask8 = 0xff // 256 - 1

12// tickBitmapFlipTick flips the state of a tick in the tick bitmap.

14// This function toggles the "initialized" state of a tick in the tick bitmap.

15// It ensures that the tick aligns with the specified tick spacing and then

16// flips the corresponding bit in the bitmap representation.

19// - tick: int32, the tick index to toggle.

20// - tickSpacing: int32, the spacing between valid ticks.

21// The tick must align with this spacing.

24// 1. Validates that the `tick` aligns with `tickSpacing` using `checkTickSpacing`.

25// 2. Computes the position of the bit in the tick bitmap:

26// - `wordPos`: Determines which word in the bitmap contains the bit.

27// - `bitPos`: Identifies the position of the bit within the word.

28// 3. Creates a bitmask using `Lsh` (Left Shift) to target the bit at `bitPos`.

29// 4. Toggles (flips) the bit using XOR with the current value of the tick bitmap.

30// 5. Updates the tick bitmap with the modified word.

33// - If the bit is `0` (uninitialized), it will be flipped to `1` (initialized).

34// - If the bit is `1` (initialized), it will be flipped to `0` (uninitialized).

38// pool.tickBitmapFlipTick(120, 60)

39// // This flips the bit for tick 120 with a tick spacing of 60.

42// - The `tick` must be divisible by `tickSpacing`. If not, the function will panic.

43func tickBitmapFlipTick(

46 tickSpacing int32,

48 checkTickSpacing(tick, tickSpacing)

49 wordPos, bitPos := tickBitmapPosition(tick / tickSpacing)

51 mask := u256.Zero().Lsh(u256.One(), uint(bitPos))

52 current := getTickBitmap(p, wordPos)

53 next := u256.Zero().Xor(current, mask)

54 if next.IsZero() {

55 deleteTickBitmap(p, wordPos)

59 setTickBitmap(p, wordPos, next)

62// tickBitmapNextInitializedTickWithInOneWord finds the next initialized tick within

63// one word of the bitmap.

64func tickBitmapNextInitializedTickWithInOneWord(

67 tickSpacing int32,

70 compress := tick / tickSpacing

71 // Round towards negative infinity for negative ticks

72 if tick < 0 && tick%tickSpacing != 0 {

76 wordPos, bitPos := getWordAndBitPos(compress, lte)

77 mask := getMaskBit(uint(bitPos), lte)

78 masked := u256.Zero().And(getTickBitmap(p, wordPos), mask)

79 initialized := !masked.IsZero()

81 nextTick := getNextTick(lte, initialized, compress, bitPos, tickSpacing, masked)

82 return nextTick, initialized

85// getTickBitmap gets the tick bitmap for the given word position.

86// Missing words are implicit zeroes.

87func getTickBitmap(p *pl.Pool, wordPos int16) *u256.Uint {

88 value, exist := p.TickBitmaps()[wordPos]

90 return u256.Zero()

93 return u256.MustFromDecimal(value)

96// setTickBitmap sets the tick bitmap for the given word position.

97func setTickBitmap(p *pl.Pool, wordPos int16, tickBitmap *u256.Uint) {

98 p.SetTickBitmap(wordPos, tickBitmap.ToString())

101// deleteTickBitmap deletes the tick bitmap for the given word position.

102func deleteTickBitmap(p *pl.Pool, wordPos int16) {

103 p.DeleteTickBitmap(wordPos)

106// tickBitmapPosition calculates the word and bit position for a given tick

107func tickBitmapPosition(tick int32) (int16, uint8) {

108 return int16(tick >> 8), uint8(tick) & bitMask8

111// getWordAndBitPos gets tick's wordPos and bitPos depending on the swap direction

112func getWordAndBitPos(tick int32, lte bool) (int16, uint8) {

116 return tickBitmapPosition(tick)

119// getMaskBit generates a mask based on the provided bit position (bitPos) and a boolean flag (lte).

120// The function constructs a bitmask with a shift depending on the bit position and the boolean value.

121// It either returns the mask or its negation, based on the value of 'lte' (swap direction).

123// NOTE: should always use a newly created `u256.One()` object.

124func getMaskBit(bitPos uint, lte bool) *u256.Uint {

126 if bitPos == bitMask8 {

127 return u256.Zero().SetAllOne()

129 return u256.Zero().Sub(u256.Zero().Lsh(u256.One(), bitPos+1), u256.One())

131 if bitPos == 0 {

132 return u256.Zero().SetAllOne()

134 return u256.Zero().Not(u256.Zero().Sub(u256.Zero().Lsh(u256.One(), bitPos), u256.One()))

137// getNextTick gets the next tick depending on the initialized state and the swap direction

138func getNextTick(lte, initialized bool, compress int32, bitPos uint8, tickSpacing int32, masked *u256.Uint) int32 {

139 if initialized {

140 return getTickIfInitialized(compress, tickSpacing, bitPos, masked, lte)

142 return getTickIfNotInitialized(compress, tickSpacing, bitPos, lte)

145// getTickIfInitialized gets the next tick if the tick bitmap is initialized

146func getTickIfInitialized(compress, tickSpacing int32, bitPos uint8, masked *u256.Uint, lte bool) int32 {

148 return (compress - int32(bitPos-gnsmath.BitMathMostSignificantBit(masked))) * tickSpacing

150 return (compress + 1 + int32(gnsmath.BitMathLeastSignificantBit(masked)-bitPos)) * tickSpacing

153// getTickIfNotInitialized gets the next tick if the tick bitmap is not initialized

154func getTickIfNotInitialized(compress, tickSpacing int32, bitPos uint8, lte bool) int32 {

156 return (compress - int32(bitPos)) * tickSpacing

158 return (compress + 1 + int32(bitMask8-bitPos)) * tickSpacing

gno.land/r/gnoswap/pool/v1⧉

gno.land/r/gnoswap/pool/v1