Merge headers (#803)

* style: merge storage and constants to state headers * style: declare first the immutable variables
sablier-labs · Jan 29, 2024 · b5b884d · b5b884d
1 parent ea6f097
commit b5b884d
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 30 deletions.
diff --git a/src/SablierV2Comptroller.sol b/src/SablierV2Comptroller.sol
@@ -33,7 +33,7 @@ contract SablierV2Comptroller is
     Adminable // 1 inherited component
 {
     /*//////////////////////////////////////////////////////////////////////////
-                                   PUBLIC STORAGE
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc ISablierV2Comptroller

diff --git a/src/SablierV2LockupDynamic.sol b/src/SablierV2LockupDynamic.sol
@@ -48,16 +48,12 @@ contract SablierV2LockupDynamic is
     using SafeERC20 for IERC20;
 
     /*//////////////////////////////////////////////////////////////////////////
-                                  PUBLIC CONSTANTS
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc ISablierV2LockupDynamic
     uint256 public immutable override MAX_SEGMENT_COUNT;
 
-    /*//////////////////////////////////////////////////////////////////////////
-                                  PRIVATE STORAGE
-    //////////////////////////////////////////////////////////////////////////*/
-
     /// @dev Sablier V2 Lockup Dynamic streams mapped by unsigned integer ids.
     mapping(uint256 id => LockupDynamic.Stream stream) private _streams;
 

diff --git a/src/SablierV2LockupLinear.sol b/src/SablierV2LockupLinear.sol
@@ -43,7 +43,7 @@ contract SablierV2LockupLinear is
     using SafeERC20 for IERC20;
 
     /*//////////////////////////////////////////////////////////////////////////
-                                  PRIVATE STORAGE
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @dev Sablier V2 Lockup Linear streams mapped by unsigned integers.

diff --git a/src/abstracts/Adminable.sol b/src/abstracts/Adminable.sol
@@ -8,7 +8,7 @@ import { Errors } from "../libraries/Errors.sol";
 /// @notice See the documentation in {IAdminable}.
 abstract contract Adminable is IAdminable {
     /*//////////////////////////////////////////////////////////////////////////
-                                       STORAGE
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc IAdminable

diff --git a/src/abstracts/SablierV2Base.sol b/src/abstracts/SablierV2Base.sol
@@ -22,16 +22,12 @@ abstract contract SablierV2Base is
     using SafeERC20 for IERC20;
 
     /*//////////////////////////////////////////////////////////////////////////
-                                  PUBLIC CONSTANTS
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc ISablierV2Base
     UD60x18 public constant override MAX_FEE = UD60x18.wrap(0.1e18);
 
-    /*//////////////////////////////////////////////////////////////////////////
-                                   PUBLIC STORAGE
-    //////////////////////////////////////////////////////////////////////////*/
-
     /// @inheritdoc ISablierV2Base
     ISablierV2Comptroller public override comptroller;
 

diff --git a/src/abstracts/SablierV2Lockup.sol b/src/abstracts/SablierV2Lockup.sol
@@ -23,7 +23,7 @@ abstract contract SablierV2Lockup is
     ERC721 // 6 inherited components
 {
     /*//////////////////////////////////////////////////////////////////////////
-                                USER-FACING STORAGE
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc ISablierV2Lockup

diff --git a/test/fork/Fork.t.sol b/test/fork/Fork.t.sol
@@ -9,16 +9,11 @@ import { Base_Test } from "../Base.t.sol";
 /// @notice Common logic needed by all fork tests.
 abstract contract Fork_Test is Base_Test {
     /*//////////////////////////////////////////////////////////////////////////
-                                     CONSTANTS
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     IERC20 internal immutable ASSET;
     address internal immutable HOLDER;
-
-    /*//////////////////////////////////////////////////////////////////////////
-                                     VARIABLES
-    //////////////////////////////////////////////////////////////////////////*/
-
     uint256 internal initialHolderBalance;
 
     /*//////////////////////////////////////////////////////////////////////////

diff --git a/test/invariant/handlers/BaseHandler.sol b/test/invariant/handlers/BaseHandler.sol
@@ -12,7 +12,7 @@ import { TimestampStore } from "../stores/TimestampStore.sol";
 /// @notice Base contract with common logic needed by all handler contracts.
 abstract contract BaseHandler is Constants, Fuzzers, StdCheats {
     /*//////////////////////////////////////////////////////////////////////////
-                                     CONSTANTS
+                                    STATE-VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @dev Maximum number of streams that can be created during an invariant campaign.
@@ -21,10 +21,6 @@ abstract contract BaseHandler is Constants, Fuzzers, StdCheats {
     /// @dev The virtual address of the Foundry VM.
     address internal constant VM_ADDRESS = address(uint160(uint256(keccak256("hevm cheat code"))));
 
-    /*//////////////////////////////////////////////////////////////////////////
-                                     VARIABLES
-    //////////////////////////////////////////////////////////////////////////*/
-
     /// @dev Maps function names to the number of times they have been called.
     mapping(string func => uint256 calls) public calls;
 

diff --git a/test/utils/Defaults.sol b/test/utils/Defaults.sol
@@ -13,7 +13,7 @@ import { Users } from "./Types.sol";
 /// @notice Contract with default values used throughout the tests.
 contract Defaults is Constants {
     /*//////////////////////////////////////////////////////////////////////////
-                                     CONSTANTS
+                                  STATE VARIABLES
     //////////////////////////////////////////////////////////////////////////*/
 
     UD60x18 public constant BROKER_FEE = UD60x18.wrap(0.003e18); // 0.3%
@@ -35,10 +35,6 @@ contract Defaults is Constants {
     uint128 public constant WITHDRAW_AMOUNT = 2600e18;
     uint40 public immutable WARP_26_PERCENT; // 26% of the way through the stream
 
-    /*//////////////////////////////////////////////////////////////////////////
-                                     VARIABLES
-    //////////////////////////////////////////////////////////////////////////*/
-
     IERC20 private asset;
     Users private users;