Metadata Functions (#989)

* Added a `name` and `version` function to each of the Hyperdrive instances

* Add `name` and `version` functions to the `HyperdriveFactory`

* Added a `name` and `version` function to the deployer coordinators

* Added a `name` and `version` function to the registry

* Fixed the rust tests

* Fixed the rust tests

* Addressed review feedback from @jrhea and @mcclurejt

* Used the constant for the `HyperdriveRegistry`

* Fixed remaining nit

contracts/src/deployers/HyperdriveDeployerCoordinator.sol

@@ -5,6 +5,7 @@ import { IHyperdrive } from "../interfaces/IHyperdrive.sol";
 import { IHyperdriveCoreDeployer } from "../interfaces/IHyperdriveCoreDeployer.sol";
 import { IHyperdriveDeployerCoordinator } from "../interfaces/IHyperdriveDeployerCoordinator.sol";
 import { IHyperdriveTargetDeployer } from "../interfaces/IHyperdriveTargetDeployer.sol";
+import { VERSION } from "../libraries/Constants.sol";
 import { ONE } from "../libraries/FixedPointMath.sol";
 
 /// @author DELV
@@ -103,6 +104,16 @@ abstract contract HyperdriveDeployerCoordinator is
         _;
     }
 
+    /// @notice Returns the deployer coordinator's name.
+    /// @notice The deployer coordinator's name.
+    function name() external pure virtual returns (string memory);
+
+    /// @notice Returns the deployer coordinator's version.
+    /// @notice The deployer coordinator's version.
+    function version() external pure returns (string memory) {
+        return VERSION;
+    }
+
     /// @notice Deploys a Hyperdrive instance with the given parameters.
     /// @dev This can only be deployed by the associated factory.
     /// @param _deploymentId The ID of the deployment.

contracts/src/deployers/erc4626/ERC4626HyperdriveDeployerCoordinator.sol

@@ -18,6 +18,10 @@ import { HyperdriveDeployerCoordinator } from "../HyperdriveDeployerCoordinator.
 contract ERC4626HyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using SafeERC20 for ERC20;
 
+    /// @notice The deployer coordinator's name.
+    string public constant override name =
+        "ERC4626HyperdriveDeployerCoordinator";
+
     /// @notice Instantiates the deployer coordinator.
     /// @param _factory The factory that this deployer will be registered with.
     /// @param _coreDeployer The core deployer.

contracts/src/deployers/ezeth/EzETHHyperdriveDeployerCoordinator.sol

@@ -21,6 +21,9 @@ contract EzETHHyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using SafeERC20 for ERC20;
     using FixedPointMath for uint256;
 
+    /// @notice The deployer coordinator's name.
+    string public constant override name = "EzETHHyperdriveDeployerCoordinator";
+
     /// @notice The Renzo contract.
     IRestakeManager public immutable restakeManager;
 

contracts/src/deployers/lseth/LsETHHyperdriveDeployerCoordinator.sol

@@ -20,6 +20,9 @@ contract LsETHHyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using SafeERC20 for ERC20;
     using FixedPointMath for uint256;
 
+    /// @notice The deployer coordinator's name.
+    string public constant override name = "LsETHHyperdriveDeployerCoordinator";
+
     /// @dev The LsETH contract.
     IRiverV1 internal immutable river;
 

contracts/src/deployers/reth/RETHHyperdriveDeployerCoordinator.sol

@@ -20,6 +20,9 @@ contract RETHHyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using SafeERC20 for ERC20;
     using FixedPointMath for uint256;
 
+    /// @notice The deployer coordinator's name.
+    string public constant override name = "RETHHyperdriveDeployerCoordinator";
+
     /// @dev The Rocket Token RETH contract.
     IRocketTokenRETH internal immutable rocketTokenReth;
 

contracts/src/deployers/steth/StETHHyperdriveDeployerCoordinator.sol

@@ -17,6 +17,9 @@ import { HyperdriveDeployerCoordinator } from "../HyperdriveDeployerCoordinator.
 contract StETHHyperdriveDeployerCoordinator is HyperdriveDeployerCoordinator {
     using FixedPointMath for uint256;
 
+    /// @notice The deployer coordinator's name.
+    string public constant override name = "StETHHyperdriveDeployerCoordinator";
+
     /// @notice The Lido contract.
     ILido public immutable lido;
 

contracts/src/external/HyperdriveTarget0.sol

@@ -12,6 +12,7 @@ import { HyperdriveMultiToken } from "../internal/HyperdriveMultiToken.sol";
 import { HyperdriveShort } from "../internal/HyperdriveShort.sol";
 import { HyperdriveStorage } from "../internal/HyperdriveStorage.sol";
 import { AssetId } from "../libraries/AssetId.sol";
+import { VERSION } from "../libraries/Constants.sol";
 import { FixedPointMath } from "../libraries/FixedPointMath.sol";
 import { LPMath } from "../libraries/LPMath.sol";
 
@@ -229,6 +230,16 @@ abstract contract HyperdriveTarget0 is
 
     /// Getters ///
 
+    /// @notice Gets the instance's name.
+    /// @return The instance's name.
+    function name() external pure virtual returns (string memory);
+
+    /// @notice Gets the instance's version.
+    /// @return The instance's version.
+    function version() external pure returns (string memory) {
+        _revert(abi.encode(VERSION));
+    }
+
     /// @notice Gets the pauser status of an address.
     /// @param _account The account to check.
     /// @return The pauser status.

contracts/src/factory/HyperdriveFactory.sol

@@ -5,6 +5,7 @@ import { IHyperdrive } from "../interfaces/IHyperdrive.sol";
 import { IHyperdriveFactory } from "../interfaces/IHyperdriveFactory.sol";
 import { IHyperdriveDeployerCoordinator } from "../interfaces/IHyperdriveDeployerCoordinator.sol";
 import { FixedPointMath, ONE } from "../libraries/FixedPointMath.sol";
+import { VERSION } from "../libraries/Constants.sol";
 import { HyperdriveMath } from "../libraries/HyperdriveMath.sol";
 
 /// @author DELV
@@ -17,6 +18,12 @@ import { HyperdriveMath } from "../libraries/HyperdriveMath.sol";
 contract HyperdriveFactory is IHyperdriveFactory {
     using FixedPointMath for uint256;
 
+    /// @notice The factory's name.
+    string public name;
+
+    /// @notice The factory's version.
+    string public constant version = VERSION;
+
     /// @dev Signifies an unlocked receive function, used by isReceiveLocked
     uint256 private constant RECEIVE_UNLOCKED = 1;
 
@@ -165,7 +172,11 @@ contract HyperdriveFactory is IHyperdriveFactory {
 
     /// @notice Initializes the factory.
     /// @param _factoryConfig Configuration of the Hyperdrive Factory.
-    constructor(FactoryConfig memory _factoryConfig) {
+    /// @param _name The factory's name.
+    constructor(FactoryConfig memory _factoryConfig, string memory _name) {
+        // Set the factory's name.
+        name = _name;
+
         // Ensure that the minimum checkpoint duration is greater than or equal
         // to the checkpoint duration resolution and is a multiple of the
         // checkpoint duration resolution.

contracts/src/factory/HyperdriveRegistry.sol

@@ -3,17 +3,30 @@ pragma solidity 0.8.20;
 
 import { IHyperdriveGovernedRegistry } from "../interfaces/IHyperdriveGovernedRegistry.sol";
 import { IHyperdriveRegistry } from "../interfaces/IHyperdriveRegistry.sol";
+import { VERSION } from "../libraries/Constants.sol";
 
 contract HyperdriveRegistry is
     IHyperdriveRegistry,
     IHyperdriveGovernedRegistry
 {
+    /// @notice The registry's name.
+    string public name;
+
+    /// @notice The registry's version.
+    string public constant version = VERSION;
+
+    /// @notice The registry's governance address.
     address public governance;
 
+    /// @notice A mapping from hyperdrive instances to info associated with
+    ///         those instances.
     mapping(address hyperdrive => uint256 data) internal _hyperdriveInfo;
 
-    constructor() {
+    /// @notice Instantiates the hyperdrive registry.
+    /// @param _name The registry's name.
+    constructor(string memory _name) {
         governance = msg.sender;
+        name = _name;
     }
 
     modifier onlyGovernance() {

contracts/src/instances/erc4626/ERC4626Target0.sol

@@ -14,9 +14,18 @@ import { ERC4626Base } from "./ERC4626Base.sol";
 ///                    only, and is not intended to, and does not, have any
 ///                    particular legal or regulatory significance.
 contract ERC4626Target0 is HyperdriveTarget0, ERC4626Base {
+    /// @dev The instance's name.
+    string internal constant NAME = "ERC4626Hyperdrive";
+
     /// @notice Initializes the target0 contract.
     /// @param _config The configuration of the Hyperdrive pool.
     constructor(
         IHyperdrive.PoolConfig memory _config
     ) HyperdriveTarget0(_config) {}
+
+    /// @notice Returns the instance's name.
+    /// @return The instance's name.
+    function name() external pure override returns (string memory) {
+        _revert(abi.encode(NAME));
+    }
 }

contracts/src/instances/ezeth/EzETHTarget0.sol

@@ -19,6 +19,9 @@ import { EzETHBase } from "./EzETHBase.sol";
 contract EzETHTarget0 is HyperdriveTarget0, EzETHBase {
     using SafeERC20 for ERC20;
 
+    /// @dev The instance's name.
+    string internal constant NAME = "EzETHHyperdrive";
+
     /// @notice Initializes the target0 contract.
     /// @param _config The configuration of the Hyperdrive pool.
     /// @param _restakeManager The Renzo contract.
@@ -29,6 +32,12 @@ contract EzETHTarget0 is HyperdriveTarget0, EzETHBase {
 
     /// Extras ///
 
+    /// @notice Returns the instance's name.
+    /// @return The instance's name.
+    function name() external pure override returns (string memory) {
+        _revert(abi.encode(NAME));
+    }
+
     /// @notice Returns the Renzo contract.
     /// @return The Renzo contract.
     function renzo() external view returns (IRestakeManager) {

contracts/src/instances/lseth/LsETHTarget0.sol

@@ -14,6 +14,9 @@ import { LsETHBase } from "./LsETHBase.sol";
 ///                    only, and is not intended to, and does not, have any
 ///                    particular legal or regulatory significance.
 contract LsETHTarget0 is HyperdriveTarget0, LsETHBase {
+    /// @dev The instance's name.
+    string internal constant NAME = "LsETHHyperdrive";
+
     /// @notice Initializes the target0 contract.
     /// @param _config The configuration of the Hyperdrive pool.
     constructor(
@@ -22,6 +25,12 @@ contract LsETHTarget0 is HyperdriveTarget0, LsETHBase {
 
     /// Getters ///
 
+    /// @notice Returns the instance's name.
+    /// @return The instance's name.
+    function name() external pure override returns (string memory) {
+        _revert(abi.encode(NAME));
+    }
+
     /// @notice Returns the MultiToken's decimals.
     /// @return The MultiToken's decimals.
     function decimals() external pure override returns (uint8) {

contracts/src/instances/reth/RETHTarget0.sol

@@ -14,6 +14,9 @@ import { RETHBase } from "./RETHBase.sol";
 ///                    only, and is not intended to, and does not, have any
 ///                    particular legal or regulatory significance.
 contract RETHTarget0 is HyperdriveTarget0, RETHBase {
+    /// @dev The instance's name.
+    string internal constant NAME = "RETHHyperdrive";
+
     /// @notice Initializes the target0 contract.
     /// @param _config The configuration of the Hyperdrive pool.
     constructor(
@@ -22,6 +25,12 @@ contract RETHTarget0 is HyperdriveTarget0, RETHBase {
 
     /// Getters ///
 
+    /// @notice Returns the instance's name.
+    /// @return The instance's name.
+    function name() external pure override returns (string memory) {
+        _revert(abi.encode(NAME));
+    }
+
     /// @notice Returns the MultiToken's decimals.
     /// @return The MultiToken's decimals.
     function decimals() external pure override returns (uint8) {

contracts/src/instances/steth/StETHTarget0.sol

@@ -14,6 +14,9 @@ import { StETHBase } from "./StETHBase.sol";
 ///                    only, and is not intended to, and does not, have any
 ///                    particular legal or regulatory significance.
 contract StETHTarget0 is HyperdriveTarget0, StETHBase {
+    /// @dev The instance's name.
+    string internal constant NAME = "StETHHyperdrive";
+
     /// @notice Initializes the target0 contract.
     /// @param _config The configuration of the Hyperdrive pool.
     constructor(
@@ -22,6 +25,12 @@ contract StETHTarget0 is HyperdriveTarget0, StETHBase {
 
     /// Getters ///
 
+    /// @notice Returns the instance's name.
+    /// @return The instance's name.
+    function name() external pure override returns (string memory) {
+        _revert(abi.encode(NAME));
+    }
+
     /// @notice Returns the MultiToken's decimals.
     /// @return The MultiToken's decimals.
     function decimals() external pure override returns (uint8) {

contracts/src/interfaces/IHyperdriveDeployerCoordinator.sol

@@ -90,6 +90,14 @@ interface IHyperdriveDeployerCoordinator {
 
     /// Functions ///
 
+    /// @notice Returns the deployer coordinator's name.
+    /// @return The deployer coordinator's name.
+    function name() external pure returns (string memory);
+
+    /// @notice Returns the deployer coordinator's version.
+    /// @return The deployer coordinator's version.
+    function version() external pure returns (string memory);
+
     /// @notice Deploys a Hyperdrive instance with the given parameters.
     /// @param _deploymentId The ID of the deployment.
     /// @param _deployConfig The deploy configuration of the Hyperdrive pool.

contracts/src/interfaces/IHyperdriveGovernedRegistry.sol

@@ -1,7 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity 0.8.20;
 
-interface IHyperdriveGovernedRegistry {
+import { IHyperdriveRegistry } from "./IHyperdriveRegistry.sol";
+
+interface IHyperdriveGovernedRegistry is IHyperdriveRegistry {
     /// @notice Emitted when governance is transferred.
     event GovernanceUpdated(address indexed governance);
 

contracts/src/interfaces/IHyperdriveRead.sol

@@ -5,6 +5,14 @@ import { IHyperdrive } from "./IHyperdrive.sol";
 import { IMultiTokenRead } from "./IMultiTokenRead.sol";
 
 interface IHyperdriveRead is IMultiTokenRead {
+    /// @notice Gets the instance's name.
+    /// @return The instance's name.
+    function name() external pure returns (string memory);
+
+    /// @notice Gets the instance's version.
+    /// @return The instance's version.
+    function version() external pure returns (string memory);
+
     /// @notice Gets the Hyperdrive pool's base token.
     /// @return The base token.
     function baseToken() external view returns (address);

contracts/src/libraries/Constants.sol

@@ -3,3 +3,6 @@ pragma solidity 0.8.20;
 
 /// @dev The placeholder address for ETH.
 address constant ETH = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
+
+/// @dev The version of the contracts.
+string constant VERSION = "v1.0.2";

contracts/test/MockHyperdrive.sol

@@ -447,6 +447,8 @@ contract MockHyperdrive is Hyperdrive, MockHyperdriveBase {
 }
 
 contract MockHyperdriveTarget0 is HyperdriveTarget0, MockHyperdriveBase {
+    string public constant override name = "MockHyperdrive";
+
     constructor(
         IHyperdrive.PoolConfig memory _config
     ) HyperdriveTarget0(_config) {}

contracts/test/MockHyperdriveDeployer.sol

@@ -5,9 +5,14 @@ import { IERC20 } from "contracts/src/interfaces/IERC20.sol";
 import { IHyperdrive } from "contracts/src/interfaces/IHyperdrive.sol";
 import { IHyperdriveDeployerCoordinator } from "contracts/src/interfaces/IHyperdriveDeployerCoordinator.sol";
 import { IHyperdriveTargetDeployer } from "contracts/src/interfaces/IHyperdriveTargetDeployer.sol";
+import { VERSION } from "contracts/src/libraries/Constants.sol";
 import { MockHyperdrive } from "./MockHyperdrive.sol";
 
 contract MockHyperdriveDeployer is IHyperdriveDeployerCoordinator {
+    string public constant name = "MockHyperdriveDeployer";
+
+    string public constant version = VERSION;
+
     mapping(address => mapping(bytes32 => address)) internal _deployments;
 
     function deploy(