Update metadata before hook in cancel function (#727)

* fix: update metadata before hook in cancel * test: update Precompiles bytecode * chore: improve explanatory comment in dynamic contract * chore: simplify comments * test: update Precompiles bytecode --------- Co-authored-by: Paul Razvan Berg <[email protected]>
sablier-labs · Nov 28, 2023 · fbab619 · fbab619
1 parent 8806d8b
commit fbab619
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/src/SablierV2LockupDynamic.sol b/src/SablierV2LockupDynamic.sol
@@ -515,6 +515,9 @@ contract SablierV2LockupDynamic is
         // Log the cancellation.
         emit ISablierV2Lockup.CancelLockupStream(streamId, sender, recipient, asset, senderAmount, recipientAmount);
 
+        // Emits an ERC-4906 event to trigger an update of the NFT metadata.
+        emit MetadataUpdate({ _tokenId: streamId });
+
         // Interactions: if the recipient is a contract, try to invoke the cancel hook on the recipient without
         // reverting if the hook is not implemented, and without bubbling up any potential revert.
         if (recipient.code.length > 0) {

diff --git a/src/SablierV2LockupLinear.sol b/src/SablierV2LockupLinear.sol
@@ -430,6 +430,9 @@ contract SablierV2LockupLinear is
         // Log the cancellation.
         emit ISablierV2Lockup.CancelLockupStream(streamId, sender, recipient, asset, senderAmount, recipientAmount);
 
+        // Emits an ERC-4906 event to trigger an update of the NFT metadata.
+        emit MetadataUpdate({ _tokenId: streamId });
+
         // Interactions: if the recipient is a contract, try to invoke the cancel hook on the recipient without
         // reverting if the hook is not implemented, and without bubbling up any potential revert.
         if (recipient.code.length > 0) {

diff --git a/src/abstracts/SablierV2Lockup.sol b/src/abstracts/SablierV2Lockup.sol
@@ -150,7 +150,7 @@ abstract contract SablierV2Lockup is
     }
 
     /// @inheritdoc ISablierV2Lockup
-    function cancel(uint256 streamId) public override noDelegateCall updateMetadata(streamId) {
+    function cancel(uint256 streamId) public override noDelegateCall {
         // Checks: the stream is neither depleted nor canceled. This also checks that the stream is not null.
         if (isDepleted(streamId)) {
             revert Errors.SablierV2Lockup_StreamDepleted(streamId);

diff --git a/test/utils/Precompiles.sol b/test/utils/Precompiles.sol