fix: Locked down the sweep function (#473)

* Locked down the `sweep` function

* Added a check on `isSweepable` in `test_erc4626_sweep`

* Appeased the linter

* Turned optimizer down to avoid code size issues

* Addressed review feedback from @jrhea

Author: jalextowle

cSpell.json

@@ -112,6 +112,7 @@
         "streetsidesoftware",
         "struct",
         "structs",
+        "Sweepable",
         "timestretch",
         "totalweth",
         "tsmerge",

contracts/src/factory/ERC4626HyperdriveDeployer.sol

@@ -25,6 +25,7 @@ contract ERC4626HyperdriveDeployer is IHyperdriveDeployer {
     /// @notice Deploys a copy of hyperdrive with the given params.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _dataProvider The address of the data provider.
+    /// @param _extraData The extra data that contains the sweep targets.
     /// @param _linkerCodeHash The hash of the ERC20 linker contract's
     ///        constructor code.
     /// @param _linkerFactory The address of the factory which is used to deploy
@@ -35,16 +36,24 @@ contract ERC4626HyperdriveDeployer is IHyperdriveDeployer {
         address _dataProvider,
         bytes32 _linkerCodeHash,
         address _linkerFactory,
-        bytes32[] calldata
+        bytes32[] memory _extraData
     ) external override returns (address) {
+        // Convert the extra data to an array of addresses.
+        address[] memory sweepTargets;
+        assembly ("memory-safe") {
+            sweepTargets := _extraData
+        }
+
+        // Deploy the ERC4626Hyperdrive instance.
         return (
             address(
                 new ERC4626Hyperdrive(
                     _config,
                     _dataProvider,
                     _linkerCodeHash,
                     _linkerFactory,
-                    pool
+                    pool,
+                    sweepTargets
                 )
             )
         );

contracts/src/factory/ERC4626HyperdriveFactory.sol

@@ -16,20 +16,28 @@ import { IERC4626 } from "../interfaces/IERC4626.sol";
 ///                    only, and is not intended to, and does not, have any
 ///                    particular legal or regulatory significance.
 contract ERC4626HyperdriveFactory is HyperdriveFactory {
+    /// @dev The address of the ERC4626 pool used in this factory.
     IERC4626 internal immutable pool;
 
-    /// @notice Deploys the contract
+    /// @notice The sweep targets used in deployed instances. This specifies
+    ///         the addresses that the fee collector can sweep to collect
+    ///         incentives and redistribute them.
+    address[] internal _sweepTargets;
+
+    /// @notice Initializes the factory.
     /// @param _factoryConfig The variables that configure the factory;
-    /// @param _deployer The contract which holds the bytecode and deploys new versions.
-    /// @param _linkerFactory The address of the linker factory.
+    /// @param _deployer The contract that deploys new hyperdrive instances.
+    /// @param _linkerFactory The linker factory.
     /// @param _linkerCodeHash The hash of the linker contract's constructor code.
-    /// @param _pool The Maker ERC4626 manger contract address
+    /// @param _pool The ERC4626 pool.
+    /// @param _sweepTargets_ The addresses that can be swept by the fee collector.
     constructor(
         FactoryConfig memory _factoryConfig,
         IHyperdriveDeployer _deployer,
         address _linkerFactory,
         bytes32 _linkerCodeHash,
-        IERC4626 _pool
+        IERC4626 _pool,
+        address[] memory _sweepTargets_
     )
         HyperdriveFactory(
             _factoryConfig,
@@ -38,7 +46,48 @@ contract ERC4626HyperdriveFactory is HyperdriveFactory {
             _linkerCodeHash
         )
     {
+        // Initialize the ERC4626 pool.
         pool = _pool;
+
+        // Initialize the default sweep targets.
+        _sweepTargets = _sweepTargets_;
+    }
+
+    /// @notice Allows governance to change the sweep targets used in deployed
+    ///         instances.
+    /// @param _sweepTargets_ The new sweep targets.
+    function updateSweepTargets(
+        address[] calldata _sweepTargets_
+    ) external onlyGovernance {
+        _sweepTargets = _sweepTargets_;
+    }
+
+    /// @notice This deploys and initializes a new ERC4626Hyperdrive instance.
+    /// @param _config The pool configuration.
+    /// @param _contribution The contribution amount.
+    /// @param _apr The initial spot rate.
+    function deployAndInitialize(
+        IHyperdrive.PoolConfig memory _config,
+        bytes32[] memory,
+        uint256 _contribution,
+        uint256 _apr
+    ) public payable override returns (IHyperdrive) {
+        // Deploy and initialize the ERC4626 hyperdrive instance with the
+        // default sweep targets provided as extra data.
+        address[] memory sweepTargets_ = _sweepTargets;
+        bytes32[] memory extraData;
+        assembly ("memory-safe") {
+            extraData := sweepTargets_
+        }
+        IHyperdrive hyperdrive = super.deployAndInitialize(
+            _config,
+            extraData,
+            _contribution,
+            _apr
+        );
+
+        // Return the hyperdrive instance.
+        return hyperdrive;
     }
 
     /// @notice This deploys a data provider for the ERC4626 hyperdrive instance
@@ -62,4 +111,10 @@ contract ERC4626HyperdriveFactory is HyperdriveFactory {
             )
         );
     }
+
+    /// @notice Gets the sweep targets.
+    /// @return The sweep targets.
+    function getSweepTargets() external view returns (address[] memory) {
+        return _sweepTargets;
+    }
 }