chore: introduce README fixes

Author: St0rmBr3w

examples/ovault-evm/README.md

@@ -82,6 +82,8 @@ MNEMONIC="your twelve word mnemonic here"
 
 Update `hardhat.config.ts` to include your desired networks with required `ovault` configuration. Each network needs an `ovault` config object specifying which contracts to deploy and token details.
 
+> **Note**: If your asset is already an OFT, you do not need to deploy a separate mesh. The only requirement is that the asset OFT supports the hub chain you are deploying to.
+
 ```typescript
 const config: HardhatUserConfig = {
   networks: {
@@ -148,6 +150,10 @@ Compile your contracts:
 pnpm compile
 ```
 
+> **Testing Note**: If you're deploying the asset OFT from scratch for testing purposes, you'll need to mint an initial supply. Uncomment the `_mint` line in the `MyAssetOFT` constructor to provide initial liquidity. This ensures you have tokens to test deposit and cross-chain transfer functionality.
+> 
+> **⚠️ Warning**: Do NOT mint share tokens directly in `MyShareOFT`. Share tokens must only be minted by the vault contract during deposits to maintain the correct share-to-asset ratio. Manually minting share tokens breaks the vault's accounting and can lead to incorrect redemption values. The mint line in `MyShareOFT` should only be uncommented for UI/integration testing, never in production.
+
 ## Deploy
 
 ### 1. Deploy Asset OFTs
@@ -353,27 +359,8 @@ export default async function () {
 
 - **Hub Chain**: In this example, Base is the hub (uses `MyShareOFTAdapter`)
 - **Contract Types**: Only the hub chain uses `MyShareOFTAdapter`; all other chains use `MyShareOFT`
-- **Auto-Detection**: The `lz:ovault:send` task automatically detects the hub by finding the contract with "Adapter" in the name
-
-### 3. Wire Asset OFT Network
-
-Configure and wire the Asset OFT connections:
-
-```bash
-# Wire Asset OFT network
-pnpm hardhat lz:oapp:wire --oapp-config layerzero.asset.config.ts
-```
 
-### 4. Wire Share OFT Network
-
-Configure and wire the Share OFT connections:
-
-```bash
-# Wire Share OFT network
-pnpm hardhat lz:oapp:wire --oapp-config layerzero.share.config.ts
-```
-
-### 5. Customizing for Your Networks
+### 3. Customizing for Your Networks
 
 To use different chains or network configurations:
 
@@ -393,6 +380,25 @@ To use different chains or network configurations:
 - Add pathway configurations between the new chain and existing chains
 - Deploy Asset OFTs and Share OFTs to the new chains
 
+
+### 4. Wire Asset OFT Network
+
+Configure and wire the Asset OFT connections:
+
+```bash
+# Wire Asset OFT network
+pnpm hardhat lz:oapp:wire --oapp-config layerzero.asset.config.ts
+```
+
+### 5. Wire Share OFT Network
+
+Configure and wire the Share OFT connections:
+
+```bash
+# Wire Share OFT network
+pnpm hardhat lz:oapp:wire --oapp-config layerzero.share.config.ts
+```
+
 ## Cross-Chain Operations
 
 The `lz:ovault:send` task handles four different operation types automatically based on source and destination chains. Here's how to use each:
@@ -628,19 +634,6 @@ After completing your deployment:
   - [ ] Set up vault access controls and admin functions
   - [ ] Test vault preview functions (`previewDeposit`/`previewRedeem`)
 
-- [ ] **Error Recovery**
-
-  - [ ] Document error recovery procedures for failed operations
-  - [ ] Set up monitoring for failed compose messages
-  - [ ] Test refund and retry mechanisms
-  - [ ] Configure alerts for stuck transactions
-
-- [ ] **Network Configuration**
-  - [ ] Verify all peer configurations are correct
-  - [ ] Test message delivery on all supported routes
-  - [ ] Confirm rate limiting settings are appropriate
-  - [ ] Validate pathway configurations
-
 ## Appendix
 
 ### Running Tests
@@ -706,4 +699,4 @@ pnpm hardhat lz:deploy             # Deploy contracts
 
 ---
 
-**Need help?** Reach out in the [LayerZero Discord](https://discord-layerzero.netlify.app/discord) or check the [Developer Docs](https://docs.layerzero.network/).
+**Need help?** Reach out in the [LayerZero Discord](https://discord-layerzero.netlify.app/discord) or check the [Developer Docs](https://docs.layerzero.network/).

examples/ovault-evm/contracts/MyAssetOFT.sol

@@ -4,11 +4,33 @@ pragma solidity ^0.8.20;
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { OFT } from "@layerzerolabs/oft-evm/contracts/OFT.sol";
 
+/**
+ * @title MyAssetOFT
+ * @notice ERC20 representation of the vault's asset token on a spoke chain for cross-chain functionality
+ * @dev This contract represents the vault's underlying asset on spoke chains. It inherits from
+ * LayerZero's OFT (Omnichain Fungible Token) to enable seamless cross-chain transfers of the
+ * vault's asset tokens between the hub chain and spoke chains.
+ *
+ * The asset OFT acts as a bridgeable ERC20 representation of the vault's collateral asset, allowing
+ * users to move their assets across supported chains while maintaining fungibility.
+ */
 contract MyAssetOFT is OFT {
+    /**
+     * @notice Constructs the Asset OFT contract
+     * @dev Initializes the OFT with LayerZero endpoint and sets up ownership
+     * @param _name The name of the asset token
+     * @param _symbol The symbol of the asset token
+     * @param _lzEndpoint The address of the LayerZero endpoint on this chain
+     * @param _delegate The address that will have owner privileges
+     */
     constructor(
         string memory _name,
         string memory _symbol,
         address _lzEndpoint,
         address _delegate
-    ) OFT(_name, _symbol, _lzEndpoint, _delegate) Ownable(_delegate) {}
-}
+    ) OFT(_name, _symbol, _lzEndpoint, _delegate) Ownable(_delegate) {
+        // NOTE: Uncomment the line below if you need to mint initial supply
+        // This can be useful for testing or if the asset needs initial liquidity
+        // _mint(msg.sender, 1 ether);
+    }
+}

examples/ovault-evm/contracts/MyShareOFT.sol

@@ -4,11 +4,36 @@ pragma solidity ^0.8.20;
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { OFT } from "@layerzerolabs/oft-evm/contracts/OFT.sol";
 
+/**
+ * @title MyShareOFT
+ * @notice ERC20 representation of the vault's share token on a spoke chain for cross-chain functionality
+ * @dev This contract represents the vault's share tokens on spoke chains. It inherits from
+ * LayerZero's OFT (Omnichain Fungible Token) to enable seamless cross-chain transfers of
+ * vault shares between the hub chain and spoke chains. This contract is designed to work
+ * with ERC4626-compliant vaults, enabling standardized cross-chain vault interactions.
+ *
+ * Share tokens represent ownership in the vault and can be redeemed for the underlying
+ * asset on the hub chain. The OFT mechanism ensures that shares maintain their value and can be freely
+ * moved across supported chains while preserving the vault's accounting integrity.
+ */
 contract MyShareOFT is OFT {
+    /**
+     * @notice Constructs the Share OFT contract
+     * @dev Initializes the OFT with LayerZero endpoint and sets up ownership
+     * @param _name The name of the share token
+     * @param _symbol The symbol of the share token
+     * @param _lzEndpoint The address of the LayerZero endpoint on this chain
+     * @param _delegate The address that will have owner privileges
+     */
     constructor(
         string memory _name,
         string memory _symbol,
         address _lzEndpoint,
         address _delegate
-    ) OFT(_name, _symbol, _lzEndpoint, _delegate) Ownable(_delegate) {}
-}
+    ) OFT(_name, _symbol, _lzEndpoint, _delegate) Ownable(_delegate) {
+        // WARNING: Do NOT mint share tokens directly as this breaks the vault's share-to-asset ratio
+        // Share tokens should only be minted by the vault contract during deposits to maintain
+        // the correct relationship between shares and underlying assets
+        // _mint(msg.sender, 1 ether); // ONLY uncomment for testing UI/integration, never in production
+    }
+}