@augustdigital/sdk 9.5.0 → 9.7.0

package/lib/core/constants/core.js

@@ -63,6 +63,7 @@ exports.WEBSERVER_URL = {
 };
 exports.WEBSERVER_ENDPOINTS = {
     default: {
+        /** @deprecated No backend route. Removed in the next major release. */
         hello: '/hello',
         protected: '/protected',
     },
@@ -75,6 +76,7 @@ exports.WEBSERVER_ENDPOINTS = {
     },
     subaccount: {
         list: (offset = 0, limit = 100) => `/subaccount?offset=${offset}&limit=${limit}`,
+        /** @deprecated No backend route. Removed in the next major release. */
         rewards: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/rewards`,
         tokens: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/tokens`,
         twap: {
@@ -85,6 +87,7 @@ exports.WEBSERVER_ENDPOINTS = {
         debank: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/debank`,
         health_factor: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/health_factor`,
         summary: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/summary`,
+        /** @deprecated No backend route. Removed in the next major release. */
         batch: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/tx_batcher_integrations`,
         loans: (subaccount, side = 'BOTH', active = true) => `/subaccount/${subaccountSegment(subaccount)}/loans?side=${side}&active=${active}`,
         cefi: (subaccount) => `/subaccount/${subaccountSegment(subaccount)}/cefi_position`,

package/lib/core/constants/swap-router.d.ts

@@ -108,6 +108,22 @@ export declare const SWAP_ROUTER_MAX_SWAPS = 9;
  * every dispatch. Used to validate that native-token deposits target a
  * vault whose reference asset is the wrapped native — the only configuration
  * the contract's `depositNativeToken` / `swapAndDepositNativeToken` accept.
+ *
+ * **Wrap-only, WETH-vaults-only limitation.** Both payable entry points on the
+ * deployed router (`depositNativeToken` and `swapAndDepositNativeToken`) only
+ * wrap native ETH to this address and deposit — neither has an ETH→other-asset
+ * swap leg. `swapAndDepositNativeToken`'s ABI takes no swap payload, so a DEX
+ * swap is structurally impossible on that path too; its only difference from
+ * `depositNativeToken` is applying the vault swap fee on the pure wrap. The
+ * practical consequence: **native ETH can only be deposited into a vault whose
+ * reference asset is this wrapped-native token** (e.g. a WETH-reference
+ * vault). 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, and it routes through the swap leg for a vault whose
+ * reference asset differs). True atomic ETH→any-asset support would require a
+ * contract change (a payable `swapAndDeposit` variant), which is out of scope
+ * for this SDK. Use {@link isNativeSwapRouterDepositSupported} to check a
+ * vault's eligibility for the native path before offering it in a UI.
  */
 export declare const SWAP_ROUTER_WRAPPED_NATIVE: Readonly<Record<number, IAddress>>;
 /**

package/lib/core/constants/swap-router.js

@@ -121,6 +121,22 @@ exports.SWAP_ROUTER_MAX_SWAPS = 9;
  * every dispatch. Used to validate that native-token deposits target a
  * vault whose reference asset is the wrapped native — the only configuration
  * the contract's `depositNativeToken` / `swapAndDepositNativeToken` accept.
+ *
+ * **Wrap-only, WETH-vaults-only limitation.** Both payable entry points on the
+ * deployed router (`depositNativeToken` and `swapAndDepositNativeToken`) only
+ * wrap native ETH to this address and deposit — neither has an ETH→other-asset
+ * swap leg. `swapAndDepositNativeToken`'s ABI takes no swap payload, so a DEX
+ * swap is structurally impossible on that path too; its only difference from
+ * `depositNativeToken` is applying the vault swap fee on the pure wrap. The
+ * practical consequence: **native ETH can only be deposited into a vault whose
+ * reference asset is this wrapped-native token** (e.g. a WETH-reference
+ * vault). 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, and it routes through the swap leg for a vault whose
+ * reference asset differs). True atomic ETH→any-asset support would require a
+ * contract change (a payable `swapAndDeposit` variant), which is out of scope
+ * for this SDK. Use {@link isNativeSwapRouterDepositSupported} to check a
+ * vault's eligibility for the native path before offering it in a UI.
  */
 exports.SWAP_ROUTER_WRAPPED_NATIVE = {
     1: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',

package/lib/core/errors/index.d.ts

@@ -15,7 +15,7 @@
  * ```
  */
 /** Stable error codes attached to SDK errors. */
-export type AugustErrorCode = 'AUTH_MISSING_KEY' | 'AUTH_INVALID_KEY' | 'AUTH_FORBIDDEN' | 'AUTH_UNAUTHORIZED' | 'INVALID_URL' | 'INVALID_INPUT' | 'INVALID_CHAIN' | 'INVALID_ADDRESS' | 'ACCOUNT_NOT_FUNDED' | 'NETWORK_ERROR' | 'TIMEOUT' | 'RATE_LIMITED' | 'SERVER_ERROR' | 'HISTORY_UNAVAILABLE' | 'UNKNOWN';
+export type AugustErrorCode = 'AUTH_MISSING_KEY' | 'AUTH_INVALID_KEY' | 'AUTH_FORBIDDEN' | 'AUTH_UNAUTHORIZED' | 'INVALID_URL' | 'INVALID_INPUT' | 'INVALID_CHAIN' | 'INVALID_ADDRESS' | 'ACCOUNT_NOT_FUNDED' | 'NETWORK_ERROR' | 'TIMEOUT' | 'RATE_LIMITED' | 'SERVER_ERROR' | 'HISTORY_UNAVAILABLE' | 'PRICE_UNAVAILABLE' | 'UNKNOWN';
 /** Options accepted by every SDK error constructor. */
 export interface AugustErrorOptions {
     /** Original error preserved for stack-trace chaining. */
@@ -110,5 +110,40 @@ export declare class AugustHistoryUnavailableError extends AugustSDKError {
      */
     constructor(message: string, options?: AugustErrorOptions);
 }
+/**
+ * The USD price needed to convert a computed value could not be resolved, so
+ * any USD figure derived from it would be fabricated rather than merely
+ * missing.
+ *
+ * Motivation — `getVaultUserLifetimePnl` used to substitute a price of `1`
+ * whenever the price server returned nothing, which reported every
+ * USD field of a non-dollar vault (lsETH, tETH, BTC) at $1 per asset: a
+ * position worth ~$40k read as ~$13, indistinguishable from a real result.
+ * Throwing this typed error makes a missing price explicit so callers can hide
+ * the USD value instead of displaying a wrong one.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await sdk.getVaultUserLifetimePnl({ vault, wallet, chainId });
+ * } catch (err) {
+ *   if (err instanceof AugustPriceUnavailableError) {
+ *     // No USD price for the vault asset — hide the USD figures rather than
+ *     // show a fabricated one.
+ *     hideUsd(err.context);
+ *   } else throw err;
+ * }
+ * ```
+ */
+export declare class AugustPriceUnavailableError extends AugustSDKError {
+    /**
+     * @param message - Human-readable description of the missing price. Callers
+     *   pass the same `#<method>::<vault>::<wallet>` prefix the surrounding getter
+     *   uses so log grouping stays consistent.
+     * @param options - Standard SDK error options. `context` should carry the
+     *   identifiers that scope the failure (e.g. `{ vault, wallet, asset }`).
+     */
+    constructor(message: string, options?: AugustErrorOptions);
+}
 /** Type guard. Works across realms (e.g. Web Worker / VM contexts). */
 export declare function isAugustSDKError(err: unknown): err is AugustSDKError;

package/lib/core/errors/index.js

@@ -16,7 +16,7 @@
  * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AugustHistoryUnavailableError = exports.AugustServerError = exports.AugustRateLimitError = exports.AugustValidationError = exports.AugustTimeoutError = exports.AugustNetworkError = exports.AugustAuthError = exports.AugustSDKError = void 0;
+exports.AugustPriceUnavailableError = exports.AugustHistoryUnavailableError = exports.AugustServerError = exports.AugustRateLimitError = exports.AugustValidationError = exports.AugustTimeoutError = exports.AugustNetworkError = exports.AugustAuthError = exports.AugustSDKError = void 0;
 exports.isAugustSDKError = isAugustSDKError;
 /** Base class for all SDK errors. */
 class AugustSDKError extends Error {
@@ -173,6 +173,45 @@ class AugustHistoryUnavailableError extends AugustSDKError {
     }
 }
 exports.AugustHistoryUnavailableError = AugustHistoryUnavailableError;
+/**
+ * The USD price needed to convert a computed value could not be resolved, so
+ * any USD figure derived from it would be fabricated rather than merely
+ * missing.
+ *
+ * Motivation — `getVaultUserLifetimePnl` used to substitute a price of `1`
+ * whenever the price server returned nothing, which reported every
+ * USD field of a non-dollar vault (lsETH, tETH, BTC) at $1 per asset: a
+ * position worth ~$40k read as ~$13, indistinguishable from a real result.
+ * Throwing this typed error makes a missing price explicit so callers can hide
+ * the USD value instead of displaying a wrong one.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await sdk.getVaultUserLifetimePnl({ vault, wallet, chainId });
+ * } catch (err) {
+ *   if (err instanceof AugustPriceUnavailableError) {
+ *     // No USD price for the vault asset — hide the USD figures rather than
+ *     // show a fabricated one.
+ *     hideUsd(err.context);
+ *   } else throw err;
+ * }
+ * ```
+ */
+class AugustPriceUnavailableError extends AugustSDKError {
+    /**
+     * @param message - Human-readable description of the missing price. Callers
+     *   pass the same `#<method>::<vault>::<wallet>` prefix the surrounding getter
+     *   uses so log grouping stays consistent.
+     * @param options - Standard SDK error options. `context` should carry the
+     *   identifiers that scope the failure (e.g. `{ vault, wallet, asset }`).
+     */
+    constructor(message, options) {
+        super('PRICE_UNAVAILABLE', message, options);
+        this.name = 'AugustPriceUnavailableError';
+    }
+}
+exports.AugustPriceUnavailableError = AugustPriceUnavailableError;
 /** Type guard. Works across realms (e.g. Web Worker / VM contexts). */
 function isAugustSDKError(err) {
     return (err instanceof AugustSDKError ||

package/lib/core/fetcher.d.ts

@@ -21,8 +21,8 @@ export type IFetchAugustOptions = {
     /** Per-request timeout in ms. Defaults to `REQUEST_TIMEOUT_MS`. */
     timeoutMs?: number;
     /**
-     * @deprecated Bypasses the API-key check for legacy unauthenticated endpoints.
-     * Will be removed in a future major version; pass a valid `apiKey` instead.
+     * @deprecated No longer has any effect: an absent `apiKey` already sends an
+     * anonymous request. Will be removed in a future major version; drop it.
      */
     override?: boolean;
 };
@@ -41,6 +41,19 @@ export declare function setSdkRequestTimeout(ms?: number | null): void;
  * otherwise the compiled-in `REQUEST_TIMEOUT_MS`.
  */
 export declare function getSdkRequestTimeout(): number;
+/**
+ * Record the consuming application's `appName` so every request to the
+ * August backend carries it as `x-august-app`, next to
+ * `x-august-sdk-version`. This gives the backend per-integrator request
+ * counts that do not depend on Sentry sampling.
+ *
+ * Process-global, last writer wins — the same contract as
+ * `setSdkRequestTimeout` and `setPublicApiBaseUrl`. The `AugustSDK`
+ * constructor calls this with its validated `appName`.
+ *
+ * @param appName - Validated app-name slug, or `null` to stop sending it.
+ */
+export declare function setSdkAppName(appName?: string | null): void;
 /**
  * Override the base URL used for `WEBSERVER_URL.public` requests — the
  * unauthenticated vault-catalog API that `getVault` / `fetchTokenizedVault`
@@ -79,15 +92,21 @@ export declare function getPublicApiBaseUrl(): string;
 import { CACHE, getSafeCache, setSafeCache } from './cache';
 export { CACHE, getSafeCache, setSafeCache };
 /**
- * Make authenticated requests to August backend services using API key.
+ * Make requests to August backend services, sending an API key when one is
+ * configured. Many backend routes — vault-linked sub-account reads, the two
+ * collateral risk routes, timelock requests — answer anonymous callers, so a
+ * missing key is not an error here: the request goes out without the
+ * `x-api-key` header and the backend decides. Routes that do require a key
+ * answer `401`, which surfaces as an `AugustAuthError` with code
+ * `AUTH_UNAUTHORIZED`.
  * Automatically logs errors with correlation IDs for debugging.
- * @param apiKey - August API key for authentication
+ * @param apiKey - August API key, or `undefined` for an anonymous request
  * @param relativeUrl - Endpoint path relative to base URL
  * @param options - Request configuration including method and headers
  * @returns Response object if successful
  * @throws Error with correlation ID if request fails
  */
-export declare function fetchAugustWithKey(apiKey: string, relativeUrl: string, options?: IFetchAugustOptions): Promise<Response>;
+export declare function fetchAugustWithKey(apiKey: string | undefined, relativeUrl: string, options?: IFetchAugustOptions): Promise<Response>;
 /**
  * Make unauthenticated requests to August public API endpoints.
  * Used for fetching vault metadata and public market data.

package/lib/core/fetcher.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setSafeCache = exports.getSafeCache = exports.CACHE = void 0;
 exports.setSdkRequestTimeout = setSdkRequestTimeout;
 exports.getSdkRequestTimeout = getSdkRequestTimeout;
+exports.setSdkAppName = setSdkAppName;
 exports.setPublicApiBaseUrl = setPublicApiBaseUrl;
 exports.getPublicApiBaseUrl = getPublicApiBaseUrl;
 exports.fetchAugustWithKey = fetchAugustWithKey;
@@ -32,6 +33,7 @@ const core_2 = require("./constants/core");
 const vault_version_1 = require("./helpers/vault-version");
 const analytics_1 = require("./analytics");
 const sanitize_1 = require("./analytics/sanitize");
+const sentry_1 = require("./analytics/sentry");
 const errors_1 = require("./errors");
 /** Map an HTTP status to the appropriate typed SDK error subclass. */
 function errorFromResponseStatus(status, message, options) {
@@ -76,6 +78,34 @@ function setSdkRequestTimeout(ms = null) {
 function getSdkRequestTimeout() {
     return SDK_REQUEST_TIMEOUT_OVERRIDE ?? core_2.REQUEST_TIMEOUT_MS;
 }
+let SDK_APP_NAME = null;
+/**
+ * Record the consuming application's `appName` so every request to the
+ * August backend carries it as `x-august-app`, next to
+ * `x-august-sdk-version`. This gives the backend per-integrator request
+ * counts that do not depend on Sentry sampling.
+ *
+ * Process-global, last writer wins — the same contract as
+ * `setSdkRequestTimeout` and `setPublicApiBaseUrl`. The `AugustSDK`
+ * constructor calls this with its validated `appName`.
+ *
+ * @param appName - Validated app-name slug, or `null` to stop sending it.
+ */
+function setSdkAppName(appName = null) {
+    SDK_APP_NAME = appName;
+}
+/**
+ * Client-identification headers merged into every backend fetcher's
+ * defaults. Both values are low-cardinality slugs, never credentials.
+ */
+function sdkClientHeaders() {
+    const headers = {
+        'x-august-sdk-version': (0, sentry_1.getSDKVersion)(),
+    };
+    if (SDK_APP_NAME)
+        headers['x-august-app'] = SDK_APP_NAME;
+    return headers;
+}
 let PUBLIC_API_BASE_OVERRIDE = null;
 /**
  * Override the base URL used for `WEBSERVER_URL.public` requests — the
@@ -228,7 +258,7 @@ function warnOverrideDeprecation(callerTag) {
     // notice must surface in the integrator's console in every environment.
     // Logger.log.warn would downgrade it to a prod-silent Sentry breadcrumb.
     // biome-ignore lint/suspicious/noConsole: integrator-facing deprecation notice must surface in every environment; Logger.log.warn would downgrade it to a prod-silent Sentry breadcrumb.
-    console.warn(`[@augustdigital/sdk] ${callerTag}: option "override" is deprecated and will be removed in a future major version. Pass a valid apiKey instead.`);
+    console.warn(`[@augustdigital/sdk] ${callerTag}: option "override" is deprecated and has no effect — an absent apiKey already sends an anonymous request. It will be removed in a future major version; drop it.`);
 }
 /**
  * LRU cache for API responses and frequently accessed data.
@@ -354,9 +384,15 @@ function buildAugustUrl(server, relativeUrl) {
     return url.toString();
 }
 /**
- * Make authenticated requests to August backend services using API key.
+ * Make requests to August backend services, sending an API key when one is
+ * configured. Many backend routes — vault-linked sub-account reads, the two
+ * collateral risk routes, timelock requests — answer anonymous callers, so a
+ * missing key is not an error here: the request goes out without the
+ * `x-api-key` header and the backend decides. Routes that do require a key
+ * answer `401`, which surfaces as an `AugustAuthError` with code
+ * `AUTH_UNAUTHORIZED`.
  * Automatically logs errors with correlation IDs for debugging.
- * @param apiKey - August API key for authentication
+ * @param apiKey - August API key, or `undefined` for an anonymous request
  * @param relativeUrl - Endpoint path relative to base URL
  * @param options - Request configuration including method and headers
  * @returns Response object if successful
@@ -366,11 +402,9 @@ async function fetchAugustWithKey(apiKey, relativeUrl, options) {
     if (options?.override) {
         warnOverrideDeprecation('fetchAugustWithKey');
     }
-    if (!apiKey && !options?.override) {
-        throw new errors_1.AugustAuthError('AUTH_MISSING_KEY', 'fetchAugustWithKey: apiKey is required (set keys.august on the SDK constructor, or pass an explicit apiKey).');
-    }
     const defaultHeaders = {
-        'x-api-key': apiKey,
+        ...sdkClientHeaders(),
+        ...(apiKey ? { 'x-api-key': apiKey } : {}),
         'content-type': 'application/json',
         accept: 'application/json',
     };
@@ -426,6 +460,7 @@ async function fetchAugustWithKey(apiKey, relativeUrl, options) {
  */
 async function fetchAugustPublic(relativeUrl, options) {
     const defaultHeaders = {
+        ...sdkClientHeaders(),
         'content-type': 'application/json',
         accept: 'application/json',
     };
@@ -480,6 +515,7 @@ async function fetchAugustPublic(relativeUrl, options) {
  */
 async function fetchAugustWithBearer(bearerToken, relativeUrl, options) {
     const defaultHeaders = {
+        ...sdkClientHeaders(),
         authorization: `Bearer ${bearerToken}`,
         'content-type': 'application/json',
         accept: 'application/json',

package/lib/main.d.ts

@@ -355,6 +355,12 @@ export declare class AugustSDK extends AugustBase {
      * Calculates realized and unrealized PnL based on deposit/withdrawal history and current position.
      * @param props - Vault address, wallet address, and optional chain ID
      * @returns Lifetime PnL data including realized and unrealized PnL in both native token and USD
+     * @throws {@link AugustHistoryUnavailableError} (`HISTORY_UNAVAILABLE`) when a
+     *   live position has no indexed deposits, withdrawals or priceable share
+     *   transfers.
+     * @throws {@link AugustPriceUnavailableError} (`PRICE_UNAVAILABLE`) when the
+     *   vault's underlying asset has no USD price — the USD fields are never
+     *   computed from a stand-in price.
      */
     getVaultUserLifetimePnl(props: {
         vault: IAddress;

package/lib/main.js

@@ -430,6 +430,12 @@ class AugustSDK extends core_1.AugustBase {
      * Calculates realized and unrealized PnL based on deposit/withdrawal history and current position.
      * @param props - Vault address, wallet address, and optional chain ID
      * @returns Lifetime PnL data including realized and unrealized PnL in both native token and USD
+     * @throws {@link AugustHistoryUnavailableError} (`HISTORY_UNAVAILABLE`) when a
+     *   live position has no indexed deposits, withdrawals or priceable share
+     *   transfers.
+     * @throws {@link AugustPriceUnavailableError} (`PRICE_UNAVAILABLE`) when the
+     *   vault's underlying asset has no USD price — the USD fields are never
+     *   computed from a stand-in price.
      */
     async getVaultUserLifetimePnl(props) {
         return await this.vaults.getVaultUserLifetimePnl(props);

package/lib/modules/api/main.d.ts

@@ -54,9 +54,10 @@ export declare class AugustApi extends AugustBase {
      * token.
      *
      * Backed by `GET /risk/collateral_excess_or_deficit` (60-second server-side
-     * cache), which resolves the subaccount and reads its current health factor,
-     * so an authenticated (admin-scoped) August API key is required. Makes
-     * exactly one HTTP request and no RPC calls.
+     * cache), which resolves the subaccount and reads its current health factor.
+     * The backend serves this route to anonymous callers today, so no August API
+     * key is needed; pass one if you get `AUTH_UNAUTHORIZED`. Makes exactly one
+     * HTTP request and no RPC calls.
      *
      * @param params.subaccount Subaccount (smart-contract wallet) address.
      * @param params.tokenAddress Collateral token address to evaluate.
@@ -86,9 +87,8 @@ export declare class AugustApi extends AugustBase {
      * This is a pure, read-only simulation: the backend `POST
      * /risk/collateral_simulation` endpoint (60-second server-side cache)
      * computes required collateral and effective discount factors and changes
-     * no state. It runs against the authenticated backend, so an
-     * (admin-scoped) August API key is required. Makes exactly one HTTP request
-     * and no RPC calls.
+     * no state. The route is public, so no August API key is needed. Makes
+     * exactly one HTTP request and no RPC calls.
      *
      * @param input Simulation parameters — see {@link ICollateralSimulationInput}. `collateral_tokens` and `collateral_token_allocation` must be non-empty and equal length; when `on_platform` is `true`, both `loan_redeployed_token_*` fields are required.
      * @returns The simulated {@link ICollateralSimulationResults}: total debt, required collateral, resulting health factor, and a per-token breakdown.

package/lib/modules/api/main.js

@@ -204,9 +204,10 @@ class AugustApi extends base_class_1.AugustBase {
      * token.
      *
      * Backed by `GET /risk/collateral_excess_or_deficit` (60-second server-side
-     * cache), which resolves the subaccount and reads its current health factor,
-     * so an authenticated (admin-scoped) August API key is required. Makes
-     * exactly one HTTP request and no RPC calls.
+     * cache), which resolves the subaccount and reads its current health factor.
+     * The backend serves this route to anonymous callers today, so no August API
+     * key is needed; pass one if you get `AUTH_UNAUTHORIZED`. Makes exactly one
+     * HTTP request and no RPC calls.
      *
      * @param params.subaccount Subaccount (smart-contract wallet) address.
      * @param params.tokenAddress Collateral token address to evaluate.
@@ -244,9 +245,8 @@ class AugustApi extends base_class_1.AugustBase {
      * This is a pure, read-only simulation: the backend `POST
      * /risk/collateral_simulation` endpoint (60-second server-side cache)
      * computes required collateral and effective discount factors and changes
-     * no state. It runs against the authenticated backend, so an
-     * (admin-scoped) August API key is required. Makes exactly one HTTP request
-     * and no RPC calls.
+     * no state. The route is public, so no August API key is needed. Makes
+     * exactly one HTTP request and no RPC calls.
      *
      * @param input Simulation parameters — see {@link ICollateralSimulationInput}. `collateral_tokens` and `collateral_token_allocation` must be non-empty and equal length; when `on_platform` is `true`, both `loan_redeployed_token_*` fields are required.
      * @returns The simulated {@link ICollateralSimulationResults}: total debt, required collateral, resulting health factor, and a per-token breakdown.

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

@@ -4,7 +4,13 @@ import type { IAddress, ILoanBookInfo, ISubaccountDebank, ISubaccountTransaction
  * Subaccount operation class interacting with August Subaccounts
  * Subaccount is a smart contract wallet that serves as the fundamental infrastructure for August's platform.
  * It functions as a cross-margin account designed for optimal capital efficiency.
- * Most of the operations require a August API key to perform
+ *
+ * `getSubaccountSummary`, `getSubaccountHealthFactor`, `getSubaccountLoans`,
+ * `getSubaccountCefiPositions` and `getSubaccountOtcPositions` work without an
+ * August API key for subaccounts linked to a vault; `getSubaccountDebank` is
+ * public. `getSubaccountTransactions` needs a key authorized for the
+ * subaccount, and `getAllSubaccounts` and `getSubaccountLoanByAddress` need an
+ * admin key.
  */
 export declare class AugustSubAccounts extends AugustBase {
     private headers;

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

@@ -25,7 +25,13 @@ function assertSubaccountAddress(address, method) {
  * Subaccount operation class interacting with August Subaccounts
  * Subaccount is a smart contract wallet that serves as the fundamental infrastructure for August's platform.
  * It functions as a cross-margin account designed for optimal capital efficiency.
- * Most of the operations require a August API key to perform
+ *
+ * `getSubaccountSummary`, `getSubaccountHealthFactor`, `getSubaccountLoans`,
+ * `getSubaccountCefiPositions` and `getSubaccountOtcPositions` work without an
+ * August API key for subaccounts linked to a vault; `getSubaccountDebank` is
+ * public. `getSubaccountTransactions` needs a key authorized for the
+ * subaccount, and `getAllSubaccounts` and `getSubaccountLoanByAddress` need an
+ * admin key.
  */
 class AugustSubAccounts extends core_1.AugustBase {
     headers = null;