@oydual31/more-vaults-sdk 0.1.2 → 0.1.3

package/dist/react/index.d.cts

@@ -0,0 +1,382 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { e as VaultStatus, V as VaultMetadata, c as UserPosition, a as AsyncRequestStatusInfo } from '../userHelpers-CZLB9oQ4.cjs';
+import * as _tanstack_query_core from '@tanstack/query-core';
+import 'viem';
+
+interface UseVaultStatusOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read the full vault status snapshot.
+ * Automatically refetches on a configurable interval.
+ *
+ * @example
+ * const { data: status, isLoading } = useVaultStatus('0xVAULT', 747)
+ * if (status?.mode === 'cross-chain-async') { ... }
+ */
+declare function useVaultStatus(vault: `0x${string}` | undefined, chainId: number, options?: UseVaultStatusOptions): _tanstack_react_query.UseQueryResult<VaultStatus, Error>;
+
+/**
+ * Read display metadata for a vault and its underlying token.
+ * Uses a long stale time (5 min) because metadata rarely changes.
+ *
+ * @example
+ * const { data: meta } = useVaultMetadata('0xVAULT', 747)
+ * // meta.name, meta.symbol, meta.underlying, meta.underlyingSymbol
+ */
+declare function useVaultMetadata(vault: `0x${string}` | undefined, chainId: number): _tanstack_react_query.UseQueryResult<VaultMetadata, Error>;
+
+/**
+ * Read the user's current position in a vault.
+ * Refetches every 15s to keep the balance display current.
+ *
+ * @example
+ * const { data: position } = useUserPosition('0xVAULT', '0xUSER', 747)
+ * // position.shares, position.estimatedAssets, position.pendingWithdrawal
+ */
+declare function useUserPosition(vault: `0x${string}` | undefined, user: `0x${string}` | undefined, chainId: number): _tanstack_react_query.UseQueryResult<UserPosition, Error>;
+
+/**
+ * Quote the LayerZero fee required for async operations (D4, D5, R5).
+ * Refreshes every 60s — fees change with network congestion.
+ *
+ * @example
+ * const { fee, feeWithBuffer } = useLzFee('0xVAULT', 747)
+ * // feeWithBuffer adds 1% buffer automatically (fee * 101 / 100)
+ */
+declare function useLzFee(vault: `0x${string}` | undefined, chainId: number): {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: bigint;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+} | {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: bigint;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+} | {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+} | {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+} | {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+} | {
+    fee: bigint | undefined;
+    feeWithBuffer: bigint | undefined;
+    data: bigint;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<bigint>;
+};
+
+/**
+ * Poll the status of an async cross-chain request (D4/D5/R5) by GUID.
+ *
+ * Automatically stops polling when status reaches 'completed' or 'refunded'.
+ * Polls every 10s while the request is still pending or ready-to-execute.
+ *
+ * @example
+ * const { data } = useAsyncRequestStatus('0xVAULT', guid, 747)
+ * // data.status: 'pending' | 'ready-to-execute' | 'completed' | 'refunded'
+ * // data.label: human-readable description
+ * // data.result: shares minted or assets returned (0n while pending)
+ */
+declare function useAsyncRequestStatus(vault: `0x${string}` | undefined, guid: `0x${string}` | undefined, chainId: number): _tanstack_react_query.UseQueryResult<AsyncRequestStatusInfo, Error>;
+
+interface UseOmniDepositReturn {
+    /** Execute approve + depositAsync. Handles everything internally. */
+    deposit: (amountInWei: bigint, receiver: `0x${string}`) => Promise<void>;
+    isLoading: boolean;
+    txHash: `0x${string}` | undefined;
+    /** GUID for cross-chain tracking. Available after tx confirmation. */
+    guid: `0x${string}` | undefined;
+    /** Cross-chain request status. undefined until a guid is available. */
+    requestStatus: AsyncRequestStatusInfo | undefined;
+    /** true when the wallet is connected to the wrong chain */
+    wrongChain: boolean;
+    error: Error | undefined;
+    reset: () => void;
+}
+/**
+ * Complete hook for async deposits on hub vaults (D4 flow).
+ *
+ * Handles: fee quote, chain validation, approve, depositAsync, and GUID polling.
+ * The deposit function wraps the entire flow — callers only pass amount + receiver.
+ *
+ * @example
+ * const { deposit, isLoading, guid, requestStatus, wrongChain } = useOmniDeposit('0xVAULT', 747)
+ *
+ * if (wrongChain) return <SwitchNetworkButton chainId={747} />
+ *
+ * await deposit(parseUnits('100', 6), userAddress)
+ * // requestStatus.status goes: 'pending' → 'completed' | 'refunded'
+ */
+declare function useOmniDeposit(vault: `0x${string}` | undefined, hubChainId: number): UseOmniDepositReturn;
+
+interface UseOmniRedeemReturn {
+    /** Execute approve + redeemAsync. Handles everything internally. */
+    redeem: (sharesInWei: bigint, receiver: `0x${string}`, owner: `0x${string}`) => Promise<void>;
+    isLoading: boolean;
+    txHash: `0x${string}` | undefined;
+    /** GUID for cross-chain tracking. Available after tx confirmation. */
+    guid: `0x${string}` | undefined;
+    /** Cross-chain request status. undefined until a guid is available. */
+    requestStatus: AsyncRequestStatusInfo | undefined;
+    /** true when the wallet is connected to the wrong chain */
+    wrongChain: boolean;
+    error: Error | undefined;
+    reset: () => void;
+}
+/**
+ * Complete hook for async redeems on hub vaults (R5 flow).
+ *
+ * Handles: fee quote, chain validation, share approve, redeemAsync, and GUID polling.
+ *
+ * @example
+ * const { redeem, isLoading, guid, requestStatus, wrongChain } = useOmniRedeem('0xVAULT', 747)
+ *
+ * if (wrongChain) return <SwitchNetworkButton chainId={747} />
+ *
+ * await redeem(sharesInWei, userAddress, userAddress)
+ * // requestStatus.status goes: 'pending' → 'completed' | 'refunded'
+ */
+declare function useOmniRedeem(vault: `0x${string}` | undefined, hubChainId: number): UseOmniRedeemReturn;
+
+interface UseDepositSimpleReturn {
+    /** Execute approve + depositSimple (D1/D3 flows). */
+    deposit: (amountInWei: bigint, receiver: `0x${string}`) => Promise<void>;
+    isLoading: boolean;
+    txHash: `0x${string}` | undefined;
+    /** Shares minted. Available after tx confirmation. */
+    shares: bigint | undefined;
+    error: Error | undefined;
+    reset: () => void;
+}
+/**
+ * Hook for local and oracle-on cross-chain vaults (D1/D3 flows).
+ *
+ * Simpler than useOmniDeposit — no LZ fee, no GUID, no polling.
+ * One approve + one deposit transaction.
+ *
+ * @example
+ * const { deposit, isLoading, txHash, shares } = useDepositSimple('0xVAULT', 747)
+ * await deposit(parseUnits('100', 6), userAddress)
+ */
+declare function useDepositSimple(vault: `0x${string}` | undefined, chainId: number): UseDepositSimpleReturn;
+
+interface UseRedeemSharesReturn {
+    /** Execute redeemShares (R1 flow). */
+    redeem: (sharesInWei: bigint, receiver: `0x${string}`, owner: `0x${string}`) => Promise<void>;
+    isLoading: boolean;
+    txHash: `0x${string}` | undefined;
+    /** Assets received. Available after tx confirmation. */
+    assets: bigint | undefined;
+    error: Error | undefined;
+    reset: () => void;
+}
+/**
+ * Hook for standard ERC-4626 share redemption (R1 flow).
+ *
+ * Used for local and oracle-on cross-chain vaults.
+ * No LZ fee required — single transaction.
+ *
+ * @example
+ * const { redeem, isLoading, txHash, assets } = useRedeemShares('0xVAULT', 747)
+ * await redeem(sharesInWei, userAddress, userAddress)
+ */
+declare function useRedeemShares(vault: `0x${string}` | undefined, chainId: number): UseRedeemSharesReturn;
+
+interface UseSmartDepositReturn {
+    /**
+     * Execute deposit using the correct flow for this vault's mode.
+     * For async vaults: wraps depositAsync (D4) — returns guid for tracking.
+     * For local/oracle vaults: wraps depositSimple (D1/D3) — returns shares.
+     */
+    deposit: (amountInWei: bigint, receiver: `0x${string}`) => Promise<void>;
+    isLoading: boolean;
+    txHash: `0x${string}` | undefined;
+    /** Shares minted (available for D1/D3 vaults after confirmation, undefined for D4). */
+    shares: bigint | undefined;
+    /** GUID for cross-chain tracking (D4 vaults only). */
+    guid: `0x${string}` | undefined;
+    /** Cross-chain request status (D4 vaults only). */
+    requestStatus: AsyncRequestStatusInfo | undefined;
+    /** true when the wallet is connected to the wrong chain (D4 vaults only). */
+    wrongChain: boolean;
+    /** Vault mode loaded from getVaultStatus. undefined while loading. */
+    vaultMode: 'local' | 'cross-chain-oracle' | 'cross-chain-async' | 'paused' | 'full' | undefined;
+    error: Error | undefined;
+    reset: () => void;
+}
+/**
+ * Auto-selects the correct deposit flow based on vault mode.
+ * Best for frontends that support multiple vault types.
+ *
+ * Internally uses useVaultStatus to detect the mode, then delegates to:
+ * - useOmniDeposit (D4) for 'cross-chain-async' vaults
+ * - useDepositSimple (D1/D3) for 'local' and 'cross-chain-oracle' vaults
+ *
+ * @example
+ * const { deposit, isLoading, guid, requestStatus, vaultMode } = useSmartDeposit('0xVAULT', 747)
+ *
+ * if (vaultMode === 'paused') return <PausedBadge />
+ *
+ * await deposit(parseUnits('100', 6), userAddress)
+ * // For async vaults: poll requestStatus until 'completed'
+ * // For sync vaults: txHash + shares are available immediately
+ */
+declare function useSmartDeposit(vault: `0x${string}` | undefined, hubChainId: number): UseSmartDepositReturn;
+
+export { AsyncRequestStatusInfo, UserPosition, VaultMetadata, VaultStatus, useAsyncRequestStatus, useDepositSimple, useLzFee, useOmniDeposit, useOmniRedeem, useRedeemShares, useSmartDeposit, useUserPosition, useVaultMetadata, useVaultStatus };