diff --git a/contracts/helpers/ARebalancerFlashloan.sol b/contracts/helpers/ARebalancerFlashloan.sol index 993c63dc..c1564335 100644 --- a/contracts/helpers/ARebalancerFlashloan.sol +++ b/contracts/helpers/ARebalancerFlashloan.sol @@ -27,8 +27,8 @@ contract ARebalancerFlashloan is Rebalancer, IERC3156FlashBorrower { IERC20(AGTOKEN).safeApprove(address(_flashloan), type(uint256).max); } - /// @notice Burns `amountStablecoins` for one collateral asset, swap for asset then mints stablecoins from the proceeds of the - /// swap + /// @notice Burns `amountStablecoins` for one collateral asset, swap for asset then mints stablecoins + /// from the proceeds of the swap. /// @dev If `increase` is 1, then the system tries to increase its exposure to the yield bearing asset which means /// burning stablecoin for the liquid asset, swapping for the yield bearing asset, then minting the stablecoin /// @dev This function reverts if the second stablecoin mint gives less than `minAmountOut` of stablecoins diff --git a/contracts/interfaces/IRebalancerFlashloan.sol b/contracts/interfaces/IRebalancerFlashloan.sol index 6f76178c..c7e3167d 100644 --- a/contracts/interfaces/IRebalancerFlashloan.sol +++ b/contracts/interfaces/IRebalancerFlashloan.sol @@ -8,12 +8,10 @@ import { IERC3156FlashBorrower } from "oz/interfaces/IERC3156FlashBorrower.sol"; /// @title IRebalancer /// @author Angle Labs, Inc. interface IRebalancerFlashloan is IRebalancer, IERC3156FlashBorrower { - /// @notice Burns `amountStablecoins` for one collateral asset, swap for asset then mints stablecoins from the proceeds of the - /// swap + /// @notice Burns `amountStablecoins` for one collateral asset and use the proceeds to mint the other collateral asset /// @dev If `increase` is 1, then the system tries to increase its exposure to the yield bearing asset which means /// burning stablecoin for the liquid asset, swapping for the yield bearing asset, then minting the stablecoin /// @dev This function reverts if the second stablecoin mint gives less than `minAmountOut` of stablecoins - /// @dev This function reverts if the swap slippage is higher than `maxSlippage` function adjustYieldExposure( uint256 amountStablecoins, uint8 increase,