@hyperlane-xyz/core 3.11.0 → 3.12.0

package/contracts/avs/ECDSAStakeRegistry.sol

@@ -0,0 +1,536 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.12;
+
+import {ECDSAStakeRegistryStorage, Quorum, StrategyParams} from "./ECDSAStakeRegistryStorage.sol";
+import {IStrategy} from "../interfaces/avs/vendored/IStrategy.sol";
+import {IDelegationManager} from "../interfaces/avs/vendored/IDelegationManager.sol";
+import {ISignatureUtils} from "../interfaces/avs/vendored/ISignatureUtils.sol";
+import {IServiceManager} from "../interfaces/avs/vendored/IServiceManager.sol";
+
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+import {CheckpointsUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/CheckpointsUpgradeable.sol";
+import {SignatureCheckerUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/cryptography/SignatureCheckerUpgradeable.sol";
+import {IERC1271Upgradeable} from "@openzeppelin/contracts-upgradeable/interfaces/IERC1271Upgradeable.sol";
+
+/// @title ECDSA Stake Registry
+/// @author Layr Labs, Inc.
+/// @dev THIS CONTRACT IS NOT AUDITED
+/// @notice Manages operator registration and quorum updates for an AVS using ECDSA signatures.
+contract ECDSAStakeRegistry is
+    IERC1271Upgradeable,
+    OwnableUpgradeable,
+    ECDSAStakeRegistryStorage
+{
+    using SignatureCheckerUpgradeable for address;
+    using CheckpointsUpgradeable for CheckpointsUpgradeable.History;
+
+    /// @dev Constructor to create ECDSAStakeRegistry.
+    /// @param _delegationManager Address of the DelegationManager contract that this registry interacts with.
+    constructor(
+        IDelegationManager _delegationManager
+    ) ECDSAStakeRegistryStorage(_delegationManager) {
+        // _disableInitializers();
+    }
+
+    /// @notice Initializes the contract with the given parameters.
+    /// @param _serviceManager The address of the service manager.
+    /// @param _thresholdWeight The threshold weight in basis points.
+    /// @param _quorum The quorum struct containing the details of the quorum thresholds.
+    function initialize(
+        address _serviceManager,
+        uint256 _thresholdWeight,
+        Quorum memory _quorum
+    ) external initializer {
+        __ECDSAStakeRegistry_init(_serviceManager, _thresholdWeight, _quorum);
+    }
+
+    /// @notice Registers a new operator using a provided signature
+    /// @param _operatorSignature Contains the operator's signature, salt, and expiry
+    function registerOperatorWithSignature(
+        address _operator,
+        ISignatureUtils.SignatureWithSaltAndExpiry memory _operatorSignature
+    ) external {
+        _registerOperatorWithSig(_operator, _operatorSignature);
+    }
+
+    /// @notice Deregisters an existing operator
+    function deregisterOperator() external {
+        _deregisterOperator(msg.sender);
+    }
+
+    /**
+     * @notice Updates the StakeRegistry's view of one or more operators' stakes adding a new entry in their history of stake checkpoints,
+     * @dev Queries stakes from the Eigenlayer core DelegationManager contract
+     * @param _operators A list of operator addresses to update
+     */
+    function updateOperators(address[] memory _operators) external {
+        _updateOperators(_operators);
+    }
+
+    /**
+     * @notice Updates the quorum configuration and the set of operators
+     * @dev Only callable by the contract owner.
+     * It first updates the quorum configuration and then updates the list of operators.
+     * @param _quorum The new quorum configuration, including strategies and their new weights
+     * @param _operators The list of operator addresses to update stakes for
+     */
+    function updateQuorumConfig(
+        Quorum memory _quorum,
+        address[] memory _operators
+    ) external onlyOwner {
+        _updateQuorumConfig(_quorum);
+        _updateOperators(_operators);
+    }
+
+    /// @notice Updates the weight an operator must have to join the operator set
+    /// @dev Access controlled to the contract owner
+    /// @param _newMinimumWeight The new weight an operator must have to join the operator set
+    function updateMinimumWeight(
+        uint256 _newMinimumWeight,
+        address[] memory _operators
+    ) external onlyOwner {
+        _updateMinimumWeight(_newMinimumWeight);
+        _updateOperators(_operators);
+    }
+
+    /**
+     * @notice Sets a new cumulative threshold weight for message validation by operator set signatures.
+     * @dev This function can only be invoked by the owner of the contract. It delegates the update to
+     * an internal function `_updateStakeThreshold`.
+     * @param _thresholdWeight The updated threshold weight required to validate a message. This is the
+     * cumulative weight that must be met or exceeded by the sum of the stakes of the signatories for
+     * a message to be deemed valid.
+     */
+    function updateStakeThreshold(uint256 _thresholdWeight) external onlyOwner {
+        _updateStakeThreshold(_thresholdWeight);
+    }
+
+    /// @notice Verifies if the provided signature data is valid for the given data hash.
+    /// @param _dataHash The hash of the data that was signed.
+    /// @param _signatureData Encoded signature data consisting of an array of signers, an array of signatures, and a reference block number.
+    /// @return The function selector that indicates the signature is valid according to ERC1271 standard.
+    function isValidSignature(
+        bytes32 _dataHash,
+        bytes memory _signatureData
+    ) external view returns (bytes4) {
+        (
+            address[] memory signers,
+            bytes[] memory signatures,
+            uint32 referenceBlock
+        ) = abi.decode(_signatureData, (address[], bytes[], uint32));
+        _checkSignatures(_dataHash, signers, signatures, referenceBlock);
+        return IERC1271Upgradeable.isValidSignature.selector;
+    }
+
+    /// @notice Retrieves the current stake quorum details.
+    /// @return Quorum - The current quorum of strategies and weights
+    function quorum() external view returns (Quorum memory) {
+        return _quorum;
+    }
+
+    /// @notice Retrieves the last recorded weight for a given operator.
+    /// @param _operator The address of the operator.
+    /// @return uint256 - The latest weight of the operator.
+    function getLastCheckpointOperatorWeight(
+        address _operator
+    ) external view returns (uint256) {
+        return _operatorWeightHistory[_operator].latest();
+    }
+
+    /// @notice Retrieves the last recorded total weight across all operators.
+    /// @return uint256 - The latest total weight.
+    function getLastCheckpointTotalWeight() external view returns (uint256) {
+        return _totalWeightHistory.latest();
+    }
+
+    /// @notice Retrieves the last recorded threshold weight
+    /// @return uint256 - The latest threshold weight.
+    function getLastCheckpointThresholdWeight()
+        external
+        view
+        returns (uint256)
+    {
+        return _thresholdWeightHistory.latest();
+    }
+
+    /// @notice Retrieves the operator's weight at a specific block number.
+    /// @param _operator The address of the operator.
+    /// @param _blockNumber The block number to get the operator weight for the quorum
+    /// @return uint256 - The weight of the operator at the given block.
+    function getOperatorWeightAtBlock(
+        address _operator,
+        uint32 _blockNumber
+    ) external view returns (uint256) {
+        return _operatorWeightHistory[_operator].getAtBlock(_blockNumber);
+    }
+
+    /// @notice Retrieves the total weight at a specific block number.
+    /// @param _blockNumber The block number to get the total weight for the quorum
+    /// @return uint256 - The total weight at the given block.
+    function getLastCheckpointTotalWeightAtBlock(
+        uint32 _blockNumber
+    ) external view returns (uint256) {
+        return _totalWeightHistory.getAtBlock(_blockNumber);
+    }
+
+    /// @notice Retrieves the threshold weight at a specific block number.
+    /// @param _blockNumber The block number to get the threshold weight for the quorum
+    /// @return uint256 - The threshold weight the given block.
+    function getLastCheckpointThresholdWeightAtBlock(
+        uint32 _blockNumber
+    ) external view returns (uint256) {
+        return _thresholdWeightHistory.getAtBlock(_blockNumber);
+    }
+
+    function operatorRegistered(
+        address _operator
+    ) external view returns (bool) {
+        return _operatorRegistered[_operator];
+    }
+
+    /// @notice Returns the weight an operator must have to contribute to validating an AVS
+    function minimumWeight() external view returns (uint256) {
+        return _minimumWeight;
+    }
+
+    /// @notice Calculates the current weight of an operator based on their delegated stake in the strategies considered in the quorum
+    /// @param _operator The address of the operator.
+    /// @return uint256 - The current weight of the operator; returns 0 if below the threshold.
+    function getOperatorWeight(
+        address _operator
+    ) public view returns (uint256) {
+        StrategyParams[] memory strategyParams = _quorum.strategies;
+        uint256 weight;
+        IStrategy[] memory strategies = new IStrategy[](strategyParams.length);
+        for (uint256 i; i < strategyParams.length; i++) {
+            strategies[i] = strategyParams[i].strategy;
+        }
+        uint256[] memory shares = DELEGATION_MANAGER.getOperatorShares(
+            _operator,
+            strategies
+        );
+        for (uint256 i; i < strategyParams.length; i++) {
+            weight += shares[i] * strategyParams[i].multiplier;
+        }
+        weight = weight / BPS;
+
+        if (weight >= _minimumWeight) {
+            return weight;
+        } else {
+            return 0;
+        }
+    }
+
+    /// @notice Initializes state for the StakeRegistry
+    /// @param _serviceManagerAddr The AVS' ServiceManager contract's address
+    function __ECDSAStakeRegistry_init(
+        address _serviceManagerAddr,
+        uint256 _thresholdWeight,
+        Quorum memory _quorum
+    ) internal onlyInitializing {
+        _serviceManager = _serviceManagerAddr;
+        _updateStakeThreshold(_thresholdWeight);
+        _updateQuorumConfig(_quorum);
+        __Ownable_init();
+    }
+
+    /// @notice Updates the set of operators for the first quorum.
+    /// @param operatorsPerQuorum An array of operator address arrays, one for each quorum.
+    /// @dev This interface maintains compatibility with avs-sync which handles multiquorums while this registry has a single quorum
+    function updateOperatorsForQuorum(
+        address[][] memory operatorsPerQuorum,
+        bytes memory
+    ) external {
+        _updateAllOperators(operatorsPerQuorum[0]);
+    }
+
+    /// @dev Updates the list of operators if the provided list has the correct number of operators.
+    /// Reverts if the provided list of operators does not match the expected total count of operators.
+    /// @param _operators The list of operator addresses to update.
+    function _updateAllOperators(address[] memory _operators) internal {
+        if (_operators.length != _totalOperators) {
+            revert MustUpdateAllOperators();
+        }
+        _updateOperators(_operators);
+    }
+
+    /// @dev Updates the weights for a given list of operator addresses.
+    /// When passing an operator that isn't registered, then 0 is added to their history
+    /// @param _operators An array of addresses for which to update the weights.
+    function _updateOperators(address[] memory _operators) internal {
+        int256 delta;
+        for (uint256 i; i < _operators.length; i++) {
+            delta += _updateOperatorWeight(_operators[i]);
+        }
+        _updateTotalWeight(delta);
+    }
+
+    /// @dev Updates the stake threshold weight and records the history.
+    /// @param _thresholdWeight The new threshold weight to set and record in the history.
+    function _updateStakeThreshold(uint256 _thresholdWeight) internal {
+        _thresholdWeightHistory.push(_thresholdWeight);
+        emit ThresholdWeightUpdated(_thresholdWeight);
+    }
+
+    /// @dev Updates the weight an operator must have to join the operator set
+    /// @param _newMinimumWeight The new weight an operator must have to join the operator set
+    function _updateMinimumWeight(uint256 _newMinimumWeight) internal {
+        uint256 oldMinimumWeight = _minimumWeight;
+        _minimumWeight = _newMinimumWeight;
+        emit MinimumWeightUpdated(oldMinimumWeight, _newMinimumWeight);
+    }
+
+    /// @notice Updates the quorum configuration
+    /// @dev Replaces the current quorum configuration with `_newQuorum` if valid.
+    /// Reverts with `InvalidQuorum` if the new quorum configuration is not valid.
+    /// Emits `QuorumUpdated` event with the old and new quorum configurations.
+    /// @param _newQuorum The new quorum configuration to set.
+    function _updateQuorumConfig(Quorum memory _newQuorum) internal {
+        if (!_isValidQuorum(_newQuorum)) {
+            revert InvalidQuorum();
+        }
+        Quorum memory oldQuorum = _quorum;
+        delete _quorum;
+        for (uint256 i; i < _newQuorum.strategies.length; i++) {
+            _quorum.strategies.push(_newQuorum.strategies[i]);
+        }
+        emit QuorumUpdated(oldQuorum, _newQuorum);
+    }
+
+    /// @dev Internal function to deregister an operator
+    /// @param _operator The operator's address to deregister
+    function _deregisterOperator(address _operator) internal {
+        if (!_operatorRegistered[_operator]) {
+            revert OperatorNotRegistered();
+        }
+        _totalOperators--;
+        delete _operatorRegistered[_operator];
+        int256 delta = _updateOperatorWeight(_operator);
+        _updateTotalWeight(delta);
+        IServiceManager(_serviceManager).deregisterOperatorFromAVS(_operator);
+        emit OperatorDeregistered(_operator, address(_serviceManager));
+    }
+
+    /// @dev registers an operator through a provided signature
+    /// @param _operatorSignature Contains the operator's signature, salt, and expiry
+    function _registerOperatorWithSig(
+        address _operator,
+        ISignatureUtils.SignatureWithSaltAndExpiry memory _operatorSignature
+    ) internal virtual {
+        if (_operatorRegistered[_operator]) {
+            revert OperatorAlreadyRegistered();
+        }
+        _totalOperators++;
+        _operatorRegistered[_operator] = true;
+        int256 delta = _updateOperatorWeight(_operator);
+        _updateTotalWeight(delta);
+        IServiceManager(_serviceManager).registerOperatorToAVS(
+            _operator,
+            _operatorSignature
+        );
+        emit OperatorRegistered(_operator, _serviceManager);
+    }
+
+    /// @notice Updates the weight of an operator and returns the previous and current weights.
+    /// @param _operator The address of the operator to update the weight of.
+    function _updateOperatorWeight(
+        address _operator
+    ) internal virtual returns (int256) {
+        int256 delta;
+        uint256 newWeight;
+        uint256 oldWeight = _operatorWeightHistory[_operator].latest();
+        if (!_operatorRegistered[_operator]) {
+            delta -= int256(oldWeight);
+            if (delta == 0) {
+                return delta;
+            }
+            _operatorWeightHistory[_operator].push(0);
+        } else {
+            newWeight = getOperatorWeight(_operator);
+            delta = int256(newWeight) - int256(oldWeight);
+            if (delta == 0) {
+                return delta;
+            }
+            _operatorWeightHistory[_operator].push(newWeight);
+        }
+        emit OperatorWeightUpdated(_operator, oldWeight, newWeight);
+        return delta;
+    }
+
+    /// @dev Internal function to update the total weight of the stake
+    /// @param delta The change in stake applied last total weight
+    /// @return oldTotalWeight The weight before the update
+    /// @return newTotalWeight The updated weight after applying the delta
+    function _updateTotalWeight(
+        int256 delta
+    ) internal returns (uint256 oldTotalWeight, uint256 newTotalWeight) {
+        oldTotalWeight = _totalWeightHistory.latest();
+        int256 newWeight = int256(oldTotalWeight) + delta;
+        newTotalWeight = uint256(newWeight);
+        _totalWeightHistory.push(newTotalWeight);
+        emit TotalWeightUpdated(oldTotalWeight, newTotalWeight);
+    }
+
+    /**
+     * @dev Verifies that a specified quorum configuration is valid. A valid quorum has:
+     *      1. Weights that sum to exactly 10,000 basis points, ensuring proportional representation.
+     *      2. Unique strategies without duplicates to maintain quorum integrity.
+     * @param _quorum The quorum configuration to be validated.
+     * @return bool True if the quorum configuration is valid, otherwise false.
+     */
+    function _isValidQuorum(
+        Quorum memory _quorum
+    ) internal pure returns (bool) {
+        StrategyParams[] memory strategies = _quorum.strategies;
+        address lastStrategy;
+        address currentStrategy;
+        uint256 totalMultiplier;
+        for (uint256 i; i < strategies.length; i++) {
+            currentStrategy = address(strategies[i].strategy);
+            if (lastStrategy >= currentStrategy) revert NotSorted();
+            lastStrategy = currentStrategy;
+            totalMultiplier += strategies[i].multiplier;
+        }
+        if (totalMultiplier != BPS) {
+            return false;
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * @notice Common logic to verify a batch of ECDSA signatures against a hash, using either last stake weight or at a specific block.
+     * @param _dataHash The hash of the data the signers endorsed.
+     * @param _signers A collection of addresses that endorsed the data hash.
+     * @param _signatures A collection of signatures matching the signers.
+     * @param _referenceBlock The block number for evaluating stake weight; use max uint32 for latest weight.
+     */
+    function _checkSignatures(
+        bytes32 _dataHash,
+        address[] memory _signers,
+        bytes[] memory _signatures,
+        uint32 _referenceBlock
+    ) internal view {
+        uint256 signersLength = _signers.length;
+        address lastSigner;
+        uint256 signedWeight;
+
+        _validateSignaturesLength(signersLength, _signatures.length);
+        for (uint256 i; i < signersLength; i++) {
+            address currentSigner = _signers[i];
+
+            _validateSortedSigners(lastSigner, currentSigner);
+            _validateSignature(currentSigner, _dataHash, _signatures[i]);
+
+            lastSigner = currentSigner;
+            uint256 operatorWeight = _getOperatorWeight(
+                currentSigner,
+                _referenceBlock
+            );
+            signedWeight += operatorWeight;
+        }
+
+        _validateThresholdStake(signedWeight, _referenceBlock);
+    }
+
+    /// @notice Validates that the number of signers equals the number of signatures, and neither is zero.
+    /// @param _signersLength The number of signers.
+    /// @param _signaturesLength The number of signatures.
+    function _validateSignaturesLength(
+        uint256 _signersLength,
+        uint256 _signaturesLength
+    ) internal pure {
+        if (_signersLength != _signaturesLength) {
+            revert LengthMismatch();
+        }
+        if (_signersLength == 0) {
+            revert InvalidLength();
+        }
+    }
+
+    /// @notice Ensures that signers are sorted in ascending order by address.
+    /// @param _lastSigner The address of the last signer.
+    /// @param _currentSigner The address of the current signer.
+    function _validateSortedSigners(
+        address _lastSigner,
+        address _currentSigner
+    ) internal pure {
+        if (_lastSigner >= _currentSigner) {
+            revert NotSorted();
+        }
+    }
+
+    /// @notice Validates a given signature against the signer's address and data hash.
+    /// @param _signer The address of the signer to validate.
+    /// @param _dataHash The hash of the data that is signed.
+    /// @param _signature The signature to validate.
+    function _validateSignature(
+        address _signer,
+        bytes32 _dataHash,
+        bytes memory _signature
+    ) internal view {
+        if (!_signer.isValidSignatureNow(_dataHash, _signature)) {
+            revert InvalidSignature();
+        }
+    }
+
+    /// @notice Retrieves the operator weight for a signer, either at the last checkpoint or a specified block.
+    /// @param _signer The address of the signer whose weight is returned.
+    /// @param _referenceBlock The block number to query the operator's weight at, or the maximum uint32 value for the last checkpoint.
+    /// @return The weight of the operator.
+    function _getOperatorWeight(
+        address _signer,
+        uint32 _referenceBlock
+    ) internal view returns (uint256) {
+        if (_referenceBlock == type(uint32).max) {
+            return _operatorWeightHistory[_signer].latest();
+        } else {
+            return _operatorWeightHistory[_signer].getAtBlock(_referenceBlock);
+        }
+    }
+
+    /// @notice Retrieve the total stake weight at a specific block or the latest if not specified.
+    /// @dev If the `_referenceBlock` is the maximum value for uint32, the latest total weight is returned.
+    /// @param _referenceBlock The block number to retrieve the total stake weight from.
+    /// @return The total stake weight at the given block or the latest if the given block is the max uint32 value.
+    function _getTotalWeight(
+        uint32 _referenceBlock
+    ) internal view returns (uint256) {
+        if (_referenceBlock == type(uint32).max) {
+            return _totalWeightHistory.latest();
+        } else {
+            return _totalWeightHistory.getAtBlock(_referenceBlock);
+        }
+    }
+
+    /// @notice Retrieves the threshold stake for a given reference block.
+    /// @param _referenceBlock The block number to query the threshold stake for.
+    /// If set to the maximum uint32 value, it retrieves the latest threshold stake.
+    /// @return The threshold stake in basis points for the reference block.
+    function _getThresholdStake(
+        uint32 _referenceBlock
+    ) internal view returns (uint256) {
+        if (_referenceBlock == type(uint32).max) {
+            return _thresholdWeightHistory.latest();
+        } else {
+            return _thresholdWeightHistory.getAtBlock(_referenceBlock);
+        }
+    }
+
+    /// @notice Validates that the cumulative stake of signed messages meets or exceeds the required threshold.
+    /// @param _signedWeight The cumulative weight of the signers that have signed the message.
+    /// @param _referenceBlock The block number to verify the stake threshold for
+    function _validateThresholdStake(
+        uint256 _signedWeight,
+        uint32 _referenceBlock
+    ) internal view {
+        uint256 totalWeight = _getTotalWeight(_referenceBlock);
+        if (_signedWeight > totalWeight) {
+            revert InvalidSignedWeight();
+        }
+        uint256 thresholdStake = _getThresholdStake(_referenceBlock);
+        if (thresholdStake > _signedWeight) {
+            revert InsufficientSignedStake();
+        }
+    }
+}

package/contracts/avs/ECDSAStakeRegistryStorage.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.12;
+
+import {IDelegationManager} from "../interfaces/avs/vendored/IDelegationManager.sol";
+import {CheckpointsUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/CheckpointsUpgradeable.sol";
+import {IECDSAStakeRegistryEventsAndErrors, Quorum, StrategyParams} from "../interfaces/avs/vendored/IECDSAStakeRegistryEventsAndErrors.sol";
+
+/// @author Layr Labs, Inc.
+abstract contract ECDSAStakeRegistryStorage is
+    IECDSAStakeRegistryEventsAndErrors
+{
+    /// @notice Manages staking delegations through the DelegationManager interface
+    IDelegationManager internal immutable DELEGATION_MANAGER;
+
+    /// @dev The total amount of multipliers to weigh stakes
+    uint256 internal constant BPS = 10_000;
+
+    /// @notice The size of the current operator set
+    uint256 internal _totalOperators;
+
+    /// @notice Stores the current quorum configuration
+    Quorum internal _quorum;
+
+    /// @notice Specifies the weight required to become an operator
+    uint256 internal _minimumWeight;
+
+    /// @notice Holds the address of the service manager
+    address internal _serviceManager;
+
+    /// @notice Defines the duration after which the stake's weight expires.
+    uint256 internal _stakeExpiry;
+
+    /// @notice Tracks the total stake history over time using checkpoints
+    CheckpointsUpgradeable.History internal _totalWeightHistory;
+
+    /// @notice Tracks the threshold bps history using checkpoints
+    CheckpointsUpgradeable.History internal _thresholdWeightHistory;
+
+    /// @notice Maps operator addresses to their respective stake histories using checkpoints
+    mapping(address => CheckpointsUpgradeable.History)
+        internal _operatorWeightHistory;
+
+    /// @notice Maps an operator to their registration status
+    mapping(address => bool) internal _operatorRegistered;
+
+    /// @param _delegationManager Connects this registry with the DelegationManager
+    constructor(IDelegationManager _delegationManager) {
+        DELEGATION_MANAGER = _delegationManager;
+    }
+
+    // slither-disable-next-line shadowing-state
+    /// @dev Reserves storage slots for future upgrades
+    // solhint-disable-next-line
+    uint256[42] private __gap;
+}