Merge pull request #414 from gnoswap-labs/refactor/pool_grc20reg

* GSW-1838 refactor: use grc20reg - use gno's grc20reg realm to support dynamic token transfer in pool * GSW-1838 feat: grc20reg - replace previous token_register to latest grc20reg * feat: update grc20 spec for grc20reg * hotfix: update bar token spec * feat: get token object from `grc20-reg` in `common` * fix: typo * chore: remove grc20reg - it's been merged into master of gnolang/gno * feat: get `token` and `teller` object from grc20reg * test: txtar for approve & transferfrom using grc20reg * feat: use teller to transfer token * feat: IsRegistered() to check if token is registered or not * refactor: remove old token_register * chore: rename teller * feat: guard logic to see if token is registered * feat: MustRegistered in common - if token is not registered, it will panic. * chore: rename * GSW-1838 fix: test errors are fixed (#422) * GSW-1838 fix: test errors are fixed - Integrate helper functions for tests - Change file extensions to prevent test code in the test folder from being executed - Fixing failure errors due to code integration - Known issue : Fixed additional test failure case related to getter * fix: remove time compare in unit test * fix: do not setup data in init * test: pool manger testcase --------- Co-authored-by: n3wbie <[email protected]> * GSW-1838 refactor: use grc20reg - use gno's grc20reg realm to support dynamic token transfer in pool * fix: gno.mod tidy * fix: missing guard logic for HandleWithdrawalFee * fix: failing testcase * fix: tc * feat: use teller to transfer/transferfrom * test: fix mocking old functions * test: remove hardcoded value * test: detail error message * fix: typo * remove: duplicate token register check * fix: typo * refactor: duplicate token register check - GetPoolPath has check function --------- Co-authored-by: 0xTopaz <[email protected]> Co-authored-by: 0xTopaz <[email protected]>
gnoswap-labs · Dec 11, 2024 · 78dfa75 · 78dfa75
2 parents c86dab4 + 2e656ad
commit 78dfa75
Show file tree

Hide file tree

Showing 15 changed files with 161 additions and 539 deletions.
diff --git a/_deploy/r/gnoswap/common/errors.gno b/_deploy/r/gnoswap/common/errors.gno
@@ -7,9 +7,10 @@ import (
 )
 
 var (
-	errNoPermission = errors.New("[GNOSWAP-COMMON-001] caller has no permission")
-	errHalted       = errors.New("[GNOSWAP-COMMON-002] halted")
-	errOutOfRange   = errors.New("[GNOSWAP-COMMON-003] value out of range")
+	errNoPermission  = errors.New("[GNOSWAP-COMMON-001] caller has no permission")
+	errHalted        = errors.New("[GNOSWAP-COMMON-002] halted")
+	errOutOfRange    = errors.New("[GNOSWAP-COMMON-003] value out of range")
+	errNotRegistered = errors.New("[GNOSWAP-COMMON-004] token is not registered")
 )
 
 func addDetailToError(err error, detail string) string {

diff --git a/_deploy/r/gnoswap/common/grc20reg_helper.gno b/_deploy/r/gnoswap/common/grc20reg_helper.gno
@@ -44,3 +44,14 @@ func IsRegistered(path string) error {
 	}
 	return nil
 }
+
+// MustRegistered is a helper function to check if token is registered to grc20reg
+// if token is not registered, it will panic
+func MustRegistered(path string) {
+	if err := IsRegistered(path); err != nil {
+		panic(addDetailToError(
+			errNotRegistered,
+			ufmt.Sprintf("token(%s) is not registered", path),
+		))
+	}
+}
diff --git a/_deploy/r/gnoswap/common/grc20reg_helper_test.gno b/_deploy/r/gnoswap/common/grc20reg_helper_test.gno
@@ -16,20 +16,20 @@ var (
 )
 
 func TestGetToken(t *testing.T) {
-	t.Run("registered(by default)", func(t *testing.T) {
+	t.Run("get regsitered token", func(t *testing.T) {
 		token := GetToken(tokenPath)
 		if token == nil {
-			t.Error("Expected non-nil teller for foo20")
+			t.Error("Expected non-nil token for foo20")
 		}
 	})
 
-	t.Run("not registered", func(t *testing.T) {
+	t.Run("get non registered token", func(t *testing.T) {
 		defer func() {
 			if r := recover(); r == nil {
 				t.Errorf("Expected panic for non-registered token")
 			}
 		}()
-		GetToken("not_registered")
+		GetToken("not_registered_token")
 	})
 }
 
@@ -75,20 +75,20 @@ func TestTokenMethod(t *testing.T) {
 }
 
 func TestGetTokenTeller(t *testing.T) {
-	t.Run("registered(by default)", func(t *testing.T) {
+	t.Run("get registered token teller", func(t *testing.T) {
 		teller := GetTokenTeller(tokenPath)
 		if teller == nil {
 			t.Error("Expected non-nil teller for foo20")
 		}
 	})
 
-	t.Run("not registered", func(t *testing.T) {
+	t.Run("get non registered token teller", func(t *testing.T) {
 		defer func() {
 			if r := recover(); r == nil {
-				t.Errorf("Expected panic for non-registered token")
+				t.Errorf("Expected panic for non-registered token teller")
 			}
 		}()
-		GetTokenTeller("not_registered")
+		GetTokenTeller("not_registered_teller")
 	})
 }
 
@@ -129,6 +129,26 @@ func TestTellerMethod(t *testing.T) {
 }
 
 func TestIsRegistered(t *testing.T) {
-	uassert.NoError(t, IsRegistered(tokenPath))
-	uassert.Error(t, IsRegistered("not_registered"))
+	t.Run("check if token is registered", func(t *testing.T) {
+		uassert.NoError(t, IsRegistered(tokenPath))
+	})
+
+	t.Run("check if token is not registered", func(t *testing.T) {
+		uassert.Error(t, IsRegistered("not_registered_token"))
+	})
+}
+
+func TestMustRegistered(t *testing.T) {
+	t.Run("must be registered", func(t *testing.T) {
+		MustRegistered(tokenPath)
+	})
+
+	t.Run("panic for non registered token", func(t *testing.T) {
+		defer func() {
+			if r := recover(); r == nil {
+				t.Errorf("Expected panic for non-registered token")
+			}
+		}()
+		MustRegistered("not_registered")
+	})
 }
diff --git a/pool/_helper_test.gno b/pool/_helper_test.gno
@@ -45,123 +45,6 @@ const (
 	addr02 = testutils.TestAddress("addr02")
 )
 
-type WugnotToken struct{}
-
-func (WugnotToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return wugnot.Transfer
-}
-func (WugnotToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return wugnot.TransferFrom
-}
-func (WugnotToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return wugnot.BalanceOf
-}
-func (WugnotToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return wugnot.Approve
-}
-
-type GNSToken struct{}
-
-func (GNSToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return gns.Transfer
-}
-func (GNSToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return gns.TransferFrom
-}
-func (GNSToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return gns.BalanceOf
-}
-func (GNSToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return gns.Approve
-}
-
-type BarToken struct{}
-
-func (BarToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return bar.Transfer
-}
-func (BarToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return bar.TransferFrom
-}
-func (BarToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return bar.BalanceOf
-}
-func (BarToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return bar.Approve
-}
-
-type BazToken struct{}
-
-func (BazToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return baz.Transfer
-}
-func (BazToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return baz.TransferFrom
-}
-func (BazToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return baz.BalanceOf
-}
-func (BazToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return baz.Approve
-}
-
-type FooToken struct{}
-
-func (FooToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return foo.Transfer
-}
-func (FooToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return foo.TransferFrom
-}
-func (FooToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return foo.BalanceOf
-}
-func (FooToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return foo.Approve
-}
-
-type OBLToken struct{}
-
-func (OBLToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return obl.Transfer
-}
-func (OBLToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return obl.TransferFrom
-}
-func (OBLToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return obl.BalanceOf
-}
-func (OBLToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return obl.Approve
-}
-
-type QuxToken struct{}
-
-func (QuxToken) Transfer() func(to pusers.AddressOrName, amount uint64) {
-	return qux.Transfer
-}
-func (QuxToken) TransferFrom() func(from, to pusers.AddressOrName, amount uint64) {
-	return qux.TransferFrom
-}
-func (QuxToken) BalanceOf() func(owner pusers.AddressOrName) uint64 {
-	return qux.BalanceOf
-}
-func (QuxToken) Approve() func(spender pusers.AddressOrName, amount uint64) {
-	return qux.Approve
-}
-
-func init() {
-	std.TestSetRealm(std.NewUserRealm(consts.TOKEN_REGISTER))
-
-	RegisterGRC20Interface(wugnotPath, WugnotToken{})
-	RegisterGRC20Interface(gnsPath, GNSToken{})
-	RegisterGRC20Interface(barPath, BarToken{})
-	RegisterGRC20Interface(bazPath, BazToken{})
-	RegisterGRC20Interface(fooPath, FooToken{})
-	RegisterGRC20Interface(oblPath, OBLToken{})
-	RegisterGRC20Interface(quxPath, QuxToken{})
-}
-
 var (
 	admin       = pusers.AddressOrName(consts.ADMIN)
 	alice       = pusers.AddressOrName(testutils.TestAddress("alice"))

diff --git a/pool/pool.gno b/pool/pool.gno
@@ -145,12 +145,18 @@ func Collect(
 	// Smallest of three: amount0Requested, position.tokensOwed0, pool.balances.token0
 	amount0Req := u256.MustFromDecimal(amount0Requested)
 	amount0, position.tokensOwed0, pool.balances.token0 = collectToken(amount0Req, position.tokensOwed0, pool.balances.token0)
-	transferByRegisterCall(pool.token0Path, recipient, amount0.Uint64())
+	token0 := common.GetTokenTeller(pool.token0Path)
+	checkTransferError(token0.Transfer(recipient, amount0.Uint64()))
 
 	// Smallest of three: amount0Requested, position.tokensOwed0, pool.balances.token0
 	amount1Req := u256.MustFromDecimal(amount1Requested)
 	amount1, position.tokensOwed1, pool.balances.token1 = collectToken(amount1Req, position.tokensOwed1, pool.balances.token1)
-	transferByRegisterCall(pool.token1Path, recipient, amount1.Uint64())
+
+	// Update state first then transfer
+	position.tokensOwed1 = new(u256.Uint).Sub(position.tokensOwed1, amount1)
+	pool.balances.token1 = new(u256.Uint).Sub(pool.balances.token1, amount1)
+	token1 := common.GetTokenTeller(pool.token1Path)
+	checkTransferError(token1.Transfer(recipient, amount1.Uint64()))
 
 	pool.positions[positionKey] = position
 
@@ -175,15 +181,15 @@ func collectToken(
 // SwapResult encapsulates all state changes that occur as a result of a swap
 // This type ensure all state transitions are atomic and can be applied at once.
 type SwapResult struct {
-	Amount0          *i256.Int
-	Amount1          *i256.Int
-	NewSqrtPrice     *u256.Uint
-	NewTick          int32
-	NewLiquidity     *u256.Uint
-	NewProtocolFees  ProtocolFees
+	Amount0              *i256.Int
+	Amount1              *i256.Int
+	NewSqrtPrice         *u256.Uint
+	NewTick              int32
+	NewLiquidity         *u256.Uint
+	NewProtocolFees      ProtocolFees
 	FeeGrowthGlobal0X128 *u256.Uint
 	FeeGrowthGlobal1X128 *u256.Uint
-	SwapFee          *u256.Uint
+	SwapFee              *u256.Uint
 }
 
 // SwapComputation encapsulates pure computation logic for swap
@@ -294,10 +300,11 @@ func Swap(
 // The function follows these state transitions:
 // 1. Initial State: Provided by `SwapComputation.InitialState`
 // 2. Stepping State: For each step:
-//    - Compute next tick and price target
-//    - Calculate amounts and fees
-//    - Update state (remaining amount, fees, liquidity)
-//    - Handle tick transitions if necessary
+//   - Compute next tick and price target
+//   - Calculate amounts and fees
+//   - Update state (remaining amount, fees, liquidity)
+//   - Handle tick transitions if necessary
+//
 // 3. Final State: Aggregated in SwapResult
 //
 // The computation continues until either:
@@ -309,7 +316,6 @@ func computeSwap(pool *Pool, comp SwapComputation) (*SwapResult, error) {
 	state := comp.InitialState
 	swapFee := u256.Zero()
 
-
 	var newFee *u256.Uint
 	var err error
 
@@ -342,7 +348,7 @@ func computeSwap(pool *Pool, comp SwapComputation) (*SwapResult, error) {
 		},
 		FeeGrowthGlobal0X128: pool.feeGrowthGlobal0X128,
 		FeeGrowthGlobal1X128: pool.feeGrowthGlobal1X128,
-		SwapFee:          swapFee,
+		SwapFee:              swapFee,
 	}
 
 	// Update protocol fees if necessary
@@ -377,6 +383,7 @@ func applySwapResult(pool *Pool, result *SwapResult) {
 // For zeroForOne (selling token0):
 //   - Price limit must be below current price
 //   - Price limit must be above MIN_SQRT_RATIO
+//
 // For !zeroForOne (selling token1):
 //   - Price limit must be above current price
 //   - Price limit must be below MAX_SQRT_RATIO
@@ -562,6 +569,7 @@ func computeAmounts(state SwapState, sqrtRatioTargetX96 *u256.Uint, pool *Pool,
 // For exact input swaps:
 //   - Decrements remaining input amount by (amountIn + feeAmount)
 //   - Decrements calculated amount by amountOut
+//
 // For exact output swaps:
 //   - Increments remaining output amount by amountOut
 //   - Increments calculated amount by (amountIn + feeAmount)
@@ -717,9 +725,12 @@ func CollectProtocolByAdmin(
 	token1Path string,
 	fee uint32,
 	recipient std.Address,
-	amount0Requested string,
-	amount1Requested string,
-) (string, string) {
+	amount0Requested string, // uint128
+	amount1Requested string, // uint128
+) (string, string) { // uint128 x2
+	common.MustRegistered(token0Path)
+	common.MustRegistered(token1Path)
+
 	caller := std.PrevRealm().Addr()
 	if err := common.AdminOnly(caller); err != nil {
 		panic(err)
@@ -759,9 +770,12 @@ func CollectProtocol(
 	token1Path string,
 	fee uint32,
 	recipient std.Address,
-	amount0Requested string,
-	amount1Requested string,
-) (string, string) {
+	amount0Requested string, // uint128
+	amount1Requested string, // uint128
+) (string, string) { // uint128 x2
+	common.MustRegistered(token0Path)
+	common.MustRegistered(token1Path)
+
 	caller := std.PrevRealm().Addr()
 	if err := common.GovernanceOnly(caller); err != nil {
 		panic(err)
@@ -814,8 +828,11 @@ func collectProtocol(
 	uAmount0 := amount0.Uint64()
 	uAmount1 := amount1.Uint64()
 
-	transferByRegisterCall(pool.token0Path, recipient, uAmount0)
-	transferByRegisterCall(pool.token1Path, recipient, uAmount1)
+	token0Teller := common.GetTokenTeller(pool.token0Path)
+	checkTransferError(token0Teller.Transfer(recipient, uAmount0))
+
+	token1Teller := common.GetTokenTeller(pool.token1Path)
+	checkTransferError(token1Teller.Transfer(recipient, uAmount1))
 
 	return amount0.ToString(), amount1.ToString()
 }
@@ -866,7 +883,8 @@ func (pool *Pool) transferAndVerify(
 		panic(err)
 	}
 
-	transferByRegisterCall(tokenPath, to, amountUint64)
+	token := common.GetTokenTeller(tokenPath)
+	checkTransferError(token.Transfer(to, amountUint64))
 
 	newBalance, err := updatePoolBalance(token0, token1, absAmount, isToken0)
 	if err != nil {
@@ -943,12 +961,8 @@ func (pool *Pool) transferFromAndVerify(
 		panic(err)
 	}
 
-	// try sending
-	// will panic if following conditions are met:
-	// - POOL does not have enough approved amount
-	// - from does not have enough balance
-	// - token is not registered
-	transferFromByRegisterCall(tokenPath, from, to, amountUint64)
+	token := common.GetTokenTeller(tokenPath)
+	checkTransferError(token.TransferFrom(from, to, amountUint64))
 
 	// update pool balances
 	if isToken0 {