Added an Aave integration

.gitmodules

@@ -12,3 +12,6 @@
 [submodule "lib/ExcessivelySafeCall"]
 	path = lib/ExcessivelySafeCall
 	url = https://github.com/nomad-xyz/ExcessivelySafeCall
+[submodule "lib/aave-v3-core"]
+	path = lib/aave-v3-core
+	url = https://github.com/aave/aave-v3-core

codegen/example/config.yaml

@@ -6,6 +6,9 @@ name:
   # names, and comments.
   capitalized: "TestETH"
 
+  # All upper case name to be used for constants.
+  uppercase: "TEST_ETH"
+
   # All lower case name to be used for directories.
   lowercase: "testeth"
 

codegen/hyperdrive_codegen/config.py

@@ -10,6 +10,7 @@ class Name(BaseModel):
     """Holds different versions of the instance name."""
 
     capitalized: str
+    uppercase: str
     lowercase: str
     camelcase: str
 

codegen/hyperdrive_codegen/templates.py

@@ -41,7 +41,6 @@ class FileInfo:
     TemplatePathInfo("deployers/Target1Deployer.sol.jinja", "Target1Deployer", "deployers"),
     TemplatePathInfo("deployers/Target2Deployer.sol.jinja", "Target2Deployer", "deployers"),
     TemplatePathInfo("deployers/Target3Deployer.sol.jinja", "Target3Deployer", "deployers"),
-    TemplatePathInfo("deployers/Target4Deployer.sol.jinja", "Target4Deployer", "deployers"),
 ]
 
 instance_templates = [
@@ -51,7 +50,6 @@ class FileInfo:
     TemplatePathInfo("instances/Target1.sol.jinja", "Target1", "instances"),
     TemplatePathInfo("instances/Target2.sol.jinja", "Target2", "instances"),
     TemplatePathInfo("instances/Target3.sol.jinja", "Target3", "instances"),
-    TemplatePathInfo("instances/Target4.sol.jinja", "Target4", "instances"),
 ]
 
 interface_templates = [

codegen/templates/deployers/HyperdriveCoreDeployer.sol.jinja

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity 0.8.20;
 
-import { I{{ name.capitalized }} } from "../../interfaces/I{{ name.capitalized }}.sol";
 import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
 import { IHyperdriveCoreDeployer } from "../../interfaces/IHyperdriveCoreDeployer.sol";
 import { {{ name.capitalized }}Hyperdrive } from "../../instances/{{ name.lowercase }}/{{ name.capitalized }}Hyperdrive.sol";
@@ -14,22 +13,22 @@ import { {{ name.capitalized }}Hyperdrive } from "../../instances/{{ name.lowerc
 ///                    particular legal or regulatory significance.
 contract {{ name.capitalized }}HyperdriveCoreDeployer is IHyperdriveCoreDeployer {
     /// @notice Deploys a Hyperdrive instance with the given parameters.
+    /// @param __name The name of the Hyperdrive pool.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _target0 The target0 address.
     /// @param _target1 The target1 address.
     /// @param _target2 The target2 address.
     /// @param _target3 The target3 address.
-    /// @param _target4 The target4 address.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Hyperdrive instance.
-    function deploy(
+    function deployHyperdrive(
+        string memory __name,
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused _extraData,
         address _target0,
         address _target1,
         address _target2,
         address _target3,
-        address _target4,
         bytes32 _salt
     ) external returns (address) {
         return (
@@ -38,7 +37,7 @@ contract {{ name.capitalized }}HyperdriveCoreDeployer is IHyperdriveCoreDeployer
                 // front-running of deployments.
                 new {{ name.capitalized }}Hyperdrive{
                     salt: keccak256(abi.encode(msg.sender, _salt))
-                }(_config, _target0, _target1, _target2, _target3, _target4)
+                }(_config, _target0, _target1, _target2, _target3)
             )
         );
     }

codegen/templates/deployers/HyperdriveDeployerCoordinator.sol.jinja

@@ -7,6 +7,7 @@ import { I{{ name.capitalized }} } from "../../interfaces/I{{ name.capitalized }
 import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
 import { I{{ name.capitalized }}Hyperdrive } from "../../interfaces/I{{ name.capitalized }}Hyperdrive.sol";
 import { IHyperdriveDeployerCoordinator } from "../../interfaces/IHyperdriveDeployerCoordinator.sol";
+import { {{ name.uppercase }}_HYPERDRIVE_DEPLOYER_COORDINATOR_KIND } from "../../libraries/Constants.sol";
 import { ONE } from "../../libraries/FixedPointMath.sol";
 import { HyperdriveDeployerCoordinator } from "../HyperdriveDeployerCoordinator.sol";
 
@@ -20,7 +21,12 @@ import { HyperdriveDeployerCoordinator } from "../HyperdriveDeployerCoordinator.
 contract {{ name.capitalized }}HyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using SafeERC20 for ERC20;
 
+    /// @notice The deployer coordinator's kind.
+    string public constant override kind =
+        {{ name.uppercase }}_HYPERDRIVE_DEPLOYER_COORDINATOR_KIND;
+
     /// @notice Instantiates the deployer coordinator.
+    /// @param _name The deployer coordinator's name.
     /// @param _factory The factory that this deployer will be registered with.
     /// @param _coreDeployer The core deployer.
     /// @param _target0Deployer The target0 deployer.
@@ -29,6 +35,7 @@ contract {{ name.capitalized }}HyperdriveDeployerCoordinator is HyperdriveDeploy
     /// @param _target3Deployer The target3 deployer.
     /// @param _target4Deployer The target4 deployer.
     constructor(
+        string memory _name,
         address _factory,
         address _coreDeployer,
         address _target0Deployer,
@@ -38,6 +45,7 @@ contract {{ name.capitalized }}HyperdriveDeployerCoordinator is HyperdriveDeploy
         address _target4Deployer
     )
         HyperdriveDeployerCoordinator(
+            _name,
             _factory,
             _coreDeployer,
             _target0Deployer,
@@ -128,10 +136,12 @@ contract {{ name.capitalized }}HyperdriveDeployerCoordinator is HyperdriveDeploy
     }
 
 {% if contract.payable %}
-    /// @dev Allows the contract to receive ether.
+    /// @dev We override the message value check since this integration is
+    ///      payable.
     function _checkMessageValue() internal view override {}
 {% else %}
-    /// @dev Prevents the contract from receiving ether.
+    /// @dev We override the message value check since this integration is
+    ///      not payable.
     function _checkMessageValue() internal view override {
         if (msg.value != 0) {
             revert IHyperdriveDeployerCoordinator.NotPayable();

codegen/templates/deployers/Target0Deployer.sol.jinja

@@ -17,7 +17,7 @@ contract {{ name.capitalized }}Target0Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Target0 instance.
-    function deploy(
+    function deployTarget(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused _extraData
         bytes32 _salt

codegen/templates/deployers/Target1Deployer.sol.jinja

@@ -17,7 +17,7 @@ contract {{ name.capitalized }}Target1Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Target1 instance.
-    function deploy(
+    function deployTarget(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused _extraData
         bytes32 _salt

codegen/templates/deployers/Target2Deployer.sol.jinja

@@ -17,7 +17,7 @@ contract {{ name.capitalized }}Target2Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Target2 instance.
-    function deploy(
+    function deployTarget(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused  _extraData
         bytes32 _salt

codegen/templates/deployers/Target3Deployer.sol.jinja

@@ -17,7 +17,7 @@ contract {{ name.capitalized }}Target3Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Target3 instance.
-    function deploy(
+    function deployTarget(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused  _extraData
         bytes32 _salt

codegen/templates/deployers/Target4Deployer.sol.jinja

@@ -17,7 +17,7 @@ contract {{ name.capitalized }}Target4Deployer is IHyperdriveTargetDeployer {
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _salt The create2 salt used in the deployment.
     /// @return The address of the newly deployed {{ name.capitalized }}Target4 instance.
-    function deploy(
+    function deployTarget(
         IHyperdrive.PoolConfig memory _config,
         bytes memory, // unused  _extraData
         bytes32 _salt

codegen/templates/instances/Hyperdrive.sol.jinja

@@ -58,22 +58,27 @@ contract {{ name.capitalized }}Hyperdrive is Hyperdrive, {{ name.capitalized }}B
     using SafeERC20 for ERC20;
 
     /// @notice Instantiates Hyperdrive with a {{ name.capitalized }} vault as the yield source.
+    /// @param __name The pool's name.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _target0 The target0 address.
     /// @param _target1 The target1 address.
     /// @param _target2 The target2 address.
     /// @param _target3 The target3 address.
     /// @param _target4 The target4 address.
     constructor(
+        string memory __name,
         IHyperdrive.PoolConfig memory _config,
         address _target0,
         address _target1,
         address _target2,
         address _target3,
         address _target4
     )
-        Hyperdrive(_config, _target0, _target1, _target2, _target3, _target4)
+        Hyperdrive(_config, _target0, _target1, _target2, _target3)
     {
+        // ****************************************************************
+        // FIXME: Implement this for new instances. ERC4626 example provided.
+
         // Approve the base token with 1 wei. This ensures that all of the
         // subsequent approvals will be writing to a dirty storage slot.
         ERC20(address(_config.baseToken)).forceApprove(

codegen/templates/instances/Target0.sol.jinja

@@ -3,6 +3,7 @@ pragma solidity 0.8.20;
 
 import { HyperdriveTarget0 } from "../../external/HyperdriveTarget0.sol";
 import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
+import { {{ name.uppercase }}_HYPERDRIVE_KIND } from "../../libraries/Constants.sol";
 import { {{ name.capitalized }}Base } from "./{{ name.capitalized }}Base.sol";
 
 /// @author DELV
@@ -20,4 +21,9 @@ contract {{ name.capitalized }}Target0 is HyperdriveTarget0, {{ name.capitalized
         IHyperdrive.PoolConfig memory _config
     ) HyperdriveTarget0(_config) {}
 
+    /// @notice Returns the instance's kind.
+    /// @return The instance's kind.
+    function kind() external pure override returns (string memory) {
+        _revert(abi.encode({{ name.uppercase }}_HYPERDRIVE_KIND));
+    }
 }

codegen/templates/instances/Target4.sol.jinja

@@ -7,7 +7,7 @@ import { {{ name.capitalized }}Base } from "./{{ name.capitalized }}Base.sol";
 
 /// @author DELV
 /// @title {{ name.capitalized }}Target4
-/// @notice {{ name.capitalized }}Hyperdrive's target4 logic contract. This contract contains
+/// @notice {{ name.capitalized }}Hyperdrive's target3 logic contract. This contract contains
 ///         several stateful functions that couldn't fit into the Hyperdrive
 ///         contract.
 /// @custom:disclaimer The language used in this code is for coding convenience

contracts/src/deployers/HyperdriveDeployerCoordinator.sol

@@ -42,6 +42,8 @@ abstract contract HyperdriveDeployerCoordinator is
         address target2;
         /// @dev The address of the HyperdriveTarget3 contract.
         address target3;
+        /// @dev The address of the HyperdriveTarget4 contract.
+        address target4;
     }
 
     /// @notice The factory that this deployer will be registered with.
@@ -62,6 +64,9 @@ abstract contract HyperdriveDeployerCoordinator is
     /// @notice The contract used to deploy new instances of HyperdriveTarget3.
     address public immutable target3Deployer;
 
+    /// @notice The contract used to deploy new instances of HyperdriveTarget4.
+    address public immutable target4Deployer;
+
     /// @notice The deployer coordinator's name.
     string public override name;
 
@@ -75,14 +80,17 @@ abstract contract HyperdriveDeployerCoordinator is
     /// @param _target0Deployer The target0 deployer.
     /// @param _target1Deployer The target1 deployer.
     /// @param _target2Deployer The target2 deployer.
+    /// @param _target3Deployer The target3 deployer.
+    /// @param _target4Deployer The target4 deployer.
     constructor(
         string memory _name,
         address _factory,
         address _coreDeployer,
         address _target0Deployer,
         address _target1Deployer,
         address _target2Deployer,
-        address _target3Deployer
+        address _target3Deployer,
+        address _target4Deployer
     ) {
         name = _name;
         factory = _factory;
@@ -91,6 +99,7 @@ abstract contract HyperdriveDeployerCoordinator is
         target1Deployer = _target1Deployer;
         target2Deployer = _target2Deployer;
         target3Deployer = _target3Deployer;
+        target4Deployer = _target4Deployer;
     }
 
     /// @dev Ensures that the contract is being called by the associated
@@ -144,7 +153,8 @@ abstract contract HyperdriveDeployerCoordinator is
             deployment.target0 == address(0) ||
             deployment.target1 == address(0) ||
             deployment.target2 == address(0) ||
-            deployment.target3 == address(0)
+            deployment.target3 == address(0) ||
+            deployment.target4 == address(0)
         ) {
             revert IHyperdriveDeployerCoordinator.IncompleteDeployment();
         }
@@ -182,6 +192,7 @@ abstract contract HyperdriveDeployerCoordinator is
                 deployment.target1,
                 deployment.target2,
                 deployment.target3,
+                deployment.target4,
                 // NOTE: We hash the deployment ID with the salt to prevent the
                 // front-running of deployments.
                 keccak256(abi.encode(deploymentId, salt))
@@ -319,6 +330,16 @@ abstract contract HyperdriveDeployerCoordinator is
                 keccak256(abi.encode(msg.sender, _deploymentId, _salt))
             );
             deployment.target3 = target;
+        } else if (_targetIndex == 4) {
+            if (deployment.target4 != address(0)) {
+                revert IHyperdriveDeployerCoordinator.TargetAlreadyDeployed();
+            }
+            target = IHyperdriveTargetDeployer(target4Deployer).deployTarget(
+                config,
+                _extraData,
+                keccak256(abi.encode(msg.sender, _deploymentId, _salt))
+            );
+            deployment.target4 = target;
         } else {
             revert IHyperdriveDeployerCoordinator.InvalidTargetIndex();
         }

contracts/src/deployers/aave/AaveHyperdriveCoreDeployer.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.20;
+
+import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
+import { IHyperdriveCoreDeployer } from "../../interfaces/IHyperdriveCoreDeployer.sol";
+import { AaveHyperdrive } from "../../instances/aave/AaveHyperdrive.sol";
+
+/// @author DELV
+/// @title AaveHyperdriveCoreDeployer
+/// @notice The core deployer for the AaveHyperdrive implementation.
+/// @custom:disclaimer The language used in this code is for coding convenience
+///                    only, and is not intended to, and does not, have any
+///                    particular legal or regulatory significance.
+contract AaveHyperdriveCoreDeployer is IHyperdriveCoreDeployer {
+    /// @notice Deploys a Hyperdrive instance with the given parameters.
+    /// @param __name The name of the Hyperdrive pool.
+    /// @param _config The configuration of the Hyperdrive pool.
+    /// @param _target0 The target0 address.
+    /// @param _target1 The target1 address.
+    /// @param _target2 The target2 address.
+    /// @param _target3 The target3 address.
+    /// @param _target4 The target4 address.
+    /// @param _salt The create2 salt used in the deployment.
+    /// @return The address of the newly deployed AaveHyperdrive instance.
+    function deployHyperdrive(
+        string memory __name,
+        IHyperdrive.PoolConfig memory _config,
+        bytes memory, // unused _extraData,
+        address _target0,
+        address _target1,
+        address _target2,
+        address _target3,
+        address _target4,
+        bytes32 _salt
+    ) external returns (address) {
+        return (
+            address(
+                // NOTE: We hash the sender with the salt to prevent the
+                // front-running of deployments.
+                new AaveHyperdrive{
+                    salt: keccak256(abi.encode(msg.sender, _salt))
+                }(
+                    __name,
+                    _config,
+                    _target0,
+                    _target1,
+                    _target2,
+                    _target3,
+                    _target4
+                )
+            )
+        );
+    }
+}