renamed to onInFlowDeleted and onOutFlowDeleted

Author: d10r

packages/ethereum-contracts/CHANGELOG.md

@@ -72,11 +72,10 @@ subtask(TASK_COMPILE_GET_REMAPPINGS).setAction(
 - `SuperTokenV1Library.distribute`: return `actualAmount` instead of a bool
 
 # Breaking
-- CFASuperAppBase: `onFlowDeleted` from now on only handles events related to incoming flows, while for events triggered by outgoing flows `onOutFlowDeleted` is invoked.
-  This is safer because the latter case is in many cases unexpected and may thus not be handled correctly, potentially leading to state corruption or SuperApp jailing.
-  The change is breaking because of a signature change in `onFlowDeleted`. The removal of the now unnecessary `receiver` argument also makes sure
-  that this change can't without notice break implementations which correctly handled the corner case of an outgoing flow with the previous implementation of CFASuperAppBase.
-  Many applications may not want/need to handle the case of outgoing flows being deleted, thus don't need to override the newly added `onOutFlowDeleted`.
+- CFASuperAppBase: `onFlowDeleted` is replaced by `onInFlowDeleted` and `onOutFlowDeleted`.
+  This is safer because the latter hook handles a case (outgoing flow being deleted by its receiver) which is often not expected.
+  In the past, apps creating outflows had to explicitly distinguish between the 2 possible triggers in order to avoid potentially invalid state changes or even jailing.
+  Most apps will want to implement just `onInFlowDeleted`.
 
 ## [v1.12.0]
 

packages/ethereum-contracts/contracts/apps/CFASuperAppBase.sol

@@ -153,9 +153,9 @@ abstract contract CFASuperAppBase is ISuperApp {
 
     /// @dev override if the SuperApp shall have custom logic invoked when an existing flow
     ///      to it is deleted (flowrate set to 0).
-    ///      Unlike the other callbacks, this method is NOT allowed to revert.
+    ///      Unlike the other callbacks, the delete callbacks are NOT allowed to revert.
     ///      Failing to satisfy that requirement leads to jailing (defunct SuperApp).
-    function onFlowDeleted(
+    function onInFlowDeleted(
         ISuperToken /*superToken*/,
         address /*sender*/,
         int96 /*previousFlowRate*/,
@@ -168,13 +168,13 @@ abstract contract CFASuperAppBase is ISuperApp {
     /// @dev override if the SuperApp shall have custom logic invoked when an outgoing flow
     ///      is deleted by the receiver (it's not triggered when deleted by the SuperApp itself).
     ///      A possible implementation is to make outflows "sticky" by simply reopening it.
-    ///      Like onFlowDeleted, this method is NOT allowed to revert.
+    ///      Like onInFlowDeleted, this method is NOT allowed to revert.
     ///      It's safe to not override this method if the SuperApp doesn't have outgoing flows,
     ///      or if it doesn't want/need to know if an outgoing flow is deleted by its receiver.
     /// Note: In theory this hook could also be triggered by a liquidation, but this would imply
     /// that the SuperApp is insolvent, and would thus be jailed already.
     /// Thus in practice this is triggered only when a receiver of an outgoing flow deletes that flow.
-    function onOutflowDeleted(
+    function onOutFlowDeleted(
         ISuperToken /*superToken*/,
         address /*receiver*/,
         int96 /*previousFlowRate*/,
@@ -324,7 +324,7 @@ abstract contract CFASuperAppBase is ISuperApp {
 
         if (receiver == address(this)) {
             return
-                onFlowDeleted(
+                onInFlowDeleted(
                     superToken,
                     sender,
                     previousFlowRate,
@@ -333,7 +333,7 @@ abstract contract CFASuperAppBase is ISuperApp {
                 );
         } else {
             return
-                onOutflowDeleted(
+                onOutFlowDeleted(
                     superToken,
                     receiver,
                     previousFlowRate,

packages/ethereum-contracts/test/foundry/apps/CFASuperAppBaseTester.t.sol

@@ -72,7 +72,7 @@ contract CFASuperAppBaseTester is CFASuperAppBase {
 
     // DELETE
 
-    function onFlowDeleted(
+    function onInFlowDeleted(
         ISuperToken, /*superToken*/
         address sender,
         int96 previousFlowRate,
@@ -85,7 +85,7 @@ contract CFASuperAppBaseTester is CFASuperAppBase {
         return ctx;
     }
 
-    function onOutflowDeleted(
+    function onOutFlowDeleted(
         ISuperToken, /*superToken*/
         address receiver,
         int96 previousFlowRate,

packages/ethereum-contracts/test/foundry/apps/SuperAppTester/FlowSplitter.sol

@@ -129,7 +129,7 @@ contract FlowSplitter is CFASuperAppBase {
         );
     }
 
-    function onFlowDeleted(
+    function onInFlowDeleted(
         ISuperToken superToken,
         address, /*sender*/
         int96 previousFlowRate,
@@ -160,7 +160,7 @@ contract FlowSplitter is CFASuperAppBase {
         }
     }
 
-    function onOutflowDeleted(
+    function onOutFlowDeleted(
         ISuperToken superToken,
         address receiver,
         int96 previousFlowRate,

packages/ethereum-contracts/test/foundry/apps/SuperTokenV1Library.t.sol

@@ -553,18 +553,18 @@ contract SuperAppMock is CFASuperAppBase {
         return _mirrorOrMatchIncomingFlow(superToken, sender, ctx);
     }
 
-    function onFlowDeleted(
+    function onInFlowDeleted(
         ISuperToken superToken,
         address sender,
-        int96 previousFlowRate,
+        int96 /*previousFlowRate*/,
         uint256 /*lastUpdated*/,
         bytes calldata ctx
     ) internal virtual override returns (bytes memory /*newCtx*/) {
         return _mirrorOrMatchIncomingFlow(superToken, sender, ctx);
     }
 
     // outflow was deleted by the sender we mirror to, we make it "sticky" by simply restoring it.
-    function onOutflowDeleted(
+    function onOutFlowDeleted(
         ISuperToken superToken,
         address receiver,
         int96 previousFlowRate,