@augustdigital/sdk 9.6.0 → 9.7.1

package/README.md

@@ -36,7 +36,7 @@ const sdk = new AugustSDK({
     -1: 'https://api.mainnet-beta.solana.com', // Solana
   },
   keys: {
-    august: 'YOUR_API_KEY', // Optional: required for allocations, health factors, and sub-account operations
+    august: 'YOUR_API_KEY', // Optional: vault reads, allocations and vault-linked sub-account reads work without it
   },
   monitoring: {
     env: 'DEV', // Optional: 'DEV' enables console logging (defaults to 'PROD')

package/lib/adapters/solana/types.d.ts

@@ -85,6 +85,10 @@ export interface ISolanaDepositOptions {
      * Skips the quote and the single snapshot read it needs. `0n` restores the
      * unguarded behaviour of the plain `deposit` instruction.
      *
+     * When the handler's `idl` predates `deposit_checked`, a non-zero floor or
+     * any `slippageBps` throws {@link AugustValidationError} instead of being
+     * silently dropped; with neither, the plain `deposit` is sent.
+     *
      * Must be a `bigint` in `0 .. 2^64-1`; anything else throws
      * {@link AugustValidationError} before the transaction is built.
      */
@@ -107,6 +111,10 @@ export interface ISolanaRedeemOptions {
      * Explicit floor in raw deposit-mint units, net of the withdrawal fee,
      * passed to `redeem_checked` as is. Skips the quote. `0n` restores the
      * unguarded behaviour of the plain `redeem` instruction.
+     *
+     * When the handler's `idl` predates `redeem_checked`, a non-zero floor or
+     * any `slippageBps` throws {@link AugustValidationError} instead of being
+     * silently dropped; with neither, the plain `redeem` is sent.
      */
     minAssetsOut?: bigint;
 }

package/lib/adapters/solana/vault.actions.d.ts

@@ -55,7 +55,9 @@ export declare function slippageHint(e: unknown): string;
  *   is given, the vault state and share mint are read to quote the shares this
  *   deposit should mint, and that quote lowered by `options.slippageBps`
  *   (default {@link DEFAULT_SLIPPAGE_BPS}) is passed as the floor; the program
- *   reverts with `SlippageExceeded` if execution would mint fewer.
+ *   reverts with `SlippageExceeded` if execution would mint fewer. An `idl`
+ *   that predates `deposit_checked` gets the plain `deposit` with no floor,
+ *   unless `options` asks for one — then it throws {@link AugustValidationError}.
  */
 export declare function handleSolanaDeposit({ provider, connection, network, vaultProgramId, vaultAddress, depositAmount, publicKey, idl, options, }: {
     vaultProgramId: PublicKey | string;
@@ -83,6 +85,9 @@ export declare function handleSolanaDeposit({ provider, connection, network, vau
  *   handler already reads, **net of the withdrawal fee**, and that quote
  *   lowered by `options.slippageBps` (default {@link DEFAULT_SLIPPAGE_BPS}) is
  *   passed as the floor; the program reverts with `SlippageExceeded` below it.
+ *   An `idl` that predates `redeem_checked` gets the plain `redeem` with no
+ *   floor, unless `options` asks for one — then it throws
+ *   {@link AugustValidationError}.
  * @throws AugustValidationError on missing wallet/programId or invalid amount,
  *   or when the wallet holds fewer shares than `redeemShares`.
  * @throws AugustSDKError when a candidate token account's balance cannot be

package/lib/adapters/solana/vault.actions.js

@@ -99,6 +99,52 @@ function validateExplicitFloor(value, label) {
     }
     return value;
 }
+/**
+ * Decide whether a handler can send the slippage-checked instruction, or must
+ * fall back to the plain one.
+ *
+ * `idl` is caller-supplied, and an IDL generated before the program shipped
+ * `deposit_checked` / `redeem_checked` produces a `Program` with no such
+ * method. Until 9.4.0 the handlers sent the plain instructions, so those same
+ * inputs used to work; calling the checked method on them throws a TypeError
+ * before anything is sent (AUGUST-8023). The program still accepts the plain
+ * instructions, with the behaviour a floor of `0` gives the checked ones, so
+ * falling back preserves what those callers had.
+ *
+ * The fallback is refused when the caller asked for protection — a non-zero
+ * explicit floor, or any `slippageBps` — since the plain instruction would
+ * silently drop it. An explicit floor of `0n` is the documented "no floor" and
+ * falls back.
+ *
+ * Probes `program.methods` rather than `idl.instructions`: that is the object
+ * the handler calls, and it already reflects Anchor's camelCase conversion.
+ *
+ * @param program - Anchor program built from the caller's IDL.
+ * @param checkedMethod - `'depositChecked'` or `'redeemChecked'`.
+ * @param floor - The caller's explicit `minSharesOut` / `minAssetsOut`, if any.
+ * @param slippageBps - The caller's tolerance, if any.
+ * @param handler - Handler name, for the log line and the error.
+ * @returns `true` to send the checked instruction, `false` for the plain one.
+ * @throws {@link AugustValidationError} when the IDL lacks the checked
+ *   instruction and the caller asked for a floor.
+ */
+function sendsCheckedInstruction({ program, checkedMethod, floor, slippageBps, handler, }) {
+    const methods = program.methods;
+    if (typeof methods[checkedMethod] === 'function')
+        return true;
+    const instruction = checkedMethod === 'depositChecked' ? 'deposit_checked' : 'redeem_checked';
+    const floorOption = checkedMethod === 'depositChecked' ? 'minSharesOut' : 'minAssetsOut';
+    if ((floor !== undefined && floor !== 0n) || slippageBps !== undefined) {
+        throw new core_1.AugustValidationError('INVALID_INPUT', `${handler}: the supplied IDL does not declare \`${instruction}\`, so ` +
+            `the requested ${floorOption} / slippageBps cannot be enforced. Pass ` +
+            "the SDK's bundled IDL (`Solana.constants.vaultIdl`), or omit both " +
+            'options to send the unguarded instruction.');
+    }
+    core_1.Logger.log.warn(handler, `Supplied IDL does not declare \`${instruction}\`; sending the plain ` +
+        "instruction without a slippage floor. Pass the SDK's bundled IDL to " +
+        'enable slippage protection.');
+    return false;
+}
 /**
  * The vault state and share-mint supply as of a **single slot**.
  *
@@ -265,7 +311,9 @@ async function resolveUserTokenAccountPair({ connection, owner, mints, }) {
  *   is given, the vault state and share mint are read to quote the shares this
  *   deposit should mint, and that quote lowered by `options.slippageBps`
  *   (default {@link DEFAULT_SLIPPAGE_BPS}) is passed as the floor; the program
- *   reverts with `SlippageExceeded` if execution would mint fewer.
+ *   reverts with `SlippageExceeded` if execution would mint fewer. An `idl`
+ *   that predates `deposit_checked` gets the plain `deposit` with no floor,
+ *   unless `options` asks for one — then it throws {@link AugustValidationError}.
  */
 async function handleSolanaDeposit({ provider, connection, network = constants_1.fallbackNetwork, vaultProgramId, vaultAddress, depositAmount, publicKey, idl, options = {}, }) {
     try {
@@ -281,6 +329,21 @@ async function handleSolanaDeposit({ provider, connection, network = constants_1
         // Before any RPC: an unusable floor should cost the caller nothing.
         if (options.minSharesOut !== undefined)
             validateExplicitFloor(options.minSharesOut, 'minSharesOut');
+        const _vaultProgramId = new web3_js_1.PublicKey(vaultProgramId);
+        const program = utils_1.SolanaUtils.getProgram({
+            provider,
+            idl,
+            programId: _vaultProgramId.toBase58(),
+        });
+        // Also before any RPC: a floor the caller's IDL cannot enforce is refused
+        // on the spot rather than after the mint and token-account reads.
+        const checked = sendsCheckedInstruction({
+            program,
+            checkedMethod: 'depositChecked',
+            floor: options.minSharesOut,
+            slippageBps: options.slippageBps,
+            handler: 'handleSolanaDeposit',
+        });
         const { depositMint, shareMint, vaultVersion } = await utils_1.SolanaUtils.getVaultMints({
             network,
             connection,
@@ -291,14 +354,8 @@ async function handleSolanaDeposit({ provider, connection, network = constants_1
         if (!depositMint || !shareMint) {
             throw new Error('Failed to read vault mints from on-chain state');
         }
-        const _vaultProgramId = new web3_js_1.PublicKey(vaultProgramId);
         const _publicKey = new web3_js_1.PublicKey(publicKey);
         const _depositMint = new web3_js_1.PublicKey(depositMint);
-        const program = utils_1.SolanaUtils.getProgram({
-            provider,
-            idl,
-            programId: _vaultProgramId.toBase58(),
-        });
         core_1.Logger.log.info('handleSolanaDeposit', 'Program', program);
         const vaultStatePda = vaultAddress
             ? new web3_js_1.PublicKey(vaultAddress)
@@ -394,7 +451,10 @@ async function handleSolanaDeposit({ provider, connection, network = constants_1
         core_1.Logger.log.info('handleSolanaDeposit', 'Deposit mint', _depositMint?.toBase58());
         core_1.Logger.log.info('handleSolanaDeposit', 'Signer', _publicKey.toBase58());
         let minSharesOut;
-        if (options.minSharesOut !== undefined) {
+        if (!checked) {
+            // The plain instruction takes no floor, so there is nothing to quote.
+        }
+        else if (options.minSharesOut !== undefined) {
             minSharesOut = options.minSharesOut;
         }
         else {
@@ -417,9 +477,11 @@ async function handleSolanaDeposit({ provider, connection, network = constants_1
                 slippageBps: options.slippageBps ?? pricing_1.DEFAULT_SLIPPAGE_BPS,
             });
         }
-        core_1.Logger.log.info('handleSolanaDeposit', 'Min shares out (raw)', minSharesOut.toString());
-        const tx = await program.methods
-            .depositChecked(depositAmountRaw, new anchor_1.BN(minSharesOut.toString()))
+        core_1.Logger.log.info('handleSolanaDeposit', 'Min shares out (raw)', minSharesOut?.toString() ?? 'none (plain deposit)');
+        const methods = program.methods;
+        const tx = await (minSharesOut === undefined
+            ? methods.deposit(depositAmountRaw)
+            : methods.depositChecked(depositAmountRaw, new anchor_1.BN(minSharesOut.toString())))
             .accounts({
             vaultState: vaultStatePda,
             vaultTokenAta: vaultTokenAtaPda,
@@ -478,6 +540,9 @@ async function handleSolanaDeposit({ provider, connection, network = constants_1
  *   handler already reads, **net of the withdrawal fee**, and that quote
  *   lowered by `options.slippageBps` (default {@link DEFAULT_SLIPPAGE_BPS}) is
  *   passed as the floor; the program reverts with `SlippageExceeded` below it.
+ *   An `idl` that predates `redeem_checked` gets the plain `redeem` with no
+ *   floor, unless `options` asks for one — then it throws
+ *   {@link AugustValidationError}.
  * @throws AugustValidationError on missing wallet/programId or invalid amount,
  *   or when the wallet holds fewer shares than `redeemShares`.
  * @throws AugustSDKError when a candidate token account's balance cannot be
@@ -503,6 +568,20 @@ async function handleSolanaRedeem({ provider, connection, vaultProgramId, vaultA
         // Before any RPC: an unusable floor should cost the caller nothing.
         if (options.minAssetsOut !== undefined)
             validateExplicitFloor(options.minAssetsOut, 'minAssetsOut');
+        const _vaultProgramId = new web3_js_1.PublicKey(vaultProgramId);
+        const program = utils_1.SolanaUtils.getProgram({
+            provider,
+            idl,
+            programId: _vaultProgramId.toBase58(),
+        });
+        // See `handleSolanaDeposit`: refused before any RPC.
+        const checked = sendsCheckedInstruction({
+            program,
+            checkedMethod: 'redeemChecked',
+            floor: options.minAssetsOut,
+            slippageBps: options.slippageBps,
+            handler: 'handleSolanaRedeem',
+        });
         const { depositMint, shareMint, vaultVersion } = await utils_1.SolanaUtils.getVaultMints({
             network: provider.connection.rpcEndpoint.includes('devnet')
                 ? 'devnet'
@@ -515,14 +594,8 @@ async function handleSolanaRedeem({ provider, connection, vaultProgramId, vaultA
         if (!depositMint || !shareMint) {
             throw new Error('Failed to read vault mints from on-chain state');
         }
-        const _vaultProgramId = new web3_js_1.PublicKey(vaultProgramId);
         const _depositMint = new web3_js_1.PublicKey(depositMint);
         const _publicKey = new web3_js_1.PublicKey(publicKey);
-        const program = utils_1.SolanaUtils.getProgram({
-            provider,
-            idl,
-            programId: _vaultProgramId.toBase58(),
-        });
         const vaultStatePda = vaultAddress
             ? new web3_js_1.PublicKey(vaultAddress)
             : utils_1.SolanaUtils.deriveVaultStatePda(_vaultProgramId);
@@ -598,7 +671,10 @@ async function handleSolanaRedeem({ provider, connection, vaultProgramId, vaultA
         // No extra reads here: the share mint (supply) and vault state (assets,
         // offset, fee, fee recipient) came from the snapshot above.
         let minAssetsOut;
-        if (options.minAssetsOut !== undefined) {
+        if (!checked) {
+            // The plain instruction takes no floor, so there is nothing to quote.
+        }
+        else if (options.minAssetsOut !== undefined) {
             minAssetsOut = options.minAssetsOut;
         }
         else {
@@ -639,9 +715,11 @@ async function handleSolanaRedeem({ provider, connection, vaultProgramId, vaultA
         core_1.Logger.log.info('handleSolanaRedeem', 'Share mint:', shareMintAddr.toBase58());
         core_1.Logger.log.info('handleSolanaRedeem', 'Deposit mint:', _depositMint?.toBase58());
         core_1.Logger.log.info('handleSolanaRedeem', 'Signer:', _publicKey.toBase58());
-        core_1.Logger.log.info('handleSolanaRedeem', 'Min assets out, net of fee (raw):', minAssetsOut.toString());
-        const tx = await program.methods
-            .redeemChecked(redeemSharesRaw, new anchor_1.BN(minAssetsOut.toString()))
+        core_1.Logger.log.info('handleSolanaRedeem', 'Min assets out, net of fee (raw):', minAssetsOut?.toString() ?? 'none (plain redeem)');
+        const methods = program.methods;
+        const tx = await (minAssetsOut === undefined
+            ? methods.redeem(redeemSharesRaw)
+            : methods.redeemChecked(redeemSharesRaw, new anchor_1.BN(minAssetsOut.toString())))
             .accounts({
             vaultState: vaultStatePda,
             vaultDepositAta: vaultTokenAtaPda,

package/lib/core/analytics/sanitize.d.ts

@@ -12,6 +12,19 @@ export declare function sanitizeString(input: string): string;
  * …), and `cause`. Subclass constructors are NOT invoked — they may have
  * positional signatures (`new AugustAuthError(code, message, opts)`) that would
  * misalign if we naively passed the sanitized message as the first arg.
+ *
+ * Every write onto the clone goes through `Object.defineProperty` rather than
+ * assignment: the clone inherits `err`'s prototype, and some libraries make
+ * properties read-only there — `@solana/web3.js` defines `name` as non-writable
+ * on its error classes (`TransactionExpiredTimeoutError`, …). Assigning to an
+ * inherited non-writable property throws a `TypeError` in strict mode, which
+ * would escape from inside a caller's `catch` (e.g. `Logger.log.error`) and
+ * replace the error being reported. Defining an own property shadows the
+ * prototype's instead; each one is writable, configurable and enumerable,
+ * exactly as the plain assignment used to create it.
+ *
+ * @param err - Any caught value; non-`Error` values are returned unchanged.
+ * @returns A redacted clone for `Error` instances, otherwise `err` itself.
  */
 export declare function sanitizeError(err: unknown): unknown;
 /** Sanitize arbitrary log input (strings, errors, objects, arrays, primitives). */

package/lib/core/analytics/sanitize.js

@@ -72,30 +72,42 @@ function sanitizeString(input) {
  * …), and `cause`. Subclass constructors are NOT invoked — they may have
  * positional signatures (`new AugustAuthError(code, message, opts)`) that would
  * misalign if we naively passed the sanitized message as the first arg.
+ *
+ * Every write onto the clone goes through `Object.defineProperty` rather than
+ * assignment: the clone inherits `err`'s prototype, and some libraries make
+ * properties read-only there — `@solana/web3.js` defines `name` as non-writable
+ * on its error classes (`TransactionExpiredTimeoutError`, …). Assigning to an
+ * inherited non-writable property throws a `TypeError` in strict mode, which
+ * would escape from inside a caller's `catch` (e.g. `Logger.log.error`) and
+ * replace the error being reported. Defining an own property shadows the
+ * prototype's instead; each one is writable, configurable and enumerable,
+ * exactly as the plain assignment used to create it.
+ *
+ * @param err - Any caught value; non-`Error` values are returned unchanged.
+ * @returns A redacted clone for `Error` instances, otherwise `err` itself.
  */
 function sanitizeError(err) {
     if (!(err instanceof Error))
         return err;
     const safe = Object.create(Object.getPrototypeOf(err));
+    const define = (key, value) => Object.defineProperty(safe, key, {
+        value,
+        writable: true,
+        configurable: true,
+        enumerable: true,
+    });
     for (const key of Object.getOwnPropertyNames(err)) {
         const value = err[key];
-        if (key === 'message' && typeof value === 'string') {
-            safe[key] = sanitizeString(value);
-        }
-        else if (key === 'stack' && typeof value === 'string') {
-            safe[key] = sanitizeString(value);
-        }
-        else {
-            safe[key] = value;
-        }
+        const redact = (key === 'message' || key === 'stack') && typeof value === 'string';
+        define(key, redact ? sanitizeString(value) : value);
     }
     if (!safe.message && typeof err.message === 'string') {
-        safe.message = sanitizeString(err.message);
+        define('message', sanitizeString(err.message));
     }
     if (!safe.stack && typeof err.stack === 'string') {
-        safe.stack = sanitizeString(err.stack);
+        define('stack', sanitizeString(err.stack));
     }
-    safe.name = err.name;
+    define('name', err.name);
     return safe;
 }
 /** Sanitize arbitrary log input (strings, errors, objects, arrays, primitives). */

package/lib/core/analytics/version.d.ts

@@ -3,4 +3,4 @@
  * Generated during publish from package.json version
  * This file is gitignored and created at publish time
  */
-export declare const SDK_VERSION = "9.6.0";
+export declare const SDK_VERSION = "9.7.1";

package/lib/core/analytics/version.js

@@ -6,5 +6,5 @@ exports.SDK_VERSION = void 0;
  * Generated during publish from package.json version
  * This file is gitignored and created at publish time
  */
-exports.SDK_VERSION = '9.6.0';
+exports.SDK_VERSION = '9.7.1';
 //# sourceMappingURL=version.js.map

package/lib/core/auth/verify.js

@@ -15,8 +15,8 @@ async function verifyInfuraKey(key) {
 }
 async function verifyAugustKey(key) {
     // Fast path: no key means no verification possible. Returning false here
-    // preserves the historical contract (`init()` throws a generic "API key is invalid")
-    // and avoids letting an AUTH_MISSING_KEY error bubble up from the fetcher.
+    // preserves the historical contract (`init()` throws a generic "API key is
+    // invalid") and saves a request the backend would reject with a 401.
     if (!key)
         return false;
     try {

package/lib/core/base.class.d.ts

@@ -63,7 +63,13 @@ export interface IAugustBase {
     providers?: IProvidersConfig;
     solana?: ISolanaConfig;
     stellar?: IStellarConfig;
-    keys: IKeys;
+    /**
+     * Provider keys. Optional: vault reads and vault-linked sub-account reads
+     * work without an August key. Supply `august` for admin and curator methods,
+     * for authenticated-user reads such as `getDiscountFactors`, and for
+     * sub-account reads where the subaccount is not linked to a vault.
+     */
+    keys?: IKeys;
     monitoring?: IMonitoring;
     /** Analytics configuration. Enabled by default (opt-out model). */
     analytics?: IAnalyticsConfig;
@@ -149,6 +155,7 @@ export declare class AugustBase {
     constructor({ appName, providers, keys, monitoring, analytics, versionCheck, timeoutMs, publicApiBaseUrl, attribution, }: IAugustBase);
     /**
      * Verify the configured August API key and mark this instance as authorized.
+     * Only for SDKs built with `keys.august`; a keyless SDK skips `init()`.
      * @throws Error when `keys.august` is missing or rejected by the API.
      */
     init(): Promise<void>;

package/lib/core/base.class.js

@@ -46,7 +46,9 @@ class AugustBase {
                 rpcUrl: Object.values(providers)[0],
             };
         }
-        this.keys = keys;
+        // Default to an empty set so the api and sub-account modules can read
+        // `this.keys.august` (undefined) instead of throwing on a keyless SDK.
+        this.keys = keys ?? {};
         // Set environment (defaults to PROD for safety)
         const environment = monitoring?.env || monitoring?.['x-environment'] || 'PROD';
         this.monitoring = {
@@ -91,6 +93,7 @@ class AugustBase {
     }
     /**
      * Verify the configured August API key and mark this instance as authorized.
+     * Only for SDKs built with `keys.august`; a keyless SDK skips `init()`.
      * @throws Error when `keys.august` is missing or rejected by the API.
      */
     async init() {

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;
 };
@@ -92,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

@@ -258,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.
@@ -384,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
@@ -396,12 +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 = {
         ...sdkClientHeaders(),
-        'x-api-key': apiKey,
+        ...(apiKey ? { 'x-api-key': apiKey } : {}),
         'content-type': 'application/json',
         accept: 'application/json',
     };

package/lib/main.d.ts

@@ -356,7 +356,8 @@ export declare class AugustSDK extends AugustBase {
      * @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 or withdrawals.
+     *   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.

package/lib/main.js

@@ -431,7 +431,8 @@ class AugustSDK extends core_1.AugustBase {
      * @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 or withdrawals.
+     *   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.

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;