feat: Support SettleAndMintRefund in periphery (#3)

pancakeswap · Mar 25, 2024 · ba7169c · ba7169c
1 parent 0d1987b
commit ba7169c
Show file tree

Hide file tree

Showing 40 changed files with 244 additions and 38 deletions.
diff --git a/...nFungiblePositionManager_AddLiquidityTest#testAddLiquidityOutsideActiveId_ExistingId.snap b/...nFungiblePositionManager_AddLiquidityTest#testAddLiquidityOutsideActiveId_ExistingId.snap
@@ -1 +1 @@
-79699
+80435
diff --git a/...ts/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityOutsideActiveId_NewId.snap b/...ts/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityOutsideActiveId_NewId.snap
@@ -1 +1 @@
-627067
+627803
diff --git a/...e-snapshots/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityWithActiveId.snap b/...e-snapshots/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityWithActiveId.snap
@@ -1 +1 @@
-918147
+919685
diff --git a/...ts/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityWithActiveId_WithHook.snap b/...ts/BinFungiblePositionManager_AddLiquidityTest#testAddLiquidityWithActiveId_WithHook.snap
@@ -1 +1 @@
-1268812
+1270351
diff --git a/...iblePositionManager_RemoveLiquidityTest#testRemoveLiquidityOutsideActiveId_ThreeBins.snap b/...iblePositionManager_RemoveLiquidityTest#testRemoveLiquidityOutsideActiveId_ThreeBins.snap
@@ -1 +1 @@
-80824
+80759
diff --git a/...ungiblePositionManager_RemoveLiquidityTest#testRemoveLiquidityWithActiveId_ThreeBins.snap b/...ungiblePositionManager_RemoveLiquidityTest#testRemoveLiquidityWithActiveId_ThreeBins.snap
@@ -1 +1 @@
-117826
+117761
diff --git a/...ge-snapshots/BinFungiblePositionManager_RemoveLiquidityTest#testRemoveLiquidity_Half.snap b/...ge-snapshots/BinFungiblePositionManager_RemoveLiquidityTest#testRemoveLiquidity_Half.snap
@@ -1 +1 @@
-114631
+114566
diff --git a/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromOwner.snap b/.forge-snapshots/BinFungibleTokenTest#testBatchTransferFrom_FromOwner.snap
@@ -1 +1 @@
-29390
+9490
diff --git a/.forge-snapshots/BinFungibleTokenTest#testMint.snap b/.forge-snapshots/BinFungibleTokenTest#testMint.snap
@@ -1 +1 @@
-43594
+43591
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_DifferentRecipient.snap b/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_DifferentRecipient.snap
@@ -1 +1 @@
-138752
+139491
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_EthPool_SwapEthForToken.snap b/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_EthPool_SwapEthForToken.snap
@@ -1 +1 @@
-131484
+132217
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_EthPool_SwapTokenForEth.snap b/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_EthPool_SwapTokenForEth.snap
@@ -1 +1 @@
-136297
+137030
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_SwapForY_1.snap b/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_SwapForY_1.snap
@@ -1 +1 @@
-132258
+132997
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_SwapForY_2.snap b/.forge-snapshots/BinSwapRouterTest#testExactInputSingle_SwapForY_2.snap
@@ -1 +1 @@
-132333
+133072
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactInput_MultiHopDifferentRecipient.snap b/.forge-snapshots/BinSwapRouterTest#testExactInput_MultiHopDifferentRecipient.snap
@@ -1 +1 @@
-167590
+168327
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_DifferentRecipient.snap b/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_DifferentRecipient.snap
@@ -1 +1 @@
-144076
+144815
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_SwapForY_1.snap b/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_SwapForY_1.snap
@@ -1 +1 @@
-137582
+138321
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_SwapForY_2.snap b/.forge-snapshots/BinSwapRouterTest#testExactOutputSingle_SwapForY_2.snap
@@ -1 +1 @@
-137669
+138408
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactOutput_MultiHopDifferentRecipient.snap b/.forge-snapshots/BinSwapRouterTest#testExactOutput_MultiHopDifferentRecipient.snap
@@ -1 +1 @@
-172111
+172844
diff --git a/.forge-snapshots/BinSwapRouterTest#testExactOutput_SingleHop.snap b/.forge-snapshots/BinSwapRouterTest#testExactOutput_SingleHop.snap
@@ -1 +1 @@
-130040
+130773
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactInput.snap b/.forge-snapshots/CLSwapRouterTest#ExactInput.snap
@@ -1 +1 @@
-250131
+250868
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactInputSingle.snap b/.forge-snapshots/CLSwapRouterTest#ExactInputSingle.snap
@@ -1 +1 @@
-180878
+181611
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactOutput.snap b/.forge-snapshots/CLSwapRouterTest#ExactOutput.snap
@@ -1 +1 @@
-256134
+256867
diff --git a/.forge-snapshots/CLSwapRouterTest#ExactOutputSingle.snap b/.forge-snapshots/CLSwapRouterTest#ExactOutputSingle.snap
@@ -1 +1 @@
-180439
+181172
diff --git a/.forge-snapshots/NonfungiblePositionManager#collect.snap b/.forge-snapshots/NonfungiblePositionManager#collect.snap
@@ -1 +1 @@
-199252
+199079
diff --git a/.forge-snapshots/NonfungiblePositionManager#decreaseLiquidity.snap b/.forge-snapshots/NonfungiblePositionManager#decreaseLiquidity.snap
@@ -1 +1 @@
-75212
+75144
diff --git a/.forge-snapshots/NonfungiblePositionManager#increaseLiquidity.snap b/.forge-snapshots/NonfungiblePositionManager#increaseLiquidity.snap
@@ -1 +1 @@
-80908
+82440
diff --git a/.forge-snapshots/NonfungiblePositionManager#mint.snap b/.forge-snapshots/NonfungiblePositionManager#mint.snap
@@ -1 +1 @@
-624939
+626477
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
diff --git a/lib/pancake-v4-core b/lib/pancake-v4-core
diff --git a/lib/solmate b/lib/solmate
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "test": "forge test",
     "dev": "forge test -vvv -w",
     "snapshot": "rm -fr .forge-snapshots && forge test",
-    "prettier": "forge fmt contracts/ && forge fmt test/ && forge fmt script/",
+    "prettier": "forge fmt src/ && forge fmt test/ && forge fmt script/",
     "prettier-check": "forge fmt --check"
   }
 }
diff --git a/src/SwapRouterBase.sol b/src/SwapRouterBase.sol
@@ -40,7 +40,7 @@ abstract contract SwapRouterBase is ISwapRouterBase {
 
     function _payAndSettle(Currency currency, address msgSender, int128 settleAmount) internal virtual {
         _pay(currency, msgSender, address(vault), uint256(uint128(settleAmount)));
-        vault.settle(currency);
+        vault.settleAndMintRefund(currency, msgSender);
     }
 
     function _pay(Currency currency, address payer, address recipient, uint256 amount) internal virtual;

diff --git a/src/pool-bin/BinFungiblePositionManager.sol b/src/pool-bin/BinFungiblePositionManager.sol
@@ -227,14 +227,14 @@ contract BinFungiblePositionManager is
     function _settleDeltas(address user, PoolKey memory poolKey, BalanceDelta delta) internal {
         if (delta.amount0() > 0) {
             pay(poolKey.currency0, user, address(vault), uint256(int256(delta.amount0())));
-            vault.settle(poolKey.currency0);
+            vault.settleAndMintRefund(poolKey.currency0, user);
         } else if (delta.amount0() < 0) {
             vault.take(poolKey.currency0, user, uint128(-delta.amount0()));
         }
 
         if (delta.amount1() > 0) {
             pay(poolKey.currency1, user, address(vault), uint256(int256(delta.amount1())));
-            vault.settle(poolKey.currency1);
+            vault.settleAndMintRefund(poolKey.currency1, user);
         } else if (delta.amount1() < 0) {
             vault.take(poolKey.currency1, user, uint128(-delta.amount1()));
         }

diff --git a/src/pool-cl/base/LiquidityManagement.sol b/src/pool-cl/base/LiquidityManagement.sol
@@ -113,13 +113,13 @@ abstract contract LiquidityManagement is CLPeripheryImmutableState, PeripheryPay
     function settleDeltas(address sender, PoolKey memory poolKey, BalanceDelta delta) internal {
         if (delta.amount0() > 0) {
             pay(poolKey.currency0, sender, address(vault), uint256(int256(delta.amount0())));
-            vault.settle(poolKey.currency0);
+            vault.settleAndMintRefund(poolKey.currency0, sender);
         } else if (delta.amount0() < 0) {
             vault.take(poolKey.currency0, sender, uint128(-delta.amount0()));
         }
         if (delta.amount1() > 0) {
             pay(poolKey.currency1, sender, address(vault), uint256(int256(delta.amount1())));
-            vault.settle(poolKey.currency1);
+            vault.settleAndMintRefund(poolKey.currency1, sender);
         } else if (delta.amount1() < 0) {
             vault.take(poolKey.currency1, sender, uint128(-delta.amount1()));
         }

diff --git a/test/pool-bin/BinFungiblePositionManager_AddLiquidity.t.sol b/test/pool-bin/BinFungiblePositionManager_AddLiquidity.t.sol
@@ -538,4 +538,41 @@ contract BinFungiblePositionManager_AddLiquidityTest is Test, GasSnapshot, Liqui
             deadline: block.timestamp + 600
         });
     }
+
+    function testSettleAndMintRefund() public {
+        // transfer excess token to vault
+        uint256 excessTokenAmount = 1 ether;
+        address hacker = address(1);
+        token0.mint(hacker, excessTokenAmount);
+        vm.startPrank(hacker);
+        token0.transfer(address(vault), excessTokenAmount);
+        vm.stopPrank();
+
+        // pre-test, verify alice has 1e18 token0 and token1
+        token0.mint(alice, 1 ether);
+        token1.mint(alice, 1 ether);
+        assertEq(token0.balanceOf(alice), 1 ether);
+        assertEq(token1.balanceOf(alice), 1 ether);
+
+        vm.startPrank(alice);
+        uint24[] memory binIds = getBinIds(activeId, 3);
+        IBinFungiblePositionManager.AddLiquidityParams memory params;
+        params = _getAddParams(key1, binIds, 1 ether, 1 ether, activeId, alice);
+        (,, uint256[] memory tokenIds,) = binFungiblePositionManager.addLiquidity(params);
+
+        for (uint256 i; i < tokenIds.length; i++) {
+            (Currency curr0, Currency curr1, uint24 fee, uint24 binId) =
+                binFungiblePositionManager.positions(tokenIds[i]);
+            assertEq(Currency.unwrap(curr0), Currency.unwrap(key1.currency0));
+            assertEq(Currency.unwrap(curr1), Currency.unwrap(key1.currency1));
+            assertEq(fee, key1.fee);
+            assertEq(binId, binIds[i]);
+        }
+
+        // check currency balance in vault
+        {
+            uint256 currency0Balance = vault.balanceOf(alice, currency0);
+            assertEq(currency0Balance, excessTokenAmount, "Unexpected currency0 balance in vault");
+        }
+    }
 }
diff --git a/test/pool-bin/BinSwapRouter.t.sol b/test/pool-bin/BinSwapRouter.t.sol
@@ -766,6 +766,47 @@ contract BinSwapRouterTest is Test, GasSnapshot, LiquidityParamsHelper {
         assertEq(token0.balanceOf(alice), abi.decode(result[0], (uint256)));
     }
 
+    function testSettleAndMintRefund() public {
+        // transfer excess token to vault
+        uint256 excessTokenAmount = 1 ether;
+        address hacker = address(1);
+        token0.mint(hacker, excessTokenAmount);
+        vm.startPrank(hacker);
+        token0.transfer(address(vault), excessTokenAmount);
+        vm.stopPrank();
+
+        vm.startPrank(alice);
+        token0.mint(alice, 1 ether);
+
+        ISwapRouterBase.PathKey[] memory path = new ISwapRouterBase.PathKey[](1);
+        path[0] = ISwapRouterBase.PathKey({
+            intermediateCurrency: Currency.wrap(address(token1)),
+            fee: key.fee,
+            hooks: key.hooks,
+            hookData: new bytes(0),
+            poolManager: key.poolManager,
+            parameters: key.parameters
+        });
+
+        uint256 amountOut = router.exactInput(
+            IBinSwapRouterBase.V4BinExactInputParams({
+                currencyIn: Currency.wrap(address(token0)),
+                path: path,
+                recipient: alice,
+                amountIn: 1 ether,
+                amountOutMinimum: 0
+            }),
+            block.timestamp + 60
+        );
+        assertEq(token1.balanceOf(alice), amountOut);
+
+        // check currency balance in vault
+        {
+            uint256 currency0Balance = vault.balanceOf(alice, Currency.wrap(address(token0)));
+            assertEq(currency0Balance, excessTokenAmount, "Unexpected currency0 balance in vault");
+        }
+    }
+
     // function testExactOutput_InsufficientAmountOut() public {
     //     //todo: in order to simulate this error, require
     //     // 1. hooks at beforeSwap do something funny on the pool resulting in actual amountOut lesser

diff --git a/test/pool-cl/CLSwapRouter.t.sol b/test/pool-cl/CLSwapRouter.t.sol
@@ -689,6 +689,40 @@ contract CLSwapRouterTest is TokenFixture, Test, GasSnapshot {
         snapEnd();
     }
 
+    function testSettleAndMintRefund() external {
+        // transfer excess token to vault
+        uint256 excessTokenAmount = 1 ether;
+        address hacker = address(1);
+        MockERC20(Currency.unwrap(currency0)).mint(hacker, excessTokenAmount);
+        vm.startPrank(hacker);
+        MockERC20(Currency.unwrap(currency0)).transfer(address(vault), excessTokenAmount);
+        vm.stopPrank();
+
+        uint256 amountOut = router.exactInputSingle(
+            ICLSwapRouterBase.V4CLExactInputSingleParams({
+                poolKey: poolKey0,
+                zeroForOne: true,
+                recipient: makeAddr("recipient"),
+                amountIn: 0.01 ether,
+                amountOutMinimum: 0,
+                sqrtPriceLimitX96: 0,
+                hookData: new bytes(0)
+            }),
+            block.timestamp + 100
+        );
+
+        uint256 received = IERC20(Currency.unwrap(currency1)).balanceOf(makeAddr("recipient"));
+        assertEq(received, amountOut);
+        // considering slippage and fee, tolerance is 1%
+        assertApproxEqAbs(amountOut, 1 ether, amountOut / 100);
+
+        // check currency balance in vault
+        {
+            uint256 currency0Balance = vault.balanceOf(address(this), currency0);
+            assertEq(currency0Balance, excessTokenAmount, "Unexpected currency0 balance in vault");
+        }
+    }
+
     // allow refund of ETH
     receive() external payable {}
 }
+1 −0		.gitattributes
+0 −3		.gitmodules
+1 −1		README.md
+1 −1		foundry.toml
+0 −1		lib/ds-test
+1 −1		package.json
+635 −0		scripts/vm.py
+518 −225		src/StdAssertions.sol
+8 −2		src/StdChains.sol
+7 −11		src/StdJson.sol
+201 −106		src/StdStorage.sol
+179 −0		src/StdToml.sol
+4 −4		src/Test.sol
+1,280 −469		src/Vm.sol
+51 −33		src/mocks/MockERC20.sol
+46 −32		src/mocks/MockERC721.sol
+39 −909		test/StdAssertions.t.sol
+29 −24		test/StdChains.t.sol
+18 −10		test/StdCheats.t.sol
+3 −1		test/StdError.t.sol
+49 −0		test/StdJson.t.sol
+8 −8		test/StdMath.t.sol
+159 −11		test/StdStorage.t.sol
+49 −0		test/StdToml.t.sol
+20 −20		test/StdUtils.t.sol
+3 −3		test/Vm.t.sol
+8 −0		test/fixtures/test.json
+6 −0		test/fixtures/test.toml
+1 −1		test/mocks/MockERC20.t.sol
+1 −1		test/mocks/MockERC721.t.sol
+1 −1		.github/actions/setup/action.yml
+13 −0		CHANGELOG.md
+21 −10		contracts/metatx/ERC2771Context.sol
+19 −0		contracts/mocks/Base64Dirty.sol
+6 −1		contracts/mocks/ERC2771ContextMock.sol
+1 −1		contracts/package.json
+1 −1		contracts/token/ERC20/extensions/ERC20Permit.sol
+1 −1		contracts/token/ERC20/extensions/IERC20Permit.sol
+19 −10		contracts/utils/Base64.sol
+5 −1		contracts/utils/Context.sol
+17 −3		contracts/utils/Multicall.sol
+2 −2		package-lock.json
+1 −1		package.json
+54 −1		test/metatx/ERC2771Context.test.js
+11 −1		test/utils/Base64.test.js
+135 −131		.gas-snapshot
+1 −2		README.md
+76 −10		src/test/ERC6909.t.sol
+1 −1		src/test/utils/mocks/MockERC4626.sol
+1 −1		src/tokens/ERC4626.sol
+4 −26		src/tokens/ERC6909.sol