Final Polish Pass (#750)

* Added unit tests for `deployTarget`

* Finished the deployer coordinator tests

* Final polish of `HyperdriveCheckpoint`

* Polishing `HyperdriveAdmin`

* More polishing

* Finished polishing the `HyperdriveFactory`

* Add an `InsufficientBalance` error

* Addressed nits and jokes from @jrhea

Author: jalextowle

contracts/src/deployers/HyperdriveDeployerCoordinator.sol

@@ -63,7 +63,7 @@ abstract contract HyperdriveDeployerCoordinator is
     address public immutable target4Deployer;
 
     /// @notice A mapping from deployer to deployment ID to deployment.
-    mapping(address => mapping(bytes32 => Deployment)) public deployments;
+    mapping(address => mapping(bytes32 => Deployment)) internal _deployments;
 
     /// @notice Instantiates the deployer coordinator.
     /// @param _coreDeployer The core deployer.
@@ -100,7 +100,7 @@ abstract contract HyperdriveDeployerCoordinator is
         bytes32 _salt
     ) external returns (address) {
         // Ensure that the Hyperdrive entrypoint has not already been deployed.
-        Deployment memory deployment = deployments[msg.sender][_deploymentId];
+        Deployment memory deployment = _deployments[msg.sender][_deploymentId];
         if (deployment.hyperdrive != address(0)) {
             revert IHyperdriveDeployerCoordinator.HyperdriveAlreadyDeployed();
         }
@@ -132,23 +132,31 @@ abstract contract HyperdriveDeployerCoordinator is
             revert IHyperdriveDeployerCoordinator.MismatchedExtraData();
         }
 
+        // Check the pool configuration to ensure that it's a valid
+        // configuration for this instance. This was already done when deploying
+        // target0, but we check again as a precaution in case the check relies
+        // on state that can change.
+        _checkPoolConfig(_deployConfig);
+
         // Convert the deploy config into the pool config and set the initial
         // vault share price.
         IHyperdrive.PoolConfig memory config = _copyPoolConfig(_deployConfig);
         config.initialVaultSharePrice = deployment.initialSharePrice;
 
-        // Deploy the Hyperdrive instance.
-        return
-            IHyperdriveCoreDeployer(coreDeployer).deploy(
-                config,
-                _extraData,
-                deployment.target0,
-                deployment.target1,
-                deployment.target2,
-                deployment.target3,
-                deployment.target4,
-                _salt
-            );
+        // Deploy the Hyperdrive instance and add it to the deployment struct.
+        address hyperdrive = IHyperdriveCoreDeployer(coreDeployer).deploy(
+            config,
+            _extraData,
+            deployment.target0,
+            deployment.target1,
+            deployment.target2,
+            deployment.target3,
+            deployment.target4,
+            _salt
+        );
+        _deployments[msg.sender][_deploymentId].hyperdrive = hyperdrive;
+
+        return hyperdrive;
     }
 
     /// @notice Deploys a Hyperdrive target instance with the given parameters.
@@ -174,7 +182,7 @@ abstract contract HyperdriveDeployerCoordinator is
             // Ensure that the deployment is a fresh deployment. We can check this
             // by ensuring that the config hash is not set.
             if (
-                deployments[msg.sender][_deploymentId].configHash != bytes32(0)
+                _deployments[msg.sender][_deploymentId].configHash != bytes32(0)
             ) {
                 revert IHyperdriveDeployerCoordinator.DeploymentAlreadyExists();
             }
@@ -204,96 +212,113 @@ abstract contract HyperdriveDeployerCoordinator is
             );
 
             // Store the deployment.
-            deployments[msg.sender][_deploymentId].configHash = configHash;
-            deployments[msg.sender][_deploymentId]
+            _deployments[msg.sender][_deploymentId].configHash = configHash;
+            _deployments[msg.sender][_deploymentId]
                 .extraDataHash = extraDataHash;
-            deployments[msg.sender][_deploymentId]
+            _deployments[msg.sender][_deploymentId]
                 .initialSharePrice = initialSharePrice;
-            deployments[msg.sender][_deploymentId].target0 = target;
+            _deployments[msg.sender][_deploymentId].target0 = target;
 
             return target;
         }
 
         // Ensure that the deployment is not a fresh deployment. We can check
         // this by ensuring that the config hash is set.
-        if (deployments[msg.sender][_deploymentId].configHash == bytes32(0)) {
+        if (_deployments[msg.sender][_deploymentId].configHash == bytes32(0)) {
             revert IHyperdriveDeployerCoordinator.DeploymentDoesNotExist();
         }
 
         // Ensure that the provided config matches the config hash.
         if (
             keccak256(abi.encode(_deployConfig)) !=
-            deployments[msg.sender][_deploymentId].configHash
+            _deployments[msg.sender][_deploymentId].configHash
         ) {
             revert IHyperdriveDeployerCoordinator.MismatchedConfig();
         }
 
         // Ensure that the provided extra data matches the extra data hash.
         if (
             keccak256(_extraData) !=
-            deployments[msg.sender][_deploymentId].extraDataHash
+            _deployments[msg.sender][_deploymentId].extraDataHash
         ) {
             revert IHyperdriveDeployerCoordinator.MismatchedExtraData();
         }
 
+        // Check the pool configuration to ensure that it's a valid
+        // configuration for this instance. This was already done when deploying
+        // target0, but we check again as a precaution in case the check relies
+        // on state that can change.
+        _checkPoolConfig(_deployConfig);
+
         // Convert the deploy config into the pool config and set the initial
         // vault share price.
         IHyperdrive.PoolConfig memory config = _copyPoolConfig(_deployConfig);
-        config.initialVaultSharePrice = deployments[msg.sender][_deploymentId]
+        config.initialVaultSharePrice = _deployments[msg.sender][_deploymentId]
             .initialSharePrice;
 
         // If the target index is greater than 0, then we're deploying one of
         // the other target instances. We don't allow targets to be deployed
         // more than once, and their addresses are stored in the deployment
         // state.
         if (_targetIndex == 1) {
-            if (deployments[msg.sender][_deploymentId].target1 != address(0)) {
+            if (_deployments[msg.sender][_deploymentId].target1 != address(0)) {
                 revert IHyperdriveDeployerCoordinator.TargetAlreadyDeployed();
             }
             target = IHyperdriveTargetDeployer(target1Deployer).deploy(
                 config,
                 _extraData,
                 _salt
             );
-            deployments[msg.sender][_deploymentId].target1 = target;
+            _deployments[msg.sender][_deploymentId].target1 = target;
         } else if (_targetIndex == 2) {
-            if (deployments[msg.sender][_deploymentId].target2 != address(0)) {
+            if (_deployments[msg.sender][_deploymentId].target2 != address(0)) {
                 revert IHyperdriveDeployerCoordinator.TargetAlreadyDeployed();
             }
             target = IHyperdriveTargetDeployer(target2Deployer).deploy(
                 config,
                 _extraData,
                 _salt
             );
-            deployments[msg.sender][_deploymentId].target2 = target;
+            _deployments[msg.sender][_deploymentId].target2 = target;
         } else if (_targetIndex == 3) {
-            if (deployments[msg.sender][_deploymentId].target3 != address(0)) {
+            if (_deployments[msg.sender][_deploymentId].target3 != address(0)) {
                 revert IHyperdriveDeployerCoordinator.TargetAlreadyDeployed();
             }
             target = IHyperdriveTargetDeployer(target3Deployer).deploy(
                 config,
                 _extraData,
                 _salt
             );
-            deployments[msg.sender][_deploymentId].target3 = target;
+            _deployments[msg.sender][_deploymentId].target3 = target;
         } else if (_targetIndex == 4) {
-            if (deployments[msg.sender][_deploymentId].target4 != address(0)) {
+            if (_deployments[msg.sender][_deploymentId].target4 != address(0)) {
                 revert IHyperdriveDeployerCoordinator.TargetAlreadyDeployed();
             }
             target = IHyperdriveTargetDeployer(target4Deployer).deploy(
                 config,
                 _extraData,
                 _salt
             );
-            deployments[msg.sender][_deploymentId].target4 = target;
+            _deployments[msg.sender][_deploymentId].target4 = target;
         } else {
             revert IHyperdriveDeployerCoordinator.InvalidTargetIndex();
         }
 
         return target;
     }
 
-    /// @notice Checks the pool configuration to ensure that it is valid.
+    /// @notice Gets the deployment specified by the deployer and deployment ID.
+    /// @param _deployer The deployer.
+    /// @param _deploymentId The deployment ID.
+    /// @return The deployment.
+    function deployments(
+        address _deployer,
+        bytes32 _deploymentId
+    ) external view returns (Deployment memory) {
+        return _deployments[_deployer][_deploymentId];
+    }
+
+    /// @dev Checks the pool configuration to ensure that it is valid.
     /// @param _deployConfig The deploy configuration of the Hyperdrive pool.
     function _checkPoolConfig(
         IHyperdrive.PoolDeployConfig memory _deployConfig

contracts/src/external/HyperdriveTarget0.sol

@@ -203,6 +203,13 @@ abstract contract HyperdriveTarget0 is
 
     /// Getters ///
 
+    /// @notice Gets the pauser status of an address.
+    /// @param _account The account to check.
+    /// @return The pauser status.
+    function isPauser(address _account) external view returns (bool) {
+        _revert(abi.encode(_pausers[_account]));
+    }
+
     /// @notice Gets the base token.
     /// @return The base token.
     function baseToken() external view returns (address) {

contracts/src/factory/HyperdriveFactory.sol

@@ -20,20 +20,9 @@ contract HyperdriveFactory is IHyperdriveFactory {
     using FixedPointMath for uint256;
     using SafeERC20 for ERC20;
 
-    /// @notice The resolution for the checkpoint duration. Every checkpoint
-    ///         duration must be a multiple of this resolution.
-    uint256 public checkpointDurationResolution;
-
     /// @notice The governance address that updates the factory's configuration.
     address public governance;
 
-    /// @notice The number of times the factory's deployer has been updated.
-    uint256 public versionCounter = 1;
-
-    /// @notice A mapping from deployed Hyperdrive instances to the version
-    ///         of the deployer that deployed them.
-    mapping(address instance => uint256 version) public isOfficial;
-
     /// @notice The governance address used when new instances are deployed.
     address public hyperdriveGovernance;
 
@@ -46,6 +35,10 @@ contract HyperdriveFactory is IHyperdriveFactory {
     /// @notice The fee collector used when new instances are deployed.
     address public feeCollector;
 
+    /// @notice The resolution for the checkpoint duration. Every checkpoint
+    ///         duration must be a multiple of this resolution.
+    uint256 public checkpointDurationResolution;
+
     /// @notice The minimum checkpoint duration that can be used by new
     ///         deployments.
     uint256 public minCheckpointDuration;
@@ -133,6 +126,12 @@ contract HyperdriveFactory is IHyperdriveFactory {
     ///         by governance.
     mapping(address => bool) public isDeployerCoordinator;
 
+    /// @notice A mapping from deployed Hyperdrive instances to the deployer
+    ///         coordintor that deployed them. This is useful for verifying
+    ///         the bytecode that was used to deploy the instance.
+    mapping(address instance => address deployCoordinator)
+        public instancesToDeployerCoordinators;
+
     /// @dev Array of all instances deployed by this factory.
     address[] internal _instances;
 
@@ -615,9 +614,16 @@ contract HyperdriveFactory is IHyperdriveFactory {
 
         // Add this instance to the registry and emit an event with the
         // deployment configuration.
-        isOfficial[address(hyperdrive)] = versionCounter;
+        instancesToDeployerCoordinators[
+            address(hyperdrive)
+        ] = _deployerCoordinator;
         _config.governance = hyperdriveGovernance;
-        emit Deployed(versionCounter, address(hyperdrive), _config, _extraData);
+        emit Deployed(
+            _deployerCoordinator,
+            address(hyperdrive),
+            _config,
+            _extraData
+        );
 
         // Add the newly deployed Hyperdrive instance to the registry.
         _instances.push(address(hyperdrive));

…cts/src/interfaces/IForwarderFactory.sol …rc/interfaces/IERC20ForwarderFactory.solcontracts/src/interfaces/IForwarderFactory.sol renamed to contracts/src/interfaces/IERC20ForwarderFactory.sol contracts/src/interfaces/IForwarderFactory.sol renamed to contracts/src/interfaces/IERC20ForwarderFactory.sol

@@ -4,7 +4,7 @@ pragma solidity 0.8.20;
 import { IERC20Forwarder } from "./IERC20Forwarder.sol";
 import { IMultiToken } from "./IMultiToken.sol";
 
-interface IForwarderFactory {
+interface IERC20ForwarderFactory {
     /// Errors ///
 
     error InvalidForwarderAddress();

contracts/src/interfaces/IHyperdrive.sol

@@ -206,6 +206,10 @@ interface IHyperdrive is
     /// @notice Thrown when a permit signature is expired.
     error ExpiredDeadline();
 
+    /// @notice Thrown when a user doesn't have a sufficient balance to perform
+    ///         an action.
+    error InsufficientBalance();
+
     /// @notice Thrown when the pool doesn't have sufficient liquidity to
     ///         complete the trade.
     error InsufficientLiquidity(InsufficientLiquidityReason reason);

contracts/src/interfaces/IHyperdriveEvents.sol

@@ -85,4 +85,6 @@ interface IHyperdriveEvents is IMultiTokenEvents {
     event GovernanceUpdated(address indexed newGovernance);
 
     event PauserUpdated(address indexed newPauser);
+
+    event PauseStatusUpdated(bool isPaused);
 }

contracts/src/interfaces/IHyperdriveFactory.sol

@@ -7,7 +7,7 @@ interface IHyperdriveFactory {
     /// Events ///
 
     event Deployed(
-        uint256 indexed version,
+        address indexed deployerCoordinator,
         address hyperdrive,
         IHyperdrive.PoolDeployConfig config,
         bytes extraData

contracts/src/interfaces/IHyperdriveRead.sol

@@ -34,6 +34,8 @@ interface IHyperdriveRead is IMultiTokenRead {
 
     function getPoolInfo() external view returns (IHyperdrive.PoolInfo memory);
 
+    function isPauser(address _account) external view returns (bool);
+
     function load(
         uint256[] calldata _slots
     ) external view returns (bytes32[] memory);

contracts/src/internal/HyperdriveAdmin.sol

@@ -47,26 +47,39 @@ abstract contract HyperdriveAdmin is IHyperdriveEvents, HyperdriveBase {
     /// @dev Allows an authorized address to pause this contract.
     /// @param _status True to pause all deposits and false to unpause them.
     function _pause(bool _status) internal {
-        if (!_pausers[msg.sender]) revert IHyperdrive.Unauthorized();
-        _marketState.isPaused = _status;
+        // Ensure that the sender is authorized to pause the contract.
+        if (!_pausers[msg.sender]) {
+            revert IHyperdrive.Unauthorized();
+        }
 
-        // FIXME: This needs to emit an event.
+        // Update the paused status and emit an event.
+        _marketState.isPaused = _status;
+        emit PauseStatusUpdated(_status);
     }
 
     /// @dev Allows governance to change governance.
     /// @param _who The new governance address.
     function _setGovernance(address _who) internal {
-        if (msg.sender != _governance) revert IHyperdrive.Unauthorized();
-        _governance = _who;
+        // Ensure that the sender is governance.
+        if (msg.sender != _governance) {
+            revert IHyperdrive.Unauthorized();
+        }
 
+        // Update the governance address and emit an event.
+        _governance = _who;
         emit GovernanceUpdated(_who);
     }
 
     /// @dev Allows governance to change the pauser status of an address.
     /// @param who The address to change.
     /// @param status The new pauser status.
     function _setPauser(address who, bool status) internal {
-        if (msg.sender != _governance) revert IHyperdrive.Unauthorized();
+        // Ensure that the sender is governance.
+        if (msg.sender != _governance) {
+            revert IHyperdrive.Unauthorized();
+        }
+
+        // Update the pauser status and emit an event.
         _pausers[who] = status;
         emit PauserUpdated(who);
     }