Chainlink Integration

.env_template

@@ -2,6 +2,7 @@
 MAINNET_RPC_URL=
 SEPOLIA_RPC_URL=
 BASE_SEPOLIA_RPC_URL=
+GNOSIS_CHAIN_RPC_URL=
 DEBUG_RPC_URL=
 
 # private key used for running migration scripts

.github/workflows/benchmark.yml

@@ -19,6 +19,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       # Install the dependencies.
       - uses: actions/checkout@v2

.github/workflows/coverage.yml

@@ -19,6 +19,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:

.github/workflows/solidity_lint.yml

@@ -19,6 +19,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:

.github/workflows/solidity_test.yml

@@ -19,6 +19,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:
@@ -41,6 +42,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:
@@ -63,6 +65,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:
@@ -85,6 +88,7 @@ jobs:
     env:
       MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
+      GNOSIS_CHAIN_RPC_URL: ${{ secrets.GNOSIS_CHAIN_RPC_URL }}
     steps:
       - uses: actions/checkout@v3
         with:

contracts/src/deployers/HyperdriveDeployerCoordinator.sol

@@ -173,7 +173,7 @@ abstract contract HyperdriveDeployerCoordinator is
         // 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);
+        _checkPoolConfig(_deployConfig, _extraData);
 
         // Convert the deploy config into the pool config and set the initial
         // vault share price.
@@ -232,7 +232,7 @@ abstract contract HyperdriveDeployerCoordinator is
 
             // Check the pool configuration to ensure that it's a valid
             // configuration for this instance.
-            _checkPoolConfig(_deployConfig);
+            _checkPoolConfig(_deployConfig, _extraData);
 
             // Get the initial share price and the hashes of the config and extra
             // data.
@@ -289,7 +289,7 @@ abstract contract HyperdriveDeployerCoordinator is
         // 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);
+        _checkPoolConfig(_deployConfig, _extraData);
 
         // Convert the deploy config into the pool config and set the initial
         // vault share price.
@@ -447,7 +447,8 @@ abstract contract HyperdriveDeployerCoordinator is
     /// @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
+        IHyperdrive.PoolDeployConfig memory _deployConfig,
+        bytes memory // unused _extraData
     ) internal view virtual {
         // Ensure that the minimum share reserves is at least 1e3. Deployer
         // coordinators should override this to be stricter.

contracts/src/deployers/aave/AaveHyperdriveDeployerCoordinator.sol

@@ -150,11 +150,13 @@ contract AaveHyperdriveDeployerCoordinator is
 
     /// @notice Checks the pool configuration to ensure that it is valid.
     /// @param _deployConfig The deploy configuration of the Hyperdrive pool.
+    /// @param _extraData The empty extra data.
     function _checkPoolConfig(
-        IHyperdrive.PoolDeployConfig memory _deployConfig
+        IHyperdrive.PoolDeployConfig memory _deployConfig,
+        bytes memory _extraData
     ) internal view override {
         // Perform the default checks.
-        super._checkPoolConfig(_deployConfig);
+        super._checkPoolConfig(_deployConfig, _extraData);
 
         // Ensure that the vault shares token address is non-zero.
         if (address(_deployConfig.vaultSharesToken) == address(0)) {

contracts/src/deployers/chainlink/ChainlinkHyperdriveCoreDeployer.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.22;
+
+import { IChainlinkAggregatorV3 } from "../../interfaces/IChainlinkAggregatorV3.sol";
+import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
+import { IHyperdriveCoreDeployer } from "../../interfaces/IHyperdriveCoreDeployer.sol";
+import { ChainlinkHyperdrive } from "../../instances/chainlink/ChainlinkHyperdrive.sol";
+
+/// @author DELV
+/// @title ChainlinkHyperdriveCoreDeployer
+/// @notice The core deployer for the ChainlinkHyperdrive 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 ChainlinkHyperdriveCoreDeployer 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 _extraData The extra data containing the Chainlink aggregator.
+    /// @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 ChainlinkHyperdrive instance.
+    function deployHyperdrive(
+        string memory __name,
+        IHyperdrive.PoolConfig memory _config,
+        bytes memory _extraData,
+        address _target0,
+        address _target1,
+        address _target2,
+        address _target3,
+        address _target4,
+        bytes32 _salt
+    ) external returns (address) {
+        (IChainlinkAggregatorV3 aggregator, uint8 decimals) = abi.decode(
+            _extraData,
+            (IChainlinkAggregatorV3, uint8)
+        );
+        return (
+            address(
+                // NOTE: We hash the sender with the salt to prevent the
+                // front-running of deployments.
+                new ChainlinkHyperdrive{
+                    salt: keccak256(abi.encode(msg.sender, _salt))
+                }(
+                    __name,
+                    _config,
+                    _target0,
+                    _target1,
+                    _target2,
+                    _target3,
+                    _target4,
+                    aggregator,
+                    decimals
+                )
+            )
+        );
+    }
+}

contracts/src/deployers/chainlink/ChainlinkHyperdriveDeployerCoordinator.sol

@@ -0,0 +1,158 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.22;
+
+import { ERC20 } from "openzeppelin/token/ERC20/ERC20.sol";
+import { SafeERC20 } from "openzeppelin/token/ERC20/utils/SafeERC20.sol";
+import { ChainlinkConversions } from "../../instances/chainlink/ChainlinkConversions.sol";
+import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
+import { IChainlinkAggregatorV3 } from "../../interfaces/IChainlinkAggregatorV3.sol";
+import { IHyperdriveDeployerCoordinator } from "../../interfaces/IHyperdriveDeployerCoordinator.sol";
+import { CHAINLINK_HYPERDRIVE_DEPLOYER_COORDINATOR_KIND } from "../../libraries/Constants.sol";
+import { ONE } from "../../libraries/FixedPointMath.sol";
+import { HyperdriveDeployerCoordinator } from "../HyperdriveDeployerCoordinator.sol";
+
+/// @author DELV
+/// @title ChainlinkHyperdriveDeployerCoordinator
+/// @notice The deployer coordinator for the ChainlinkHyperdrive
+///         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 ChainlinkHyperdriveDeployerCoordinator is
+    HyperdriveDeployerCoordinator
+{
+    using SafeERC20 for ERC20;
+
+    /// @notice The deployer coordinator's kind.
+    string public constant override kind =
+        CHAINLINK_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.
+    /// @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 _target4Deployer
+    )
+        HyperdriveDeployerCoordinator(
+            _name,
+            _factory,
+            _coreDeployer,
+            _target0Deployer,
+            _target1Deployer,
+            _target2Deployer,
+            _target3Deployer,
+            _target4Deployer
+        )
+    {}
+
+    /// @dev Prepares the coordinator for initialization by drawing funds from
+    ///      the LP, if necessary.
+    /// @param _hyperdrive The Hyperdrive instance that is being initialized.
+    /// @param _lp The LP that is initializing the pool.
+    /// @param _contribution The amount of capital to supply. The units of this
+    ///        quantity are either base or vault shares, depending on the value
+    ///        of `_options.asBase`.
+    /// @param _options The options that configure how the initialization is
+    ///        settled.
+    /// @return value The value that should be sent in the initialize transaction.
+    function _prepareInitialize(
+        IHyperdrive _hyperdrive,
+        address _lp,
+        uint256 _contribution,
+        IHyperdrive.Options memory _options
+    ) internal override returns (uint256 value) {
+        // Depositing as base is disallowed.
+        if (_options.asBase) {
+            revert IHyperdrive.UnsupportedToken();
+        }
+
+        // Take custody of the contribution and approve Hyperdrive to pull the
+        // tokens.
+        address token = _hyperdrive.vaultSharesToken();
+        ERC20(token).safeTransferFrom(_lp, address(this), _contribution);
+        ERC20(token).forceApprove(address(_hyperdrive), _contribution);
+
+        return value;
+    }
+
+    /// @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();
+        }
+    }
+
+    /// @notice Checks the pool configuration to ensure that it is valid.
+    /// @param _deployConfig The deploy configuration of the Hyperdrive pool.
+    /// @param _extraData The extra data containing the Chainlink aggregator
+    ///        and the instance's decimals.
+    function _checkPoolConfig(
+        IHyperdrive.PoolDeployConfig memory _deployConfig,
+        bytes memory _extraData
+    ) internal view override {
+        // Perform the default checks.
+        super._checkPoolConfig(_deployConfig, _extraData);
+
+        // Ensure that the base token is zero.
+        if (address(_deployConfig.baseToken) != address(0)) {
+            revert IHyperdriveDeployerCoordinator.InvalidBaseToken();
+        }
+
+        // Ensure that the vault shares token isn't zero.
+        if (address(_deployConfig.vaultSharesToken) == address(0)) {
+            revert IHyperdriveDeployerCoordinator.InvalidVaultSharesToken();
+        }
+
+        // Ensure that the minimum share reserves are large enough to meet the
+        // minimum requirements for safety.
+        //
+        // NOTE: Some pools may require larger minimum share reserves to be
+        // considered safe. This is just a sanity check.
+        (, uint8 decimals) = abi.decode(
+            _extraData,
+            (IChainlinkAggregatorV3, uint8)
+        );
+        if (_deployConfig.minimumShareReserves != 10 ** (decimals - 3)) {
+            revert IHyperdriveDeployerCoordinator.InvalidMinimumShareReserves();
+        }
+
+        // Ensure that the minimum transaction amount is large enough to meet
+        // the minimum requirements for safety.
+        //
+        // NOTE: Some pools may require larger minimum transaction amounts to be
+        // considered safe. This is just a sanity check.
+        if (_deployConfig.minimumTransactionAmount != 10 ** (decimals - 3)) {
+            revert IHyperdriveDeployerCoordinator
+                .InvalidMinimumTransactionAmount();
+        }
+    }
+
+    /// @dev Gets the initial vault share price of the Hyperdrive pool.
+    /// @param _extraData The extra data containing the Chainlink aggregator
+    ///        and the instance's decimals.
+    /// @return The initial vault share price of the Hyperdrive pool.
+    function _getInitialVaultSharePrice(
+        IHyperdrive.PoolDeployConfig memory, // unused _deployConfig
+        bytes memory _extraData
+    ) internal view override returns (uint256) {
+        IChainlinkAggregatorV3 aggregator = abi.decode(
+            _extraData,
+            (IChainlinkAggregatorV3)
+        );
+        return ChainlinkConversions.convertToBase(aggregator, ONE);
+    }
+}

contracts/src/deployers/chainlink/ChainlinkTarget0Deployer.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.22;
+
+import { ChainlinkTarget0 } from "../../instances/chainlink/ChainlinkTarget0.sol";
+import { IChainlinkAggregatorV3 } from "../../interfaces/IChainlinkAggregatorV3.sol";
+import { IHyperdrive } from "../../interfaces/IHyperdrive.sol";
+import { IHyperdriveTargetDeployer } from "../../interfaces/IHyperdriveTargetDeployer.sol";
+
+/// @author DELV
+/// @title ChainlinkTarget0Deployer
+/// @notice The target0 deployer for the ChainlinkHyperdrive 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 ChainlinkTarget0Deployer is IHyperdriveTargetDeployer {
+    /// @notice Deploys a target0 instance with the given parameters.
+    /// @param _config The configuration of the Hyperdrive pool.
+    /// @param _extraData The extra data containing the Chainlink aggregator.
+    /// @param _salt The create2 salt used in the deployment.
+    /// @return The address of the newly deployed ChainlinkTarget0 instance.
+    function deployTarget(
+        IHyperdrive.PoolConfig memory _config,
+        bytes memory _extraData,
+        bytes32 _salt
+    ) external returns (address) {
+        (IChainlinkAggregatorV3 aggregator, uint8 decimals) = abi.decode(
+            _extraData,
+            (IChainlinkAggregatorV3, uint8)
+        );
+        return
+            address(
+                // NOTE: We hash the sender with the salt to prevent the
+                // front-running of deployments.
+                new ChainlinkTarget0{
+                    salt: keccak256(abi.encode(msg.sender, _salt))
+                }(_config, aggregator, decimals)
+            );
+    }
+}