From 8888e0d9e3c0a5e8bca797829f73d699e795f34e Mon Sep 17 00:00:00 2001
From: davidbrai <davidbrai@gmail.com>
Date: Tue, 3 Dec 2024 11:53:55 +0000
Subject: [PATCH] add natspec

---
 packages/nouns-contracts/contracts/StreamEscrow.sol | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/packages/nouns-contracts/contracts/StreamEscrow.sol b/packages/nouns-contracts/contracts/StreamEscrow.sol
index 10048abd9..d174841d2 100644
--- 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;