@drift-labs/sdk 2.97.0-beta.2 → 2.97.0-beta.21

package/lib/idl/switchboard_on_demand_30.json

@@ -443,10 +443,14 @@
                     }
                 },
                 {
-                    "name": "queue"
+                    "name": "queue",
+                    "relations": [
+                        "oracle"
+                    ]
                 },
                 {
-                    "name": "authority"
+                    "name": "authority",
+                    "signer": true
                 },
                 {
                     "name": "program_state",
@@ -503,6 +507,9 @@
                 },
                 {
                     "name": "stake_pool"
+                },
+                {
+                    "name": "delegation_group"
                 }
             ],
             "args": [
@@ -955,10 +962,7 @@
                 },
                 {
                     "name": "authority",
-                    "signer": true,
-                    "relations": [
-                        "queue"
-                    ]
+                    "signer": true
                 },
                 {
                     "name": "program_authority"
@@ -1038,6 +1042,13 @@
                 {
                     "name": "oracle",
                     "writable": true
+                },
+                {
+                    "name": "authority",
+                    "signer": true
+                },
+                {
+                    "name": "state"
                 }
             ],
             "args": [
@@ -1294,10 +1305,7 @@
                 },
                 {
                     "name": "authority",
-                    "signer": true,
-                    "relations": [
-                        "queue"
-                    ]
+                    "signer": true
                 },
                 {
                     "name": "program_authority"
@@ -1336,10 +1344,7 @@
                 },
                 {
                     "name": "authority",
-                    "signer": true,
-                    "relations": [
-                        "queue"
-                    ]
+                    "signer": true
                 },
                 {
                     "name": "state"
@@ -1387,6 +1392,13 @@
                 {
                     "name": "recent_slothashes",
                     "address": "SysvarS1otHashes111111111111111111111111111"
+                },
+                {
+                    "name": "authority",
+                    "signer": true,
+                    "relations": [
+                        "randomness"
+                    ]
                 }
             ],
             "args": [
@@ -1860,6 +1872,19 @@
         }
     ],
     "events": [
+        {
+            "name": "CostWhitelistEvent",
+            "discriminator": [
+                56,
+                107,
+                191,
+                127,
+                116,
+                6,
+                138,
+                149
+            ]
+        },
         {
             "name": "GarbageCollectionEvent",
             "discriminator": [
@@ -2235,9 +2260,84 @@
         {
             "code": 6047,
             "name": "InvalidInstruction"
+        },
+        {
+            "code": 6048,
+            "name": "OracleAlreadyVerified"
+        },
+        {
+            "code": 6049,
+            "name": "GuardianNotVerified"
+        },
+        {
+            "code": 6050,
+            "name": "InvalidConstraint"
+        },
+        {
+            "code": 6051,
+            "name": "InvalidDelegationGroup"
+        },
+        {
+            "code": 6052,
+            "name": "OracleKeyNotFound"
+        },
+        {
+            "code": 6053,
+            "name": "GuardianReregisterAttempt"
         }
     ],
     "types": [
+        {
+            "name": "CompactResult",
+            "serialization": "bytemuck",
+            "repr": {
+                "kind": "c"
+            },
+            "type": {
+                "kind": "struct",
+                "fields": [
+                    {
+                        "name": "std_dev",
+                        "docs": [
+                            "The standard deviation of the submissions needed for quorom size"
+                        ],
+                        "type": "f32"
+                    },
+                    {
+                        "name": "mean",
+                        "docs": [
+                            "The mean of the submissions needed for quorom size"
+                        ],
+                        "type": "f32"
+                    },
+                    {
+                        "name": "slot",
+                        "docs": [
+                            "The slot at which this value was signed."
+                        ],
+                        "type": "u64"
+                    }
+                ]
+            }
+        },
+        {
+            "name": "CostWhitelistEvent",
+            "type": {
+                "kind": "struct",
+                "fields": [
+                    {
+                        "name": "feeds",
+                        "type": {
+                            "vec": "pubkey"
+                        }
+                    },
+                    {
+                        "name": "reward",
+                        "type": "u32"
+                    }
+                ]
+            }
+        },
         {
             "name": "CurrentResult",
             "serialization": "bytemuck",
@@ -2384,7 +2484,7 @@
                         }
                     },
                     {
-                        "name": "idx",
+                        "name": "_reserved1",
                         "type": "u32"
                     },
                     {
@@ -2437,12 +2537,7 @@
             "name": "GuardianUnregisterParams",
             "type": {
                 "kind": "struct",
-                "fields": [
-                    {
-                        "name": "idx",
-                        "type": "u32"
-                    }
-                ]
+                "fields": []
             }
         },
         {
@@ -2948,7 +3043,7 @@
                 "kind": "struct",
                 "fields": [
                     {
-                        "name": "recent_slot",
+                        "name": "_reserved1",
                         "type": "u64"
                     }
                 ]
@@ -3068,14 +3163,18 @@
                         }
                     },
                     {
-                        "name": "_padding1",
+                        "name": "padding1",
                         "type": {
                             "array": [
                                 "u8",
-                                3
+                                2
                             ]
                         }
                     },
+                    {
+                        "name": "historical_result_idx",
+                        "type": "u8"
+                    },
                     {
                         "name": "min_sample_size",
                         "type": "u8"
@@ -3089,7 +3188,7 @@
                         "type": "u64"
                     },
                     {
-                        "name": "ipfs_hash",
+                        "name": "_reserved1",
                         "type": {
                             "array": [
                                 "u8",
@@ -3110,38 +3209,51 @@
                         "type": "u32"
                     },
                     {
-                        "name": "_ebuf4",
+                        "name": "padding2",
                         "type": {
                             "array": [
                                 "u8",
-                                20
+                                12
                             ]
                         }
                     },
                     {
-                        "name": "_ebuf3",
+                        "name": "historical_results",
+                        "type": {
+                            "array": [
+                                {
+                                    "defined": {
+                                        "name": "CompactResult"
+                                    }
+                                },
+                                32
+                            ]
+                        }
+                    },
+                    {
+                        "name": "_ebuf4",
                         "type": {
                             "array": [
                                 "u8",
-                                24
+                                8
                             ]
                         }
                     },
                     {
-                        "name": "_ebuf2",
+                        "name": "_ebuf3",
                         "type": {
                             "array": [
                                 "u8",
-                                256
+                                24
                             ]
                         }
                     },
                     {
-                        "name": "_ebuf1",
+                        "name": "_ebuf2",
                         "type": {
                             "array": [
                                 "u8",
-                                512
+                                256
                             ]
                         }
                     }
@@ -4237,12 +4349,43 @@
                         "name": "lut_slot",
                         "type": "u64"
                     },
+                    {
+                        "name": "base_reward",
+                        "type": "u32"
+                    },
+                    {
+                        "name": "_ebuf6",
+                        "type": {
+                            "array": [
+                                "u8",
+                                28
+                            ]
+                        }
+                    },
+                    {
+                        "name": "_ebuf5",
+                        "type": {
+                            "array": [
+                                "u8",
+                                32
+                            ]
+                        }
+                    },
+                    {
+                        "name": "_ebuf4",
+                        "type": {
+                            "array": [
+                                "u8",
+                                64
+                            ]
+                        }
+                    },
                     {
                         "name": "_ebuf3",
                         "type": {
                             "array": [
                                 "u8",
-                                256
+                                128
                             ]
                         }
                     },
@@ -4256,11 +4399,14 @@
                         }
                     },
                     {
-                        "name": "_ebuf1",
+                        "name": "cost_whitelist",
+                        "docs": [
+                            "Cost whitelist by authority"
+                        ],
                         "type": {
                             "array": [
-                                "u8",
-                                1024
+                                "pubkey",
+                                32
                             ]
                         }
                     }
@@ -4346,6 +4492,18 @@
                     {
                         "name": "subsidy_amount",
                         "type": "u32"
+                    },
+                    {
+                        "name": "base_reward",
+                        "type": "u32"
+                    },
+                    {
+                        "name": "add_cost_wl",
+                        "type": "pubkey"
+                    },
+                    {
+                        "name": "rm_cost_wl",
+                        "type": "pubkey"
                     }
                 ]
             }

package/lib/math/margin.d.ts

@@ -21,19 +21,19 @@ export declare function calculateWorstCasePerpLiabilityValue(perpPosition: PerpP
     worstCaseBaseAssetAmount: BN;
     worstCaseLiabilityValue: BN;
 };
-export declare function calculatePerpLiabilityValue(baseAssetAmount: BN, oraclePrice: BN, isPredictionMarket: boolean): BN;
+export declare function calculatePerpLiabilityValue(baseAssetAmount: BN, price: BN, isPredictionMarket: boolean): BN;
 /**
  * Calculates the margin required to open a trade, in quote amount. Only accounts for the trade size as a scalar value, does not account for the trade direction or current open positions and whether the trade would _actually_ be risk-increasing and use any extra collateral.
  * @param targetMarketIndex
  * @param baseSize
  * @returns
  */
-export declare function calculateMarginUSDCRequiredForTrade(driftClient: DriftClient, targetMarketIndex: number, baseSize: BN, userMaxMarginRatio?: number): BN;
+export declare function calculateMarginUSDCRequiredForTrade(driftClient: DriftClient, targetMarketIndex: number, baseSize: BN, userMaxMarginRatio?: number, userHighLeverageMode?: boolean, entryPrice?: BN): BN;
 /**
  * Similar to calculatetMarginUSDCRequiredForTrade, but calculates how much of a given collateral is required to cover the margin requirements for a given trade. Basically does the same thing as getMarginUSDCRequiredForTrade but also accounts for asset weight of the selected collateral.
  *
  * Returns collateral required in the precision of the target collateral market.
  */
-export declare function calculateCollateralDepositRequiredForTrade(driftClient: DriftClient, targetMarketIndex: number, baseSize: BN, collateralIndex: number, userMaxMarginRatio?: number): BN;
+export declare function calculateCollateralDepositRequiredForTrade(driftClient: DriftClient, targetMarketIndex: number, baseSize: BN, collateralIndex: number, userMaxMarginRatio?: number, userHighLeverageMode?: boolean, estEntryPrice?: BN): BN;
 export declare function calculateCollateralValueOfDeposit(driftClient: DriftClient, collateralIndex: number, baseSize: BN): BN;
 export declare function calculateLiquidationPrice(freeCollateral: BN, freeCollateralDelta: BN, oraclePrice: BN): BN;

package/lib/math/margin.js

@@ -100,20 +100,20 @@ function calculateWorstCasePerpLiabilityValue(perpPosition, perpMarket, oraclePr
     }
 }
 exports.calculateWorstCasePerpLiabilityValue = calculateWorstCasePerpLiabilityValue;
-function calculatePerpLiabilityValue(baseAssetAmount, oraclePrice, isPredictionMarket) {
+function calculatePerpLiabilityValue(baseAssetAmount, price, isPredictionMarket) {
     if (isPredictionMarket) {
         if (baseAssetAmount.gt(numericConstants_1.ZERO)) {
-            return baseAssetAmount.mul(oraclePrice).div(numericConstants_1.BASE_PRECISION);
+            return baseAssetAmount.mul(price).div(numericConstants_1.BASE_PRECISION);
         }
         else {
             return baseAssetAmount
                 .abs()
-                .mul(numericConstants_1.MAX_PREDICTION_PRICE.sub(oraclePrice))
+                .mul(numericConstants_1.MAX_PREDICTION_PRICE.sub(price))
                 .div(numericConstants_1.BASE_PRECISION);
         }
     }
     else {
-        return baseAssetAmount.abs().mul(oraclePrice).div(numericConstants_1.BASE_PRECISION);
+        return baseAssetAmount.abs().mul(price).div(numericConstants_1.BASE_PRECISION);
     }
 }
 exports.calculatePerpLiabilityValue = calculatePerpLiabilityValue;
@@ -123,11 +123,11 @@ exports.calculatePerpLiabilityValue = calculatePerpLiabilityValue;
  * @param baseSize
  * @returns
  */
-function calculateMarginUSDCRequiredForTrade(driftClient, targetMarketIndex, baseSize, userMaxMarginRatio) {
+function calculateMarginUSDCRequiredForTrade(driftClient, targetMarketIndex, baseSize, userMaxMarginRatio, userHighLeverageMode, entryPrice) {
     const targetMarket = driftClient.getPerpMarketAccount(targetMarketIndex);
-    const oracleData = driftClient.getOracleDataForPerpMarket(targetMarket.marketIndex);
-    const perpLiabilityValue = calculatePerpLiabilityValue(baseSize, oracleData.price, (0, types_1.isVariant)(targetMarket.contractType, 'prediction'));
-    const marginRequired = new anchor_1.BN((0, __1.calculateMarketMarginRatio)(targetMarket, baseSize.abs(), 'Initial', userMaxMarginRatio))
+    const price = entryPrice !== null && entryPrice !== void 0 ? entryPrice : driftClient.getOracleDataForPerpMarket(targetMarket.marketIndex).price;
+    const perpLiabilityValue = calculatePerpLiabilityValue(baseSize, price, (0, types_1.isVariant)(targetMarket.contractType, 'prediction'));
+    const marginRequired = new anchor_1.BN((0, __1.calculateMarketMarginRatio)(targetMarket, baseSize.abs(), 'Initial', userMaxMarginRatio, userHighLeverageMode))
         .mul(perpLiabilityValue)
         .div(numericConstants_1.MARGIN_PRECISION);
     return marginRequired;
@@ -138,8 +138,8 @@ exports.calculateMarginUSDCRequiredForTrade = calculateMarginUSDCRequiredForTrad
  *
  * Returns collateral required in the precision of the target collateral market.
  */
-function calculateCollateralDepositRequiredForTrade(driftClient, targetMarketIndex, baseSize, collateralIndex, userMaxMarginRatio) {
-    const marginRequiredUsdc = calculateMarginUSDCRequiredForTrade(driftClient, targetMarketIndex, baseSize, userMaxMarginRatio);
+function calculateCollateralDepositRequiredForTrade(driftClient, targetMarketIndex, baseSize, collateralIndex, userMaxMarginRatio, userHighLeverageMode, estEntryPrice) {
+    const marginRequiredUsdc = calculateMarginUSDCRequiredForTrade(driftClient, targetMarketIndex, baseSize, userMaxMarginRatio, userHighLeverageMode, estEntryPrice);
     const collateralMarket = driftClient.getSpotMarketAccount(collateralIndex);
     const collateralOracleData = driftClient.getOracleDataForSpotMarket(collateralIndex);
     const scaledAssetWeight = (0, __1.calculateScaledInitialAssetWeight)(collateralMarket, collateralOracleData.price);

package/lib/math/market.d.ts

@@ -27,7 +27,7 @@ export declare function calculateAskPrice(market: PerpMarketAccount, oraclePrice
 export declare function calculateNewMarketAfterTrade(baseAssetAmount: BN, direction: PositionDirection, market: PerpMarketAccount): PerpMarketAccount;
 export declare function calculateOracleReserveSpread(market: PerpMarketAccount, oraclePriceData: OraclePriceData): BN;
 export declare function calculateOracleSpread(price: BN, oraclePriceData: OraclePriceData): BN;
-export declare function calculateMarketMarginRatio(market: PerpMarketAccount, size: BN, marginCategory: MarginCategory, customMarginRatio?: number): number;
+export declare function calculateMarketMarginRatio(market: PerpMarketAccount, size: BN, marginCategory: MarginCategory, customMarginRatio?: number, userHighLeverageMode?: boolean): number;
 export declare function calculateUnrealizedAssetWeight(market: PerpMarketAccount, quoteSpotMarket: SpotMarketAccount, unrealizedPnl: BN, marginCategory: MarginCategory, oraclePriceData: OraclePriceData): BN;
 export declare function calculateMarketAvailablePNL(perpMarket: PerpMarketAccount, spotMarket: SpotMarketAccount): BN;
 export declare function calculateMarketMaxAvailableInsurance(perpMarket: PerpMarketAccount, spotMarket: SpotMarketAccount): BN;

package/lib/math/market.js

@@ -60,16 +60,28 @@ function calculateOracleSpread(price, oraclePriceData) {
     return price.sub(oraclePriceData.price);
 }
 exports.calculateOracleSpread = calculateOracleSpread;
-function calculateMarketMarginRatio(market, size, marginCategory, customMarginRatio = 0) {
+function calculateMarketMarginRatio(market, size, marginCategory, customMarginRatio = 0, userHighLeverageMode = false) {
+    let marginRationInitial;
+    let marginRatioMaintenance;
+    if (userHighLeverageMode &&
+        market.highLeverageMarginRatioInitial > 0 &&
+        market.highLeverageMarginRatioMaintenance) {
+        marginRationInitial = market.highLeverageMarginRatioInitial;
+        marginRatioMaintenance = market.highLeverageMarginRatioMaintenance;
+    }
+    else {
+        marginRationInitial = market.marginRatioInitial;
+        marginRatioMaintenance = market.marginRatioMaintenance;
+    }
     let marginRatio;
     switch (marginCategory) {
         case 'Initial': {
             // use lowest leverage between max allowed and optional user custom max
-            marginRatio = Math.max((0, margin_1.calculateSizePremiumLiabilityWeight)(size, new anchor_1.BN(market.imfFactor), new anchor_1.BN(market.marginRatioInitial), numericConstants_1.MARGIN_PRECISION).toNumber(), customMarginRatio);
+            marginRatio = Math.max((0, margin_1.calculateSizePremiumLiabilityWeight)(size, new anchor_1.BN(market.imfFactor), new anchor_1.BN(marginRationInitial), numericConstants_1.MARGIN_PRECISION).toNumber(), customMarginRatio);
             break;
         }
         case 'Maintenance': {
-            marginRatio = (0, margin_1.calculateSizePremiumLiabilityWeight)(size, new anchor_1.BN(market.imfFactor), new anchor_1.BN(market.marginRatioMaintenance), numericConstants_1.MARGIN_PRECISION).toNumber();
+            marginRatio = (0, margin_1.calculateSizePremiumLiabilityWeight)(size, new anchor_1.BN(market.imfFactor), new anchor_1.BN(marginRatioMaintenance), numericConstants_1.MARGIN_PRECISION).toNumber();
             break;
         }
     }

package/lib/types.d.ts

@@ -71,6 +71,14 @@ export declare enum UserStatus {
     REDUCE_ONLY = 4,
     ADVANCED_LP = 8
 }
+export declare class MarginMode {
+    static readonly DEFAULT: {
+        default: {};
+    };
+    static readonly HIGH_LEVERAGE: {
+        highLeverage: {};
+    };
+}
 export declare class ContractType {
     static readonly PERPETUAL: {
         perpetual: {};
@@ -753,6 +761,8 @@ export type PerpMarketAccount = {
     fuelBoostTaker: number;
     fuelBoostMaker: number;
     fuelBoostPosition: number;
+    highLeverageMarginRatioInitial: number;
+    highLeverageMarginRatioMaintenance: number;
 };
 export type HistoricalOracleData = {
     lastOraclePrice: BN;
@@ -964,7 +974,7 @@ export type UserStatsAccount = {
         current_epoch_referrer_reward: BN;
     };
     referrer: PublicKey;
-    isReferrer: boolean;
+    referrerStatus: boolean;
     authority: PublicKey;
     ifStakedQuoteAssetAmount: BN;
     lastFuelIfBonusUpdateTs: number;
@@ -1004,6 +1014,7 @@ export type UserAccount = {
     openAuctions: number;
     hasOpenAuction: boolean;
     lastFuelBonusUpdateTs: number;
+    marginMode: MarginMode;
 };
 export type SpotPosition = {
     marketIndex: number;
@@ -1127,6 +1138,10 @@ export type ReferrerInfo = {
     referrer: PublicKey;
     referrerStats: PublicKey;
 };
+export declare enum ReferrerStatus {
+    IsReferrer = 1,
+    IsReferred = 2
+}
 export declare enum PlaceAndTakeOrderSuccessCondition {
     PartialFill = 1,
     FullFill = 2
@@ -1308,4 +1323,9 @@ export type SignedTxData = {
     lastValidBlockHeight?: number;
     blockHash: string;
 };
+export type HighLeverageModeConfig = {
+    maxUsers: number;
+    currentUsers: number;
+    reduceOnly: boolean;
+};
 export {};

package/lib/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwapReduceOnly = exports.PlaceAndTakeOrderSuccessCondition = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PostOnlyParams = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.ExchangeStatus = void 0;
+exports.SwapReduceOnly = exports.PlaceAndTakeOrderSuccessCondition = exports.ReferrerStatus = exports.DefaultOrderParams = exports.ModifyOrderPolicy = exports.PostOnlyParams = exports.LiquidationType = exports.LPAction = exports.TradeSide = exports.getVariant = exports.isOneOfVariant = exports.isVariant = exports.SettlePnlMode = exports.StakeAction = exports.SpotFulfillmentConfigStatus = exports.SettlePnlExplanation = exports.DepositExplanation = exports.SpotFulfillmentStatus = exports.SpotFulfillmentType = exports.OrderTriggerCondition = exports.OrderActionExplanation = exports.OrderAction = exports.OrderStatus = exports.MarketType = exports.OrderType = exports.OracleSource = exports.DepositDirection = exports.PositionDirection = exports.SpotBalanceType = exports.SwapDirection = exports.AssetTier = exports.ContractTier = exports.ContractType = exports.MarginMode = exports.UserStatus = exports.InsuranceFundOperation = exports.SpotOperation = exports.PerpOperation = exports.MarketStatus = exports.ExchangeStatus = void 0;
 const _1 = require(".");
 // # Utility Types / Enums / Constants
 var ExchangeStatus;
@@ -58,6 +58,11 @@ var UserStatus;
     UserStatus[UserStatus["REDUCE_ONLY"] = 4] = "REDUCE_ONLY";
     UserStatus[UserStatus["ADVANCED_LP"] = 8] = "ADVANCED_LP";
 })(UserStatus = exports.UserStatus || (exports.UserStatus = {}));
+class MarginMode {
+}
+exports.MarginMode = MarginMode;
+MarginMode.DEFAULT = { default: {} };
+MarginMode.HIGH_LEVERAGE = { highLeverage: {} };
 class ContractType {
 }
 exports.ContractType = ContractType;
@@ -325,6 +330,11 @@ exports.DefaultOrderParams = {
     auctionStartPrice: null,
     auctionEndPrice: null,
 };
+var ReferrerStatus;
+(function (ReferrerStatus) {
+    ReferrerStatus[ReferrerStatus["IsReferrer"] = 1] = "IsReferrer";
+    ReferrerStatus[ReferrerStatus["IsReferred"] = 2] = "IsReferred";
+})(ReferrerStatus = exports.ReferrerStatus || (exports.ReferrerStatus = {}));
 var PlaceAndTakeOrderSuccessCondition;
 (function (PlaceAndTakeOrderSuccessCondition) {
     PlaceAndTakeOrderSuccessCondition[PlaceAndTakeOrderSuccessCondition["PartialFill"] = 1] = "PartialFill";

package/lib/user.d.ts

@@ -247,6 +247,7 @@ export declare class User {
     isBeingLiquidated(): boolean;
     hasStatus(status: UserStatus): boolean;
     isBankrupt(): boolean;
+    isHighLeverageMode(): boolean;
     /**
      * Checks if any user position cumulative funding differs from respective market cumulative funding
      * @returns
@@ -279,7 +280,7 @@ export declare class User {
      * @returns : Precision PRICE_PRECISION
      */
     liquidationPriceAfterClose(positionMarketIndex: number, closeQuoteAmount: BN, estimatedEntryPrice?: BN): BN;
-    getMarginUSDCRequiredForTrade(targetMarketIndex: number, baseSize: BN): BN;
+    getMarginUSDCRequiredForTrade(targetMarketIndex: number, baseSize: BN, estEntryPrice?: BN): BN;
     getCollateralDepositRequiredForTrade(targetMarketIndex: number, baseSize: BN, collateralIndex: number): BN;
     /**
      * Get the maximum trade size for a given market, taking into account the user's current leverage, positions, collateral, etc.