added missing comments

stakedotlink · Dec 13, 2024 · 67d8ac5 · 67d8ac5
1 parent 1dbe63d
commit 67d8ac5
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/contracts/core/RebaseController.sol b/contracts/core/RebaseController.sol
@@ -13,16 +13,27 @@ import "./interfaces/ISecurityPool.sol";
  * @notice Updates strategy rewards in the Staking Pool and and performs emergency pausing/reopening of the pool
  */
 contract RebaseController is Ownable {
+    // address of staking pool
     IStakingPool public stakingPool;
+    // address of priority pool
     IPriorityPool public priorityPool;
+    // address of security pool
     ISecurityPool public securityPool;
 
+    // address authorized to pause pool in case of emergency
     address public emergencyPauser;
 
     error PoolClosed();
     error SenderNotAuthorized();
     error NoLossDetected();
 
+    /**
+     * @notice Initializes contract
+     * @param _stakingPool address of staking pool
+     * @param _priorityPool address of priority pool
+     * @param _securityPool address of security pool
+     * @param _emergencyPauser address authorized to pause pool in case of emergency
+     */
     constructor(
         address _stakingPool,
         address _priorityPool,
@@ -35,6 +46,9 @@ contract RebaseController is Ownable {
         emergencyPauser = _emergencyPauser;
     }
 
+    /**
+     * @notice Reverts if sender is not emergency pauser
+     */
     modifier onlyEmergencyPauser() {
         if (msg.sender != emergencyPauser) revert SenderNotAuthorized();
         _;