@augustdigital/sdk 9.11.0 → 9.13.0

package/lib/main.js

@@ -317,8 +317,24 @@ class AugustSDK extends core_1.AugustBase {
     }
     /**
      * Get redemption requests that are ready to be claimed.
+     *
+     * For a Solana vault, `wallet` is the holder's base58 address and the result
+     * lists their withdrawal-queue requests: waiting (`AWAITING_COOLDOWN`) and
+     * past-window (`EXPIRED`, cancel-only) ones in `availableRedemptions`, and
+     * claimable ones (`READY_TO_CLAIM`) in `pendingRedemptions`, each with
+     * `estimatedAssets`, the net payout at the current share price. Without a
+     * Solana wallet, or for a vault with no queue, both lists are empty. Solana
+     * RPC: the vault state, one `getAccountInfo` for the queue, and, when it
+     * exists, one `getProgramAccounts` and one `getMultipleAccountsInfo` (the
+     * vault state, share mint and payout accounts, read together).
+     *
      * @param props - Vault address, chain ID, and optional wallet filter
      * @returns Array of available redemption requests with amounts and timestamps
+     * @example
+     * ```ts
+     * const { availableRedemptions, pendingRedemptions } =
+     *   await sdk.getVaultAvailableRedemptions({ vault: solanaVault, wallet: holder });
+     * ```
      */
     async getVaultAvailableRedemptions(props) {
         return await this.vaults.getVaultAvailableRedemptions(props);

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

@@ -1,4 +1,4 @@
-import { type IAddress, type IHistoricalTimeseriesPoint, type IHistoricalTimeseriesResponse, type INormalizedNumber, type ISubgraphReserveDeposit, type ISubgraphTransfer, type ISubgraphUserHistoryItem, type ITokenizedVault, type ISubgraphWithdrawProccessed, type IVault, type IVaultAllocations, type IVaultAnnualizedApy, type IVaultAvailableRedemption, type IVaultLoan, type IVaultPosition, type IVaultRedemptionHistoryItem, type IVaultSummary, type IVaultWithdrawals, type IVaultPendingRedemptions, type IActiveStakingPosition, type IVaultHistoricalParams, type IVaultUserLifetimePnl, type IVaultBorrowerHealthFactor, type IVaultPnl, type VaultAddress } from '../../types';
+import { type IAddress, type IHistoricalTimeseriesPoint, type IHistoricalTimeseriesResponse, type INormalizedNumber, type ISubgraphReserveDeposit, type ISubgraphTransfer, type ISubgraphUserHistoryItem, type ITokenizedVault, type ISubgraphWithdrawProccessed, type ISubgraphWithdrawRequest, type IVault, type IVaultAllocations, type IVaultAnnualizedApy, type IVaultAvailableRedemption, type IVaultLoan, type IVaultPosition, type IVaultRedemptionHistoryItem, type IVaultSummary, type IVaultWithdrawals, type IVaultPendingRedemptions, type IActiveStakingPosition, type IVaultHistoricalParams, type IVaultUserLifetimePnl, type IVaultBorrowerHealthFactor, type IVaultPnl, type VaultAddress } from '../../types';
 import type { IVaultBaseOptions } from './types';
 /**
  * Vault Data Getters
@@ -98,7 +98,7 @@ export declare function getVaultAvailableRedemptions({ vault, wallet, options, p
     };
 }): Promise<{
     processedWithdrawals: ISubgraphWithdrawProccessed[];
-    requestedWithdrawals: import("../../types").ISubgraphWithdrawRequest[];
+    requestedWithdrawals: ISubgraphWithdrawRequest[];
     availableRedemptions: IVaultAvailableRedemption[];
     pendingRedemptions: IVaultAvailableRedemption[];
 }>;

package/lib/modules/vaults/getters.js

@@ -85,6 +85,8 @@ const debank_1 = require("../../services/debank");
 const utils_2 = require("../../adapters/solana/utils");
 const SolanaGetters = __importStar(require("../../adapters/solana/getters"));
 const SolanaConstants = __importStar(require("../../adapters/solana/constants"));
+const withdrawal_queue_1 = require("../../adapters/solana/withdrawal-queue");
+const web3_js_1 = require("@solana/web3.js");
 const StellarGetters = __importStar(require("../../adapters/stellar/getters"));
 const utils_3 = require("../../adapters/stellar/utils");
 const constants_1 = require("../../adapters/stellar/constants");
@@ -935,6 +937,51 @@ async function readLagDuration(vaultContract, vault, scope) {
  * an empty response to any *other* view still surfaces as an error.
  */
 const LAG_DURATION_SELECTOR = '0x24e86d67';
+/**
+ * A Solana wallet's withdrawal-queue requests on one vault, for
+ * `getVaultPositions` and `getVaultAvailableRedemptions`. Empty when the vault
+ * has no queue, the wallet has no request, or the service cannot name the queue
+ * program (including where the queue is not deployed); a failed read is logged
+ * and reads as empty, like the balance reads beside it.
+ *
+ * RPC: see `getSolanaWithdrawalRedemptions` (one `getAccountInfo` for a vault
+ * with no queue; up to one more `getProgramAccounts` and one
+ * `getMultipleAccountsInfo`).
+ */
+async function readSolanaRedemptions(input) {
+    const empty = {
+        availableRedemptions: [],
+        pendingRedemptions: [],
+    };
+    const { tokenizedVault, solanaService, vaultState } = input;
+    if (!vaultState.shareMint)
+        return empty;
+    try {
+        const queueProgramId = (0, withdrawal_queue_1.resolveQueueProgramId)(solanaService);
+        if (!queueProgramId)
+            return empty;
+        const metadata = tokenizedVault.solana_vault_metadata;
+        const programId = utils_2.SolanaUtils.resolveProgramId(String(tokenizedVault.address), metadata);
+        return await (0, withdrawal_queue_1.getSolanaWithdrawalRedemptions)({
+            connection: solanaService.connection,
+            queueProgramId,
+            vaultStateAddress: metadata?.vault_state_pda
+                ? new web3_js_1.PublicKey(metadata.vault_state_pda)
+                : utils_2.SolanaUtils.deriveVaultStatePda(programId),
+            shareMint: new web3_js_1.PublicKey(vaultState.shareMint),
+            owner: new web3_js_1.PublicKey(input.wallet),
+            vault: tokenizedVault.address,
+            depositDecimals: input.depositDecimals,
+        });
+    }
+    catch (error) {
+        core_1.Logger.log.warn('readSolanaRedemptions', 'Withdrawal requests read failed', {
+            vault: tokenizedVault.address,
+            error,
+        });
+        return empty;
+    }
+}
 async function getVaultAvailableRedemptions({ vault, wallet, options, prefetchedReads, }) {
     try {
         // Stellar vaults don't support on-chain redemptions yet
@@ -949,6 +996,41 @@ async function getVaultAvailableRedemptions({ vault, wallet, options, prefetched
                 }),
             };
         }
+        // Solana: the wallet's withdrawal-queue requests. There is no processed
+        // history to report, so the verbose lists are always empty.
+        if (utils_2.SolanaUtils.isSolanaAddress(vault)) {
+            const empty = {
+                availableRedemptions: [],
+                pendingRedemptions: [],
+                ...(options.verbose && {
+                    processedWithdrawals: [],
+                    requestedWithdrawals: [],
+                }),
+            };
+            const solanaService = options.solanaService;
+            if (!wallet || !utils_2.SolanaUtils.isSolanaAddress(wallet) || !solanaService) {
+                return empty;
+            }
+            const solanaVault = (await (0, core_1.fetchTokenizedVault)(vault, options?.headers, false, false))?.[0];
+            if (!solanaVault)
+                return empty;
+            const vaultStateRes = await solanaService.getVaultState(utils_2.SolanaUtils.resolveProgramId(String(solanaVault.address), solanaVault.solana_vault_metadata), SolanaConstants.vaultIdl, solanaVault.solana_vault_metadata?.vault_state_pda ?? undefined);
+            const vaultState = vaultStateRes?.vaultState;
+            if (!vaultState)
+                return empty;
+            return {
+                ...empty,
+                ...(await readSolanaRedemptions({
+                    tokenizedVault: solanaVault,
+                    wallet,
+                    solanaService,
+                    vaultState,
+                    depositDecimals: vaultStateRes?.depositMintDecimals ??
+                        solanaVault.solana_vault_metadata?.deposit_token_decimals ??
+                        SolanaConstants.fallbackDecimals,
+                })),
+            };
+        }
         // setup
         const provider = (0, core_1.createProvider)(options.rpcUrl);
         const tokenizedVault = (await (0, core_1.fetchTokenizedVault)(vault, options?.headers, false, false))?.[0];
@@ -1435,6 +1517,10 @@ async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, o
                     const fallbackShareDecimals = v.solana_vault_metadata?.deposit_token_decimals ??
                         SolanaConstants.fallbackDecimals;
                     let balance = (0, core_1.toNormalizedBn)(0, fallbackShareDecimals);
+                    let redemptions = {
+                        availableRedemptions: [],
+                        pendingRedemptions: [],
+                    };
                     // Defensive: without a Solana adapter we can't fetch on-chain
                     // state. The outer filter in modules/vaults/main.ts already gates
                     // on `this.solanaService`, so this is a belt-and-suspenders guard
@@ -1456,6 +1542,15 @@ async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, o
                             const decimals = raw.decimals ?? fallbackShareDecimals;
                             balance = (0, core_1.toNormalizedBn)(BigInt(raw.amount), decimals);
                         }
+                        if (vaultState) {
+                            redemptions = await readSolanaRedemptions({
+                                tokenizedVault: v,
+                                wallet: solanaWallet,
+                                solanaService: options.solanaService,
+                                vaultState,
+                                depositDecimals: vaultStateRes?.depositMintDecimals ?? fallbackShareDecimals,
+                            });
+                        }
                     }
                     return {
                         // Mirror the Stellar branch — return the backend's `v.address`,
@@ -1464,9 +1559,14 @@ async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, o
                         // not 0x-hex; the IAddress typing across non-EVM positions is a
                         // known wart documented in IVaultPosition.
                         vault: v.address,
-                        status: renderStatus([], balance),
-                        availableRedemptions: [],
-                        pendingRedemptions: [],
+                        // Any queued request, waiting or claimable, marks the position
+                        // REDEEM; the shares it escrows are no longer in the wallet.
+                        status: renderStatus([
+                            ...redemptions.availableRedemptions,
+                            ...redemptions.pendingRedemptions,
+                        ], balance),
+                        availableRedemptions: redemptions.availableRedemptions,
+                        pendingRedemptions: redemptions.pendingRedemptions,
                         redeemable: balance,
                         walletBalance: balance,
                     };

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

@@ -68,6 +68,8 @@ export declare class AugustVaults extends AugustBase {
     /**
      * Calculate total deposited across all tokenized vaults by summing latest_reported_tvl.
      * Uses the /tokenized_vault endpoint which returns latest_reported_tvl in USD.
+     * Wrapper vaults (non-null `underlying_vault_address`) are skipped: their
+     * deposits sit in the underlying vault as LP and are already counted there.
      * @param options Optional configuration for loading vaults
      * @returns Total deposited amount in USD (sum of all latest_reported_tvl values)
      */
@@ -160,7 +162,17 @@ export declare class AugustVaults extends AugustBase {
         nDays?: number;
     }): Promise<import("../../types").IHistoricalTimeseriesResponse>;
     /**
+     * A wallet's redemption requests on one vault, split into
+     * `availableRedemptions` and `pendingRedemptions`. EVM, Stellar and Solana
+     * vault addresses are accepted; see `AugustSDK.getVaultAvailableRedemptions`
+     * for what each list holds on Solana.
      *
+     * @param props - `vault`, the vault address; `chainId`, the EVM chain whose
+     *   RPC to use (the active network when omitted); `wallet`, the holder,
+     *   required for Solana, where it is base58; `verbose`, to also return the
+     *   processed and requested withdrawal lists (always empty for Solana).
+     * @returns `{ availableRedemptions, pendingRedemptions }`, plus the verbose lists.
+     * @throws Error when unauthorized, or when `vault` is missing or not an address.
      */
     getVaultAvailableRedemptions({ vault, chainId, wallet, verbose, }: {
         vault: IAddress;

package/lib/modules/vaults/main.js

@@ -339,6 +339,8 @@ class AugustVaults extends core_1.AugustBase {
     /**
      * Calculate total deposited across all tokenized vaults by summing latest_reported_tvl.
      * Uses the /tokenized_vault endpoint which returns latest_reported_tvl in USD.
+     * Wrapper vaults (non-null `underlying_vault_address`) are skipped: their
+     * deposits sit in the underlying vault as LP and are already counted there.
      * @param options Optional configuration for loading vaults
      * @returns Total deposited amount in USD (sum of all latest_reported_tvl values)
      */
@@ -348,6 +350,8 @@ class AugustVaults extends core_1.AugustBase {
         allVaults.forEach((vault) => {
             if (vaults_2.TVL_EXCLUDED_VAULTS.has(vault.address?.toLowerCase()))
                 return;
+            if (vault.underlying_vault_address)
+                return;
             if (vault.latest_reported_tvl !== null &&
                 vault.latest_reported_tvl !== undefined) {
                 total += vault.latest_reported_tvl;
@@ -591,14 +595,26 @@ class AugustVaults extends core_1.AugustBase {
         });
     }
     /**
+     * A wallet's redemption requests on one vault, split into
+     * `availableRedemptions` and `pendingRedemptions`. EVM, Stellar and Solana
+     * vault addresses are accepted; see `AugustSDK.getVaultAvailableRedemptions`
+     * for what each list holds on Solana.
      *
+     * @param props - `vault`, the vault address; `chainId`, the EVM chain whose
+     *   RPC to use (the active network when omitted); `wallet`, the holder,
+     *   required for Solana, where it is base58; `verbose`, to also return the
+     *   processed and requested withdrawal lists (always empty for Solana).
+     * @returns `{ availableRedemptions, pendingRedemptions }`, plus the verbose lists.
+     * @throws Error when unauthorized, or when `vault` is missing or not an address.
      */
     async getVaultAvailableRedemptions({ vault, chainId, wallet, verbose, }) {
         if (!this.authorized)
             throw new Error('Not authorized.');
         if (!vault)
             throw new Error('Vault input parameter is undefined.');
-        if (!(0, ethers_1.isAddress)(vault) && !(0, utils_2.isStellarAddress)(vault))
+        if (!(0, ethers_1.isAddress)(vault) &&
+            !(0, utils_2.isStellarAddress)(vault) &&
+            !utils_1.SolanaUtils.isSolanaAddress(vault))
             throw new Error(`Vault input parameter is not an address: ${String(vault)}`);
         return await (0, getters_1.getVaultAvailableRedemptions)({
             vault,

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

@@ -1,5 +1,5 @@
 import type { Connection } from '@solana/web3.js';
-import type { IAddress, IEnv, IStellarNetwork, IWSMonitorHeaders } from '../../types';
+import type { IAddress, IEnv, ISolanaNetwork, IStellarNetwork, IWSMonitorHeaders } from '../../types';
 /**
  * Structural interface for the Solana adapter surface used by vault operations.
  * Avoids importing the concrete SolanaAdapter class to prevent circular dependencies.
@@ -29,6 +29,19 @@ export interface ISolanaService {
         amount: string;
         decimals: number | null;
     }>;
+    /**
+     * Canonical program id for this service's network, as
+     * `SolanaAdapter.getProgramId`. Optional so a hand-built service keeps
+     * working: without it the withdrawal-queue reads are skipped, and vaults and
+     * positions come back without queue data.
+     */
+    getProgramId?: (type: 'vault' | 'withdrawalQueue') => string;
+    /**
+     * This service's network, as `SolanaAdapter.network`. When present, the
+     * withdrawal-queue reads look the queue program up in `programIds` directly
+     * instead of calling `getProgramId`.
+     */
+    network?: ISolanaNetwork;
 }
 /**
  * Base configuration for vault operations.

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

@@ -82,6 +82,14 @@ export declare function formatVaultApy(tokenizedVault: ITokenizedVault): IVault[
  *   the trailing `Z` is preserved.
  */
 export declare function mapVaultFreshness(tokenizedVault: ITokenizedVault | undefined | null): IVaultFreshness | null;
+/**
+ * Map a wrapper vault's link to the vault it wraps.
+ *
+ * @param tokenizedVault - Backend tokenized-vault payload.
+ * @returns The underlying vault address (casing preserved) and chain id, both
+ *   null for a non-wrapper vault. A chain id without an address is dropped.
+ */
+export declare function mapUnderlyingVault(tokenizedVault: ITokenizedVault | undefined | null): Pick<IVault, 'underlyingVaultAddress' | 'underlyingChainId'>;
 /**
  * Map strategists from backend subaccounts or hardcoded list.
  * Shared across all chain adapters.

package/lib/modules/vaults/utils.js

@@ -7,6 +7,7 @@ exports.getIdleAssets = getIdleAssets;
 exports.getYieldLastRealizedOn = getYieldLastRealizedOn;
 exports.formatVaultApy = formatVaultApy;
 exports.mapVaultFreshness = mapVaultFreshness;
+exports.mapUnderlyingVault = mapUnderlyingVault;
 exports.mapStrategists = mapStrategists;
 exports.mapComposabilityIntegrations = mapComposabilityIntegrations;
 exports.backendTvlToNormalizedBn = backendTvlToNormalizedBn;
@@ -268,6 +269,22 @@ function mapVaultFreshness(tokenizedVault) {
         cachedAt: freshness.cached_at ?? null,
     };
 }
+/**
+ * Map a wrapper vault's link to the vault it wraps.
+ *
+ * @param tokenizedVault - Backend tokenized-vault payload.
+ * @returns The underlying vault address (casing preserved) and chain id, both
+ *   null for a non-wrapper vault. A chain id without an address is dropped.
+ */
+function mapUnderlyingVault(tokenizedVault) {
+    const address = tokenizedVault?.underlying_vault_address;
+    if (!address)
+        return { underlyingVaultAddress: null, underlyingChainId: null };
+    return {
+        underlyingVaultAddress: address,
+        underlyingChainId: tokenizedVault?.underlying_chain ?? null,
+    };
+}
 /**
  * Map strategists from backend subaccounts or hardcoded list.
  * Shared across all chain adapters.
@@ -437,6 +454,7 @@ function buildBackendVault(tokenizedVault, overrides) {
         dailyPnlPerShare: mapDailyPnlPerShare(tokenizedVault.daily_pnl_per_share),
         enabled_historical_price_horizons: tokenizedVault.enabled_historical_price_horizons || [],
         latest_reported_tvl: tokenizedVault.latest_reported_tvl,
+        ...mapUnderlyingVault(tokenizedVault),
         defaultApyHorizon: tokenizedVault.default_apy_horizon,
         ...(tokenizedVault.instant_redeem_config
             ? {
@@ -659,6 +677,7 @@ async function buildFormattedVault(provider, tokenizedVault, contractCalls) {
         enabled_historical_price_horizons: tokenizedVault?.enabled_historical_price_horizons,
         defaultApyHorizon: tokenizedVault?.default_apy_horizon ?? null,
         latest_reported_tvl: tokenizedVault?.latest_reported_tvl,
+        ...mapUnderlyingVault(tokenizedVault),
         cachedAt: tokenizedVault?.cached_at ?? null,
         freshness: mapVaultFreshness(tokenizedVault),
         showCapFilled: tokenizedVault?.show_cap_filled ?? null,