@oydual31/more-vaults-sdk 0.4.2 → 0.6.0

package/src/react/useERC7540RequestStatus.ts

@@ -0,0 +1,43 @@
+import { useQuery } from '@tanstack/react-query'
+import { usePublicClient } from 'wagmi'
+import { asSdkClient, getERC7540RequestStatus } from '../viem/index.js'
+import type { ERC7540RequestStatus } from '../viem/index.js'
+
+export type { ERC7540RequestStatus }
+
+interface UseERC7540RequestStatusOptions {
+  /** Refetch interval in ms. Default: 15_000 (15s) — shorter since pending→claimable transitions matter */
+  refetchInterval?: number
+}
+
+/**
+ * Read ERC7540 async request status for a specific sub-vault.
+ *
+ * Queries pending and claimable deposit/redeem amounts for the vault
+ * acting as controller in the given ERC7540 sub-vault (requestId = 0).
+ *
+ * @example
+ * const { data: status } = useERC7540RequestStatus(
+ *   '0xVAULT',
+ *   8453,
+ *   '0xSUB_VAULT'
+ * )
+ * if (status?.canFinalizeDeposit) {
+ *   // curator can call erc7540Deposit to claim shares
+ * }
+ */
+export function useERC7540RequestStatus(
+  vault: `0x${string}` | undefined,
+  chainId: number,
+  subVault: `0x${string}` | undefined,
+  options?: UseERC7540RequestStatusOptions,
+) {
+  const publicClient = usePublicClient({ chainId })
+  return useQuery({
+    queryKey: ['erc7540RequestStatus', vault, chainId, subVault],
+    queryFn: () => getERC7540RequestStatus(asSdkClient(publicClient), vault!, subVault!),
+    enabled: !!vault && !!publicClient && !!subVault,
+    refetchInterval: options?.refetchInterval ?? 15_000,
+    staleTime: 10_000,
+  })
+}

package/src/react/useExecuteBridge.ts

@@ -0,0 +1,50 @@
+import { useMutation } from '@tanstack/react-query'
+import { usePublicClient, useWalletClient } from 'wagmi'
+import { asSdkClient, executeCuratorBridge } from '../viem/index.js'
+import type { CuratorBridgeParams } from '../viem/index.js'
+import type { Address } from 'viem'
+
+export type { CuratorBridgeParams }
+
+/**
+ * Execute a curator bridge operation via BridgeFacet.executeBridging.
+ *
+ * This is a direct curator call (NOT via multicall). The vault pauses during
+ * bridging for security. Automatically quotes and includes the required
+ * LayerZero fee as msg.value.
+ *
+ * @param vault    Hub vault address (diamond proxy)
+ * @param token    Underlying ERC-20 token address to bridge (NOT the OFT address)
+ * @param chainId  Chain ID of the hub vault
+ *
+ * @example
+ * ```tsx
+ * const { mutateAsync, isPending } = useExecuteBridge('0xVAULT', USDC_ADDRESS, 8453)
+ *
+ * await mutateAsync({
+ *   oftToken: '0x27a16dc786820B16E5c9028b75B99F6f604b5d26',
+ *   dstEid: 30101,
+ *   amount: 1_000_000n,
+ *   dstVault: '0xSpokeVault...',
+ *   refundAddress: curatorAddress,
+ * })
+ * ```
+ */
+export function useExecuteBridge(
+  vault: `0x${string}`,
+  token: Address,
+  chainId: number,
+) {
+  const publicClient = usePublicClient({ chainId })
+  const { data: walletClient } = useWalletClient({ chainId })
+
+  return useMutation({
+    mutationFn: async (params: CuratorBridgeParams) => {
+      if (!walletClient || !publicClient) {
+        throw new Error('Wallet or public client not available')
+      }
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return executeCuratorBridge(walletClient as any, asSdkClient(publicClient), vault, token, params)
+    },
+  })
+}

package/src/react/useSubVaultPositions.ts

@@ -0,0 +1,35 @@
+import { useQuery } from '@tanstack/react-query'
+import { usePublicClient } from 'wagmi'
+import { asSdkClient, getSubVaultPositions } from '../viem/index.js'
+import type { SubVaultPosition } from '../viem/index.js'
+
+export type { SubVaultPosition }
+
+interface UseSubVaultPositionsOptions {
+  /** Refetch interval in ms. Default: 30_000 (30s) */
+  refetchInterval?: number
+}
+
+/**
+ * Read active sub-vault positions held by a curator vault.
+ *
+ * Returns ERC4626 and ERC7540 positions with share balances and underlying values.
+ * Positions with zero share balance are excluded.
+ *
+ * @example
+ * const { data: positions, isLoading } = useSubVaultPositions('0xVAULT', 8453)
+ */
+export function useSubVaultPositions(
+  vault: `0x${string}` | undefined,
+  chainId: number,
+  options?: UseSubVaultPositionsOptions,
+) {
+  const publicClient = usePublicClient({ chainId })
+  return useQuery({
+    queryKey: ['subVaultPositions', vault, chainId],
+    queryFn: () => getSubVaultPositions(asSdkClient(publicClient), vault!),
+    enabled: !!vault && !!publicClient,
+    refetchInterval: options?.refetchInterval ?? 30_000,
+    staleTime: 15_000,
+  })
+}

package/src/react/useVaultPortfolio.ts

@@ -0,0 +1,35 @@
+import { useQuery } from '@tanstack/react-query'
+import { usePublicClient } from 'wagmi'
+import { asSdkClient, getVaultPortfolio } from '../viem/index.js'
+import type { VaultPortfolio } from '../viem/index.js'
+
+export type { VaultPortfolio }
+
+interface UseVaultPortfolioOptions {
+  /** Refetch interval in ms. Default: 30_000 (30s) */
+  refetchInterval?: number
+}
+
+/**
+ * Read the full portfolio view for a curator vault.
+ *
+ * Combines liquid asset balances with ERC4626/ERC7540 sub-vault positions
+ * and locked ERC7540 pending assets into a single portfolio snapshot.
+ *
+ * @example
+ * const { data: portfolio, isLoading } = useVaultPortfolio('0xVAULT', 8453)
+ */
+export function useVaultPortfolio(
+  vault: `0x${string}` | undefined,
+  chainId: number,
+  options?: UseVaultPortfolioOptions,
+) {
+  const publicClient = usePublicClient({ chainId })
+  return useQuery({
+    queryKey: ['vaultPortfolio', vault, chainId],
+    queryFn: () => getVaultPortfolio(asSdkClient(publicClient), vault!),
+    enabled: !!vault && !!publicClient,
+    refetchInterval: options?.refetchInterval ?? 30_000,
+    staleTime: 15_000,
+  })
+}

package/src/viem/abis.ts

@@ -780,6 +780,30 @@ export const REGISTRY_ABI = [
   { type: 'function', name: 'getAllowedFacets', inputs: [], outputs: [{ type: 'address[]' }], stateMutability: 'view' },
 ] as const
 
+/**
+ * Sub-vault ABI — reads for ERC4626/ERC7540 sub-vaults and ConfigurationFacet extensions.
+ * Used by curator sub-vault portfolio helpers (Phase 5).
+ */
+export const SUB_VAULT_ABI = [
+  // ConfigurationFacet reads — called on the MoreVaults diamond proxy
+  { type: 'function', name: 'tokensHeld', inputs: [{ name: 'id', type: 'bytes32' }], outputs: [{ name: '', type: 'address[]' }], stateMutability: 'view' },
+  { type: 'function', name: 'lockedTokensAmountOfAsset', inputs: [{ name: 'asset', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+
+  // ERC4626 standard reads — called on the sub-vault contract
+  { type: 'function', name: 'convertToAssets', inputs: [{ name: 'shares', type: 'uint256' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'convertToShares', inputs: [{ name: 'assets', type: 'uint256' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'previewDeposit', inputs: [{ name: 'assets', type: 'uint256' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'previewRedeem', inputs: [{ name: 'shares', type: 'uint256' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'maxDeposit', inputs: [{ name: 'receiver', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'maxRedeem', inputs: [{ name: 'owner', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+
+  // ERC7540 async reads — called on the sub-vault contract
+  { type: 'function', name: 'pendingDepositRequest', inputs: [{ name: 'requestId', type: 'uint256' }, { name: 'controller', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'claimableDepositRequest', inputs: [{ name: 'requestId', type: 'uint256' }, { name: 'controller', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'pendingRedeemRequest', inputs: [{ name: 'requestId', type: 'uint256' }, { name: 'controller', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+  { type: 'function', name: 'claimableRedeemRequest', inputs: [{ name: 'requestId', type: 'uint256' }, { name: 'controller', type: 'address' }], outputs: [{ name: '', type: 'uint256' }], stateMutability: 'view' },
+] as const
+
 /**
  * Minimal LZ Endpoint V2 ABI for compose queue management.
  * Used by the Stargate 2-TX flow to check compose status and execute pending composes.

package/src/viem/curatorBridge.ts

@@ -0,0 +1,288 @@
+/**
+ * Curator BridgeFacet helpers for the MoreVaults SDK.
+ *
+ * Provides typed helpers to quote and execute cross-chain asset bridging
+ * via BridgeFacet.executeBridging on any MoreVaults diamond.
+ *
+ * Key flows:
+ *   1. `quoteCuratorBridgeFee`  — read-only fee estimation via LzAdapter
+ *   2. `executeCuratorBridge`   — send bridging transaction (curator only)
+ *   3. `encodeBridgeParams`     — encode the 5-field bridgeSpecificParams bytes
+ *   4. `findBridgeRoute`        — resolve OFT route for a token on given chains
+ *
+ * Bridge call flow:
+ *   curator → vault.executeBridging(adapter, token, amount, bridgeSpecificParams)
+ *   bridgeSpecificParams = abi.encode(oftToken, dstEid, amount, dstVault, refundAddress)
+ *
+ * Quote call flow:
+ *   publicClient → lzAdapter.quoteBridgeFee(encode(oftToken, dstEid, amount, dstVault))
+ *
+ * @module curatorBridge
+ */
+
+import {
+  type Address,
+  type PublicClient,
+  type WalletClient,
+  type Hash,
+  encodeAbiParameters,
+  getAddress,
+} from 'viem'
+import { BRIDGE_FACET_ABI, LZ_ADAPTER_ABI } from './abis.js'
+import { OFT_ROUTES } from './chains.js'
+import { getCuratorVaultStatus } from './curatorStatus.js'
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Types
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Parameters for a curator bridge operation.
+ * Used in both quoting (4-field) and execution (5-field with refundAddress).
+ */
+export interface CuratorBridgeParams {
+  /** OFT contract address on the source chain (from OFT_ROUTES[symbol][chainId].oft) */
+  oftToken: Address
+  /** LayerZero endpoint ID of the destination chain */
+  dstEid: number
+  /** Amount to bridge (in token's native units) */
+  amount: bigint
+  /** Vault address on the destination chain (hub or spoke) */
+  dstVault: Address
+  /** Address where excess LayerZero gas refunds are sent (usually the curator wallet) */
+  refundAddress: Address
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Encoding helpers
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Encode the 5-field bridgeSpecificParams for use in `executeBridging`.
+ *
+ * Encodes: (oftToken, dstEid, amount, dstVault, refundAddress)
+ * Types:   (address,  uint32, uint256, address,  address)
+ *
+ * @param params  Full bridge parameters including refundAddress
+ * @returns       ABI-encoded bytes (`0x`-prefixed hex string)
+ */
+export function encodeBridgeParams(params: CuratorBridgeParams): `0x${string}` {
+  return encodeAbiParameters(
+    [
+      { type: 'address' },
+      { type: 'uint32' },
+      { type: 'uint256' },
+      { type: 'address' },
+      { type: 'address' },
+    ],
+    [
+      getAddress(params.oftToken),
+      params.dstEid,
+      params.amount,
+      getAddress(params.dstVault),
+      getAddress(params.refundAddress),
+    ],
+  )
+}
+
+/**
+ * Encode the 4-field bridgeSpecificParams for `quoteBridgeFee`.
+ * Does NOT include refundAddress — quoting only needs the routing parameters.
+ *
+ * Encodes: (oftToken, dstEid, amount, dstVault)
+ * Types:   (address,  uint32, uint256, address)
+ *
+ * @internal
+ */
+function encodeBridgeParamsForQuote(params: Omit<CuratorBridgeParams, 'refundAddress'>): `0x${string}` {
+  return encodeAbiParameters(
+    [
+      { type: 'address' },
+      { type: 'uint32' },
+      { type: 'uint256' },
+      { type: 'address' },
+    ],
+    [
+      getAddress(params.oftToken),
+      params.dstEid,
+      params.amount,
+      getAddress(params.dstVault),
+    ],
+  )
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Route resolver
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Find the OFT bridge route for a given token address on the source chain.
+ *
+ * Searches OFT_ROUTES for an asset whose `token` or `oft` field matches
+ * the provided address on the given source chainId.
+ *
+ * @param srcChainId    EVM chain ID of the source chain (where the vault holds the token)
+ * @param dstChainId    EVM chain ID of the destination chain
+ * @param tokenAddress  ERC-20 token address on the source chain
+ * @returns             Route info or null if no matching route exists
+ *
+ * @example
+ * ```typescript
+ * const route = findBridgeRoute(8453, 1, '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913')
+ * // → { symbol: 'stgUSDC', oftHub: '0x27a1...', oftSpoke: '0xc026...' }
+ * ```
+ */
+export function findBridgeRoute(
+  srcChainId: number,
+  dstChainId: number,
+  tokenAddress: Address,
+): { oftSrc: Address; oftDst: Address; symbol: string } | null {
+  const normalizedToken = getAddress(tokenAddress)
+
+  for (const [symbol, chains] of Object.entries(OFT_ROUTES)) {
+    const srcEntry = (chains as Record<number, { oft: `0x${string}`; token: `0x${string}` }>)[srcChainId]
+    const dstEntry = (chains as Record<number, { oft: `0x${string}`; token: `0x${string}` }>)[dstChainId]
+
+    if (!srcEntry || !dstEntry) continue
+
+    // Match if the provided address is either the token OR the OFT on the source chain
+    const srcToken = getAddress(srcEntry.token)
+    const srcOft = getAddress(srcEntry.oft)
+
+    if (srcToken === normalizedToken || srcOft === normalizedToken) {
+      return {
+        oftSrc: srcOft,
+        oftDst: getAddress(dstEntry.oft),
+        symbol,
+      }
+    }
+  }
+
+  return null
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Read operations
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Quote the native fee required to bridge assets via the vault's LzAdapter.
+ *
+ * Calls `lzAdapter.quoteBridgeFee(bridgeSpecificParams)` using a 4-field
+ * encoding (no refundAddress). The returned fee must be sent as `msg.value`
+ * when calling `executeBridging`.
+ *
+ * @param publicClient  Viem public client (must be on the vault's chain)
+ * @param vault         Hub vault address (diamond proxy)
+ * @param params        Bridge parameters (refundAddress is optional here)
+ * @returns             Native fee in wei
+ *
+ * @example
+ * ```typescript
+ * const fee = await quoteCuratorBridgeFee(publicClient, VAULT, {
+ *   oftToken: '0x27a16dc786820B16E5c9028b75B99F6f604b5d26', // stgUSDC on Base
+ *   dstEid: 30101,   // Ethereum EID
+ *   amount: 1_000_000n, // 1 USDC
+ *   dstVault: '0xSpokeVault...',
+ *   refundAddress: '0xCurator...',
+ * })
+ * console.log('Fee:', formatEther(fee), 'ETH')
+ * ```
+ */
+export async function quoteCuratorBridgeFee(
+  publicClient: PublicClient,
+  vault: Address,
+  params: CuratorBridgeParams,
+): Promise<bigint> {
+  // Get lzAdapter from vault status
+  const status = await getCuratorVaultStatus(publicClient, vault)
+  const lzAdapter = status.lzAdapter
+
+  // Encode 4-field params (no refundAddress) for quoting
+  const bridgeSpecificParams = encodeBridgeParamsForQuote(params)
+
+  // Call quoteBridgeFee on the LzAdapter (not the vault)
+  const nativeFee = await publicClient.readContract({
+    address: lzAdapter,
+    abi: LZ_ADAPTER_ABI,
+    functionName: 'quoteBridgeFee',
+    args: [bridgeSpecificParams],
+  })
+
+  return nativeFee as bigint
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Write operations
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Execute a curator bridge operation via `BridgeFacet.executeBridging`.
+ *
+ * This is a direct curator call (NOT via multicall). The vault pauses during
+ * bridging for security. The `token` passed to executeBridging is the underlying
+ * ERC-20, NOT the OFT address.
+ *
+ * Steps:
+ *   1. Get lzAdapter from `getCuratorVaultStatus`
+ *   2. Quote the native bridge fee
+ *   3. Encode 5-field bridgeSpecificParams
+ *   4. Call `vault.executeBridging(adapter, token, amount, bridgeSpecificParams)` with fee as value
+ *
+ * @param walletClient   Wallet client with curator account attached
+ * @param publicClient   Public client for reads and fee quoting
+ * @param vault          Hub vault address (diamond proxy)
+ * @param token          Underlying ERC-20 token address (NOT the OFT address)
+ * @param params         Full bridge parameters including refundAddress
+ * @returns              Transaction hash
+ * @throws               If caller is not curator, vault is paused, or bridge fails
+ *
+ * @example
+ * ```typescript
+ * const txHash = await executeCuratorBridge(walletClient, publicClient, VAULT, USDC_ADDRESS, {
+ *   oftToken: '0x27a16dc786820B16E5c9028b75B99F6f604b5d26',
+ *   dstEid: 30101,
+ *   amount: 1_000_000n,
+ *   dstVault: '0xSpokeVault...',
+ *   refundAddress: curatorAddress,
+ * })
+ * ```
+ */
+export async function executeCuratorBridge(
+  walletClient: WalletClient,
+  publicClient: PublicClient,
+  vault: Address,
+  token: Address,
+  params: CuratorBridgeParams,
+): Promise<Hash> {
+  const account = walletClient.account!
+  const v = getAddress(vault)
+
+  // Step 1: Get lzAdapter address from vault status
+  const status = await getCuratorVaultStatus(publicClient, vault)
+  const lzAdapter = status.lzAdapter
+
+  // Step 2: Quote the bridge fee
+  const fee = await quoteCuratorBridgeFee(publicClient, vault, params)
+
+  // Step 3: Encode full 5-field bridgeSpecificParams
+  const bridgeSpecificParams = encodeBridgeParams(params)
+
+  // Step 4: Execute bridging with fee as msg.value
+  const txHash = await walletClient.writeContract({
+    address: v,
+    abi: BRIDGE_FACET_ABI,
+    functionName: 'executeBridging',
+    args: [
+      lzAdapter,
+      getAddress(token),
+      params.amount,
+      bridgeSpecificParams,
+    ],
+    value: fee,
+    account,
+    chain: walletClient.chain,
+  })
+
+  return txHash
+}