upshift-finance 1.0.0

package/lib/modules/api/main.js

@@ -0,0 +1,479 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AugustApi = void 0;
+const ethers_1 = require("ethers");
+const fetcher_1 = require("./fetcher");
+const base_class_1 = require("../../core/base.class");
+const core_1 = require("../../core/constants/core");
+const errors_1 = require("../../core/errors");
+const fetcher_2 = require("../../core/fetcher");
+const chain_address_1 = require("../../core/helpers/chain-address");
+function toUnrealizedPnlSnapshot(raw) {
+    return {
+        timestamp: raw.timestamp,
+        vaultName: raw.vault_name,
+        vaultAddress: raw.vault_address,
+        strategistName: raw.strategist_name ?? null,
+        referenceAsset: raw.reference_asset,
+        assetPrice: raw.asset_price,
+        tvlOnVault: raw.tvl_on_vault,
+        currentRedeemRatio: raw.current_redeem_ratio,
+        actualTvl: raw.actual_tvl,
+        adjustedRedeemRatio: raw.adjusted_redeem_ratio,
+        unrealizedPnl: raw.unrealized_pnl,
+        unrealizedPnlInAsset: raw.unrealized_pnl_in_asset,
+    };
+}
+function assertVaultAddress(vault, method) {
+    const valid = typeof vault === 'string' &&
+        vault.length > 0 &&
+        ((0, ethers_1.isAddress)(vault) || (0, chain_address_1.isSolanaAddress)(vault) || (0, chain_address_1.isStellarAddress)(vault));
+    if (!valid) {
+        throw new errors_1.AugustValidationError('INVALID_ADDRESS', `${method}: "${vault}" is not a valid vault address — pass the vault's EVM (0x…), Solana, or Stellar address.`);
+    }
+}
+function assertAddressArg(value, label, method) {
+    const valid = typeof value === 'string' &&
+        value.length > 0 &&
+        ((0, ethers_1.isAddress)(value) || (0, chain_address_1.isSolanaAddress)(value) || (0, chain_address_1.isStellarAddress)(value));
+    if (!valid) {
+        throw new errors_1.AugustValidationError('INVALID_ADDRESS', `${method}: "${value}" is not a valid ${label} — pass an EVM (0x…), Solana, or Stellar address.`);
+    }
+}
+const SNAPSHOT_STRING_FIELDS = [
+    'timestamp',
+    'vault_name',
+    'vault_address',
+    'reference_asset',
+];
+const SNAPSHOT_NUMBER_FIELDS = [
+    'asset_price',
+    'tvl_on_vault',
+    'current_redeem_ratio',
+    'actual_tvl',
+    'adjusted_redeem_ratio',
+    'unrealized_pnl',
+    'unrealized_pnl_in_asset',
+];
+function isRawSnapshot(item) {
+    if (!item || typeof item !== 'object')
+        return false;
+    const record = item;
+    return (SNAPSHOT_STRING_FIELDS.every((field) => typeof record[field] === 'string') &&
+        SNAPSHOT_NUMBER_FIELDS.every((field) => typeof record[field] === 'number'));
+}
+function assertSnapshotArray(data, method) {
+    const valid = Array.isArray(data) && data.every(isRawSnapshot);
+    if (!valid) {
+        throw new errors_1.AugustServerError(200, `${method}: unexpected response shape from the August API — expected an array of PnL snapshots. The backend contract may have changed; refresh packages/sdk/api-spec and update the SDK.`);
+    }
+}
+/**
+ * Read-only client for August backend REST endpoints that have no on-chain
+ * equivalent — currently the unrealized-PnL series the backend computes
+ * from periodic vault snapshots.
+ *
+ * Every method makes exactly one HTTPS request to the public
+ * (unauthenticated) August API and zero RPC calls. Responses are not cached
+ * by the SDK: this is time-sensitive PnL state where staleness is worse
+ * than request latency.
+ *
+ * Accessible as `apiModule` on the SDK instance; the same methods are also
+ * exposed directly on the SDK class.
+ *
+ * A subset of methods (loan book, risk) hit authenticated admin-only backend
+ * endpoints and require an admin-scoped August API key on the SDK
+ * constructor; each such method documents the requirement.
+ */
+class AugustApi extends base_class_1.AugustBase {
+    headers = null;
+    constructor(baseConfig) {
+        super(baseConfig);
+        this.headers = {
+            'x-environment': this.monitoring?.['x-environment'],
+            'x-user-id': this.monitoring?.['x-user-id'],
+        };
+    }
+    /**
+     * Retrieve the global loan-book aggregate across every active client
+     * subaccount — one {@link ILoanBookInfo} entry per loan, with principal /
+     * interest amounts, APRs, state, and the next upcoming payment.
+     *
+     * Backed by the admin-only `GET /dashboard/loans` backend endpoint (60-second
+     * server-side cache), so the August API key configured on the SDK must
+     * belong to an admin user. Makes exactly one HTTP request and no RPC calls.
+     *
+     * @returns Array of loan-book entries; empty when there are no active loans.
+     * @throws AugustAuthError When the API key is missing or not admin-scoped.
+     * @throws AugustServerError When the API responds with a non-2xx status.
+     * @example
+     *   const loans = await sdk.apiModule.getDashboardLoans();
+     *   const active = loans.filter((l) => l.state === 'ACTIVE');
+     */
+    async getDashboardLoans() {
+        return (0, fetcher_1.fetchDashboardLoans)(this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Retrieve every token discount-factor ladder the risk engine applies when
+     * valuing collateral.
+     *
+     * Backed by `GET /risk/discount_factors` (60-second server-side cache),
+     * which requires an authenticated August user; an admin-scoped API key
+     * works. Makes exactly one HTTP request and no RPC calls.
+     *
+     * @returns Array of {@link IDiscountFactorLadder}, one per whitelisted token that has a configured ladder.
+     * @throws AugustAuthError When the API key is missing or not authorized.
+     * @throws AugustServerError When the API responds with a non-2xx status.
+     * @example
+     *   const ladders = await sdk.apiModule.getDiscountFactors();
+     *   console.log(ladders.map((d) => `${d.address}@${d.chain}`));
+     */
+    async getDiscountFactors() {
+        return (0, fetcher_1.fetchDiscountFactors)(this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Compute how much collateral a subaccount has in excess of — or is short
+     * of — what it needs to hold a target health factor, for one collateral
+     * 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.
+     *
+     * @param params.subaccount Subaccount (smart-contract wallet) address.
+     * @param params.tokenAddress Collateral token address to evaluate.
+     * @param params.tokenChain Numeric August chain id of the token (e.g. `1` for Ethereum mainnet).
+     * @param params.targetHealthFactor Health factor to solve for. Defaults server-side to the minimum healthy factor (1.2); when supplied must be a finite number greater than 0.
+     * @returns The signed excess (positive) or deficit (negative) in USD and token units. Zeroes when the subaccount has no debt.
+     * @throws AugustValidationError When an address is invalid, `tokenChain` is not an integer, or `targetHealthFactor` is out of range.
+     * @throws AugustServerError When the token has no discount factor (backend 404) or the API otherwise responds non-2xx.
+     * @example
+     *   const r = await sdk.apiModule.getCollateralExcessOrDeficit({
+     *     subaccount: '0xabc…',
+     *     tokenAddress: '0xdef…',
+     *     tokenChain: 1,
+     *   });
+     *   console.log(r.amount_usd > 0 ? 'excess' : 'deficit');
+     */
+    async getCollateralExcessOrDeficit(params) {
+        const method = 'getCollateralExcessOrDeficit';
+        assertAddressArg(params.subaccount, 'subaccount address', method);
+        assertAddressArg(params.tokenAddress, 'token address', method);
+        if (!Number.isInteger(params.tokenChain)) {
+            throw new errors_1.AugustValidationError('INVALID_CHAIN', `${method}: tokenChain must be an integer August chain id, got ${params.tokenChain}.`);
+        }
+        if (params.targetHealthFactor !== undefined &&
+            (!Number.isFinite(params.targetHealthFactor) ||
+                params.targetHealthFactor <= 0)) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: targetHealthFactor must be a finite number greater than 0, got ${params.targetHealthFactor}.`);
+        }
+        return (0, fetcher_1.fetchCollateralExcessOrDeficit)(params, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Simulate the collateral required to open a hypothetical loan against a
+     * chosen basket of collateral tokens.
+     *
+     * 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.
+     *
+     * @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.
+     * @throws AugustValidationError When addresses are invalid, `loan_amount` is not a finite non-negative number, the collateral arrays are empty / mismatched, or `on_platform` is set without redeployed-token details.
+     * @throws AugustServerError When the API responds with a non-2xx status (e.g. a token missing a discount factor).
+     * @example
+     *   const sim = await sdk.apiModule.simulateCollateral({
+     *     loan_token_chain: 1,
+     *     loan_token_address: '0xloan…',
+     *     loan_amount: 1_000_000,
+     *     collateral_tokens: [[1, '0xcol…']],
+     *     collateral_token_allocation: [1],
+     *   });
+     *   console.log(sim.total_required_collateral_usd);
+     */
+    async simulateCollateral(input) {
+        const method = 'simulateCollateral';
+        assertAddressArg(input.loan_token_address, 'loan token address', method);
+        if (!Number.isFinite(input.loan_amount) || input.loan_amount < 0) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: loan_amount must be a finite non-negative number, got ${input.loan_amount}.`);
+        }
+        if (!Array.isArray(input.collateral_tokens) ||
+            input.collateral_tokens.length === 0 ||
+            !Array.isArray(input.collateral_token_allocation) ||
+            input.collateral_token_allocation.length === 0) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: collateral_tokens and collateral_token_allocation must both be non-empty.`);
+        }
+        if (input.collateral_tokens.length !==
+            input.collateral_token_allocation.length) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: collateral_tokens (${input.collateral_tokens.length}) and collateral_token_allocation (${input.collateral_token_allocation.length}) must be the same length.`);
+        }
+        for (const [, address] of input.collateral_tokens) {
+            assertAddressArg(address, 'collateral token address', method);
+        }
+        if (input.on_platform &&
+            (input.loan_redeployed_token_chain === undefined ||
+                input.loan_redeployed_token_chain === null ||
+                !input.loan_redeployed_token_address)) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: on_platform requires both loan_redeployed_token_chain and loan_redeployed_token_address.`);
+        }
+        return (0, fetcher_1.fetchCollateralSimulation)(input, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Fetch the decoded revert reason(s) for a transaction — error messages,
+     * revert strings, and recognized universal-subaccount errors extracted from
+     * a `debug_traceTransaction` call tree.
+     *
+     * Backed by the public (unauthenticated) `GET /revert_reason` endpoint; no
+     * API key required. The backend relies on the target chain's RPC supporting
+     * `debug_trace*`; on chains/RPCs without it the backend returns a 5xx whose
+     * detail explains why, surfaced here as an {@link AugustServerError}. Makes
+     * exactly one HTTP request and no RPC calls from the SDK itself.
+     *
+     * @param txHash Transaction hash to trace.
+     * @param chain Numeric August chain id the transaction is on (e.g. `1` for Ethereum mainnet).
+     * @returns The decoded {@link IRevertReason}; all arrays empty when the trace yielded no matching signal.
+     * @throws AugustValidationError When `txHash` is empty or `chain` is not an integer.
+     * @throws AugustServerError When the chain/RPC does not support tracing, or the API otherwise responds non-2xx.
+     * @example
+     *   const r = await sdk.apiModule.getRevertReason('0xabc…', 1);
+     *   console.log(r.revert_reasons);
+     */
+    async getRevertReason(txHash, chain) {
+        const method = 'getRevertReason';
+        if (typeof txHash !== 'string' || txHash.trim().length === 0) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: txHash must be a non-empty transaction hash.`);
+        }
+        if (!Number.isInteger(chain)) {
+            throw new errors_1.AugustValidationError('INVALID_CHAIN', `${method}: chain must be an integer August chain id, got ${chain}.`);
+        }
+        return (0, fetcher_1.fetchRevertReason)(txHash, chain, this.headers ?? undefined);
+    }
+    /**
+     * Retrieve every tracked OTC position.
+     *
+     * Backed by the admin-only `GET /otc/position` backend endpoint, so the
+     * configured August API key must belong to an admin user. Makes exactly one
+     * HTTP request and no RPC calls.
+     *
+     * @returns Array of {@link IOtcPositionRead}; empty when there are no OTC positions.
+     * @throws AugustAuthError When the API key is missing or not admin-scoped.
+     * @throws AugustServerError When the API responds with a non-2xx status.
+     * @example
+     *   const positions = await sdk.apiModule.getOtcPositions();
+     */
+    async getOtcPositions() {
+        return (0, fetcher_1.fetchOtcPositions)(this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Retrieve OTC margin requirements, optionally filtered by counterparty
+     * and/or payer.
+     *
+     * Backed by the admin-only `GET /otc/margin_requirement` backend endpoint,
+     * so the configured August API key must belong to an admin user. Makes
+     * exactly one HTTP request and no RPC calls.
+     *
+     * @param options - Optional filters
+     * @param options.otcCounterpartyId - Restrict to a single counterparty (UUID)
+     * @param options.payer - Restrict to a single payer address
+     * @returns Array of {@link IOtcMarginRequirement} matching the filters (all when none given).
+     * @throws AugustAuthError When the API key is missing or not admin-scoped.
+     * @throws AugustServerError When the API responds with a non-2xx status.
+     * @example
+     *   const reqs = await sdk.apiModule.getOtcMarginRequirements({ payer: '0xabc…' });
+     */
+    async getOtcMarginRequirements(options = {}) {
+        return (0, fetcher_1.fetchOtcMarginRequirements)(options, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * List the subaccounts linked to a vault (curator surface).
+     *
+     * Backed by the curator-or-admin `GET
+     * /curator/vaults/{vault_address}/subaccounts` backend endpoint, so the
+     * configured August API key must belong to the vault's curator or an admin.
+     * Makes exactly one HTTP request and no RPC calls.
+     *
+     * @param vaultAddress - The vault address (EVM `0x…`, Solana, or Stellar)
+     * @returns Array of subaccount records linked to the vault (same shape as the subaccount directory); empty when none are linked.
+     * @throws AugustValidationError When `vaultAddress` is not a valid address.
+     * @throws AugustAuthError When the API key is missing or not curator/admin for the vault.
+     * @throws AugustServerError When the API responds with a non-2xx status.
+     * @example
+     *   const subs = await sdk.apiModule.getCuratorVaultSubaccounts('0xvault…');
+     */
+    async getCuratorVaultSubaccounts(vaultAddress) {
+        assertVaultAddress(vaultAddress, 'getCuratorVaultSubaccounts');
+        return (0, fetcher_1.fetchCuratorVaultSubaccounts)(vaultAddress, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Get on-chain whitelist status for every subaccount linked to a vault
+     * (curator surface).
+     *
+     * Backed by the curator-or-admin `GET
+     * /curator/vaults/{vault_address}/whitelist` backend endpoint. EVM vaults
+     * only — non-EVM vaults manage access internally and the backend returns a
+     * 400 (surfaced as {@link AugustServerError}). Makes exactly one HTTP
+     * request and no RPC calls from the SDK.
+     *
+     * @param vaultAddress - The EVM vault address (`0x…`)
+     * @returns Array of {@link ICuratorWhitelistStatus}, one per linked subaccount; empty when the vault has no subaccounts.
+     * @throws AugustValidationError When `vaultAddress` is not a valid address.
+     * @throws AugustAuthError When the API key is missing or not curator/admin for the vault.
+     * @throws AugustServerError When the vault is non-EVM (backend 400) or the API otherwise responds non-2xx.
+     * @example
+     *   const status = await sdk.apiModule.getCuratorVaultWhitelist('0xvault…');
+     *   console.log(status.filter((s) => !s.is_whitelisted));
+     */
+    async getCuratorVaultWhitelist(vaultAddress) {
+        assertVaultAddress(vaultAddress, 'getCuratorVaultWhitelist');
+        return (0, fetcher_1.fetchCuratorVaultWhitelist)(vaultAddress, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * List timelock (governance) requests for a vault on a chain, optionally
+     * filtered by status.
+     *
+     * Backed by the `GET /timelock-requests` backend endpoint. Makes exactly one
+     * HTTP request and no RPC calls.
+     *
+     * @param params.vaultAddress The vault address the requests target.
+     * @param params.chainId Numeric August chain id (must be a positive integer).
+     * @param params.status Status filter: `"scheduled"` (backend default), `"executed"`, `"cancelled"`, or `"all"`. Omit to use the backend default.
+     * @returns Array of {@link ITimelockRequest}; empty when the vault has no matching requests.
+     * @throws AugustValidationError When `vaultAddress` is invalid or `chainId` is not a positive integer.
+     * @throws AugustServerError When the API responds with a non-2xx status (e.g. an invalid status filter).
+     * @example
+     *   const reqs = await sdk.apiModule.getTimelockRequests({ vaultAddress: '0xvault…', chainId: 1 });
+     */
+    async getTimelockRequests(params) {
+        const method = 'getTimelockRequests';
+        assertVaultAddress(params.vaultAddress, method);
+        if (!Number.isInteger(params.chainId) || params.chainId <= 0) {
+            throw new errors_1.AugustValidationError('INVALID_CHAIN', `${method}: chainId must be a positive integer August chain id, got ${params.chainId}.`);
+        }
+        return (0, fetcher_1.fetchTimelockRequests)(params, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Compute a vault's performance fees over a period (backend-computed from
+     * its snapshot history).
+     *
+     * Backed by `GET /metrics/vault_performance_fees`. The backend runs pandas
+     * over the vault's full snapshot history, so the first call is slow; results
+     * are cached server-side for 20 minutes. Makes exactly one HTTP request and
+     * no RPC calls.
+     *
+     * @param params.vault The vault address (EVM `0x…`, Solana, or Stellar).
+     * @param params.annualizedFeesPct Annualized performance-fee percentage. Defaults to 20.
+     * @param params.nativeDenominated Whether to denominate in the vault's native token. Defaults to `true`.
+     * @param params.calculationPeriod Period preset — `"YearToDate"` (default) or `"MonthToDate"`. Ignored by the backend when a custom `startDate`/`endDate` range is supplied.
+     * @param params.startDate ISO-8601 datetime range start. Must be supplied together with `endDate`.
+     * @param params.endDate ISO-8601 datetime range end. Must be supplied together with `startDate`.
+     * @returns The vault's {@link IVaultPerformanceFees} computation.
+     * @throws AugustValidationError When `vault` is invalid, or exactly one of `startDate`/`endDate` is supplied.
+     * @throws AugustServerError When there is insufficient snapshot data for the period, or the API otherwise responds non-2xx.
+     * @example
+     *   const fees = await sdk.apiModule.getVaultPerformanceFees({ vault: '0xvault…' });
+     *   console.log(fees.total_perf_fees_asset);
+     */
+    async getVaultPerformanceFees(params) {
+        const method = 'getVaultPerformanceFees';
+        assertVaultAddress(params.vault, method);
+        const hasStart = params.startDate !== undefined;
+        const hasEnd = params.endDate !== undefined;
+        if (hasStart !== hasEnd) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: startDate and endDate must be supplied together (both or neither).`);
+        }
+        return (0, fetcher_1.fetchVaultPerformanceFees)({
+            vaultAddress: params.vault,
+            annualizedFeesPct: params.annualizedFeesPct ?? 20,
+            nativeDenominated: params.nativeDenominated ?? true,
+            calculationPeriod: params.calculationPeriod ?? 'YearToDate',
+            startDate: params.startDate,
+            endDate: params.endDate,
+        }, this.keys.august, this.headers ?? undefined);
+    }
+    /**
+     * Fetch a vault's NAV-oracle classification table — how each position/token
+     * is priced (Primary / Secondary Market / CeFi) and its USD value, plus
+     * warnings for tokens that could not be resolved.
+     *
+     * Backed by the public (unauthenticated) `GET
+     * /upshift/oracle_classification/{vault_address}` endpoint; no API key
+     * required. Reads the newest daily snapshot. Makes exactly one HTTP request
+     * and no RPC calls from the SDK.
+     *
+     * @param vault The vault address (EVM `0x…`, Solana, or Stellar).
+     * @param chainId Numeric August chain id the vault lives on.
+     * @returns The vault's {@link IOracleClassification}.
+     * @throws AugustValidationError When `vault` is invalid or `chainId` is not an integer.
+     * @throws AugustServerError When the vault or its snapshot is not found, or the API otherwise responds non-2xx.
+     * @example
+     *   const cls = await sdk.apiModule.getVaultOracleClassification('0xvault…', 1);
+     *   console.log(cls.warnings);
+     */
+    async getVaultOracleClassification(vault, chainId) {
+        const method = 'getVaultOracleClassification';
+        assertVaultAddress(vault, method);
+        if (!Number.isInteger(chainId)) {
+            throw new errors_1.AugustValidationError('INVALID_CHAIN', `${method}: chainId must be an integer August chain id, got ${chainId}.`);
+        }
+        return (0, fetcher_1.fetchVaultOracleClassification)(vault, chainId, this.headers ?? undefined);
+    }
+    /**
+     * Fetch the historical unrealized-PnL series for a vault, newest first,
+     * as computed by the August backend from periodic vault snapshots.
+     *
+     * Makes one HTTPS request to the public August API; no RPC calls.
+     *
+     * @param params.vault Vault address (EVM `0x…`, Solana, or Stellar).
+     * @param params.limit Maximum number of snapshots to return (1–1000). Backend default applies when omitted.
+     * @returns Array of {@link IUnrealizedPnlSnapshot}; empty when the backend has no history for the vault.
+     * @throws AugustValidationError When `vault` is not a valid address or `limit` is out of range.
+     * @throws AugustServerError When the API responds with a 5xx, or returns a body that is not a snapshot array.
+     * @throws AugustRateLimitError When the API responds 429.
+     * @throws AugustTimeoutError When the request exceeds the SDK request timeout.
+     * @example
+     *   const series = await sdk.getVaultUnrealizedPnlHistory({ vault: '0x36eDbF0C834591BFdfCaC0Ef9605528c75c406aA', limit: 30 });
+     *   console.log(series[0]?.unrealizedPnlInAsset);
+     */
+    async getVaultUnrealizedPnlHistory(params) {
+        const method = 'getVaultUnrealizedPnlHistory';
+        assertVaultAddress(params.vault, method);
+        if (params.limit !== undefined &&
+            (!Number.isInteger(params.limit) ||
+                params.limit < 1 ||
+                params.limit > 1000)) {
+            throw new errors_1.AugustValidationError('INVALID_INPUT', `${method}: limit must be an integer between 1 and 1000, got ${params.limit}.`);
+        }
+        const endpoint = core_1.WEBSERVER_ENDPOINTS.public.pnl.unrealizedHistory(params.vault, params.limit);
+        const response = await (0, fetcher_2.fetchAugustPublic)(endpoint);
+        const data = await response.json();
+        assertSnapshotArray(data, method);
+        return data.map(toUnrealizedPnlSnapshot);
+    }
+    /**
+     * Fetch the latest unrealized-PnL snapshot for every vault the backend
+     * tracks — one entry per vault.
+     *
+     * Makes one HTTPS request to the public August API; no RPC calls.
+     *
+     * @returns Array of {@link IUnrealizedPnlSnapshot}, one per tracked vault.
+     * @throws AugustServerError When the API responds with a 5xx, or returns a body that is not a snapshot array.
+     * @throws AugustRateLimitError When the API responds 429.
+     * @throws AugustTimeoutError When the request exceeds the SDK request timeout.
+     * @example
+     *   const all = await sdk.getLatestUnrealizedPnl();
+     *   const losing = all.filter((s) => s.unrealizedPnl < 0);
+     */
+    async getLatestUnrealizedPnl() {
+        const method = 'getLatestUnrealizedPnl';
+        const response = await (0, fetcher_2.fetchAugustPublic)(core_1.WEBSERVER_ENDPOINTS.public.pnl.unrealizedLatest);
+        const data = await response.json();
+        assertSnapshotArray(data, method);
+        return data.map(toUnrealizedPnlSnapshot);
+    }
+}
+exports.AugustApi = AugustApi;
+//# sourceMappingURL=main.js.map

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

@@ -0,0 +1,53 @@
+import { type IFetchAugustOptions } from '../../core';
+import type { IAddress, ILoanBookInfo, IOTCPosition, ISubaccountDebank, ISubaccountTransaction, IWSSubaccountCefi, IWSSubAccountHealthFactor, IWSSubaccountListItem, IWSSubaccountLoan, IWSSubaccountSummary } from '../../types';
+/**
+ * Fetch one page of the subaccount directory (admin-only backend endpoint)
+ */
+export declare const fetchAllSubaccounts: (pagination: {
+    offset?: number;
+    limit?: number;
+}, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IWSSubaccountListItem[]>;
+/**
+ * Fetch a subaccount's transaction history (authenticated `GET
+ * /transactions/v2`), optionally windowed by ISO-8601 start/end datetimes.
+ */
+export declare const fetchSubaccountTransactions: (payload: {
+    address: IAddress;
+    startTime?: string;
+    endTime?: string;
+}, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<ISubaccountTransaction[]>;
+/**
+ * Fetch a single loan's loan-book detail by loan address + chain
+ * (admin-only `GET /subaccount/loans/{loan_address}`).
+ */
+export declare const fetchSubaccountLoanByAddress: (loanAddress: string, chainId: number, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<ILoanBookInfo>;
+/**
+ * Fetch cross-chain DeBank positions for a subaccount (`GET
+ * /subaccount/{subaccount_address}/debank`). Slow endpoint (300-second
+ * server-side cache) — it fans out across every supported chain.
+ */
+export declare const fetchSubaccountDebank: (address: IAddress, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<ISubaccountDebank>;
+/**
+ * Fetch subaccount health factor for a given subaccount address
+ */
+export declare const fetchSubaccountHeathFactor: (address: IAddress, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IWSSubAccountHealthFactor>;
+/**
+ * Fetch subaccount loans details
+ */
+export declare const fetchSubaccountLoans: (payload: {
+    address: IAddress;
+    side?: "BOTH" | "BORROWER" | "LENDER";
+    active?: boolean;
+}, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IWSSubaccountLoan[]>;
+/**
+ * Fetch the subaccount CeFi positions
+ */
+export declare const fetchSubaccountCefiPositions: (address: IAddress, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IWSSubaccountCefi[]>;
+/**
+ * Fetch the subaccount OTC positions
+ */
+export declare const fetchSubaccountOtcPositions: (address: IAddress, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IOTCPosition[]>;
+/**
+ * Fetch the subaccount summary view
+ */
+export declare const fetchSubaccountSummary: (address: IAddress, augustKey: string, headers?: IFetchAugustOptions["headers"]) => Promise<IWSSubaccountSummary>;

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

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchSubaccountSummary = exports.fetchSubaccountOtcPositions = exports.fetchSubaccountCefiPositions = exports.fetchSubaccountLoans = exports.fetchSubaccountHeathFactor = exports.fetchSubaccountDebank = exports.fetchSubaccountLoanByAddress = exports.fetchSubaccountTransactions = exports.fetchAllSubaccounts = void 0;
+const core_1 = require("../../core");
+/**
+ * Fetch one page of the subaccount directory (admin-only backend endpoint)
+ */
+const fetchAllSubaccounts = async (pagination, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.list(pagination.offset, pagination.limit), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccounts: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchAllSubaccounts = fetchAllSubaccounts;
+/**
+ * Fetch a subaccount's transaction history (authenticated `GET
+ * /transactions/v2`), optionally windowed by ISO-8601 start/end datetimes.
+ */
+const fetchSubaccountTransactions = async (payload, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.transactions.v2(payload.address, payload.startTime, payload.endTime), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount transactions: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountTransactions = fetchSubaccountTransactions;
+/**
+ * Fetch a single loan's loan-book detail by loan address + chain
+ * (admin-only `GET /subaccount/loans/{loan_address}`).
+ */
+const fetchSubaccountLoanByAddress = async (loanAddress, chainId, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.loanByAddress(loanAddress, chainId), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch loan by address: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountLoanByAddress = fetchSubaccountLoanByAddress;
+/**
+ * Fetch cross-chain DeBank positions for a subaccount (`GET
+ * /subaccount/{subaccount_address}/debank`). Slow endpoint (300-second
+ * server-side cache) — it fans out across every supported chain.
+ */
+const fetchSubaccountDebank = async (address, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.debank(address), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount debank: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountDebank = fetchSubaccountDebank;
+/**
+ * Fetch subaccount health factor for a given subaccount address
+ */
+const fetchSubaccountHeathFactor = async (address, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.health_factor(address), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount health factor: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountHeathFactor = fetchSubaccountHeathFactor;
+/**
+ * Fetch subaccount loans details
+ */
+const fetchSubaccountLoans = async (payload, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.loans(payload.address, payload.side, payload.active), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount loans: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountLoans = fetchSubaccountLoans;
+/**
+ * Fetch the subaccount CeFi positions
+ */
+const fetchSubaccountCefiPositions = async (address, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.cefi(address), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount CeFi positions: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountCefiPositions = fetchSubaccountCefiPositions;
+/**
+ * Fetch the subaccount OTC positions
+ */
+const fetchSubaccountOtcPositions = async (address, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.otc_positions(address), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount OTC positions: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountOtcPositions = fetchSubaccountOtcPositions;
+/**
+ * Fetch the subaccount summary view
+ */
+const fetchSubaccountSummary = async (address, augustKey, headers) => {
+    const response = await (0, core_1.fetchAugustWithKey)(augustKey, core_1.WEBSERVER_ENDPOINTS.subaccount.summary(address), {
+        headers,
+    });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch subaccount summary: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchSubaccountSummary = fetchSubaccountSummary;
+//# sourceMappingURL=fetcher.js.map

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

@@ -0,0 +1,2 @@
+export * from './fetcher';
+export * from './main';