@augustdigital/sdk 8.3.1 → 8.5.0

package/lib/evm/methods/crossChainVault.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * Cross-Chain Vault Methods
+ *
+ * Implements LayerZero OVault cross-chain deposit and redemption operations.
+ * These functions are generic — callers provide their own ICrossChainVaultConfig
+ * rather than relying on hardcoded vault addresses.
+ *
+ * @module evm/methods/crossChainVault
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -52,16 +61,46 @@ exports.getLayerZeroScanUrl = getLayerZeroScanUrl;
 const core_1 = require("../../core");
 const crossChain_1 = require("../types/crossChain");
 const OFT_1 = require("../../abis/OFT");
+// ---------------------------------------------------------------------------
+// Constants
+// ---------------------------------------------------------------------------
+/**
+ * lzReceive option hex for 500,000 gas.
+ * The Agora OFT has no enforced options for SEND_AND_CALL, so we must provide
+ * lzReceive gas explicitly or the executor reverts with Executor_ZeroLzReceiveGasProvided.
+ */
 const LZ_RECEIVE_OPTION_HEX = '010011010000000000000000000000000007a120';
+/** Default fee buffer percentage applied to LayerZero native fees */
 const DEFAULT_FEE_BUFFER_PERCENT = 50;
+/** Default slippage in basis points (1%) */
 const DEFAULT_SLIPPAGE_BPS = 100;
+/** Default gas buffer for deposits (1.5x) */
 const DEFAULT_DEPOSIT_GAS_BUFFER_PERCENT = 150;
+/** Default gas buffer for redeems (2x) */
 const DEFAULT_REDEEM_GAS_BUFFER_PERCENT = 200;
+/** Default minimum gas limit for redeem operations */
 const DEFAULT_MIN_REDEEM_GAS = 5000000n;
+/** Default hub lzCompose gas limit */
 const DEFAULT_HUB_LZ_COMPOSE_GAS_LIMIT = 2000000n;
+// ---------------------------------------------------------------------------
+// Mutex for SDK monkey-patches
+//
+// Multi-asset and hub-redeem flows mutate the shared `OVaultSyncMessageBuilder`
+// — module-level bindings inside the SDK mean a shallow clone is unsafe, so we
+// serialize patched calls. The timeout THROWS rather than silently racing
+// concurrent callers' patches.
+// ---------------------------------------------------------------------------
 const PATCH_LOCK_TIMEOUT_MS = 30000;
 let patchLock = Promise.resolve();
+// ---------------------------------------------------------------------------
+// Internal helpers
+// ---------------------------------------------------------------------------
+/**
+ * Try available previewRedeem signatures, falling back to 1:1 if the vault
+ * does not expose a working preview function.
+ */
 async function redeemPreview(publicClient, vaultAddress, shares) {
+    // 1. previewRedemption(uint256, bool) — multi-asset vault
     try {
         const result = await publicClient.readContract({
             address: vaultAddress,
@@ -73,7 +112,9 @@ async function redeemPreview(publicClient, vaultAddress, shares) {
         return assetsAfterFee;
     }
     catch {
+        /* try next */
     }
+    // 2. Standard ERC4626: previewRedeem(uint256)
     try {
         return (await publicClient.readContract({
             address: vaultAddress,
@@ -83,18 +124,30 @@ async function redeemPreview(publicClient, vaultAddress, shares) {
         }));
     }
     catch {
+        /* try next */
     }
+    // 3. Fallback: 1:1 ratio. Slippage protects against discrepancy.
     return shares;
 }
+/**
+ * Wraps generateOVaultInputs with monkey-patches for:
+ * 1. REDEEM from hub — skip quoteOFT (reverts for same-chain)
+ * 2. Multi-asset DEPOSIT — previewDeposit(address, uint256)
+ * 3. Multi-asset REDEEM — try previewRedeem variants, fallback to 1:1
+ * 4. Multi-asset composed messages — add lzReceive gas to SEND_AND_CALL
+ */
 async function generateOVaultInputsWithOverride(input, config, hubPublicClient, ovaultSdk) {
     const OVaultSyncMessageBuilder = ovaultSdk.OVaultSyncMessageBuilder;
     const OVaultSyncOperations = ovaultSdk.OVaultSyncOperations;
     const isRedeemFromHub = input.operation === OVaultSyncOperations.REDEEM &&
         input.srcEid === input.hubEid;
     const isMultiAsset = !!config.multiAsset;
+    // Fast path — no patches needed
     if (!isMultiAsset && !isRedeemFromHub) {
         return OVaultSyncMessageBuilder.generateOVaultInputs(input);
     }
+    // Serialize: wait for the prior holder or REJECT on timeout (silent races
+    // produced wrong cross-chain quotes).
     const prev = patchLock;
     let unlock;
     patchLock = new Promise((r) => {
@@ -124,11 +177,15 @@ async function generateOVaultInputsWithOverride(input, config, hubPublicClient,
     const origBuildApproval = Builder.buildApproval;
     try {
         if (isRedeemFromHub) {
+            // Patch 1a: skip quoteOFT (reverts for same-chain calls).
             Builder.getOutputAmount = async () => input.amount;
+            // Patch 1b: skip SDK's allowance check — multi-asset vault contracts
+            // may not implement ERC20. Caller handles approval directly.
             Builder.buildApproval = async () => undefined;
         }
         if (isMultiAsset) {
             const { hubAssetAddress } = config.multiAsset;
+            // Patch 2/3: Multi-asset quoteOVaultOutput
             Builder.quoteOVaultOutput = async (quoteInput) => {
                 const getOutputAmount = Builder.getOutputAmount;
                 const sourceAmount = await getOutputAmount({
@@ -158,6 +215,7 @@ async function generateOVaultInputsWithOverride(input, config, hubPublicClient,
                     minDstAmount: outputAmount - slippageAmount,
                 };
             };
+            // Patch 4: Ensure lzReceive gas in extraOptions for composed messages
             Builder.buildSendParams = async (spInput) => {
                 const origFn = origBuildSendParams;
                 const result = await origFn.call(Builder, spInput);
@@ -184,9 +242,23 @@ async function generateOVaultInputsWithOverride(input, config, hubPublicClient,
         unlock();
     }
 }
+// ---------------------------------------------------------------------------
+// Public API: Build
+// ---------------------------------------------------------------------------
+/**
+ * Build LayerZero OVault transaction inputs for cross-chain deposits and
+ * redemptions. Does NOT execute the transaction.
+ *
+ * Overridable defaults on `props`: `slippageBps` = 100 (range 1–10000),
+ * `feeBufferPercent` = 50% (added to LZ `nativeFee`),
+ * `hubLzComposeGasLimit` = 2_000_000n (multi-asset composed messages).
+ *
+ * @returns Transaction inputs or `{ success: false, error }`.
+ */
 async function buildCrossChainVaultTx(props) {
     try {
         const { config } = props;
+        // Validate slippage at the public boundary (BPS, not decimal)
         const slippageBps = props.slippageBps ?? DEFAULT_SLIPPAGE_BPS;
         if (slippageBps < 1 || slippageBps > 10000) {
             return {
@@ -194,6 +266,7 @@ async function buildCrossChainVaultTx(props) {
                 error: `Slippage must be between 1 and 10000 basis points (got ${slippageBps})`,
             };
         }
+        // Validate chains
         const hubChain = props.hubChain;
         const sourceChain = props.sourceChain;
         if (!hubChain || !sourceChain) {
@@ -202,6 +275,8 @@ async function buildCrossChainVaultTx(props) {
                 error: 'Hub chain and source chain are required',
             };
         }
+        // Reject unknown chain IDs up front so a typo can't fall through to
+        // `|| hub` and route shares to a chain the user didn't pick.
         const supportedChains = [
             config.hubChainId,
             ...Object.keys(config.layerZeroEids.spokes).map((k) => Number(k)),
@@ -230,6 +305,7 @@ async function buildCrossChainVaultTx(props) {
                 return config.layerZeroEids.hub;
             return config.layerZeroEids.spokes[chainId];
         };
+        // Determine source and destination EIDs based on operation
         let srcEid;
         let dstEid;
         let tokenAddress;
@@ -266,7 +342,9 @@ async function buildCrossChainVaultTx(props) {
                     error: `Invalid operation: ${props.operation}`,
                 };
         }
+        // Normalize amount
         const normalizedAmount = (0, core_1.toNormalizedBn)(props.amount, props.decimals);
+        // Build LayerZero OVault inputs
         const input = {
             srcEid,
             hubEid: config.layerZeroEids.hub,
@@ -286,10 +364,12 @@ async function buildCrossChainVaultTx(props) {
             oftAddress,
             hubLzComposeGasLimit: props.hubLzComposeGasLimit ?? DEFAULT_HUB_LZ_COMPOSE_GAS_LIMIT,
         };
+        // Create a minimal public client for hub chain reads (multi-asset patches)
         const hubRpc = hubChain?.rpcUrls;
         const hubRpcUrl = hubRpc?.default?.http?.[0];
         let hubPublicClient;
         try {
+            // Dynamic import to keep viem optional at the module level
             const viem = await Promise.resolve().then(() => __importStar(require('viem')));
             hubPublicClient = viem.createPublicClient({
                 chain: hubChain,
@@ -297,19 +377,25 @@ async function buildCrossChainVaultTx(props) {
             });
         }
         catch {
+            // If viem is not available, provide a stub that will fail on multi-asset only
             hubPublicClient = {
                 readContract: async () => {
                     throw new Error('viem is required for multi-asset vault operations. Install viem as a peer dependency.');
                 },
             };
         }
+        // Generate OVault transaction inputs (with monkey-patches for multi-asset)
         const inputs = await generateOVaultInputsWithOverride(input, config, hubPublicClient, props.ovaultSdk);
+        // Apply fee buffer to LZ fees (post-hoc to avoid SDK double-compounding)
         const feeBufferPercent = props.feeBufferPercent ?? DEFAULT_FEE_BUFFER_PERCENT;
         const rawNativeFee = inputs.messageFee.nativeFee;
         const rawMessageValue = inputs.messageValue;
         const feeBuffer = (rawNativeFee * BigInt(feeBufferPercent)) / 100n;
         inputs.messageFee.nativeFee = rawNativeFee + feeBuffer;
         inputs.messageValue = rawMessageValue + feeBuffer;
+        // Patch fee into txArgs in place for OFT.send(); warn if the LayerZero
+        // SDK ever returns a different entry-point name (silent no-op would
+        // underpay the LZ fee).
         if (inputs.contractFunctionName === 'send') {
             const sendFee = inputs.txArgs[1];
             sendFee.nativeFee = inputs.messageFee.nativeFee;
@@ -348,6 +434,14 @@ async function buildCrossChainVaultTx(props) {
         };
     }
 }
+// ---------------------------------------------------------------------------
+// Public API: Quote
+// ---------------------------------------------------------------------------
+/**
+ * Estimate fees and expected shares for a cross-chain deposit. The returned
+ * quote carries `quotedAt`/`expiresAt`; re-quote via {@link isQuoteStale}
+ * before submitting.
+ */
 async function quoteCrossChainDeposit(props) {
     const result = await buildCrossChainVaultTx({
         ovaultSdk: props.ovaultSdk,
@@ -374,6 +468,11 @@ async function quoteCrossChainDeposit(props) {
         expiresAt: quotedAt + crossChain_1.CROSS_CHAIN_QUOTE_TTL_MS,
     };
 }
+/**
+ * Estimate fees and expected assets for a cross-chain redeem. The returned
+ * quote carries `quotedAt`/`expiresAt`; re-quote via {@link isQuoteStale}
+ * before submitting.
+ */
 async function quoteCrossChainRedeem(props) {
     const result = await buildCrossChainVaultTx({
         ovaultSdk: props.ovaultSdk,
@@ -400,6 +499,14 @@ async function quoteCrossChainRedeem(props) {
         expiresAt: quotedAt + crossChain_1.CROSS_CHAIN_QUOTE_TTL_MS,
     };
 }
+// ---------------------------------------------------------------------------
+// Public API: Approval
+// ---------------------------------------------------------------------------
+/**
+ * Returns `true` when the wallet's ERC-20 allowance is insufficient for the
+ * cross-chain operation. On RPC failure also returns `true` (defensive
+ * default — better a redundant approval than a downstream revert).
+ */
 async function needsCrossChainApproval(tokenAddress, spenderAddress, walletAddress, amount, publicClient) {
     try {
         const allowance = (await publicClient.readContract({
@@ -411,9 +518,15 @@ async function needsCrossChainApproval(tokenAddress, spenderAddress, walletAddre
         return allowance < amount;
     }
     catch {
+        // If we can't check allowance, assume approval is needed
         return true;
     }
 }
+/**
+ * Execute a token approval for a cross-chain operation.
+ *
+ * @returns Transaction hash of the approval
+ */
 async function approveCrossChain(tokenAddress, spenderAddress, amount, walletClient, publicClient) {
     if (!walletClient.account) {
         throw new Error('Wallet not ready — please reconnect your wallet');
@@ -433,6 +546,18 @@ async function approveCrossChain(tokenAddress, spenderAddress, amount, walletCli
     }
     return hash;
 }
+// ---------------------------------------------------------------------------
+// Public API: Execute
+// ---------------------------------------------------------------------------
+/**
+ * Execute a cross-chain deposit via LayerZero OVault. Validates the source
+ * chain, ensures approval, estimates gas with a buffer, and waits for the
+ * on-chain receipt. Defaults: `slippageBps` 100, `feeBufferPercent` 50,
+ * `gasBufferPercent` 150 — all overridable on the request.
+ *
+ * @throws Error on unsupported chain, approval revert, gas-estimation
+ *   failure, or on-chain revert.
+ */
 async function crossChainVaultDeposit(props) {
     if (props.userChainId !== props.config.hubChainId &&
         !props.config.spokeChainIds.includes(props.userChainId)) {
@@ -440,6 +565,7 @@ async function crossChainVaultDeposit(props) {
     }
     const walletClient = props.walletClient;
     const publicClient = props.publicClient;
+    // 1. Build transaction inputs
     const result = await buildCrossChainVaultTx({
         ovaultSdk: props.ovaultSdk,
         config: props.config,
@@ -458,6 +584,7 @@ async function crossChainVaultDeposit(props) {
         throw new Error(result.error || 'Failed to build transaction');
     }
     const txInputs = result.data;
+    // 2. Check and execute approval if needed
     if (!props.skipApprovalCheck) {
         const tokenAddr = txInputs.approval?.tokenAddress ??
             props.config.contracts.assetToken[props.userChainId];
@@ -469,6 +596,7 @@ async function crossChainVaultDeposit(props) {
             await approveCrossChain(tokenAddr, spenderAddr, approvalAmount, walletClient, publicClient);
         }
     }
+    // 3. Estimate gas with buffer
     if (!walletClient.account) {
         throw new Error('Wallet not ready — please reconnect your wallet');
     }
@@ -488,6 +616,7 @@ async function crossChainVaultDeposit(props) {
     catch (estimateErr) {
         throw new Error(`Gas estimation failed for cross-chain deposit. Ensure you have sufficient native tokens for the LayerZero fee (${txInputs.messageFee.nativeFee.toString()} wei). Original error: ${estimateErr instanceof Error ? estimateErr.message : String(estimateErr)}`);
     }
+    // 4. Execute the transaction
     const hash = await walletClient.writeContract({
         account: walletClient.account,
         address: txInputs.contractAddress,
@@ -497,6 +626,7 @@ async function crossChainVaultDeposit(props) {
         value: txInputs.messageValue,
         gas: gasLimit,
     });
+    // 5. Wait for confirmation
     const receipt = await publicClient.waitForTransactionReceipt({
         hash: hash,
     });
@@ -508,13 +638,21 @@ async function crossChainVaultDeposit(props) {
         success: true,
     };
 }
+/**
+ * Execute a cross-chain redemption via LayerZero OVault. User must be on the
+ * hub chain. Defaults: `slippageBps` 100, `feeBufferPercent` 50,
+ * `gasBufferPercent` 200 (compose calls under-estimate on mainnet),
+ * `minGasLimit` 5_000_000n — all overridable on the request.
+ */
 async function crossChainVaultRedeem(props) {
+    // 1. Validate: redemptions must be from hub chain
     if (props.userChainId !== props.config.hubChainId) {
         throw new Error(`Redemptions must be executed from hub chain (${props.config.hubChainId}). ` +
             `Please switch to the hub chain first.`);
     }
     const walletClient = props.walletClient;
     const publicClient = props.publicClient;
+    // 2. Build transaction inputs
     const result = await buildCrossChainVaultTx({
         ovaultSdk: props.ovaultSdk,
         config: props.config,
@@ -533,12 +671,14 @@ async function crossChainVaultRedeem(props) {
         throw new Error(result.error || 'Failed to build transaction');
     }
     const txInputs = result.data;
+    // 3. Check and execute approval if needed
     if (!props.skipApprovalCheck && txInputs.approval) {
         const approvalNeeded = await needsCrossChainApproval(txInputs.approval.tokenAddress, txInputs.approval.spender, props.walletAddress, txInputs.approval.amount, publicClient);
         if (approvalNeeded) {
             await approveCrossChain(txInputs.approval.tokenAddress, txInputs.approval.spender, txInputs.approval.amount, walletClient, publicClient);
         }
     }
+    // 4. Estimate gas with buffer
     if (!walletClient.account) {
         throw new Error('Wallet account not available');
     }
@@ -560,6 +700,7 @@ async function crossChainVaultRedeem(props) {
     catch (estimateErr) {
         throw new Error(`Gas estimation failed for cross-chain redeem. Ensure you have sufficient native tokens for the LayerZero fee (${txInputs.messageFee.nativeFee.toString()} wei). Original error: ${estimateErr instanceof Error ? estimateErr.message : String(estimateErr)}`);
     }
+    // 5. Execute the transaction
     const hash = await walletClient.writeContract({
         account: walletClient.account,
         address: txInputs.contractAddress,
@@ -569,6 +710,7 @@ async function crossChainVaultRedeem(props) {
         value: txInputs.messageValue,
         gas: gasLimit,
     });
+    // 6. Wait for confirmation
     const receipt = await publicClient.waitForTransactionReceipt({
         hash: hash,
     });
@@ -580,9 +722,18 @@ async function crossChainVaultRedeem(props) {
         success: true,
     };
 }
+// ---------------------------------------------------------------------------
+// Public API: Error Classification
+// ---------------------------------------------------------------------------
+/**
+ * Check if an error indicates a missing LayerZero peer configuration.
+ */
 function isNoPeerError(errStr) {
     return errStr.includes('0xf6ff4fb7') || errStr.includes('NoPeer');
 }
+/**
+ * Classify a cross-chain contract error into a known error type.
+ */
 function classifyCrossChainError(error) {
     const err = error;
     const msg = err?.message ?? String(error);
@@ -609,13 +760,30 @@ function classifyCrossChainError(error) {
         return 'network';
     return 'unknown';
 }
+// ---------------------------------------------------------------------------
+// Public API: Utility helpers
+// ---------------------------------------------------------------------------
+/**
+ * Check if a user can deposit from their current chain.
+ */
 function canDepositFromChain(config, userChainId) {
     return (userChainId === config.hubChainId ||
         config.spokeChainIds.includes(userChainId));
 }
+/**
+ * Check if a user can redeem from their current chain (must be hub).
+ */
 function canRedeemFromChain(config, userChainId) {
     return userChainId === config.hubChainId;
 }
+/**
+ * Check if an operation is cross-chain (needs LayerZero).
+ *
+ * An operation is cross-chain when:
+ * - The user's chain differs from the hub chain, OR
+ * - The destination chain differs from the hub chain
+ *   (e.g. deposit from hub but receive shares on a spoke)
+ */
 function isCrossChainOperation(config, userChainId, destinationChainId) {
     if (userChainId !== config.hubChainId)
         return true;
@@ -624,10 +792,20 @@ function isCrossChainOperation(config, userChainId, destinationChainId) {
         return true;
     return false;
 }
+/**
+ * Get all chain IDs that a vault supports (hub + all spokes).
+ */
 function getAvailableChains(config) {
     return [config.hubChainId, ...config.spokeChainIds];
 }
+/**
+ * Format a cross-chain error into a user-friendly message.
+ *
+ * Mirrors the `classifyCrossChainDepositError` from upshift-app but is
+ * generic enough for any SDK consumer.
+ */
 function formatCrossChainError(errMsg) {
+    // If the error already contains specific gas fee info, show it directly
     if (errMsg.includes('Cross-chain fee is') ||
         errMsg.includes('Gas estimation failed'))
         return errMsg;
@@ -642,17 +820,24 @@ function formatCrossChainError(errMsg) {
     if (lower.includes('user rejected'))
         return 'Transaction cancelled by user.';
     if (lower.includes('hub chain'))
-        return errMsg;
+        return errMsg; // Already descriptive
     if (errMsg.includes('reverted'))
         return 'Transaction reverted on-chain. This may be due to insufficient gas or a contract error.';
     return 'Cross-chain transaction failed. Please try again.';
 }
+/**
+ * Get the LayerZero Scan URL for tracking a cross-chain message.
+ */
 function getLayerZeroScanUrl(txHash, testnet = false) {
     const baseUrl = testnet
         ? 'https://testnet.layerzeroscan.com'
         : 'https://layerzeroscan.com';
     return `${baseUrl}/tx/${txHash}`;
 }
+/**
+ * Well-known LayerZero Endpoint IDs for common chains.
+ * SDK consumers can use these when building their ICrossChainVaultConfig.
+ */
 exports.LAYERZERO_ENDPOINT_IDS = {
     ETHEREUM: 30101,
     ARBITRUM: 30110,

package/lib/evm/methods/crossChainVaultRegistry.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Cross-Chain Vault Registry
+ *
+ * Address-keyed registry of August's LayerZero OVault deployments plus the
+ * resolver helpers that turn a vault address into the
+ * {@link ICrossChainVaultConfig} consumed by `buildCrossChainVaultTx`,
+ * `crossChainVaultDeposit`, and `quoteCrossChainDeposit`.
+ *
+ * This is the cross-chain analogue of the SwapRouter registry
+ * (`VAULTS_USING_SWAP_ROUTER` / `getSwapRouterAddress`): consumers resolve a
+ * full config by vault address instead of hand-assembling the per-chain
+ * contract maps and LayerZero EIDs. Without it, every consuming app would
+ * re-encode the same address book.
+ *
+ * Addresses are ported verbatim from upshift-app `src/config/ovault.ts` and
+ * cross-checked against the read-side `LAYERZERO_VAULTS` registry in
+ * `services/layerzero/deposits.ts`. Verify against the deployed contracts
+ * before adding or editing an entry — a wrong address silently routes funds
+ * to the wrong chain.
+ *
+ * Return convention (deliberate, mirrors the SwapRouter helpers): lookups that
+ * resolve a single optional value (`getCrossChainVaultConfig`,
+ * `getOVaultChains`) return `undefined` for an unregistered vault, while
+ * list-returning helpers (`getWithdrawDestinationChains`) return `[]` so
+ * callers can iterate without a null-check.
+ *
+ * @module evm/methods/crossChainVaultRegistry
+ */
+import type { IAddress } from '../../types';
+import type { ICrossChainVaultConfig } from '../types/crossChain';
+/**
+ * August's LayerZero OVault deployments, keyed by lowercase hub-chain vault
+ * address. Resolve entries with {@link getCrossChainVaultConfig} rather than
+ * indexing directly — the helper handles address-casing for you.
+ *
+ * @see {@link getCrossChainVaultConfig} for the typed, case-insensitive lookup.
+ */
+export declare const CROSS_CHAIN_VAULT_CONFIGS: Readonly<Record<string, ICrossChainVaultConfig>>;
+/**
+ * Resolve the full cross-chain config for a vault. Address comparison is
+ * case-insensitive.
+ *
+ * @param vault - Hub-chain vault contract address.
+ * @returns The {@link ICrossChainVaultConfig} to pass to
+ *   `crossChainVaultDeposit` / `quoteCrossChainDeposit`, or `undefined` when
+ *   the vault is not a registered OVault deployment.
+ * @example
+ * ```ts
+ * const config = getCrossChainVaultConfig('0xE9B725010A9E419412ed67d0fA5f3A5f40159D32');
+ * if (config) await quoteCrossChainDeposit({ config, ...rest });
+ * ```
+ */
+export declare function getCrossChainVaultConfig(vault: IAddress): ICrossChainVaultConfig | undefined;
+/**
+ * Whether a vault is a registered LayerZero OVault and should route deposits
+ * through the cross-chain flow. Address comparison is case-insensitive.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` when the vault has an entry in
+ *   {@link CROSS_CHAIN_VAULT_CONFIGS}.
+ */
+export declare function isCrossChainVault(vault: IAddress): boolean;
+/**
+ * Get the hub and spoke chain IDs a vault is deployed across — the set of
+ * chains a user can deposit from.
+ *
+ * @param vault - Vault contract address.
+ * @returns `{ hub, spokes }` chain IDs, or `undefined` when the vault is not a
+ *   registered OVault deployment.
+ */
+export declare function getOVaultChains(vault: IAddress): {
+    hub: number;
+    spokes: number[];
+} | undefined;
+/**
+ * Whether a vault's receipt token is hub-only (no cross-chain withdraw).
+ * The deposit UI must not offer a spoke share destination for these vaults.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` for vaults whose shares cannot leave the hub chain
+ *   (AUGUST-6300).
+ */
+export declare function isHubOnlyReceipt(vault: IAddress): boolean;
+/**
+ * Chains a user can receive the underlying asset on when withdrawing.
+ * Hub-only-receipt vaults redeem to the hub chain only (AUGUST-6300); all
+ * other OVault vaults can redeem to the hub or any spoke.
+ *
+ * @param vault - Vault contract address.
+ * @returns Destination chain IDs, or an empty array when the vault is not a
+ *   registered OVault deployment.
+ */
+export declare function getWithdrawDestinationChains(vault: IAddress): number[];