ovault - example improvements and deploy (#1656)

Signed-off-by: shankar <shankar@layerzerolabs.org>
Co-authored-by: Blockchain Warlock <39101443+TRileySchwarz@users.noreply.github.com>
Co-authored-by: Krak <krak@layerzerolabs.org>

Author: 3 people

examples/ovault-evm/README.md

@@ -80,107 +80,137 @@ PRIVATE_KEY="YOUR_PRIVATE_KEY_HERE"
 
 ### 2. Network Configuration
 
-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.
+Update `hardhat.config.ts` to include your desired networks:
 
 ```typescript
 const config: HardhatUserConfig = {
   networks: {
     base: {
-      eid: EndpointId.BASE_V2_MAINNET,
-      url: process.env.RPC_URL_BASE || "https://base.gateway.tenderly.co",
+      eid: EndpointId.BASESEP_V2_TESTNET,
+      url:
+        process.env.RPC_URL_BASESEP_TESTNET ||
+        "https://base-sepolia.gateway.tenderly.co",
       accounts,
-      ovault: {
-        isHubChain: true,
-        assetToken: {
-          name: "MyAssetOFT",
-          symbol: "ASSET",
-        },
-        shareToken: {
-          name: "MyShareOFT",
-          symbol: "SHARE",
-        },
-      },
     },
     arbitrum: {
-      eid: EndpointId.ARBITRUM_V2_MAINNET,
-      url: process.env.RPC_URL_ARB || "https://arbitrum.gateway.tenderly.co",
+      eid: EndpointId.ARBSEP_V2_TESTNET,
+      url:
+        process.env.RPC_URL_ARBSEP_TESTNET ||
+        "https://arbitrum-sepolia.gateway.tenderly.co",
       accounts,
-      ovault: {
-        isHubChain: false,
-        assetToken: {
-          name: "MyAssetOFT",
-          symbol: "ASSET",
-        },
-        shareToken: {
-          name: "MyShareOFT",
-          symbol: "SHARE",
-        },
-      },
     },
     optimism: {
-      eid: EndpointId.OPTIMISM_V2_MAINNET,
+      eid: EndpointId.OPTSEP_V2_TESTNET,
       url:
-        process.env.RPC_URL_OPTIMISM || "https://optimism.gateway.tenderly.co",
+        process.env.RPC_URL_OPTSEP_TESTNET ||
+        "https://optimism-sepolia.gateway.tenderly.co",
       accounts,
-      ovault: {
-        assetToken: {
-          name: "MyAssetOFT",
-          symbol: "ASSET",
-        },
-      },
     },
   },
   // ... rest of config
 };
 ```
 
+### 3. Deployment Configuration
+
+Configure your vault deployment in `devtools/deployConfig.ts`. This file controls which chains get which contracts and their deployment settings:
+
+> **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.
+
 Asset and share token networks don't need to perfectly overlap. Configure based on your requirements:
 
-- `asset` tag requires `assetToken` config
-- `ovault` tag requires `isHubChain: true` and `shareToken` config
-- `share` tag requires `isHubChain: false` and `shareToken` config
+```typescript
+import { EndpointId } from "@layerzerolabs/lz-definitions";
 
-## Build
+export const DEPLOYMENT_CONFIG = {
+  // Vault chain configuration (where the ERC4626 vault lives)
+  vault: {
+    eid: EndpointId.ARBSEP_V2_TESTNET, // Your hub chain
+    contracts: {
+      vault: "MyERC4626",
+      shareAdapter: "MyShareOFTAdapter",
+      composer: "MyOVaultComposer",
+    },
+    // IF YOU HAVE A PRE-DEPLOYED ASSET, SET THE ADDRESS HERE
+    assetAddress: undefined, // Set to '0x...' to use existing asset
+  },
 
-Compile your contracts:
+  // Asset OFT configuration (deployed on all chains)
+  asset: {
+    contract: "MyAssetOFT",
+    metadata: {
+      name: "MyAssetOFT",
+      symbol: "ASSET",
+    },
+    chains: [
+      EndpointId.OPTSEP_V2_TESTNET,
+      EndpointId.BASESEP_V2_TESTNET,
+      EndpointId.ARBSEP_V2_TESTNET, // Include hub chain
+    ],
+  },
 
-```bash
-pnpm compile
+  // Share OFT configuration (only on spoke chains)
+  share: {
+    contract: "MyShareOFT",
+    metadata: {
+      name: "MyShareOFT",
+      symbol: "SHARE",
+    },
+    chains: [
+      EndpointId.OPTSEP_V2_TESTNET,
+      EndpointId.BASESEP_V2_TESTNET,
+      // Do NOT include hub chain (it uses ShareOFTAdapter)
+    ],
+  },
+};
 ```
 
-> **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.
+**Key Configuration Points:**
 
-## Deploy
+- **Hub Chain**: Set `vault.eid` to your chosen hub chain's endpoint ID
+- **Asset Chains**: Include all chains where you want asset OFTs (including the hub chain)
+- **Share Chains**: Include only spoke chains (exclude hub, which uses the ShareOFTAdapter)
+- **Pre-deployed Asset**: Set `vault.assetAddress` if using an existing asset token
+
+The deployment scripts automatically determine what to deploy based on:
+
+- Vault contracts (ERC4626, ShareOFTAdapter, Composer) deploy only on the hub chain
+- Asset OFTs deploy on chains listed in `asset.chains` (unless using pre-deployed asset)
+- Share OFTs deploy on chains listed in `share.chains`
 
-### 1. Deploy Asset OFTs
+## Build
 
-Deploy Asset OFTs to networks with `assetToken` configuration:
+Compile your contracts:
 
 ```bash
-pnpm hardhat lz:deploy --tags asset
+pnpm compile`
 ```
 
-### 2. Deploy ERC4626 Vault System (Hub Chain Only)
+> **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 the vault, composer, and ShareOFT adapter on networks with `isHubChain: true`:
+## Deploy
+
+Deploy all vault contracts across all configured chains:
 
 ```bash
-pnpm hardhat lz:deploy --networks base --tags ovault
+pnpm hardhat lz:deploy --tags ovault
 ```
 
-### 3. Deploy Share OFTs (Spoke Chains Only)
+This single command will:
 
-Deploy Share OFTs on networks with `isHubChain: false`:
+- Deploy `AssetOFTs` to all chains in `deployConfig.asset.chains`
+- Deploy the vault system (`ERC4626`, `ShareOFTAdapter`, `Composer`) on the hub chain
+- Deploy `ShareOFTs` to all spoke chains in `deployConfig.share.chains`
 
-```bash
-pnpm hardhat lz:deploy --tags share
-```
+The deployment scripts automatically skip existing deployments, so you can safely run this command when expanding to new chains. Simply add the new chain endpoints to your `deployConfig.ts` and run the deploy command again.
 
-The deploy scripts automatically validate your network configuration and will error if required config is missing or contracts are deployed on wrong chain types.
+> **Tip**: To deploy to specific networks only, use the `--networks` flag:
+>
+> ```bash
+> pnpm hardhat lz:deploy --tags ovault --networks arbitrum,optimism
+> ```
 
 ## Enable Messaging
 
@@ -198,17 +228,17 @@ import {
 import { OAppEnforcedOption } from "@layerzerolabs/toolbox-hardhat";
 
 const optimismContract: OmniPointHardhat = {
-  eid: EndpointId.OPTIMISM_V2_MAINNET.valueOf(),
+  eid: EndpointId.OPTSEP_V2_TESTNET.valueOf(),
   contractName: "MyAssetOFT",
 };
 
 const arbitrumContract: OmniPointHardhat = {
-  eid: EndpointId.ARBITRUM_V2_MAINNET.valueOf(),
+  eid: EndpointId.ARBSEP_V2_TESTNET.valueOf(),
   contractName: "MyAssetOFT",
 };
 
 const baseContract: OmniPointHardhat = {
-  eid: EndpointId.BASE_V2_MAINNET.valueOf(),
+  eid: EndpointId.BASESEP_V2_TESTNET.valueOf(),
   contractName: "MyAssetOFT",
 };
 
@@ -287,17 +317,17 @@ import {
 import { OAppEnforcedOption } from "@layerzerolabs/toolbox-hardhat";
 
 const optimismContract: OmniPointHardhat = {
-  eid: EndpointId.OPTIMISM_V2_MAINNET.valueOf(),
+  eid: EndpointId.OPTSEP_V2_TESTNET.valueOf(),
   contractName: "MyShareOFT", // Standard OFT (spoke)
 };
 
 const arbitrumContract: OmniPointHardhat = {
-  eid: EndpointId.BASE_V2_MAINNET.valueOf(), // Note: Base is the hub chain
+  eid: EndpointId.BASESEP_V2_TESTNET.valueOf(), // Note: Base is the hub chain
   contractName: "MyShareOFTAdapter", // Adapter (hub/lockbox)
 };
 
 const baseContract: OmniPointHardhat = {
-  eid: EndpointId.ARBITRUM_V2_MAINNET.valueOf(),
+  eid: EndpointId.ARBSEP_V2_TESTNET.valueOf(),
   contractName: "MyShareOFT", // Standard OFT (spoke)
 };
 
@@ -366,9 +396,9 @@ To use different chains or network configurations:
 
 **For Testnet Deployment:**
 
-- Replace `EndpointId.OPTIMISM_V2_MAINNET` with `EndpointId.OPTSEP_V2_TESTNET`
-- Replace `EndpointId.BASE_V2_MAINNET` with `EndpointId.BASESEP_V2_TESTNET`
-- Replace `EndpointId.ARBITRUM_V2_MAINNET` with `EndpointId.ARBSEP_V2_TESTNET`
+- Replace `EndpointId.OPTSEP_V2_TESTNET` with `EndpointId.OPTSEP_V2_TESTNET`
+- Replace `EndpointId.BASESEP_V2_TESTNET` with `EndpointId.BASESEP_V2_TESTNET`
+- Replace `EndpointId.ARBSEP_V2_TESTNET` with `EndpointId.ARBSEP_V2_TESTNET`
 
 **For Different Hub Chain:**
 
@@ -380,7 +410,6 @@ 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:
@@ -699,4 +728,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

@@ -33,4 +33,4 @@ contract MyAssetOFT is OFT {
         // This can be useful for testing or if the asset needs initial liquidity
         // _mint(msg.sender, 1 ether);
     }
-}
+}

examples/ovault-evm/contracts/MyShareOFT.sol

@@ -36,4 +36,4 @@ contract MyShareOFT is OFT {
         // the correct relationship between shares and underlying assets
         // _mint(msg.sender, 1 ether); // ONLY uncomment for testing UI/integration, never in production
     }
-}
+}