@augustdigital/sdk 9.5.0 → 9.7.0

package/lib/modules/vaults/write.actions.js

@@ -19,6 +19,7 @@ exports.rwaRedeemAsset = rwaRedeemAsset;
 exports.swapAndDeposit = swapAndDeposit;
 exports.depositViaSwapRouter = depositViaSwapRouter;
 exports.depositNativeViaSwapRouter = depositNativeViaSwapRouter;
+exports.isNativeSwapRouterDepositSupported = isNativeSwapRouterDepositSupported;
 exports.swapRouterDeposit = swapRouterDeposit;
 const ethers_1 = require("ethers");
 const abis_1 = require("../../abis");
@@ -1407,7 +1408,7 @@ async function dispatchViaSwapRouter(args) {
         const wrappedNative = core_1.SWAP_ROUTER_WRAPPED_NATIVE[args.chainId];
         if (!wrappedNative ||
             args.underlyingAsset.toLowerCase() !== wrappedNative.toLowerCase()) {
-            throw new core_1.AugustValidationError('INVALID_INPUT', `vaultDeposit (SwapRouter): native deposit is only supported when the vault's reference asset is the chain's wrapped-native token. Vault ${args.target} underlying ${args.underlyingAsset} is not. Wrap to ${wrappedNative ?? 'WETH'} first and call again with depositAsset = the wrapped token.`, {
+            throw new core_1.AugustValidationError('INVALID_INPUT', `vaultDeposit (SwapRouter): native deposit is only supported when the vault's reference asset is the chain's wrapped-native token. Vault ${args.target} underlying ${args.underlyingAsset} is not. Wrap to ${wrappedNative ?? 'WETH'} first and call again with depositAsset = the wrapped token. Check isNativeSwapRouterDepositSupported(chainId, vault, options) before offering this path to avoid hitting this error.`, {
                 context: {
                     vault: args.target,
                     underlying: args.underlyingAsset,
@@ -1694,6 +1695,14 @@ async function depositViaSwapRouter(signer, options) {
  * before depositing — only valid when the vault's reference asset equals
  * the wrapped-native token.
  *
+ * **Wrap-only limitation**: the on-chain SwapRouter has no ETH→other-asset
+ * swap leg, so this only ever reaches a WETH-accepting vault (see
+ * {@link SWAP_ROUTER_WRAPPED_NATIVE}). There is no atomic native-ETH deposit
+ * into a non-WETH-reference vault (e.g. a USDC vault) — deposit the wrapped
+ * native token instead (already whitelisted, routes through the swap leg for
+ * a non-reference-asset vault). Use {@link isNativeSwapRouterDepositSupported}
+ * to check eligibility before offering this path in a UI.
+ *
  * No ERC-20 approval is needed; `amount` travels as `msg.value`.
  *
  * @param signer - ethers `Signer` or `Wallet`.
@@ -1727,6 +1736,78 @@ async function depositNativeViaSwapRouter(signer, options) {
     core_1.Logger.log.info('depositNativeViaSwapRouter:tx_hash', hash);
     return hash;
 }
+/**
+ * Whether a vault can take a native-ETH (chain-native token) SwapRouter
+ * deposit — the pre-flight check for {@link depositNativeViaSwapRouter} and
+ * {@link swapRouterDeposit} with a zero-address `depositAsset`.
+ *
+ * The on-chain SwapRouter only wraps native ETH to the chain's wrapped-native
+ * token and deposits that — it has no ETH→other-asset swap leg (see
+ * {@link SWAP_ROUTER_WRAPPED_NATIVE}). So a native deposit needs all three: a
+ * SwapRouter deployed on `chainId`, the vault registered on that router with
+ * the wrapped-native token as its `vaultInfo(vault).referenceAsset` (a
+ * deposit into an unregistered vault reverts with `InvalidVault`), and the
+ * vault's own on-chain `asset()` equal to that same token. Use this to gate a
+ * "deposit ETH" UI option before the user picks it, instead of discovering
+ * the answer via a thrown {@link AugustValidationError} or an on-chain revert.
+ *
+ * It checks configuration only — a deposit that passes this check can still
+ * fail on balance, gas, a paused vault, or a deposit cap.
+ *
+ * Read-only and provider-agnostic (no signer required) — safe to call before
+ * a wallet is connected. Makes no backend call.
+ *
+ * @param chainId - EVM chain ID the vault is deployed on.
+ * @param vault - August vault address to check.
+ * @param options - `rpcUrl` for `chainId`, passed to `createProvider`.
+ * @returns `true` iff a SwapRouter exists on `chainId`, the vault is
+ *   registered on it with the wrapped-native reference asset, and the vault's
+ *   `asset()` is that token. `false` — never throws — for a chain with no
+ *   SwapRouter deployment, a missing/invalid `rpcUrl`, an unreadable vault or
+ *   router, an unregistered vault, or a vault whose reference asset isn't the
+ *   wrapped-native token.
+ * @worstCaseRpcCalls 2 — the vault's `asset()` and the router's
+ *   `vaultInfo(vault)`, read in parallel. None on a chain with no SwapRouter.
+ * @example
+ * ```ts
+ * const canDepositEth = await isNativeSwapRouterDepositSupported(
+ *   1,
+ *   '0x1234000000000000000000000000000000005678',
+ *   { rpcUrl: 'https://eth-mainnet.example/v2/KEY' },
+ * );
+ * // true only if that vault is a router-registered WETH vault on mainnet
+ * ```
+ */
+async function isNativeSwapRouterDepositSupported(chainId, vault, options) {
+    const wrappedNative = core_1.SWAP_ROUTER_WRAPPED_NATIVE[chainId];
+    const routerAddress = (0, core_1.getSwapRouterAddress)(chainId);
+    if (!wrappedNative || !routerAddress)
+        return false;
+    try {
+        const provider = (0, core_1.createProvider)(options.rpcUrl, chainId);
+        const vaultContract = (0, core_1.createContract)({
+            address: vault,
+            provider,
+            abi: abis_1.ABI_TOKENIZED_VAULT_V2,
+        });
+        const routerContract = (0, core_1.createContract)({
+            address: routerAddress,
+            provider,
+            abi: abis_1.ABI_SWAP_ROUTER,
+        });
+        const [asset, info] = await Promise.all([
+            vaultContract.asset(),
+            routerContract.vaultInfo(vault),
+        ]);
+        const wrapped = wrappedNative.toLowerCase();
+        return (asset.toLowerCase() === wrapped &&
+            info?.referenceAsset?.toLowerCase() === wrapped);
+    }
+    catch (error) {
+        core_1.Logger.log.warn('isNativeSwapRouterDepositSupported', 'vault or router read failed — treating as unsupported', { vault, chainId, error });
+        return false;
+    }
+}
 /**
  * Deposit into an August vault through the on-chain `SwapRouter`, selecting the
  * correct router path from the deposit asset. This is the high-level, explicit
@@ -1746,7 +1827,10 @@ async function depositNativeViaSwapRouter(signer, options) {
  *  - equals the reference asset → direct router deposit, no swap
  *    ({@link depositViaSwapRouter});
  *  - the zero address → native-token deposit ({@link depositNativeViaSwapRouter}),
- *    valid only when the reference asset is the chain's wrapped-native token;
+ *    valid only when the reference asset is the chain's wrapped-native token —
+ *    the router only wraps ETH, it never swaps it, so this throws for any
+ *    other reference asset (see {@link SWAP_ROUTER_WRAPPED_NATIVE} for why, and
+ *    {@link isNativeSwapRouterDepositSupported} to check first);
  *  - any other ERC-20 → a swap to the reference asset (Paraswap quote pinned to
  *    the chain's whitelisted aggregator, fail-closed on router/selector drift)
  *    bundled into {@link swapAndDeposit}.