@augustdigital/sdk 8.5.0 → 8.6.0

package/lib/core/helpers/vaults.d.ts

@@ -1,4 +1,4 @@
-import { IAddress, IContractRunner } from '../../types';
+import type { IAddress, IContractRunner } from '../../types';
 /**
  * Bad transactions that should be ignored
  * these transactions are usually from tests and can skew data

package/lib/core/helpers/web3.d.ts

@@ -1,7 +1,7 @@
-import { ethers, Interface, InterfaceAbi, JsonRpcProvider } from 'ethers';
+import { ethers, Interface, type InterfaceAbi, JsonRpcProvider } from 'ethers';
 import type { Abi } from 'abitype';
 import type { TypedContract } from '../../types/typed-contract';
-import { IAddress, IContractRunner, IInfuraOptions } from '../../types';
+import type { IAddress, IContractRunner, IInfuraOptions } from '../../types';
 /**
  * Web3 Helper Utilities
  *

package/lib/core/helpers/web3.js

@@ -41,13 +41,13 @@ const vault_version_1 = require("./vault-version");
 const determineBlockCutoff = (chain) => {
     switch (chain) {
         case 56:
-            return 120000;
+            return 120_000;
         case 43114:
-            return 120000;
+            return 120_000;
         case 143:
-            return 3456000;
+            return 3_456_000;
         default:
-            return 150000;
+            return 150_000;
     }
 };
 exports.determineBlockCutoff = determineBlockCutoff;
@@ -78,15 +78,15 @@ exports.determineSecondsPerBlock = determineSecondsPerBlock;
 const determineBlockSkipInternal = (chain) => {
     switch (chain) {
         case 43114:
-            return 8000;
+            return 8_000;
         case 56:
-            return 8000;
+            return 8_000;
         case 143: // Monad — Alchemy limits eth_getLogs to 1000 blocks
-            return 1000;
+            return 1_000;
         case 999: // HyperEVM — rpc.hypurrscan.io limits eth_getLogs to 1000 blocks
-            return 1000;
+            return 1_000;
         default:
-            return 50000;
+            return 50_000;
     }
 };
 exports.determineBlockSkipInternal = determineBlockSkipInternal;

package/lib/core/vault-metadata.d.ts

@@ -1,4 +1,4 @@
-import { IVaultMetadata } from '../types';
+import type { IVaultMetadata } from '../types';
 /**
  * Fetch vault metadata from the upshift API.
  * Returns metadata including symbol, subgraph URL, and address for all vaults.

package/lib/core/version-check.js

@@ -30,7 +30,7 @@ let hasRunCheck = false;
 const NPM_PACKAGE = '@augustdigital/sdk';
 const REGISTRY_URL = `https://registry.npmjs.org/${NPM_PACKAGE}/latest`;
 /** Timeout for the registry request. 5s is generous; faster failures stay silent. */
-const REQUEST_TIMEOUT_MS = 5000;
+const REQUEST_TIMEOUT_MS = 5_000;
 /**
  * Read the current installed SDK version from the generated `version.ts`
  * shim. Returns `null` when running from source (the file is gitignored and

package/lib/evm/methods/crossChainVault.js

@@ -90,7 +90,7 @@ const DEFAULT_HUB_LZ_COMPOSE_GAS_LIMIT = 2000000n;
 // serialize patched calls. The timeout THROWS rather than silently racing
 // concurrent callers' patches.
 // ---------------------------------------------------------------------------
-const PATCH_LOCK_TIMEOUT_MS = 30000;
+const PATCH_LOCK_TIMEOUT_MS = 30_000;
 let patchLock = Promise.resolve();
 // ---------------------------------------------------------------------------
 // Internal helpers

package/lib/evm/types/crossChain.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CROSS_CHAIN_QUOTE_TTL_MS = void 0;
 exports.isQuoteStale = isQuoteStale;
 /** Default validity window for a cross-chain quote (30s). */
-exports.CROSS_CHAIN_QUOTE_TTL_MS = 30000;
+exports.CROSS_CHAIN_QUOTE_TTL_MS = 30_000;
 /** Returns `true` when the quote should be refreshed before submitting. */
 function isQuoteStale(quote, now = Date.now()) {
     return now >= quote.expiresAt;

package/lib/main.d.ts

@@ -69,7 +69,7 @@ export declare class AugustSDK extends AugustBase {
      * @param symbol - Token symbol or contract address
      * @returns Current price in USD
      */
-    getPrice(symbol: string): Promise<any>;
+    getPrice(symbol: string): Promise<number>;
     /**
      * Vault Data and Operations
      */

package/lib/main.js

@@ -56,6 +56,13 @@ const api_1 = require("./modules/api");
  * Provides unified access to EVM, Solana, Sui, and Stellar blockchain adapters.
  */
 class AugustSDK extends core_1.AugustBase {
+    vaults;
+    subaccounts;
+    api;
+    solana;
+    sui;
+    stellar;
+    evm;
     /**
      * Initialize the August SDK with provider configuration.
      * Automatically sets up EVM adapter and optionally initializes Solana if RPC URL is provided.

package/lib/modules/sub-accounts/fetcher.d.ts

@@ -1,5 +1,5 @@
-import { IFetchAugustOptions } from '../../core';
-import { IAddress, IOTCPosition, IWSSubaccountCefi, IWSSubAccountHealthFactor, IWSSubaccountLoan, IWSSubaccountSummary } from '../../types';
+import { type IFetchAugustOptions } from '../../core';
+import type { IAddress, IOTCPosition, IWSSubaccountCefi, IWSSubAccountHealthFactor, IWSSubaccountLoan, IWSSubaccountSummary } from '../../types';
 /**
  * Fetch subaccount health factor for a given subaccount address
  */

package/lib/modules/sub-accounts/main.d.ts

@@ -1,5 +1,5 @@
-import { AugustBase, IAugustBase } from '../../core';
-import { IAddress } from '../../types';
+import { AugustBase, type IAugustBase } from '../../core';
+import type { IAddress } from '../../types';
 /**
  * Subaccount operation class interacting with August Subaccounts
  * Subaccount is a smart contract wallet that serves as the fundamental infrastructure for August's platform.

package/lib/modules/sub-accounts/main.js

@@ -16,9 +16,9 @@ const core_1 = require("../../core");
  * Most of the operations require a August API key to perform
  */
 class AugustSubAccounts extends core_1.AugustBase {
+    headers = null;
     constructor(baseConfig) {
         super(baseConfig);
-        this.headers = null;
         this.headers = {
             'x-environment': this.monitoring?.['x-environment'],
             'x-user-id': this.monitoring?.['x-user-id'],

package/lib/modules/sub-accounts/utils.d.ts

@@ -1,4 +1,4 @@
-import { IWSSubaccountSummary } from '../../types';
+import type { IWSSubaccountSummary } from '../../types';
 /**
  * Transform the raw API response to camelCase
  */

package/lib/modules/vaults/adapter.helpers.d.ts

@@ -4,9 +4,9 @@
  * Functions to support deposits with alternative tokens through swap adapters,
  * wrapper contracts, and Paraswap integration.
  */
-import { BaseContract, Signer, Wallet } from 'ethers';
-import { IAddress } from '../../types';
-import { IVaultAdapterConfig } from '../../types/vaults';
+import type { BaseContract, Signer, Wallet } from 'ethers';
+import type { IAddress } from '../../types';
+import type { IVaultAdapterConfig } from '../../types/vaults';
 /**
  * Get quote from Paraswap for token swap
  */

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

@@ -1,3 +1,28 @@
+import type { IAddress } from '../../types';
+/**
+ * Fetch the set of vaults whose deposit/withdraw history is served from the
+ * backend Mongo snapshot (`/upshift/vault_history`) rather than their (retired)
+ * Goldsky subgraph.
+ *
+ * This is the routing source of truth: a vault appears here only once its
+ * history has been backfilled, so the SDK can never reroute a vault to empty
+ * snapshot data ahead of its backfill. Result is cached for 10 minutes.
+ *
+ * Side effects: one HTTP GET to the public API (cached).
+ *
+ * @returns A set of lowercased vault addresses. Empty on any error — callers
+ *   then fall back to the subgraph path, which is the safe default while
+ *   subgraphs still exist.
+ */
+export declare function fetchArchivedVaults(): Promise<Set<string>>;
+/**
+ * Whether a vault's history should be served from the backend snapshot rather
+ * than its subgraph. Backed by {@link fetchArchivedVaults} (cached).
+ *
+ * @param vaultAddress - The vault contract address (any casing).
+ * @returns `true` if the vault has a backfilled history snapshot.
+ */
+export declare function isArchivedVault(vaultAddress: IAddress): Promise<boolean>;
 /**
  * Specialized vault fetching with enhanced retry logic and fallback strategies
  * This function attempts to fetch vault data with multiple fallback approaches

package/lib/modules/vaults/fetcher.js

@@ -1,11 +1,61 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchVaultMetadata = void 0;
+exports.fetchArchivedVaults = fetchArchivedVaults;
+exports.isArchivedVault = isArchivedVault;
 exports.fetchVaultWithFallback = fetchVaultWithFallback;
 exports.fetchVaultsBatch = fetchVaultsBatch;
 exports.fetchVaultsComprehensive = fetchVaultsComprehensive;
 exports.filterVaultsIntelligently = filterVaultsIntelligently;
 const core_1 = require("../../core");
+const ARCHIVED_VAULTS_CACHE_KEY = 'archived_vaults';
+const ARCHIVED_VAULTS_TTL_MS = 10 * 60 * 1000;
+/**
+ * Fetch the set of vaults whose deposit/withdraw history is served from the
+ * backend Mongo snapshot (`/upshift/vault_history`) rather than their (retired)
+ * Goldsky subgraph.
+ *
+ * This is the routing source of truth: a vault appears here only once its
+ * history has been backfilled, so the SDK can never reroute a vault to empty
+ * snapshot data ahead of its backfill. Result is cached for 10 minutes.
+ *
+ * Side effects: one HTTP GET to the public API (cached).
+ *
+ * @returns A set of lowercased vault addresses. Empty on any error — callers
+ *   then fall back to the subgraph path, which is the safe default while
+ *   subgraphs still exist.
+ */
+async function fetchArchivedVaults() {
+    const cached = core_1.CACHE.get(ARCHIVED_VAULTS_CACHE_KEY);
+    if (cached)
+        return cached;
+    try {
+        const response = await (0, core_1.fetchAugustPublic)(core_1.WEBSERVER_ENDPOINTS.public.tokenizedVault.archivedVaults);
+        if (response.status !== 200) {
+            core_1.Logger.log.error('fetchArchivedVaults', `non-200 from archived endpoint: ${response.status}`);
+            return new Set();
+        }
+        const addresses = (await response.json());
+        const set = new Set(addresses.map((a) => a.toLowerCase()));
+        core_1.CACHE.set(ARCHIVED_VAULTS_CACHE_KEY, set, { ttl: ARCHIVED_VAULTS_TTL_MS });
+        return set;
+    }
+    catch (e) {
+        core_1.Logger.log.error('fetchArchivedVaults', e);
+        return new Set();
+    }
+}
+/**
+ * Whether a vault's history should be served from the backend snapshot rather
+ * than its subgraph. Backed by {@link fetchArchivedVaults} (cached).
+ *
+ * @param vaultAddress - The vault contract address (any casing).
+ * @returns `true` if the vault has a backfilled history snapshot.
+ */
+async function isArchivedVault(vaultAddress) {
+    const archived = await fetchArchivedVaults();
+    return archived.has(vaultAddress.toLowerCase());
+}
 /** @internal */
 async function runWithConcurrency(tasks, limit) {
     if (!Number.isFinite(limit) || limit <= 0) {
@@ -151,7 +201,7 @@ async function fetchVaultsComprehensive(vaults, fetchFn, options = {}) {
                 catch (error) {
                     lastError = error;
                     if (attempts < maxRetries) {
-                        const delay = baseDelay * Math.pow(2, attempts - 1);
+                        const delay = baseDelay * 2 ** (attempts - 1);
                         core_1.Logger.log.warn('fetchVaultsComprehensive', `Vault ${vault.address} attempt ${attempts} failed, retrying in ${delay}ms: ${error.message}`);
                         await new Promise((resolve) => setTimeout(resolve, delay));
                     }

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