exact output native gas tests

hensha256 · hensha256 · commit 194fe35f21c5 · 2024-07-29T14:10:30.000+02:00
diff --git a/.forge-snapshots/V4Router_Bytecode.snap b/.forge-snapshots/V4Router_Bytecode.snap
@@ -1 +1 @@
-6509
+6505
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn1Hop_nativeIn.snap
@@ -1 +1 @@
-120940
+120918
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_nativeOut.snap b/.forge-snapshots/V4Router_ExactIn1Hop_nativeOut.snap
@@ -1 +1 @@
-120095
+120073
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_oneForZero.snap b/.forge-snapshots/V4Router_ExactIn1Hop_oneForZero.snap
@@ -1 +1 @@
-128967
+128945
diff --git a/.forge-snapshots/V4Router_ExactIn1Hop_zeroForOne.snap b/.forge-snapshots/V4Router_ExactIn1Hop_zeroForOne.snap
@@ -1 +1 @@
-135797
+135775
diff --git a/.forge-snapshots/V4Router_ExactIn2Hops.snap b/.forge-snapshots/V4Router_ExactIn2Hops.snap
@@ -1 +1 @@
-187076
+187054
diff --git a/.forge-snapshots/V4Router_ExactIn2Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn2Hops_nativeIn.snap
@@ -1 +1 @@
-179051
+179029
diff --git a/.forge-snapshots/V4Router_ExactIn3Hops.snap b/.forge-snapshots/V4Router_ExactIn3Hops.snap
@@ -1 +1 @@
-238384
+238362
diff --git a/.forge-snapshots/V4Router_ExactIn3Hops_nativeIn.snap b/.forge-snapshots/V4Router_ExactIn3Hops_nativeIn.snap
@@ -1 +1 @@
-230383
+230361
diff --git a/.forge-snapshots/V4Router_ExactInputSingle.snap b/.forge-snapshots/V4Router_ExactInputSingle.snap
@@ -1 +1 @@
-134628
+134606
diff --git a/.forge-snapshots/V4Router_ExactInputSingle_nativeIn.snap b/.forge-snapshots/V4Router_ExactInputSingle_nativeIn.snap
@@ -1 +1 @@
-119771
+119749
diff --git a/.forge-snapshots/V4Router_ExactInputSingle_nativeOut.snap b/.forge-snapshots/V4Router_ExactInputSingle_nativeOut.snap
@@ -1 +1 @@
-118904
+118882
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_nativeIn_sweepETH.snap b/.forge-snapshots/V4Router_ExactOut1Hop_nativeIn_sweepETH.snap
@@ -0,0 +1 @@
+126727
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_nativeOut.snap b/.forge-snapshots/V4Router_ExactOut1Hop_nativeOut.snap
@@ -0,0 +1 @@
+120920
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_oneForZero.snap b/.forge-snapshots/V4Router_ExactOut1Hop_oneForZero.snap
@@ -1 +1 @@
-129814
+129792
diff --git a/.forge-snapshots/V4Router_ExactOut1Hop_zeroForOne.snap b/.forge-snapshots/V4Router_ExactOut1Hop_zeroForOne.snap
@@ -1 +1 @@
-134615
+134593
diff --git a/.forge-snapshots/V4Router_ExactOut2Hops.snap b/.forge-snapshots/V4Router_ExactOut2Hops.snap
@@ -1 +1 @@
-186509
+186487
diff --git a/.forge-snapshots/V4Router_ExactOut2Hops_nativeOut.snap b/.forge-snapshots/V4Router_ExactOut2Hops_nativeOut.snap
@@ -0,0 +1 @@
+183422
diff --git a/.forge-snapshots/V4Router_ExactOut3Hops.snap b/.forge-snapshots/V4Router_ExactOut3Hops.snap
@@ -1 +1 @@
-238447
+238425
diff --git a/.forge-snapshots/V4Router_ExactOut3Hops_nativeOut.snap b/.forge-snapshots/V4Router_ExactOut3Hops_nativeOut.snap
@@ -0,0 +1 @@
+235384
diff --git a/.forge-snapshots/V4Router_ExactOutputSingle.snap b/.forge-snapshots/V4Router_ExactOutputSingle.snap
@@ -1 +1 @@
-133162
+133140
diff --git a/.forge-snapshots/V4Router_ExactOutputSingle_nativeIn_sweepETH.snap b/.forge-snapshots/V4Router_ExactOutputSingle_nativeIn_sweepETH.snap
@@ -0,0 +1 @@
+125274
diff --git a/test/router/V4Router.gas.t.sol b/test/router/V4Router.gas.t.sol
@@ -282,4 +282,81 @@ contract V4RouterTest is RoutingTestHelpers, GasSnapshot {
     /*//////////////////////////////////////////////////////////////
                 ETH -> ERC20 and ERC20 -> ETH EXACT OUTPUT
     //////////////////////////////////////////////////////////////*/
+
+    function test_gas_nativeIn_swapExactOutputSingle_sweepExcessETH() public {
+        uint256 amountOut = 1 ether;
+
+        IV4Router.ExactOutputSingleParams memory params =
+            IV4Router.ExactOutputSingleParams(nativeKey, true, uint128(amountOut), 0, 0, bytes(""));
+
+        plan = plan.add(Actions.SWAP_EXACT_OUT_SINGLE, abi.encode(params));
+        _finalizePlan(nativeKey.currency0, nativeKey.currency1, address(this));
+        bytes memory data = plan.encode();
+
+        router.executeActionsAndSweepExcessETH{value: 2 ether}(data);
+        snapLastCall("V4Router_ExactOutputSingle_nativeIn_sweepETH");
+    }
+
+    function test_gas_nativeIn_swapExactOut_1Hop_sweepExcessETH() public {
+        uint256 amountOut = 1 ether;
+
+        tokenPath.push(CurrencyLibrary.NATIVE);
+        tokenPath.push(currency0);
+        IV4Router.ExactOutputParams memory params = _getExactOutputParams(tokenPath, amountOut);
+
+        plan = plan.add(Actions.SWAP_EXACT_OUT, abi.encode(params));
+        _finalizePlan(CurrencyLibrary.NATIVE, currency0, address(this));
+        bytes memory data = plan.encode();
+
+        router.executeActionsAndSweepExcessETH{value: 2 ether}(data);
+        snapLastCall("V4Router_ExactOut1Hop_nativeIn_sweepETH");
+    }
+
+    function test_gas_nativeOut_swapExactOut_1Hop() public {
+        uint256 amountOut = 1 ether;
+
+        tokenPath.push(currency0);
+        tokenPath.push(CurrencyLibrary.NATIVE);
+        IV4Router.ExactOutputParams memory params = _getExactOutputParams(tokenPath, amountOut);
+
+        plan = plan.add(Actions.SWAP_EXACT_OUT, abi.encode(params));
+        _finalizePlan(currency0, CurrencyLibrary.NATIVE, address(this));
+        bytes memory data = plan.encode();
+
+        router.executeActions(data);
+        snapLastCall("V4Router_ExactOut1Hop_nativeOut");
+    }
+
+    function test_gas_nativeIn_swapExactOut_2Hops_sweepExcessETH() public {
+        uint256 amountOut = 1 ether;
+
+        tokenPath.push(CurrencyLibrary.NATIVE);
+        tokenPath.push(currency0);
+        tokenPath.push(currency1);
+        IV4Router.ExactOutputParams memory params = _getExactOutputParams(tokenPath, amountOut);
+
+        plan = plan.add(Actions.SWAP_EXACT_OUT, abi.encode(params));
+        _finalizePlan(CurrencyLibrary.NATIVE, currency1, address(this));
+        bytes memory data = plan.encode();
+
+        router.executeActionsAndSweepExcessETH{value: 2 ether}(data);
+        snapLastCall("V4Router_ExactOut2Hops_nativeOut");
+    }
+
+    function test_gas_nativeIn_swapExactOut_3Hops_sweepExcessETH() public {
+        uint256 amountOut = 1 ether;
+
+        tokenPath.push(CurrencyLibrary.NATIVE);
+        tokenPath.push(currency0);
+        tokenPath.push(currency1);
+        tokenPath.push(currency2);
+        IV4Router.ExactOutputParams memory params = _getExactOutputParams(tokenPath, amountOut);
+
+        plan = plan.add(Actions.SWAP_EXACT_OUT, abi.encode(params));
+        _finalizePlan(CurrencyLibrary.NATIVE, currency2, address(this));
+        bytes memory data = plan.encode();
+
+        router.executeActionsAndSweepExcessETH{value: 2 ether}(data);
+        snapLastCall("V4Router_ExactOut3Hops_nativeOut");
+    }
 }
diff --git a/test/shared/RoutingTestHelpers.sol b/test/shared/RoutingTestHelpers.sol
@@ -156,7 +156,7 @@ contract RoutingTestHelpers is Test, Deployers {
             // send too much ETH to mimic slippage
             // then make sure the router can sweep back excess input
             value += 0.1 ether;
-            router.executeActionsAndSweepETH{value: value}(data);
+            router.executeActionsAndSweepExcessETH{value: value}(data);
         } else {
             // otherwise just execute as normal
             router.executeActions{value: value}(data);
diff --git a/test/shared/implementation/V4RouterImplementation.sol b/test/shared/implementation/V4RouterImplementation.sol
@@ -17,7 +17,7 @@ contract V4RouterImplementation is V4Router, ReentrancyLock {
         _executeActions(params);
     }
 
-    function executeActionsAndSweepETH(bytes calldata params) external payable isNotLocked {
+    function executeActionsAndSweepExcessETH(bytes calldata params) external payable isNotLocked {
         _executeActions(params);
 
         uint256 balance = address(this).balance;
