refactor(position): Position

_deploy/r/gnoswap/consts/consts.gno

@@ -18,6 +18,7 @@ const (
 // WRAP & UNWRAP
 const (
 	GNOT           string = "gnot"
+	UGNOT          string = "ugnot"
 	WRAPPED_WUGNOT string = "gno.land/r/demo/wugnot"
 
 	// defined in https://github.com/gnolang/gno/blob/81a88a2976ba9f2f9127ebbe7fb7d1e1f7fa4bd4/examples/gno.land/r/demo/wugnot/wugnot.gno#L19

pool/_helper_test.gno

@@ -33,13 +33,17 @@ const (
 	oblPath    string = "gno.land/r/onbloc/obl"
 	quxPath    string = "gno.land/r/onbloc/qux"
 
-	fee100      uint32 = 100
-	fee500      uint32 = 500
-	fee3000     uint32 = 3000
-	maxApprove  uint64 = 18446744073709551615
-	max_timeout int64  = 9999999999
-
+	fee100               uint32 = 100
+	fee500               uint32 = 500
+	fee3000              uint32 = 3000
+	fee10000             uint32 = 10000
+	maxApprove           uint64 = 18446744073709551615
+	max_timeout          int64  = 9999999999
 	maxSqrtPriceLimitX96 string = "1461446703485210103287273052203988822378723970341"
+
+	TIER_1 uint64 = 1
+	TIER_2 uint64 = 2
+	TIER_3 uint64 = 3
 )
 
 const (
@@ -52,6 +56,7 @@ var (
 	admin       = pusers.AddressOrName(consts.ADMIN)
 	alice       = pusers.AddressOrName(testutils.TestAddress("alice"))
 	pool        = pusers.AddressOrName(consts.POOL_ADDR)
+	bob         = pusers.AddressOrName(testutils.TestAddress("bob"))
 	protocolFee = pusers.AddressOrName(consts.PROTOCOL_FEE_ADDR)
 	router      = pusers.AddressOrName(consts.ROUTER_ADDR)
 	adminRealm  = std.NewUserRealm(users.Resolve(admin))
@@ -187,6 +192,22 @@ func TokenApprove(t *testing.T, tokenPath string, owner, spender pusers.AddressO
 	}
 }
 
+func CreatePool(t *testing.T,
+	token0 string,
+	token1 string,
+	fee uint32,
+	sqrtPriceX96 string,
+	caller std.Address) {
+	t.Helper()
+
+	std.TestSetRealm(std.NewUserRealm(caller))
+	poolPath := pl.GetPoolPath(token0, token1, fee)
+	if !pl.DoesPoolPathExist(poolPath) {
+		pl.CreatePool(token0, token1, fee, sqrtPriceX96)
+		sr.SetPoolTierByAdmin(poolPath, TIER_1)
+	}
+}
+
 func MintPosition(t *testing.T,
 	token0 string,
 	token1 string,
@@ -373,6 +394,54 @@ func MintPositionAll(t *testing.T, caller std.Address) {
 
 }
 
+func MakeMintPositionWithoutFee(t *testing.T) (uint64, string, string, string) {
+	t.Helper()
+
+	// make actual data to test resetting not only position's state but also pool's state
+	std.TestSetRealm(adminRealm)
+
+	// set pool create fee to 0 for testing
+	pl.SetPoolCreationFeeByAdmin(0)
+	CreatePool(t, barPath, fooPath, fee500, common.TickMathGetSqrtRatioAtTick(0).ToString(), users.Resolve(admin))
+
+	TokenApprove(t, barPath, admin, pool, consts.UINT64_MAX)
+	TokenApprove(t, fooPath, admin, pool, consts.UINT64_MAX)
+
+	// mint position
+	return Mint(
+		barPath,
+		fooPath,
+		fee500,
+		-887270,
+		887270,
+		"50000",
+		"50000",
+		"0",
+		"0",
+		max_timeout,
+		users.Resolve(admin),
+		users.Resolve(admin),
+	)
+}
+
+func LPTokenApprove(t *testing.T, owner, operator pusers.AddressOrName, tokenId uint64) {
+	t.Helper()
+	std.TestSetRealm(std.NewUserRealm(users.Resolve(owner)))
+	gnft.Approve(operator, tokenIdFrom(tokenId))
+}
+
+func LPTokenStake(t *testing.T, owner pusers.AddressOrName, tokenId uint64) {
+	t.Helper()
+	std.TestSetRealm(std.NewUserRealm(users.Resolve(owner)))
+	sr.StakeToken(tokenId)
+}
+
+func LPTokenUnStake(t *testing.T, owner pusers.AddressOrName, tokenId uint64, unwrap bool) {
+	t.Helper()
+	std.TestSetRealm(std.NewUserRealm(users.Resolve(owner)))
+	sr.UnstakeToken(tokenId, unwrap)
+}
+
 func wugnotApprove(t *testing.T, owner, spender pusers.AddressOrName, amount uint64) {
 	t.Helper()
 	std.TestSetRealm(std.NewUserRealm(users.Resolve(owner)))
@@ -569,7 +638,17 @@ func burnUsdc(addr pusers.AddressOrName) {
 	usdc.Burn(addr, usdc.BalanceOf(addr))
 }
 
-func TestBeforeResetObject(t *testing.T) {
+// burnAllNFT burns all NFTs
+func burnAllNFT(t *testing.T) {
+	t.Helper()
+
+	std.TestSetRealm(std.NewCodeRealm(consts.POSITION_PATH))
+	for i := uint64(1); i <= gnft.TotalSupply(); i++ {
+		gnft.Burn(tokenIdFrom(i))
+	}
+}
+
+func TestBeforeResetPoolObject(t *testing.T) {
 	// make some data
 	pools = avl.NewTree()
 	pools.Set("gno.land/r/gnoswap/v1/gns:gno.land/r/onbloc/usdc", &Pool{
@@ -604,3 +683,8 @@ func TestBurnTokens(t *testing.T) {
 	uassert.Equal(t, foo.BalanceOf(a2u(addr01)), uint64(0)) // 100_000_000 -> 0
 	uassert.Equal(t, bar.BalanceOf(a2u(addr01)), uint64(0)) // 100_000_000 -> 0
 }
+
+func TestBurnAllNFT(t *testing.T) {
+	burnAllNFT(t)
+	uassert.Equal(t, gnft.TotalSupply(), uint64(0), "gnft total supply should be 0")
+}

pool/position.gno

@@ -77,7 +77,7 @@ func positionUpdate(
 		if position.liquidity.IsZero() {
 			panic(addDetailToError(
 				errZeroLiquidity,
-				"position.gno__positionUpdate() || both liquidityDelta and current position's liquidity are zero",
+				"both liquidityDelta and current position's liquidity are zero",
 			))
 		}
 

pool/position_test.gno

@@ -75,7 +75,7 @@ func TestPositionUpdateWithKey(t *testing.T) {
 		panicMsg          string
 		expectedLiquidity string
 	}{
-		{i256.MustFromDecimal("0"), u256.Zero(), u256.Zero(), true, `[GNOSWAP-POOL-010] zero liquidity || position.gno__positionUpdate() || both liquidityDelta and current position's liquidity are zero`, ""},
+		{i256.MustFromDecimal("0"), u256.Zero(), u256.Zero(), true, `[GNOSWAP-POOL-010] zero liquidity || both liquidityDelta and current position's liquidity are zero`, ""},
 		{i256.MustFromDecimal("100000"), u256.Zero(), u256.Zero(), false, "", "100000"},
 	}
 
@@ -109,7 +109,7 @@ func TestPositionUpdate(t *testing.T) {
 			feeGrowthInside0X128: u256.Zero(),
 			feeGrowthInside1X128: u256.Zero(),
 			shouldPanic:          true,
-			panicMsg:             `[GNOSWAP-POOL-010] zero liquidity || position.gno__positionUpdate() || both liquidityDelta and current position's liquidity are zero`,
+			panicMsg:             `[GNOSWAP-POOL-010] zero liquidity || both liquidityDelta and current position's liquidity are zero`,
 		},
 		{
 			initialLiquidity:             u256.Zero(),

pool/tests/__TEST_pool_spec_#6_test.gnoA

@@ -81,7 +81,7 @@ func TestPokeIsNotAllowedOnUninitilaizedPosition(t *testing.T) {
 	std.TestSetRealm(posRealm)
 	uassert.PanicsWithMessage(
 		t,
-		`[GNOSWAP-POOL-010] zero liquidity || position.gno__positionUpdate() || both liquidityDelta and (self)liquidity are zero`,
+		`[GNOSWAP-POOL-010] zero liquidity || both liquidityDelta and (self)liquidity are zero`,
 		func() {
 			Burn(
 				barPath,

position/_GET_no_receiver.gno

@@ -12,51 +12,62 @@ import (
 
 // type Position
 func PositionGetPosition(tokenId uint64) Position {
-	return positions[tokenId]
+	position, _ := GetPosition(tokenId)
+	return position
 }
 
 func PositionGetPositionNonce(tokenId uint64) *u256.Uint {
-	return positions[tokenId].nonce
+	position := MustGetPosition(tokenId)
+	return position.nonce
 }
 
 func PositionGetPositionOperator(tokenId uint64) std.Address {
-	return positions[tokenId].operator
+	position := MustGetPosition(tokenId)
+	return position.operator
 }
 
 func PositionGetPositionPoolKey(tokenId uint64) string {
-	return positions[tokenId].poolKey
+	position := MustGetPosition(tokenId)
+	return position.poolKey
 }
 
 func PositionGetPositionTickLower(tokenId uint64) int32 {
-	return positions[tokenId].tickLower
+	position := MustGetPosition(tokenId)
+	return position.tickLower
 }
 
 func PositionGetPositionTickUpper(tokenId uint64) int32 {
-	return positions[tokenId].tickUpper
+	position := MustGetPosition(tokenId)
+	return position.tickUpper
 }
 
 func PositionGetPositionLiquidity(tokenId uint64) *u256.Uint {
-	return positions[tokenId].liquidity
+	position := MustGetPosition(tokenId)
+	return position.liquidity
 }
 
 func PositionGetPositionFeeGrowthInside0LastX128(tokenId uint64) *u256.Uint {
-	return positions[tokenId].feeGrowthInside0LastX128
+	position := MustGetPosition(tokenId)
+	return position.feeGrowthInside0LastX128
 }
 
 func PositionGetPositionFeeGrowthInside1LastX128(tokenId uint64) *u256.Uint {
-	return positions[tokenId].feeGrowthInside1LastX128
+	position := MustGetPosition(tokenId)
+	return position.feeGrowthInside1LastX128
 }
 
 func PositionGetPositionTokensOwed0(tokenId uint64) *u256.Uint {
-	return positions[tokenId].tokensOwed0
+	position := MustGetPosition(tokenId)
+	return position.tokensOwed0
 }
 
 func PositionGetPositionTokensOwed1(tokenId uint64) *u256.Uint {
-	return positions[tokenId].tokensOwed1
+	position := MustGetPosition(tokenId)
+	return position.tokensOwed1
 }
 
 func PositionIsInRange(tokenId uint64) bool {
-	position := positions[tokenId]
+	position := MustGetPosition(tokenId)
 	poolPath := position.poolKey
 	poolCurrentTick := pl.PoolGetSlot0Tick(poolPath)
 

position/_GET_no_receiver_string.gno

@@ -2,25 +2,25 @@ package position
 
 // type Position
 func PositionGetPositionNonceStr(tokenId uint64) string {
-	return positions[tokenId].nonce.ToString()
+	return MustGetPosition(tokenId).nonce.ToString()
 }
 
 func PositionGetPositionLiquidityStr(tokenId uint64) string {
-	return positions[tokenId].liquidity.ToString()
+	return MustGetPosition(tokenId).liquidity.ToString()
 }
 
 func PositionGetPositionFeeGrowthInside0LastX128Str(tokenId uint64) string {
-	return positions[tokenId].feeGrowthInside0LastX128.ToString()
+	return MustGetPosition(tokenId).feeGrowthInside0LastX128.ToString()
 }
 
 func PositionGetPositionFeeGrowthInside1LastX128Str(tokenId uint64) string {
-	return positions[tokenId].feeGrowthInside1LastX128.ToString()
+	return MustGetPosition(tokenId).feeGrowthInside1LastX128.ToString()
 }
 
 func PositionGetPositionTokensOwed0Str(tokenId uint64) string {
-	return positions[tokenId].tokensOwed0.ToString()
+	return MustGetPosition(tokenId).tokensOwed0.ToString()
 }
 
 func PositionGetPositionTokensOwed1Str(tokenId uint64) string {
-	return positions[tokenId].tokensOwed1.ToString()
+	return MustGetPosition(tokenId).tokensOwed1.ToString()
 }