@augustdigital/sdk 9.10.1 → 9.12.0

package/README.md

@@ -109,19 +109,21 @@ const { registered, originFeeBps, collector } = await sdk.getOriginInfo({
 - **Where it applies.** `vaultDeposit` sends a deposit through `SwapRouter.deposit` with the code when
   `sdk.evm.getDepositRoute()` returns `via: 'router'`: the vault is registered on the router, the vault accepts
   the asset as-is (its reference asset, or a Tokenized Vault V2 whitelisted asset — never swapped), the router
-  whitelists the asset, the deposit is not a permit, native-token or adapter deposit, and the code is
-  registered. `swapRouterDeposit`, `swapAndDeposit`, `depositViaSwapRouter` and `depositNativeViaSwapRouter`
+  whitelists the asset, the router is not paused, the deposit is not a permit, native-token or adapter deposit,
+  and the code is registered. `swapRouterDeposit`, `swapAndDeposit`, `depositViaSwapRouter` and `depositNativeViaSwapRouter`
   send it too.
 - **Precedence.** An `originCode` passed to a router method wins, then the instance code, then the all-zero
   sentinel (no origin fee). Pass the zero sentinel to opt one call out.
 - **Fallback.** When the code cannot be applied — it is not registered, the chain is not mainnet, the router
-  does not whitelist the asset, the vault does not accept it or is not registered on the router, or it is a
-  permit, native-token or adapter deposit — `vaultDeposit` takes the vault's native path and logs
+  is paused (`router-paused`, checked with a 15-second cache) or does not whitelist the asset, the vault does
+  not accept it or is not registered on the router, or it is a permit, native-token or adapter deposit —
+  `vaultDeposit` takes the vault's native path and logs
   `vaultDeposit:attribution-skipped` with the reason (Sentry tag `sdk.attribution.origin=skipped`). The router
   methods send the zero sentinel for an unregistered instance code and log `<method>:attribution-skipped`.
   With `strictOrigin: true` an unregistered instance code throws `AugustValidationError` before any approval
-  instead. An `originCode` passed to a router method that is not registered always throws
-  `AugustValidationError` before any approval.
+  instead; a paused router falls back to native even then. An `originCode` passed to a router method that is
+  not registered always throws `AugustValidationError` before any approval. While the router is paused, the
+  router methods throw `AugustSDKError` (`context.reason: 'router-paused'`) before any approval.
 - **Approve `route.spender`, not the vault.** A routed deposit is pulled by the SwapRouter. `vaultDeposit` and
   `approve` handle this; if you send approvals yourself, read the spender first:
 

package/lib/adapters/evm/index.d.ts

@@ -106,9 +106,10 @@ declare class EVMAdapter {
      * (`route.spender`, not necessarily the vault). See {@link getDepositRoute}.
      *
      * @param options - {@link IGetDepositRouteOptions}.
-     * @returns `{ via, spender, reason? }` — `reason` explains a native route.
+     * @returns `{ via, spender, reason? }` — `reason` explains a native route
+     *   (`router-paused` while the SwapRouter is paused).
      * @throws AugustValidationError on an invalid target, or an unregistered
-     *   code under `attribution.strictOrigin`.
+     *   code under `attribution.strictOrigin` while the router is not paused.
      * @throws AugustSDKError when a backend, vault or router read fails.
      * @example
      * ```ts
@@ -174,7 +175,8 @@ declare class EVMAdapter {
      * @param options - {@link ISwapAndDepositOptions}.
      * @returns The transaction hash of the `swapAndDeposit` call.
      * @throws AugustValidationError on invalid inputs (bad chain, empty swaps).
-     * @throws AugustSDKError on RPC / contract revert.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      *
      * @example
      * ```ts
@@ -198,6 +200,8 @@ declare class EVMAdapter {
      *
      * @param options - {@link ISwapRouterDirectDepositOptions}.
      * @returns The transaction hash of the `deposit` call.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      */
     depositViaSwapRouter(options: ISwapRouterDirectDepositOptions): Promise<string>;
     /**
@@ -207,6 +211,8 @@ declare class EVMAdapter {
      *
      * @param options - {@link ISwapRouterNativeDepositOptions}.
      * @returns The transaction hash of the `depositNativeToken` call.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      */
     depositNativeViaSwapRouter(options: ISwapRouterNativeDepositOptions): Promise<string>;
     /**
@@ -224,6 +230,8 @@ declare class EVMAdapter {
      * @returns The transaction hash of the router deposit call.
      * @throws AugustValidationError on unsupported chain, invalid address, zero
      *   amount, a native deposit into a non-wrapped-native vault, or quote drift.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      * @example
      * ```ts
      * const hash = await augustSdk.evm.swapRouterDeposit({

package/lib/adapters/evm/index.js

@@ -154,9 +154,10 @@ class EVMAdapter {
      * (`route.spender`, not necessarily the vault). See {@link getDepositRoute}.
      *
      * @param options - {@link IGetDepositRouteOptions}.
-     * @returns `{ via, spender, reason? }` — `reason` explains a native route.
+     * @returns `{ via, spender, reason? }` — `reason` explains a native route
+     *   (`router-paused` while the SwapRouter is paused).
      * @throws AugustValidationError on an invalid target, or an unregistered
-     *   code under `attribution.strictOrigin`.
+     *   code under `attribution.strictOrigin` while the router is not paused.
      * @throws AugustSDKError when a backend, vault or router read fails.
      * @example
      * ```ts
@@ -231,7 +232,8 @@ class EVMAdapter {
      * @param options - {@link ISwapAndDepositOptions}.
      * @returns The transaction hash of the `swapAndDeposit` call.
      * @throws AugustValidationError on invalid inputs (bad chain, empty swaps).
-     * @throws AugustSDKError on RPC / contract revert.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      *
      * @example
      * ```ts
@@ -258,6 +260,8 @@ class EVMAdapter {
      *
      * @param options - {@link ISwapRouterDirectDepositOptions}.
      * @returns The transaction hash of the `deposit` call.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      */
     async depositViaSwapRouter(options) {
         const signer = await this._getSigner();
@@ -270,6 +274,8 @@ class EVMAdapter {
      *
      * @param options - {@link ISwapRouterNativeDepositOptions}.
      * @returns The transaction hash of the `depositNativeToken` call.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      */
     async depositNativeViaSwapRouter(options) {
         const signer = await this._getSigner();
@@ -290,6 +296,8 @@ class EVMAdapter {
      * @returns The transaction hash of the router deposit call.
      * @throws AugustValidationError on unsupported chain, invalid address, zero
      *   amount, a native deposit into a non-wrapped-native vault, or quote drift.
+     * @throws AugustSDKError while the SwapRouter is paused (checked before any
+     *   approval), or on RPC / contract revert.
      * @example
      * ```ts
      * const hash = await augustSdk.evm.swapRouterDeposit({

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

@@ -2,6 +2,14 @@ import type { ISolanaNetwork } from '../../types';
 import { vaultIdl } from './idl/vault-idl';
 declare const fallbackDecimals = 8;
 declare const fallbackNetwork: ISolanaNetwork;
+/**
+ * Program ids deployed on one Solana network. `withdrawalQueue` is absent where
+ * the queue program is not deployed yet (currently mainnet-beta).
+ */
+type ISolanaProgramIds = {
+    vault: string;
+    withdrawalQueue?: string;
+};
 declare const fallbackRpcEndpoints: {
     readonly devnet: "https://api.devnet.solana.com";
     readonly mainnet: "https://api.mainnet-beta.solana.com";
@@ -11,12 +19,14 @@ declare const fallbackRpcEndpoints: {
 declare const programIds: {
     devnet: {
         vault: string;
+        withdrawalQueue: string;
     };
     "mainnet-beta": {
         vault: string;
     };
     localnet: {
         vault: string;
+        withdrawalQueue: string;
     };
 };
 /** Solana networks the canonical august_vault program is actually deployed on. */
@@ -26,8 +36,6 @@ type ISolanaDeployedNetwork = keyof typeof programIds;
  * deployment there (currently `testnet`). Callers must handle `undefined` —
  * silently substituting a default would hand back a dead address.
  */
-declare function getDeployedProgramIds(network: ISolanaNetwork): {
-    vault: string;
-} | undefined;
+declare function getDeployedProgramIds(network: ISolanaNetwork): ISolanaProgramIds | undefined;
 export { fallbackDecimals, fallbackNetwork, fallbackRpcEndpoints, getDeployedProgramIds, programIds, vaultIdl, };
-export type { ISolanaDeployedNetwork };
+export type { ISolanaDeployedNetwork, ISolanaProgramIds };

package/lib/adapters/solana/constants.js

@@ -8,9 +8,6 @@ const fallbackDecimals = 8;
 exports.fallbackDecimals = fallbackDecimals;
 const fallbackNetwork = 'mainnet-beta';
 exports.fallbackNetwork = fallbackNetwork;
-// ============================================================================
-// SOLANA CONFIGURATION
-// ============================================================================
 const fallbackRpcEndpoints = {
     devnet: 'https://api.devnet.solana.com',
     mainnet: 'https://api.mainnet-beta.solana.com',
@@ -29,15 +26,23 @@ exports.fallbackRpcEndpoints = fallbackRpcEndpoints;
 // transaction. Unmapped networks throw from `getProgram`/`getProgramId` instead.
 // `satisfies` keeps the literal ids in the generated docs while checking keys
 // against ISolanaNetwork, so `testnet` is absent from the type, not optional.
+//
+// `withdrawalQueue` is the august_withdrawal_queue program. Its id is fixed (the
+// vault binary hardcodes it as `WITHDRAWAL_QUEUE_PROGRAM_ID`), but it is mapped
+// only where deployed: devnet and localnet. Mainnet-beta still runs the pre-queue
+// vault build, which the bundled vault IDL stays compatible with; add the entry
+// there once the mainnet upgrade deploys the queue.
 const programIds = {
     devnet: {
         vault: 'up12bytoZBmwofqsySf2uqKQ7zpfeKiAWwfvqzJjtRt',
+        withdrawalQueue: 'upQhC7mgYwmHLVaatRWoGAu394piLT9th9FiQZHnPrW',
     },
     ['mainnet-beta']: {
         vault: 'up12bytoZBmwofqsySf2uqKQ7zpfeKiAWwfvqzJjtRt',
     },
     localnet: {
         vault: 'up12bytoZBmwofqsySf2uqKQ7zpfeKiAWwfvqzJjtRt',
+        withdrawalQueue: 'upQhC7mgYwmHLVaatRWoGAu394piLT9th9FiQZHnPrW',
     },
 };
 exports.programIds = programIds;

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

@@ -4,6 +4,11 @@ import type { IVaultBaseOptions } from '../../modules/vaults/types';
  * Fetch Solana vault data from on-chain program state.
  * Falls back to backend-only data when Solana RPC is unavailable,
  * ensuring vaults always appear in the list even without on-chain access.
+ *
+ * When the vault has a withdrawal queue, `withdrawalQueue` carries its live
+ * summary, at the cost of one extra `getMultipleAccountsInfo` (the queue and a
+ * fresh read of the vault state, for `enabled`). A failed queue read is
+ * logged and leaves the field out rather than failing the vault.
  * @param tokenizedVault Vault metadata from backend
  * @param options RPC configuration with Solana service
  * @returns Formatted vault object with Solana-specific fields

package/lib/adapters/solana/getters.js

@@ -39,10 +39,16 @@ const utils_1 = require("./utils");
 const SolanaConstants = __importStar(require("./constants"));
 const core_1 = require("../../core");
 const utils_2 = require("../../modules/vaults/utils");
+const withdrawal_queue_1 = require("./withdrawal-queue");
 /**
  * Fetch Solana vault data from on-chain program state.
  * Falls back to backend-only data when Solana RPC is unavailable,
  * ensuring vaults always appear in the list even without on-chain access.
+ *
+ * When the vault has a withdrawal queue, `withdrawalQueue` carries its live
+ * summary, at the cost of one extra `getMultipleAccountsInfo` (the queue and a
+ * fresh read of the vault state, for `enabled`). A failed queue read is
+ * logged and leaves the field out rather than failing the vault.
  * @param tokenizedVault Vault metadata from backend
  * @param options RPC configuration with Solana service
  * @returns Formatted vault object with Solana-specific fields
@@ -101,6 +107,7 @@ const getSolanaVault = async (tokenizedVault, options) => {
     // Prefer vaultState.shareMint (correct for multi-vault programs like jitoSOL);
     // fall back to deriveShareMintPda(programId) for legacy single-vault programs.
     let totalSupply = (0, core_1.toNormalizedBn)(0, decimals);
+    let shareDecimals = decimals;
     if (onChainAvailable) {
         try {
             const shareMintFromState = vaultState?.vaultState?.shareMint;
@@ -112,6 +119,7 @@ const getSolanaVault = async (tokenizedVault, options) => {
                 const parsedData = shareMintAccountInfo.value.data;
                 const { supply, decimals: mintDecimals } = parsedData.parsed.info;
                 totalSupply = (0, core_1.toNormalizedBn)(BigInt(supply), mintDecimals);
+                shareDecimals = mintDecimals;
             }
         }
         catch (error) {
@@ -152,8 +160,31 @@ const getSolanaVault = async (tokenizedVault, options) => {
             vault: tokenizedVault.address,
         });
     }
+    let withdrawalQueue;
+    const solanaService = options.solanaService;
+    if (onChainAvailable && vaultState?.vaultState && solanaService) {
+        try {
+            const queueProgramId = (0, withdrawal_queue_1.resolveQueueProgramId)(solanaService);
+            withdrawalQueue = queueProgramId
+                ? await (0, withdrawal_queue_1.getSolanaWithdrawalQueueSummary)({
+                    connection: solanaService.connection,
+                    queueProgramId,
+                    vaultState: solanaMetadata?.vault_state_pda
+                        ? new web3_js_1.PublicKey(solanaMetadata.vault_state_pda)
+                        : utils_1.SolanaUtils.deriveVaultStatePda(programId),
+                    shareDecimals,
+                })
+                : undefined;
+        }
+        catch (error) {
+            core_1.Logger.log.warn('getSolanaVault', 'Withdrawal queue read failed', {
+                vault: tokenizedVault.address,
+                error,
+            });
+        }
+    }
     // Build unified vault object combining on-chain and backend data
-    return (0, utils_2.buildBackendVault)(tokenizedVault, {
+    const vault = (0, utils_2.buildBackendVault)(tokenizedVault, {
         chainId: core_1.SPECIAL_CHAINS.solana.chainId,
         version: 'sol-0',
         name: tokenizedVault.vault_name || 'Solana Program',
@@ -167,6 +198,9 @@ const getSolanaVault = async (tokenizedVault, options) => {
         },
         programId,
     });
+    if (withdrawalQueue)
+        vault.withdrawalQueue = withdrawalQueue;
+    return vault;
 };
 exports.getSolanaVault = getSolanaVault;
 //# sourceMappingURL=getters.js.map