Skip to main content

Implement Hooks

In this guide, we will explain how to implement hooks in your on-chain integration of Sablier.

Overview​

Recipient​

These are the hooks that can be implemented by a recipient contract:

HookArgumentsDescription
onStreamCanceled(streamId,sender,senderAmount,recipientAmount)Called when the stream is canceled by the sender.
onStreamRenounced(streamId)Called when the stream is renounced by the sender.
onStreamWithdrawn(streamId,caller,to,amount)Called when the sender or an an approved NFT operator withdraws from the stream.
caution

While it isn't mandatory, we highly recommend implementing the onStreamCanceled and, more importantly, the onStreamWithdrawn hook. Doing so enables your contract to keep its internal accounting updated accurately.

Sender​

And these are the hooks that can be implemented by a sender contract:

HookArgumentsDescription
onStreamCanceled(streamId,sender,senderAmount,recipientAmount)Called when the stream is canceled by the sender.

Sample Implementations​

Recipient​

Sablier Recipient Hooks
loading...

Sender​

Sablier Sender Hooks
loading...

Error Management​

danger

Reverts in your hooks will NOT be picked up by Sablier. If your hook reverts, the original transaction will go through, but any state changes made by your hook will be reverted.