@drift-labs/sdk 0.2.0-master.25 → 0.2.0-master.27

package/lib/clearingHouseConfig.d.ts

@@ -14,8 +14,8 @@ export declare type ClearingHouseConfig = {
     txSenderConfig?: TxSenderConfig;
     userIds?: number[];
     activeUserId?: number;
-    marketIndexes?: BN[];
-    bankIndexes?: BN[];
+    perpMarketIndexes?: BN[];
+    spotMarketIndexes?: BN[];
     oracleInfos?: OracleInfo[];
     env?: DriftEnv;
     userStats?: boolean;

package/lib/clearingHouseUser.d.ts

@@ -4,9 +4,9 @@ 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 { MarginCategory, Order, UserAccount, PerpPosition } from './types';
 import { UserAccountSubscriber, UserAccountEvents, DataAndSlot } from './accounts/types';
-import { PositionDirection, BN } from '.';
+import { PositionDirection, BN, SpotMarketAccount } from '.';
 import { OraclePriceData } from './oracles/types';
 import { ClearingHouseUserConfig } from './clearingHouseUserConfig';
 export declare class ClearingHouseUser {
@@ -35,9 +35,9 @@ export declare class ClearingHouseUser {
      * @param marketIndex
      * @returns userPosition
      */
-    getUserPosition(marketIndex: BN): UserPosition | undefined;
-    getEmptyPosition(marketIndex: BN): UserPosition;
-    getClonedPosition(position: UserPosition): UserPosition;
+    getUserPosition(marketIndex: BN): PerpPosition | undefined;
+    getEmptyPosition(marketIndex: BN): PerpPosition;
+    getClonedPosition(position: PerpPosition): PerpPosition;
     /**
      * @param orderId
      * @returns Order
@@ -56,7 +56,7 @@ export declare class ClearingHouseUser {
      * @returns : the dust base asset amount (ie, < stepsize)
      * @returns : pnl from settle
      */
-    getSettledLPPosition(marketIndex: BN): [UserPosition, BN, BN];
+    getSettledLPPosition(marketIndex: BN): [PerpPosition, BN, BN];
     /**
      * calculates Buying Power = FC * MAX_LEVERAGE
      * @returns : Precision QUOTE_PRECISION
@@ -70,7 +70,7 @@ export declare class ClearingHouseUser {
     /**
      * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
      */
-    getMarginRequirement(type: MarginCategory): BN;
+    getMarginRequirement(marginCategory: MarginCategory, liquidationBuffer?: BN): BN;
     /**
      * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
      */
@@ -78,7 +78,7 @@ export declare class ClearingHouseUser {
     /**
      * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION
      */
-    getMaintenanceMarginRequirement(): BN;
+    getMaintenanceMarginRequirement(liquidationBuffer?: BN): BN;
     /**
      * calculates unrealized position price pnl
      * @returns : Precision QUOTE_PRECISION
@@ -89,9 +89,11 @@ export declare class ClearingHouseUser {
      * @returns : Precision QUOTE_PRECISION
      */
     getUnrealizedFundingPNL(marketIndex?: BN): BN;
-    getBankLiabilityValue(bankIndex?: BN, withWeightMarginCategory?: MarginCategory): BN;
-    getBankAssetValue(bankIndex?: BN, withWeightMarginCategory?: MarginCategory): BN;
-    getNetBankValue(withWeightMarginCategory?: MarginCategory): BN;
+    getSpotMarketLiabilityValue(marketIndex?: BN, marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean): BN;
+    getSpotLiabilityValue(tokenAmount: BN, oraclePriceData: OraclePriceData, spotMarketAccount: SpotMarketAccount, marginCategory?: MarginCategory, liquidationBuffer?: BN): BN;
+    getSpotMarketAssetValue(marketIndex?: BN, marginCategory?: MarginCategory, includeOpenOrders?: boolean): BN;
+    getSpotAssetValue(tokenAmount: BN, oraclePriceData: OraclePriceData, spotMarketAccount: SpotMarketAccount, marginCategory?: MarginCategory): BN;
+    getNetSpotMarketValue(withWeightMarginCategory?: MarginCategory): BN;
     /**
      * calculates TotalCollateral: collateral + unrealized pnl
      * @returns : Precision QUOTE_PRECISION
@@ -101,23 +103,23 @@ export declare class ClearingHouseUser {
      * calculates sum of position value across all positions in margin system
      * @returns : Precision QUOTE_PRECISION
      */
-    getTotalPositionValue(): BN;
+    getTotalPerpPositionValue(marginCategory?: MarginCategory, liquidationBuffer?: BN, includeOpenOrders?: boolean): BN;
     /**
      * calculates position value in margin system
      * @returns : Precision QUOTE_PRECISION
      */
-    getPositionValue(marketIndex: BN, oraclePriceData: OraclePriceData): BN;
-    getPositionSide(currentPosition: Pick<UserPosition, 'baseAssetAmount'>): PositionDirection | undefined;
+    getPerpPositionValue(marketIndex: BN, oraclePriceData: OraclePriceData): BN;
+    getPositionSide(currentPosition: Pick<PerpPosition, 'baseAssetAmount'>): PositionDirection | undefined;
     /**
      * calculates average exit price (optionally for closing up to 100% of position)
      * @returns : Precision MARK_PRICE_PRECISION
      */
-    getPositionEstimatedExitPriceAndPnl(position: UserPosition, amountToClose?: BN, useAMMClose?: boolean): [BN, BN];
+    getPositionEstimatedExitPriceAndPnl(position: PerpPosition, amountToClose?: BN, useAMMClose?: boolean): [BN, BN];
     /**
      * calculates current user leverage across all positions
      * @returns : Precision TEN_THOUSAND
      */
-    getLeverage(): BN;
+    getLeverage(marginCategory?: MarginCategory): BN;
     /**
      * calculates max allowable leverage exceeding hitting requirement category
      * @params category {Initial, Partial, Maintenance}
@@ -128,8 +130,8 @@ export declare class ClearingHouseUser {
      * calculates margin ratio: total collateral / |total position value|
      * @returns : Precision TEN_THOUSAND
      */
-    getMarginRatio(): BN;
-    canBeLiquidated(): [boolean, BN];
+    getMarginRatio(marginCategory?: MarginCategory): BN;
+    canBeLiquidated(): boolean;
     /**
      * Checks if any user position cumulative funding differs from respective market cumulative funding
      * @returns
@@ -137,12 +139,12 @@ export declare class ClearingHouseUser {
     needsToSettleFundingPayment(): boolean;
     /**
      * Calculate the liquidation price of a position, with optional parameter to calculate the liquidation price after a trade
-     * @param marketPosition
+     * @param PerpPosition
      * @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;
+    liquidationPrice(perpPosition: Pick<PerpPosition, 'marketIndex'>, positionBaseSizeChange?: BN): BN;
     /**
      * Calculates the estimated liquidation price for a position after closing a quote amount of the position.
      * @param positionMarketIndex
@@ -191,7 +193,7 @@ export declare class ClearingHouseUser {
      * @param marketToIgnore
      * @returns positionValue : Precision QUOTE_PRECISION
      */
-    private getTotalPositionValueExcludingMarket;
+    private getTotalPerpPositionValueExcludingMarket;
     private getOracleDataForMarket;
-    private getOracleDataForBank;
+    private getOracleDataForSpotMarket;
 }