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)

protocol_fee.gnogno

1package pool23import (4	"chain"5	"errors"67	"gno.land/p/gnoswap/gnsmath/v1"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.

prabc "gno.land/p/gnoswap/rbac/v1"

9 u256 "gno.land/p/gnoswap/uint256/v1"

10 "gno.land/p/gnoswap/utils/v1"

11 ufmt "gno.land/p/nt/ufmt/v0"

13 "gno.land/r/gnoswap/access/v1"

14 "gno.land/r/gnoswap/common"

15 "gno.land/r/gnoswap/halt/v1"

16 pf "gno.land/r/gnoswap/protocol_fee"

20 MaxBpsValue = uint64(1000) // 10%

21 ZeroBps = uint64(0)

24// deductWithdrawalFee splits amount into the fee withheld for the protocol and

25// the remainder paid out to the collector.

27// Rounding favours the collector: the fee is truncated. The two results always

28// sum back to amount, so a caller that debits amount and pays out

29// amountAfterFee never leaves the pool short.

30func deductWithdrawalFee(amount int64, withdrawalFeeBPS uint64) (feeAmount, amountAfterFee int64) {

31 if amount <= 0 || withdrawalFeeBPS == ZeroBps {

35 fee, afterFee := calculateAmountWithFee(

36 u256.NewUint(uint64(amount)),

37 u256.NewUint(withdrawalFeeBPS),

40 return gnsmath.SafeConvertToInt64(fee), gnsmath.SafeConvertToInt64(afterFee)

43// GetPendingProtocolFees returns the pending protocol fee amount per token path.

46// - map[string]int64: Pending protocol fee amounts keyed by token contract

47// path, with values in token base units.

48func (i *poolV1) GetPendingProtocolFees() map[string]int64 {

49 return i.store.GetPendingProtocolFees()

52func (i *poolV1) addPendingProtocolFee(_ int, rlm realm, tokenPath string, amount int64) {

57 pendingAmount := gnsmath.SafeAddInt64(i.store.GetPendingProtocolFee(tokenPath), amount)

58 if err := i.store.SetPendingProtocolFee(0, rlm, tokenPath, pendingAmount); err != nil {

63// settleProtocolFee forwards amount, plus anything already pending for tokenPath, to

64// the protocol fee realm. When collection is halted or the transfer fails, the amount

65// is recorded as pending instead and settled by a later call for the same token, which

66// every fee path makes even when the fee is zero.

68// Only tokenPath is touched, so an unrelated token can never block settlement. The

69// pending entry is written only when the fee cannot be forwarded, so the common path

70// performs no store write at all.

71func (i *poolV1) settleProtocolFee(_ int, rlm realm, tokenPath string, amount int64) {

72 if halt.IsHaltedProtocolFee() {

73 i.addPendingProtocolFee(0, rlm, tokenPath, amount)

77 pendingAmount := i.store.GetPendingProtocolFee(tokenPath)

78 totalAmount := gnsmath.SafeAddInt64(pendingAmount, amount)

80 if totalAmount > 0 {

81 protocolFeeAddr := access.MustGetAddress(prabc.ROLE_PROTOCOL_FEE.String())

82 common.SafeGRC20Approve(0, rlm, tokenPath, protocolFeeAddr, totalAmount)

84 // AddToProtocolFee only reports an error for a halted realm, which is handled

85 // above. The branch keeps the amount pending should that ever change, and

86 // withdraws the approval so no unspent allowance outlives the call.

87 if err := pf.AddToProtocolFee(cross(rlm), tokenPath, totalAmount); err != nil {

88 common.SafeGRC20Approve(0, rlm, tokenPath, protocolFeeAddr, 0)

89 i.addPendingProtocolFee(0, rlm, tokenPath, amount)

94 if err := i.store.RemovePendingProtocolFee(0, rlm, tokenPath); err != nil {

99// SetPoolCreationFee sets the poolCreationFee.

100// Only admin or governance can call this function.

103// - _: Leading integer discriminator for the forwarded realm call; callers

105// - rlm: Propagated realm context validated as current before the fee is

107// - fee: New non-negative pool creation fee in configured native-token base

109func (i *poolV1) SetPoolCreationFee(_ int, rlm realm, fee int64) {

110 access.AssertIsRlmCurrent(0, rlm)

112 i.assertPoolUnlocked()

113 halt.AssertIsNotHaltedPool()

115 previousRealm := rlm.Previous()

116 caller := previousRealm.Address()

117 access.AssertIsAdminOrGovernance(caller)

119 i.lockPool(0, rlm)

120 defer i.unlockPool(0, rlm)

122 prevPoolCreationFee := i.store.GetPoolCreationFee()

123 err := i.setPoolCreationFee(0, rlm, fee)

129 "SetPoolCreationFee",

130 "prevAddr", caller.String(),

131 "prevRealm", previousRealm.PkgPath(),

132 "prevFee", utils.FormatInt(prevPoolCreationFee),

133 "newFee", utils.FormatInt(fee),

137// SetWithdrawalFee sets the withdrawal fee.

138// Only admin or governance can call this function.

141// - _: Leading integer discriminator for the forwarded realm call; callers

143// - rlm: Propagated realm context validated as current before the fee is

145// - fee: New withdrawal fee in basis points; the setter accepts 0 through

146// 1,000 (10%) inclusive.

147func (i *poolV1) SetWithdrawalFee(_ int, rlm realm, fee uint64) {

148 access.AssertIsRlmCurrent(0, rlm)

150 i.assertPoolUnlocked()

151 halt.AssertIsNotHaltedPool()

153 previousRealm := rlm.Previous()

154 caller := previousRealm.Address()

155 access.AssertIsAdminOrGovernance(caller)

157 i.lockPool(0, rlm)

158 defer i.unlockPool(0, rlm)

160 prevWithdrawalFee := i.store.GetWithdrawalFeeBPS()

162 err := i.setWithdrawalFee(0, rlm, fee)

168 "SetWithdrawalFee",

169 "prevAddr", caller.String(),

170 "prevRealm", previousRealm.PkgPath(),

171 "prevFee", utils.FormatUint(prevWithdrawalFee),

172 "newFee", utils.FormatUint(fee),

176// calculateAmountWithFee calculates the fee amount and the amount after the fee

179// - amount: the amount before the fee

180// - fee: the fee in BPS

183// - the fee amount

184// - the amount after the fee applied

185func calculateAmountWithFee(amount, fee *u256.Uint) (feeAmount, afterAmount *u256.Uint) {

186 feeAmount, overflow := u256.Zero().MulOverflow(amount, fee)

188 panic(errors.New(errOverflow))

190 feeAmount = u256.Zero().Div(feeAmount, u256.NewUint(10_000))

191 afterAmount = u256.Zero().Sub(amount, feeAmount)

192 return feeAmount, afterAmount

195// setPoolCreationFee this function is internal function called by SetPoolCreationFee

196// And SetPoolCreationFee

197func (i *poolV1) setPoolCreationFee(_ int, rlm realm, fee int64) error {

199 return makeErrorWithDetails(

200 errInvalidInput,

201 "pool creation fee cannot be negative",

205 // update pool creation fee

206 err := i.store.SetPoolCreationFee(0, rlm, fee)

214// setWithdrawalFee this function is internal function called by SetWithdrawalFee

215// function and SetWithdrawalFee function

216func (i *poolV1) setWithdrawalFee(_ int, rlm realm, fee uint64) error {

217 if fee > MaxBpsValue {

218 return makeErrorWithDetails(

219 errInvalidWithdrawalFeePct,

220 ufmt.Sprintf("fee(%d) must be in range 0 ~ %d", fee, MaxBpsValue),

224 err := i.store.SetWithdrawalFeeBPS(0, rlm, fee)

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

gno.land/r/gnoswap/pool/v1