natspec in config

Author: LeoPatOZ

src/protocol/ProverManagerConfig.sol

@@ -2,94 +2,103 @@
 pragma solidity ^0.8.28;
 
 abstract contract ProverManagerConfig {
+    /// @notice Returns the maximum fraction (in bps) of the previous bid a prover can offer and still have a successful
+    /// bid
+    /// @return _ The maximum bid fraction
     function maxBidFraction() external view returns (uint16) {
         return _maxBidFraction();
     }
+    /// @notice Returns the time window after which a publication is considered old enough for prover eviction
+    /// @return _ The liveness window value in seconds
 
     function livenessWindow() external view returns (uint40) {
         return _livenessWindow();
     }
 
+    /// @notice Returns the time delay before a new prover takes over after a successful bid
+    /// @return _ The succession delay value in seconds
     function successionDelay() external view returns (uint40) {
         return _successionDelay();
     }
 
+    /// @notice Returns the delay after which the current prover can exit, or is removed if evicted
+    /// @return _ The exit delay value in seconds
     function exitDelay() external view returns (uint40) {
         return _exitDelay();
     }
 
+    /// @notice Returns the time window for a prover to submit a valid proof after their period ends
+    /// @return _ The proving window value in seconds
     function provingWindow() external view returns (uint40) {
         return _provingWindow();
     }
 
+    /// @notice Returns the minimum stake required to be a prover
+    /// @return _ The liveness bond value in wei
     function livenessBond() external view returns (uint96) {
         return _livenessBond();
     }
 
+    /// @notice Returns the fraction (in bps) of the liveness bond that the evictor gets as an incentive
+    /// @return _ The evictor incentive fraction
     function evictorIncentiveFraction() external view returns (uint16) {
         return _evictorIncentiveFraction();
     }
 
+    /// @notice Returns the fraction (in bps) of the remaining liveness bond rewarded to the prover
+    /// @return _ The reward fraction
     function rewardFraction() external view returns (uint16) {
         return _rewardFraction();
     }
 
+    /// @notice The percentage of the fee that is charged for delayed publications
+    /// @dev It is recommended to set this to >100 since delayed publications should usually be charged at a higher rate
+    /// @return _ The multiplier as a percentage (two decimals). This value should usually be greater than 100 (100%).
     function delayedFeePercentage() external view returns (uint16) {
         return _delayedFeePercentage();
     }
 
-    /// @dev Returns the maximum fraction (in bps) of the previous bid a prover can offer and still have a successful
-    /// bid
-    /// @return _ The maximum bid fraction
+    /// @dev See maxBidFraction
     function _maxBidFraction() internal view virtual returns (uint16) {
         return 9500; // 95% in basis points
     }
 
-    /// @dev Returns the time window after which a publication is considered old enough for prover eviction
-    /// @return _ The liveness window value in seconds
+    /// @dev See livenessWindow
     function _livenessWindow() internal view virtual returns (uint40) {
         return 60;
     }
 
-    /// @dev Returns the time delay before a new prover takes over after a successful bid
-    /// @return _ The succession delay value in seconds
+    /// @dev See successionDelay
     function _successionDelay() internal view virtual returns (uint40) {
         return 10;
     }
 
-    /// @dev Returns the delay after which the current prover can exit, or is removed if evicted
-    /// @return _ The exit delay value in seconds
+    /// @dev See exitDelay
     function _exitDelay() internal view virtual returns (uint40) {
         return 10;
     }
 
-    /// @dev Returns the time window for a prover to submit a valid proof after their period ends
-    /// @return _ The proving window value in seconds
+    /// @dev See provingWindow
     function _provingWindow() internal view virtual returns (uint40) {
         return 30;
     }
 
-    /// @dev Returns the minimum stake required to be a prover
-    /// @return _ The liveness bond value in wei
+    /// @dev See livenessBond
     function _livenessBond() internal view virtual returns (uint96) {
         return 1 ether;
     }
 
-    /// @dev Returns the fraction (in bps) of the liveness bond that the evictor gets as an incentive
-    /// @return _ The evictor incentive fraction
+    /// @dev See evictorIncentiveFraction
     function _evictorIncentiveFraction() internal view virtual returns (uint16) {
         return 500; // 5% in basis points
     }
 
-    /// @dev Returns the fraction (in bps) of the remaining liveness bond rewarded to the prover
-    /// @return _ The reward fraction
+    /// @dev See rewardFraction
     function _rewardFraction() internal view virtual returns (uint16) {
         return 9000; // 90% in basis points
     }
 
-    /// @dev The percentage of the fee that is charged for delayed publications
-    /// @dev It is recommended to set this to >100 since delayed publications should usually be charged at a higher rate
-    /// @return _ The multiplier as a percentage (two decimals). This value should usually be greater than 100 (100%).
+    /// @dev See delayedFeePercentage
     function _delayedFeePercentage() internal view virtual returns (uint16) {
         return 150;
     }