Skip to content

Commit 8466db6

Browse files
committed
natspec improvements
Spearbit #2
1 parent 6535ab7 commit 8466db6

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

src/EulerSwapManagement.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ import {FundsLib} from "./libraries/FundsLib.sol";
1111
import {CurveLib} from "./libraries/CurveLib.sol";
1212
import {SwapLib} from "./libraries/SwapLib.sol";
1313

14+
/// @title EulerSwapManagement contract
15+
/// @custom:security-contact security@euler.xyz
16+
/// @author Euler Labs (https://www.eulerlabs.com/)
1417
contract EulerSwapManagement is EulerSwapBase {
1518
error Unauthorized();
1619
error AlreadyActivated();

src/interfaces/IEulerSwapCallee.sol

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,9 @@ interface IEulerSwapCallee {
66
/// is invoked on the `to` address, allowing flash-swaps (withdrawing output before
77
/// sending input.
88
/// @dev This callback mechanism is designed to be as similar as possible to Uniswap2.
9+
/// @param sender The address that originated the swap
10+
/// @param amount0 The requested output amount of token0
11+
/// @param amount1 The requested output amount of token1
12+
/// @param data Opaque callback data passed by swapper
913
function eulerSwapCall(address sender, uint256 amount0, uint256 amount1, bytes calldata data) external;
1014
}

src/libraries/FundsLib.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ library FundsLib {
7272
/// @param amount The total amount to deposit
7373
/// @return The amount of assets successfully deposited (may be less than requested)
7474
/// @dev This function attempts to deposit assets into the specified vault.
75-
/// @dev If the deposit fails with E_ZeroShares error, it safely returns 0 (this happens with very small amounts).
75+
/// @dev If the deposit fails with E_ZeroShares or ZeroShares error, it safely returns 0 (this happens with very small amounts).
7676
/// @dev After successful deposit, if the user has any outstanding controller-enabled debt, it attempts to repay it.
7777
/// @dev If all debt is repaid, the controller is automatically disabled to reduce gas costs in future operations.
7878
function depositAssets(address evc, address eulerAccount, address supplyVault, address borrowVault, uint256 amount)

0 commit comments

Comments
 (0)