Class User

Hierarchy

  • User

Constructors

constructor

Properties

_isSubscribed accountSubscriber driftClient eventEmitter userAccountPublicKey

Accessors

isSubscribed

Methods

accountLeverageAfterSwap accountLeverageRatioAfterTrade calculateFeeForQuoteAmount calculateFreeCollateralDeltaForPerp calculateFreeCollateralDeltaForSpot calculateLeverageFromComponents calculateSpotPositionFreeCollateralContribution calculateSpotPositionLeverageContribution calculateWeightedPerpPositionValue canBeLiquidated canBypassWithdrawLimits canMakeIdle cloneAndUpdateSpotPosition exists fetchAccounts forceGetUserAccount getActivePerpPositions getActivePerpPositionsAndSlot getActivePerpPositionsForUserAccount getActiveSpotPositions getActiveSpotPositionsAndSlot getActiveSpotPositionsForUserAccount getClonedPosition getEmptyPosition getEmptySpotPosition getFreeCollateral getHealth getInitialMarginRequirement getLPBidAsks getLeverage getLeverageComponents getMaintenanceMarginRequirement getMarginRatio getMarginRequirement getMaxLeverageForPerp getMaxLeverageForSpot getMaxSwapAmount getMaxTradeSizeUSDCForPerp getMaxTradeSizeUSDCForSpot getNetSpotMarketValue getOpenOrders getOpenOrdersAndSlot getOpenOrdersForUserAccount getOracleDataForPerpMarket getOracleDataForSpotMarket getOrder getOrderAndSlot getOrderByUserIdForUserAccount getOrderByUserOrderId getOrderByUserOrderIdAndSlot getOrderForUserAccount getPerpBidAsks getPerpBuyingPower getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount getPerpMarketLiabilityValue getPerpPosition getPerpPositionAndSlot getPerpPositionForUserAccount getPerpPositionValue getPerpPositionWithLPSettle getPositionEstimatedExitPriceAndPnl getPositionSide getSafestTiers getSpotAssetValue getSpotLiabilityValue getSpotMarketAssetAndLiabilityValue getSpotMarketAssetValue getSpotMarketLiabilityValue getSpotPosition getSpotPositionAndSlot getSpotPositionForUserAccount getSpotPositionValue getTokenAmount getTotalAllTimePnl getTotalAssetValue getTotalCollateral getTotalLiabilityValue getTotalPerpPositionValue getTotalPerpPositionValueExcludingMarket getUnrealizedFundingPNL getUnrealizedPNL getUserAccount getUserAccountAndSlot getUserAccountPublicKey getWithdrawalLimit isBankrupt isBeingLiquidated liquidationPrice liquidationPriceAfterClose needsToSettleFundingPayment spotLiquidationPrice subscribe unsubscribe

Constructors

constructor

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: UserAccountSubscriber

driftClient

driftClient: DriftClient

eventEmitter

eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents, UserAccountEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">

userAccountPublicKey

userAccountPublicKey: PublicKey

Accessors

isSubscribed

Methods

accountLeverageAfterSwap

  • 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

accountLeverageRatioAfterTrade

  • 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

calculateFeeForQuoteAmount

  • Calculates how much fee will be taken for a given sized trade

    Returns

    feeForQuote : Precision QUOTE_PRECISION

    Parameters

    • quoteAmount: BN

    Returns BN

calculateFreeCollateralDeltaForPerp

calculateFreeCollateralDeltaForSpot

calculateLeverageFromComponents

  • Parameters

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

    Returns BN

calculateSpotPositionFreeCollateralContribution

calculateSpotPositionLeverageContribution

  • Parameters

    Returns {
        totalAssetValue: BN;
        totalLiabilityValue: BN;
    }

    • totalAssetValue: BN
    • totalLiabilityValue: BN

calculateWeightedPerpPositionValue

  • Parameters

    • perpPosition: PerpPosition
    • Optional marginCategory: MarginCategory
    • Optional liquidationBuffer: BN
    • Optional includeOpenOrders: boolean
    • strict: boolean = false

    Returns BN

canBeLiquidated

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

    • canBeLiquidated: boolean
    • marginRequirement: BN
    • totalCollateral: BN

canBypassWithdrawLimits

  • Parameters

    • marketIndex: number

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

    • canBypass: boolean
    • depositAmount: BN
    • maxDepositAmount: BN
    • netDeposits: BN

canMakeIdle

  • Parameters

    • slot: BN
    • slotsBeforeIdle: BN

    Returns boolean

cloneAndUpdateSpotPosition

exists

fetchAccounts

  • Forces the accountSubscriber to fetch account updates from rpc

    Returns Promise<void>

forceGetUserAccount

getActivePerpPositions

getActivePerpPositionsAndSlot

getActivePerpPositionsForUserAccount

getActiveSpotPositions

getActiveSpotPositionsAndSlot

getActiveSpotPositionsForUserAccount

getClonedPosition

getEmptyPosition

getEmptySpotPosition

getFreeCollateral

  • calculates Free Collateral = Total collateral - initial margin requirement

    Returns

    : Precision QUOTE_PRECISION

    Returns BN

getHealth

  • calculates User Health by comparing total collateral and maint. margin requirement

    Returns

    : number (value from [0, 100])

    Returns number

getInitialMarginRequirement

  • Returns

    The initial margin requirement in USDC. : QUOTE_PRECISION

    Returns BN

getLPBidAsks

  • calculates the open bids and asks for an lp

    Returns

    : lp open bids

    Returns

    : lp open asks

    Parameters

    • marketIndex: number

    Returns [BN, BN]

getLeverage

  • calculates current user leverage which is (total liability size) / (net asset value)

    Returns

    : Precision TEN_THOUSAND

    Returns BN

getLeverageComponents

  • Returns {
        perpLiabilityValue: BN;
        perpPnl: BN;
        spotAssetValue: BN;
        spotLiabilityValue: BN;
    }

    • perpLiabilityValue: BN
    • perpPnl: BN
    • spotAssetValue: BN
    • spotLiabilityValue: BN

getMaintenanceMarginRequirement

  • Returns

    The maintenance margin requirement in USDC. : QUOTE_PRECISION

    Parameters

    • Optional liquidationBuffer: BN

    Returns BN

getMarginRatio

  • calculates margin ratio: 1 / leverage

    Returns

    : Precision TEN_THOUSAND

    Returns BN

getMarginRequirement

  • Returns

    The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION

    Parameters

    • marginCategory: MarginCategory
    • Optional liquidationBuffer: BN
    • strict: boolean = false

    Returns BN

getMaxLeverageForPerp

  • 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

getMaxLeverageForSpot

  • calculates max allowable leverage exceeding hitting requirement category

    Returns

    : Precision TEN_THOUSAND

    Parameters

    Returns BN

getMaxSwapAmount

  • 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

getMaxTradeSizeUSDCForPerp

  • 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

    tradeSizeAllowed : Precision QUOTE_PRECISION

    Parameters

    Returns BN

getMaxTradeSizeUSDCForSpot

  • 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

getNetSpotMarketValue

getOpenOrders

getOpenOrdersAndSlot

getOpenOrdersForUserAccount

Private getOracleDataForPerpMarket

Private getOracleDataForSpotMarket

getOrder

getOrderAndSlot

getOrderByUserIdForUserAccount

getOrderByUserOrderId

getOrderByUserOrderIdAndSlot

getOrderForUserAccount

getPerpBidAsks

  • calculates the total open bids/asks in a perp market (including lps)

    Returns

    : open bids

    Returns

    : open asks

    Parameters

    • marketIndex: number

    Returns [BN, BN]

getPerpBuyingPower

  • calculates Buying Power = free collateral / initial margin ratio

    Returns

    : Precision QUOTE_PRECISION

    Parameters

    • marketIndex: number
    • collateralBuffer: any = ZERO

    Returns BN

getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount

  • Parameters

    • marketIndex: number
    • freeCollateral: BN
    • baseAssetAmount: BN

    Returns BN

getPerpMarketLiabilityValue

  • 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

getPerpPosition

  • 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

getPerpPositionAndSlot

getPerpPositionForUserAccount

getPerpPositionValue

  • calculates position value in margin system

    Returns

    : Precision QUOTE_PRECISION

    Parameters

    • marketIndex: number
    • oraclePriceData: OraclePriceData
    • includeOpenOrders: boolean = false

    Returns BN

getPerpPositionWithLPSettle

  • 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

    Returns [PerpPosition, BN, BN]

getPositionEstimatedExitPriceAndPnl

  • 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]

getPositionSide

getSafestTiers

  • Returns {
        perpTier: number;
        spotTier: number;
    }

    • perpTier: number
    • spotTier: number

getSpotAssetValue

getSpotLiabilityValue

getSpotMarketAssetAndLiabilityValue

  • 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

getSpotMarketAssetValue

  • Parameters

    • Optional marketIndex: number
    • Optional marginCategory: MarginCategory
    • Optional includeOpenOrders: boolean
    • strict: boolean = false
    • Optional now: BN

    Returns BN

getSpotMarketLiabilityValue

  • Parameters

    • Optional marketIndex: number
    • Optional marginCategory: MarginCategory
    • Optional liquidationBuffer: BN
    • Optional includeOpenOrders: boolean
    • strict: boolean = false
    • Optional now: BN

    Returns BN

getSpotPosition

  • 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

getSpotPositionAndSlot

getSpotPositionForUserAccount

getSpotPositionValue

  • Parameters

    • marketIndex: number
    • Optional marginCategory: MarginCategory
    • Optional includeOpenOrders: boolean
    • strict: boolean = false
    • Optional now: BN

    Returns BN

getTokenAmount

  • 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

getTotalAllTimePnl

  • Calculates the all time P&L of the user.

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

    Returns BN

getTotalAssetValue

getTotalCollateral

  • calculates TotalCollateral: collateral + unrealized pnl

    Returns

    : Precision QUOTE_PRECISION

    Parameters

    Returns BN

getTotalLiabilityValue

getTotalPerpPositionValue

  • 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

Private getTotalPerpPositionValueExcludingMarket

  • 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

getUnrealizedFundingPNL

  • calculates unrealized funding payment pnl

    Returns

    : Precision QUOTE_PRECISION

    Parameters

    • Optional marketIndex: number

    Returns BN

getUnrealizedPNL

  • calculates unrealized position price pnl

    Returns

    : Precision QUOTE_PRECISION

    Parameters

    • Optional withFunding: boolean
    • Optional marketIndex: number
    • Optional withWeightMarginCategory: MarginCategory
    • strict: boolean = false

    Returns BN

getUserAccount

getUserAccountAndSlot

getUserAccountPublicKey

getWithdrawalLimit

  • 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

isBankrupt

isBeingLiquidated

liquidationPrice

  • 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^13

    Returns BN

liquidationPriceAfterClose

  • 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

    Returns BN

needsToSettleFundingPayment

  • Checks if any user position cumulative funding differs from respective market cumulative funding

    Returns

    Returns boolean

spotLiquidationPrice

  • Calculate the liquidation price of a spot position

    Returns

    Precision : PRICE_PRECISION

    Parameters

    • marketIndex: number
    • positionBaseSizeChange: BN = ZERO

    Returns BN

subscribe

  • Subscribe to User state accounts

    Returns

    SusbcriptionSuccess result

    Parameters

    Returns Promise<boolean>

unsubscribe

Settings

Member Visibility

Theme

Generated using TypeDoc