Improve code formatting

Author: DrZoltanFazekas

README.md

@@ -437,5 +437,5 @@ and a few more for the non-liquid variant.
 
 To generate and view the comprehensive NatSpec documentation, run
 ```bash
-forge doc --serve --open
+forge doc --serve --open --port 3001
 ```

src/BaseDelegation.sol

@@ -53,7 +53,7 @@ interface IDelegation {
 
     /**
     * @notice Transfer all outstanding commissions to the configured receiver.
-    * Must be called by the contract owner.
+    * It must be called by the contract owner.
     */
     function collectCommission() external;
 

src/IDelegation.sol

@@ -9,17 +9,19 @@ import {NonRebasingLST} from "src/NonRebasingLST.sol";
 bytes32 constant LIQUID_VARIANT = 0xfa57cbed4b267d0bc9f2cbdae86b4d1d23ca818308f873af9c968a23afadfd00;
 
 /**
- * @notice The liquid variant of the stake delegation contract. It uses {NonRebasingLST}
- * as liquid staking token implementation. Every time users stake ZIL they receive the
- * corresponding amount of liquid staking tokens depending on the current token price.
- * The liquid staking token is non-rebasing, i.e. the token balances are not adjusted
- * to reflect the rewards earned by the staking pool. Instead, the taxed rewards, i.e.
- * the rewards after deducting the commission are included in the token price.
+ * @notice The liquid variant of the stake delegation contract that uses a
+ * {NonRebasingLST} as liquid staking token. Every time users stake ZIL they
+ * receive the corresponding amount of liquid staking tokens depending on the
+ * current token price. The liquid staking token is non-rebasing, i.e. the token
+ * balances are not adjusted to reflect the rewards earned by the staking pool.
+ * Instead, the taxed rewards, i.e. the rewards after deducting the commission
+ * are included in the token price.
  *
  * @dev The contract is registered as the reward address of all validators in the
  * staking pool, i.e. its balance can increase in every block. Since this does not
  * happen in form of transactions, the {receive} function will not notice it.
  */
+// solhint-disable comprehensive-interface
 contract LiquidDelegation is IDelegation, BaseDelegation {
 
     // ************************************************************************
@@ -29,10 +31,11 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     // ************************************************************************
 
     /**
-    * @dev `lst` is the address of the {NonRebasingLST} token issued by the {LiquidDelegation}.
-    * `taxedRewards` is the amount of rewards accrued that the {LiquidDelegation} contract is
-    * aware of and has already deducted the commission from. The contract balance is higher
-    * if new (untaxed) rewards have been added to it since the last update of `taxedRewards`.
+    * @dev `lst` stores the address of the {NonRebasingLST} token issued by the
+    * {LiquidDelegation}. `taxedRewards` is the amount of rewards accrued that
+    * the {LiquidDelegation} contract is aware of and has already deducted the
+    * commission from. The contract balance is higher if new (untaxed) rewards
+    * have been added to it since the last update of `taxedRewards`.
     */
     /// @custom:storage-location erc7201:zilliqa.storage.LiquidDelegation
     struct LiquidDelegationStorage {
@@ -70,7 +73,11 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     /**
     * @dev Initialize the base contracts and create the LST token contract.
     */
-    function initialize(address initialOwner, string calldata name, string calldata symbol) public initializer {
+    function initialize(
+        address initialOwner,
+        string calldata name,
+        string calldata symbol
+    ) public initializer {
         __BaseDelegation_init(initialOwner);
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
         $.lst = address(new NonRebasingLST(name, symbol));
@@ -105,19 +112,25 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     } 
 
     /// @inheritdoc BaseDelegation
-    function joinPool(bytes calldata blsPubKey, address controlAddress) public override onlyOwner {
-        // deduct the commission from the yet untaxed rewards before calculating the number of shares
+    function joinPool(
+        bytes calldata blsPubKey,
+        address controlAddress
+    ) public override onlyOwner {
+        // deduct the commission from the yet untaxed rewards
+        // before calculating the number of shares
         taxRewards();
         _stake(getDeposit(blsPubKey), controlAddress);
-        // increases the deposited stake hence it must be called after calculating the shares
+        // increases the deposited stake hence it must
+        // be called after calculating the shares
         _addToPool(blsPubKey, controlAddress);
     }
 
     /// @inheritdoc BaseDelegation
     function leavePool(bytes calldata blsPubKey) public override {
         if (!_preparedToLeave(blsPubKey))
             return;
-        // deduct the commission from the yet untaxed rewards before calculating the amount
+        // deduct the commission from the yet untaxed rewards
+        // before calculating the amount
         taxRewards();
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
         uint256 amount = _unstake(NonRebasingLST($.lst).balanceOf(_msgSender()), _msgSender());
@@ -138,17 +151,19 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
 
     /**
     * @inheritdoc IDelegation
-    * @dev Deduct the commission from the yet untaxed rewards before calculating the number of liquid
-    * staking tokens corresponsing to the delegated amount. Increase the deposit of the validators in
-    * the staking pool by the delegated amount.
+    * @dev Deduct the commission from the yet untaxed rewards before calculating the
+    * number of liquid staking tokens corresponsing to the delegated amount. Increase
+    * the deposit of the validators in the staking pool by the delegated amount.
     */
     function stake() public override(BaseDelegation, IDelegation) payable whenNotPaused {
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
-        // if we are in the fundraising phase getRewards() would return 0 and taxedRewards would
-        // be greater i.e. the commission calculated in taxRewards() would be negative, therefore
+        // if we are in the fundraising phase getRewards() would return 0 and
+        // taxedRewards would be greater i.e. the commission calculated in
+        // taxRewards() would be negative, therefore
         if (_isActivated()) {
-            // the amount just delegated is now part of the rewards since it was added to the balance
-            // therefore add it to the taxed rewards too to avoid commission and remove it after taxing
+            // the amount just delegated is now part of the rewards since
+            // it was added to the balance therefore add it to the taxed
+            // rewards too to avoid commission and remove it after taxing
             $.taxedRewards += msg.value;
             taxRewards();
             $.taxedRewards -= msg.value;
@@ -160,13 +175,14 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     }
 
     /**
-    * @dev Calculate the shares of the `staker` based on the delegated `value` and mint the
-    * corresponding amount of liquid staking tokens (LST).
+    * @dev Calculate the shares of the `staker` based on the delegated `value`
+    * and mint the corresponding amount of liquid staking tokens (LST).
     *
-    * Emit {Staked} containing the `staker` address, the `value` staked, and the corresponding
-    * amount of LST minted to the `staker`.
+    * Emit {Staked} containing the `staker` address, the `value` staked, and
+    * the corresponding amount of LST minted to the `staker`.
     *
-    * Revert with {DelegatedAmountTooLow} containing the `value` lower than {MIN_DELEGATION}.
+    * Revert with {DelegatedAmountTooLow} containing the `value` lower
+    * than {MIN_DELEGATION}.
     */
     function _stake(uint256 value, address staker) internal {
         require(value >= MIN_DELEGATION, DelegatedAmountTooLow(value));
@@ -182,32 +198,35 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
 
     /**
     * @inheritdoc IDelegation
-    * @dev Deduct the commission from the yet untaxed rewards before calculating the amount
-    * corresponding to the unstaked liquid staking tokens. Decrease the deposit of the validators
-    * in the staking pool by the calculated amount.
+    * @dev Deduct the commission from the yet untaxed rewards before calculating
+    * the amount corresponding to the unstaked liquid staking tokens. Decrease
+    * the deposit of the validators in the staking pool by the calculated amount.
     */
     function unstake(uint256 shares)
         public
         override(BaseDelegation, IDelegation)
         whenNotPaused
         returns(uint256 amount)
     {
-        // if we are in the fundraising phase getRewards() would return 0 and taxedRewards would
-        // be greater i.e. the commission calculated in taxRewards() would be negative, therefore
+        // if we are in the fundraising phase getRewards() would return 0 and
+        // taxedRewards would be greater i.e. the commission calculated in
+        // taxRewards() would be negative, therefore
         if (_isActivated())
-            // deduct the commission from the yet untaxed rewards before calculating the amount
+            // deduct the commission from the yet untaxed rewards
+            // before calculating the amount
             taxRewards();
         amount = _unstake(shares, _msgSender());
         _enqueueWithdrawal(amount);
         _decreaseDeposit(amount);
     }
 
     /**
-    * @dev Calculate and return the `amount` of ZIL corresponding to the unstaked `shares` i.e.
-    * liquid staking tokens of the `staker` and burn the unstaked liquid staking tokens (LST).
+    * @dev Calculate and return the `amount` of ZIL corresponding to the unstaked
+    * `shares` i.e. liquid staking tokens of the `staker` and burn the unstaked
+    * liquid staking tokens (LST).
     *
-    * Emit {Unstaked} containing the `staker` address, the amount of ZIL unstaked, and the
-    * number of LST `shares` burned.
+    * Emit {Unstaked} containing the `staker` address, the amount of ZIL unstaked,
+    * and the number of LST `shares` burned.
     */
     function _unstake(uint256 shares, address staker) internal returns(uint256 amount) {
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
@@ -221,7 +240,8 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     }
 
     /**
-    * @dev Return the amount of ZIL equivalent to 10**18 shares of the liquid staking token supply.
+    * @dev Return the amount of ZIL equivalent to 10**18 shares of the liquid
+    * staking token supply.
     */
     function getPrice() public view returns(uint256 amount) {
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
@@ -234,13 +254,13 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     }
 
     /**
-    * @dev Deduct the commission from the yet untaxed rewards and transfer it to the configured
-    * commission receiver address.
+    * @dev Deduct the commission from the yet untaxed rewards and transfer it to
+    * the configured commission receiver address.
     *
     * Emit {CommissionPaid} containing the receiver address and the amount transferred.
     *
-    * Revert with {TransferFailed} containing the reciever address and the amount to be
-    * transferred if the transfer failed.
+    * Revert with {TransferFailed} containing the reciever address and the amount
+    * to be transferred if the transfer failed.
     */
     function taxRewards() internal {
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();
@@ -260,17 +280,17 @@ contract LiquidDelegation is IDelegation, BaseDelegation {
     /**
     * @inheritdoc IDelegation
     *
-    * @dev Revert with {StakingPoolNotActivated} if the staking pool has not earned
-    * any rewards yet.
+    * @dev Revert with {StakingPoolNotActivated} if the staking pool has not
+    * earned any rewards yet.
     */
     function stakeRewards() public override(BaseDelegation, IDelegation) onlyOwner {
         require(_isActivated(), StakingPoolNotActivated());
         _stakeRewards();
     }
 
     /**
-    * @dev Stake only the portion of the taxed rewards that are not needed for covering
-    * the pending withdrawals.
+    * @dev Stake only the portion of the taxed rewards that are not needed for
+    * covering the pending withdrawals.
     */
     function _stakeRewards() internal {
         LiquidDelegationStorage storage $ = _getLiquidDelegationStorage();