@velocity-exchange/sdk 0.9.0 → 0.10.0

package/lib/browser/adminClient.d.ts

@@ -17,7 +17,7 @@ import { AddressLookupTableAccount, Keypair, PublicKey, TransactionInstruction,
 import { FeeStructure, OracleGuardRails, OracleSource, ExchangeStatus, SolvencyStatus, MarketStatus, ContractTier, AssetTier, TxParams, AddAmmConstituentMappingDatum, SwapReduceOnly, InitializeConstituentParams, ConstituentStatus, LPPoolAccount, TransferFeeAndPnlPoolDirection, MarketType } from './types';
 import { BN } from './isomorphic/anchor';
 import { VelocityClient } from './velocityClient';
-import { JupiterClient, QuoteResponse } from './jupiter/jupiterClient';
+import { JupiterClient, JupiterSwapQuote } from './jupiter/jupiterClient';
 import { SwapMode } from './swap/UnifiedSwapClient';
 export declare class AdminClient extends VelocityClient {
     /**
@@ -2283,7 +2283,7 @@ export declare class AdminClient extends VelocityClient {
         slippageBps?: number;
         swapMode?: SwapMode;
         onlyDirectRoutes?: boolean;
-        quote?: QuoteResponse;
+        quote?: JupiterSwapQuote;
         lpPoolId: number;
     }): Promise<{
         ixs: TransactionInstruction[];

package/lib/browser/adminClient.js

@@ -4496,21 +4496,13 @@ class AdminClient extends velocityClient_1.VelocityClient {
         if (!quote) {
             throw new Error('Could not fetch swap quote. Please try again.');
         }
+        this.assertQuoteMatchesMarkets(quote, inMarket, outMarket);
         const isExactOut = swapMode === 'ExactOut' || quote.swapMode === 'ExactOut';
         const amountIn = new anchor_1.BN(quote.inAmount);
         const exactOutBufferedAmountIn = amountIn.muln(1001).divn(1000); // Add 10bp buffer
-        const transaction = await jupiterClient.getSwap({
+        const { instructions: jupiterInstructions, lookupTables } = await jupiterClient.getRouteInstructions({
             quote,
             userPublicKey: this.provider.wallet.publicKey,
-            slippageBps,
-        });
-        const { transactionMessage, lookupTables } = await jupiterClient.getTransactionMessageAndLookupTables({
-            transaction,
-        });
-        const jupiterInstructions = jupiterClient.getJupiterInstructions({
-            transactionMessage,
-            inputMint: inMarket.mint,
-            outputMint: outMarket.mint,
         });
         const preInstructions = [];
         const tokenProgram = this.getTokenProgramForSpotMarket(outMarket);
@@ -4523,7 +4515,7 @@ class AdminClient extends velocityClient_1.VelocityClient {
         const inAssociatedTokenAccount = await this.getAssociatedTokenAccount(inMarket.marketIndex, false, inTokenProgram);
         const inAccountInfo = await this.connection.getAccountInfo(inAssociatedTokenAccount);
         if (!inAccountInfo) {
-            preInstructions.push(this.createAssociatedTokenAccountIdempotentInstruction(inAssociatedTokenAccount, this.provider.wallet.publicKey, this.provider.wallet.publicKey, inMarket.mint, tokenProgram));
+            preInstructions.push(this.createAssociatedTokenAccountIdempotentInstruction(inAssociatedTokenAccount, this.provider.wallet.publicKey, this.provider.wallet.publicKey, inMarket.mint, inTokenProgram));
         }
         const { beginSwapIx, endSwapIx } = await this.getSwapIx({
             lpPoolId,

package/lib/browser/equityFloorManager.d.ts

@@ -18,7 +18,7 @@ import { TxParams } from './types';
 /** One subaccount's standing relative to its floor. All BN values QUOTE_PRECISION. */
 export type SubaccountFloorStatus = {
     subAccountId: number;
-    /** Cross-margin total collateral, strict (TWAP-bounded) pricing — what the on-chain checks see. */
+    /** Net equity (`User.getNetUsdValue`, unweighted live-oracle value), what the onchain checks see. */
     equity: BN;
     equityFloor: BN;
     equityFloorBuffer: BN;
@@ -86,7 +86,7 @@ export type EquityFloorManagerConfig = {
     subAccountIds?: number[];
     /**
      * Client-side equity haircut (QUOTE_PRECISION) applied when sizing floor
-     * deltas, absorbing the dust by which strict on-chain pricing can differ
+     * deltas, absorbing the dust by which onchain oracle pricing can differ
      * from the client's. Defaults to 1 quote unit ($1).
      */
     collateralHaircut?: BN;
@@ -123,8 +123,8 @@ export declare class EquityFloorManager {
     getMaxQuoteTransferable(fromSubAccountId: number, toSubAccountId: number): BN;
     /**
      * Resolves a quote transfer into the exact instruction parameters,
-     * padding the auto floor delta by the haircut so on-chain strict pricing
-     * dust cannot fail it. The padded delta never exceeds the amount or the
+     * padding the auto floor delta by the haircut so onchain pricing dust
+     * cannot fail it. The padded delta never exceeds the amount or the
      * debited side's floor, so the credited side stays backed whenever it was
      * before.
      */
@@ -139,7 +139,11 @@ export declare class EquityFloorManager {
      * pinned in place and the rest is allocated around them. Throws when the
      * pool's equity cannot back the total floor plus buffers — at that point
      * no split works and equity must be deposited (or the admin must lower
-     * the floor).
+     * the floor). Each onchain move also carries a proportional share of the
+     * debited side's buffer, so buffers drift toward the same split as the
+     * floors; the plan sizes against current buffers and the haircut absorbs
+     * the drift dust, but a move can still revert if a credited side cannot
+     * back the buffer share it receives.
      */
     planFloorRebalance(): FloorMove[];
     /**

package/lib/browser/equityFloorManager.js

@@ -134,7 +134,7 @@ class EquityFloorManager {
     }
     getSubaccountStatus(user) {
         const userAccount = user.getUserAccountOrThrow();
-        const equity = user.getTotalCollateral('Initial', true);
+        const equity = user.getNetUsdValue();
         const bufferedFloor = userAccount.equityFloor.add(userAccount.equityFloorBuffer);
         return {
             subAccountId: userAccount.subAccountId,
@@ -212,15 +212,15 @@ class EquityFloorManager {
     }
     /**
      * Resolves a quote transfer into the exact instruction parameters,
-     * padding the auto floor delta by the haircut so on-chain strict pricing
-     * dust cannot fail it. The padded delta never exceeds the amount or the
+     * padding the auto floor delta by the haircut so onchain pricing dust
+     * cannot fail it. The padded delta never exceeds the amount or the
      * debited side's floor, so the credited side stays backed whenever it was
      * before.
      */
     planQuoteTransfer(amount, fromSubAccountId, toSubAccountId) {
         const fromUser = this.velocityClient.getUser(fromSubAccountId, this.velocityClient.authority);
         const fromAccount = fromUser.getUserAccountOrThrow();
-        const equityFloorDelta = (0, margin_1.calculateEquityFloorAutoDelta)(amount, fromUser.getTotalCollateral('Initial', true).sub(this.collateralHaircut), fromAccount.equityFloor, fromAccount.equityFloorBuffer);
+        const equityFloorDelta = (0, margin_1.calculateEquityFloorAutoDelta)(amount, fromUser.getNetUsdValue().sub(this.collateralHaircut), fromAccount.equityFloor, fromAccount.equityFloorBuffer);
         return {
             amount,
             marketIndex: numericConstants_2.QUOTE_SPOT_MARKET_INDEX,
@@ -242,7 +242,11 @@ class EquityFloorManager {
      * pinned in place and the rest is allocated around them. Throws when the
      * pool's equity cannot back the total floor plus buffers — at that point
      * no split works and equity must be deposited (or the admin must lower
-     * the floor).
+     * the floor). Each onchain move also carries a proportional share of the
+     * debited side's buffer, so buffers drift toward the same split as the
+     * floors; the plan sizes against current buffers and the haircut absorbs
+     * the drift dust, but a move can still revert if a credited side cannot
+     * back the buffer share it receives.
      */
     planFloorRebalance() {
         const subaccounts = this.getManagedUsers().map((user) => this.getSubaccountStatus(user));

package/lib/browser/idl/velocity.d.ts

@@ -24136,7 +24136,8 @@ export type Velocity = {
                     {
                         "name": "equityFloor";
                         "docs": [
-                            "Minimum account equity (cross-margin total collateral). Below this the",
+                            "Minimum account net equity (unweighted assets plus perp pnl minus",
+                            "spot liabilities, see `calculate_user_equity`). Below this the",
                             "permissionless breaker can trip. Risk-increasing orders, fills,",
                             "withdrawals and deposit transfers must clear `equity_floor +",
                             "equity_floor_buffer`. Settable only by the warm/cold admin; 0 disables",

package/lib/browser/idl/velocity.json

@@ -24130,7 +24130,8 @@
                     {
                         "name": "equity_floor",
                         "docs": [
-                            "Minimum account equity (cross-margin total collateral). Below this the",
+                            "Minimum account net equity (unweighted assets plus perp pnl minus",
+                            "spot liabilities, see `calculate_user_equity`). Below this the",
                             "permissionless breaker can trip. Risk-increasing orders, fills,",
                             "withdrawals and deposit transfers must clear `equity_floor +",
                             "equity_floor_buffer`. Settable only by the warm/cold admin; 0 disables",

package/lib/browser/index.d.ts

@@ -65,6 +65,8 @@ export * from './events/parse';
 export * from './events/pollingLogProvider';
 export * from './jupiter/jupiterClient';
 export * from './swap/UnifiedSwapClient';
+export * from './swap/types';
+export * from './swap/routeInstructions';
 export * from './math/auction';
 export * from './math/builder';
 export * from './math/spotMarket';

package/lib/browser/index.js

@@ -96,6 +96,9 @@ __exportStar(require("./events/pollingLogProvider"), exports);
 __exportStar(require("./jupiter/jupiterClient"), exports);
 // Primary swap client interface - use this for all swap operations
 __exportStar(require("./swap/UnifiedSwapClient"), exports);
+// The SwapProvider contract both providers implement, and the shared route filter
+__exportStar(require("./swap/types"), exports);
+__exportStar(require("./swap/routeInstructions"), exports);
 __exportStar(require("./math/auction"), exports);
 __exportStar(require("./math/builder"), exports);
 __exportStar(require("./math/spotMarket"), exports);

package/lib/browser/jupiter/jupiterClient.d.ts

@@ -1,6 +1,5 @@
 import { AddressLookupTableAccount, Connection, PublicKey, TransactionInstruction, TransactionMessage, VersionedTransaction } from '@solana/web3.js';
-import { BN } from '../isomorphic/anchor';
-import { SwapMode } from '../swap/UnifiedSwapClient';
+import { GetRouteInstructionsParams, SwapMode, SwapProvider, SwapQuote, SwapQuoteParams, SwapRouteInstructions } from '../swap/types';
 export interface MarketInfo {
     id: string;
     inAmount: number;
@@ -207,14 +206,17 @@ export interface QuoteResponse {
      */
     errorCode?: string;
 }
+/** A Jupiter quote plus the payload {@link JupiterClient.getRouteInstructions} needs. */
+export type JupiterSwapQuote = QuoteResponse & SwapQuote;
 export declare const RECOMMENDED_JUPITER_API_VERSION = "/v1";
 /** @deprecated Use RECOMMENDED_JUPITER_API instead. lite-api.jup.ag requires migration to api.jup.ag with API key. */
 export declare const LEGACY_JUPITER_API = "https://lite-api.jup.ag/swap";
 export declare const RECOMMENDED_JUPITER_API = "https://api.jup.ag/swap";
-export declare class JupiterClient {
+export declare class JupiterClient implements SwapProvider {
+    readonly providerName: "jupiter";
     url: string;
     connection: Connection;
-    lookupTableCahce: Map<string, AddressLookupTableAccount>;
+    lookupTableCache: Map<string, AddressLookupTableAccount>;
     private apiKey?;
     /**
      * Create a Jupiter client
@@ -240,31 +242,34 @@ export declare class JupiterClient {
      * @param swapMode the swap mode (ExactIn or ExactOut)
      * @param onlyDirectRoutes whether to only return direct routes
      */
-    getQuote({ inputMint, outputMint, amount, maxAccounts, // 50 is an estimated amount with buffer
-    slippageBps, swapMode, onlyDirectRoutes, excludeDexes, autoSlippage, maxAutoSlippageBps, usdEstimate, }: {
-        inputMint: PublicKey;
-        outputMint: PublicKey;
-        amount: BN;
-        maxAccounts?: number;
-        slippageBps?: number;
-        swapMode?: SwapMode;
-        onlyDirectRoutes?: boolean;
-        excludeDexes?: string[];
-        autoSlippage?: boolean;
-        maxAutoSlippageBps?: number;
-        usdEstimate?: number;
-    }): Promise<QuoteResponse>;
+    getQuote({ inputMint, outputMint, amount, maxAccounts, slippageBps, swapMode, onlyDirectRoutes, excludeDexes, autoSlippage, maxAutoSlippageBps, usdEstimate, }: SwapQuoteParams): Promise<JupiterSwapQuote>;
     /**
      * Get a swap transaction for quote
-     * @param quoteResponse quote to perform swap
+     * @param quote quote to perform swap, from {@link getQuote}
      * @param userPublicKey the signer's wallet public key
-     * @param slippageBps the slippage tolerance in basis points
+     *
+     * Always builds at the quote's own slippage — the price the caller was
+     * shown. Re-quote to change it rather than overriding it here.
      */
-    getSwap({ quote, userPublicKey, slippageBps, }: {
-        quote: QuoteResponse;
+    getSwap({ quote, userPublicKey, }: {
+        quote: QuoteResponse | JupiterSwapQuote;
         userPublicKey: PublicKey;
-        slippageBps?: number;
     }): Promise<VersionedTransaction>;
+    /**
+     * The standalone transaction Jupiter's `/swap` endpoint returns, setup and
+     * teardown included.
+     * @throws If the quote came from a different provider or a different wallet.
+     */
+    getSwapTransaction({ quote, userPublicKey, }: GetRouteInstructionsParams): Promise<VersionedTransaction>;
+    /**
+     * Builds the route instructions for a quote returned by {@link getQuote}.
+     *
+     * The quote carries its own route payload, so this reads no client state
+     * and two quotes in flight can never be confused for one another. The swap
+     * is built at the slippage the quote was priced at — re-quote to change it.
+     * @throws If the quote came from a different provider or a different wallet.
+     */
+    getRouteInstructions({ quote, userPublicKey, }: GetRouteInstructionsParams): Promise<SwapRouteInstructions>;
     /**
      * Get the transaction message and lookup tables for a transaction
      * @param transaction
@@ -277,10 +282,9 @@ export declare class JupiterClient {
     }>;
     getLookupTable(accountKey: PublicKey): Promise<AddressLookupTableAccount | undefined>;
     /**
-     * Get the jupiter instructions from transaction by filtering out instructions to compute budget and associated token programs
-     * @param transactionMessage the transaction message
-     * @param inputMint the input mint
-     * @param outputMint the output mint
+     * Strips the setup/teardown Jupiter wraps around its route.
+     * @deprecated Use {@link getRouteInstructions}, which quotes and filters in
+     * one step. Kept for callers holding a decompiled message of their own.
      */
     getJupiterInstructions({ transactionMessage, inputMint, outputMint, }: {
         transactionMessage: TransactionMessage;

package/lib/browser/jupiter/jupiterClient.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JupiterClient = exports.RECOMMENDED_JUPITER_API = exports.LEGACY_JUPITER_API = exports.RECOMMENDED_JUPITER_API_VERSION = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const node_fetch_1 = __importDefault(require("node-fetch"));
+const routeInstructions_1 = require("../swap/routeInstructions");
+const types_1 = require("../swap/types");
 exports.RECOMMENDED_JUPITER_API_VERSION = '/v1';
 /** @deprecated Use RECOMMENDED_JUPITER_API instead. lite-api.jup.ag requires migration to api.jup.ag with API key. */
 exports.LEGACY_JUPITER_API = 'https://lite-api.jup.ag/swap';
@@ -18,7 +20,8 @@ class JupiterClient {
      * @param apiKey - API key for Jupiter API. Required for api.jup.ag (free tier available at https://portal.jup.ag)
      */
     constructor({ connection, url, apiKey, }) {
-        this.lookupTableCahce = new Map();
+        this.providerName = 'jupiter';
+        this.lookupTableCache = new Map();
         this.connection = connection;
         this.url = url !== null && url !== void 0 ? url : exports.RECOMMENDED_JUPITER_API;
         this.apiKey = apiKey;
@@ -45,8 +48,7 @@ class JupiterClient {
      * @param swapMode the swap mode (ExactIn or ExactOut)
      * @param onlyDirectRoutes whether to only return direct routes
      */
-    async getQuote({ inputMint, outputMint, amount, maxAccounts = 50, // 50 is an estimated amount with buffer
-    slippageBps = 50, swapMode = 'ExactIn', onlyDirectRoutes = false, excludeDexes, autoSlippage = false, maxAutoSlippageBps, usdEstimate, }) {
+    async getQuote({ inputMint, outputMint, amount, maxAccounts = types_1.DEFAULT_SWAP_MAX_ACCOUNTS, slippageBps = 50, swapMode = 'ExactIn', onlyDirectRoutes = false, excludeDexes, autoSlippage = false, maxAutoSlippageBps, usdEstimate, }) {
         var _a;
         if (autoSlippage && maxAutoSlippageBps === undefined) {
             throw new Error('JupiterClient.getQuote: maxAutoSlippageBps is required when autoSlippage is enabled');
@@ -94,19 +96,25 @@ class JupiterClient {
         if (!quote.inputMint || !quote.outputMint || !quote.outAmount) {
             throw new Error('Jupiter quote failed: response is missing route fields');
         }
-        return quote;
+        // Jupiter's /swap endpoint takes the quote body back verbatim, so the
+        // quote is its own route payload.
+        return (0, types_1.buildSwapQuote)(quote, { provider: 'jupiter', quote });
     }
     /**
      * Get a swap transaction for quote
-     * @param quoteResponse quote to perform swap
+     * @param quote quote to perform swap, from {@link getQuote}
      * @param userPublicKey the signer's wallet public key
-     * @param slippageBps the slippage tolerance in basis points
+     *
+     * Always builds at the quote's own slippage — the price the caller was
+     * shown. Re-quote to change it rather than overriding it here.
      */
-    async getSwap({ quote, userPublicKey, slippageBps = 50, }) {
+    async getSwap({ quote, userPublicKey, }) {
         var _a;
         if (!quote) {
             throw new Error('Jupiter swap quote not provided. Please try again.');
         }
+        // `providerRoute` is our own wrapper, not part of Jupiter's quote body.
+        const { providerRoute: _providerRoute, ...quoteResponse } = quote;
         const apiVersionParam = this.url === exports.RECOMMENDED_JUPITER_API || this.url === exports.LEGACY_JUPITER_API
             ? exports.RECOMMENDED_JUPITER_API_VERSION
             : '';
@@ -114,9 +122,9 @@ class JupiterClient {
             method: 'POST',
             headers: this.getHeaders('application/json'),
             body: JSON.stringify({
-                quoteResponse: quote,
+                quoteResponse,
                 userPublicKey,
-                slippageBps,
+                slippageBps: quoteResponse.slippageBps,
             }),
         })).json();
         if (!('swapTransaction' in resp)) {
@@ -131,6 +139,41 @@ class JupiterClient {
             throw new Error('Something went wrong with creating the Jupiter swap transaction. Please try again.');
         }
     }
+    /**
+     * The standalone transaction Jupiter's `/swap` endpoint returns, setup and
+     * teardown included.
+     * @throws If the quote came from a different provider or a different wallet.
+     */
+    async getSwapTransaction({ quote, userPublicKey, }) {
+        const jupiterQuote = (0, types_1.expectProviderRoute)(quote, 'jupiter', userPublicKey)
+            .quote;
+        return this.getSwap({ quote: jupiterQuote, userPublicKey });
+    }
+    /**
+     * Builds the route instructions for a quote returned by {@link getQuote}.
+     *
+     * The quote carries its own route payload, so this reads no client state
+     * and two quotes in flight can never be confused for one another. The swap
+     * is built at the slippage the quote was priced at — re-quote to change it.
+     * @throws If the quote came from a different provider or a different wallet.
+     */
+    async getRouteInstructions({ quote, userPublicKey, }) {
+        const jupiterQuote = (0, types_1.expectProviderRoute)(quote, 'jupiter', userPublicKey)
+            .quote;
+        const transaction = await this.getSwap({
+            quote: jupiterQuote,
+            userPublicKey,
+        });
+        const { transactionMessage, lookupTables } = await this.getTransactionMessageAndLookupTables({ transaction });
+        return {
+            instructions: (0, routeInstructions_1.filterRouteInstructions)({
+                instructions: transactionMessage.instructions,
+                inputMint: new web3_js_1.PublicKey(quote.inputMint),
+                outputMint: new web3_js_1.PublicKey(quote.outputMint),
+            }),
+            lookupTables,
+        };
+    }
     /**
      * Get the transaction message and lookup tables for a transaction
      * @param transaction
@@ -149,7 +192,7 @@ class JupiterClient {
         };
     }
     async getLookupTable(accountKey) {
-        const cached = this.lookupTableCahce.get(accountKey.toString());
+        const cached = this.lookupTableCache.get(accountKey.toString());
         if (cached !== undefined) {
             return cached;
         }
@@ -159,36 +202,19 @@ class JupiterClient {
         }
         // Populate the cache — without this every route re-fetches the same tables,
         // which is a large share of the RPC calls a swap makes.
-        this.lookupTableCahce.set(accountKey.toString(), lookupTable);
+        this.lookupTableCache.set(accountKey.toString(), lookupTable);
         return lookupTable;
     }
     /**
-     * Get the jupiter instructions from transaction by filtering out instructions to compute budget and associated token programs
-     * @param transactionMessage the transaction message
-     * @param inputMint the input mint
-     * @param outputMint the output mint
+     * Strips the setup/teardown Jupiter wraps around its route.
+     * @deprecated Use {@link getRouteInstructions}, which quotes and filters in
+     * one step. Kept for callers holding a decompiled message of their own.
      */
     getJupiterInstructions({ transactionMessage, inputMint, outputMint, }) {
-        return transactionMessage.instructions.filter((instruction) => {
-            if (instruction.programId.toString() ===
-                'ComputeBudget111111111111111111111111111111') {
-                return false;
-            }
-            if (instruction.programId.toString() ===
-                'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA') {
-                return false;
-            }
-            if (instruction.programId.toString() === '11111111111111111111111111111111') {
-                return false;
-            }
-            if (instruction.programId.toString() ===
-                'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL') {
-                const mint = instruction.keys[3].pubkey;
-                if (mint.equals(inputMint) || mint.equals(outputMint)) {
-                    return false;
-                }
-            }
-            return true;
+        return (0, routeInstructions_1.filterRouteInstructions)({
+            instructions: transactionMessage.instructions,
+            inputMint,
+            outputMint,
         });
     }
 }

package/lib/browser/math/margin.d.ts

@@ -104,13 +104,14 @@ export declare function calculateCollateralDepositRequiredForTrade(velocityClien
  * Minimal equity floor to carry along with a quote transfer of `amount` out
  * of a subaccount so the debited side ends at/above its buffered floor
  * (`equityFloor + equityFloorBuffer`): the first
- * `totalCollateral - (floor + buffer)` of the transfer carries no floor, the
+ * `netEquity - (floor + buffer)` of the transfer carries no floor, the
  * remainder carries floor one-for-one, capped at the floor the subaccount
- * actually holds. Returns zero when no floor is set. The result never exceeds
- * `amount`, so a credited side that met its own buffered floor before the
- * transfer still meets it after. All values QUOTE_PRECISION.
+ * actually holds. `netEquity` is `User.getNetUsdValue()`, the metric the
+ * onchain floor checks use. Returns zero when no floor is set. The result
+ * never exceeds `amount`, so a credited side that met its own buffered floor
+ * before the transfer still meets it after. All values QUOTE_PRECISION.
  */
-export declare function calculateEquityFloorAutoDelta(amount: BN, totalCollateral: BN, equityFloor: BN, equityFloorBuffer: BN): BN;
+export declare function calculateEquityFloorAutoDelta(amount: BN, netEquity: BN, equityFloor: BN, equityFloorBuffer: BN): BN;
 /**
  * Severity of a subaccount's equity relative to its floor, most to least
  * severe. `breached`: below the floor, the permissionless breaker can trip.
@@ -120,9 +121,10 @@ export declare function calculateEquityFloorAutoDelta(amount: BN, totalCollatera
  */
 export type EquityFloorLevel = 'breached' | 'critical' | 'warning' | 'healthy' | 'disabled';
 /**
- * Classifies `totalCollateral` against the floor thresholds. Used by the
- * `EquityFloorManager` and the equity-floor guard bot so both report the same
- * levels. `warningBufferMultiple` scales the warning threshold above the
- * floor (default 2: warn inside `floor + 2 * buffer`). All QUOTE_PRECISION.
+ * Classifies `netEquity` (`User.getNetUsdValue()`) against the floor
+ * thresholds. Used by the `EquityFloorManager` and the equity-floor guard bot
+ * so both report the same levels. `warningBufferMultiple` scales the warning
+ * threshold above the floor (default 2: warn inside `floor + 2 * buffer`).
+ * All QUOTE_PRECISION.
  */
-export declare function getEquityFloorLevel(totalCollateral: BN, equityFloor: BN, equityFloorBuffer: BN, warningBufferMultiple?: number): EquityFloorLevel;
+export declare function getEquityFloorLevel(netEquity: BN, equityFloor: BN, equityFloorBuffer: BN, warningBufferMultiple?: number): EquityFloorLevel;

package/lib/browser/math/margin.js

@@ -214,37 +214,39 @@ exports.calculateCollateralDepositRequiredForTrade = calculateCollateralDepositR
  * Minimal equity floor to carry along with a quote transfer of `amount` out
  * of a subaccount so the debited side ends at/above its buffered floor
  * (`equityFloor + equityFloorBuffer`): the first
- * `totalCollateral - (floor + buffer)` of the transfer carries no floor, the
+ * `netEquity - (floor + buffer)` of the transfer carries no floor, the
  * remainder carries floor one-for-one, capped at the floor the subaccount
- * actually holds. Returns zero when no floor is set. The result never exceeds
- * `amount`, so a credited side that met its own buffered floor before the
- * transfer still meets it after. All values QUOTE_PRECISION.
+ * actually holds. `netEquity` is `User.getNetUsdValue()`, the metric the
+ * onchain floor checks use. Returns zero when no floor is set. The result
+ * never exceeds `amount`, so a credited side that met its own buffered floor
+ * before the transfer still meets it after. All values QUOTE_PRECISION.
  */
-function calculateEquityFloorAutoDelta(amount, totalCollateral, equityFloor, equityFloorBuffer) {
+function calculateEquityFloorAutoDelta(amount, netEquity, equityFloor, equityFloorBuffer) {
     if (equityFloor.lte(numericConstants_1.ZERO)) {
         return numericConstants_1.ZERO;
     }
-    const excess = anchor_1.BN.max(totalCollateral.sub(equityFloor.add(equityFloorBuffer)), numericConstants_1.ZERO);
+    const excess = anchor_1.BN.max(netEquity.sub(equityFloor.add(equityFloorBuffer)), numericConstants_1.ZERO);
     return anchor_1.BN.min(anchor_1.BN.max(amount.sub(excess), numericConstants_1.ZERO), equityFloor);
 }
 exports.calculateEquityFloorAutoDelta = calculateEquityFloorAutoDelta;
 /**
- * Classifies `totalCollateral` against the floor thresholds. Used by the
- * `EquityFloorManager` and the equity-floor guard bot so both report the same
- * levels. `warningBufferMultiple` scales the warning threshold above the
- * floor (default 2: warn inside `floor + 2 * buffer`). All QUOTE_PRECISION.
+ * Classifies `netEquity` (`User.getNetUsdValue()`) against the floor
+ * thresholds. Used by the `EquityFloorManager` and the equity-floor guard bot
+ * so both report the same levels. `warningBufferMultiple` scales the warning
+ * threshold above the floor (default 2: warn inside `floor + 2 * buffer`).
+ * All QUOTE_PRECISION.
  */
-function getEquityFloorLevel(totalCollateral, equityFloor, equityFloorBuffer, warningBufferMultiple = 2) {
+function getEquityFloorLevel(netEquity, equityFloor, equityFloorBuffer, warningBufferMultiple = 2) {
     if (equityFloor.lte(numericConstants_1.ZERO)) {
         return 'disabled';
     }
-    if (totalCollateral.lt(equityFloor)) {
+    if (netEquity.lt(equityFloor)) {
         return 'breached';
     }
-    if (totalCollateral.lt(equityFloor.add(equityFloorBuffer))) {
+    if (netEquity.lt(equityFloor.add(equityFloorBuffer))) {
         return 'critical';
     }
-    if (totalCollateral.lt(equityFloor.add(equityFloorBuffer.muln(warningBufferMultiple)))) {
+    if (netEquity.lt(equityFloor.add(equityFloorBuffer.muln(warningBufferMultiple)))) {
         return 'warning';
     }
     return 'healthy';

package/lib/browser/math/superStake.d.ts

@@ -1,5 +1,5 @@
 import { AddressLookupTableAccount, PublicKey, TransactionInstruction } from '@solana/web3.js';
-import { JupiterClient, QuoteResponse } from '../jupiter/jupiterClient';
+import { JupiterClient, JupiterSwapQuote } from '../jupiter/jupiterClient';
 import { VelocityClient } from '../velocityClient';
 import { BN } from '../isomorphic/anchor';
 import { User } from '../user';
@@ -61,7 +61,7 @@ export declare function fetchBSolVelocityEmissions(): Promise<fetch.Response>;
  * @param {boolean} [params.forceMarinade] - Force the direct Marinade stake path over a Jupiter
  *   swap even if Jupiter would be cheaper (market index 2 only)
  * @param {boolean} [params.onlyDirectRoutes] - Restrict Jupiter routing to direct swaps only
- * @param {QuoteResponse} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse instead of
+ * @param {JupiterSwapQuote} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse instead of
  *   fetching a fresh one
  * @return {Promise<{ ixs: TransactionInstruction[]; lookupTables: AddressLookupTableAccount[];
  *   method: 'jupiter' | 'marinade'; price?: number }>} The instructions to submit, any address
@@ -78,7 +78,7 @@ export declare function findBestSuperStakeIxs({ marketIndex, amount, jupiterClie
     userAccountPublicKey?: PublicKey;
     forceMarinade?: boolean;
     onlyDirectRoutes?: boolean;
-    jupiterQuote?: QuoteResponse;
+    jupiterQuote?: JupiterSwapQuote;
 }): Promise<{
     ixs: TransactionInstruction[];
     lookupTables: AddressLookupTableAccount[];
@@ -100,7 +100,7 @@ export declare function findBestSuperStakeIxs({ marketIndex, amount, jupiterClie
  * @param {PublicKey} [params.userAccountPublicKey] - The target sub-account
  * @param {boolean} [params.forceMarinade] - Force the Marinade path regardless of Jupiter pricing
  * @param {boolean} [params.onlyDirectRoutes] - Restrict Jupiter routing to direct swaps only
- * @param {QuoteResponse} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
+ * @param {JupiterSwapQuote} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
  * @return {Promise<{ ixs: TransactionInstruction[]; lookupTables: AddressLookupTableAccount[];
  *   method: 'jupiter' | 'marinade'; price: number }>} The chosen route's instructions, required
  *   lookup tables, the method used, and the mSOL/SOL price used for the decision
@@ -113,7 +113,7 @@ export declare function findBestMSolSuperStakeIxs({ amount, jupiterClient, veloc
     userAccountPublicKey?: PublicKey;
     forceMarinade?: boolean;
     onlyDirectRoutes?: boolean;
-    jupiterQuote?: QuoteResponse;
+    jupiterQuote?: JupiterSwapQuote;
 }): Promise<{
     ixs: TransactionInstruction[];
     lookupTables: AddressLookupTableAccount[];
@@ -130,7 +130,7 @@ export declare function findBestMSolSuperStakeIxs({ amount, jupiterClient, veloc
  * @param {VelocityClient} params.velocityClient - Velocity client
  * @param {PublicKey} [params.userAccountPublicKey] - The target sub-account
  * @param {boolean} [params.onlyDirectRoutes] - Restrict Jupiter routing to direct swaps only
- * @param {QuoteResponse} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
+ * @param {JupiterSwapQuote} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
  * @return {Promise<{ ixs: TransactionInstruction[]; lookupTables: AddressLookupTableAccount[];
  *   method: 'jupiter' | 'marinade'; price?: number }>} Always resolves with `method: 'jupiter'`
  */
@@ -140,7 +140,7 @@ export declare function findBestJitoSolSuperStakeIxs({ amount, jupiterClient, ve
     velocityClient: VelocityClient;
     userAccountPublicKey?: PublicKey;
     onlyDirectRoutes?: boolean;
-    jupiterQuote?: QuoteResponse;
+    jupiterQuote?: JupiterSwapQuote;
 }): Promise<{
     ixs: TransactionInstruction[];
     lookupTables: AddressLookupTableAccount[];
@@ -161,7 +161,7 @@ export declare function findBestJitoSolSuperStakeIxs({ amount, jupiterClient, ve
  * @param {VelocityClient} params.velocityClient - Velocity client
  * @param {PublicKey} [params.userAccountPublicKey] - The target sub-account
  * @param {boolean} [params.onlyDirectRoutes] - Restrict Jupiter routing to direct swaps only
- * @param {QuoteResponse} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
+ * @param {JupiterSwapQuote} [params.jupiterQuote] - A pre-fetched Jupiter quote to reuse
  * @return {Promise<{ ixs: TransactionInstruction[]; lookupTables: AddressLookupTableAccount[];
  *   method: 'jupiter' | 'marinade' }>} Always resolves with `method: 'jupiter'`
  */
@@ -173,7 +173,7 @@ export declare function findBestLstSuperStakeIxs({ amount, jupiterClient, veloci
     velocityClient: VelocityClient;
     userAccountPublicKey?: PublicKey;
     onlyDirectRoutes?: boolean;
-    jupiterQuote?: QuoteResponse;
+    jupiterQuote?: JupiterSwapQuote;
 }): Promise<{
     ixs: TransactionInstruction[];
     lookupTables: AddressLookupTableAccount[];