Skip to content

Commit

Permalink
chore: correct explanatory comment for cancel
Browse files Browse the repository at this point in the history
style: order alphabetically functions
  • Loading branch information
andreivladbrg committed Nov 24, 2023
1 parent ba827e1 commit e1a53b4
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions src/interfaces/ISablierV2Lockup.sol
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,11 @@ interface ISablierV2Lockup is
/// @param streamId The stream id for the query.
function isStream(uint256 streamId) external view returns (bool result);

/// @notice Retrieves a flag indicating whether the stream NFT can be transferred.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream id for the query.
function isTransferable(uint256 streamId) external view returns (bool result);

/// @notice Retrieves a flag indicating whether the stream is warm, i.e. either pending or streaming.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream id for the query.
Expand Down Expand Up @@ -155,11 +160,6 @@ interface ISablierV2Lockup is
/// @param streamId The stream id for the query.
function withdrawableAmountOf(uint256 streamId) external view returns (uint128 withdrawableAmount);

/// @notice Retrieves a flag indicating whether the stream NFT can be transferred.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream id for the query.
function isTransferable(uint256 streamId) external view returns (bool);

/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
Expand All @@ -184,8 +184,7 @@ interface ISablierV2Lockup is
/// Notes:
/// - If there any assets left for the recipient to withdraw, the stream is marked as canceled. Otherwise, the
/// stream is marked as depleted.
/// - This function attempts to invoke a hook on either the sender or the recipient, depending on who `msg.sender`
/// is, and if the resolved address is a contract.
/// - This function attempts to invoke a hook on the recipient, if the resolved address is a contract.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down

0 comments on commit e1a53b4

Please sign in to comment.