feat: enhance vault handling and status responses with improved key mapping and withdrawal support

Author: sai-aarna

apps/api/src/config/vault-registry.ts

@@ -1,6 +1,6 @@
 import { cmsService } from "../services/cms.service";
 import { pool } from "../db/postgres";
-import { IAtvVault } from "../types/vault.types";
+import { DepositContractType, IAtvVault } from "../types/vault.types";
 
 /**
  * Vault registry — the single source of truth for vault configs across this service.
@@ -27,12 +27,22 @@ class VaultRegistry {
   }
 
   /**
-   * Returns a map of lowercase atvTokenAddress → IAtvVault for O(1) lookup.
+   * Returns a map of lookup address → IAtvVault for O(1) lookup.
+   *
+   * For ERC4626 vaults the user-facing address is the timelock contract,
+   * so we key by timelock address. All other vaults key by atvTokenAddress.
    */
   async getVaultMap(): Promise<Record<string, IAtvVault>> {
     const vaults = await this.getVaults();
     return Object.fromEntries(
-      vaults.map((v) => [v.atvTokenAddress.toLowerCase(), v]),
+      vaults.map((v) => {
+        const key =
+          v.depositContractType === DepositContractType.ERC4626 &&
+          v.contracts.timelock?.address
+            ? v.contracts.timelock.address.toLowerCase()
+            : v.atvTokenAddress.toLowerCase();
+        return [key, v];
+      }),
     );
   }
 

apps/api/src/handlers/vaults.handler.ts

@@ -102,7 +102,10 @@ export const vaultsHandler = {
     ) => {
         try {
             const data = await vaultService.getQueueWithdrawStatus(req.params.address);
-            res.json({ data, message: 'Queue withdraw status retrieved', statusCode: 200 });
+            const message = data.supported
+                ? 'Queue withdraw status retrieved'
+                : 'Queue withdraw method not supported for this vault';
+            res.json({ data, message, statusCode: 200 });
         } catch (err) {
             next(err);
         }

apps/api/src/services/cms.service.ts

@@ -60,9 +60,9 @@ class CmsService {
   }
 
   async getVaults(): Promise<IAtvVault[]> {
-    // if (this.isCacheValid) {
-    //   return this.cache!.vaults;
-    // }
+    if (this.isCacheValid) {
+      return this.cache!.vaults;
+    }
 
     const vaults = await this.fetchFromCms();
     this.cache = { vaults, fetchedAt: Date.now() };
@@ -164,9 +164,7 @@ class CmsService {
         (item.depositContractType?.toUpperCase() as DepositContractType) ??
         DepositContractType.ERC20,
       withdrawType: item.withdrawType?.length
-        ? (item.withdrawType.map((w) =>
-            w.toUpperCase(),
-          ) as WithdrawType[])
+        ? (item.withdrawType.map((w) => w.toUpperCase()) as WithdrawType[])
         : [WithdrawType.INSTANT],
       depositFee: item.depositFee,
       contracts: {

apps/api/src/services/vault.service.ts

@@ -14,7 +14,7 @@ import {
   VaultMetadata,
   VaultStatusResponse,
 } from "../types/api.types";
-import { IAtvVault } from "../types/vault.types";
+import { IAtvVault, WithdrawType } from "../types/vault.types";
 
 export class VaultService {
   private toMetadata(
@@ -157,7 +157,7 @@ export class VaultService {
     } catch (e: any) {
       console.error(
         `[VaultService] getDepositTokens failed for vault ${vault.productId} ` +
-        `(atvTokenAddress=${vault.atvTokenAddress}, chainId=${vault.chain.decimal}):`,
+          `(atvTokenAddress=${vault.atvTokenAddress}, chainId=${vault.chain.decimal}):`,
         e,
       );
       return [];
@@ -288,9 +288,9 @@ export class VaultService {
         [],
         vault.chain,
       );
-      return { vaultAddress: vault.atvTokenAddress, isPaused, supported: true };
+      return { isPaused, supported: true };
     } catch {
-      return { vaultAddress: vault.atvTokenAddress, isPaused: false, supported: false };
+      return { isPaused: false, supported: false };
     }
   }
 
@@ -304,14 +304,28 @@ export class VaultService {
         [],
         vault.chain,
       );
-      return { vaultAddress: vault.atvTokenAddress, isPaused, supported: true };
+      return { isPaused, supported: true };
     } catch {
-      return { vaultAddress: vault.atvTokenAddress, isPaused: false, supported: false };
+      return { isPaused: false, supported: false };
     }
   }
 
+  private static QUEUE_WITHDRAW_TYPES = new Set<WithdrawType>([
+    WithdrawType.STANDARD,
+    WithdrawType.STANDARD_AUTO_REDEEM,
+  ]);
+
   async getQueueWithdrawStatus(address: string): Promise<VaultStatusResponse> {
     const vault = await vaultRegistry.getVaultOrThrow(address);
+
+    // Check if the vault supports queued withdrawals based on CMS config
+    const supportsQueue = vault.withdrawType.some((t) =>
+      VaultService.QUEUE_WITHDRAW_TYPES.has(t),
+    );
+    if (!supportsQueue) {
+      return { isPaused: false, supported: false };
+    }
+
     try {
       const isPaused = await ethersHelper.readContract<boolean>(
         vault.contracts.base.address,
@@ -320,9 +334,9 @@ export class VaultService {
         [],
         vault.chain,
       );
-      return { vaultAddress: vault.atvTokenAddress, isPaused, supported: true };
+      return { isPaused, supported: true };
     } catch {
-      return { vaultAddress: vault.atvTokenAddress, isPaused: false, supported: false };
+      return { isPaused: false, supported: false };
     }
   }
 }

apps/api/src/types/api.types.ts

@@ -71,7 +71,6 @@ export interface ApyResponse {
 }
 
 export interface VaultStatusResponse {
-  vaultAddress: string;
   isPaused: boolean;
   supported: boolean; // false when contract doesn't expose the status function
 }