native-pool-review (#1788)

Signed-off-by: shankar <[email protected]>

Author: shankars99

examples/ovault-evm/test/vault-sync/VaultComposerSync_ProxySend.t.sol

@@ -22,7 +22,7 @@ contract VaultComposerSyncProxySendTest is VaultComposerSyncBaseTest {
         vm.deal(userA, 100 ether);
     }
 
-    function test_target_is_hub_reverts_when_msg_value_provided() public {
+    function test_target_is_hub_does_not_revert_when_msg_value_provided() public {
         SendParam memory sendParam = SendParam(ARB_EID, addressToBytes32(userA), TOKENS_TO_SEND, 0, "", "", "");
         assetOFT_arb.mint(address(userA), TOKENS_TO_SEND);
         vault_arb.mint(address(userA), TOKENS_TO_SEND);

packages/ovault-evm/contracts/VaultComposerSync.sol

@@ -398,8 +398,8 @@ contract VaultComposerSync is IVaultComposerSync, ReentrancyGuard {
      * @dev Internal function to validate the share token compatibility
      * @dev Validate part of the constructor in an overridable function due to differences in asset and OFT token
      * @return shareERC20 The address of the share ERC20 token
-     * @notice Share token must be the vault itself
-     * @notice Share OFT must be an adapter (approvalRequired() returns true)
+     * @dev requirement Share token must be the vault itself
+     * @dev requirement Share OFT must be an adapter (approvalRequired() returns true)
      */
     function _initializeShareToken() internal virtual returns (address shareERC20) {
         shareERC20 = IOFT(SHARE_OFT).token();

packages/ovault-evm/contracts/VaultComposerSyncNative.sol

@@ -14,10 +14,10 @@ import { VaultComposerSync } from "./VaultComposerSync.sol";
 /**
  * @title Synchronous Vault Composer with Stargate NativePools as Asset and WETH as Share
  * @author LayerZero Labs (@shankars99)
- * @dev Extends VaultComposerSync with Pool-specific behavior such as oft.token wrapping
+ * @dev Extends VaultComposerSync with Pool-specific behavior such as OFT token wrapping
  * @dev WETH is used as the asset token for the vault instead of native token (ETH)
- * @dev DepositAndSend and Deposit use asset token (WETH) instead of native token (ETH)
- * @dev DepositNativeAndSend allows for deposits with ETH
+ * @dev `depositAndSend` uses asset token (WETH)
+ * @dev `depositNativeAndSend` allows for deposits with ETH
  * @dev Redemptions always output the asset token (WETH)
  * @dev Compatible with ERC4626 vaults and requires Share OFT to be an adapter
  */
@@ -43,7 +43,7 @@ contract VaultComposerSyncNative is VaultComposerSync, IVaultComposerSyncNative
      * @dev Reduction of ComposerNative into ComposerBase by wrapping ETH into WETH
      * @dev All internal logic handles WETH as the asset token making deposit symmetric to redemption
      * @dev The native token used here was sent during lzReceive from the Pool
-     * @dev lzCompose calls comes from the Endpoint and are not affected by the wrapNative call
+     @dev Inherits entry authorization from parent contract
      */
     function lzCompose(
         address _composeSender, // The OFT used on refund, also the vaultIn token.
@@ -53,6 +53,7 @@ contract VaultComposerSyncNative is VaultComposerSync, IVaultComposerSyncNative
         bytes calldata _extraData
     ) public payable virtual override {
         /// @dev Wrap ETH received during lzReceive into WETH
+        /// @dev Conversion happens here to avoid running out of gas in the receive function
         if (_composeSender == ASSET_OFT) IWETH(ASSET_ERC20).deposit{ value: _message.amountLD() }();
 
         /// @dev Since lzCompose is public, the msg.value called to pay the tx Fee is automatically forwarded
@@ -103,8 +104,8 @@ contract VaultComposerSyncNative is VaultComposerSync, IVaultComposerSyncNative
 
         /// @dev Safe because this is the only function in VaultComposerSync that calls oft.send()
         if (_oft == ASSET_OFT) {
-            /// @dev In deposit's lzReceive() we converted ETH to WETH.
-            /// @dev Incase of redemption the vault outputs WETH.
+            /// @dev In deposit's lzCompose() we converted ETH to WETH.
+            /// @dev In a redemption, the vault outputs WETH.
             /// @dev So we always have WETH at this point which we unwrap to ETH for the Stargate Pool
             IWETH(ASSET_ERC20).withdraw(_sendParam.amountLD);
             /// @dev MsgValue passed to Stargate Pool is nativeFee + amountLD
@@ -132,6 +133,6 @@ contract VaultComposerSyncNative is VaultComposerSync, IVaultComposerSyncNative
 
     receive() external payable virtual {
         /// @dev From ASSET_OFT for NativeOFT::lzReceive and from ASSET_ERC20 for WETH::withdraw
-        if (msg.sender != ASSET_OFT && msg.sender != ASSET_ERC20) revert ETHTransferOnlyFromAssetOFT();
+        if (msg.sender != ASSET_OFT && msg.sender != ASSET_ERC20) revert ETHTransferNotFromAsset();
     }
 }

packages/ovault-evm/contracts/interfaces/IVaultComposerSyncNative.sol

@@ -6,7 +6,7 @@ import { SendParam } from "@layerzerolabs/oft-evm/contracts/interfaces/IOFT.sol"
 interface IVaultComposerSyncNative {
     error AssetOFTTokenNotNative(); // 0xd61c4b4a
     error AmountExceedsMsgValue(); // 0x0f971d59
-    error ETHTransferOnlyFromAssetOFT(); // 0x61c07af9
+    error ETHTransferNotFromAsset(); // 0x02cadbeb
 
     /**
      * @notice Deposits Native token (ETH) from the caller into the vault and sends them to the recipient

packages/ovault-evm/test/vault-sync-stargate-pools/VaultComposerSyncSTG_Native.t.sol

@@ -135,9 +135,9 @@ contract VaultComposerSyncSTG_NativeForkTest is VaultComposerSyncSTG_ERC20ForkTe
         assertFalse(success, "ETH transfer from non-pool address should fail");
 
         // Check that the failure is due to the expected error
-        bytes4 expectedErrorSignature = bytes4(keccak256("ETHTransferOnlyFromAssetOFT()"));
+        bytes4 expectedErrorSignature = bytes4(keccak256("ETHTransferNotFromAsset()"));
         bytes4 actualErrorSignature = bytes4(returnData);
-        assertEq(actualErrorSignature, expectedErrorSignature, "Should fail with ETHTransferOnlyFromAssetOFT error");
+        assertEq(actualErrorSignature, expectedErrorSignature, "Should fail with ETHTransferNotFromAsset error");
 
         assertEq(wethBalanceBefore, weth.balanceOf(address(ethComposer)), "WETH should not be wrapped");
         assertEq(address(ethComposer).balance, ethBalanceBefore, "ETH balance should remain unchanged");

packages/ovault-evm/test/vault-sync/VaultComposerSync_ProxySend.t.sol

@@ -14,7 +14,7 @@ contract VaultComposerSyncProxySendTest is VaultComposerSyncBaseTest {
         super.setUp();
     }
 
-    function test_target_is_hub_reverts_when_msg_value_provided() public {
+    function test_target_is_hub_does_not_revert_when_msg_value_provided() public {
         SendParam memory sendParam = SendParam(ARB_EID, addressToBytes32(userA), TOKENS_TO_SEND, 0, "", "", "");
         assetToken_arb.mint(address(userA), TOKENS_TO_SEND);
         vault_arb.mint(address(userA), TOKENS_TO_SEND);