@augustdigital/sdk 8.5.0 → 8.6.1

package/lib/modules/vaults/getters.d.ts

@@ -19,10 +19,10 @@ import type { IVaultBaseOptions } from './types';
  * Fetch comprehensive vault data including on-chain state and backend metadata.
  * Routes to appropriate chain adapter (EVM v1/v2, Solana, or Stellar) based on vault version.
  * Optionally enriches with loan and allocation data.
- * @param vault Vault contract address (EVM hex, Stellar C-address, or Solana program ID)
- * @param loans Include active loan data
- * @param allocations Include DeFi/CeFi allocation breakdowns
- * @param options RPC and service configuration
+ * @param vault - Vault contract address (EVM hex, Stellar C-address, or Solana program ID)
+ * @param loans - Include active loan data
+ * @param allocations - Include DeFi/CeFi allocation breakdowns
+ * @param options - RPC and service configuration
  * @returns Complete vault object with optional enrichments
  */
 export declare function getVault({ vault, loans, allocations, options, loadSubaccounts, loadSnapshots, }: {
@@ -48,8 +48,8 @@ export declare function getVaultSubaccountLoans(vault: VaultAddress | IVault, op
  * Fetch comprehensive vault asset allocation breakdown.
  * Includes DeFi protocols (via DeBank), CeFi balances, OTC positions, and loans.
  * Categorizes exposures by borrowing, supplying, lending, and wallet holdings.
- * @param vault Vault address
- * @param options RPC configuration
+ * @param vault - Vault address
+ * @param options - RPC configuration
  * @returns Detailed allocation data with exposure categorization
  */
 export declare function getVaultAllocations(vault: IAddress, options: IVaultBaseOptions): Promise<IVaultAllocations>;
@@ -117,8 +117,8 @@ export declare function getVaultTvl({ vault, options, historical, }: {
  * `health_factor: undefined` so callers can render an explicit empty state
  * rather than a perpetual loading skeleton.
  *
- * @param vault Vault address to scope the fetch to.
- * @param options Standard vault options — `rpcUrl` must point at `vault`'s chain.
+ * @param vault - Vault address to scope the fetch to.
+ * @param options - Standard vault options — `rpcUrl` must point at `vault`'s chain.
  * @returns Array of `IVaultBorrowerHealthFactor`, one entry per active loan.
  */
 export declare function getVaultBorrowerHealthFactor({ vault, options, }: {
@@ -141,8 +141,8 @@ export declare function getVaultBorrowerHealthFactor({ vault, options, }: {
  * look up entries without worrying about EIP-55 checksum casing in either the
  * backend response or the caller's input.
  *
- * @param options Standard vault options — `rpcUrl` should match `vault`'s chain.
- * @param vault Optional vault address to scope the fetch to.
+ * @param options - Standard vault options — `rpcUrl` should match `vault`'s chain.
+ * @param vault - Optional vault address to scope the fetch to.
  * @returns Map of lowercased vault address → array of borrower-health-factor rows.
  */
 export declare function getHealthFactorOfBorrowersByVault({ options, vault, }: {
@@ -152,8 +152,8 @@ export declare function getHealthFactorOfBorrowersByVault({ options, vault, }: {
 /**
  * Fetch user points from the backend API endpoint.
  * This replaces client-side points calculation with server-side processing.
- * @param userAddress User wallet address (EVM or Solana)
- * @param options Request options including headers
+ * @param userAddress - User wallet address (EVM or Solana)
+ * @param options - Request options including headers
  * @returns Points data from the backend API
  */
 export declare function getUserPoints({ userAddress, options, }: {
@@ -180,24 +180,24 @@ export declare function getUserPoints({ userAddress, options, }: {
  * expires: {expiry}
  * ```
  *
- * @param userAddress EVM wallet address being registered. Must match the
+ * @param userAddress - EVM wallet address being registered. Must match the
  *   signer that produced `signature`. Lowercased before being embedded in
  *   the canonical message.
- * @param referrerAddress Optional EVM address that referred this user.
+ * @param referrerAddress - Optional EVM address that referred this user.
  *   Lowercased when embedded; the literal string `"none"` is used when
  *   absent. Tampering with this field after signing produces 401.
- * @param chainId Chain on which the wallet signed. For smart-contract wallets
+ * @param chainId - Chain on which the wallet signed. For smart-contract wallets
  *   (Safe etc.) this is the chain whose RPC the backend will use to run the
  *   EIP-1271 `isValidSignature` check; for EOAs it still pins the signature
  *   to a chain so it can't be replayed cross-chain. Must be one of the chains
  *   Upshift supports (see backend `SUPPORTED_REGISTRATION_CHAINS`).
- * @param signature `0x`-prefixed hex of the personal_sign signature over
+ * @param signature - `0x`-prefixed hex of the personal_sign signature over
  *   the canonical message. Single-use: replays within ~10 min are rejected.
- * @param nonce Caller-generated random string (8–128 chars). Pair with
+ * @param nonce - Caller-generated random string (8–128 chars). Pair with
  *   `userAddress` to form the single-use key in the backend's nonce store.
- * @param expiry Unix timestamp (seconds). Must be in the future and within
+ * @param expiry - Unix timestamp (seconds). Must be in the future and within
  *   the backend's TTL window (currently 10 min).
- * @param options Request options (headers).
+ * @param options - Request options (headers).
  * @returns Raw `Response` from the backend. 200 on success, 401 for
  *   expired / replayed / mismatched-signer / tampered-referrer, 422 for an
  *   unsupported `chainId`.
@@ -227,8 +227,8 @@ export declare function registerUserForPoints({ userAddress, referrerAddress, ch
 }): Promise<Response>;
 /**
  * Fetch the points leaderboard data.
- * @param params Optional parameters for pagination and sorting
- * @param options Request options including headers
+ * @param params - Optional parameters for pagination and sorting
+ * @param options - Request options including headers
  * @returns Leaderboard response data
  */
 export declare function fetchPointsLeaderboard({ params, options, }: {
@@ -242,8 +242,8 @@ export declare function fetchPointsLeaderboard({ params, options, }: {
 /**
  * Fetch the timestamp when yield was last realized for a vault.
  * Returns the assetsUpdatedOn timestamp from the vault contract.
- * @param vault Vault contract address
- * @param options RPC configuration
+ * @param vault - Vault contract address
+ * @param options - RPC configuration
  * @returns Timestamp (Unix timestamp in seconds) when yield was last realized
  */
 export declare function getYieldLastRealizedOn({ vault, options, }: {
@@ -258,9 +258,9 @@ export declare function getYieldLastRealizedOn({ vault, options, }: {
  * 2. Fetch user's current assets (balanceOf * sharePrice via convertToAssets)
  * 3. Calculate PnL = assets withdrawn + current assets - assets deposited
  *
- * @param vault Vault contract address
- * @param wallet User wallet address
- * @param options RPC configuration and service options
+ * @param vault - Vault contract address
+ * @param wallet - User wallet address
+ * @param options - RPC configuration and service options
  * @returns Lifetime PnL data in both native token and USD
  */
 export declare function getVaultUserLifetimePnl({ vault, wallet, options, }: {
@@ -273,8 +273,8 @@ export declare function getVaultUserLifetimePnl({ vault, wallet, options, }: {
  * Calculate PnL for a vault (vault-level, not user-specific).
  * Returns the vault's overall profit and loss across all users.
  *
- * @param vault Vault contract address
- * @param options RPC configuration and service options
+ * @param vault - Vault contract address
+ * @param options - RPC configuration and service options
  * @returns Vault PnL in USD and notional value
  */
 export declare function getVaultPnl({ vault, options, }: {
@@ -295,8 +295,8 @@ export declare function getVaultHistoricalTimeseries({ vault, nDays, options, }:
  * These fields will be removed on 2026-01-01.
  * Use `liquidAPY30Day` and `liquidAPY7Day` fields instead.
  *
- * @param vault Vault contract address
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param options - Request options including headers
  * @returns Annualized APY data including liquidity APY
  */
 export declare function getVaultAnnualizedApy({ vault, options, }: {
@@ -305,8 +305,8 @@ export declare function getVaultAnnualizedApy({ vault, options, }: {
 }): Promise<IVaultAnnualizedApy>;
 /**
  * Fetch summary data for a vault (name, type, chain, recent returns).
- * @param vault Vault contract address
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param options - Request options including headers
  * @returns Vault summary data
  */
 export declare function getVaultSummary({ vault, options, }: {
@@ -315,9 +315,9 @@ export declare function getVaultSummary({ vault, options, }: {
 }): Promise<IVaultSummary>;
 /**
  * Fetch withdrawal summary and pending queue for a vault.
- * @param vault Vault contract address
- * @param chain Chain identifier (e.g., chain ID as string)
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param chain - Chain identifier (e.g., chain ID as string)
+ * @param options - Request options including headers
  * @returns Withdrawal summary and pending queue
  */
 export declare function getVaultWithdrawals({ vault, chain, options, }: {
@@ -327,10 +327,10 @@ export declare function getVaultWithdrawals({ vault, chain, options, }: {
 }): Promise<IVaultWithdrawals>;
 /**
  * Fetch pending redemptions for a vault with liquidity analysis.
- * @param vault Vault contract address
- * @param pastDays Number of past days to include (default 7, min 1, max 30)
- * @param futureDays Number of future days to include (default 14, min 1, max 30)
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param pastDays - Number of past days to include (default 7, min 1, max 30)
+ * @param futureDays - Number of future days to include (default 14, min 1, max 30)
+ * @param options - Request options including headers
  * @returns Pending redemptions grouped by date with liquidity summary
  */
 export declare function getVaultPendingRedemptions({ vault, pastDays, futureDays, options, }: {
@@ -341,10 +341,10 @@ export declare function getVaultPendingRedemptions({ vault, pastDays, futureDays
 }): Promise<IVaultPendingRedemptions>;
 /**
  * Preview the amount of assets that would be received for redeeming shares (queued redemption).
- * @param vault Vault contract address
- * @param sharesAmount Amount of shares to redeem (human-readable, raw bigint, or string)
- * @param options RPC configuration
- * @returns The amount of assets as INormalizedNumber { normalized, raw }
+ * @param vault - Vault contract address
+ * @param sharesAmount - Amount of shares to redeem (human-readable, raw bigint, or string)
+ * @param options - RPC configuration
+ * @returns The amount of assets as an INormalizedNumber with `normalized` and `raw` fields
  */
 export declare function getPreviewRedemption({ vault, sharesAmount, options, }: {
     vault: IAddress;
@@ -409,13 +409,13 @@ export interface WithdrawalRequestStatus {
  * - `'ready_to_claim'` — Claimable date has passed (within the lookback window) but no processed event found.
  * - `'pending'` — Claimable date is still in the future.
  *
- * @param params - Query parameters
- * @param params.vault - Vault address to query
- * @param params.receiver - (Optional) Filter by receiver address
- * @param params.lookbackBlocks - (Optional) On-chain log lookback window in blocks.
- *   Defaults to a chain-specific value (e.g. 150,000 for Ethereum, 3,456,000 for Monad).
- *   Increasing this scans more history but requires more RPC calls.
- * @param params.options - Standard vault query options (provider, RPC URL, etc.)
+ * @param params - Query parameters:
+ *   - `vault` — Vault address to query.
+ *   - `receiver` — (Optional) Filter by receiver address.
+ *   - `lookbackBlocks` — (Optional) On-chain log lookback window in blocks.
+ *     Defaults to a chain-specific value (e.g. 150,000 for Ethereum, 3,456,000 for Monad).
+ *     Increasing this scans more history but requires more RPC calls.
+ *   - `options` — Standard vault query options (provider, RPC URL, etc.).
  * @returns Array of withdrawal requests with status and claimable dates
  *
  * @example

package/lib/modules/vaults/getters.js

@@ -103,10 +103,10 @@ const redeems_1 = require("../../services/layerzero/redeems");
  * Fetch comprehensive vault data including on-chain state and backend metadata.
  * Routes to appropriate chain adapter (EVM v1/v2, Solana, or Stellar) based on vault version.
  * Optionally enriches with loan and allocation data.
- * @param vault Vault contract address (EVM hex, Stellar C-address, or Solana program ID)
- * @param loans Include active loan data
- * @param allocations Include DeFi/CeFi allocation breakdowns
- * @param options RPC and service configuration
+ * @param vault - Vault contract address (EVM hex, Stellar C-address, or Solana program ID)
+ * @param loans - Include active loan data
+ * @param allocations - Include DeFi/CeFi allocation breakdowns
+ * @param options - RPC and service configuration
  * @returns Complete vault object with optional enrichments
  */
 async function getVault({ vault, loans = false, allocations = false, options, loadSubaccounts, loadSnapshots, }) {
@@ -355,8 +355,8 @@ async function getVaultSubaccountLoans(vault, options) {
  * Fetch comprehensive vault asset allocation breakdown.
  * Includes DeFi protocols (via DeBank), CeFi balances, OTC positions, and loans.
  * Categorizes exposures by borrowing, supplying, lending, and wallet holdings.
- * @param vault Vault address
- * @param options RPC configuration
+ * @param vault - Vault address
+ * @param options - RPC configuration
  * @returns Detailed allocation data with exposure categorization
  */
 async function getVaultAllocations(vault, options) {
@@ -604,9 +604,9 @@ async function getVaultAvailableRedemptions({ vault, wallet, options, }) {
                 core_1.Logger.log.warn('getVaultAvailableRedemptions', `Skipping invalid event: ${ev}`);
                 continue;
             }
-            let month;
-            let day;
-            let year;
+            let month = 0;
+            let day = 0;
+            let year = 0;
             if (version === 'evm-2') {
                 // Use UTC-based computeClaimableDate to mirror contract logic exactly
                 const claimable = (0, date_utils_1.computeClaimableDate)(Number(ev.timestamp_), lagDuration);
@@ -931,11 +931,12 @@ async function getVaultRedemptionHistory({ vault, wallet, lookbackBlocks, option
         if (isV2 && logs.length > 0) {
             const uniqueBlocks = [...new Set(logs.map((l) => l.blockNumber))];
             const blockResults = await Promise.all(uniqueBlocks.map((bn) => provider.getBlock(bn)));
-            blockTimestamps = new Map();
+            const timestamps = new Map();
             blockResults.forEach((block) => {
                 if (block)
-                    blockTimestamps.set(block.number, block.timestamp);
+                    timestamps.set(block.number, block.timestamp);
             });
+            blockTimestamps = timestamps;
         }
         // format — iterate logs directly to preserve transactionHash
         const redemptions = [];
@@ -1190,7 +1191,7 @@ async function getVaultApy({ vault, options, historical, }) {
                 const query = urlParams.toString();
                 if (!query)
                     return '';
-                return baseUrl && baseUrl.includes('?') ? `&${query}` : `?${query}`;
+                return baseUrl?.includes('?') ? `&${query}` : `?${query}`;
             }
             const baseUrl = core_1.WEBSERVER_ENDPOINTS.public.tokenizedVault.historicalApy(vault);
             const historicalApy = await (0, core_1.fetchAugustPublic)(`${baseUrl}${paramBuilder(historical, baseUrl)}`, {
@@ -1357,15 +1358,15 @@ async function getVaultTvl({ vault, options, historical, }) {
                 case 'evm-2': {
                     const receiptTokenAddress = await (0, core_1.getReceiptTokenAddress)(provider, vault);
                     const receiptTokenDecimals = await (0, core_1.getDecimals)(provider, receiptTokenAddress, false);
-                    const receiptTokenContract = (0, core_1.createContract)({
-                        address: receiptTokenAddress,
-                        abi: TokenizedVaultV2Receipt_1.ABI_TOKENIZED_VAULT_V2_RECEIPT,
+                    const vaultContract = (0, core_1.createContract)({
+                        address: vault,
+                        abi: TokenizedVaultV2_1.ABI_TOKENIZED_VAULT_V2,
                         provider,
                     });
-                    const totalSupply = await receiptTokenContract.totalSupply();
+                    const totalAssets = await vaultContract.getTotalAssets();
                     return [
                         {
-                            value: (0, core_1.toNormalizedBn)(totalSupply, receiptTokenDecimals),
+                            value: (0, core_1.toNormalizedBn)(totalAssets, receiptTokenDecimals),
                             timestamp: new Date().toISOString(),
                         },
                     ];
@@ -1377,10 +1378,10 @@ async function getVaultTvl({ vault, options, historical, }) {
                         provider,
                     });
                     const decimals = await (0, core_1.getDecimals)(provider, vault);
-                    const totalSupply = await vaultContract.totalSupply();
+                    const totalAssets = await vaultContract.totalAssets();
                     return [
                         {
-                            value: (0, core_1.toNormalizedBn)(totalSupply, decimals),
+                            value: (0, core_1.toNormalizedBn)(totalAssets, decimals),
                             timestamp: new Date().toISOString(),
                         },
                     ];
@@ -1495,8 +1496,8 @@ async function getVaultTvl({ vault, options, historical, }) {
  * `health_factor: undefined` so callers can render an explicit empty state
  * rather than a perpetual loading skeleton.
  *
- * @param vault Vault address to scope the fetch to.
- * @param options Standard vault options — `rpcUrl` must point at `vault`'s chain.
+ * @param vault - Vault address to scope the fetch to.
+ * @param options - Standard vault options — `rpcUrl` must point at `vault`'s chain.
  * @returns Array of `IVaultBorrowerHealthFactor`, one entry per active loan.
  */
 async function getVaultBorrowerHealthFactor({ vault, options, }) {
@@ -1588,8 +1589,8 @@ async function getVaultBorrowerHealthFactor({ vault, options, }) {
  * look up entries without worrying about EIP-55 checksum casing in either the
  * backend response or the caller's input.
  *
- * @param options Standard vault options — `rpcUrl` should match `vault`'s chain.
- * @param vault Optional vault address to scope the fetch to.
+ * @param options - Standard vault options — `rpcUrl` should match `vault`'s chain.
+ * @param vault - Optional vault address to scope the fetch to.
  * @returns Map of lowercased vault address → array of borrower-health-factor rows.
  */
 async function getHealthFactorOfBorrowersByVault({ options, vault, }) {
@@ -1620,8 +1621,8 @@ async function getHealthFactorOfBorrowersByVault({ options, vault, }) {
 /**
  * Fetch user points from the backend API endpoint.
  * This replaces client-side points calculation with server-side processing.
- * @param userAddress User wallet address (EVM or Solana)
- * @param options Request options including headers
+ * @param userAddress - User wallet address (EVM or Solana)
+ * @param options - Request options including headers
  * @returns Points data from the backend API
  */
 async function getUserPoints({ userAddress, options, }) {
@@ -1665,24 +1666,24 @@ async function getUserPoints({ userAddress, options, }) {
  * expires: {expiry}
  * ```
  *
- * @param userAddress EVM wallet address being registered. Must match the
+ * @param userAddress - EVM wallet address being registered. Must match the
  *   signer that produced `signature`. Lowercased before being embedded in
  *   the canonical message.
- * @param referrerAddress Optional EVM address that referred this user.
+ * @param referrerAddress - Optional EVM address that referred this user.
  *   Lowercased when embedded; the literal string `"none"` is used when
  *   absent. Tampering with this field after signing produces 401.
- * @param chainId Chain on which the wallet signed. For smart-contract wallets
+ * @param chainId - Chain on which the wallet signed. For smart-contract wallets
  *   (Safe etc.) this is the chain whose RPC the backend will use to run the
  *   EIP-1271 `isValidSignature` check; for EOAs it still pins the signature
  *   to a chain so it can't be replayed cross-chain. Must be one of the chains
  *   Upshift supports (see backend `SUPPORTED_REGISTRATION_CHAINS`).
- * @param signature `0x`-prefixed hex of the personal_sign signature over
+ * @param signature - `0x`-prefixed hex of the personal_sign signature over
  *   the canonical message. Single-use: replays within ~10 min are rejected.
- * @param nonce Caller-generated random string (8–128 chars). Pair with
+ * @param nonce - Caller-generated random string (8–128 chars). Pair with
  *   `userAddress` to form the single-use key in the backend's nonce store.
- * @param expiry Unix timestamp (seconds). Must be in the future and within
+ * @param expiry - Unix timestamp (seconds). Must be in the future and within
  *   the backend's TTL window (currently 10 min).
- * @param options Request options (headers).
+ * @param options - Request options (headers).
  * @returns Raw `Response` from the backend. 200 on success, 401 for
  *   expired / replayed / mismatched-signer / tampered-referrer, 422 for an
  *   unsupported `chainId`.
@@ -1735,8 +1736,8 @@ async function registerUserForPoints({ userAddress, referrerAddress, chainId, si
 }
 /**
  * Fetch the points leaderboard data.
- * @param params Optional parameters for pagination and sorting
- * @param options Request options including headers
+ * @param params - Optional parameters for pagination and sorting
+ * @param options - Request options including headers
  * @returns Leaderboard response data
  */
 async function fetchPointsLeaderboard({ params, options, }) {
@@ -1764,8 +1765,8 @@ async function fetchPointsLeaderboard({ params, options, }) {
 /**
  * Fetch the timestamp when yield was last realized for a vault.
  * Returns the assetsUpdatedOn timestamp from the vault contract.
- * @param vault Vault contract address
- * @param options RPC configuration
+ * @param vault - Vault contract address
+ * @param options - RPC configuration
  * @returns Timestamp (Unix timestamp in seconds) when yield was last realized
  */
 async function getYieldLastRealizedOn({ vault, options, }) {
@@ -1822,9 +1823,9 @@ async function getYieldLastRealizedOn({ vault, options, }) {
  * 2. Fetch user's current assets (balanceOf * sharePrice via convertToAssets)
  * 3. Calculate PnL = assets withdrawn + current assets - assets deposited
  *
- * @param vault Vault contract address
- * @param wallet User wallet address
- * @param options RPC configuration and service options
+ * @param vault - Vault contract address
+ * @param wallet - User wallet address
+ * @param options - RPC configuration and service options
  * @returns Lifetime PnL data in both native token and USD
  */
 async function getVaultUserLifetimePnl({ vault, wallet, options, }) {
@@ -2196,8 +2197,8 @@ async function getVaultUserLifetimePnl({ vault, wallet, options, }) {
  * Calculate PnL for a vault (vault-level, not user-specific).
  * Returns the vault's overall profit and loss across all users.
  *
- * @param vault Vault contract address
- * @param options RPC configuration and service options
+ * @param vault - Vault contract address
+ * @param options - RPC configuration and service options
  * @returns Vault PnL in USD and notional value
  */
 async function getVaultPnl({ vault, options, }) {
@@ -2254,7 +2255,7 @@ async function getVaultPnl({ vault, options, }) {
             const dateKey = dayDate.toISOString().split('T')[0];
             // Find matching snapshot for this date
             const snapshot = snapshotsByDate.get(dateKey);
-            if (!snapshot || !snapshot.total_shares) {
+            if (!snapshot?.total_shares) {
                 core_1.Logger.log.warn('getVaultPnl:snapshotNotFound', `No snapshot found for date ${dateKey}`);
                 return;
             }
@@ -2301,9 +2302,9 @@ async function getVaultPnl({ vault, options, }) {
 /*
  * Fetch historical timeseries data for a vault.
  * Returns TVL, APY, PnL, share price, and other metrics over time.
- * @param vault Vault contract address
- * @param nDays Number of days of historical data (default 30, min 1)
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param nDays - Number of days of historical data (default 30, min 1)
+ * @param options - Request options including headers
  * @returns Historical timeseries data with date string keys
  */
 async function getVaultHistoricalTimeseries({ vault, nDays, options, }) {
@@ -2328,8 +2329,8 @@ async function getVaultHistoricalTimeseries({ vault, nDays, options, }) {
  * These fields will be removed on 2026-01-01.
  * Use `liquidAPY30Day` and `liquidAPY7Day` fields instead.
  *
- * @param vault Vault contract address
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param options - Request options including headers
  * @returns Annualized APY data including liquidity APY
  */
 async function getVaultAnnualizedApy({ vault, options, }) {
@@ -2358,8 +2359,8 @@ async function getVaultAnnualizedApy({ vault, options, }) {
 }
 /**
  * Fetch summary data for a vault (name, type, chain, recent returns).
- * @param vault Vault contract address
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param options - Request options including headers
  * @returns Vault summary data
  */
 async function getVaultSummary({ vault, options, }) {
@@ -2389,9 +2390,9 @@ async function getVaultSummary({ vault, options, }) {
 }
 /**
  * Fetch withdrawal summary and pending queue for a vault.
- * @param vault Vault contract address
- * @param chain Chain identifier (e.g., chain ID as string)
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param chain - Chain identifier (e.g., chain ID as string)
+ * @param options - Request options including headers
  * @returns Withdrawal summary and pending queue
  */
 async function getVaultWithdrawals({ vault, chain, options, }) {
@@ -2424,10 +2425,10 @@ async function getVaultWithdrawals({ vault, chain, options, }) {
 }
 /**
  * Fetch pending redemptions for a vault with liquidity analysis.
- * @param vault Vault contract address
- * @param pastDays Number of past days to include (default 7, min 1, max 30)
- * @param futureDays Number of future days to include (default 14, min 1, max 30)
- * @param options Request options including headers
+ * @param vault - Vault contract address
+ * @param pastDays - Number of past days to include (default 7, min 1, max 30)
+ * @param futureDays - Number of future days to include (default 14, min 1, max 30)
+ * @param options - Request options including headers
  * @returns Pending redemptions grouped by date with liquidity summary
  */
 async function getVaultPendingRedemptions({ vault, pastDays, futureDays, options, }) {
@@ -2499,10 +2500,10 @@ async function getVaultPendingRedemptions({ vault, pastDays, futureDays, options
 }
 /**
  * Preview the amount of assets that would be received for redeeming shares (queued redemption).
- * @param vault Vault contract address
- * @param sharesAmount Amount of shares to redeem (human-readable, raw bigint, or string)
- * @param options RPC configuration
- * @returns The amount of assets as INormalizedNumber { normalized, raw }
+ * @param vault - Vault contract address
+ * @param sharesAmount - Amount of shares to redeem (human-readable, raw bigint, or string)
+ * @param options - RPC configuration
+ * @returns The amount of assets as an INormalizedNumber with `normalized` and `raw` fields
  */
 async function getPreviewRedemption({ vault, sharesAmount, options, }) {
     try {
@@ -2599,13 +2600,13 @@ async function decodeProcessingTransaction(txHash, provider, iface) {
  * - `'ready_to_claim'` — Claimable date has passed (within the lookback window) but no processed event found.
  * - `'pending'` — Claimable date is still in the future.
  *
- * @param params - Query parameters
- * @param params.vault - Vault address to query
- * @param params.receiver - (Optional) Filter by receiver address
- * @param params.lookbackBlocks - (Optional) On-chain log lookback window in blocks.
- *   Defaults to a chain-specific value (e.g. 150,000 for Ethereum, 3,456,000 for Monad).
- *   Increasing this scans more history but requires more RPC calls.
- * @param params.options - Standard vault query options (provider, RPC URL, etc.)
+ * @param params - Query parameters:
+ *   - `vault` — Vault address to query.
+ *   - `receiver` — (Optional) Filter by receiver address.
+ *   - `lookbackBlocks` — (Optional) On-chain log lookback window in blocks.
+ *     Defaults to a chain-specific value (e.g. 150,000 for Ethereum, 3,456,000 for Monad).
+ *     Increasing this scans more history but requires more RPC calls.
+ *   - `options` — Standard vault query options (provider, RPC URL, etc.).
  * @returns Array of withdrawal requests with status and claimable dates
  *
  * @example

package/lib/modules/vaults/main.js

@@ -71,9 +71,11 @@ const read_actions_1 = require("./read.actions");
  * Supports both EVM and Solana vaults with unified interface.
  */
 class AugustVaults extends core_1.AugustBase {
+    solanaService;
+    suiService;
+    headers = null;
     constructor(baseConfig, solana, sui) {
         super(baseConfig);
-        this.headers = null;
         this.solanaService = solana;
         this.suiService = sui || new sui_1.default();
         this.headers = {

package/lib/modules/vaults/read.actions.d.ts

@@ -1,5 +1,5 @@
-import { IAddress, IContractRunner, INormalizedNumber } from '../../types';
-import { IContractWriteOptions } from './write.actions';
+import type { IAddress, IContractRunner, INormalizedNumber } from '../../types';
+import type { IContractWriteOptions } from './write.actions';
 /**
  * Function to fetch instant redemption fee
  * @param signer - signer / provider object