ISablierV2LockupSender

Git Source

Interface for sender contracts capable of reacting to cancellations.

Implementation of this interface is optional. If a sender contract doesn't implement this interface, function execution will not revert.

Functions

onStreamCanceled

Responds to recipient-triggered cancellations.

Notes:

• This function may revert, but the Sablier contract will ignore the revert.

function onStreamCanceled(
    uint256 streamId,
    address recipient,
    uint128 senderAmount,
    uint128 recipientAmount
)
    external;

Parameters

Name	Type	Description
streamId	uint256	The id of the canceled stream.
recipient	address	The stream's recipient, who canceled the stream.
senderAmount	uint128	The amount of assets refunded to the stream's sender, denoted in units of the asset's decimals.
recipientAmount	uint128	The amount of assets left for the stream's recipient to withdraw, denoted in units of the asset's decimals.