Merge pull request #547 from liquity/zappers_rename_setInitialBalances

fix: Send leftovers to receiver in Zappers lever up and down
liquity · Oct 31, 2024 · cffc3e2 · cffc3e2
2 parents e3b4367 + 9c9ba2b
commit cffc3e2
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 17 deletions.
diff --git a/contracts/src/Zappers/GasCompZapper.sol b/contracts/src/Zappers/GasCompZapper.sol
@@ -125,7 +125,7 @@ contract GasCompZapper is BaseZapper {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensAndBalances(collToken, boldToken, initialBalances);
 
         // Pull Bold
         boldToken.transferFrom(msg.sender, address(this), _boldAmount);
@@ -184,7 +184,7 @@ contract GasCompZapper is BaseZapper {
             _checkAdjustTroveManagers(_troveId, _collChange, _isCollIncrease, _boldChange, _isDebtIncrease);
 
         // Set initial balances to make sure there are not lefovers
-        _setInitialBalances(collToken, boldToken, _initialBalances);
+        _setInitialTokensAndBalances(collToken, boldToken, _initialBalances);
 
         // Pull coll
         if (_isCollIncrease) {

diff --git a/contracts/src/Zappers/LeftoversSweep.sol b/contracts/src/Zappers/LeftoversSweep.sol
@@ -13,7 +13,14 @@ contract LeftoversSweep {
         address receiver;
     }
 
-    function _setInitialBalances(IERC20 _collToken, IBoldToken _boldToken, InitialBalances memory _initialBalances)
+    function _setInitialTokensAndBalances(IERC20 _collToken, IBoldToken _boldToken, InitialBalances memory _initialBalances)
+        internal
+        view
+    {
+        _setInitialTokensBalancesAndReceiver(_collToken, _boldToken, _initialBalances, msg.sender);
+    }
+
+    function _setInitialTokensBalancesAndReceiver(IERC20 _collToken, IBoldToken _boldToken, InitialBalances memory _initialBalances, address _receiver)
         internal
         view
     {

diff --git a/contracts/src/Zappers/LeverageLSTZapper.sol b/contracts/src/Zappers/LeverageLSTZapper.sol
@@ -27,7 +27,7 @@ contract LeverageLSTZapper is GasCompZapper, ILeverageZapper {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensAndBalances(collToken, boldToken, initialBalances);
 
         // Convert ETH to WETH
         WETH.deposit{value: msg.value}();
@@ -107,11 +107,11 @@ contract LeverageLSTZapper is GasCompZapper, ILeverageZapper {
 
     function leverUpTrove(LeverUpTroveParams calldata _params) external {
         address owner = troveNFT.ownerOf(_params.troveId);
-        _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
+        address receiver = _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensBalancesAndReceiver(collToken, boldToken, initialBalances, receiver);
 
         // Flash loan coll
         flashLoanProvider.makeFlashLoan(
@@ -152,11 +152,11 @@ contract LeverageLSTZapper is GasCompZapper, ILeverageZapper {
 
     function leverDownTrove(LeverDownTroveParams calldata _params) external {
         address owner = troveNFT.ownerOf(_params.troveId);
-        _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
+        address receiver = _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensBalancesAndReceiver(collToken, boldToken, initialBalances, receiver);
 
         // Flash loan coll
         flashLoanProvider.makeFlashLoan(

diff --git a/contracts/src/Zappers/LeverageWETHZapper.sol b/contracts/src/Zappers/LeverageWETHZapper.sol
@@ -26,7 +26,7 @@ contract LeverageWETHZapper is WETHZapper, ILeverageZapper {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(WETH, boldToken, initialBalances);
+        _setInitialTokensAndBalances(WETH, boldToken, initialBalances);
 
         // Convert ETH to WETH
         WETH.deposit{value: msg.value}();
@@ -104,11 +104,11 @@ contract LeverageWETHZapper is WETHZapper, ILeverageZapper {
 
     function leverUpTrove(LeverUpTroveParams calldata _params) external {
         address owner = troveNFT.ownerOf(_params.troveId);
-        _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
+        address receiver = _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(WETH, boldToken, initialBalances);
+        _setInitialTokensBalancesAndReceiver(WETH, boldToken, initialBalances, receiver);
 
         // Flash loan coll
         flashLoanProvider.makeFlashLoan(
@@ -149,11 +149,11 @@ contract LeverageWETHZapper is WETHZapper, ILeverageZapper {
 
     function leverDownTrove(LeverDownTroveParams calldata _params) external {
         address owner = troveNFT.ownerOf(_params.troveId);
-        _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
+        address receiver = _requireSenderIsOwnerOrRemoveManagerAndGetReceiver(_params.troveId, owner);
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(WETH, boldToken, initialBalances);
+        _setInitialTokensBalancesAndReceiver(WETH, boldToken, initialBalances, receiver);
 
         // Flash loan coll
         flashLoanProvider.makeFlashLoan(

diff --git a/contracts/src/Zappers/Modules/Exchanges/UniV3Exchange.sol b/contracts/src/Zappers/Modules/Exchanges/UniV3Exchange.sol
@@ -31,7 +31,7 @@ contract UniV3Exchange is LeftoversSweep, IExchange {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensAndBalances(collToken, boldToken, initialBalances);
 
         boldToken.transferFrom(msg.sender, address(this), _boldAmount);
         boldToken.approve(address(uniV3RouterCached), _boldAmount);
@@ -58,7 +58,7 @@ contract UniV3Exchange is LeftoversSweep, IExchange {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(collToken, boldToken, initialBalances);
+        _setInitialTokensAndBalances(collToken, boldToken, initialBalances);
 
         collToken.safeTransferFrom(msg.sender, address(this), _collAmount);
         collToken.approve(address(uniV3RouterCached), _collAmount);

diff --git a/contracts/src/Zappers/WETHZapper.sol b/contracts/src/Zappers/WETHZapper.sol
@@ -112,7 +112,7 @@ contract WETHZapper is BaseZapper {
 
         // Set initial balances to make sure there are not lefovers
         InitialBalances memory initialBalances;
-        _setInitialBalances(WETH, boldToken, initialBalances);
+        _setInitialTokensAndBalances(WETH, boldToken, initialBalances);
 
         // Pull Bold
         boldToken.transferFrom(msg.sender, address(this), _boldAmount);
@@ -177,7 +177,7 @@ contract WETHZapper is BaseZapper {
             payable(_checkAdjustTroveManagers(_troveId, _collChange, _isCollIncrease, _boldChange, _isDebtIncrease));
 
         // Set initial balances to make sure there are not lefovers
-        _setInitialBalances(WETH, boldToken, _initialBalances);
+        _setInitialTokensAndBalances(WETH, boldToken, _initialBalances);
 
         // ETH -> WETH
         if (_isCollIncrease) {