Skip to content

Commit

Permalink
refactor: withdraw related notes
Browse files Browse the repository at this point in the history
  • Loading branch information
smol-ninja committed Jan 12, 2024
1 parent 8ac610d commit 742ec20
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
5 changes: 3 additions & 2 deletions src/interfaces/ISablierV2Lockup.sol
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,8 @@ interface ISablierV2Lockup is
/// @dev Emits a {Transfer}, {WithdrawFromLockupStream}, and {MetadataUpdate} event.
///
/// Notes:
/// - This function attempts to invoke a hook on the stream's recipient, provided that the recipient is a contract
/// and `msg.sender` is not the recipient.
/// - This function attempts to call a hook on the recipient of the stream, unless `msg.sender` is the recipient.
/// - This function attempts to call a hook on the sender of the stream, unless `msg.sender` is the sender.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down Expand Up @@ -295,6 +295,7 @@ interface ISablierV2Lockup is
///
/// Notes:
/// - This function attempts to call a hook on the recipient of each stream, unless `msg.sender` is the recipient.
/// - This function attempts to call a hook on the sender of each stream, unless `msg.sender` is the sender.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down
2 changes: 1 addition & 1 deletion src/interfaces/hooks/ISablierV2Recipient.sol
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ interface ISablierV2Recipient {
/// @param streamId The id of the renounced stream.
function onLockupStreamRenounced(uint256 streamId) external;

/// @notice Responds to withdrawals triggered by either the stream's sender or an approved third party.
/// @notice Responds to withdrawals triggered by anyone unless `caller` is the recipient address.
///
/// @dev Notes:
/// - This function may revert, but the Sablier contract will ignore the revert.
Expand Down
2 changes: 1 addition & 1 deletion src/interfaces/hooks/ISablierV2Sender.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pragma solidity >=0.8.22;
/// @dev Implementation of this interface is optional. If a sender contract doesn't implement this
/// interface or implements it partially, function execution will not revert.
interface ISablierV2Sender {
/// @notice Responds to withdrawals triggered by either the stream's recipient or an approved third party.
/// @notice Responds to withdrawals triggered by anyone unless `caller` is the sender address.
///
/// @dev Notes:
/// - This function may revert, but the Sablier contract will ignore the revert.
Expand Down
1 change: 0 additions & 1 deletion test/integration/fuzz/lockup/withdraw.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@ abstract contract Withdraw_Integration_Fuzz_Test is Integration_Test, Withdraw_I
/// - Multiple withdraw amounts
function testFuzz_Withdraw(
uint256 timeJump,
address caller,
address to,
uint128 withdrawAmount
)
Expand Down

0 comments on commit 742ec20

Please sign in to comment.