feat: Add to in parameter for settleAndRefund

pancakeswap · Mar 20, 2024 · 7cf771c · 7cf771c
1 parent 095503b
commit 7cf771c
Show file tree

Hide file tree

Showing 46 changed files with 68 additions and 55 deletions.
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-92245
+92310
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-67437
+67502
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-150992
+151057
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-68616
+68681
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-53952
+53973
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-968047
+968068
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-121561
+121582
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-337237
+337258
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-56298
+56319
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-93040
+93083
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-95025
+95068
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-74469
+74512
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-318945
+318966
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Burn.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Burn.snap
@@ -1 +1 @@
-41876
+41941
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap
@@ -1 +1 @@
-19493
+19558
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap
@@ -1 +1 @@
-37345
+37410
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap
@@ -1 +1 @@
-22699
+22764
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-348452
+348473
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-61000
+61021
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-241390
+241433
diff --git a/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap b/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap
@@ -1 +1 @@
-84138
+84159
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-53445
+53488
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-43322
+43387
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-56445
+56488
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-104554
+104597
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-25044269
+25044312
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-36336
+36401
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-103030
+103140
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-41986
+42051
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-36339
+36404
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Donate.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Donate.snap
@@ -1 +1 @@
-19448
+19513
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_ModifyPosition.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_ModifyPosition.snap
@@ -1 +1 @@
-27615
+27680
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap
@@ -1 +1 @@
-21897
+21962
diff --git a/.forge-snapshots/VaultTest#Vault.snap b/.forge-snapshots/VaultTest#Vault.snap
@@ -1 +1 @@
-7016
+7018
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap b/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap
@@ -1 +1 @@
-122519
+122540
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap b/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap
@@ -1 +1 @@
-158811
+158832
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap
@@ -1 +1 @@
-46974
+47017
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap
@@ -1 +1 @@
-46973
+47016
diff --git a/.forge-snapshots/VaultTest#testLock_NoOp.snap b/.forge-snapshots/VaultTest#testLock_NoOp.snap
@@ -1 +1 @@
-11532
+11597
diff --git a/.forge-snapshots/VaultTest#testSettleAndRefund_WithErc20Transfer.snap b/.forge-snapshots/VaultTest#testSettleAndRefund_WithErc20Transfer.snap
@@ -1 +1 @@
-75609
+79085
diff --git a/.forge-snapshots/VaultTest#testSettleAndRefund_WithoutErc20Transfer.snap b/.forge-snapshots/VaultTest#testSettleAndRefund_WithoutErc20Transfer.snap
@@ -1 +1 @@
-33010
+36485
diff --git a/src/Vault.sol b/src/Vault.sol
@@ -126,7 +126,12 @@ contract Vault is IVault, VaultToken, Ownable {
         SettlementGuard.accountDelta(msg.sender, currency, -(paid.toInt128()));
     }
 
-    function settleAndRefund(Currency currency) external payable isLocked returns (uint256 paid, uint256 refund) {
+    function settleAndRefund(Currency currency, address to)
+        external
+        payable
+        isLocked
+        returns (uint256 paid, uint256 refund)
+    {
         paid = settle(currency);
 
         int256 afterCurrencyDelta = SettlementGuard.getCurrencyDelta(msg.sender, currency);
@@ -138,7 +143,7 @@ contract Vault is IVault, VaultToken, Ownable {
             /// thus refund msg.sender and update accountDelta
             SettlementGuard.accountDelta(msg.sender, currency, refund.toInt128());
             reservesOfVault[currency] -= refund;
-            currency.transfer(msg.sender, refund);
+            currency.transfer(to, refund);
         }
     }
 

diff --git a/src/interfaces/IVault.sol b/src/interfaces/IVault.sol
@@ -68,7 +68,9 @@ interface IVault is IVaultToken {
     function settle(Currency token) external payable returns (uint256 paid);
 
     /// @notice Called by the user to pay what is owed. If the payment is more than the debt, the surplus is refunded
-    function settleAndRefund(Currency token) external payable returns (uint256 paid, uint256 refund);
+    /// @param currency The currency to settle
+    /// @param to The address to refund the surplus to
+    function settleAndRefund(Currency currency, address to) external payable returns (uint256 paid, uint256 refund);
 
     /// @notice move the delta from target to the msg.sender, only payment delta can be moved
     /// @param currency The currency to settle

diff --git a/test/vault/FakePoolManagerRouter.sol b/test/vault/FakePoolManagerRouter.sol
@@ -129,8 +129,10 @@ contract FakePoolManagerRouter {
             vault.settle{value: 5 ether}(CurrencyLibrary.NATIVE);
             vault.take(CurrencyLibrary.NATIVE, address(this), 5 ether);
         } else if (data[0] == 0x18) {
-            vault.settleAndRefund(poolKey.currency0);
-            vault.settleAndRefund(poolKey.currency1);
+            // call this method via vault.lock(abi.encodePacked(hex"18", alice));
+            address to = address(uint160(uint256(bytes32(data[1:0x15]) >> 96)));
+            vault.settleAndRefund(poolKey.currency0, to);
+            vault.settleAndRefund(poolKey.currency1, to);
         }
 
         return "";

diff --git a/test/vault/Vault.t.sol b/test/vault/Vault.t.sol
@@ -174,35 +174,39 @@ contract VaultTest is Test, GasSnapshot {
     }
 
     function testSettleAndRefund_WithErc20Transfer() public {
+        address alice = makeAddr("alice");
+
         // simulate someone transferred token to vault
         currency0.transfer(address(vault), 10 ether);
         assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
-        assertEq(IERC20(Currency.unwrap(currency1)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
+        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(alice)), 0 ether);
 
         // settle and refund
         vm.prank(address(fakePoolManagerRouter));
         snapStart("VaultTest#testSettleAndRefund_WithErc20Transfer");
-        vault.lock(hex"18");
+        vault.lock(abi.encodePacked(hex"18", alice));
         snapEnd();
 
         // verify
-        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(fakePoolManagerRouter)), 10 ether);
-        assertEq(IERC20(Currency.unwrap(currency1)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
+        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
+        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(alice)), 10 ether);
     }
 
     function testSettleAndRefund_WithoutErc20Transfer() public {
+        address alice = makeAddr("alice");
+
         assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
-        assertEq(IERC20(Currency.unwrap(currency1)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
+        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(alice)), 0 ether);
 
         // settleAndRefund works even if there's no excess currency
         vm.prank(address(fakePoolManagerRouter));
         snapStart("VaultTest#testSettleAndRefund_WithoutErc20Transfer");
-        vault.lock(hex"18");
+        vault.lock(abi.encodePacked(hex"18", alice));
         snapEnd();
 
         // verify
         assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
-        assertEq(IERC20(Currency.unwrap(currency1)).balanceOf(address(fakePoolManagerRouter)), 0 ether);
+        assertEq(IERC20(Currency.unwrap(currency0)).balanceOf(address(alice)), 0 ether);
     }
 
     function testNotCorrectPoolManager() public {

diff --git a/test/vault/VaultInvariant.t.sol b/test/vault/VaultInvariant.t.sol
@@ -188,8 +188,8 @@ contract VaultPoolManager is Test {
             token0.transfer(address(vault), action.amt0);
             token1.transfer(address(vault), action.amt1);
 
-            vault.settleAndRefund(currency0);
-            vault.settleAndRefund(currency1);
+            vault.settleAndRefund(currency0, address(this));
+            vault.settleAndRefund(currency1, address(this));
         } else if (action.actionType == ActionType.SettleFor) {
             // hook cash out the fee ahead
             BalanceDelta delta = toBalanceDelta(int128(action.amt0), int128(action.amt1));