Update genesis validator lifecycle (#778)

contracts/src/GatewayDiamond.sol

@@ -67,7 +67,13 @@ contract GatewayDiamond {
         // through the gateway constructor in the future.
         s.maxMsgsPerBottomUpBatch = MAX_MSGS_PER_BATCH;
 
-        LibValidatorTracking.init(s.validatorsTracker, params.activeValidatorsLimit, params.genesisValidators);
+        Validator[] memory validators = LibValidatorTracking.init(
+            s.validatorsTracker,
+            params.activeValidatorsLimit,
+            params.genesisValidators
+        );
+        Membership memory initial = Membership({configurationNumber: 0, validators: validators});
+        LibGateway.updateMembership(initial);
     }
 
     function _fallback() internal {

contracts/src/lib/LibGenesis.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity ^0.8.23;
+
+import {GenesisValidator, SubnetGenesis, ValidatorInfo, ValidatorSet} from "../structs/Subnet.sol";
+import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
+
+/// @notice Provides convinient util methods to handle genesis states of the subnet
+library LibGenesis {
+    using EnumerableSet for EnumerableSet.AddressSet;
+
+    /// @notice Dumps the validator's genesis information
+    function getValidatorInfo(SubnetGenesis storage self, address validator) internal view returns(GenesisValidator memory info){
+        info = self.validatorInfo[validator];   
+    }
+
+    function addValidator(SubnetGenesis storage self, address validator) internal {
+        self.validators.add(validator);   
+    }
+
+    function removeValidator(SubnetGenesis storage self, address validator) internal {
+        self.validators.remove(validator);   
+    }
+
+    /// @notice Handles the genesis state when the subnet is bootstrapped. From this point onwards,
+    ///         no genesis state of the subnet can be changed.
+    /// @param validatorInfo The validator staking information from LibStaking
+    function bootstrap(SubnetGenesis storage self, ValidatorSet storage validatorInfo) internal {
+        finalizeValidatorInfo(self, validatorInfo);
+    }
+
+    // ============ Interal functions ==============
+
+    /// @notice Finalizes the genesis validator information as the subnet is bootstrapped. After 
+    ///         this point, the genesis validator info can no longer be changed.
+    /// @param validatorInfo The validator staking information from LibStaking
+    function finalizeValidatorInfo(SubnetGenesis storage self, ValidatorSet storage validatorInfo) internal {
+        address[] memory validators = self.validators.values();
+
+        for (uint256 i = 0; i < validators.length; ) {
+            address addr = validators[i];
+
+            ValidatorInfo memory info = validatorInfo.validators[addr];
+            GenesisValidator memory genesis = GenesisValidator({
+                collateral: info.totalCollateral,
+                federatedPower: info.federatedPower,
+                addr: addr,
+                metadata: info.metadata
+            });
+
+            self.validatorInfo[addr] = genesis;
+
+            unchecked {
+                i++;
+            }
+        }
+    }
+}

contracts/src/lib/LibStaking.sol

@@ -9,6 +9,7 @@ import {LibStakingChangeLog} from "./LibStakingChangeLog.sol";
 import {PermissionMode, StakingReleaseQueue, StakingChangeLog, StakingChange, StakingChangeRequest, StakingOperation, StakingRelease, ValidatorSet, AddressStakingReleases, ParentValidatorsTracker, GenesisValidator, Validator} from "../structs/Subnet.sol";
 import {WithdrawExceedingCollateral, NotValidator, CannotConfirmFutureChanges, NoCollateralToWithdraw, AddressShouldBeValidator, InvalidConfigurationNumber} from "../errors/IPCErrors.sol";
 import {Address} from "openzeppelin-contracts/utils/Address.sol";
+import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
 
 library LibAddressStakingReleases {
     /// @notice Add new release to the storage. Caller makes sure the release.releasedAt is ordered
@@ -173,7 +174,6 @@ library LibValidatorSet {
         collateral += getTotalConfirmedCollateral(validators);
     }
 
-
     /// @notice Get the total power of the validators.
     /// The function reverts if at least one validator is not in the active validator set.
     function getTotalPowerOfValidators(
@@ -377,6 +377,7 @@ library LibStaking {
     using LibMaxPQ for MaxPQ;
     using LibMinPQ for MinPQ;
     using Address for address payable;
+    using EnumerableSet for EnumerableSet.AddressSet;
 
     uint64 internal constant INITIAL_CONFIGURATION_NUMBER = 1;
 
@@ -469,31 +470,6 @@ library LibStaking {
         s.validatorSet.recordDeposit(validator, amount);
         // confirm deposit that updates the confirmed collateral
         s.validatorSet.confirmDeposit(validator, amount);
-
-        if (!s.bootstrapped) {
-            // add to initial validators avoiding duplicates if it
-            // is a genesis validator.
-            bool alreadyValidator;
-            uint256 length = s.genesisValidators.length;
-            for (uint256 i; i < length; ) {
-                if (s.genesisValidators[i].addr == validator) {
-                    alreadyValidator = true;
-                    break;
-                }
-                unchecked {
-                    ++i;
-                }
-            }
-            if (!alreadyValidator) {
-                uint256 collateral = s.validatorSet.validators[validator].confirmedCollateral;
-                Validator memory val = Validator({
-                    addr: validator,
-                    weight: collateral,
-                    metadata: s.validatorSet.validators[validator].metadata
-                });
-                s.genesisValidators.push(val);
-            }
-        }
     }
 
     /// @notice Confirm the withdraw directly without going through the confirmation process
@@ -541,7 +517,6 @@ library LibStaking {
     }
 
     // =============== Other functions ================
-
     /// @notice Claim the released collateral
     function claimCollateral(address validator) internal {
         SubnetActorStorage storage s = LibSubnetActorStorage.appStorage();
@@ -611,15 +586,15 @@ library LibValidatorTracking {
         ParentValidatorsTracker storage self,
         uint16 activeValidatorsLimit,
         GenesisValidator[] memory validators
-    ) internal returns (Validator[] memory membership) {
+    ) internal returns (Validator[] memory) {
         self.validators.activeLimit = activeValidatorsLimit;
         // Start the next configuration number from 1, 0 is reserved for no change and the genesis membership
         self.changes.nextConfigurationNumber = LibStaking.INITIAL_CONFIGURATION_NUMBER;
         // The startConfiguration number is also 1 to match with nextConfigurationNumber, indicating we have
         // empty validator change logs
         self.changes.startConfigurationNumber = LibStaking.INITIAL_CONFIGURATION_NUMBER;
 
-        initValidators(self, validators);
+        return initValidators(self, validators);
     }
 
     function initValidators(

contracts/src/lib/LibSubnetActor.sol

@@ -5,16 +5,18 @@ import {VALIDATOR_SECP256K1_PUBLIC_KEY_LENGTH} from "../constants/Constants.sol"
 import {ERR_PERMISSIONED_AND_BOOTSTRAPPED} from "../errors/IPCErrors.sol";
 import {NotEnoughGenesisValidators, DuplicatedGenesisValidator, NotOwnerOfPublicKey, MethodNotAllowed} from "../errors/IPCErrors.sol";
 import {IGateway} from "../interfaces/IGateway.sol";
-import {Validator, ValidatorSet, PermissionMode} from "../structs/Subnet.sol";
+import {Validator, ValidatorSet, PermissionMode, SubnetGenesis} from "../structs/Subnet.sol";
 import {SubnetActorModifiers} from "../lib/LibSubnetActorStorage.sol";
 import {LibValidatorSet, LibStaking} from "../lib/LibStaking.sol";
+import {LibGenesis} from "../lib/LibGenesis.sol";
 import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
 import {LibSubnetActorStorage, SubnetActorStorage} from "./LibSubnetActorStorage.sol";
 
 library LibSubnetActor {
     using EnumerableSet for EnumerableSet.AddressSet;
+    using LibGenesis for SubnetGenesis;
 
-    event SubnetBootstrapped(Validator[]);
+    event SubnetBootstrapped(address[]);
 
     /// @notice Ensures that the subnet is operating under Collateral-based permission mode.
     /// @dev Reverts if the subnet is not in Collateral mode.
@@ -48,7 +50,8 @@ library LibSubnetActor {
         if (totalCollateral >= s.minActivationCollateral) {
             if (LibStaking.totalActiveValidators() >= s.minValidators) {
                 s.bootstrapped = true;
-                emit SubnetBootstrapped(s.genesisValidators);
+                s.genesis.bootstrap(s.validatorSet);
+                emit SubnetBootstrapped(s.genesis.validators.values());
 
                 // register adding the genesis circulating supply (if it exists)
                 IGateway(s.ipcGatewayAddr).register{value: totalCollateral + s.genesisCircSupply}(s.genesisCircSupply);
@@ -98,16 +101,16 @@ library LibSubnetActor {
 
             LibStaking.setMetadataWithConfirm(validators[i], publicKeys[i]);
             LibStaking.setFederatedPowerWithConfirm(validators[i], powers[i]);
-
-            s.genesisValidators.push(Validator({addr: validators[i], weight: powers[i], metadata: publicKeys[i]}));
+            s.genesis.addValidator(validators[i]);
 
             unchecked {
                 ++i;
             }
         }
 
         s.bootstrapped = true;
-        emit SubnetBootstrapped(s.genesisValidators);
+        s.genesis.bootstrap(s.validatorSet);
+        emit SubnetBootstrapped(s.genesis.validators.values());
 
         // register adding the genesis circulating supply (if it exists)
         IGateway(s.ipcGatewayAddr).register{value: s.genesisCircSupply}(s.genesisCircSupply);

contracts/src/lib/LibSubnetActorStorage.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.23;
 import {ConsensusType} from "../enums/ConsensusType.sol";
 import {NotGateway, SubnetAlreadyKilled} from "../errors/IPCErrors.sol";
 import {BottomUpCheckpoint, BottomUpMsgBatchInfo} from "../structs/CrossNet.sol";
-import {SubnetID, ValidatorSet, StakingChangeLog, StakingReleaseQueue, SupplySource, Validator, PermissionMode} from "../structs/Subnet.sol";
+import {SubnetID, ValidatorSet, StakingChangeLog, StakingReleaseQueue, SupplySource, Validator, SubnetGenesis, PermissionMode} from "../structs/Subnet.sol";
 import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
 
     struct SubnetActorStorage {
@@ -55,8 +55,8 @@ import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.
         EnumerableSet.AddressSet bootstrapOwners;
         /// @notice contains all committed bottom-up checkpoint at specific epoch
         mapping(uint256 => BottomUpCheckpoint) committedCheckpoints;
-        /// @notice initial set of validators joining in genesis
-        Validator[] genesisValidators;
+        /// @notice Tracks the subnet genesis state
+        SubnetGenesis genesis;
         /// @notice genesis balance to be allocated to the subnet in genesis.
         mapping(address => uint256) genesisBalance;
         /// @notice genesis balance addresses

contracts/src/structs/Subnet.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.23;
 import {FvmAddress} from "./FvmAddress.sol";
 import {MaxPQ} from "../lib/priority/LibMaxPQ.sol";
 import {MinPQ} from "../lib/priority/LibMinPQ.sol";
+import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
 
 /// @notice A subnet identity type.
 struct SubnetID {
@@ -153,6 +154,17 @@ struct GenesisValidator {
     bytes metadata;
 }
 
+/// @notice Maintains the genesis information related to a particular subnet
+struct SubnetGenesis {
+    /// The genesis validators
+    EnumerableSet.AddressSet validators;
+    /// Tracks the validator info. This is only populated when the subnet is bootstrapped
+    mapping(address => GenesisValidator) validatorInfo;
+
+    /// TODO: migrating all the genesis related fields to this struct so that one can handle
+    ///       them all in a library.
+}
+
 /// @notice Validator struct stored in the gateway.
 struct Validator {
     uint256 weight;

contracts/src/subnet/SubnetActorGetterFacet.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.23;
 import {ConsensusType} from "../enums/ConsensusType.sol";
 import {BottomUpCheckpoint, IpcEnvelope} from "../structs/CrossNet.sol";
 import {SubnetID, SupplySource} from "../structs/Subnet.sol";
-import {SubnetID, ValidatorInfo, Validator, PermissionMode} from "../structs/Subnet.sol";
+import {SubnetID, ValidatorInfo, Validator, GenesisValidator, PermissionMode} from "../structs/Subnet.sol";
 import {SubnetActorStorage} from "../lib/LibSubnetActorStorage.sol";
 import {SubnetIDHelper} from "../lib/SubnetIDHelper.sol";
 import {Address} from "openzeppelin-contracts/utils/Address.sol";
@@ -55,8 +55,40 @@ contract SubnetActorGetterFacet {
     }
 
     /// @notice Returns the initial set of validators of the genesis block.
-    function genesisValidators() external view returns (Validator[] memory) {
-        return s.genesisValidators;
+    function genesisValidators() external view returns (GenesisValidator[] memory validators) {
+        uint256 total = s.genesis.validators.length();
+
+        validators = new GenesisValidator[](total);
+
+        if (s.bootstrapped) {
+            // subnet boostrapped, that means validator information at genesis should be locked
+            // and cannot be changed anymore, fetch from s.genesis
+
+            for (uint256 i = 0; i < total; ) {
+                address addr = s.genesis.validators.at(i);
+                validators[i] = s.genesis.validatorInfo[addr];
+
+                unchecked {
+                    i++;
+                }
+            }
+            return validators;
+        }
+
+        for (uint256 i = 0; i < total; ) {
+            address addr = s.genesis.validators.at(i);
+            ValidatorInfo memory info = getValidator(addr);
+            validators[i] = GenesisValidator({
+                // for genesis validators, totalCollateral == confirmedCollateral
+                collateral: info.totalCollateral,
+                federatedPower: info.federatedPower,
+                addr: addr,
+                metadata: info.metadata
+            });
+            unchecked {
+                i++;
+            }
+        }
     }
 
     // @notice Provides the circulating supply of the genesis block.
@@ -114,7 +146,7 @@ contract SubnetActorGetterFacet {
 
     /// @notice Returns detailed information about a specific validator.
     /// @param validatorAddress The address of the validator to query information for.
-    function getValidator(address validatorAddress) external view returns (ValidatorInfo memory validator) {
+    function getValidator(address validatorAddress) public view returns (ValidatorInfo memory validator) {
         validator = s.validatorSet.validators[validatorAddress];
     }
 

contracts/src/subnet/SubnetActorManagerFacet.sol

@@ -5,11 +5,12 @@ import {VALIDATOR_SECP256K1_PUBLIC_KEY_LENGTH} from "../constants/Constants.sol"
 import {ERR_VALIDATOR_JOINED, ERR_VALIDATOR_NOT_JOINED} from "../errors/IPCErrors.sol";
 import {InvalidFederationPayload, SubnetAlreadyBootstrapped, NotEnoughFunds, CollateralIsZero, CannotReleaseZero, NotOwnerOfPublicKey, EmptyAddress, NotEnoughBalance, NotEnoughCollateral, NotValidator, NotAllValidatorsHaveLeft, InvalidPublicKeyLength, MethodNotAllowed, SubnetNotBootstrapped} from "../errors/IPCErrors.sol";
 import {IGateway} from "../interfaces/IGateway.sol";
-import {Validator, ValidatorSet} from "../structs/Subnet.sol";
+import {Validator, ValidatorSet, SubnetGenesis} from "../structs/Subnet.sol";
 import {LibDiamond} from "../lib/LibDiamond.sol";
 import {ReentrancyGuard} from "../lib/LibReentrancyGuard.sol";
 import {SubnetActorModifiers} from "../lib/LibSubnetActorStorage.sol";
 import {LibValidatorSet, LibStaking} from "../lib/LibStaking.sol";
+import {LibGenesis} from "../lib/LibGenesis.sol";
 import {EnumerableSet} from "openzeppelin-contracts/utils/structs/EnumerableSet.sol";
 import {Address} from "openzeppelin-contracts/utils/Address.sol";
 import {LibSubnetActor} from "../lib/LibSubnetActor.sol";
@@ -18,6 +19,7 @@ import {Pausable} from "../lib/LibPausable.sol";
 contract SubnetActorManagerFacet is SubnetActorModifiers, ReentrancyGuard, Pausable {
     using EnumerableSet for EnumerableSet.AddressSet;
     using LibValidatorSet for ValidatorSet;
+    using LibGenesis for SubnetGenesis;
     using Address for address payable;
 
     /// @notice method to add some initial balance into a subnet that hasn't yet bootstrapped.
@@ -142,6 +144,7 @@ contract SubnetActorManagerFacet is SubnetActorModifiers, ReentrancyGuard, Pausa
             // confirm validators deposit immediately
             LibStaking.setMetadataWithConfirm(msg.sender, publicKey);
             LibStaking.depositWithConfirm(msg.sender, msg.value);
+            s.genesis.addValidator(msg.sender);
 
             LibSubnetActor.bootstrapSubnetIfNeeded();
         } else {
@@ -169,7 +172,6 @@ contract SubnetActorManagerFacet is SubnetActorModifiers, ReentrancyGuard, Pausa
 
         if (!s.bootstrapped) {
             LibStaking.depositWithConfirm(msg.sender, msg.value);
-
             LibSubnetActor.bootstrapSubnetIfNeeded();
         } else {
             LibStaking.deposit(msg.sender, msg.value);
@@ -193,11 +195,17 @@ contract SubnetActorManagerFacet is SubnetActorModifiers, ReentrancyGuard, Pausa
         if (collateral == 0) {
             revert NotValidator(msg.sender);
         }
-        if (collateral <= amount) {
+        if (collateral < amount) {
             revert NotEnoughCollateral();
         }
         if (!s.bootstrapped) {
             LibStaking.withdrawWithConfirm(msg.sender, amount);
+
+            uint256 total = LibStaking.totalValidatorCollateral(msg.sender);
+            if (total == 0) {
+                s.genesis.removeValidator(msg.sender);
+            }
+
             return;
         }
 
@@ -237,6 +245,7 @@ contract SubnetActorManagerFacet is SubnetActorModifiers, ReentrancyGuard, Pausa
 
             // interaction must be performed after checks and changes
             LibStaking.withdrawWithConfirm(msg.sender, amount);
+            s.genesis.removeValidator(msg.sender);
             return;
         }
         LibStaking.withdraw(msg.sender, amount);

contracts/test/helpers/TestUtils.sol

@@ -194,7 +194,7 @@ contract MockIpcContractRevert is IpcHandler {
     bool public reverted = true;
 
     /* solhint-disable-next-line unused-vars */
-    function handleIpcMessage(IpcEnvelope calldata) external payable returns (bytes memory ret) {
+    function handleIpcMessage(IpcEnvelope calldata) external payable returns (bytes memory) {
         // success execution of this methid will set reverted to false, by default it's true
         reverted = false;