Addressed the remaining FIXME comments

Author: jalextowle

contracts/src/instances/ezeth-linea/EzETHLineaBase.sol

@@ -6,14 +6,9 @@ import { IXRenzoDeposit } from "../../interfaces/IXRenzoDeposit.sol";
 import { HyperdriveBase } from "../../internal/HyperdriveBase.sol";
 import { EzETHLineaConversions } from "./EzETHLineaConversions.sol";
 
-// FIXME: Update the Natspec comment.
-//
 /// @author DELV
 /// @title EzETHLineaBase
 /// @notice The base contract for the EzETHLinea Hyperdrive implementation.
-/// @dev This Hyperdrive implementation is designed to work with standard
-///      EzETHLinea vaults. Non-standard implementations may not work correctly
-///      and should be carefully checked.
 /// @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.

contracts/src/instances/ezeth-linea/EzETHLineaConversions.sol

@@ -4,11 +4,18 @@ pragma solidity 0.8.22;
 import { IXRenzoDeposit } from "../../interfaces/IXRenzoDeposit.sol";
 import { FixedPointMath } from "../../libraries/FixedPointMath.sol";
 
-// FIXME: Add a @dev section explaining the oracle.
-//
 /// @author DELV
 /// @title EzETHLineaConversions
 /// @notice The conversion logic for the EzETH integration on Linea.
+/// @dev This conversion library pulls the vault share price from the Renzo
+///      oracle on linea. It's possible for this oracle to have downtime or
+///      to be deprecated entirely. Our approach to this problem is to always
+///      use the latest price data (regardless of how current it is) since
+///      reverting will compromise the protocol's liveness and will prevent
+///      users from closing their existing positions. These pools should be
+///      monitored to ensure that the underlying oracle continues to be
+///      maintained, and the pool should be paused if the oracle has significant
+///      downtime or is deprecated.
 /// @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.
@@ -50,13 +57,7 @@ library EzETHLineaConversions {
     function getLastMintPrice(
         IXRenzoDeposit _xRenzoDeposit
     ) internal view returns (uint256) {
-        // FIXME: What are the historical values for this oracle? Does it ever
-        // go down?
-        //
-        // FIXME: Is this acceptable? Do we need to do anything with the timestamp?
-        //
-        // FIXME: Regardless of what we do with the timestamp, we need to make a
-        // note of what we're doing.
+        // NOTE: We
         (uint256 lastPrice, ) = _xRenzoDeposit.getMintRate();
         return lastPrice;
     }

contracts/src/instances/ezeth-linea/EzETHLineaHyperdrive.sol

@@ -7,8 +7,6 @@ import { IHyperdriveAdminController } from "../../interfaces/IHyperdriveAdminCon
 import { IXRenzoDeposit } from "../../interfaces/IXRenzoDeposit.sol";
 import { EzETHLineaBase } from "./EzETHLineaBase.sol";
 
-// FIXME: Add an @dev comment documenting this yield source.
-//
 ///      ______  __                           _________      _____
 ///      ___  / / /____  ___________________________  /_________(_)__   ______
 ///      __  /_/ /__  / / /__  __ \  _ \_  ___/  __  /__  ___/_  /__ | / /  _ \
@@ -52,6 +50,18 @@ import { EzETHLineaBase } from "./EzETHLineaBase.sol";
 /// @author DELV
 /// @title EzETHLineaHyperdrive
 /// @notice A Hyperdrive instance that uses a EzETHLinea vault as the yield source.
+/// @dev This instance supports the Renzo protocol on Linea. The vault shares token
+///      is the rebasing LRT token xezETH. There are a few special things about
+///      this integration:
+///
+///      - The base token address is the ETH constant.
+///      - The vault shares token address is the xezETH address.
+///      - The vault share price is provided by an oracle.
+///      - Interest accrues sporadically when the oracle is updated.
+///      - Base deposits aren't supported since there is a deposit fee for
+///        minting xezETH.
+///      - Base withdrawals aren't supported since there isn't an instantaneous
+///        way to withdraw from xezETH.
 /// @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.

test/instances/ezeth-linea/EzETHLineaTest.t.sol

@@ -55,7 +55,6 @@ contract EzETHLineaHyperdriveTest is InstanceTest {
             vaultSharesTokenWhaleAccounts: vaultSharesTokenWhaleAccounts,
             baseToken: IERC20(ETH),
             vaultSharesToken: EZETH,
-            // FIXME
             shareTolerance: 0,
             minimumShareReserves: 1e15,
             minimumTransactionAmount: 1e15,