Skip to content

Commit

Permalink
docs: polish natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulRBerg committed Jan 6, 2025
1 parent 43cf223 commit e270e09
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/interfaces/ISablierLockupBase.sol
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,7 @@ interface ISablierLockupBase is
/// Notes:
/// - If there any tokens left for the recipient to withdraw, the stream is marked as canceled. Otherwise, the
/// stream is marked as depleted.
/// - This function attempts to call a hook on the recipient of the stream, unless msg.sender is the recipient or
/// the recipient is not on the allowlist.
/// - If the address is on the allowlist, this function will invoke a hook on the recipient.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down Expand Up @@ -275,7 +274,7 @@ interface ISablierLockupBase is
/// @dev Emits a {CollectFees} event.
///
/// Notes:
/// - If the admin is a contract, it must be able to receive ETH.
/// - If the admin is a contract, it must be able to receive native token payments, e.g., ETH for Ethereum Mainnet.
function collectFees() external;

/// @notice Removes the right of the stream's sender to cancel the stream.
Expand Down Expand Up @@ -325,7 +324,8 @@ interface ISablierLockupBase is
/// @dev Emits a {Transfer}, {WithdrawFromLockupStream}, and {MetadataUpdate} event.
///
/// Notes:
/// - This function attempts to call a hook on the recipient of the stream, unless `msg.sender` is the recipient.
/// - If `msg.sender` is not the recipient and the address is on the allowlist, this function will invoke a hook on
/// the recipient.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down
1 change: 1 addition & 0 deletions src/libraries/VestingMath.sol
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ library VestingMath {
/// - $s$ is the start unlock amount.
/// - $c$ is the cliff unlock amount.
///
/// TODO: edit this
/// Assumptions:
/// 1. unlockAmounts.start + unlockAmounts.cliff does not overflow uint128
/// 2. timestamps.start < timestamps.end and timestamps.start <= block.timestamp <= timestamps.end
Expand Down

0 comments on commit e270e09

Please sign in to comment.