Add validator status (#5)

* Add a test to prove bad behaviour

* Remove only flag

* Use status to track the state of a validator

* fix tests & add more

* add validation on whitelisting

* fix PR requests

* Add custom errors

* Remove duplicated checks in tests

* Generate latest docs

---------

Co-authored-by: Samuil Borisov <[email protected]>

contracts/ValidatorSet/IValidatorSet.sol

@@ -21,13 +21,18 @@ struct Epoch {
     bytes32 epochRoot;
 }
 
+enum ValidatorStatus {
+    None,
+    Whitelisted,
+    Registered,
+    Banned
+}
+
 struct Validator {
     uint256[4] blsKey;
     uint256 liquidDebt;
     uint256 commission;
-    bool active;
-    bool whitelisted;
-    bool registered; // TODO: use a single property for status instead active, whitelisted and registered
+    ValidatorStatus status;
 }
 
 interface IValidatorSet {

contracts/ValidatorSet/ValidatorSet.sol

@@ -113,7 +113,7 @@ contract ValidatorSet is ValidatorSetBase, System, AccessControl, PowerExponent,
         stake = totalStake - rewardPool.totalDelegationOf(validatorAddress);
         commission = v.commission;
         withdrawableRewards = rewardPool.getValidatorReward(validatorAddress);
-        active = v.active;
+        active = v.status == ValidatorStatus.Registered;
     }
 
     /**

contracts/ValidatorSet/modules/AccessControl/AccessControl.sol

@@ -6,6 +6,9 @@ import "./IAccessControl.sol";
 import "./../../ValidatorSetBase.sol";
 
 abstract contract AccessControl is IAccessControl, Ownable2StepUpgradeable, ValidatorSetBase {
+    error MustBeWhitelisted();
+    error PreviouslyWhitelisted();
+
     // TODO: We must be able to enable/disable this feature
     function __AccessControl_init(address governance) internal onlyInitializing {
         __AccessControl_init_unchained(governance);
@@ -34,12 +37,14 @@ abstract contract AccessControl is IAccessControl, Ownable2StepUpgradeable, Vali
     }
 
     function _addToWhitelist(address account) internal {
-        validators[account].whitelisted = true;
+        if (validators[account].status != ValidatorStatus.None) revert PreviouslyWhitelisted();
+        validators[account].status = ValidatorStatus.Whitelisted;
         emit AddedToWhitelist(account);
     }
 
     function _removeFromWhitelist(address account) internal {
-        validators[account].whitelisted = false;
+        if (validators[account].status != ValidatorStatus.Whitelisted) revert MustBeWhitelisted();
+        validators[account].status = ValidatorStatus.None;
         emit RemovedFromWhitelist(account);
     }
 

contracts/ValidatorSet/modules/Delegation/Delegation.sol

@@ -82,7 +82,7 @@ abstract contract Delegation is
     // _______________ Private functions _______________
 
     function _delegate(address validator, address delegator, uint256 amount) private {
-        if (!validators[validator].active) revert Unauthorized("INVALID_VALIDATOR");
+        if (validators[validator].status != ValidatorStatus.Registered) revert Unauthorized("INVALID_VALIDATOR");
 
         _mint(validator, amount); // increase validator power
         StateSyncer._syncStake(validator, balanceOf(validator));

contracts/ValidatorSet/modules/Staking/IStaking.sol

@@ -6,7 +6,6 @@ interface IStaking {
     event CommissionUpdated(address indexed validator, uint256 oldCommission, uint256 newCommission);
     event Staked(address indexed validator, uint256 amount);
     event Unstaked(address indexed validator, uint256 amount);
-    event ValidatorDeactivated(address indexed validator);
 
     /**
      * @notice Sets commission for validator.

contracts/ValidatorSet/modules/Staking/Staking.sol

@@ -26,8 +26,9 @@ abstract contract Staking is
 
     // _______________ Modifiers _______________
 
+    // Only address that is allowed to be a validator
     modifier onlyValidator() {
-        if (!validators[msg.sender].active) revert Unauthorized("VALIDATOR");
+        if (validators[msg.sender].status != ValidatorStatus.Registered) revert Unauthorized("VALIDATOR");
         _;
     }
 
@@ -56,10 +57,8 @@ abstract contract Staking is
      * @inheritdoc IStaking
      */
     function register(uint256[2] calldata signature, uint256[4] calldata pubkey, uint256 commission) external {
-        if (validators[msg.sender].registered) revert AlreadyRegistered(msg.sender);
-        if (!validators[msg.sender].whitelisted) revert Unauthorized("WHITELIST");
+        if (validators[msg.sender].status != ValidatorStatus.Whitelisted) revert Unauthorized("WHITELIST");
         _register(msg.sender, signature, pubkey, commission);
-        _removeFromWhitelist(msg.sender);
 
         emit NewValidator(msg.sender, pubkey);
     }
@@ -104,10 +103,8 @@ abstract contract Staking is
     ) internal {
         _verifyValidatorRegistration(validator, signature, pubkey);
         validators[validator].blsKey = pubkey;
-        validators[validator].active = true;
-        validators[validator].registered = true;
+        validators[validator].status = ValidatorStatus.Registered;
         _setCommission(validator, commission);
-
         validatorsAddresses.push(validator);
         rewardPool.onNewValidator(validator);
     }
@@ -134,18 +131,10 @@ abstract contract Staking is
             revert StakeRequirement({src: "unstake", msg: "STAKE_TOO_LOW"});
 
         _burn(msg.sender, amount);
-        _removeIfValidatorUnstaked(msg.sender, balanceAfterUnstake);
 
         return balanceAfterUnstake;
     }
 
-    function _removeIfValidatorUnstaked(address validator, uint256 newStake) private {
-        if (newStake == 0) {
-            validators[validator].active = false;
-            emit ValidatorDeactivated(validator);
-        }
-    }
-
     function _ensureStakeIsInRange(uint256 amount, uint256 currentBalance) private view {
         if (amount + currentBalance < minStake) revert StakeRequirement({src: "stake", msg: "STAKE_TOO_LOW"});
     }

contracts/common/Errors.sol

@@ -7,6 +7,5 @@ error DelegateRequirement(string src, string msg);
 error InvalidSignature(address signer);
 error ZeroAddress();
 error SendFailed();
-error AlreadyRegistered(address validator);
 error InvalidCommission(uint256 commission);
 error InvalidMinStake(uint256 minStake);

docs/RewardPool/modules/DelegationRewards.md

@@ -379,7 +379,7 @@ Keeps the delegation pools
 function delegationPositions(address, address) external view returns (uint256 duration, uint256 start, uint256 end, uint256 base, uint256 vestBonus, uint256 rsiBonus)
 ```
 
-The vesting positions for every delegator.
+The vesting positions for every delegator
 
 
 

docs/RewardPool/modules/StakingRewards.md

@@ -381,7 +381,7 @@ Historical Validator Delegation Pool's Params per delegator
 function delegationPositions(address, address) external view returns (uint256 duration, uint256 start, uint256 end, uint256 base, uint256 vestBonus, uint256 rsiBonus)
 ```
 
-The vesting positions for every delegator.
+The vesting positions for every delegator
 
 
 

docs/RewardPool/modules/Vesting.md

@@ -176,7 +176,7 @@ function beforeTopUpParams(address, address) external view returns (uint256 rewa
 
 
 
-*Keep the account parameters before the top-up, so we can separately calculate the rewards made before a top-up is madeThis is because we need to apply the RSI bonus to the rewards made before the top-upand not apply the RSI bonus to the rewards made after the top-up*
+*Keep the account parameters before the top-up, so we can separately calculate the rewards made before a top-up is made This is because we need to apply the RSI bonus to the rewards made before the top-up and not apply the RSI bonus to the rewards made after the top-up*
 
 #### Parameters
 
@@ -225,7 +225,7 @@ Historical Validator Delegation Pool's Params per delegator
 function delegationPositions(address, address) external view returns (uint256 duration, uint256 start, uint256 end, uint256 base, uint256 vestBonus, uint256 rsiBonus)
 ```
 
-The vesting positions for every delegator.
+The vesting positions for every delegator
 
 *Validator => Delegator => VestingPosition*
 

docs/ValidatorSet/ValidatorSet.md

@@ -941,7 +941,7 @@ Additional mapping to store all vesting managers per user address for fast off-c
 ### validators
 
 ```solidity
-function validators(address) external view returns (uint256 liquidDebt, uint256 commission, bool active, bool whitelisted, bool registered)
+function validators(address) external view returns (uint256 liquidDebt, uint256 commission, enum ValidatorStatus status)
 ```
 
 
@@ -960,9 +960,7 @@ function validators(address) external view returns (uint256 liquidDebt, uint256
 |---|---|---|
 | liquidDebt | uint256 | undefined |
 | commission | uint256 | undefined |
-| active | bool | undefined |
-| whitelisted | bool | undefined |
-| registered | bool | undefined |
+| status | enum ValidatorStatus | undefined |
 
 ### validatorsAddresses
 
@@ -1345,22 +1343,6 @@ event Unstaked(address indexed validator, uint256 amount)
 | validator `indexed` | address | undefined |
 | amount  | uint256 | undefined |
 
-### ValidatorDeactivated
-
-```solidity
-event ValidatorDeactivated(address indexed validator)
-```
-
-
-
-
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| validator `indexed` | address | undefined |
-
 ### WithdrawalFinished
 
 ```solidity
@@ -1400,22 +1382,6 @@ event WithdrawalRegistered(address indexed account, uint256 amount)
 
 ## Errors
 
-### AlreadyRegistered
-
-```solidity
-error AlreadyRegistered(address validator)
-```
-
-
-
-
-
-#### Parameters
-
-| Name | Type | Description |
-|---|---|---|
-| validator | address | undefined |
-
 ### DelegateRequirement
 
 ```solidity
@@ -1481,6 +1447,17 @@ error InvalidSignature(address signer)
 |---|---|---|
 | signer | address | undefined |
 
+### MustBeWhitelisted
+
+```solidity
+error MustBeWhitelisted()
+```
+
+
+
+
+
+
 ### NotVestingManager
 
 ```solidity
@@ -1492,6 +1469,17 @@ error NotVestingManager()
 
 
 
+### PreviouslyWhitelisted
+
+```solidity
+error PreviouslyWhitelisted()
+```
+
+
+
+
+
+
 ### StakeRequirement
 
 ```solidity

docs/ValidatorSet/ValidatorSetBase.md

@@ -208,7 +208,7 @@ Returns the total supply
 ### validators
 
 ```solidity
-function validators(address) external view returns (uint256 liquidDebt, uint256 commission, bool active, bool whitelisted, bool registered)
+function validators(address) external view returns (uint256 liquidDebt, uint256 commission, enum ValidatorStatus status)
 ```
 
 
@@ -227,9 +227,7 @@ function validators(address) external view returns (uint256 liquidDebt, uint256
 |---|---|---|
 | liquidDebt | uint256 | undefined |
 | commission | uint256 | undefined |
-| active | bool | undefined |
-| whitelisted | bool | undefined |
-| registered | bool | undefined |
+| status | enum ValidatorStatus | undefined |
 
 ### validatorsAddresses
 

docs/ValidatorSet/modules/AccessControl/AccessControl.md

@@ -312,7 +312,7 @@ function transferOwnership(address newOwner) external nonpayable
 ### validators
 
 ```solidity
-function validators(address) external view returns (uint256 liquidDebt, uint256 commission, bool active, bool whitelisted, bool registered)
+function validators(address) external view returns (uint256 liquidDebt, uint256 commission, enum ValidatorStatus status)
 ```
 
 
@@ -331,9 +331,7 @@ function validators(address) external view returns (uint256 liquidDebt, uint256
 |---|---|---|
 | liquidDebt | uint256 | undefined |
 | commission | uint256 | undefined |
-| active | bool | undefined |
-| whitelisted | bool | undefined |
-| registered | bool | undefined |
+| status | enum ValidatorStatus | undefined |
 
 ### validatorsAddresses
 
@@ -464,3 +462,28 @@ event RemovedFromWhitelist(address indexed validator)
 
 
 
+## Errors
+
+### MustBeWhitelisted
+
+```solidity
+error MustBeWhitelisted()
+```
+
+
+
+
+
+
+### PreviouslyWhitelisted
+
+```solidity
+error PreviouslyWhitelisted()
+```
+
+
+
+
+
+
+

docs/ValidatorSet/modules/Delegation/Delegation.md

@@ -486,7 +486,7 @@ Additional mapping to store all vesting managers per user address for fast off-c
 ### validators
 
 ```solidity
-function validators(address) external view returns (uint256 liquidDebt, uint256 commission, bool active, bool whitelisted, bool registered)
+function validators(address) external view returns (uint256 liquidDebt, uint256 commission, enum ValidatorStatus status)
 ```
 
 
@@ -505,9 +505,7 @@ function validators(address) external view returns (uint256 liquidDebt, uint256
 |---|---|---|
 | liquidDebt | uint256 | undefined |
 | commission | uint256 | undefined |
-| active | bool | undefined |
-| whitelisted | bool | undefined |
-| registered | bool | undefined |
+| status | enum ValidatorStatus | undefined |
 
 ### validatorsAddresses