Remove SETTLE_TAKE_PAIR command (#371)

Uniswap · Nov 21, 2024 · 8acce8b · 8acce8b
1 parent d767807
commit 8acce8b
Show file tree

Hide file tree

Showing 34 changed files with 39 additions and 69 deletions.
diff --git a/.forge-snapshots/Payments_swap_settleFromCaller_takeAllToMsgSender.snap b/.forge-snapshots/Payments_swap_settleFromCaller_takeAllToMsgSender.snap
@@ -1 +1 @@
-129438
+129542
diff --git a/.forge-snapshots/Payments_swap_settleFromCaller_takeAllToSpecifiedAddress.snap b/.forge-snapshots/Payments_swap_settleFromCaller_takeAllToSpecifiedAddress.snap
@@ -1 +1 @@
-131502
+131456
diff --git a/.forge-snapshots/Payments_swap_settleWithBalance_takeAllToMsgSender.snap b/.forge-snapshots/Payments_swap_settleWithBalance_takeAllToMsgSender.snap
@@ -1 +1 @@
-123707
+123661
diff --git a/.forge-snapshots/Payments_swap_settleWithBalance_takeAllToSpecifiedAddress.snap b/.forge-snapshots/Payments_swap_settleWithBalance_takeAllToSpecifiedAddress.snap
@@ -1 +1 @@
-123849
+123803
diff --git a/.forge-snapshots/V4Router_Bytecode.snap b/.forge-snapshots/V4Router_Bytecode.snap
@@ -1 +1 @@
-7117
+7007
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn1Hop_nativeIn.snap
@@ -1 +1 @@
-115672
+117265
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_nativeOut.snap b/.forge-snapshots/V4Router_ExactIn1Hop_nativeOut.snap
@@ -1 +1 @@
-115929
+117522
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_oneForZero.snap b/.forge-snapshots/V4Router_ExactIn1Hop_oneForZero.snap
@@ -1 +1 @@
-124744
+126337
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_zeroForOne.snap b/.forge-snapshots/V4Router_ExactIn1Hop_zeroForOne.snap
@@ -1 +1 @@
-130408
+132001
diff --git a/.forge-snapshots/V4Router_ExactIn2Hops.snap b/.forge-snapshots/V4Router_ExactIn2Hops.snap
@@ -1 +1 @@
-185177
+186735
diff --git a/.forge-snapshots/V4Router_ExactIn2Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn2Hops_nativeIn.snap
@@ -1 +1 @@
-170441
+171999
diff --git a/.forge-snapshots/V4Router_ExactIn3Hops.snap b/.forge-snapshots/V4Router_ExactIn3Hops.snap
@@ -1 +1 @@
-239949
+241519
diff --git a/.forge-snapshots/V4Router_ExactIn3Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn3Hops_nativeIn.snap
@@ -1 +1 @@
-225213
+226783
diff --git a/.forge-snapshots/V4Router_ExactInputSingle.snap b/.forge-snapshots/V4Router_ExactInputSingle.snap
@@ -1 +1 @@
-129438
+131009
diff --git a/.forge-snapshots/V4Router_ExactInputSingle_nativeIn.snap b/.forge-snapshots/V4Router_ExactInputSingle_nativeIn.snap
@@ -1 +1 @@
-114702
+116273
diff --git a/.forge-snapshots/V4Router_ExactInputSingle_nativeOut.snap b/.forge-snapshots/V4Router_ExactInputSingle_nativeOut.snap
@@ -1 +1 @@
-114927
+116498
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_nativeIn_sweepETH.snap b/.forge-snapshots/V4Router_ExactOut1Hop_nativeIn_sweepETH.snap
@@ -1 +1 @@
-121930
+123523
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_nativeOut.snap b/.forge-snapshots/V4Router_ExactOut1Hop_nativeOut.snap
@@ -1 +1 @@
-117002
+118595
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_oneForZero.snap b/.forge-snapshots/V4Router_ExactOut1Hop_oneForZero.snap
@@ -1 +1 @@
-125817
+127410
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_zeroForOne.snap b/.forge-snapshots/V4Router_ExactOut1Hop_zeroForOne.snap
@@ -1 +1 @@
-129689
+131282
diff --git a/.forge-snapshots/V4Router_ExactOut2Hops.snap b/.forge-snapshots/V4Router_ExactOut2Hops.snap
@@ -1 +1 @@
-183515
+185073
diff --git a/.forge-snapshots/V4Router_ExactOut2Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactOut2Hops_nativeIn.snap
@@ -1 +1 @@
-175756
+177314
diff --git a/.forge-snapshots/V4Router_ExactOut3Hops.snap b/.forge-snapshots/V4Router_ExactOut3Hops.snap
@@ -1 +1 @@
-237372
+238942
diff --git a/.forge-snapshots/V4Router_ExactOut3Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactOut3Hops_nativeIn.snap
@@ -1 +1 @@
-229613
+231183
diff --git a/.forge-snapshots/V4Router_ExactOut3Hops_nativeOut.snap b/.forge-snapshots/V4Router_ExactOut3Hops_nativeOut.snap
@@ -1 +1 @@
-216949
+218519
diff --git a/.forge-snapshots/V4Router_ExactOutputSingle.snap b/.forge-snapshots/V4Router_ExactOutputSingle.snap
@@ -1 +1 @@
-128716
+130287
diff --git a/.forge-snapshots/V4Router_ExactOutputSingle_nativeIn_sweepETH.snap b/.forge-snapshots/V4Router_ExactOutputSingle_nativeIn_sweepETH.snap
@@ -1 +1 @@
-120957
+122528
diff --git a/.forge-snapshots/V4Router_ExactOutputSingle_nativeOut.snap b/.forge-snapshots/V4Router_ExactOutputSingle_nativeOut.snap
@@ -1 +1 @@
-116103
+117674
diff --git a/lib/v4-core b/lib/v4-core
diff --git a/src/V4Router.sol b/src/V4Router.sol
@@ -50,12 +50,7 @@ abstract contract V4Router is IV4Router, BaseActionsRouter, DeltaResolver {
                 return;
             }
         } else {
-            if (action == Actions.SETTLE_TAKE_PAIR) {
-                (Currency settleCurrency, Currency takeCurrency) = params.decodeCurrencyPair();
-                _settle(settleCurrency, msgSender(), _getFullDebt(settleCurrency));
-                _take(takeCurrency, msgSender(), _getFullCredit(takeCurrency));
-                return;
-            } else if (action == Actions.SETTLE_ALL) {
+            if (action == Actions.SETTLE_ALL) {
                 (Currency currency, uint256 maxAmount) = params.decodeCurrencyAndUint256();
                 uint256 amount = _getFullDebt(currency);
                 if (amount > maxAmount) revert V4TooMuchRequested(maxAmount, amount);

diff --git a/src/libraries/Actions.sol b/src/libraries/Actions.sol
@@ -29,7 +29,6 @@ library Actions {
     uint256 constant TAKE_PORTION = 0x14;
     uint256 constant TAKE_PAIR = 0x15;
 
-    uint256 constant SETTLE_TAKE_PAIR = 0x16;
     uint256 constant CLOSE_CURRENCY = 0x17;
     uint256 constant CLEAR_OR_TAKE = 0x18;
     uint256 constant SWEEP = 0x19;

diff --git a/test/router/Payments.gas.t.sol b/test/router/Payments.gas.t.sol
@@ -39,7 +39,8 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
             IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, bytes(""));
 
         plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
-        plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
+        plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
+        plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));
 
         bytes memory data = plan.encode();
         router.executeActions(data);

diff --git a/test/router/Payments.t.sol b/test/router/Payments.t.sol
@@ -22,35 +22,6 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
         plan = Planner.init();
     }
 
-    function test_settleTakePair() public {
-        uint256 amountIn = 1 ether;
-        uint256 expectedAmountOut = 992054607780215625;
-        IV4Router.ExactInputSingleParams memory params =
-            IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, bytes(""));
-
-        plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
-        plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
-
-        uint256 inputBalanceBefore = key0.currency0.balanceOfSelf();
-        uint256 outputBalanceBefore = key0.currency1.balanceOfSelf();
-        // router is empty before
-        assertEq(currency0.balanceOf(address(router)), 0);
-        assertEq(currency1.balanceOf(address(router)), 0);
-
-        bytes memory data = plan.encode();
-        router.executeActions(data);
-
-        uint256 inputBalanceAfter = key0.currency0.balanceOfSelf();
-        uint256 outputBalanceAfter = key0.currency1.balanceOfSelf();
-
-        // router is empty
-        assertEq(currency0.balanceOf(address(router)), 0);
-        assertEq(currency1.balanceOf(address(router)), 0);
-        // caller's balance changed by input and output amounts
-        assertEq(inputBalanceBefore - inputBalanceAfter, amountIn);
-        assertEq(outputBalanceAfter - outputBalanceBefore, expectedAmountOut);
-    }
-
     function test_exactIn_settleAll_revertsSlippage() public {
         uint256 amountIn = 1 ether;
         IV4Router.ExactInputSingleParams memory params =
@@ -172,9 +143,10 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
             IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, bytes(""));
 
         plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
+        plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
         // take 15 bips to Bob
         plan = plan.add(Actions.TAKE_PORTION, abi.encode(key0.currency1, bob, 15));
-        plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
+        plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));
 
         uint256 inputBalanceBefore = key0.currency0.balanceOfSelf();
         uint256 outputBalanceBefore = key0.currency1.balanceOfSelf();
@@ -208,9 +180,10 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
             IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, bytes(""));
 
         plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
+        plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
         // bips is larger than maximum bips
         plan = plan.add(Actions.TAKE_PORTION, abi.encode(key0.currency1, bob, BipsLibrary.BPS_DENOMINATOR + 1));
-        plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
+        plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));
 
         bytes memory data = plan.encode();
 

diff --git a/test/shared/Planner.sol b/test/shared/Planner.sol
@@ -86,7 +86,9 @@ library Planner {
         returns (bytes memory)
     {
         if (takeRecipient == ActionConstants.MSG_SENDER) {
-            plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(inputCurrency, outputCurrency));
+            // blindly settling and taking all, without slippage checks, isnt recommended in prod
+            plan = plan.add(Actions.SETTLE_ALL, abi.encode(inputCurrency, type(uint256).max));
+            plan = plan.add(Actions.TAKE_ALL, abi.encode(outputCurrency, 0));
         } else {
             plan = plan.add(Actions.SETTLE, abi.encode(inputCurrency, ActionConstants.OPEN_DELTA, true));
             plan = plan.add(Actions.TAKE, abi.encode(outputCurrency, takeRecipient, ActionConstants.OPEN_DELTA));