feat(stream-manager): add aggregated 'withdrawableAmountOf' linear an…

…d tranched stream
xWerk · Aug 14, 2024 · e7877ef · e7877ef
1 parent 1530288
commit e7877ef
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/src/modules/invoice-module/sablier-v2/StreamManager.sol b/src/modules/invoice-module/sablier-v2/StreamManager.sol
@@ -138,11 +138,16 @@ abstract contract StreamManager is IStreamManager {
     }
 
     /// @inheritdoc IStreamManager
-    function streamedAmountOf(
+    function withdrawableAmountOf(
         Types.Method streamType,
         uint256 streamId
     ) public view returns (uint128 withdrawableAmount) {
-        withdrawableAmount = _getISablierV2Lockup(streamType).streamedAmountOf(streamId);
+        withdrawableAmount = _getISablierV2Lockup(streamType).withdrawableAmountOf(streamId);
+    }
+
+    /// @inheritdoc IStreamManager
+    function streamedAmountOf(Types.Method streamType, uint256 streamId) public view returns (uint128 streamedAmount) {
+        streamedAmount = _getISablierV2Lockup(streamType).streamedAmountOf(streamId);
     }
 
     /*//////////////////////////////////////////////////////////////////////////

diff --git a/src/modules/invoice-module/sablier-v2/interfaces/IStreamManager.sol b/src/modules/invoice-module/sablier-v2/interfaces/IStreamManager.sol
@@ -102,13 +102,21 @@ interface IStreamManager {
         address to
     ) external returns (uint128 withdrawnAmount);
 
+    /// @notice See the documentation in {ISablierV2Lockup-withdrawableAmountOf}
+    /// Notes:
+    /// - `streamType` parameter has been added to retrieve from the according {ISablierV2Lockup} contract
+    function withdrawableAmountOf(
+        Types.Method streamType,
+        uint256 streamId
+    ) external view returns (uint128 withdrawableAmount);
+
     /// @notice See the documentation in {ISablierV2Lockup-streamedAmountOf}
     /// Notes:
-    /// - `streamType` parameter has been added to retrieve data from the according {ISablierV2Lockup} contract
+    /// - `streamType` parameter has been added to retrieve from the according {ISablierV2Lockup} contract
     function streamedAmountOf(
         Types.Method streamType,
         uint256 streamId
-    ) external view returns (uint128 withdrawableAmount);
+    ) external view returns (uint128 streamedAmount);
 
     /// @notice See the documentation in {ISablierV2Lockup-cancel}
     ///