@drift-labs/sdk 2.42.0-beta.1 → 2.42.0-beta.11

package/lib/math/funding.js

@@ -72,7 +72,8 @@ async function calculateAllEstimatedFundingRate(market, oraclePriceData, markPri
     // 	console.log('shrink orac:', liveOracleTwap.toString(), '->', oracleTwap.toString());
     // }
     const twapSpread = markTwap.sub(oracleTwap);
-    const twapSpreadPct = twapSpread
+    const twapSpreadWithOffset = twapSpread.add(oracleTwap.abs().div(numericConstants_1.FUNDING_RATE_OFFSET_DENOMINATOR));
+    const twapSpreadPct = twapSpreadWithOffset
         .mul(numericConstants_1.PRICE_PRECISION)
         .mul(new anchor_1.BN(100))
         .div(oracleTwap);

package/lib/math/insurance.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '../index';
 export declare function stakeAmountToShares(amount: BN, totalIfShares: BN, insuranceFundVaultBalance: BN): BN;
 export declare function unstakeSharesToAmount(nShares: BN, totalIfShares: BN, insuranceFundVaultBalance: BN): BN;

package/lib/math/margin.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '@coral-xyz/anchor';
 import { OraclePriceData } from '../oracles/types';
 import { PerpMarketAccount, PerpPosition } from '..';

package/lib/math/market.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '@coral-xyz/anchor';
 import { PerpMarketAccount, PositionDirection, MarginCategory, SpotMarketAccount } from '../types';
 import { OraclePriceData } from '../oracles/types';
@@ -26,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): number;
+export declare function calculateMarketMarginRatio(market: PerpMarketAccount, size: BN, marginCategory: MarginCategory, customMarginRatio?: number): 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,11 +60,12 @@ function calculateOracleSpread(price, oraclePriceData) {
     return price.sub(oraclePriceData.price);
 }
 exports.calculateOracleSpread = calculateOracleSpread;
-function calculateMarketMarginRatio(market, size, marginCategory) {
+function calculateMarketMarginRatio(market, size, marginCategory, customMarginRatio = 0) {
     let marginRatio;
     switch (marginCategory) {
         case 'Initial': {
-            marginRatio = (0, margin_1.calculateSizePremiumLiabilityWeight)(size, new anchor_1.BN(market.imfFactor), new anchor_1.BN(market.marginRatioInitial), numericConstants_1.MARGIN_PRECISION).toNumber();
+            // 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);
             break;
         }
         case 'Maintenance': {

package/lib/math/oracles.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { AMM, OracleGuardRails } from '../types';
 import { OraclePriceData } from '../oracles/types';
 import { BN, HistoricalOracleData, PerpMarketAccount } from '../index';

package/lib/math/orders.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { User } from '../user';
 import { PerpMarketAccount, AMM, Order, PositionDirection } from '../types';
 import { BN } from '@coral-xyz/anchor';

package/lib/math/position.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN, SpotMarketAccount } from '../';
 import { OraclePriceData } from '../oracles/types';
 import { PerpMarketAccount, PositionDirection, PerpPosition } from '../types';

package/lib/math/repeg.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '@coral-xyz/anchor';
 import { AMM } from '../types';
 /**

package/lib/math/spotBalance.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { SpotMarketAccount, SpotBalanceType, MarginCategory } from '../types';
 import { BN } from '@coral-xyz/anchor';
 import { OraclePriceData } from '../oracles/types';
@@ -50,7 +51,7 @@ export declare function getTokenValue(tokenAmount: BN, spotDecimals: number, ora
 export declare function calculateAssetWeight(balanceAmount: BN, oraclePrice: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): BN;
 export declare function calculateScaledInitialAssetWeight(spotMarket: SpotMarketAccount, oraclePrice: BN): BN;
 export declare function calculateLiabilityWeight(size: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): BN;
-export declare function calculateUtilization(bank: SpotMarketAccount, delta?: any): BN;
+export declare function calculateUtilization(bank: SpotMarketAccount, delta?: BN): BN;
 /**
  * calculates max borrow amount where rate would stay below targetBorrowRate
  * @param spotMarketAccount
@@ -61,7 +62,7 @@ export declare function calculateSpotMarketBorrowCapacity(spotMarketAccount: Spo
     totalCapacity: BN;
     remainingCapacity: BN;
 };
-export declare function calculateInterestRate(bank: SpotMarketAccount, delta?: any): BN;
+export declare function calculateInterestRate(bank: SpotMarketAccount, delta?: BN): BN;
 export declare function calculateDepositRate(bank: SpotMarketAccount): BN;
 export declare function calculateBorrowRate(bank: SpotMarketAccount): BN;
 export declare function calculateInterestAccumulated(bank: SpotMarketAccount, now: BN): {

package/lib/math/spotMarket.d.ts

@@ -1,4 +1,5 @@
+/// <reference types="bn.js" />
 import { BN } from '@coral-xyz/anchor';
 import { MarginCategory, SpotBalanceType, SpotMarketAccount } from '../types';
 export declare function castNumberToSpotPrecision(value: number | BN, spotMarket: SpotMarketAccount): BN;
-export declare function calculateSpotMarketMarginRatio(market: SpotMarketAccount, oraclePrice: BN, marginCategory: MarginCategory, size: BN, balanceType: SpotBalanceType): number;
+export declare function calculateSpotMarketMarginRatio(market: SpotMarketAccount, oraclePrice: BN, marginCategory: MarginCategory, size: BN, balanceType: SpotBalanceType, customMarginRatio?: number): number;

package/lib/math/spotMarket.js

@@ -14,14 +14,20 @@ function castNumberToSpotPrecision(value, spotMarket) {
     }
 }
 exports.castNumberToSpotPrecision = castNumberToSpotPrecision;
-function calculateSpotMarketMarginRatio(market, oraclePrice, marginCategory, size, balanceType) {
+function calculateSpotMarketMarginRatio(market, oraclePrice, marginCategory, size, balanceType, customMarginRatio = 0) {
+    let marginRatio;
     if ((0, types_1.isVariant)(balanceType, 'deposit')) {
         const assetWeight = (0, spotBalance_1.calculateAssetWeight)(size, oraclePrice, market, marginCategory);
-        return numericConstants_1.MARGIN_PRECISION.sub(assetWeight).toNumber();
+        marginRatio = numericConstants_1.MARGIN_PRECISION.sub(assetWeight).toNumber();
     }
     else {
         const liabilityWeight = (0, spotBalance_1.calculateLiabilityWeight)(size, market, marginCategory);
-        return liabilityWeight.sub(numericConstants_1.MARGIN_PRECISION).toNumber();
+        marginRatio = liabilityWeight.sub(numericConstants_1.MARGIN_PRECISION).toNumber();
     }
+    if (marginCategory === 'Initial') {
+        // use lowest leverage between max allowed and optional user custom max
+        return Math.max(marginRatio, customMarginRatio);
+    }
+    return marginRatio;
 }
 exports.calculateSpotMarketMarginRatio = calculateSpotMarketMarginRatio;

package/lib/math/spotPosition.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { MarginCategory, SpotMarketAccount, SpotPosition } from '../types';
 import { BN } from '@coral-xyz/anchor';
 import { StrictOraclePrice } from '../oracles/strictOraclePrice';
@@ -10,9 +11,9 @@ export type OrderFillSimulation = {
     weightedTokenValue: BN;
     freeCollateralContribution: any;
 };
-export declare function getWorstCaseTokenAmounts(spotPosition: SpotPosition, spotMarketAccount: SpotMarketAccount, strictOraclePrice: StrictOraclePrice, marginCategory: MarginCategory): OrderFillSimulation;
-export declare function calculateWeightedTokenValue(tokenAmount: BN, tokenValue: BN, oraclePrice: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): {
+export declare function getWorstCaseTokenAmounts(spotPosition: SpotPosition, spotMarketAccount: SpotMarketAccount, strictOraclePrice: StrictOraclePrice, marginCategory: MarginCategory, customMarginRatio?: number): OrderFillSimulation;
+export declare function calculateWeightedTokenValue(tokenAmount: BN, tokenValue: BN, oraclePrice: BN, spotMarket: SpotMarketAccount, marginCategory: MarginCategory, customMarginRatio?: number): {
     weight: BN;
     weightedTokenValue: BN;
 };
-export declare function simulateOrderFill(tokenAmount: BN, tokenValue: BN, openOrders: BN, strictOraclePrice: StrictOraclePrice, spotMarket: SpotMarketAccount, marginCategory: MarginCategory): OrderFillSimulation;
+export declare function simulateOrderFill(tokenAmount: BN, tokenValue: BN, openOrders: BN, strictOraclePrice: StrictOraclePrice, spotMarket: SpotMarketAccount, marginCategory: MarginCategory, customMarginRatio?: number): OrderFillSimulation;

package/lib/math/spotPosition.js

@@ -2,16 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.simulateOrderFill = exports.calculateWeightedTokenValue = exports.getWorstCaseTokenAmounts = exports.isSpotPositionAvailable = void 0;
 const numericConstants_1 = require("../constants/numericConstants");
+const anchor_1 = require("@coral-xyz/anchor");
 const spotBalance_1 = require("./spotBalance");
 function isSpotPositionAvailable(position) {
     return position.scaledBalance.eq(numericConstants_1.ZERO) && position.openOrders === 0;
 }
 exports.isSpotPositionAvailable = isSpotPositionAvailable;
-function getWorstCaseTokenAmounts(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory) {
+function getWorstCaseTokenAmounts(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory, customMarginRatio) {
     const tokenAmount = (0, spotBalance_1.getSignedTokenAmount)((0, spotBalance_1.getTokenAmount)(spotPosition.scaledBalance, spotMarketAccount, spotPosition.balanceType), spotPosition.balanceType);
     const tokenValue = (0, spotBalance_1.getStrictTokenValue)(tokenAmount, spotMarketAccount.decimals, strictOraclePrice);
     if (spotPosition.openBids.eq(numericConstants_1.ZERO) && spotPosition.openAsks.eq(numericConstants_1.ZERO)) {
-        const { weight, weightedTokenValue } = calculateWeightedTokenValue(tokenAmount, tokenValue, strictOraclePrice.current, spotMarketAccount, marginCategory);
+        const { weight, weightedTokenValue } = calculateWeightedTokenValue(tokenAmount, tokenValue, strictOraclePrice.current, spotMarketAccount, marginCategory, customMarginRatio);
         return {
             tokenAmount,
             ordersValue: numericConstants_1.ZERO,
@@ -21,8 +22,8 @@ function getWorstCaseTokenAmounts(spotPosition, spotMarketAccount, strictOracleP
             freeCollateralContribution: weightedTokenValue,
         };
     }
-    const bidsSimulation = simulateOrderFill(tokenAmount, tokenValue, spotPosition.openBids, strictOraclePrice, spotMarketAccount, marginCategory);
-    const asksSimulation = simulateOrderFill(tokenAmount, tokenValue, spotPosition.openAsks, strictOraclePrice, spotMarketAccount, marginCategory);
+    const bidsSimulation = simulateOrderFill(tokenAmount, tokenValue, spotPosition.openBids, strictOraclePrice, spotMarketAccount, marginCategory, customMarginRatio);
+    const asksSimulation = simulateOrderFill(tokenAmount, tokenValue, spotPosition.openAsks, strictOraclePrice, spotMarketAccount, marginCategory, customMarginRatio);
     if (asksSimulation.freeCollateralContribution.lt(bidsSimulation.freeCollateralContribution)) {
         return asksSimulation;
     }
@@ -31,7 +32,7 @@ function getWorstCaseTokenAmounts(spotPosition, spotMarketAccount, strictOracleP
     }
 }
 exports.getWorstCaseTokenAmounts = getWorstCaseTokenAmounts;
-function calculateWeightedTokenValue(tokenAmount, tokenValue, oraclePrice, spotMarket, marginCategory) {
+function calculateWeightedTokenValue(tokenAmount, tokenValue, oraclePrice, spotMarket, marginCategory, customMarginRatio) {
     let weight;
     if (tokenValue.gte(numericConstants_1.ZERO)) {
         weight = (0, spotBalance_1.calculateAssetWeight)(tokenAmount, oraclePrice, spotMarket, marginCategory);
@@ -39,6 +40,16 @@ function calculateWeightedTokenValue(tokenAmount, tokenValue, oraclePrice, spotM
     else {
         weight = (0, spotBalance_1.calculateLiabilityWeight)(tokenAmount.abs(), spotMarket, marginCategory);
     }
+    if (marginCategory === 'Initial' &&
+        customMarginRatio &&
+        spotMarket.marketIndex !== numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
+        const userCustomAssetWeight = tokenValue.gte(numericConstants_1.ZERO)
+            ? anchor_1.BN.max(numericConstants_1.ZERO, numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION.subn(customMarginRatio))
+            : numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION.addn(customMarginRatio);
+        weight = tokenValue.gte(numericConstants_1.ZERO)
+            ? anchor_1.BN.min(weight, userCustomAssetWeight)
+            : anchor_1.BN.max(weight, userCustomAssetWeight);
+    }
     return {
         weight: weight,
         weightedTokenValue: tokenValue
@@ -47,13 +58,13 @@ function calculateWeightedTokenValue(tokenAmount, tokenValue, oraclePrice, spotM
     };
 }
 exports.calculateWeightedTokenValue = calculateWeightedTokenValue;
-function simulateOrderFill(tokenAmount, tokenValue, openOrders, strictOraclePrice, spotMarket, marginCategory) {
+function simulateOrderFill(tokenAmount, tokenValue, openOrders, strictOraclePrice, spotMarket, marginCategory, customMarginRatio) {
     const ordersValue = (0, spotBalance_1.getTokenValue)(openOrders.neg(), spotMarket.decimals, {
         price: strictOraclePrice.max(),
     });
     const tokenAmountAfterFill = tokenAmount.add(openOrders);
     const tokenValueAfterFill = tokenValue.add(ordersValue.neg());
-    const { weight, weightedTokenValue: weightedTokenValueAfterFill } = calculateWeightedTokenValue(tokenAmountAfterFill, tokenValueAfterFill, strictOraclePrice.current, spotMarket, marginCategory);
+    const { weight, weightedTokenValue: weightedTokenValueAfterFill } = calculateWeightedTokenValue(tokenAmountAfterFill, tokenValueAfterFill, strictOraclePrice.current, spotMarket, marginCategory, customMarginRatio);
     const freeCollateralContribution = weightedTokenValueAfterFill.add(ordersValue);
     return {
         tokenAmount: tokenAmountAfterFill,

package/lib/math/superStake.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { AddressLookupTableAccount, PublicKey, TransactionInstruction } from '@solana/web3.js';
 import { JupiterClient } from '../jupiter/jupiterClient';
 import { DriftClient } from '../driftClient';

package/lib/math/trade.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { PerpMarketAccount, PositionDirection, SpotMarketAccount } from '../types';
 import { BN } from '@coral-xyz/anchor';
 import { AssetType } from './amm';

package/lib/math/utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '../';
 export declare function clampBN(x: BN, min: BN, max: BN): BN;
 export declare const squareRootBN: (n: BN) => BN;

package/lib/oracles/pythClient.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 /// <reference types="node" />
 import { Connection, PublicKey } from '@solana/web3.js';
 import { OracleClient, OraclePriceData } from './types';
@@ -6,7 +7,7 @@ export declare class PythClient implements OracleClient {
     private connection;
     private multiple;
     private stableCoin;
-    constructor(connection: Connection, multiple?: any, stableCoin?: boolean);
+    constructor(connection: Connection, multiple?: BN, stableCoin?: boolean);
     getOraclePriceData(pricePublicKey: PublicKey): Promise<OraclePriceData>;
     getOraclePriceDataFromBuffer(buffer: Buffer): OraclePriceData;
 }

package/lib/oracles/strictOraclePrice.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { BN } from '@coral-xyz/anchor';
 export declare class StrictOraclePrice {
     current: BN;

package/lib/oracles/types.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 /// <reference types="node" />
 import { BN } from '@coral-xyz/anchor';
 import { PublicKey } from '@solana/web3.js';

package/lib/orderParams.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { OptionalOrderParams, OrderParams, OrderTriggerCondition } from './types';
 import { BN } from '@coral-xyz/anchor';
 export declare function getLimitOrderParams(params: Omit<OptionalOrderParams, 'orderType'> & {

package/lib/phoenix/phoenixSubscriber.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { Connection, PublicKey } from '@solana/web3.js';
 import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
 import { Client, Market } from '@ellipsis-labs/phoenix-sdk';

package/lib/serum/serumSubscriber.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { Connection, PublicKey } from '@solana/web3.js';
 import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
 import { Market, Orderbook } from '@project-serum/serum';

package/lib/tokenFaucet.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import * as anchor from '@coral-xyz/anchor';
 import { AnchorProvider, Program } from '@coral-xyz/anchor';
 import { Account } from '@solana/spl-token';

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="bn.js" />
 import { PublicKey, Transaction, VersionedTransaction } from '@solana/web3.js';
 import { BN } from '.';
 export declare enum ExchangeStatus {
@@ -316,6 +317,12 @@ export declare class StakeAction {
     static readonly UNSTAKE: {
         unstake: {};
     };
+    static readonly UNSTAKE_TRANSFER: {
+        unstakeTransfer: {};
+    };
+    static readonly STAKE_TRANSFER: {
+        stakeTransfer: {};
+    };
 }
 export declare function isVariant(object: unknown, type: string): boolean;
 export declare function isOneOfVariant(object: unknown, types: string[]): boolean;

package/lib/types.js

@@ -201,6 +201,8 @@ StakeAction.STAKE = { stake: {} };
 StakeAction.UNSTAKE_REQUEST = { unstakeRequest: {} };
 StakeAction.UNSTAKE_CANCEL_REQUEST = { unstakeCancelRequest: {} };
 StakeAction.UNSTAKE = { unstake: {} };
+StakeAction.UNSTAKE_TRANSFER = { unstakeTransfer: {} };
+StakeAction.STAKE_TRANSFER = { stakeTransfer: {} };
 function isVariant(object, type) {
     return object.hasOwnProperty(type);
 }

package/lib/user.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="bn.js" />
 import { PublicKey } from '@solana/web3.js';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
@@ -99,7 +100,7 @@ export declare class User {
      * calculates Buying Power = free collateral / initial margin ratio
      * @returns : Precision QUOTE_PRECISION
      */
-    getPerpBuyingPower(marketIndex: number, collateralBuffer?: any): BN;
+    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN): BN;
     getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN): BN;
     /**
      * calculates Free Collateral = Total collateral - margin requirement
@@ -187,7 +188,7 @@ export declare class User {
         spotAssetValue: BN;
         spotLiabilityValue: BN;
     }): BN;
-    getLeverageComponents(includeOpenOrders?: boolean): {
+    getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory): {
         perpLiabilityValue: BN;
         perpPnl: BN;
         spotAssetValue: BN;

package/lib/user.js

@@ -411,7 +411,7 @@ class User {
         return this.getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex, freeCollateral, worstCaseBaseAssetAmount);
     }
     getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex, freeCollateral, baseAssetAmount) {
-        const marginRatio = (0, _1.calculateMarketMarginRatio)(this.driftClient.getPerpMarketAccount(marketIndex), baseAssetAmount, 'Initial');
+        const marginRatio = (0, _1.calculateMarketMarginRatio)(this.driftClient.getPerpMarketAccount(marketIndex), baseAssetAmount, 'Initial', this.getUserAccount().maxMarginRatio);
         return freeCollateral.mul(numericConstants_1.MARGIN_PRECISION).div(new _1.BN(marginRatio));
     }
     /**
@@ -577,7 +577,7 @@ class User {
                     continue;
                 }
             }
-            const { tokenAmount: worstCaseTokenAmount, ordersValue: worstCaseQuoteTokenAmount, } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory !== null && marginCategory !== void 0 ? marginCategory : 'Initial');
+            const { tokenAmount: worstCaseTokenAmount, ordersValue: worstCaseQuoteTokenAmount, } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory, this.getUserAccount().maxMarginRatio);
             if (worstCaseTokenAmount.gt(numericConstants_1.ZERO) && countForBase) {
                 const baseAssetValue = this.getSpotAssetValue(worstCaseTokenAmount, strictOraclePrice, spotMarketAccount, marginCategory);
                 totalAssetValue = totalAssetValue.add(baseAssetValue);
@@ -620,8 +620,9 @@ class User {
         let liabilityValue = (0, _1.getStrictTokenValue)(tokenAmount, spotMarketAccount.decimals, strictOraclePrice);
         if (marginCategory !== undefined) {
             let weight = (0, spotBalance_1.calculateLiabilityWeight)(tokenAmount, spotMarketAccount, marginCategory);
-            if (marginCategory === 'Initial') {
-                weight = _1.BN.max(weight, new _1.BN(this.getUserAccount().maxMarginRatio));
+            if (marginCategory === 'Initial' &&
+                spotMarketAccount.marketIndex !== numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
+                weight = _1.BN.max(weight, numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION.addn(this.getUserAccount().maxMarginRatio));
             }
             if (liquidationBuffer !== undefined) {
                 weight = weight.add(liquidationBuffer);
@@ -639,7 +640,12 @@ class User {
     getSpotAssetValue(tokenAmount, strictOraclePrice, spotMarketAccount, marginCategory) {
         let assetValue = (0, _1.getStrictTokenValue)(tokenAmount, spotMarketAccount.decimals, strictOraclePrice);
         if (marginCategory !== undefined) {
-            const weight = (0, spotBalance_1.calculateAssetWeight)(tokenAmount, strictOraclePrice.current, spotMarketAccount, marginCategory);
+            let weight = (0, spotBalance_1.calculateAssetWeight)(tokenAmount, strictOraclePrice.current, spotMarketAccount, marginCategory);
+            if (marginCategory === 'Initial' &&
+                spotMarketAccount.marketIndex !== numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
+                const userCustomAssetWeight = _1.BN.max(numericConstants_1.ZERO, numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION.subn(this.getUserAccount().maxMarginRatio));
+                weight = _1.BN.min(weight, userCustomAssetWeight);
+            }
             assetValue = assetValue.mul(weight).div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION);
         }
         return assetValue;
@@ -702,10 +708,7 @@ class User {
             .mul(valuationPrice)
             .div(numericConstants_1.BASE_PRECISION);
         if (marginCategory) {
-            let marginRatio = new _1.BN((0, _1.calculateMarketMarginRatio)(market, baseAssetAmount.abs(), marginCategory));
-            if (marginCategory === 'Initial') {
-                marginRatio = _1.BN.max(marginRatio, new _1.BN(this.getUserAccount().maxMarginRatio));
-            }
+            let marginRatio = new _1.BN((0, _1.calculateMarketMarginRatio)(market, baseAssetAmount.abs(), marginCategory, this.getUserAccount().maxMarginRatio));
             if (liquidationBuffer !== undefined) {
                 marginRatio = marginRatio.add(liquidationBuffer);
             }
@@ -834,10 +837,10 @@ class User {
         }
         return totalLiabilityValue.mul(numericConstants_1.TEN_THOUSAND).div(netAssetValue);
     }
-    getLeverageComponents(includeOpenOrders = true) {
-        const perpLiability = this.getTotalPerpPositionValue(undefined, undefined, includeOpenOrders);
-        const perpPnl = this.getUnrealizedPNL(true);
-        const { totalAssetValue: spotAssetValue, totalLiabilityValue: spotLiabilityValue, } = this.getSpotMarketAssetAndLiabilityValue(undefined, undefined, undefined, includeOpenOrders);
+    getLeverageComponents(includeOpenOrders = true, marginCategory = undefined) {
+        const perpLiability = this.getTotalPerpPositionValue(marginCategory, undefined, includeOpenOrders);
+        const perpPnl = this.getUnrealizedPNL(true, undefined, marginCategory);
+        const { totalAssetValue: spotAssetValue, totalLiabilityValue: spotLiabilityValue, } = this.getSpotMarketAssetAndLiabilityValue(undefined, marginCategory, undefined, includeOpenOrders);
         return {
             perpLiabilityValue: perpLiability,
             perpPnl,
@@ -889,7 +892,7 @@ class User {
         let rawMarginRatio;
         switch (marginCategory) {
             case 'Initial':
-                rawMarginRatio = market.marginRatioInitial;
+                rawMarginRatio = Math.max(market.marginRatioInitial, this.getUserAccount().maxMarginRatio);
                 break;
             case 'Maintenance':
                 rawMarginRatio = market.marginRatioMaintenance;
@@ -905,7 +908,7 @@ class User {
             .mul(numericConstants_1.PRICE_PRECISION)
             .div(marketPrice));
         // margin ratio incorporting upper bound on size
-        let marginRatio = (0, _1.calculateMarketMarginRatio)(market, maxSize, marginCategory);
+        let marginRatio = (0, _1.calculateMarketMarginRatio)(market, maxSize, marginCategory, this.getUserAccount().maxMarginRatio);
         // use more fesible size since imf factor activated
         let attempts = 0;
         while (marginRatio > rawMarginRatio + 1e-4 && attempts < 10) {
@@ -916,7 +919,7 @@ class User {
                 .mul(numericConstants_1.PRICE_PRECISION)
                 .div(marketPrice));
             // margin ratio incorporting more fesible target size
-            marginRatio = (0, _1.calculateMarketMarginRatio)(market, targetSize, marginCategory);
+            marginRatio = (0, _1.calculateMarketMarginRatio)(market, targetSize, marginCategory, this.getUserAccount().maxMarginRatio);
             attempts += 1;
         }
         // how much more liabilities can be opened w remaining free collateral
@@ -1277,19 +1280,19 @@ class User {
         let freeCollateral = this.getFreeCollateral();
         const marginRatio = (0, _1.calculateSpotMarketMarginRatio)(market, oraclePrice, 'Initial', numericConstants_1.ZERO, (0, types_1.isVariant)(direction, 'long')
             ? _1.SpotBalanceType.DEPOSIT
-            : _1.SpotBalanceType.BORROW);
+            : _1.SpotBalanceType.BORROW, this.getUserAccount().maxMarginRatio);
         let tradeAmount = numericConstants_1.ZERO;
         if (this.getUserAccount().isMarginTradingEnabled) {
             // if the user is buying/selling and already short/long, need to account for closing out short/long
             if ((0, types_1.isVariant)(direction, 'long') && currentSpotMarketNetValue.lt(numericConstants_1.ZERO)) {
                 tradeAmount = currentSpotMarketNetValue.abs();
-                const marginRatio = (0, _1.calculateSpotMarketMarginRatio)(market, oraclePrice, 'Initial', this.getTokenAmount(targetMarketIndex).abs(), _1.SpotBalanceType.BORROW);
+                const marginRatio = (0, _1.calculateSpotMarketMarginRatio)(market, oraclePrice, 'Initial', this.getTokenAmount(targetMarketIndex).abs(), _1.SpotBalanceType.BORROW, this.getUserAccount().maxMarginRatio);
                 freeCollateral = freeCollateral.add(tradeAmount.mul(new _1.BN(marginRatio)).div(numericConstants_1.MARGIN_PRECISION));
             }
             else if ((0, types_1.isVariant)(direction, 'short') &&
                 currentSpotMarketNetValue.gt(numericConstants_1.ZERO)) {
                 tradeAmount = currentSpotMarketNetValue;
-                const marginRatio = (0, _1.calculateSpotMarketMarginRatio)(market, oraclePrice, 'Initial', this.getTokenAmount(targetMarketIndex), _1.SpotBalanceType.DEPOSIT);
+                const marginRatio = (0, _1.calculateSpotMarketMarginRatio)(market, oraclePrice, 'Initial', this.getTokenAmount(targetMarketIndex), _1.SpotBalanceType.DEPOSIT, this.getUserAccount().maxMarginRatio);
                 freeCollateral = freeCollateral.add(tradeAmount.mul(new _1.BN(marginRatio)).div(numericConstants_1.MARGIN_PRECISION));
             }
             tradeAmount = tradeAmount.add(freeCollateral.mul(numericConstants_1.MARGIN_PRECISION).div(new _1.BN(marginRatio)));
@@ -1332,7 +1335,7 @@ class User {
         const outContributionInitial = this.calculateSpotPositionFreeCollateralContribution(outSpotPosition, outStrictOraclePrice);
         const { totalAssetValue: outTotalAssetValueInitial, totalLiabilityValue: outTotalLiabilityValueInitial, } = this.calculateSpotPositionLeverageContribution(outSpotPosition, outStrictOraclePrice);
         const initialContribution = inContributionInitial.add(outContributionInitial);
-        const { perpLiabilityValue, perpPnl, spotAssetValue, spotLiabilityValue } = this.getLeverageComponents();
+        const { perpLiabilityValue, perpPnl, spotAssetValue, spotLiabilityValue } = this.getLeverageComponents(undefined, 'Initial');
         if (!calculateSwap) {
             calculateSwap = (inSwap) => {
                 return inSwap
@@ -1440,14 +1443,14 @@ class User {
     calculateSpotPositionFreeCollateralContribution(spotPosition, strictOraclePrice) {
         const marginCategory = 'Initial';
         const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
-        const { freeCollateralContribution } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory);
+        const { freeCollateralContribution } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory, this.getUserAccount().maxMarginRatio);
         return freeCollateralContribution;
     }
     calculateSpotPositionLeverageContribution(spotPosition, strictOraclePrice) {
         let totalAssetValue = numericConstants_1.ZERO;
         let totalLiabilityValue = numericConstants_1.ZERO;
         const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
-        const { tokenValue, ordersValue } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, 'Initial');
+        const { tokenValue, ordersValue } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, 'Initial', this.getUserAccount().maxMarginRatio);
         if (tokenValue.gte(numericConstants_1.ZERO)) {
             totalAssetValue = tokenValue;
         }
@@ -1487,7 +1490,7 @@ class User {
             this.getEmptySpotPosition(outMarketIndex);
         const { totalAssetValue: inTotalAssetValueInitial, totalLiabilityValue: inTotalLiabilityValueInitial, } = this.calculateSpotPositionLeverageContribution(inSpotPosition, inStrictOraclePrice);
         const { totalAssetValue: outTotalAssetValueInitial, totalLiabilityValue: outTotalLiabilityValueInitial, } = this.calculateSpotPositionLeverageContribution(outSpotPosition, outStrictOraclePrice);
-        const { perpLiabilityValue, perpPnl, spotAssetValue, spotLiabilityValue } = this.getLeverageComponents();
+        const { perpLiabilityValue, perpPnl, spotAssetValue, spotLiabilityValue } = this.getLeverageComponents(undefined, 'Initial');
         const inPositionAfter = this.cloneAndUpdateSpotPosition(inSpotPosition, inAmount.abs().neg(), inMarket);
         const outPositionAfter = this.cloneAndUpdateSpotPosition(outSpotPosition, outAmount.abs(), outMarket);
         const { totalAssetValue: inTotalAssetValueAfter, totalLiabilityValue: inTotalLiabilityValueAfter, } = this.calculateSpotPositionLeverageContribution(inPositionAfter, inStrictOraclePrice);
@@ -1801,7 +1804,7 @@ class User {
             const oraclePriceData = this.driftClient.getOraclePriceDataAndSlot(perpMarket.amm.oracle).data;
             const oraclePrice = oraclePriceData.price;
             const worstCaseBaseAmount = (0, margin_1.calculateWorstCaseBaseAssetAmount)(perpPosition);
-            const marginRatio = new _1.BN((0, _1.calculateMarketMarginRatio)(perpMarket, worstCaseBaseAmount.abs(), marginCategory));
+            const marginRatio = new _1.BN((0, _1.calculateMarketMarginRatio)(perpMarket, worstCaseBaseAmount.abs(), marginCategory, this.getUserAccount().maxMarginRatio));
             const quoteSpotMarket = this.driftClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.driftClient.getOraclePriceDataAndSlot(quoteSpotMarket.oracle).data;
             const baseAssetValue = worstCaseBaseAmount
@@ -1861,7 +1864,7 @@ class User {
                 netQuoteValue = netQuoteValue.add(tokenAmount);
                 continue;
             }
-            const { tokenAmount: worstCaseTokenAmount, tokenValue: tokenValue, weight, weightedTokenValue: weightedTokenValue, ordersValue: ordersValue, } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory);
+            const { tokenAmount: worstCaseTokenAmount, tokenValue: tokenValue, weight, weightedTokenValue: weightedTokenValue, ordersValue: ordersValue, } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, marginCategory, this.getUserAccount().maxMarginRatio);
             netQuoteValue = netQuoteValue.add(ordersValue);
             const baseAssetValue = tokenValue.abs();
             const weightedValue = weightedTokenValue.abs();
@@ -1888,7 +1891,7 @@ class User {
             const spotMarketAccount = this.driftClient.getQuoteSpotMarketAccount();
             const oraclePriceData = this.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
             const baseAssetValue = (0, _1.getTokenValue)(netQuoteValue, spotMarketAccount.decimals, oraclePriceData);
-            const { weight, weightedTokenValue } = (0, spotPosition_1.calculateWeightedTokenValue)(netQuoteValue, baseAssetValue, oraclePriceData.price, spotMarketAccount, marginCategory);
+            const { weight, weightedTokenValue } = (0, spotPosition_1.calculateWeightedTokenValue)(netQuoteValue, baseAssetValue, oraclePriceData.price, spotMarketAccount, marginCategory, this.getUserAccount().maxMarginRatio);
             if (netQuoteValue.lt(numericConstants_1.ZERO)) {
                 healthComponents.borrows.push({
                     marketIndex: spotMarketAccount.marketIndex,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.42.0-beta.1",
+	"version": "2.42.0-beta.11",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",
@@ -45,6 +45,7 @@
 	},
 	"devDependencies": {
 		"@types/big.js": "^6.2.0",
+		"@types/bn.js": "^5.1.3",
 		"@types/chai": "^4.3.1",
 		"@types/jest": "^28.1.3",
 		"@types/mocha": "^9.1.1",

package/src/constants/numericConstants.ts

@@ -83,6 +83,7 @@ export const AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO =
 export const MARGIN_PRECISION = TEN_THOUSAND;
 export const BID_ASK_SPREAD_PRECISION = new BN(1000000); // 10^6
 export const LIQUIDATION_PCT_PRECISION = TEN_THOUSAND;
+export const FUNDING_RATE_OFFSET_DENOMINATOR = new BN(5000);
 
 export const FIVE_MINUTE = new BN(60 * 5);
 export const ONE_HOUR = new BN(60 * 60);