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)

type.gnogno

1package pool23import (4	"gno.land/p/gnoswap/gnsmath/v1"5	i256 "gno.land/p/gnoswap/int256/v1"6	u256 "gno.land/p/gnoswap/uint256/v1"78

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.

pl "gno.land/r/gnoswap/pool"

11// ModifyPositionParams repersents the parameters for modifying a liquidity position.

12// This structure is used internally both `Mint` and `Burn` operation to manage

13// the liquidity positions.

14type ModifyPositionParams struct {

15 // owner is the address that owns the position

18 // tickLower and atickUpper define the price range

19 // The actual price range is calculated as 1.0001^tick

20 // This allows for precision in price range while using integer math.

22 tickLower int32 // lower tick of the position

23 tickUpper int32 // upper tick of the position

25 // liquidityDelta represents the change in liquidity

26 // Positive for minting, negative for burning

27 liquidityDelta *i256.Int

30// newModifyPositionParams creates a new `ModifyPositionParams` instance.

31// This is used to preare parameters for the `modifyPosition` function,

32// which handles both minting and burning of liquidity positions.

35// - owner: address that will own (or owns) the position

36// - tickLower: lower tick bound of the position

37// - tickUpper: upper tick bound of the position

38// - liquidityDelta: amount of liquidity to add (positive) or remove (negative)

40// The tick parameters represent prices as powers of 1.0001:

41// - actual_price = 1.0001^tick

42// - For example, tick = 100 means price = 1.0001^100

45// - ModifyPositionParams: a new instance of ModifyPositionParams

46func newModifyPositionParams(

50 liquidityDelta *i256.Int,

51) ModifyPositionParams {

52 return ModifyPositionParams{

54 tickLower: tickLower,

55 tickUpper: tickUpper,

56 liquidityDelta: liquidityDelta,

60// SwapCache holds immutable swap-start inputs and oracle cumulatives that are

61// populated lazily when the swap first crosses an initialized tick.

62type SwapCache struct {

63 feeProtocol uint8 // protocol fee for the input token

64 liquidityStart *u256.Uint // liquidity at the beginning of the swap

65 blockTimestamp int64 // current block timestamp

66 tickCumulative int64 // current tick accumulator value

67 secondsPerLiquidityCumulativeX128 *u256.Uint // current seconds per liquidity accumulator

68 computedLatestObservation bool // whether we've computed the above accumulators

69 slot0Start pl.Slot0 // immutable Slot0 snapshot captured at swap start

70 readOnly bool // quote without tick accounting or hooks

73func newSwapCache(

74 feeProtocol uint8,

75 liquidityStart *u256.Uint,

76 blockTimestamp int64,

77 slot0Start pl.Slot0,

79 return &SwapCache{

80 feeProtocol: feeProtocol,

81 liquidityStart: liquidityStart,

82 blockTimestamp: blockTimestamp,

83 tickCumulative: 0,

84 secondsPerLiquidityCumulativeX128: u256.Zero(),

85 computedLatestObservation: false,

86 slot0Start: slot0Start.Clone(),

90// SwapState tracks the changing values during a swap.

91// This type helps manage the state transitions that occur as the swap progresses

92// across different price ranges.

93type SwapState struct {

94 amountSpecifiedRemaining *i256.Int // amount remaining to be swapped in/out of the input/output token

95 amountCalculated *i256.Int // amount already swapped out/in of the output/input token

96 sqrtPriceX96 *u256.Uint // current sqrt(price)

97 tick int32 // tick associated with the current sqrt(price)

98 feeGrowthGlobalX128 *u256.Uint // global fee growth of the input token

99 protocolFee *u256.Uint // amount of input token paid as protocol fee

100 liquidity *u256.Uint // current liquidity in range

103func newSwapState(

104 amountSpecifiedRemaining *i256.Int,

105 feeGrowthGlobalX128 *u256.Uint,

106 liquidity *u256.Uint,

109 return SwapState{

110 amountSpecifiedRemaining: amountSpecifiedRemaining,

111 amountCalculated: i256.Zero(),

112 sqrtPriceX96: slot0.SqrtPriceX96(),

113 tick: slot0.Tick(),

114 feeGrowthGlobalX128: feeGrowthGlobalX128,

115 protocolFee: u256.Zero(),

116 liquidity: liquidity,

120func (s *SwapState) setSqrtPriceX96(sqrtPriceX96 *u256.Uint) {

121 s.sqrtPriceX96 = sqrtPriceX96.Clone()

124func (s *SwapState) setTick(tick int32) {

128func (s *SwapState) setFeeGrowthGlobalX128(feeGrowthGlobalX128 *u256.Uint) {

129 s.feeGrowthGlobalX128 = feeGrowthGlobalX128

132func (s *SwapState) setProtocolFee(fee *u256.Uint) {

133 s.protocolFee = fee

136// StepComputations holds intermediate values used during a single step of a swap.

137// Each step represents movement from the current tick to the next initialized tick

138// or the target price, whichever comes first.

139type StepComputations struct {

140 sqrtPriceStartX96 *u256.Uint // price at the beginning of the step

141 tickNext int32 // next tick to swap to from the current tick in the swap direction

142 initialized bool // whether tickNext is initialized

143 sqrtPriceNextX96 *u256.Uint // sqrt(price) for the next tick (token1/token0) Q96

144 amountIn *u256.Uint // how much being swapped in this step

145 amountOut *u256.Uint // how much is being swapped out in this step

146 feeAmount *u256.Uint // how much fee is being paid in this step

149// init initializes the computation for a single swap step

150func (step *StepComputations) initSwapStep(state SwapState, p *pl.Pool, zeroForOne bool) {

151 step.sqrtPriceStartX96 = state.sqrtPriceX96

152 step.tickNext, step.initialized = tickBitmapNextInitializedTickWithInOneWord(

155 p.TickSpacing(),

159 // prevent overshoot the min/max tick

160 step.clampTickNext()

162 // get the price for the next tick

163 step.sqrtPriceNextX96 = gnsmath.TickMathGetSqrtRatioAtTick(step.tickNext)

166// clampTickNext ensures that `tickNext` stays within the min, max tick boundaries

167// as the tick bitmap is not aware of these bounds

168func (step *StepComputations) clampTickNext() {

169 if step.tickNext < MIN_TICK {

170 step.tickNext = MIN_TICK

171 } else if step.tickNext > MAX_TICK {

172 step.tickNext = MAX_TICK

176func newPool(poolInfo *poolCreateConfig) *pl.Pool {

177 tick := gnsmath.TickMathGetTickAtSqrtRatio(poolInfo.SqrtPriceX96())

179 return pl.NewPool(

180 poolInfo.Token0Path(),

181 poolInfo.Token1Path(),

183 poolInfo.SqrtPriceX96(),

184 poolInfo.TickSpacing(),

186 poolInfo.slot0FeeProtocol,

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

gno.land/r/gnoswap/pool/v1