Consider renaming the hooks to avoid potential conflicts

[PaulRBerg]

@razgraf has originally made this suggestion in sablier-labs/v2-periphery#112:

The proxy plugin used for the Sablier on-cancel callback is called onStreamCanceled.

https://github.com/sablier-labs/v2-periphery/blob/453a35ef662183654138bfe8cab2b523f340fa5b/src/SablierV2ProxyPlugin.sol#L77-L79

Wouldn't renaming it in something more unique (e.g. onSablierStreamCanceled) help prevent unintended collisions in the future (e.g. other project using the PRBProxy doing "Potato Streaming")? That's not necessarily intended to improve security (as bad players could still engineer plugins with our original name) but unknowing developers may benefit from this.

However, I've opened another discussion here because it's the ISablierV2LockupSender hook that dictates what function the proxy plugin inherits:

v2-core/src/interfaces/hooks/ISablierV2LockupSender.sol

Lines 20 to 26 in eb5014d

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

Now, about the suggestion itself - it's a great idea, but we've unfortunately run out of time, and we won't be able to implement it if we want to stick to the July 10 deadline :(

Happy to re-consider the idea for V2.x

[PaulRBerg]

Any thoughts on this, @andreivladbrg, @smol-ninja?

We might be able to include this in V2.2

[andreivladbrg]

i have and this is my take:

it would be redundant as the interface name is ISablierV2LockupRecipient - it already has the Sablier aspect

[PaulRBerg]

In this case, you've missed a crucial part of Razvan's point. Let me copy-paste it:

Wouldn't renaming it in something more unique (e.g., onSablierStreamCanceled) help prevent unintended collisions in the future

The word "collisions" is key.

It's not about the name of the interface. It's about potential collisions with other interfaces. If we rename the hooks to include the name "Sablier", the problem is solved.

Do you understand now?

[andreivladbrg]

i do understand, but adding Sablier is not good enough for me, i would rather suggest:

interface ISablierV2Recipient {
     function onLockupStreamCanceled(uint256 streamId, address sender, uint128 senderAmount, uint128 recipientAmount) external;
     function onLockupStreamRenounced(uint256 streamId) external;
     function onLockupStreamWithdrawn(uint256 streamId, address caller, address to, uint128 amount) external;
     function onOpenEndedStreamCanceled(uint256 streamId, address sender, uint128 senderAmount, uint128 recipientAmount) external;
     function onOpenEndedStreamWithdrawn(uint256 streamId, address caller, address to, uint128 amount) external;
}

[smol-ninja]

I understand Razvan's argument. We should rename it if the motivation is developer experience.

[PaulRBerg]

adding Sablier is not good enough for me, i would rather suggest:

This is a completely different idea, and I like it.

[andreivladbrg]

closing as we agreed, and created #736