Skip to content

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
cam-schultz committed Jan 14, 2025
1 parent cd8499c commit 07310b7
Show file tree
Hide file tree
Showing 9 changed files with 126 additions and 124 deletions.
98 changes: 45 additions & 53 deletions contracts/validator-manager/ACP99Manager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ struct Validator {
*/
abstract contract ACP99Manager {
/// @notice Emitted when an initial validator is registered.
event RegisteredInitialValidator(
bytes32 indexed validationID, bytes nodeID, uint64 weight
);
event RegisteredInitialValidator(bytes32 indexed validationID, bytes nodeID, uint64 weight);
/// @notice Emitted when a validator registration to the L1 is initiated.
event InitiatedValidatorRegistration(
bytes32 indexed validationID,
Expand All @@ -87,9 +85,7 @@ abstract contract ACP99Manager {
uint64 weight
);
/// @notice Emitted when a validator registration to the L1 is completed.
event CompletedValidatorRegistration(
bytes32 indexed validationID, bytes nodeID, uint64 weight
);
event CompletedValidatorRegistration(bytes32 indexed validationID, bytes nodeID, uint64 weight);
/// @notice Emitted when removal of an L1 validator is initiated.
event InitiatedValidatorRemoval(
bytes32 indexed validationID,
Expand All @@ -98,46 +94,41 @@ abstract contract ACP99Manager {
uint64 endTime
);
/// @notice Emitted when removal of an L1 validator is completed.
event CompletedValidatorRemoval(
bytes32 indexed validationID
);
event CompletedValidatorRemoval(bytes32 indexed validationID);
/// @notice Emitted when a validator weight update is initiated.
event InitiatedValidatorWeightUpdate(
bytes32 indexed validationID,
uint64 nonce,
bytes32 weightUpdateMessageID,
uint64 weight
bytes32 indexed validationID, uint64 nonce, bytes32 weightUpdateMessageID, uint64 weight
);
/// @notice Emitted when a validator weight update is completed.
event CompletedValidatorWeightUpdate(
bytes32 indexed validationID, uint64 nonce, uint64 weight
);
event CompletedValidatorWeightUpdate(bytes32 indexed validationID, uint64 nonce, uint64 weight);

/// @notice Returns the SubnetID of the L1 tied to this manager
function subnetID() virtual public view returns (bytes32 subnetID);
function subnetID() public view virtual returns (bytes32 subnetID);

/// @notice Returns the validator details for a given validation ID.
function getValidator(
bytes32 validationID
) virtual public view returns (Validator memory validator);
function getValidator(bytes32 validationID)
public
view
virtual
returns (Validator memory validator);

/// @notice Returns the total weight of the current L1 validator set.
function l1TotalWeight() virtual public view returns (uint64 weight);
function l1TotalWeight() public view virtual returns (uint64 weight);

/**
* @notice Verifies and sets the initial validator set for the chain by consuming a
* SubnetToL1ConversionMessage from the P-Chain.
*
*
* Emits a {RegisteredInitialValidator} event for each initial validator in {conversionData}.
*
* @param conversionData The Subnet conversion message data used to recompute and verify against the ConversionID.
* @param messsageIndex The index that contains the SubnetToL1ConversionMessage ICM message containing the
* @param messsageIndex The index that contains the SubnetToL1ConversionMessage ICM message containing the
* ConversionID to be verified against the provided {conversionData}.
*/
function initializeValidatorSet(
ConversionData calldata conversionData,
uint32 messsageIndex
) virtual public;
) public virtual;

/**
* @notice Initiates validator registration by issuing a RegisterL1ValidatorMessage. The validator should
Expand All @@ -160,7 +151,7 @@ abstract contract ACP99Manager {
PChainOwner memory remainingBalanceOwner,
PChainOwner memory disableOwner,
uint64 weight
) virtual internal returns (bytes32 validationID);
) internal virtual returns (bytes32 validationID);

/**
* @notice Completes the validator registration process by returning an acknowledgement of the registration of a
Expand All @@ -171,33 +162,33 @@ abstract contract ACP99Manager {
* @param messageIndex The index of the L1ValidatorRegistrationMessage to be received providing the acknowledgement.
* @return validationID The ID of the registered validator.
*/
function completeValidatorRegistration(
uint32 messageIndex
) virtual public returns (bytes32 validationID);
function completeValidatorRegistration(uint32 messageIndex)
public
virtual
returns (bytes32 validationID);

/**
* @notice Initiates validator removal by issuing a L1ValidatorWeightMessage with the weight set to zero.
* The validator should be considered inactive as soon as this function is called.
*
* Emits an {InitiatedValidatorRemoval} on success.
*
* @param validationID The ID of the validator to remove.
*/
function _initiateValidatorRemoval(
bytes32 validationID
) virtual internal;
* @notice Initiates validator removal by issuing a L1ValidatorWeightMessage with the weight set to zero.
* The validator should be considered inactive as soon as this function is called.
*
* Emits an {InitiatedValidatorRemoval} on success.
*
* @param validationID The ID of the validator to remove.
*/
function _initiateValidatorRemoval(bytes32 validationID) internal virtual;

/**
* @notice Completes validator removal by consuming an RegisterL1ValidatorMessage from the P-Chain acknowledging
* that the validator has been removed.
*
* Emits a {CompletedValidatorRemoval} on success.
*
* @param messageIndex The index of the RegisterL1ValidatorMessage.
*/
function completeValidatorRemoval(
uint32 messageIndex
) virtual public returns (bytes32 validationID);
* @notice Completes validator removal by consuming an RegisterL1ValidatorMessage from the P-Chain acknowledging
* that the validator has been removed.
*
* Emits a {CompletedValidatorRemoval} on success.
*
* @param messageIndex The index of the RegisterL1ValidatorMessage.
*/
function completeValidatorRemoval(uint32 messageIndex)
public
virtual
returns (bytes32 validationID);

/**
* @notice Initiates validator weight update by issuing a L1ValidatorWeightMessage with a nonzero weight.
Expand All @@ -213,7 +204,7 @@ abstract contract ACP99Manager {
function _initiateValidatorWeightUpdate(
bytes32 validationID,
uint64 weight
) virtual internal returns (uint64 nonce, bytes32 messageID);
) internal virtual returns (uint64 nonce, bytes32 messageID);

/**
* @notice Completes the validator weight update process by consuming a L1ValidatorWeightMessage from the P-Chain
Expand All @@ -225,7 +216,8 @@ abstract contract ACP99Manager {
* @return validationID The ID of the validator, retreived from the L1ValidatorWeightMessage.
* @return nonce The nonce of the validator, retreived from the L1ValidatorWeightMessage.
*/
function completeValidatorWeightUpdate(
uint32 messageIndex
) virtual public returns (bytes32 validationID, uint64 nonce);
}
function completeValidatorWeightUpdate(uint32 messageIndex)
public
virtual
returns (bytes32 validationID, uint64 nonce);
}
9 changes: 7 additions & 2 deletions contracts/validator-manager/PoAValidatorManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,13 @@ contract PoAValidatorManager is IPoAValidatorManager, ValidatorManager, OwnableU
/**
* @notice See {ACP99Manager-completeValidatorRemoval}.
*/
function completeValidatorRemoval(uint32 messageIndex) virtual override public returns (bytes32) {
(bytes32 validationID,) = _completeEndValidation(messageIndex);
function completeValidatorRemoval(uint32 messageIndex)
public
virtual
override
returns (bytes32)
{
(bytes32 validationID,) = _completeEndValidation(messageIndex);
return validationID;
}
}
29 changes: 17 additions & 12 deletions contracts/validator-manager/PoSValidatorManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,8 @@ import {
PoSValidatorInfo,
PoSValidatorManagerSettings
} from "./interfaces/IPoSValidatorManager.sol";
import {
ValidatorRegistrationInput
} from "./interfaces/IValidatorManager.sol";
import {
Validator,
ValidatorStatus
} from "./ACP99Manager.sol";
import {ValidatorRegistrationInput} from "./interfaces/IValidatorManager.sol";
import {Validator, ValidatorStatus} from "./ACP99Manager.sol";
import {IRewardCalculator} from "./interfaces/IRewardCalculator.sol";
import {WarpMessage} from
"@avalabs/[email protected]/contracts/interfaces/IWarpMessenger.sol";
Expand Down Expand Up @@ -380,7 +375,13 @@ abstract contract PoSValidatorManager is
/**
* @notice See {ACP99Manager-completeValidatorRemoval}.
*/
function completeValidatorRemoval(uint32 messageIndex) virtual override public nonReentrant returns (bytes32) {
function completeValidatorRemoval(uint32 messageIndex)
public
virtual
override
nonReentrant
returns (bytes32)
{
PoSValidatorManagerStorage storage $ = _getPoSValidatorManagerStorage();

(bytes32 validationID, Validator memory validator) = _completeEndValidation(messageIndex);
Expand Down Expand Up @@ -558,7 +559,8 @@ abstract contract PoSValidatorManager is
revert MaxWeightExceeded(newValidatorWeight);
}

(uint64 nonce, bytes32 messageID) = _initiateValidatorWeightUpdate(validationID, newValidatorWeight);
(uint64 nonce, bytes32 messageID) =
_initiateValidatorWeightUpdate(validationID, newValidatorWeight);

bytes32 delegationID = keccak256(abi.encodePacked(validationID, nonce));

Expand Down Expand Up @@ -611,7 +613,8 @@ abstract contract PoSValidatorManager is
// If we've already received a weight update with a nonce greater than the delegation's starting nonce,
// then there's no requirement to include an ICM message in this function call.
if (validator.receivedNonce < delegator.startingNonce) {
(bytes32 messageValidationID, uint64 nonce) = completeValidatorWeightUpdate(messageIndex);
(bytes32 messageValidationID, uint64 nonce) =
completeValidatorWeightUpdate(messageIndex);
if (validationID != messageValidationID) {
revert InvalidValidationID(delegator.validationID);
}
Expand All @@ -620,7 +623,6 @@ abstract contract PoSValidatorManager is
}
}


// Update the delegation status
$._delegatorStakes[delegationID].status = DelegatorStatus.Active;
$._delegatorStakes[delegationID].startTime = uint64(block.timestamp);
Expand Down Expand Up @@ -869,7 +871,10 @@ abstract contract PoSValidatorManager is
Validator memory validator = getValidator(delegator.validationID);

// We only expect an ICM message if we haven't received a weight update with a nonce greater than the delegation's ending nonce
if (getValidator(delegator.validationID).status != ValidatorStatus.Completed && validator.receivedNonce < delegator.endingNonce) {
if (
getValidator(delegator.validationID).status != ValidatorStatus.Completed
&& validator.receivedNonce < delegator.endingNonce
) {
(bytes32 validationID, uint64 nonce) = completeValidatorWeightUpdate(messageIndex);
if (delegator.validationID != validationID) {
revert InvalidValidationID(validationID);
Expand Down
Loading

0 comments on commit 07310b7

Please sign in to comment.