docs(proxy-target): align @notice for "depositUnderlyingAndMintHToken…

…AndAddLiquidityWithSignature" docs(proxy-target): reword @notice for "removeLiquidityAndWithdrawUnderlyingWithSignature" function style(proxy-target): add space to maintain separate code sections
hifi-finance · Apr 20, 2022 · 6594992 · 6594992
1 parent 2b0bbfb
commit 6594992
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/proxy-target/contracts/HifiProxyTarget.sol b/packages/proxy-target/contracts/HifiProxyTarget.sol
@@ -801,6 +801,7 @@ contract HifiProxyTarget is IHifiProxyTarget {
                 hToken.transfer(msg.sender, hTokenDelta);
             }
         }
+
         // Relay all the underlying it to the end user.
         uint256 totalUnderlyingAmount = underlyingReturned + withdrawAmount;
         hToken.underlying().safeTransfer(msg.sender, totalUnderlyingAmount);

diff --git a/packages/proxy-target/contracts/IHifiProxyTarget.sol b/packages/proxy-target/contracts/IHifiProxyTarget.sol
@@ -499,8 +499,7 @@ interface IHifiProxyTarget {
     /// @param underlyingAmount The amount of underlying to deposit.
     function depositUnderlying(IHToken hToken, uint256 underlyingAmount) external;
 
-    /// @notice Deposits underlying in the HToken contract to mint hTokens, and adds liquidity
-    /// to the AMM.
+    /// @notice Deposits underlying in the HToken contract to mint hTokens, and adds liquidity to the AMM.
     ///
     /// Requirements:
     /// - The caller must have allowed the DSProxy to spend `depositAmount + underlyingOffered` tokens.
@@ -514,7 +513,7 @@ interface IHifiProxyTarget {
         uint256 underlyingOffered
     ) external;
 
-    /// @notice Deposits underlying as collateral into the vault, and adds liquidity to the AMM using
+    /// @notice Deposits underlying in the HToken contract to mint hTokens, and adds liquidity to the AMM using
     /// EIP-2612 signatures.
     ///
     /// Requirements:
@@ -701,7 +700,7 @@ interface IHifiProxyTarget {
         uint256 withdrawAmount
     ) external;
 
-    /// @notice Removes liquidity from the AMM, and withdraws underlying using EIP-2612 signatures..
+    /// @notice Removes liquidity from the AMM, and withdraws underlying in exchange for hTokens using EIP-2612 signatures.
     ///
     /// @dev Requirements:
     /// - The `signature` must be a valid signed approval given by the caller to the DSProxy to spend `poolTokensBurned`