@velocity-exchange/sdk 0.1.0 → 0.2.1

package/lib/browser/user.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="bn.js" />
 /**
  * User — read-oriented abstraction over the on-chain `User` account.
  *
@@ -45,9 +44,21 @@ export declare class User {
      */
     fetchAccounts(): Promise<void>;
     unsubscribe(): Promise<void>;
-    getUserAccount(): UserAccount;
-    forceGetUserAccount(): Promise<UserAccount>;
+    getUserAccount(): UserAccount | undefined;
+    /**
+     * Like {@link getUserAccount} but throws a named error instead of returning
+     * `undefined` when the account has not been loaded yet. Use at call sites
+     * that structurally require a loaded account.
+     */
+    getUserAccountOrThrow(): UserAccount;
+    forceGetUserAccount(): Promise<UserAccount | undefined>;
     getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined;
+    /**
+     * Like {@link getUserAccountAndSlot} but throws a named error instead of
+     * returning `undefined` when the account has not been loaded yet. Use at
+     * call sites that structurally require a loaded account.
+     */
+    getUserAccountAndSlotOrThrow(): DataAndSlot<UserAccount>;
     getPerpPositionForUserAccount(userAccount: UserAccount, marketIndex: number): PerpPosition | undefined;
     /**
      * Gets the user's current position for a given perp market. If the user has no position returns undefined
@@ -56,6 +67,7 @@ export declare class User {
      */
     getPerpPosition(marketIndex: number): PerpPosition | undefined;
     getPerpPositionOrEmpty(marketIndex: number): PerpPosition;
+    getPerpPositionOrThrow(marketIndex: number): PerpPosition;
     getPerpPositionAndSlot(marketIndex: number): DataAndSlot<PerpPosition | undefined>;
     getSpotPositionForUserAccount(userAccount: UserAccount, marketIndex: number): SpotPosition | undefined;
     /**
@@ -95,7 +107,7 @@ export declare class User {
      */
     getOrderByUserOrderId(userOrderId: number): Order | undefined;
     getOrderByUserOrderIdAndSlot(userOrderId: number): DataAndSlot<Order | undefined>;
-    getOpenOrdersForUserAccount(userAccount?: UserAccount): Order[];
+    getOpenOrdersForUserAccount(userAccount?: UserAccount): Order[] | undefined;
     getOpenOrders(): Order[];
     getOpenOrdersAndSlot(): DataAndSlot<Order[]>;
     getUserAccountPublicKey(): PublicKey;
@@ -110,8 +122,9 @@ export declare class User {
      * calculates Buying Power = free collateral / initial margin ratio
      * @returns : Precision QUOTE_PRECISION
      */
-    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): BN;
-    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, perpMarketMaxMarginRatio?: any): BN;
+    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, maxMarginRatio?: number | undefined, positionType?: 'isolated' | 'cross'): BN;
+    private resolveMaxMarginRatio;
+    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, perpMarketMaxMarginRatio?: number | undefined): BN;
     /**
      * calculates Free Collateral = Total collateral - margin requirement
      * @returns : Precision QUOTE_PRECISION
@@ -216,7 +229,7 @@ export declare class User {
         spotAssetValue: BN;
         spotLiabilityValue: BN;
     }): BN;
-    getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory, perpMarketIndex?: number): {
+    getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory | undefined, perpMarketIndex?: number): {
         perpLiabilityValue: BN;
         perpPnl: BN;
         spotAssetValue: BN;
@@ -315,7 +328,7 @@ export declare class User {
      * @param tradeSide
      * @returns { tradeSize: BN, oppositeSideTradeSize: BN} : Precision QUOTE_PRECISION
      */
-    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): {
+    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, maxMarginRatio?: number | undefined, positionType?: 'isolated' | 'cross'): {
         tradeSize: BN;
         oppositeSideTradeSize: BN;
     };