add natspec

nounsDAO · Dec 3, 2024 · 8888e0d · 8888e0d
1 parent f1c4fdf
commit 8888e0d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/nouns-contracts/contracts/StreamEscrow.sol b/packages/nouns-contracts/contracts/StreamEscrow.sol
@@ -245,6 +245,11 @@ contract StreamEscrow is IStreamEscrow {
         return !streams[nounId].canceled && streams[nounId].lastTick > currentTick;
     }
 
+    /**
+     * @notice Returns the amount of ETH that was not yet streamed for a specific Noun token.
+     * Returns zero for inactive streams.
+     * @param nounId The ID of the Noun token to check the stream for.
+     */
     function unstreamedETHForNoun(uint256 nounId) public view returns (uint256) {
         Stream memory stream = streams[nounId];
         uint32 currentTick_ = currentTick;