sablier-labs · smol-ninja · Nov 26, 2024 · Nov 22, 2024 · Nov 26, 2024
diff --git a/package.json b/package.json
@@ -75,7 +75,7 @@
     "prepare": "husky",
     "prettier:check": "prettier --check \"**/*.{json,md,svg,yml}\"",
     "prettier:write": "prettier --write \"**/*.{json,md,svg,yml}\"",
-    "test": "forge test --nmt \"testFork\"",
+    "test": "forge test",
     "test:lite": "FOUNDRY_PROFILE=lite forge test",
     "test:optimized": "bun run build:optimized && FOUNDRY_PROFILE=test-optimized forge test"
   }

diff --git a/script/Init.s.sol b/script/Init.s.sol
@@ -51,7 +51,8 @@ contract Init is BaseScript {
                     asset: asset,
                     cancelable: true,
                     transferable: true,
-                    broker: Broker(address(0), ud60x18(0))
+                    broker: Broker(address(0), ud60x18(0)),
+                    shape: "Cliff Linear"
                 }),
                 LockupLinear.UnlockAmounts({ start: 0, cliff: 0 }),
                 LockupLinear.Durations({ cliff: cliffDurations[i], total: totalDurations[i] })
@@ -82,7 +83,8 @@ contract Init is BaseScript {
                 asset: asset,
                 cancelable: true,
                 transferable: true,
-                broker: Broker(address(0), ud60x18(0))
+                broker: Broker(address(0), ud60x18(0)),
+                shape: "Exponential Dynamic"
             }),
             segments
         );

diff --git a/src/SablierBatchLockup.sol b/src/SablierBatchLockup.sol
@@ -59,7 +59,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     asset: asset,
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].segmentsWithDuration
             );
@@ -115,7 +116,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
                     timestamps: Lockup.Timestamps({ start: batch[i].startTime, end: endTime }),
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].segments
             );
@@ -167,7 +169,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     asset: asset,
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].unlockAmounts,
                 batch[i].durations
@@ -217,7 +220,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
                     timestamps: batch[i].timestamps,
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].unlockAmounts,
                 batch[i].cliffTime
@@ -270,7 +274,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     asset: asset,
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].tranchesWithDuration
             );
@@ -326,7 +331,8 @@ contract SablierBatchLockup is ISablierBatchLockup {
                     cancelable: batch[i].cancelable,
                     transferable: batch[i].transferable,
                     timestamps: Lockup.Timestamps({ start: batch[i].startTime, end: endTime }),
-                    broker: batch[i].broker
+                    broker: batch[i].broker,
+                    shape: batch[i].shape
                 }),
                 batch[i].tranches
             );

diff --git a/src/SablierLockup.sol b/src/SablierLockup.sol
@@ -158,7 +158,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
                 cancelable: params.cancelable,
                 transferable: params.transferable,
                 timestamps: timestamps,
-                broker: params.broker
+                broker: params.broker,
+                shape: params.shape
             }),
             segments
         );
@@ -201,7 +202,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
                 cancelable: params.cancelable,
                 transferable: params.transferable,
                 timestamps: timestamps,
-                broker: params.broker
+                broker: params.broker,
+                shape: params.shape
             }),
             unlockAmounts,
             cliffTime
@@ -236,7 +238,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
                 cancelable: params.cancelable,
                 transferable: params.transferable,
                 timestamps: timestamps,
-                broker: params.broker
+                broker: params.broker,
+                shape: params.shape
             }),
             tranches
         );
@@ -393,7 +396,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
             cancelable: params.cancelable,
             transferable: params.transferable,
             timestamps: params.timestamps,
-            broker: params.broker.account
+            broker: params.broker.account,
+            shape: params.shape
         });
     }
 
@@ -413,7 +417,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
             segments: segments,
             maxCount: MAX_COUNT,
             brokerFee: params.broker.fee,
-            maxBrokerFee: MAX_BROKER_FEE
+            maxBrokerFee: MAX_BROKER_FEE,
+            shape: params.shape
         });
 
         // Load the stream ID in a variable.
@@ -459,7 +464,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
             totalAmount: params.totalAmount,
             unlockAmounts: unlockAmounts,
             brokerFee: params.broker.fee,
-            maxBrokerFee: MAX_BROKER_FEE
+            maxBrokerFee: MAX_BROKER_FEE,
+            shape: params.shape
         });
 
         // Load the stream ID in a variable.
@@ -513,7 +519,8 @@ contract SablierLockup is ISablierLockup, SablierLockupBase {
             tranches: tranches,
             maxCount: MAX_COUNT,
             brokerFee: params.broker.fee,
-            maxBrokerFee: MAX_BROKER_FEE
+            maxBrokerFee: MAX_BROKER_FEE,
+            shape: params.shape
         });
 
         // Load the stream ID in a variable.

diff --git a/src/libraries/Errors.sol b/src/libraries/Errors.sol
@@ -77,6 +77,9 @@ library Errors {
     /// @notice Thrown when trying to create a stream with the sender as the zero address.
     error SablierHelpers_SenderZeroAddress();
 
+    /// @notice Thrown when trying to create a stream with shape name exceeding 32 bytes.
+    error SablierHelpers_ShapeNameExceeds32Bytes(uint256 nameLength);
+
     /// @notice Thrown when trying to create a linear stream with a start time not strictly less than the cliff time,
     /// when the cliff time does not have a zero value.
     error SablierHelpers_StartTimeNotLessThanCliffTime(uint40 startTime, uint40 cliffTime);

diff --git a/src/libraries/Helpers.sol b/src/libraries/Helpers.sol
@@ -84,7 +84,8 @@ library Helpers {
         LockupDynamic.Segment[] memory segments,
         uint256 maxCount,
         UD60x18 brokerFee,
-        UD60x18 maxBrokerFee
+        UD60x18 maxBrokerFee,
+        string memory shape
     )
         public
         pure
@@ -94,7 +95,7 @@ library Helpers {
         createAmounts = _checkAndCalculateBrokerFee(totalAmount, brokerFee, maxBrokerFee);
 
         // Check: validate the user-provided common parameters.
-        _checkCreateStream(sender, createAmounts.deposit, timestamps.start);
+        _checkCreateStream(sender, createAmounts.deposit, timestamps.start, shape);
 
         // Check: validate the user-provided segments.
         _checkSegments(segments, createAmounts.deposit, timestamps, maxCount);
@@ -108,7 +109,8 @@ library Helpers {
         uint128 totalAmount,
         LockupLinear.UnlockAmounts memory unlockAmounts,
         UD60x18 brokerFee,
-        UD60x18 maxBrokerFee
+        UD60x18 maxBrokerFee,
+        string memory shape
     )
         public
         pure
@@ -118,7 +120,7 @@ library Helpers {
         createAmounts = _checkAndCalculateBrokerFee(totalAmount, brokerFee, maxBrokerFee);
 
         // Check: validate the user-provided common parameters.
-        _checkCreateStream(sender, createAmounts.deposit, timestamps.start);
+        _checkCreateStream(sender, createAmounts.deposit, timestamps.start, shape);
 
         // Check: validate the user-provided cliff and end times.
         _checkTimestampsAndUnlockAmounts(createAmounts.deposit, timestamps, cliffTime, unlockAmounts);
@@ -132,7 +134,8 @@ library Helpers {
         LockupTranched.Tranche[] memory tranches,
         uint256 maxCount,
         UD60x18 brokerFee,
-        UD60x18 maxBrokerFee
+        UD60x18 maxBrokerFee,
+        string memory shape
     )
         public
         pure
@@ -142,7 +145,7 @@ library Helpers {
         createAmounts = _checkAndCalculateBrokerFee(totalAmount, brokerFee, maxBrokerFee);
 
         // Check: validate the user-provided common parameters.
-        _checkCreateStream(sender, createAmounts.deposit, timestamps.start);
+        _checkCreateStream(sender, createAmounts.deposit, timestamps.start, shape);
 
         // Check: validate the user-provided segments.
         _checkTranches(tranches, createAmounts.deposit, timestamps, maxCount);
@@ -229,7 +232,15 @@ library Helpers {
     }
 
     /// @dev Checks the user-provided common parameters across lockup streams.
-    function _checkCreateStream(address sender, uint128 depositAmount, uint40 startTime) private pure {
+    function _checkCreateStream(
+        address sender,
+        uint128 depositAmount,
+        uint40 startTime,
+        string memory shape
+    )
+        private
+        pure
+    {
         // Check: the sender is not the zero address.
         if (sender == address(0)) {
             revert Errors.SablierHelpers_SenderZeroAddress();
@@ -244,6 +255,11 @@ library Helpers {
         if (startTime == 0) {
             revert Errors.SablierHelpers_StartTimeZero();
         }
+
+        // Check: the shape name is not greater than 32 bytes to prevent HTML injection attacks.
+        if (bytes(shape).length > 32) {
+            revert Errors.SablierHelpers_ShapeNameExceeds32Bytes(bytes(shape).length);
+        }
     }
 
     /// @dev Checks:

diff --git a/src/types/DataTypes.sol b/src/types/DataTypes.sol
@@ -28,6 +28,7 @@ library BatchLockup {
         bool transferable;
         LockupDynamic.SegmentWithDuration[] segmentsWithDuration;
         Broker broker;
+        string shape;
     }
 
     /// @notice A struct encapsulating all parameters of {SablierLockup.createWithDurationsLL} except for the asset.
@@ -40,6 +41,7 @@ library BatchLockup {
         LockupLinear.Durations durations;
         LockupLinear.UnlockAmounts unlockAmounts;
         Broker broker;
+        string shape;
     }
 
     /// @notice A struct encapsulating all parameters of {SablierLockup.createWithDurationsLT} except for the asset.
@@ -51,6 +53,7 @@ library BatchLockup {
         bool transferable;
         LockupTranched.TrancheWithDuration[] tranchesWithDuration;
         Broker broker;
+        string shape;
     }
 
     /// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLD} except for the asset.
@@ -63,6 +66,7 @@ library BatchLockup {
         uint40 startTime;
         LockupDynamic.Segment[] segments;
         Broker broker;
+        string shape;
     }
 
     /// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLL} except for the asset.
@@ -76,6 +80,7 @@ library BatchLockup {
         uint40 cliffTime;
         LockupLinear.UnlockAmounts unlockAmounts;
         Broker broker;
+        string shape;
     }
 
     /// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLT} except for the asset.
@@ -88,6 +93,7 @@ library BatchLockup {
         uint40 startTime;
         LockupTranched.Tranche[] tranches;
         Broker broker;
+        string shape;
     }
 }
 
@@ -136,6 +142,8 @@ library Lockup {
     /// @param transferable Boolean indicating whether the stream NFT is transferable or not.
     /// @param timestamps Struct encapsulating (i) the stream's start time and (ii) end time, all as Unix timestamps.
     /// @param broker The address of the broker who has helped create the stream, e.g. a front-end website.
+    /// @param shape The name of the stream shape that it should represent. This is useful to differentiate between
+    /// streams in the UI.
     struct CreateEventCommon {
         address funder;
         address sender;
@@ -146,6 +154,7 @@ library Lockup {
         bool transferable;
         Lockup.Timestamps timestamps;
         address broker;
+        string shape;
     }
 
     /// @notice Struct encapsulating the parameters of the `createWithDurations` functions.
@@ -159,6 +168,8 @@ library Lockup {
     /// @param transferable Indicates if the stream NFT is transferable.
     /// @param broker Struct encapsulating (i) the address of the broker assisting in creating the stream, and (ii) the
     /// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
+    /// @param shape An optional name for the stream shape that it should represent. This is useful to differentiate
+    /// between streams in the UI.
     struct CreateWithDurations {
         address sender;
         address recipient;
@@ -167,6 +178,7 @@ library Lockup {
         bool cancelable;
         bool transferable;
         Broker broker;
+        string shape;
     }
 
     /// @notice Struct encapsulating the parameters of the `createWithTimestamps` functions.
@@ -181,6 +193,8 @@ library Lockup {
     /// @param timestamps Struct encapsulating (i) the stream's start time and (ii) end time, both as Unix timestamps.
     /// @param broker Struct encapsulating (i) the address of the broker assisting in creating the stream, and (ii) the
     /// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
+    /// @param shape An optional name for the stream shape that it should represent. This is useful to differentiate
+    /// between streams in the UI.
     struct CreateWithTimestamps {
         address sender;
         address recipient;
@@ -190,6 +204,7 @@ library Lockup {
         bool transferable;
         Timestamps timestamps;
         Broker broker;
+        string shape;
     }
 
     /// @notice Enum representing the different distribution models used to create lockup streams.

diff --git a/test/fork/LockupDynamic.t.sol b/test/fork/LockupDynamic.t.sol
@@ -157,7 +157,8 @@ abstract contract Lockup_Dynamic_Fork_Test is Fork_Test {
                 cancelable: true,
                 transferable: true,
                 timestamps: vars.timestamps,
-                broker: params.broker.account
+                broker: params.broker.account,
+                shape: "Dynamic Shape"
             }),
             segments: params.segments
         });
@@ -172,7 +173,8 @@ abstract contract Lockup_Dynamic_Fork_Test is Fork_Test {
                 cancelable: true,
                 transferable: true,
                 timestamps: vars.timestamps,
-                broker: params.broker
+                broker: params.broker,
+                shape: "Dynamic Shape"
             }),
             params.segments
         );

diff --git a/test/fork/LockupLinear.t.sol b/test/fork/LockupLinear.t.sol
@@ -178,7 +178,8 @@ abstract contract Lockup_Linear_Fork_Test is Fork_Test {
                 cancelable: true,
                 transferable: true,
                 timestamps: params.timestamps,
-                broker: params.broker.account
+                broker: params.broker.account,
+                shape: "Linear Shape"
             }),
             cliffTime: params.cliffTime,
             unlockAmounts: params.unlockAmounts
@@ -194,7 +195,8 @@ abstract contract Lockup_Linear_Fork_Test is Fork_Test {
                 cancelable: true,
                 transferable: true,
                 timestamps: params.timestamps,
-                broker: params.broker
+                broker: params.broker,
+                shape: "Linear Shape"
             }),
             params.unlockAmounts,
             params.cliffTime