Skip to content

Commit

Permalink
fix: natspec on borrow and withdraw
Browse files Browse the repository at this point in the history
  • Loading branch information
Jean-Grimal committed Dec 18, 2023
1 parent b48b0cf commit acf96da
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/interfaces/IMorpho.sol
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ interface IMorphoBase {
bytes memory data
) external returns (uint256 assetsSupplied, uint256 sharesSupplied);

/// @notice Withdraws `assets` or `shares` on behalf of `onBehalf` to `receiver`.
/// @notice Withdraws `assets` or `shares` on behalf of `onBehalf` and sends the assets to `receiver`.
/// @dev Either `assets` or `shares` should be zero. To withdraw max, pass the `shares`'s balance of `onBehalf`.
/// @dev `msg.sender` must be authorized to manage `onBehalf`'s positions.
/// @dev Withdrawing an amount corresponding to more shares than supplied will revert for underflow.
Expand All @@ -172,7 +172,7 @@ interface IMorphoBase {
address receiver
) external returns (uint256 assetsWithdrawn, uint256 sharesWithdrawn);

/// @notice Borrows `assets` or `shares` on behalf of `onBehalf` to `receiver`.
/// @notice Borrows `assets` or `shares` on behalf of `onBehalf` and sends the assets to `receiver`.
/// @dev Either `assets` or `shares` should be zero. Most use cases should rely on `assets` as an input so the
/// caller is guaranteed to borrow `assets` of tokens, but the possibility to mint a specific amount of shares is
/// given for full compatibility and precision.
Expand Down Expand Up @@ -228,7 +228,7 @@ interface IMorphoBase {
function supplyCollateral(MarketParams memory marketParams, uint256 assets, address onBehalf, bytes memory data)
external;

/// @notice Withdraws `assets` of collateral on behalf of `onBehalf` to `receiver`.
/// @notice Withdraws `assets` of collateral on behalf of `onBehalf` and sends the assets to `receiver`.
/// @dev `msg.sender` must be authorized to manage `onBehalf`'s positions.
/// @dev Withdrawing an amount corresponding to more collateral than supplied will revert for underflow.
/// @param marketParams The market to withdraw collateral from.
Expand Down

0 comments on commit acf96da

Please sign in to comment.