@drift-labs/sdk-browser 2.163.0-beta.0 → 2.163.0-beta.11

package/lib/browser/types.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlaceAndTakeOrderSuccessCondition = exports.FuelOverflowStatus = exports.ReferrerStatus = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PositionFlag = exports.OrderParamsBitFlag = exports.SizeDistribution = exports.PostOnlyParams = exports.LiquidationBitFlag = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderBitFlag = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSourceNum = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.TokenProgramFlag = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.MarginMode = exports.MarketConfigFlag = exports.UserStatsPausedOperation = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.FeatureBitFlags = exports.ExchangeStatus = void 0;
-exports.ConstituentLpOperation = exports.ConstituentStatus = exports.OracleValidity = exports.SwapReduceOnly = void 0;
+exports.FuelOverflowStatus = exports.ReferrerStatus = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PositionFlag = exports.OrderParamsBitFlag = exports.SizeDistribution = exports.PostOnlyParams = exports.LiquidationBitFlag = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderBitFlag = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSourceNum = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.TokenProgramFlag = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.MarginMode = exports.MarketConfigFlag = exports.UserStatsPausedOperation = exports.SpecialUserStatus = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.FeatureBitFlags = exports.ExchangeStatus = void 0;
+exports.TransferFeeAndPnlPoolDirection = exports.ConstituentLpOperation = exports.ConstituentStatus = exports.OracleValidity = exports.SwapReduceOnly = exports.PlaceAndTakeOrderSuccessCondition = void 0;
 const numericConstants_1 = require("./constants/numericConstants");
 // # Utility Types / Enums / Constants
 var ExchangeStatus;
@@ -29,10 +29,6 @@ class MarketStatus {
 exports.MarketStatus = MarketStatus;
 MarketStatus.INITIALIZED = { initialized: {} };
 MarketStatus.ACTIVE = { active: {} };
-MarketStatus.FUNDING_PAUSED = { fundingPaused: {} };
-MarketStatus.AMM_PAUSED = { ammPaused: {} };
-MarketStatus.FILL_PAUSED = { fillPaused: {} };
-MarketStatus.WITHDRAW_PAUSED = { withdrawPaused: {} };
 MarketStatus.REDUCE_ONLY = { reduceOnly: {} };
 MarketStatus.SETTLEMENT = { settlement: {} };
 MarketStatus.DELISTED = { delisted: {} };
@@ -69,6 +65,10 @@ var UserStatus;
     UserStatus[UserStatus["ADVANCED_LP"] = 8] = "ADVANCED_LP";
     UserStatus[UserStatus["PROTECTED_MAKER"] = 16] = "PROTECTED_MAKER";
 })(UserStatus || (exports.UserStatus = UserStatus = {}));
+var SpecialUserStatus;
+(function (SpecialUserStatus) {
+    SpecialUserStatus[SpecialUserStatus["VAMM_HEDGER"] = 1] = "VAMM_HEDGER";
+})(SpecialUserStatus || (exports.SpecialUserStatus = SpecialUserStatus = {}));
 var UserStatsPausedOperation;
 (function (UserStatsPausedOperation) {
     UserStatsPausedOperation[UserStatsPausedOperation["UPDATE_BID_ASK_TWAP"] = 1] = "UPDATE_BID_ASK_TWAP";
@@ -83,16 +83,11 @@ class MarginMode {
 }
 exports.MarginMode = MarginMode;
 MarginMode.DEFAULT = { default: {} };
-MarginMode.HIGH_LEVERAGE = { highLeverage: {} };
-MarginMode.HIGH_LEVERAGE_MAINTENANCE = {
-    highLeverageMaintenance: {},
-};
 class ContractType {
 }
 exports.ContractType = ContractType;
 ContractType.PERPETUAL = { perpetual: {} };
 ContractType.FUTURE = { future: {} };
-ContractType.PREDICTION = { prediction: {} };
 class ContractTier {
 }
 exports.ContractTier = ContractTier;
@@ -388,7 +383,6 @@ class OrderParamsBitFlag {
 }
 exports.OrderParamsBitFlag = OrderParamsBitFlag;
 OrderParamsBitFlag.ImmediateOrCancel = 1;
-OrderParamsBitFlag.UpdateHighLeverageMode = 2;
 class PositionFlag {
 }
 exports.PositionFlag = PositionFlag;
@@ -461,3 +455,8 @@ var ConstituentLpOperation;
     ConstituentLpOperation[ConstituentLpOperation["Deposit"] = 2] = "Deposit";
     ConstituentLpOperation[ConstituentLpOperation["Withdraw"] = 4] = "Withdraw";
 })(ConstituentLpOperation || (exports.ConstituentLpOperation = ConstituentLpOperation = {}));
+class TransferFeeAndPnlPoolDirection {
+}
+exports.TransferFeeAndPnlPoolDirection = TransferFeeAndPnlPoolDirection;
+TransferFeeAndPnlPoolDirection.FEE_TO_PNL_POOL = { feeToPnlPool: {} };
+TransferFeeAndPnlPoolDirection.PNL_TO_FEE_POOL = { pnlToFeePool: {} };

package/lib/browser/user.d.ts

@@ -1,5 +1,18 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
+/**
+ * User — read-oriented abstraction over the on-chain `User` account.
+ *
+ * Responsibilities:
+ *   - Margin and free-collateral calculations (mirrors `programs/drift/src/math/margin.rs`).
+ *   - Position accessors: perp positions, spot positions, unrealized PnL, leverage.
+ *   - Open order queries and filtering.
+ *   - Health factor and liquidation threshold checks.
+ *   - Subscribes to and caches the latest `User` account state from chain.
+ *
+ * To send instructions (deposit, place order, etc.) use {@link DriftClient}.
+ * For referral/volume stats see {@link UserStats} (userStats.ts).
+ */
 import { PublicKey } from '@solana/web3.js';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
@@ -98,17 +111,17 @@ export declare class User {
      * calculates Buying Power = free collateral / initial margin ratio
      * @returns : Precision QUOTE_PRECISION
      */
-    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, enterHighLeverageMode?: any, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): BN;
-    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, enterHighLeverageMode?: any, perpMarketMaxMarginRatio?: any): BN;
+    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): BN;
+    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, perpMarketMaxMarginRatio?: any): BN;
     /**
      * calculates Free Collateral = Total collateral - margin requirement
      * @returns : Precision QUOTE_PRECISION
      */
-    getFreeCollateral(marginCategory?: MarginCategory, enterHighLeverageMode?: boolean, perpMarketIndex?: number): BN;
+    getFreeCollateral(marginCategory?: MarginCategory, perpMarketIndex?: number): BN;
     /**
      * @deprecated Use the overload that includes { marginType, perpMarketIndex }
      */
-    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean, enteringHighLeverage?: boolean): BN;
+    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean): BN;
     /**
      * Calculates the margin requirement based on the specified parameters.
      *
@@ -116,16 +129,15 @@ export declare class User {
      * @param liquidationBuffer - Optional buffer amount to consider during liquidation scenarios.
      * @param strict - Optional flag to enforce strict margin calculations.
      * @param includeOpenOrders - Optional flag to include open orders in the margin calculation.
-     * @param enteringHighLeverage - Optional flag indicating if the user is entering high leverage mode.
      * @param perpMarketIndex - Optional index of the perpetual market. Required if marginType is 'Isolated'.
      *
      * @returns The calculated margin requirement as a BN (BigNumber).
      */
-    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean, enteringHighLeverage?: boolean, perpMarketIndex?: number): BN;
+    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean, perpMarketIndex?: number): BN;
     /**
      * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
      */
-    getInitialMarginRequirement(enterHighLeverageMode?: boolean, perpMarketIndex?: number): BN;
+    getInitialMarginRequirement(perpMarketIndex?: number): BN;
     /**
      * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION
      */
@@ -175,7 +187,7 @@ export declare class User {
      * @returns : number (value from [0, 100])
      */
     getHealth(perpMarketIndex?: number): number;
-    calculateWeightedPerpPositionLiability(perpPosition: PerpPosition, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean, enteringHighLeverage?: any): BN;
+    calculateWeightedPerpPositionLiability(perpPosition: PerpPosition, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean): BN;
     /**
      * calculates position value of a single perp market in margin system
      * @returns : Precision QUOTE_PRECISION
@@ -185,7 +197,7 @@ export declare class User {
      * calculates sum of position value across all positions in margin system
      * @returns : Precision QUOTE_PRECISION
      */
-    getTotalPerpPositionLiability(marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean, enteringHighLeverage?: any): BN;
+    getTotalPerpPositionLiability(marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean): BN;
     /**
      * calculates position value based on oracle
      * @returns : Precision QUOTE_PRECISION
@@ -235,10 +247,9 @@ export declare class User {
      * for large sizes where imf factor activates, result is a lower bound
      * @param marginCategory {Initial, Maintenance}
      * @param isLp if calculating max leveraging for adding lp, need to add buffer
-     * @param enterHighLeverageMode can pass this as true to calculate max leverage if the user was to enter high leverage mode
      * @returns : Precision TEN_THOUSAND
      */
-    getMaxLeverageForPerp(perpMarketIndex: number, _marginCategory?: MarginCategory, isLp?: boolean, enterHighLeverageMode?: any): BN;
+    getMaxLeverageForPerp(perpMarketIndex: number, _marginCategory?: MarginCategory, isLp?: boolean): BN;
     /**
      * calculates max allowable leverage exceeding hitting requirement category
      * @param spotMarketIndex
@@ -272,7 +283,6 @@ export declare class User {
     canIsolatedPositionMarginBeLiquidated(isolatedMarginCalculation: IsolatedMarginCalculation): boolean;
     hasStatus(status: UserStatus): boolean;
     isBankrupt(): boolean;
-    isHighLeverageMode(marginCategory: MarginCategory): boolean;
     /**
      * Checks if any user position cumulative funding differs from respective market cumulative funding
      * @returns
@@ -294,9 +304,9 @@ export declare class User {
      * @param offsetCollateral // allows calculating the liquidation price after this offset collateral is added to the user's account (e.g. : what will the liquidation price be for this position AFTER I deposit $x worth of collateral)
      * @returns Precision : PRICE_PRECISION
      */
-    liquidationPrice(marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean, offsetCollateral?: BN, enteringHighLeverage?: boolean, marginType?: MarginType): BN;
-    calculateEntriesEffectOnFreeCollateral(market: PerpMarketAccount, oraclePrice: BN, perpPosition: PerpPosition, positionBaseSizeChange: BN, estimatedEntryPrice: BN, includeOpenOrders: boolean, enteringHighLeverage?: any, marginCategory?: MarginCategory): BN;
-    calculateFreeCollateralDeltaForPerp(market: PerpMarketAccount, perpPosition: PerpPosition, positionBaseSizeChange: BN, oraclePrice: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean, enteringHighLeverage?: any): BN | undefined;
+    liquidationPrice(marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean, offsetCollateral?: BN, marginType?: MarginType): BN;
+    calculateEntriesEffectOnFreeCollateral(market: PerpMarketAccount, oraclePrice: BN, perpPosition: PerpPosition, positionBaseSizeChange: BN, estimatedEntryPrice: BN, includeOpenOrders: boolean, marginCategory?: MarginCategory): BN;
+    calculateFreeCollateralDeltaForPerp(market: PerpMarketAccount, perpPosition: PerpPosition, positionBaseSizeChange: BN, oraclePrice: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean): BN | undefined;
     calculateFreeCollateralDeltaForSpot(market: SpotMarketAccount, signedTokenAmount: BN, marginCategory?: MarginCategory): BN;
     /**
      * Calculates the estimated liquidation price for a position after closing a quote amount of the position.
@@ -316,7 +326,7 @@ export declare class User {
      * @param isLp
      * @returns { tradeSize: BN, oppositeSideTradeSize: BN} : Precision QUOTE_PRECISION
      */
-    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, isLp?: boolean, enterHighLeverageMode?: any, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): {
+    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, isLp?: boolean, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): {
         tradeSize: BN;
         oppositeSideTradeSize: BN;
     };
@@ -384,7 +394,7 @@ export declare class User {
      * @param quoteAmount
      * @returns feeForQuote : Precision QUOTE_PRECISION
      */
-    calculateFeeForQuoteAmount(quoteAmount: BN, marketIndex?: number, enteringHighLeverageMode?: boolean): BN;
+    calculateFeeForQuoteAmount(quoteAmount: BN, marketIndex?: number): BN;
     /**
      * Calculates a user's max withdrawal amounts for a spot market. If reduceOnly is true,
      * it will return the max withdrawal amount without opening a liability for the user
@@ -441,7 +451,6 @@ export declare class User {
     getMarginCalculation(marginCategory?: MarginCategory, opts?: {
         strict?: boolean;
         includeOpenOrders?: boolean;
-        enteringHighLeverage?: boolean;
         liquidationBufferMap?: Map<number | 'cross', BN>;
     }): MarginCalculation;
     isPerpPositionIsolated(perpPosition: PerpPosition): boolean;