Skip to content

Commit 5d270c7

Browse files
committed
improve natspec
1 parent b19ad67 commit 5d270c7

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/interfaces/IEulerSwap.sol

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ interface IEulerSwap {
5656
returns (uint256);
5757

5858
/// @notice Upper-bounds on the amounts of each token that this pool can currently support swaps for.
59-
function getLimits(address tokenIn, address tokenOut) external view returns (uint256, uint256);
59+
/// @return limitIn Max amount of `tokenIn` that can be sold.
60+
/// @return limitOut Max amount of `tokenOut` that can be bought.
61+
function getLimits(address tokenIn, address tokenOut) external view returns (uint256 limitIn, uint256 limitOut);
6062

6163
/// @notice Optimistically sends the requested amounts of tokens to the `to`
6264
/// address, invokes `eulerSwapCall` callback on `to` (if `data` was provided),

src/interfaces/IEulerSwapPeriphery.sol

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ interface IEulerSwapPeriphery {
4040
view
4141
returns (uint256);
4242

43-
/// @notice Upper-bound on the max amount that can be sold of tokenIn and bought of tokenOut
44-
function getLimits(address eulerSwap, address tokenIn, address tokenOut) external view returns (uint256, uint256);
43+
/// @notice Upper-bounds on the amounts of each token that this pool can currently support swaps for.
44+
/// @return limitIn Max amount of `tokenIn` that can be sold.
45+
/// @return limitOut Max amount of `tokenOut` that can be bought.
46+
function getLimits(address eulerSwap, address tokenIn, address tokenOut) external view returns (uint256 limitIn, uint256 limitOut);
4547
}

0 commit comments

Comments
 (0)