ci: update reciprocalAmount logic based on feedback (#34)

pancakeswap · Jun 6, 2024 · a916fab · a916fab
1 parent 60aeb60
commit a916fab
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 59 deletions.
diff --git a/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromBob.snap b/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromBob.snap
@@ -1 +1 @@
-54399
+54579
diff --git a/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromOwner.snap b/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromOwner.snap
@@ -1 +1 @@
-52767
+52095
diff --git a/.forge-snapshots/BinFungibleTokenTest#testBurn.snap b/.forge-snapshots/BinFungibleTokenTest#testBurn.snap
@@ -1 +1 @@
-26848
+26887
diff --git a/.forge-snapshots/BinFungibleTokenTest#testMint.snap b/.forge-snapshots/BinFungibleTokenTest#testMint.snap
@@ -1 +1 @@
-67349
+67685
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactInput.snap b/.forge-snapshots/CLSwapRouterTest#ExactInput.snap
@@ -1 +1 @@
-255614
+255442
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactInputSingle.snap b/.forge-snapshots/CLSwapRouterTest#ExactInputSingle.snap
@@ -1 +1 @@
-192686
+192524
diff --git a/src/pool-cl/CLSwapRouterBase.sol b/src/pool-cl/CLSwapRouterBase.sol
@@ -24,18 +24,16 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
         V4CLExactInputSingleParams memory params,
         V4SettlementParams memory settlementParams
     ) internal returns (uint256 amountOut) {
-        amountOut = uint128(
-            -_swapExactPrivate(
-                params.poolKey,
-                params.zeroForOne,
-                -int256(int128(params.amountIn)),
-                params.sqrtPriceLimitX96,
-                settlementParams.payer,
-                params.recipient,
-                settlementParams.settle,
-                settlementParams.take,
-                params.hookData
-            )
+        amountOut = _swapExactPrivate(
+            params.poolKey,
+            params.zeroForOne,
+            -int256(int128(params.amountIn)),
+            params.sqrtPriceLimitX96,
+            settlementParams.payer,
+            params.recipient,
+            settlementParams.settle,
+            settlementParams.take,
+            params.hookData
         );
         if (amountOut < params.amountOutMinimum) revert TooLittleReceived();
     }
@@ -57,19 +55,16 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
 
             for (uint256 i = 0; i < state.pathLength; i++) {
                 (state.poolKey, state.zeroForOne) = _getPoolAndSwapDirection(params.path[i], params.currencyIn);
-
-                state.amountOut = uint128(
-                    -_swapExactPrivate(
-                        state.poolKey,
-                        state.zeroForOne,
-                        -int256(int128(params.amountIn)),
-                        0,
-                        settlementParams.payer,
-                        params.recipient,
-                        i == 0 && settlementParams.settle,
-                        i == state.pathLength - 1 && settlementParams.take,
-                        params.path[i].hookData
-                    )
+                state.amountOut = _swapExactPrivate(
+                    state.poolKey,
+                    state.zeroForOne,
+                    -int256(int128(params.amountIn)),
+                    0,
+                    settlementParams.payer,
+                    params.recipient,
+                    i == 0 && settlementParams.settle,
+                    i == state.pathLength - 1 && settlementParams.take,
+                    params.path[i].hookData
                 );
 
                 params.amountIn = state.amountOut;
@@ -86,18 +81,16 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
         V4CLExactOutputSingleParams memory params,
         V4SettlementParams memory settlementParams
     ) internal returns (uint256 amountIn) {
-        amountIn = uint128(
-            _swapExactPrivate(
-                params.poolKey,
-                params.zeroForOne,
-                int256(int128(params.amountOut)),
-                params.sqrtPriceLimitX96,
-                settlementParams.payer,
-                params.recipient,
-                settlementParams.settle,
-                settlementParams.take,
-                params.hookData
-            )
+        amountIn = _swapExactPrivate(
+            params.poolKey,
+            params.zeroForOne,
+            int256(int128(params.amountOut)),
+            params.sqrtPriceLimitX96,
+            settlementParams.payer,
+            params.recipient,
+            settlementParams.settle,
+            settlementParams.take,
+            params.hookData
         );
         if (amountIn > params.amountInMaximum) revert TooMuchRequested();
     }
@@ -119,18 +112,16 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
 
             for (uint256 i = state.pathLength; i > 0; i--) {
                 (state.poolKey, state.oneForZero) = _getPoolAndSwapDirection(params.path[i - 1], params.currencyOut);
-                state.amountIn = uint128(
-                    _swapExactPrivate(
-                        state.poolKey,
-                        !state.oneForZero,
-                        int256(int128(params.amountOut)),
-                        0,
-                        settlementParams.payer,
-                        params.recipient,
-                        i == 1 && settlementParams.settle,
-                        i == state.pathLength && settlementParams.take,
-                        params.path[i - 1].hookData
-                    )
+                state.amountIn = _swapExactPrivate(
+                    state.poolKey,
+                    !state.oneForZero,
+                    int256(int128(params.amountOut)),
+                    0,
+                    settlementParams.payer,
+                    params.recipient,
+                    i == 1 && settlementParams.settle,
+                    i == state.pathLength && settlementParams.take,
+                    params.path[i - 1].hookData
                 );
 
                 params.amountOut = state.amountIn;
@@ -142,6 +133,9 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
         }
     }
 
+    /// @return reciprocalAmount The amount of the reciprocal token
+    //      If exactInput token0 for token1, the reciprocalAmount is the amount of token1.
+    //      If exactOutput token0 for token1, the reciprocalAmount is the amount of token0.
     function _swapExactPrivate(
         PoolKey memory poolKey,
         bool zeroForOne,
@@ -152,7 +146,7 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
         bool settle,
         bool take,
         bytes memory hookData
-    ) private returns (int128 reciprocalAmount) {
+    ) private returns (uint128 reciprocalAmount) {
         BalanceDelta delta = clPoolManager.swap(
             poolKey,
             ICLPoolManager.SwapParams(
@@ -166,11 +160,15 @@ abstract contract CLSwapRouterBase is SwapRouterBase, ICLSwapRouterBase {
         );
 
         if (zeroForOne) {
-            reciprocalAmount = amountSpecified < 0 ? -delta.amount1() : -delta.amount0();
+            /// @dev amountSpecified < 0 indicate exactInput, so reciprocal token is token1 and positive
+            ///      amountSpecified > 0 indicate exactOutput, so reciprocal token is token0 but is negative
+            reciprocalAmount = amountSpecified < 0 ? uint128(delta.amount1()) : uint128(-delta.amount0());
+
             if (settle) _payAndSettle(poolKey.currency0, payer, -delta.amount0());
             if (take) vault.take(poolKey.currency1, recipient, uint128(delta.amount1()));
         } else {
-            reciprocalAmount = amountSpecified < 0 ? -delta.amount0() : -delta.amount1();
+            reciprocalAmount = amountSpecified < 0 ? uint128(delta.amount0()) : uint128(-delta.amount1());
+
             if (settle) _payAndSettle(poolKey.currency1, payer, -delta.amount1());
             if (take) vault.take(poolKey.currency0, recipient, uint128(delta.amount0()));
         }

diff --git a/test/pool-cl/CLSwapRouter.t.sol b/test/pool-cl/CLSwapRouter.t.sol
@@ -310,7 +310,7 @@ contract CLSwapRouterTest is TokenFixture, Test, GasSnapshot {
         snapEnd();
     }
 
-    function testExactInputX() external {
+    function testExactInput() external {
         ISwapRouterBase.PathKey[] memory path = new ISwapRouterBase.PathKey[](2);
         path[0] = ISwapRouterBase.PathKey({
             intermediateCurrency: currency1,