Class User

Hierarchy

User

Index

Constructors

constructor

new User(config: UserConfig): User
Parameters
- config: UserConfig
Returns User
- Defined in sdk/src/user.ts:119

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: UserAccountSubscriber

driftClient

driftClient: DriftClient

eventEmitter

userAccountPublicKey

userAccountPublicKey: PublicKey

Accessors

isSubscribed

get isSubscribed(): boolean
Returns boolean
- Defined in sdk/src/user.ts:111
set isSubscribed(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in sdk/src/user.ts:115

Methods

accountLeverageAfterSwap

accountLeverageAfterSwap(__namedParameters: {
    inAmount: BN;
    inMarketIndex: number;
    outAmount: BN;
    outMarketIndex: number;
}): BN
Estimates what the user leverage will be after swap
Parameters
- __namedParameters: {
      inAmount: BN;
      inMarketIndex: number;
      outAmount: BN;
      outMarketIndex: number;
  }
  - inAmount: BN
  - inMarketIndex: number
  - outAmount: BN
  - outMarketIndex: number
Returns BN
- Defined in sdk/src/user.ts:3161

accountLeverageRatioAfterTrade

accountLeverageRatioAfterTrade(targetMarketIndex: number, targetMarketType: MarketType, tradeQuoteAmount: BN, tradeSide: PositionDirection, includeOpenOrders?: boolean): BN
Returns the leverage ratio for the account after adding (or subtracting) the given quote size to the given position

Returns
leverageRatio : Precision TEN_THOUSAND
Parameters
- targetMarketIndex: number
  
  @param: targetMarketType
- targetMarketType: MarketType
- tradeQuoteAmount: BN
- tradeSide: PositionDirection
- includeOpenOrders: boolean = true
Returns BN
- Defined in sdk/src/user.ts:3267

calculateEntriesEffectOnFreeCollateral

calculateEntriesEffectOnFreeCollateral(market: PerpMarketAccount, oraclePrice: BN, perpPosition: PerpPosition, positionBaseSizeChange: BN, estimatedEntryPrice: BN, includeOpenOrders: boolean): BN
Parameters
- market: PerpMarketAccount
- oraclePrice: BN
- perpPosition: PerpPosition
- positionBaseSizeChange: BN
- estimatedEntryPrice: BN
- includeOpenOrders: boolean
Returns BN
- Defined in sdk/src/user.ts:2389

calculateFeeForQuoteAmount

calculateFeeForQuoteAmount(quoteAmount: BN, marketIndex?: number): BN
Calculates how much perp fee will be taken for a given sized trade

Returns
feeForQuote : Precision QUOTE_PRECISION
Parameters
- quoteAmount: BN
- Optional marketIndex: number
Returns BN
- Defined in sdk/src/user.ts:3495

calculateFreeCollateralDeltaForPerp

calculateFreeCollateralDeltaForPerp(market: PerpMarketAccount, perpPosition: PerpPosition, positionBaseSizeChange: BN, oraclePrice: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean): BN
Parameters
- market: PerpMarketAccount
- perpPosition: PerpPosition
- positionBaseSizeChange: BN
- oraclePrice: BN
- marginCategory: MarginCategory = 'Maintenance'
- includeOpenOrders: boolean = false
Returns BN
- Defined in sdk/src/user.ts:2468

calculateFreeCollateralDeltaForSpot

calculateFreeCollateralDeltaForSpot(market: SpotMarketAccount, signedTokenAmount: BN, marginCategory?: MarginCategory): BN
Parameters
- market: SpotMarketAccount
- signedTokenAmount: BN
- marginCategory: MarginCategory = 'Maintenance'
Returns BN
- Defined in sdk/src/user.ts:2534

calculateLeverageFromComponents

calculateLeverageFromComponents(__namedParameters: {
    perpLiabilityValue: BN;
    perpPnl: BN;
    spotAssetValue: BN;
    spotLiabilityValue: BN;
}): BN
Parameters
- __namedParameters: {
      perpLiabilityValue: BN;
      perpPnl: BN;
      spotAssetValue: BN;
      spotLiabilityValue: BN;
  }
  - perpLiabilityValue: BN
  - perpPnl: BN
  - spotAssetValue: BN
  - spotLiabilityValue: BN
Returns BN
- Defined in sdk/src/user.ts:1760

calculateSpotPositionFreeCollateralContribution

calculateSpotPositionFreeCollateralContribution(spotPosition: SpotPosition, strictOraclePrice: StrictOraclePrice): BN
Parameters
- spotPosition: SpotPosition
- strictOraclePrice: StrictOraclePrice
Returns BN
- Defined in sdk/src/user.ts:3095

calculateSpotPositionLeverageContribution

calculateSpotPositionLeverageContribution(spotPosition: SpotPosition, strictOraclePrice: StrictOraclePrice): {
totalAssetValue: BN;
totalLiabilityValue: BN;
}
Parameters
- spotPosition: SpotPosition
- strictOraclePrice: StrictOraclePrice
Returns {
totalAssetValue: BN;
totalLiabilityValue: BN;
}
- totalAssetValue: BN
- totalLiabilityValue: BN
- Defined in sdk/src/user.ts:3115

calculateWeightedPerpPositionLiability

calculateWeightedPerpPositionLiability(perpPosition: PerpPosition, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean): BN
Parameters
- perpPosition: PerpPosition
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
- strict: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1456

canBeLiquidated

canBeLiquidated(): {
    canBeLiquidated: boolean;
    marginRequirement: BN;
    totalCollateral: BN;
}
Returns {
    canBeLiquidated: boolean;
    marginRequirement: BN;
    totalCollateral: BN;
}
- canBeLiquidated: boolean
- marginRequirement: BN
- totalCollateral: BN
- Defined in sdk/src/user.ts:2124

canBypassWithdrawLimits

canBypassWithdrawLimits(marketIndex: number): {
    canBypass: boolean;
    depositAmount: BN;
    maxDepositAmount: BN;
    netDeposits: BN;
}
Parameters
- marketIndex: number
Returns {
    canBypass: boolean;
    depositAmount: BN;
    maxDepositAmount: BN;
    netDeposits: BN;
}
- canBypass: boolean
- depositAmount: BN
- maxDepositAmount: BN
- netDeposits: BN
- Defined in sdk/src/user.ts:3596

canMakeIdle

canMakeIdle(slot: BN): boolean
Parameters
- slot: BN
Returns boolean
- Defined in sdk/src/user.ts:3651

cloneAndUpdateSpotPosition

cloneAndUpdateSpotPosition(position: SpotPosition, tokenAmount: BN, market: SpotMarketAccount): SpotPosition
Parameters
- position: SpotPosition
- tokenAmount: BN
- market: SpotMarketAccount
Returns SpotPosition
- Defined in sdk/src/user.ts:3045

exists

exists(): Promise<boolean>
Returns Promise<boolean>
- Defined in sdk/src/user.ts:387

fetchAccounts

fetchAccounts(): Promise<void>
Forces the accountSubscriber to fetch account updates from rpc

Returns Promise<void>
- Defined in sdk/src/user.ts:159

forceGetUserAccount

forceGetUserAccount(): Promise<UserAccount>
Returns Promise<UserAccount>
- Defined in sdk/src/user.ts:172

getActivePerpPositions

getActivePerpPositions(): PerpPosition[]
Returns PerpPosition[]
- Defined in sdk/src/user.ts:758

getActivePerpPositionsAndSlot

getActivePerpPositionsAndSlot(): DataAndSlot<PerpPosition[]>
Returns DataAndSlot<PerpPosition[]>
- Defined in sdk/src/user.ts:762

getActivePerpPositionsForUserAccount

getActivePerpPositionsForUserAccount(userAccount: UserAccount): PerpPosition[]
Parameters
- userAccount: UserAccount
Returns PerpPosition[]
- Defined in sdk/src/user.ts:746

getActiveSpotPositions

getActiveSpotPositions(): SpotPosition[]
Returns SpotPosition[]
- Defined in sdk/src/user.ts:781

getActiveSpotPositionsAndSlot

getActiveSpotPositionsAndSlot(): DataAndSlot<SpotPosition[]>
Returns DataAndSlot<SpotPosition[]>
- Defined in sdk/src/user.ts:785

getActiveSpotPositionsForUserAccount

getActiveSpotPositionsForUserAccount(userAccount: UserAccount): SpotPosition[]
Parameters
- userAccount: UserAccount
Returns SpotPosition[]
- Defined in sdk/src/user.ts:773

getClonedPosition

getClonedPosition(position: PerpPosition): PerpPosition
Parameters
- position: PerpPosition
Returns PerpPosition
- Defined in sdk/src/user.ts:301

getCollateralDepositRequiredForTrade

getCollateralDepositRequiredForTrade(targetMarketIndex: number, baseSize: BN, collateralIndex: number): BN
Parameters
- targetMarketIndex: number
- baseSize: BN
- collateralIndex: number
Returns BN
- Defined in sdk/src/user.ts:2615

getEmptyPosition

getEmptyPosition(marketIndex: number): PerpPosition
Parameters
- marketIndex: number
Returns PerpPosition
- Defined in sdk/src/user.ts:281

getEmptySpotPosition

getEmptySpotPosition(marketIndex: number): SpotPosition
Parameters
- marketIndex: number
Returns SpotPosition
- Defined in sdk/src/user.ts:247

getFreeCollateral

getFreeCollateral(marginCategory?: MarginCategory): BN
calculates Free Collateral = Total collateral - margin requirement

Returns
: Precision QUOTE_PRECISION
Parameters
- marginCategory: MarginCategory = 'Initial'
Returns BN
- Defined in sdk/src/user.ts:689

getFuelBonus

getFuelBonus(now: BN, includeSettled?: boolean, includeUnsettled?: boolean): {
    borrowFuel: BN;
    depositFuel: BN;
    insuranceFuel: BN;
    makerFuel: BN;
    positionFuel: BN;
    takerFuel: BN;
}
Parameters
- now: BN
- includeSettled: boolean = true
- includeUnsettled: boolean = true
Returns {
    borrowFuel: BN;
    depositFuel: BN;
    insuranceFuel: BN;
    makerFuel: BN;
    positionFuel: BN;
    takerFuel: BN;
}
- borrowFuel: BN
- depositFuel: BN
- insuranceFuel: BN
- makerFuel: BN
- positionFuel: BN
- takerFuel: BN
- Defined in sdk/src/user.ts:896

getHealth

getHealth(): number
calculates User Health by comparing total collateral and maint. margin requirement

Returns
: number (value from [0, 100])

Returns number
- Defined in sdk/src/user.ts:1426

getHealthComponents

getHealthComponents(__namedParameters: {
marginCategory: MarginCategory;
}): HealthComponents
Parameters
- __namedParameters: {
  marginCategory: MarginCategory;
  }
  - marginCategory: MarginCategory
Returns HealthComponents
- Defined in sdk/src/user.ts:3814

getInitialMarginRequirement

getInitialMarginRequirement(): BN
Returns
The initial margin requirement in USDC. : QUOTE_PRECISION

Returns BN
- Defined in sdk/src/user.ts:727

getLPBidAsks

getLPBidAsks(marketIndex: number, lpShares?: BN): [BN, BN]
calculates the open bids and asks for an lp optionally pass in lpShares to see what bid/asks a user would take on

Returns
: lp open bids

Returns
: lp open asks
Parameters
- marketIndex: number
- Optional lpShares: BN
Returns [BN, BN]
- Defined in sdk/src/user.ts:417

getLeverage

getLeverage(includeOpenOrders?: boolean): BN
calculates current user leverage which is (total liability size) / (net asset value)

Returns
: Precision TEN_THOUSAND
Parameters
- includeOpenOrders: boolean = true
Returns BN
- Defined in sdk/src/user.ts:1754

getLeverageComponents

getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory): {
    perpLiabilityValue: BN;
    perpPnl: BN;
    spotAssetValue: BN;
    spotLiabilityValue: BN;
}
Parameters
- includeOpenOrders: boolean = true
- marginCategory: MarginCategory = undefined
Returns {
    perpLiabilityValue: BN;
    perpPnl: BN;
    spotAssetValue: BN;
    spotLiabilityValue: BN;
}
- perpLiabilityValue: BN
- perpPnl: BN
- spotAssetValue: BN
- spotLiabilityValue: BN
- Defined in sdk/src/user.ts:1782

getMaintenanceMarginRequirement

getMaintenanceMarginRequirement(): BN
Returns
The maintenance margin requirement in USDC. : QUOTE_PRECISION

Returns BN
- Defined in sdk/src/user.ts:734

getMarginRatio

getMarginRatio(): BN
calculates margin ratio: 1 / leverage

Returns
: Precision TEN_THOUSAND

Returns BN
- Defined in sdk/src/user.ts:2108

getMarginRequirement

getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN, strict?: boolean, includeOpenOrders?: boolean): BN
Returns
The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
Parameters
- marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- strict: boolean = false
- includeOpenOrders: boolean = true
Returns BN
- Defined in sdk/src/user.ts:702

getMarginUSDCRequiredForTrade

getMarginUSDCRequiredForTrade(targetMarketIndex: number, baseSize: BN): BN
Parameters
- targetMarketIndex: number
- baseSize: BN
Returns BN
- Defined in sdk/src/user.ts:2603

getMaxLeverageForPerp

getMaxLeverageForPerp(perpMarketIndex: number, marginCategory?: MarginCategory, isLp?: boolean): BN
calculates max allowable leverage exceeding hitting requirement category for large sizes where imf factor activates, result is a lower bound

Returns
: Precision TEN_THOUSAND
Parameters
- perpMarketIndex: number
- marginCategory: MarginCategory = 'Initial'
  
  {Initial, Maintenance}
- isLp: boolean = false
  
  if calculating max leveraging for adding lp, need to add buffer
Returns BN
- Defined in sdk/src/user.ts:1915

getMaxLeverageForSpot

getMaxLeverageForSpot(spotMarketIndex: number, direction: PositionDirection): BN
calculates max allowable leverage exceeding hitting requirement category

Returns
: Precision TEN_THOUSAND
Parameters
- spotMarketIndex: number
- direction: PositionDirection
Returns BN
- Defined in sdk/src/user.ts:2018

getMaxSwapAmount

getMaxSwapAmount(__namedParameters: {
    calculateSwap?: ((inAmount: BN) => BN);
    inMarketIndex: number;
    iterationLimit?: number;
    outMarketIndex: number;
}): {
    inAmount: BN;
    leverage: BN;
    outAmount: BN;
}
Calculates the max amount of token that can be swapped from inMarket to outMarket Assumes swap happens at oracle price
Parameters
- __namedParameters: {
      calculateSwap?: ((inAmount: BN) => BN);
      inMarketIndex: number;
      iterationLimit?: number;
      outMarketIndex: number;
  }
  - Optional calculateSwap?: ((inAmount: BN) => BN)
    - (inAmount: BN): BN
      
      Parameters
      
      inAmount: BN
      
      Returns BN
  - inMarketIndex: number
  - Optional iterationLimit?: number
  - outMarketIndex: number
Returns {
    inAmount: BN;
    leverage: BN;
    outAmount: BN;
}
- inAmount: BN
- leverage: BN
- outAmount: BN
- Defined in sdk/src/user.ts:2846

getMaxTradeSizeUSDCForPerp

getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, isLp?: boolean): {
oppositeSideTradeSize: BN;
tradeSize: BN;
}
Get the maximum trade size for a given market, taking into account the user's current leverage, positions, collateral, etc.

To Calculate Max Quote Available:

Case 1: SameSide => Remaining quote to get to maxLeverage

Case 2: NOT SameSide && currentLeverage <= maxLeverage => Current opposite position x2 + remaining to get to maxLeverage

Case 3: NOT SameSide && currentLeverage > maxLeverage && otherPositions - currentPosition > maxLeverage => strictly reduce current position size

Case 4: NOT SameSide && currentLeverage > maxLeverage && otherPositions - currentPosition < maxLeverage => current position + remaining to get to maxLeverage

Returns
: Precision QUOTE_PRECISION
Parameters
- targetMarketIndex: number
- tradeSide: PositionDirection
- isLp: boolean = false
Returns {
oppositeSideTradeSize: BN;
tradeSize: BN;
}
- oppositeSideTradeSize: BN
- tradeSize: BN
- Defined in sdk/src/user.ts:2651

getMaxTradeSizeUSDCForSpot

getMaxTradeSizeUSDCForSpot(targetMarketIndex: number, direction: PositionDirection, currentQuoteAssetValue?: BN, currentSpotMarketNetValue?: BN): BN
Get the maximum trade size for a given market, taking into account the user's current leverage, positions, collateral, etc.

Returns
tradeSizeAllowed : Precision QUOTE_PRECISION
Parameters
- targetMarketIndex: number
- direction: PositionDirection
- Optional currentQuoteAssetValue: BN
- Optional currentSpotMarketNetValue: BN
Returns BN
- Defined in sdk/src/user.ts:2759

getNetSpotMarketValue

getNetSpotMarketValue(withWeightMarginCategory?: MarginCategory): BN
Parameters
- Optional withWeightMarginCategory: MarginCategory
Returns BN
- Defined in sdk/src/user.ts:1396

getNetUsdValue

getNetUsdValue(): BN
Returns BN
- Defined in sdk/src/user.ts:1887

getOpenOrders

getOpenOrders(): Order[]
Returns Order[]
- Defined in sdk/src/user.ts:369

getOpenOrdersAndSlot

getOpenOrdersAndSlot(): DataAndSlot<Order[]>
Returns DataAndSlot<Order[]>
- Defined in sdk/src/user.ts:374

getOpenOrdersForUserAccount

getOpenOrdersForUserAccount(userAccount?: UserAccount): Order[]
Parameters
- Optional userAccount: UserAccount
Returns Order[]
- Defined in sdk/src/user.ts:363

`Private` getOracleDataForPerpMarket

getOracleDataForPerpMarket(marketIndex: number): OraclePriceData
Parameters
- marketIndex: number
Returns OraclePriceData
- Defined in sdk/src/user.ts:4036

`Private` getOracleDataForSpotMarket

getOracleDataForSpotMarket(marketIndex: number): OraclePriceData
Parameters
- marketIndex: number
Returns OraclePriceData
- Defined in sdk/src/user.ts:4040

getOrder

getOrder(orderId: number): Order
Returns
Order
Parameters
- orderId: number
Returns Order
- Defined in sdk/src/user.ts:317

getOrderAndSlot

getOrderAndSlot(orderId: number): DataAndSlot<Order>
Parameters
- orderId: number
Returns DataAndSlot<Order>
- Defined in sdk/src/user.ts:322

getOrderByUserIdForUserAccount

getOrderByUserIdForUserAccount(userAccount: UserAccount, userOrderId: number): Order
Parameters
- userAccount: UserAccount
- userOrderId: number
Returns Order
- Defined in sdk/src/user.ts:331

getOrderByUserOrderId

getOrderByUserOrderId(userOrderId: number): Order
Returns
Order
Parameters
- userOrderId: number
Returns Order
- Defined in sdk/src/user.ts:344

getOrderByUserOrderIdAndSlot

getOrderByUserOrderIdAndSlot(userOrderId: number): DataAndSlot<Order>
Parameters
- userOrderId: number
Returns DataAndSlot<Order>
- Defined in sdk/src/user.ts:349

getOrderForUserAccount

getOrderForUserAccount(userAccount: UserAccount, orderId: number): Order
Parameters
- userAccount: UserAccount
- orderId: number
Returns Order
- Defined in sdk/src/user.ts:306

getPerpBidAsks

getPerpBidAsks(marketIndex: number): [BN, BN]
calculates the total open bids/asks in a perp market (including lps)

Returns
: open bids

Returns
: open asks
Parameters
- marketIndex: number
Returns [BN, BN]
- Defined in sdk/src/user.ts:400

getPerpBuyingPower

getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN): BN
calculates Buying Power = free collateral / initial margin ratio

Returns
: Precision QUOTE_PRECISION
Parameters
- marketIndex: number
- collateralBuffer: BN = ZERO
Returns BN
- Defined in sdk/src/user.ts:644

getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount

getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN): BN
Parameters
- marketIndex: number
- freeCollateral: BN
- baseAssetAmount: BN
Returns BN
- Defined in sdk/src/user.ts:670

getPerpLiabilityValue

getPerpLiabilityValue(marketIndex: number, oraclePriceData: OraclePriceData, includeOpenOrders?: boolean): BN
calculates position liabiltiy value in margin system

Returns
: Precision QUOTE_PRECISION
Parameters
- marketIndex: number
- oraclePriceData: OraclePriceData
- includeOpenOrders: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1645

getPerpMarketLiabilityValue

getPerpMarketLiabilityValue(marketIndex: number, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean): BN
calculates position value of a single perp market in margin system

Returns
: Precision QUOTE_PRECISION
Parameters
- marketIndex: number
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
- strict: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1572

getPerpPosition

getPerpPosition(marketIndex: number): PerpPosition
Gets the user's current position for a given perp market. If the user has no position returns undefined

Returns
userPerpPosition
Parameters
- marketIndex: number
Returns PerpPosition
- Defined in sdk/src/user.ts:195

getPerpPositionAndSlot

getPerpPositionAndSlot(marketIndex: number): DataAndSlot<PerpPosition>
Parameters
- marketIndex: number
Returns DataAndSlot<PerpPosition>
- Defined in sdk/src/user.ts:200

getPerpPositionForUserAccount

getPerpPositionForUserAccount(userAccount: UserAccount, marketIndex: number): PerpPosition
Parameters
- userAccount: UserAccount
- marketIndex: number
Returns PerpPosition
- Defined in sdk/src/user.ts:181

getPerpPositionHealth

getPerpPositionHealth(__namedParameters: {
    marginCategory: MarginCategory;
    oraclePriceData?: OraclePriceData;
    perpPosition: PerpPosition;
    quoteOraclePriceData?: OraclePriceData;
}): HealthComponent
Parameters
- __namedParameters: {
      marginCategory: MarginCategory;
      oraclePriceData?: OraclePriceData;
      perpPosition: PerpPosition;
      quoteOraclePriceData?: OraclePriceData;
  }
  - marginCategory: MarginCategory
  - Optional oraclePriceData?: OraclePriceData
  - perpPosition: PerpPosition
  - Optional quoteOraclePriceData?: OraclePriceData
Returns HealthComponent
- Defined in sdk/src/user.ts:3738

getPerpPositionValue

getPerpPositionValue(marketIndex: number, oraclePriceData: OraclePriceData, includeOpenOrders?: boolean): BN
calculates position value based on oracle

Returns
: Precision QUOTE_PRECISION
Parameters
- marketIndex: number
- oraclePriceData: OraclePriceData
- includeOpenOrders: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1618

getPerpPositionWithLPSettle

getPerpPositionWithLPSettle(marketIndex: number, originalPosition?: PerpPosition, burnLpShares?: boolean, includeRemainderInBaseAmount?: boolean): [PerpPosition, BN, BN]
calculates the market position if the lp position was settled

Returns
: the settled userPosition

Returns
: the dust base asset amount (ie, < stepsize)

Returns
: pnl from settle
Parameters
- marketIndex: number
- Optional originalPosition: PerpPosition
- burnLpShares: boolean = false
- includeRemainderInBaseAmount: boolean = false
Returns [PerpPosition, BN, BN]
- Defined in sdk/src/user.ts:446

getPositionEstimatedExitPriceAndPnl

getPositionEstimatedExitPriceAndPnl(position: PerpPosition, amountToClose?: BN, useAMMClose?: boolean): [BN, BN]
calculates average exit price (optionally for closing up to 100% of position)

Returns
: Precision PRICE_PRECISION
Parameters
- position: PerpPosition
- Optional amountToClose: BN
- useAMMClose: boolean = false
Returns [BN, BN]
- Defined in sdk/src/user.ts:1692

getPositionSide

getPositionSide(currentPosition: Pick<PerpPosition, "baseAssetAmount">): PositionDirection
Parameters
- currentPosition: Pick<PerpPosition, "baseAssetAmount">
Returns PositionDirection
- Defined in sdk/src/user.ts:1676

getSafestTiers

getSafestTiers(): {
perpTier: number;
spotTier: number;
}
Returns {
perpTier: number;
spotTier: number;
}
- perpTier: number
- spotTier: number
- Defined in sdk/src/user.ts:3706

getSpotAssetValue

getSpotAssetValue(tokenAmount: BN, strictOraclePrice: StrictOraclePrice, spotMarketAccount: SpotMarketAccount, marginCategory?: MarginCategory): BN
Parameters
- tokenAmount: BN
- strictOraclePrice: StrictOraclePrice
- spotMarketAccount: SpotMarketAccount
- Optional marginCategory: MarginCategory
Returns BN
- Defined in sdk/src/user.ts:1337

getSpotLiabilityValue

getSpotLiabilityValue(tokenAmount: BN, strictOraclePrice: StrictOraclePrice, spotMarketAccount: SpotMarketAccount, marginCategory?: MarginCategory, liquidationBuffer?: BN): BN
Parameters
- tokenAmount: BN
- strictOraclePrice: StrictOraclePrice
- spotMarketAccount: SpotMarketAccount
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
Returns BN
- Defined in sdk/src/user.ts:1275

getSpotMarketAccountsWithDustPosition

getSpotMarketAccountsWithDustPosition(): SpotMarketAccount[]
Returns SpotMarketAccount[]
- Defined in sdk/src/user.ts:1851

getSpotMarketAssetAndLiabilityValue

getSpotMarketAssetAndLiabilityValue(marketIndex?: number, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean, now?: BN): {
totalAssetValue: BN;
totalLiabilityValue: BN;
}
Parameters
- Optional marketIndex: number
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
- strict: boolean = false
- Optional now: BN
Returns {
totalAssetValue: BN;
totalLiabilityValue: BN;
}
- totalAssetValue: BN
- totalLiabilityValue: BN
- Defined in sdk/src/user.ts:1065

getSpotMarketAssetValue

getSpotMarketAssetValue(marketIndex?: number, marginCategory?: MarginCategory, includeOpenOrders?: boolean, strict?: boolean, now?: BN): BN
Parameters
- Optional marketIndex: number
- Optional marginCategory: MarginCategory
- Optional includeOpenOrders: boolean
- strict: boolean = false
- Optional now: BN
Returns BN
- Defined in sdk/src/user.ts:1319

getSpotMarketLiabilityValue

getSpotMarketLiabilityValue(marketIndex?: number, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean, now?: BN): BN
Parameters
- Optional marketIndex: number
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
- strict: boolean = false
- Optional now: BN
Returns BN
- Defined in sdk/src/user.ts:1256

getSpotPosition

getSpotPosition(marketIndex: number): SpotPosition
Gets the user's current position for a given spot market. If the user has no position returns undefined

Returns
userSpotPosition
Parameters
- marketIndex: number
Returns SpotPosition
- Defined in sdk/src/user.ts:228

getSpotPositionAndSlot

getSpotPositionAndSlot(marketIndex: number): DataAndSlot<SpotPosition>
Parameters
- marketIndex: number
Returns DataAndSlot<SpotPosition>
- Defined in sdk/src/user.ts:233

getSpotPositionForUserAccount

getSpotPositionForUserAccount(userAccount: UserAccount, marketIndex: number): SpotPosition
Parameters
- userAccount: UserAccount
- marketIndex: number
Returns SpotPosition
- Defined in sdk/src/user.ts:214

getSpotPositionValue

getSpotPositionValue(marketIndex: number, marginCategory?: MarginCategory, includeOpenOrders?: boolean, strict?: boolean, now?: BN): BN
Parameters
- marketIndex: number
- Optional marginCategory: MarginCategory
- Optional includeOpenOrders: boolean
- strict: boolean = false
- Optional now: BN
Returns BN
- Defined in sdk/src/user.ts:1376

getTokenAmount

getTokenAmount(marketIndex: number): BN
Returns the token amount for a given market. The spot market precision is based on the token mint decimals. Positive if it is a deposit, negative if it is a borrow.
Parameters
- marketIndex: number
Returns BN
- Defined in sdk/src/user.ts:265

getTotalAllTimePnl

getTotalAllTimePnl(): BN
Calculates the all time P&L of the user.

Net withdraws + Net spot market value + Net unrealized P&L -

Returns BN
- Defined in sdk/src/user.ts:1898

getTotalAssetValue

getTotalAssetValue(marginCategory?: MarginCategory): BN
Parameters
- Optional marginCategory: MarginCategory
Returns BN
- Defined in sdk/src/user.ts:1881

getTotalCollateral

getTotalCollateral(marginCategory?: MarginCategory, strict?: boolean): BN
calculates TotalCollateral: collateral + unrealized pnl

Returns
: Precision QUOTE_PRECISION
Parameters
- marginCategory: MarginCategory = 'Initial'
- strict: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1410

getTotalLiabilityValue

getTotalLiabilityValue(marginCategory?: MarginCategory): BN
Parameters
- Optional marginCategory: MarginCategory
Returns BN
- Defined in sdk/src/user.ts:1866

getTotalPerpPositionLiability

getTotalPerpPositionLiability(marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean, strict?: boolean): BN
calculates sum of position value across all positions in margin system

Returns
: Precision QUOTE_PRECISION
Parameters
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
- strict: boolean = false
Returns BN
- Defined in sdk/src/user.ts:1593

`Private` getTotalPerpPositionValueExcludingMarket

getTotalPerpPositionValueExcludingMarket(marketToIgnore: number, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean): BN
Get the total position value, excluding any position coming from the given target market

Returns
positionValue : Precision QUOTE_PRECISION
Parameters
- marketToIgnore: number
- Optional marginCategory: MarginCategory
- Optional liquidationBuffer: BN
- Optional includeOpenOrders: boolean
Returns BN
- Defined in sdk/src/user.ts:4005

getUnrealizedFundingPNL

getUnrealizedFundingPNL(marketIndex?: number): BN
calculates unrealized funding payment pnl

Returns
: Precision QUOTE_PRECISION
Parameters
- Optional marketIndex: number
Returns BN
- Defined in sdk/src/user.ts:883

getUnrealizedPNL

getUnrealizedPNL(withFunding?: boolean, marketIndex?: number, withWeightMarginCategory?: MarginCategory, strict?: boolean): BN
calculates unrealized position price pnl

Returns
: Precision QUOTE_PRECISION
Parameters
- Optional withFunding: boolean
- Optional marketIndex: number
- Optional withWeightMarginCategory: MarginCategory
- strict: boolean = false
Returns BN
- Defined in sdk/src/user.ts:800

getUserAccount

getUserAccount(): UserAccount
Returns UserAccount
- Defined in sdk/src/user.ts:168

getUserAccountAndSlot

getUserAccountAndSlot(): DataAndSlot<UserAccount>
Returns DataAndSlot<UserAccount>
- Defined in sdk/src/user.ts:177

getUserAccountPublicKey

getUserAccountPublicKey(): PublicKey
Returns PublicKey
- Defined in sdk/src/user.ts:383

getUserFeeTier

getUserFeeTier(marketType: MarketType, now?: BN): FeeTier
Parameters
- marketType: MarketType
- Optional now: BN
Returns FeeTier
- Defined in sdk/src/user.ts:3444

getWithdrawalLimit

getWithdrawalLimit(marketIndex: number, reduceOnly?: boolean): 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

Returns
withdrawalLimit : Precision is the token precision for the chosen SpotMarket
Parameters
- marketIndex: number
- Optional reduceOnly: boolean
Returns BN
- Defined in sdk/src/user.ts:3520

hasStatus

hasStatus(status: UserStatus): boolean
Parameters
- status: UserStatus
Returns boolean
- Defined in sdk/src/user.ts:2149

isBankrupt

isBankrupt(): boolean
Returns boolean
- Defined in sdk/src/user.ts:2153

isBeingLiquidated

isBeingLiquidated(): boolean
Returns boolean
- Defined in sdk/src/user.ts:2141

isDustDepositPosition

isDustDepositPosition(spotMarketAccount: SpotMarketAccount): boolean
Parameters
- spotMarketAccount: SpotMarketAccount
Returns boolean
- Defined in sdk/src/user.ts:1816

liquidationPrice

liquidationPrice(marketIndex: number, positionBaseSizeChange?: BN, estimatedEntryPrice?: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean, offsetCollateral?: BN): BN
Calculate the liquidation price of a perp position, with optional parameter to calculate the liquidation price after a trade

Returns
Precision : PRICE_PRECISION
Parameters
- marketIndex: number
- positionBaseSizeChange: BN = ZERO
  
  // change in position size to calculate liquidation price for : Precision 10^9
- estimatedEntryPrice: BN = ZERO
- marginCategory: MarginCategory = 'Maintenance'
  
  // allow Initial to be passed in if we are trying to calculate price for DLP de-risking
- includeOpenOrders: boolean = false
- offsetCollateral: BN = ZERO
  
  // 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 BN
- Defined in sdk/src/user.ts:2282

liquidationPriceAfterClose

liquidationPriceAfterClose(positionMarketIndex: number, closeQuoteAmount: BN, estimatedEntryPrice?: BN): BN
Calculates the estimated liquidation price for a position after closing a quote amount of the position.

Returns
: Precision PRICE_PRECISION
Parameters
- positionMarketIndex: number
- closeQuoteAmount: BN
- estimatedEntryPrice: BN = ZERO
Returns BN
- Defined in sdk/src/user.ts:2574

needsToSettleFundingPayment

needsToSettleFundingPayment(): boolean
Checks if any user position cumulative funding differs from respective market cumulative funding

Returns

Returns boolean
- Defined in sdk/src/user.ts:2161

spotLiquidationPrice

spotLiquidationPrice(marketIndex: number, positionBaseSizeChange?: BN): BN
Calculate the liquidation price of a spot position

Returns
Precision : PRICE_PRECISION
Parameters
- marketIndex: number
- positionBaseSizeChange: BN = ZERO
Returns BN
- Defined in sdk/src/user.ts:2191

subscribe(userAccount?: UserAccount): Promise<boolean>
Subscribe to User state accounts

Returns
SusbcriptionSuccess result
Parameters
- Optional userAccount: UserAccount
Returns Promise<boolean>
- Defined in sdk/src/user.ts:151

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/user.ts:163

Class User

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: UserConfig

Returns User

Properties

_isSubscribed

accountSubscriber

driftClient

eventEmitter

userAccountPublicKey

Accessors

isSubscribed

Returns boolean

Parameters

val: boolean

Returns void

Methods

accountLeverageAfterSwap

Parameters

__namedParameters: { inAmount: BN; inMarketIndex: number; outAmount: BN; outMarketIndex: number; }

inAmount: BN

inMarketIndex: number

outAmount: BN

outMarketIndex: number

Returns BN

accountLeverageRatioAfterTrade

Returns

Parameters

targetMarketIndex: number

targetMarketType: MarketType

tradeQuoteAmount: BN

tradeSide: PositionDirection

includeOpenOrders: boolean = true

Returns BN

calculateEntriesEffectOnFreeCollateral

Parameters

market: PerpMarketAccount

oraclePrice: BN

perpPosition: PerpPosition

positionBaseSizeChange: BN

estimatedEntryPrice: BN

includeOpenOrders: boolean

Returns BN

calculateFeeForQuoteAmount

Returns

Parameters

quoteAmount: BN

Optional marketIndex: number

Returns BN

calculateFreeCollateralDeltaForPerp

Parameters

market: PerpMarketAccount

perpPosition: PerpPosition

positionBaseSizeChange: BN

oraclePrice: BN

marginCategory: MarginCategory = 'Maintenance'

includeOpenOrders: boolean = false

Returns BN

calculateFreeCollateralDeltaForSpot

Parameters

market: SpotMarketAccount

signedTokenAmount: BN

marginCategory: MarginCategory = 'Maintenance'

Returns BN

calculateLeverageFromComponents

Parameters

__namedParameters: { perpLiabilityValue: BN; perpPnl: BN; spotAssetValue: BN; spotLiabilityValue: BN; }

perpLiabilityValue: BN

perpPnl: BN

spotAssetValue: BN

spotLiabilityValue: BN

Returns BN

__namedParameters: {
inAmount: BN;
inMarketIndex: number;
outAmount: BN;
outMarketIndex: number;
}

`Optional` marketIndex: number

__namedParameters: {
perpLiabilityValue: BN;
perpPnl: BN;
spotAssetValue: BN;
spotLiabilityValue: BN;
}

Returns {
totalAssetValue: BN;
totalLiabilityValue: BN;
}

`Optional` marginCategory: MarginCategory

`Optional` liquidationBuffer: BN

`Optional` includeOpenOrders: boolean

Returns {
canBeLiquidated: boolean;
marginRequirement: BN;
totalCollateral: BN;
}

Returns {
canBypass: boolean;
depositAmount: BN;
maxDepositAmount: BN;
netDeposits: BN;
}