refactor: make nftDescriptor public (#796)

test: nftDescriptor in constructor
sablier-labs · Feb 12, 2024 · 65b2be6 · 65b2be6
1 parent f695d6a
commit 65b2be6
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 10 deletions.
diff --git a/src/abstracts/SablierV2Lockup.sol b/src/abstracts/SablierV2Lockup.sol
@@ -29,12 +29,8 @@ abstract contract SablierV2Lockup is
     /// @inheritdoc ISablierV2Lockup
     uint256 public override nextStreamId;
 
-    /*//////////////////////////////////////////////////////////////////////////
-                                  INTERNAL STORAGE
-    //////////////////////////////////////////////////////////////////////////*/
-
-    /// @dev Contract that generates the non-fungible token URI.
-    ISablierV2NFTDescriptor internal _nftDescriptor;
+    /// @inheritdoc ISablierV2Lockup
+    ISablierV2NFTDescriptor public override nftDescriptor;
 
     /*//////////////////////////////////////////////////////////////////////////
                                      CONSTRUCTOR
@@ -50,7 +46,7 @@ abstract contract SablierV2Lockup is
     )
         SablierV2Base(initialAdmin, initialComptroller)
     {
-        _nftDescriptor = initialNFTDescriptor;
+        nftDescriptor = initialNFTDescriptor;
     }
 
     /*//////////////////////////////////////////////////////////////////////////
@@ -111,7 +107,7 @@ abstract contract SablierV2Lockup is
         _requireMinted({ tokenId: streamId });
 
         // Generate the URI describing the stream NFT.
-        uri = _nftDescriptor.tokenURI({ sablier: this, streamId: streamId });
+        uri = nftDescriptor.tokenURI({ sablier: this, streamId: streamId });
     }
 
     /// @inheritdoc ISablierV2Lockup
@@ -215,8 +211,8 @@ abstract contract SablierV2Lockup is
     /// @inheritdoc ISablierV2Lockup
     function setNFTDescriptor(ISablierV2NFTDescriptor newNFTDescriptor) external override onlyAdmin {
         // Effects: set the NFT descriptor.
-        ISablierV2NFTDescriptor oldNftDescriptor = _nftDescriptor;
-        _nftDescriptor = newNFTDescriptor;
+        ISablierV2NFTDescriptor oldNftDescriptor = nftDescriptor;
+        nftDescriptor = newNFTDescriptor;
 
         // Log the change of the NFT descriptor.
         emit ISablierV2Lockup.SetNFTDescriptor({

diff --git a/src/interfaces/ISablierV2Lockup.sol b/src/interfaces/ISablierV2Lockup.sol
@@ -134,6 +134,9 @@ interface ISablierV2Lockup is
     /// @notice Counter for stream ids, used in the create functions.
     function nextStreamId() external view returns (uint256);
 
+    /// @notice Contract that generates the non-fungible token URI.
+    function nftDescriptor() external view returns (ISablierV2NFTDescriptor);
+
     /// @notice Calculates the amount that the sender would be refunded if the stream were canceled, denoted in units
     /// of the asset's decimals.
     /// @dev Reverts if `streamId` references a null stream.

diff --git a/test/integration/concrete/lockup-dynamic/constructor.t.sol b/test/integration/concrete/lockup-dynamic/constructor.t.sol
@@ -33,6 +33,10 @@ contract Constructor_LockupDynamic_Integration_Concrete_Test is LockupDynamic_In
         uint256 expectedStreamId = 1;
         assertEq(actualStreamId, expectedStreamId, "nextStreamId");
 
+        address actualNFTDescriptor = address(constructedLockupDynamic.nftDescriptor());
+        address expectedNFTDescriptor = address(nftDescriptor);
+        assertEq(actualNFTDescriptor, expectedNFTDescriptor, "nftDescriptor");
+
         // {SablierV2LockupDynamic.constructor}
         uint256 actualMaxSegmentCount = constructedLockupDynamic.MAX_SEGMENT_COUNT();
         uint256 expectedMaxSegmentCount = defaults.MAX_SEGMENT_COUNT();

diff --git a/test/integration/concrete/lockup-linear/constructor.t.sol b/test/integration/concrete/lockup-linear/constructor.t.sol
@@ -31,5 +31,9 @@ contract Constructor_LockupLinear_Integration_Concrete_Test is LockupLinear_Inte
         uint256 actualStreamId = constructedLockupLinear.nextStreamId();
         uint256 expectedStreamId = 1;
         assertEq(actualStreamId, expectedStreamId, "nextStreamId");
+
+        address actualNFTDescriptor = address(constructedLockupLinear.nftDescriptor());
+        address expectedNFTDescriptor = address(nftDescriptor);
+        assertEq(actualNFTDescriptor, expectedNFTDescriptor, "nftDescriptor");
     }
 }