getFlowRate and getFlowInfo now also support querying the flowrate from pools to pool members

Author: d10r

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

@@ -122,44 +122,55 @@ library SuperTokenV1Library {
     /**
      * @dev get flow rate between two accounts for given token
      * @param token The token used in flow
-     * @param sender The sender of the flow
+     * @param senderOrPool The sender or pool sending the flow
      * @param receiverOrPool The receiver or pool receiving or distributing the flow
-     * @return flowRate The flow rate
-     * Note: edge case: if a CFA stream is going to a pool, it will return 0.
+     * @return flowRate The flowrate
+     * Note: this method auto-detects if it shall look at CFA or GDA flows.
+     * For GDA flows, either sender or receiver need to be a pool.
      */
-    function getFlowRate(ISuperToken token, address sender, address receiverOrPool)
+    function getFlowRate(ISuperToken token, address senderOrPool, address receiverOrPool)
         internal view returns(int96 flowRate)
     {
+        // GDA account (distributor) -> pool
         if (_isPool(token, receiverOrPool)) {
             (, IGeneralDistributionAgreementV1 gda) = _getHostAndGDA(token);
-            (, flowRate,) = gda.getFlow(token, sender, ISuperfluidPool(receiverOrPool));
+            (, flowRate,) = gda.getFlow(token, senderOrPool, ISuperfluidPool(receiverOrPool));
+        // GDA pool -> account (pool member)
+        } else if (_isPool(token, senderOrPool)) {
+            flowRate = ISuperfluidPool(senderOrPool).getMemberFlowRate(receiverOrPool);
+        // CFA account -> account
         } else {
             (, IConstantFlowAgreementV1 cfa) = _getHostAndCFA(token);
-            (, flowRate, , ) = cfa.getFlow(token, sender, receiverOrPool);
+            (, flowRate, , ) = cfa.getFlow(token, senderOrPool, receiverOrPool);
         }
     }
 
     /**
-     * @dev get flow info between an account and another account or pool for given token
+     * @dev get flow info between an account or pool and another account or pool for given token
      * @param token The token used in flow
-     * @param sender The sender of the flow
+     * @param senderOrPool The sender or pool sending the flow
      * @param receiverOrPool The receiver or pool receiving or distributing the flow
-     * @return lastUpdated Timestamp of flow creation or last flowrate change
-     * @return flowRate The flow rate
-     * @return deposit The amount of deposit the flow
-     * @return owedDeposit The amount of owed deposit of the flow
-     * Note: edge case: a CFA stream going to a pool will not be "seen".
+     * @return lastUpdated Timestamp of flow creation or last flowrate change. Not set if the sender is a pool.
+     * @return flowRate The flow rate.
+     * @return deposit The amount of deposit of the flow.
+     * @return owedDeposit The amount of owed deposit of the flow.
      */
-    function getFlowInfo(ISuperToken token, address sender, address receiverOrPool)
+    function getFlowInfo(ISuperToken token, address senderOrPool, address receiverOrPool)
         internal view
         returns(uint256 lastUpdated, int96 flowRate, uint256 deposit, uint256 owedDeposit)
     {
+        // GDA account (distributor) -> pool
         if (_isPool(token, receiverOrPool)) {
             (, IGeneralDistributionAgreementV1 gda) = _getHostAndGDA(token);
-            (lastUpdated, flowRate, deposit) = gda.getFlow(token, sender, ISuperfluidPool(receiverOrPool));
+            (lastUpdated, flowRate, deposit) = gda.getFlow(token, senderOrPool, ISuperfluidPool(receiverOrPool));
+        // GDA pool -> account (pool member)
+        } else if (_isPool(token, senderOrPool)) {
+            flowRate = ISuperfluidPool(senderOrPool).getMemberFlowRate(receiverOrPool);
+            // deposit and lastUpdated are not set in this case
+        // CFA account -> account
         } else {
             (, IConstantFlowAgreementV1 cfa) = _getHostAndCFA(token);
-            (lastUpdated, flowRate, deposit, owedDeposit) = cfa.getFlow(token, sender, receiverOrPool);
+            (lastUpdated, flowRate, deposit, owedDeposit) = cfa.getFlow(token, senderOrPool, receiverOrPool);
         }
     }
 

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

@@ -288,9 +288,11 @@ contract SuperTokenV1LibraryTest is FoundrySuperfluidTester {
         ISuperfluidPool pool = superToken.createPool();
         pool.updateMemberUnits(bob, 1);
 
-        assertEq(superToken.getFlowRate(address(this), address(pool)), 0);
+        assertEq(superToken.getFlowRate(address(this), address(pool)), 0, "getFlowRate to pool not zero");
+        assertEq(superToken.getFlowRate(address(pool), bob), 0, "getFlowRate to pool member not zero");
         superToken.distributeFlow(pool, DEFAULT_FLOWRATE);
-        assertEq(superToken.getFlowRate(address(this), address(pool)), DEFAULT_FLOWRATE);
+        assertEq(superToken.getFlowRate(address(this), address(pool)), DEFAULT_FLOWRATE, "getFlowRate to pool wrong");
+        assertEq(superToken.getFlowRate(address(pool), bob), DEFAULT_FLOWRATE, "getFlowRate to pool member wrong");
     }
 
     function testGetFlowInfoWithCFA() external {
@@ -302,7 +304,6 @@ contract SuperTokenV1LibraryTest is FoundrySuperfluidTester {
         assertEq(owedDeposit1, 0);
 
         superToken.flow(bob, DEFAULT_FLOWRATE);
-
         (uint256 lastUpdated2, int96 flowRate2, uint256 deposit2, uint256 owedDeposit2) =
             superToken.getFlowInfo(address(this), bob);
         assertEq(flowRate2, DEFAULT_FLOWRATE);
@@ -316,20 +317,26 @@ contract SuperTokenV1LibraryTest is FoundrySuperfluidTester {
         ISuperfluidPool pool = superToken.createPool();
         pool.updateMemberUnits(bob, 1);
 
-        (uint256 lastUpdated1, int96 flowRate1, uint256 deposit1, uint256 owedDeposit1) =
+        (uint256 lastUpdatedToPoolBefore, int96 flowRateToPoolBefore, uint256 depositToPoolBefore, uint256 owedDepositToPoolBefore) =
             superToken.getFlowInfo(address(this), address(pool));
-        assertEq(flowRate1, 0);
-        assertEq(deposit1, 0);
-        assertEq(owedDeposit1, 0);
+        assertEq(flowRateToPoolBefore, 0);
+        assertEq(depositToPoolBefore, 0);
+        assertEq(owedDepositToPoolBefore, 0);
+
+        (, int96 flowRateToMemberBefore, , ) = superToken.getFlowInfo(address(pool), bob);
+        assertEq(flowRateToMemberBefore, 0);
 
         superToken.distributeFlow(pool, DEFAULT_FLOWRATE);
 
-        (uint256 lastUpdated2, int96 flowRate2, uint256 deposit2, uint256 owedDeposit2) =
+        (uint256 lastUpdatedToPoolAfter, int96 flowRateToPoolAfter, uint256 depositToPoolAfter, uint256 owedDepositToPoolAfter) =
             superToken.getFlowInfo(address(this), address(pool));
-        assertEq(flowRate2, DEFAULT_FLOWRATE);
-        assert(deposit2 > 0);
-        assertEq(owedDeposit2, 0); // GDA doesn't use owed deposits
-        assert(lastUpdated2 > lastUpdated1);
+        assertEq(flowRateToPoolAfter, DEFAULT_FLOWRATE);
+        assert(depositToPoolAfter > 0);
+        assertEq(owedDepositToPoolAfter, 0); // GDA doesn't use owed deposits
+        assert(lastUpdatedToPoolAfter > lastUpdatedToPoolBefore);
+
+        (, int96 flowRateToMemberAfter, , ) = superToken.getFlowInfo(address(pool), bob);
+        assertEq(flowRateToMemberAfter, DEFAULT_FLOWRATE);
     }
 
     // Make sure actualFlowrate and actualAmount returned by distributeFlow and distribute are always correct.