@drift-labs/sdk 0.2.0-temp.1 → 2.0.0

package/lib/clearingHouseUser.d.ts

@@ -1,187 +0,0 @@
-/// <reference types="node" />
-/// <reference types="bn.js" />
-import { PublicKey } from '@solana/web3.js';
-import { EventEmitter } from 'events';
-import StrictEventEmitter from 'strict-event-emitter-types';
-import { ClearingHouse } from './clearingHouse';
-import { MarginCategory, Order, UserAccount, UserPosition } from './types';
-import { UserAccountSubscriber, UserAccountEvents, DataAndSlot } from './accounts/types';
-import { PositionDirection, BN } from '.';
-import { OraclePriceData } from './oracles/types';
-import { ClearingHouseUserConfig } from './clearingHouseUserConfig';
-export declare class ClearingHouseUser {
-    clearingHouse: ClearingHouse;
-    userAccountPublicKey: PublicKey;
-    accountSubscriber: UserAccountSubscriber;
-    _isSubscribed: boolean;
-    eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
-    get isSubscribed(): boolean;
-    set isSubscribed(val: boolean);
-    constructor(config: ClearingHouseUserConfig);
-    /**
-     * Subscribe to ClearingHouseUser state accounts
-     * @returns SusbcriptionSuccess result
-     */
-    subscribe(): Promise<boolean>;
-    /**
-     *	Forces the accountSubscriber to fetch account updates from rpc
-     */
-    fetchAccounts(): Promise<void>;
-    unsubscribe(): Promise<void>;
-    getUserAccount(): UserAccount;
-    getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined;
-    /**
-     * Gets the user's current position for a given market. If the user has no position returns undefined
-     * @param marketIndex
-     * @returns userPosition
-     */
-    getUserPosition(marketIndex: BN): UserPosition | undefined;
-    getEmptyPosition(marketIndex: BN): UserPosition;
-    /**
-     * @param orderId
-     * @returns Order
-     */
-    getOrder(orderId: BN): Order | undefined;
-    /**
-     * @param userOrderId
-     * @returns Order
-     */
-    getOrderByUserOrderId(userOrderId: number): Order | undefined;
-    getUserAccountPublicKey(): PublicKey;
-    exists(): Promise<boolean>;
-    /**
-     * calculates Buying Power = FC * MAX_LEVERAGE
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getBuyingPower(marketIndex: BN | number): BN;
-    /**
-     * calculates Free Collateral = Total collateral - initial margin requirement
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getFreeCollateral(): BN;
-    getInitialMarginRequirement(): BN;
-    /**
-     * @returns The partial margin requirement in USDC. : QUOTE_PRECISION
-     */
-    getMaintenanceMarginRequirement(): BN;
-    /**
-     * calculates unrealized position price pnl
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getUnrealizedPNL(withFunding?: boolean, marketIndex?: BN): BN;
-    /**
-     * calculates unrealized position price pnl
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getUnsettledPNL(marketIndex?: BN): BN;
-    /**
-     * calculates unrealized funding payment pnl
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getUnrealizedFundingPNL(marketIndex?: BN): BN;
-    getTotalLiability(): BN;
-    getCollateralValue(bankIndex?: BN): BN;
-    /**
-     * calculates TotalCollateral: collateral + unrealized pnl
-     * TODO: rename to total equity (for perpetuals swaps)
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getTotalCollateral(): BN;
-    /**
-     * calculates sum of position value across all positions
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getTotalPositionValue(): BN;
-    /**
-     * calculates position value from closing 100%
-     * @returns : Precision QUOTE_PRECISION
-     */
-    getPositionValue(marketIndex: BN, oraclePriceData: OraclePriceData): BN;
-    getPositionSide(currentPosition: Pick<UserPosition, 'baseAssetAmount'>): PositionDirection | undefined;
-    /**
-     * calculates average exit price for closing 100% of position
-     * @returns : Precision MARK_PRICE_PRECISION
-     */
-    getPositionEstimatedExitPriceAndPnl(position: UserPosition, amountToClose?: BN): [BN, BN];
-    /**
-     * calculates current user leverage across all positions
-     * @returns : Precision TEN_THOUSAND
-     */
-    getLeverage(): BN;
-    /**
-     * calculates max allowable leverage exceeding hitting requirement category
-     * @params category {Initial, Partial, Maintenance}
-     * @returns : Precision TEN_THOUSAND
-     */
-    getMaxLeverage(marketIndex: BN | number, category?: MarginCategory): BN;
-    /**
-     * calculates margin ratio: total collateral / |total position value|
-     * @returns : Precision TEN_THOUSAND
-     */
-    getMarginRatio(): BN;
-    canBeLiquidated(): [boolean, BN];
-    /**
-     * Checks if any user position cumulative funding differs from respective market cumulative funding
-     * @returns
-     */
-    needsToSettleFundingPayment(): boolean;
-    /**
-     * Calculate the liquidation price of a position, with optional parameter to calculate the liquidation price after a trade
-     * @param marketPosition
-     * @param positionBaseSizeChange // change in position size to calculate liquidation price for : Precision 10^13
-     * @param partial
-     * @returns Precision : MARK_PRICE_PRECISION
-     */
-    liquidationPrice(marketPosition: Pick<UserPosition, 'marketIndex'>, positionBaseSizeChange?: BN): BN;
-    /**
-     * Calculates the estimated liquidation price for a position after closing a quote amount of the position.
-     * @param positionMarketIndex
-     * @param closeQuoteAmount
-     * @returns : Precision MARK_PRICE_PRECISION
-     */
-    liquidationPriceAfterClose(positionMarketIndex: BN, closeQuoteAmount: BN): 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
-     *
-     * @param targetMarketIndex
-     * @param tradeSide
-     * @returns tradeSizeAllowed : Precision QUOTE_PRECISION
-     */
-    getMaxTradeSizeUSDC(targetMarketIndex: BN, tradeSide: PositionDirection): BN;
-    /**
-     * Returns the leverage ratio for the account after adding (or subtracting) the given quote size to the given position
-     * @param targetMarketIndex
-     * @param positionMarketIndex
-     * @param tradeQuoteAmount
-     * @returns leverageRatio : Precision TEN_THOUSAND
-     */
-    accountLeverageRatioAfterTrade(targetMarketIndex: BN, tradeQuoteAmount: BN, tradeSide: PositionDirection): BN;
-    /**
-     * Calculates how much fee will be taken for a given sized trade
-     * @param quoteAmount
-     * @returns feeForQuote : Precision QUOTE_PRECISION
-     */
-    calculateFeeForQuoteAmount(quoteAmount: BN): BN;
-    /**
-     * Get the total position value, excluding any position coming from the given target market
-     * @param marketToIgnore
-     * @returns positionValue : Precision QUOTE_PRECISION
-     */
-    private getTotalPositionValueExcludingMarket;
-    private getOracleDataForMarket;
-    private getOracleDataForBank;
-}