Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClearingHouseUser

Hierarchy

  • ClearingHouseUser

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: UserAccountSubscriber

authority

authority: PublicKey

clearingHouse

clearingHouse: ClearingHouse

eventEmitter

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

Optional userAccountPublicKey

userAccountPublicKey?: PublicKey

Accessors

isSubscribed

  • get isSubscribed(): boolean
  • set isSubscribed(val: boolean): void

Methods

accountLeverageRatioAfterTrade

  • Returns the leverage ratio for the account after adding (or subtracting) the given quote size to the given position

    Parameters

    Returns BN

    leverageRatio : Precision TEN_THOUSAND

calculateFeeForQuoteAmount

  • calculateFeeForQuoteAmount(quoteAmount: BN): BN

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

    Parameters

    • quoteAmount: BN

    Returns BN

    feeForQuote : Precision QUOTE_PRECISION

canBeLiquidated

  • canBeLiquidated(): [boolean, BN]

exists

  • exists(): Promise<boolean>

fetchAccounts

  • fetchAccounts(): Promise<void>

getBuyingPower

  • getBuyingPower(): BN

getEmptyPosition

getFreeCollateral

  • getFreeCollateral(): BN

getLeverage

  • getLeverage(): BN

getMarginRatio

  • getMarginRatio(): BN

getMaxLeverage

  • getMaxLeverage(category?: "Initial" | "Partial" | "Maintenance"): BN

  • calculates max allowable leverage exceeding hitting requirement category

    params

    category {Initial, Partial, Maintenance}

    Parameters

    • Optional category: "Initial" | "Partial" | "Maintenance"

    Returns BN

    : Precision TEN_THOUSAND

getMaxTradeSizeUSDC

  • 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

    Parameters

    • targetMarketIndex: BN
    • tradeSide: PositionDirection
    • userMaxLeverageSetting: BN

      leverage : Precision TEN_THOUSAND

    Returns BN

    tradeSizeAllowed : Precision QUOTE_PRECISION

getPositionEstimatedExitPriceAndPnl

getPositionSide

getPositionValue

  • getPositionValue(marketIndex: BN): BN

getTotalCollateral

  • getTotalCollateral(): BN

getTotalPositionValue

  • getTotalPositionValue(): BN

Private getTotalPositionValueExcludingMarket

  • getTotalPositionValueExcludingMarket(marketToIgnore: BN): BN

  • Get the total position value, excluding any position coming from the given target market

    Parameters

    • marketToIgnore: BN

    Returns BN

    positionValue : Precision QUOTE_PRECISION

getUnrealizedFundingPNL

  • getUnrealizedFundingPNL(marketIndex?: BN): BN

getUnrealizedPNL

  • getUnrealizedPNL(withFunding?: boolean, marketIndex?: BN): BN

  • calculates unrealized position price pnl

    Parameters

    • Optional withFunding: boolean
    • Optional marketIndex: BN

    Returns BN

    : Precision QUOTE_PRECISION

getUserAccount

getUserAccountPublicKey

  • getUserAccountPublicKey(): Promise<PublicKey>

getUserPosition

getUserPositionsAccount

liquidationPrice

  • liquidationPrice(targetMarket: Pick<UserPosition, "marketIndex">, positionBaseSizeChange?: BN, partial?: boolean): BN

  • Calculate the liquidation price of a position, with optional parameter to calculate the liquidation price after a trade

    Parameters

    • targetMarket: Pick<UserPosition, "marketIndex">
    • positionBaseSizeChange: BN = ZERO

      // change in position size to calculate liquidation price for : Precision 10^13

    • partial: boolean = false

    Returns BN

    Precision : MARK_PRICE_PRECISION

liquidationPriceAfterClose

  • liquidationPriceAfterClose(positionMarketIndex: BN, closeQuoteAmount: BN): BN

  • Calculates the estimated liquidation price for a position after closing a quote amount of the position.

    Parameters

    • positionMarketIndex: BN
    • closeQuoteAmount: BN

    Returns BN

    : Precision MARK_PRICE_PRECISION

liquidationPriceOld

  • liquidationPriceOld(targetMarket: Pick<UserPosition, "marketIndex">, positionBaseSizeChange?: BN, partial?: boolean): BN

  • Calculate the liquidation price of a position, with optional parameter to calculate the liquidation price after a trade

    Parameters

    • targetMarket: Pick<UserPosition, "marketIndex">
    • positionBaseSizeChange: BN = ZERO

      // change in position size to calculate liquidation price for : Precision 10^13

    • partial: boolean = false

    Returns BN

    Precision : MARK_PRICE_PRECISION

needsToSettleFundingPayment

  • needsToSettleFundingPayment(): boolean

subscribe

  • subscribe(): Promise<boolean>

unsubscribe

  • unsubscribe(): Promise<void>

Static from

Generated using TypeDoc