refactor: rename depositAsset to asset

0xtekgrinder · 0xtekgrinder · commit cddfd4bfc626 · 2024-10-25T12:57:11.000+02:00
diff --git a/contracts/helpers/BaseHarvester.sol b/contracts/helpers/BaseHarvester.sol
@@ -13,7 +13,7 @@ import "../interfaces/IHarvester.sol";
 
 struct YieldBearingParams {
     // Address of the asset used to mint the yield bearing asset
-    address depositAsset;
+    address asset;
     // Target exposure to the collateral yield bearing asset used
     uint64 targetExposure;
     // Maximum exposure within the Transmuter to the deposit asset
@@ -92,23 +92,23 @@ abstract contract BaseHarvester is IHarvester, AccessControl {
     /**
      * @notice Set the yieldBearingAsset data
      * @param yieldBearingAsset address of the yieldBearingAsset
-     * @param depositAsset address of the depositAsset
+     * @param asset address of the asset
      * @param targetExposure target exposure to the yieldBearingAsset asset used
-     * @param minExposure minimum exposure within the Transmuter to the depositAsset
-     * @param maxExposure maximum exposure within the Transmuter to the depositAsset
+     * @param minExposure minimum exposure within the Transmuter to the asset
+     * @param maxExposure maximum exposure within the Transmuter to the asset
      * @param overrideExposures whether limit exposures should be overriden or read onchain through the Transmuter
      */
     function setYieldBearingAssetData(
         address yieldBearingAsset,
-        address depositAsset,
+        address asset,
         uint64 targetExposure,
         uint64 minExposure,
         uint64 maxExposure,
         uint64 overrideExposures
     ) external onlyGuardian {
         _setYieldBearingAssetData(
             yieldBearingAsset,
-            depositAsset,
+            asset,
             targetExposure,
             minExposure,
             maxExposure,
@@ -117,13 +117,13 @@ abstract contract BaseHarvester is IHarvester, AccessControl {
     }
 
     /**
-     * @notice Set the limit exposures to the depositAsset linked to the yield bearing asset
+     * @notice Set the limit exposures to the asset linked to the yield bearing asset
      * @param yieldBearingAsset address of the yield bearing asset
      */
     function updateLimitExposuresYieldAsset(address yieldBearingAsset) public virtual {
         YieldBearingParams storage yieldBearingInfo = yieldBearingData[yieldBearingAsset];
         if (yieldBearingInfo.overrideExposures == 2)
-            _updateLimitExposuresYieldAsset(yieldBearingInfo.depositAsset, yieldBearingInfo);
+            _updateLimitExposuresYieldAsset(yieldBearingInfo.asset, yieldBearingInfo);
     }
 
     /**
@@ -180,39 +180,39 @@ abstract contract BaseHarvester is IHarvester, AccessControl {
         (uint256 stablecoinsFromYieldBearingAsset, uint256 stablecoinsIssued) = transmuter.getIssuedByCollateral(
             yieldBearingAsset
         );
-        (uint256 stablecoinsFromDepositAsset, ) = transmuter.getIssuedByCollateral(yieldBearingInfo.depositAsset);
+        (uint256 stablecoinsFromAsset, ) = transmuter.getIssuedByCollateral(yieldBearingInfo.asset);
         uint256 targetExposureScaled = yieldBearingInfo.targetExposure * stablecoinsIssued;
         if (stablecoinsFromYieldBearingAsset * 1e9 > targetExposureScaled) {
             // Need to decrease exposure to yield bearing asset
             amount = stablecoinsFromYieldBearingAsset - targetExposureScaled / 1e9;
             uint256 maxValueScaled = yieldBearingInfo.maxExposure * stablecoinsIssued;
             // These checks assume that there are no transaction fees on the stablecoin->collateral conversion and so
             // it's still possible that exposure goes above the max exposure in some rare cases
-            if (stablecoinsFromDepositAsset * 1e9 > maxValueScaled) amount = 0;
-            else if ((stablecoinsFromDepositAsset + amount) * 1e9 > maxValueScaled)
-                amount = maxValueScaled / 1e9 - stablecoinsFromDepositAsset;
+            if (stablecoinsFromAsset * 1e9 > maxValueScaled) amount = 0;
+            else if ((stablecoinsFromAsset + amount) * 1e9 > maxValueScaled)
+                amount = maxValueScaled / 1e9 - stablecoinsFromAsset;
         } else {
             // In this case, exposure after the operation might remain slightly below the targetExposure as less
             // collateral may be obtained by burning stablecoins for the yield asset and unwrapping it
             increase = 1;
             amount = targetExposureScaled / 1e9 - stablecoinsFromYieldBearingAsset;
             uint256 minValueScaled = yieldBearingInfo.minExposure * stablecoinsIssued;
-            if (stablecoinsFromDepositAsset * 1e9 < minValueScaled) amount = 0;
-            else if (stablecoinsFromDepositAsset * 1e9 < minValueScaled + amount * 1e9)
-                amount = stablecoinsFromDepositAsset - minValueScaled / 1e9;
+            if (stablecoinsFromAsset * 1e9 < minValueScaled) amount = 0;
+            else if (stablecoinsFromAsset * 1e9 < minValueScaled + amount * 1e9)
+                amount = stablecoinsFromAsset - minValueScaled / 1e9;
         }
     }
 
     function _setYieldBearingAssetData(
         address yieldBearingAsset,
-        address depositAsset,
+        address asset,
         uint64 targetExposure,
         uint64 minExposure,
         uint64 maxExposure,
         uint64 overrideExposures
     ) internal virtual {
         YieldBearingParams storage yieldBearingInfo = yieldBearingData[yieldBearingAsset];
-        yieldBearingInfo.depositAsset = depositAsset;
+        yieldBearingInfo.asset = asset;
         if (targetExposure >= 1e9) revert InvalidParam();
         yieldBearingInfo.targetExposure = targetExposure;
         yieldBearingInfo.overrideExposures = overrideExposures;
@@ -222,22 +222,22 @@ abstract contract BaseHarvester is IHarvester, AccessControl {
             yieldBearingInfo.minExposure = minExposure;
         } else {
             yieldBearingInfo.overrideExposures = 2;
-            _updateLimitExposuresYieldAsset(depositAsset, yieldBearingInfo);
+            _updateLimitExposuresYieldAsset(asset, yieldBearingInfo);
         }
     }
 
     function _updateLimitExposuresYieldAsset(
-        address depositAsset,
+        address asset,
         YieldBearingParams storage yieldBearingInfo
     ) internal virtual {
         uint64[] memory xFeeMint;
-        (xFeeMint, ) = transmuter.getCollateralMintFees(depositAsset);
+        (xFeeMint, ) = transmuter.getCollateralMintFees(asset);
         uint256 length = xFeeMint.length;
         if (length <= 1) yieldBearingInfo.maxExposure = 1e9;
         else yieldBearingInfo.maxExposure = xFeeMint[length - 2];
 
         uint64[] memory xFeeBurn;
-        (xFeeBurn, ) = transmuter.getCollateralBurnFees(depositAsset);
+        (xFeeBurn, ) = transmuter.getCollateralBurnFees(asset);
         length = xFeeBurn.length;
         if (length <= 1) yieldBearingInfo.minExposure = 0;
         else yieldBearingInfo.minExposure = xFeeBurn[length - 2];
diff --git a/contracts/helpers/GenericHarvester.sol b/contracts/helpers/GenericHarvester.sol
@@ -112,13 +112,13 @@ contract GenericHarvester is BaseHarvester, IERC3156FlashBorrower, RouterSwapper
         (SwapType swapType, bytes memory data) = abi.decode(extraData, (SwapType, bytes));
 
         if (amount > 0) {
-            try transmuter.updateOracle(yieldBearingInfo.depositAsset) {} catch {}
+            try transmuter.updateOracle(yieldBearingInfo.asset) {} catch {}
 
             adjustYieldExposure(
                 amount,
                 increase,
                 yieldBearingAsset,
-                yieldBearingInfo.depositAsset,
+                yieldBearingInfo.asset,
                 (amount * (1e9 - maxSlippage)) / 1e9,
                 swapType,
                 data
@@ -136,7 +136,7 @@ contract GenericHarvester is BaseHarvester, IERC3156FlashBorrower, RouterSwapper
         uint256 amountStablecoins,
         uint8 increase,
         address yieldBearingAsset,
-        address depositAsset,
+        address asset,
         uint256 minAmountOut,
         SwapType swapType,
         bytes memory extraData
@@ -145,7 +145,7 @@ contract GenericHarvester is BaseHarvester, IERC3156FlashBorrower, RouterSwapper
             IERC3156FlashBorrower(address(this)),
             address(agToken),
             amountStablecoins,
-            abi.encode(msg.sender, increase, yieldBearingAsset, depositAsset, minAmountOut, swapType, extraData)
+            abi.encode(msg.sender, increase, yieldBearingAsset, asset, minAmountOut, swapType, extraData)
         );
     }
 
@@ -167,19 +167,19 @@ contract GenericHarvester is BaseHarvester, IERC3156FlashBorrower, RouterSwapper
         address tokenIn;
         {
             address yieldBearingAsset;
-            address depositAsset;
-            (sender, typeAction, yieldBearingAsset, depositAsset, minAmountOut, swapType, callData) = abi.decode(
+            address asset;
+            (sender, typeAction, yieldBearingAsset, asset, minAmountOut, swapType, callData) = abi.decode(
                 data,
                 (address, uint256, address, address, uint256, SwapType, bytes)
             );
             if (typeAction == 1) {
                 // Increase yield exposure action: we bring in the yield bearing asset
                 tokenOut = yieldBearingAsset;
-                tokenIn = depositAsset;
+                tokenIn = asset;
             } else {
                 // Decrease yield exposure action: we bring in the deposit asset
                 tokenIn = yieldBearingAsset;
-                tokenOut = depositAsset;
+                tokenOut = asset;
             }
         }
         uint256 amountOut = transmuter.swapExactInput(
diff --git a/contracts/helpers/MultiBlockHarvester.sol b/contracts/helpers/MultiBlockHarvester.sol
@@ -131,13 +131,13 @@ contract MultiBlockHarvester is BaseHarvester {
                 amount,
                 0,
                 address(agToken),
-                yieldBearingInfo.depositAsset,
+                yieldBearingInfo.asset,
                 address(this),
                 block.timestamp
             );
-            _checkSlippage(amount, amountOut, yieldBearingInfo.depositAsset, depositAddress, false);
+            _checkSlippage(amount, amountOut, yieldBearingInfo.asset, depositAddress, false);
             if (yieldBearingAsset == XEVT) {
-                _adjustAllowance(yieldBearingInfo.depositAsset, address(depositAddress), amountOut);
+                _adjustAllowance(yieldBearingInfo.asset, address(depositAddress), amountOut);
                 (uint256 shares, ) = IPool(depositAddress).deposit(amountOut, address(this));
                 _adjustAllowance(yieldBearingAsset, address(transmuter), shares);
                 amountOut = transmuter.swapExactInput(
@@ -149,7 +149,7 @@ contract MultiBlockHarvester is BaseHarvester {
                     block.timestamp
                 );
             } else if (yieldBearingAsset == USDM) {
-                IERC20(yieldBearingInfo.depositAsset).safeTransfer(depositAddress, amountOut);
+                IERC20(yieldBearingInfo.asset).safeTransfer(depositAddress, amountOut);
             }
         } else {
             uint256 amountOut = transmuter.swapExactInput(
