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

package/lib/clearingHouseUser.js

@@ -5,10 +5,11 @@ const types_1 = require("./types");
 const position_1 = require("./math/position");
 const numericConstants_1 = require("./constants/numericConstants");
 const _1 = require(".");
-const bankBalance_1 = require("./math/bankBalance");
+const spotBalance_1 = require("./math/spotBalance");
 const margin_1 = require("./math/margin");
 const pollingUserAccountSubscriber_1 = require("./accounts/pollingUserAccountSubscriber");
 const webSocketUserAccountSubscriber_1 = require("./accounts/webSocketUserAccountSubscriber");
+const spotPosition_1 = require("./math/spotPosition");
 class ClearingHouseUser {
     constructor(config) {
         var _a;
@@ -59,11 +60,12 @@ class ClearingHouseUser {
      * @returns userPosition
      */
     getUserPosition(marketIndex) {
-        return this.getUserAccount().positions.find((position) => position.marketIndex.eq(marketIndex));
+        return this.getUserAccount().perpPositions.find((position) => position.marketIndex.eq(marketIndex));
     }
     getEmptyPosition(marketIndex) {
         return {
             baseAssetAmount: numericConstants_1.ZERO,
+            remainderBaseAssetAmount: numericConstants_1.ZERO,
             lastCumulativeFundingRate: numericConstants_1.ZERO,
             marketIndex,
             quoteAssetAmount: numericConstants_1.ZERO,
@@ -112,7 +114,7 @@ class ClearingHouseUser {
     getSettledLPPosition(marketIndex) {
         const _position = this.getUserPosition(marketIndex);
         const position = this.getClonedPosition(_position);
-        const market = this.clearingHouse.getMarketAccount(position.marketIndex);
+        const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
         const nShares = position.lpShares;
         const deltaBaa = market.amm.marketPositionPerLp.baseAssetAmount
             .sub(position.lastNetBaseAssetAmountPerLp)
@@ -126,22 +128,22 @@ class ClearingHouseUser {
             const sign = { true: new _1.BN(1), false: new _1.BN(-1) }[v.gte(numericConstants_1.ZERO).toString()];
             return sign;
         }
-        const remainder = deltaBaa
-            .abs()
-            .mod(market.amm.baseAssetAmountStepSize)
-            .mul(sign(deltaBaa));
-        const _standardizedBaa = deltaBaa.sub(remainder);
-        let remainderBaa;
-        if (_standardizedBaa.abs().gte(market.amm.baseAssetAmountStepSize)) {
-            remainderBaa = remainder;
+        function standardize(amount, stepsize) {
+            const remainder = amount.abs().mod(stepsize).mul(sign(amount));
+            const standardizedAmount = amount.sub(remainder);
+            return [standardizedAmount, remainder];
         }
-        else {
-            remainderBaa = deltaBaa;
+        const [standardizedBaa, remainderBaa] = standardize(deltaBaa, market.amm.baseAssetAmountStepSize);
+        position.remainderBaseAssetAmount =
+            position.remainderBaseAssetAmount.add(remainderBaa);
+        if (position.remainderBaseAssetAmount
+            .abs()
+            .gte(market.amm.baseAssetAmountStepSize)) {
+            const [newStandardizedBaa, newRemainderBaa] = standardize(position.remainderBaseAssetAmount, market.amm.baseAssetAmountStepSize);
+            position.baseAssetAmount =
+                position.baseAssetAmount.add(newStandardizedBaa);
+            position.remainderBaseAssetAmount = newRemainderBaa;
         }
-        const standardizedBaa = deltaBaa.sub(remainderBaa);
-        const reaminderPerLP = remainderBaa.mul(numericConstants_1.AMM_RESERVE_PRECISION).div(nShares);
-        position.lastNetBaseAssetAmountPerLp =
-            market.amm.marketPositionPerLp.baseAssetAmount.sub(reaminderPerLP);
         let updateType;
         if (position.baseAssetAmount.eq(numericConstants_1.ZERO)) {
             updateType = 'open';
@@ -211,54 +213,8 @@ class ClearingHouseUser {
     /**
      * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
      */
-    getMarginRequirement(type) {
-        return this.getUserAccount()
-            .positions.reduce((marginRequirement, marketPosition) => {
-            const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            if (marketPosition.lpShares.gt(numericConstants_1.ZERO)) {
-                // is an lp
-                // clone so we dont mutate the position
-                marketPosition = this.getClonedPosition(marketPosition);
-                // settle position
-                const [settledPosition, dustBaa, _] = this.getSettledLPPosition(market.marketIndex);
-                marketPosition.baseAssetAmount =
-                    settledPosition.baseAssetAmount.add(dustBaa);
-                marketPosition.quoteAssetAmount = settledPosition.quoteAssetAmount;
-                // open orders
-                let openAsks;
-                if (market.amm.maxBaseAssetReserve > market.amm.baseAssetReserve) {
-                    openAsks = market.amm.maxBaseAssetReserve
-                        .sub(market.amm.baseAssetReserve)
-                        .mul(marketPosition.lpShares)
-                        .div(market.amm.sqrtK)
-                        .mul(new _1.BN(-1));
-                }
-                else {
-                    openAsks = numericConstants_1.ZERO;
-                }
-                let openBids;
-                if (market.amm.minBaseAssetReserve < market.amm.baseAssetReserve) {
-                    openBids = market.amm.baseAssetReserve
-                        .sub(market.amm.minBaseAssetReserve)
-                        .mul(marketPosition.lpShares)
-                        .div(market.amm.sqrtK);
-                }
-                else {
-                    openBids = numericConstants_1.ZERO;
-                }
-                marketPosition.openAsks = marketPosition.openAsks.add(openAsks);
-                marketPosition.openBids = marketPosition.openBids.add(openBids);
-            }
-            const worstCaseBaseAssetAmount = (0, margin_1.calculateWorstCaseBaseAssetAmount)(marketPosition);
-            const worstCaseAssetValue = worstCaseBaseAssetAmount
-                .abs()
-                .mul(this.getOracleDataForMarket(market.marketIndex).price)
-                .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO.mul(numericConstants_1.MARK_PRICE_PRECISION));
-            return marginRequirement.add(worstCaseAssetValue
-                .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, worstCaseBaseAssetAmount.abs(), type)))
-                .div(numericConstants_1.MARGIN_PRECISION));
-        }, numericConstants_1.ZERO)
-            .add(this.getBankLiabilityValue(undefined, type));
+    getMarginRequirement(marginCategory, liquidationBuffer) {
+        return this.getTotalPerpPositionValue(marginCategory, liquidationBuffer, true).add(this.getSpotMarketLiabilityValue(undefined, marginCategory, liquidationBuffer, true));
     }
     /**
      * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
@@ -269,24 +225,26 @@ class ClearingHouseUser {
     /**
      * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION
      */
-    getMaintenanceMarginRequirement() {
-        return this.getMarginRequirement('Maintenance');
+    getMaintenanceMarginRequirement(liquidationBuffer) {
+        return this.getMarginRequirement('Maintenance', liquidationBuffer);
     }
     /**
      * calculates unrealized position price pnl
      * @returns : Precision QUOTE_PRECISION
      */
     getUnrealizedPNL(withFunding, marketIndex, withWeightMarginCategory) {
+        const quoteSpotMarket = this.clearingHouse.getQuoteSpotMarketAccount();
         return this.getUserAccount()
-            .positions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
-            .reduce((unrealizedPnl, marketPosition) => {
-            const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            let positionUnrealizedPnl = (0, _1.calculatePositionPNL)(market, marketPosition, withFunding, this.getOracleDataForMarket(market.marketIndex));
+            .perpPositions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
+            .reduce((unrealizedPnl, perpPosition) => {
+            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            const oraclePriceData = this.getOracleDataForMarket(market.marketIndex);
+            let positionUnrealizedPnl = (0, _1.calculatePositionPNL)(market, perpPosition, withFunding, oraclePriceData);
             if (withWeightMarginCategory !== undefined) {
                 if (positionUnrealizedPnl.gt(numericConstants_1.ZERO)) {
                     positionUnrealizedPnl = positionUnrealizedPnl
-                        .mul((0, _1.calculateUnrealizedAssetWeight)(market, positionUnrealizedPnl, withWeightMarginCategory))
-                        .div(new _1.BN(numericConstants_1.BANK_WEIGHT_PRECISION));
+                        .mul((0, _1.calculateUnrealizedAssetWeight)(market, quoteSpotMarket, positionUnrealizedPnl, withWeightMarginCategory, oraclePriceData))
+                        .div(new _1.BN(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION));
                 }
             }
             return unrealizedPnl.add(positionUnrealizedPnl);
@@ -298,84 +256,217 @@ class ClearingHouseUser {
      */
     getUnrealizedFundingPNL(marketIndex) {
         return this.getUserAccount()
-            .positions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
-            .reduce((pnl, marketPosition) => {
-            const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            return pnl.add((0, _1.calculatePositionFundingPNL)(market, marketPosition));
+            .perpPositions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
+            .reduce((pnl, perpPosition) => {
+            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            return pnl.add((0, _1.calculatePositionFundingPNL)(market, perpPosition));
         }, numericConstants_1.ZERO);
     }
-    getBankLiabilityValue(bankIndex, withWeightMarginCategory) {
-        return this.getUserAccount().bankBalances.reduce((totalLiabilityValue, bankBalance) => {
-            if (bankBalance.balance.eq(numericConstants_1.ZERO) ||
-                (0, types_1.isVariant)(bankBalance.balanceType, 'deposit') ||
-                (bankIndex !== undefined && !bankBalance.bankIndex.eq(bankIndex))) {
+    getSpotMarketLiabilityValue(marketIndex, marginCategory, liquidationBuffer, includeOpenOrders) {
+        return this.getUserAccount().spotPositions.reduce((totalLiabilityValue, spotPosition) => {
+            if ((0, spotPosition_1.isSpotPositionAvailable)(spotPosition) ||
+                (marketIndex !== undefined &&
+                    !spotPosition.marketIndex.eq(marketIndex))) {
                 return totalLiabilityValue;
             }
-            // Todo this needs to account for whether it's based on initial or maintenance requirements
-            const bankAccount = this.clearingHouse.getBankAccount(bankBalance.bankIndex);
-            const tokenAmount = (0, bankBalance_1.getTokenAmount)(bankBalance.balance, bankAccount, bankBalance.balanceType);
-            let liabilityValue = tokenAmount
-                .mul(this.getOracleDataForBank(bankAccount.bankIndex).price)
-                .div(numericConstants_1.MARK_PRICE_PRECISION)
-                .div(new _1.BN(10).pow(new _1.BN(bankAccount.decimals).sub(numericConstants_1.BANK_BALANCE_PRECISION_EXP)));
-            if (withWeightMarginCategory !== undefined) {
-                const weight = (0, bankBalance_1.calculateLiabilityWeight)(tokenAmount, bankAccount, withWeightMarginCategory);
-                liabilityValue = liabilityValue
+            const spotMarketAccount = this.clearingHouse.getSpotMarketAccount(spotPosition.marketIndex);
+            if (spotPosition.marketIndex.eq(numericConstants_1.QUOTE_SPOT_MARKET_INDEX)) {
+                if ((0, types_1.isVariant)(spotPosition.balanceType, 'borrow')) {
+                    const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.balance, spotMarketAccount, spotPosition.balanceType);
+                    let weight = numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION;
+                    if (marginCategory === 'Initial') {
+                        weight = _1.BN.max(weight, new _1.BN(this.getUserAccount().customMarginRatio));
+                    }
+                    const weightedTokenValue = tokenAmount
+                        .mul(weight)
+                        .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION);
+                    return totalLiabilityValue.add(weightedTokenValue);
+                }
+                else {
+                    return totalLiabilityValue;
+                }
+            }
+            const oraclePriceData = this.getOracleDataForSpotMarket(spotPosition.marketIndex);
+            if (!includeOpenOrders) {
+                if ((0, types_1.isVariant)(spotPosition.balanceType, 'borrow')) {
+                    const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.balance, spotMarketAccount, spotPosition.balanceType);
+                    const liabilityValue = this.getSpotLiabilityValue(tokenAmount, oraclePriceData, spotMarketAccount, marginCategory, liquidationBuffer);
+                    return totalLiabilityValue.add(liabilityValue);
+                }
+                else {
+                    return totalLiabilityValue;
+                }
+            }
+            const [worstCaseTokenAmount, worstCaseQuoteTokenAmount] = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, this.getOracleDataForSpotMarket(spotPosition.marketIndex));
+            let newTotalLiabilityValue = totalLiabilityValue;
+            if (worstCaseTokenAmount.lt(numericConstants_1.ZERO)) {
+                const baseLiabilityValue = this.getSpotLiabilityValue(worstCaseTokenAmount, oraclePriceData, spotMarketAccount, marginCategory, liquidationBuffer);
+                newTotalLiabilityValue =
+                    newTotalLiabilityValue.add(baseLiabilityValue);
+            }
+            if (worstCaseQuoteTokenAmount.lt(numericConstants_1.ZERO)) {
+                let weight = numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION;
+                if (marginCategory === 'Initial') {
+                    weight = _1.BN.max(weight, new _1.BN(this.getUserAccount().customMarginRatio));
+                }
+                const weightedTokenValue = worstCaseQuoteTokenAmount
                     .mul(weight)
-                    .div(numericConstants_1.BANK_WEIGHT_PRECISION);
+                    .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION);
+                newTotalLiabilityValue =
+                    newTotalLiabilityValue.add(weightedTokenValue);
             }
-            return totalLiabilityValue.add(liabilityValue);
+            return newTotalLiabilityValue;
         }, numericConstants_1.ZERO);
     }
-    getBankAssetValue(bankIndex, withWeightMarginCategory) {
-        return this.getUserAccount().bankBalances.reduce((totalAssetValue, bankBalance) => {
-            if (bankBalance.balance.eq(numericConstants_1.ZERO) ||
-                (0, types_1.isVariant)(bankBalance.balanceType, 'borrow') ||
-                (bankIndex !== undefined && !bankBalance.bankIndex.eq(bankIndex))) {
+    getSpotLiabilityValue(tokenAmount, oraclePriceData, spotMarketAccount, marginCategory, liquidationBuffer) {
+        let liabilityValue = (0, _1.getTokenValue)(tokenAmount, spotMarketAccount.decimals, oraclePriceData);
+        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().customMarginRatio));
+            }
+            if (liquidationBuffer !== undefined) {
+                weight = weight.add(liquidationBuffer);
+            }
+            liabilityValue = liabilityValue
+                .mul(weight)
+                .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION);
+        }
+        return liabilityValue;
+    }
+    getSpotMarketAssetValue(marketIndex, marginCategory, includeOpenOrders) {
+        return this.getUserAccount().spotPositions.reduce((totalAssetValue, spotPosition) => {
+            if ((0, spotPosition_1.isSpotPositionAvailable)(spotPosition) ||
+                (marketIndex !== undefined &&
+                    !spotPosition.marketIndex.eq(marketIndex))) {
                 return totalAssetValue;
             }
             // Todo this needs to account for whether it's based on initial or maintenance requirements
-            const bankAccount = this.clearingHouse.getBankAccount(bankBalance.bankIndex);
-            const tokenAmount = (0, bankBalance_1.getTokenAmount)(bankBalance.balance, bankAccount, bankBalance.balanceType);
-            let assetValue = tokenAmount
-                .mul(this.getOracleDataForBank(bankAccount.bankIndex).price)
-                .div(numericConstants_1.MARK_PRICE_PRECISION)
-                .div(new _1.BN(10).pow(new _1.BN(bankAccount.decimals).sub(numericConstants_1.BANK_BALANCE_PRECISION_EXP)));
-            if (withWeightMarginCategory !== undefined) {
-                const weight = (0, bankBalance_1.calculateAssetWeight)(tokenAmount, bankAccount, withWeightMarginCategory);
-                assetValue = assetValue.mul(weight).div(numericConstants_1.BANK_WEIGHT_PRECISION);
+            const spotMarketAccount = this.clearingHouse.getSpotMarketAccount(spotPosition.marketIndex);
+            if (spotPosition.marketIndex.eq(numericConstants_1.QUOTE_SPOT_MARKET_INDEX)) {
+                if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
+                    const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.balance, spotMarketAccount, spotPosition.balanceType);
+                    return totalAssetValue.add(tokenAmount);
+                }
+                else {
+                    return totalAssetValue;
+                }
+            }
+            const oraclePriceData = this.getOracleDataForSpotMarket(spotPosition.marketIndex);
+            if (!includeOpenOrders) {
+                if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
+                    const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.balance, spotMarketAccount, spotPosition.balanceType);
+                    const assetValue = this.getSpotAssetValue(tokenAmount, oraclePriceData, spotMarketAccount, marginCategory);
+                    return totalAssetValue.add(assetValue);
+                }
+                else {
+                    return totalAssetValue;
+                }
+            }
+            const [worstCaseTokenAmount, worstCaseQuoteTokenAmount] = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, this.getOracleDataForSpotMarket(spotPosition.marketIndex));
+            let newTotalAssetValue = totalAssetValue;
+            if (worstCaseTokenAmount.gt(numericConstants_1.ZERO)) {
+                const baseAssetValue = this.getSpotAssetValue(worstCaseTokenAmount, oraclePriceData, spotMarketAccount, marginCategory);
+                newTotalAssetValue = newTotalAssetValue.add(baseAssetValue);
             }
-            return totalAssetValue.add(assetValue);
+            if (worstCaseQuoteTokenAmount.gt(numericConstants_1.ZERO)) {
+                newTotalAssetValue = newTotalAssetValue.add(worstCaseQuoteTokenAmount);
+            }
+            return newTotalAssetValue;
         }, numericConstants_1.ZERO);
     }
-    getNetBankValue(withWeightMarginCategory) {
-        return this.getBankAssetValue(undefined, withWeightMarginCategory).sub(this.getBankLiabilityValue(undefined, withWeightMarginCategory));
+    getSpotAssetValue(tokenAmount, oraclePriceData, spotMarketAccount, marginCategory) {
+        let assetValue = (0, _1.getTokenValue)(tokenAmount, spotMarketAccount.decimals, oraclePriceData);
+        if (marginCategory !== undefined) {
+            const weight = (0, spotBalance_1.calculateAssetWeight)(tokenAmount, spotMarketAccount, marginCategory);
+            assetValue = assetValue.mul(weight).div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION);
+        }
+        return assetValue;
+    }
+    getNetSpotMarketValue(withWeightMarginCategory) {
+        return this.getSpotMarketAssetValue(undefined, withWeightMarginCategory).sub(this.getSpotMarketLiabilityValue(undefined, withWeightMarginCategory));
     }
     /**
      * calculates TotalCollateral: collateral + unrealized pnl
      * @returns : Precision QUOTE_PRECISION
      */
     getTotalCollateral(marginCategory = 'Initial') {
-        return this.getBankAssetValue(undefined, marginCategory).add(this.getUnrealizedPNL(true, undefined, marginCategory));
+        return this.getSpotMarketAssetValue(undefined, marginCategory, true).add(this.getUnrealizedPNL(true, undefined, marginCategory));
     }
     /**
      * calculates sum of position value across all positions in margin system
      * @returns : Precision QUOTE_PRECISION
      */
-    getTotalPositionValue() {
-        return this.getUserAccount().positions.reduce((positionValue, marketPosition) => {
-            const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            const posVal = (0, margin_1.calculateBaseAssetValueWithOracle)(market, marketPosition, this.getOracleDataForMarket(market.marketIndex));
-            return positionValue.add(posVal);
+    getTotalPerpPositionValue(marginCategory, liquidationBuffer, includeOpenOrders) {
+        return this.getUserAccount().perpPositions.reduce((totalPerpValue, perpPosition) => {
+            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            if (perpPosition.lpShares.gt(numericConstants_1.ZERO)) {
+                // is an lp
+                // clone so we dont mutate the position
+                perpPosition = this.getClonedPosition(perpPosition);
+                // settle position
+                const [settledPosition, dustBaa, _] = this.getSettledLPPosition(market.marketIndex);
+                perpPosition.baseAssetAmount =
+                    settledPosition.baseAssetAmount.add(dustBaa);
+                perpPosition.quoteAssetAmount = settledPosition.quoteAssetAmount;
+                // open orders
+                let openAsks;
+                if (market.amm.maxBaseAssetReserve > market.amm.baseAssetReserve) {
+                    openAsks = market.amm.maxBaseAssetReserve
+                        .sub(market.amm.baseAssetReserve)
+                        .mul(perpPosition.lpShares)
+                        .div(market.amm.sqrtK)
+                        .mul(new _1.BN(-1));
+                }
+                else {
+                    openAsks = numericConstants_1.ZERO;
+                }
+                let openBids;
+                if (market.amm.minBaseAssetReserve < market.amm.baseAssetReserve) {
+                    openBids = market.amm.baseAssetReserve
+                        .sub(market.amm.minBaseAssetReserve)
+                        .mul(perpPosition.lpShares)
+                        .div(market.amm.sqrtK);
+                }
+                else {
+                    openBids = numericConstants_1.ZERO;
+                }
+                perpPosition.openAsks = perpPosition.openAsks.add(openAsks);
+                perpPosition.openBids = perpPosition.openBids.add(openBids);
+            }
+            let valuationPrice = this.getOracleDataForMarket(market.marketIndex).price;
+            if ((0, types_1.isVariant)(market.status, 'settlement')) {
+                valuationPrice = market.settlementPrice;
+            }
+            const baseAssetAmount = includeOpenOrders
+                ? (0, margin_1.calculateWorstCaseBaseAssetAmount)(perpPosition)
+                : perpPosition.baseAssetAmount;
+            let baseAssetValue = baseAssetAmount
+                .abs()
+                .mul(valuationPrice)
+                .div(numericConstants_1.AMM_TO_QUOTE_PRECISION_RATIO.mul(numericConstants_1.MARK_PRICE_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().customMarginRatio));
+                }
+                if (liquidationBuffer !== undefined) {
+                    marginRatio = marginRatio.add(liquidationBuffer);
+                }
+                baseAssetValue = baseAssetValue
+                    .mul(marginRatio)
+                    .div(numericConstants_1.MARGIN_PRECISION);
+            }
+            return totalPerpValue.add(baseAssetValue);
         }, numericConstants_1.ZERO);
     }
     /**
      * calculates position value in margin system
      * @returns : Precision QUOTE_PRECISION
      */
-    getPositionValue(marketIndex, oraclePriceData) {
+    getPerpPositionValue(marketIndex, oraclePriceData) {
         const userPosition = this.getUserPosition(marketIndex) || this.getEmptyPosition(marketIndex);
-        const market = this.clearingHouse.getMarketAccount(userPosition.marketIndex);
+        const market = this.clearingHouse.getPerpMarketAccount(userPosition.marketIndex);
         return (0, margin_1.calculateBaseAssetValueWithOracle)(market, userPosition, oraclePriceData);
     }
     getPositionSide(currentPosition) {
@@ -394,7 +485,7 @@ class ClearingHouseUser {
      * @returns : Precision MARK_PRICE_PRECISION
      */
     getPositionEstimatedExitPriceAndPnl(position, amountToClose, useAMMClose = false) {
-        const market = this.clearingHouse.getMarketAccount(position.marketIndex);
+        const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
         const entryPrice = (0, position_1.calculateEntryPrice)(position);
         const oraclePriceData = this.getOracleDataForMarket(position.marketIndex);
         if (amountToClose) {
@@ -433,13 +524,13 @@ class ClearingHouseUser {
      * calculates current user leverage across all positions
      * @returns : Precision TEN_THOUSAND
      */
-    getLeverage() {
-        const totalCollateral = this.getTotalCollateral();
-        const totalPositionValue = this.getTotalPositionValue();
-        if (totalPositionValue.eq(numericConstants_1.ZERO) && totalCollateral.eq(numericConstants_1.ZERO)) {
+    getLeverage(marginCategory) {
+        const totalLiabilityValue = this.getTotalPerpPositionValue(marginCategory, undefined, true).add(this.getSpotMarketLiabilityValue(undefined, marginCategory, undefined, true));
+        const totalAssetValue = this.getSpotMarketAssetValue(undefined, marginCategory, true).add(this.getUnrealizedPNL(true, undefined, marginCategory));
+        if (totalAssetValue.eq(numericConstants_1.ZERO) && totalLiabilityValue.eq(numericConstants_1.ZERO)) {
             return numericConstants_1.ZERO;
         }
-        return totalPositionValue.mul(numericConstants_1.TEN_THOUSAND).div(totalCollateral);
+        return totalLiabilityValue.mul(numericConstants_1.TEN_THOUSAND).div(totalAssetValue);
     }
     /**
      * calculates max allowable leverage exceeding hitting requirement category
@@ -447,7 +538,7 @@ class ClearingHouseUser {
      * @returns : Precision TEN_THOUSAND
      */
     getMaxLeverage(marketIndex, category = 'Initial') {
-        const market = this.clearingHouse.getMarketAccount(marketIndex);
+        const market = this.clearingHouse.getPerpMarketAccount(marketIndex);
         const marginRatioCategory = (0, _1.calculateMarketMarginRatio)(market, 
         // worstCaseBaseAssetAmount.abs(),
         numericConstants_1.ZERO, // todo
@@ -459,30 +550,34 @@ class ClearingHouseUser {
      * calculates margin ratio: total collateral / |total position value|
      * @returns : Precision TEN_THOUSAND
      */
-    getMarginRatio() {
-        const totalPositionValue = this.getTotalPositionValue();
-        if (totalPositionValue.eq(numericConstants_1.ZERO)) {
+    getMarginRatio(marginCategory) {
+        const totalLiabilityValue = this.getTotalPerpPositionValue(marginCategory, undefined, true).add(this.getSpotMarketLiabilityValue(undefined, marginCategory, undefined, true));
+        if (totalLiabilityValue.eq(numericConstants_1.ZERO)) {
             return numericConstants_1.BN_MAX;
         }
-        return this.getTotalCollateral().mul(numericConstants_1.TEN_THOUSAND).div(totalPositionValue);
+        const totalAssetValue = this.getSpotMarketAssetValue(undefined, marginCategory, true).add(this.getUnrealizedPNL(true, undefined, marginCategory));
+        return totalAssetValue.mul(numericConstants_1.TEN_THOUSAND).div(totalLiabilityValue);
     }
     canBeLiquidated() {
         const totalCollateral = this.getTotalCollateral();
-        const partialMaintenanceRequirement = this.getMaintenanceMarginRequirement();
-        const marginRatio = this.getMarginRatio();
-        const canLiquidate = totalCollateral.lt(partialMaintenanceRequirement);
-        return [canLiquidate, marginRatio];
+        // if user being liq'd, can continue to be liq'd until total collateral above the margin requirement plus buffer
+        let liquidationBuffer = undefined;
+        if (this.getUserAccount().beingLiquidated) {
+            liquidationBuffer = new _1.BN(this.clearingHouse.getStateAccount().liquidationMarginBufferRatio);
+        }
+        const maintenanceRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
+        return totalCollateral.lt(maintenanceRequirement);
     }
     /**
      * Checks if any user position cumulative funding differs from respective market cumulative funding
      * @returns
      */
     needsToSettleFundingPayment() {
-        for (const userPosition of this.getUserAccount().positions) {
+        for (const userPosition of this.getUserAccount().perpPositions) {
             if (userPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {
                 continue;
             }
-            const market = this.clearingHouse.getMarketAccount(userPosition.marketIndex);
+            const market = this.clearingHouse.getPerpMarketAccount(userPosition.marketIndex);
             if (market.amm.cumulativeFundingRateLong.eq(userPosition.lastCumulativeFundingRate) ||
                 market.amm.cumulativeFundingRateShort.eq(userPosition.lastCumulativeFundingRate)) {
                 continue;
@@ -493,12 +588,12 @@ class ClearingHouseUser {
     }
     /**
      * 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, positionBaseSizeChange = numericConstants_1.ZERO) {
+    liquidationPrice(perpPosition, positionBaseSizeChange = numericConstants_1.ZERO) {
         // solves formula for example canBeLiquidated below
         /* example: assume BTC price is $40k (examine 10% up/down)
 
@@ -511,15 +606,16 @@ class ClearingHouseUser {
         3. (10k - 4k) / (100k - 4k) = 6k/96k => .0625 */
         const totalCollateral = this.getTotalCollateral();
         // calculate the total position value ignoring any value from the target market of the trade
-        const totalPositionValueExcludingTargetMarket = this.getTotalPositionValueExcludingMarket(marketPosition.marketIndex);
-        const currentMarketPosition = this.getUserPosition(marketPosition.marketIndex) ||
-            this.getEmptyPosition(marketPosition.marketIndex);
-        const currentMarketPositionBaseSize = currentMarketPosition.baseAssetAmount;
-        const proposedBaseAssetAmount = currentMarketPositionBaseSize.add(positionBaseSizeChange);
+        const totalPositionValueExcludingTargetMarket = this.getTotalPerpPositionValueExcludingMarket(perpPosition.marketIndex);
+        const currentPerpPosition = this.getUserPosition(perpPosition.marketIndex) ||
+            this.getEmptyPosition(perpPosition.marketIndex);
+        const currentPerpPositionBaseSize = currentPerpPosition.baseAssetAmount;
+        const proposedBaseAssetAmount = currentPerpPositionBaseSize.add(positionBaseSizeChange);
         // calculate position for current market after trade
-        const proposedMarketPosition = {
-            marketIndex: marketPosition.marketIndex,
+        const proposedPerpPosition = {
+            marketIndex: perpPosition.marketIndex,
             baseAssetAmount: proposedBaseAssetAmount,
+            remainderBaseAssetAmount: numericConstants_1.ZERO,
             quoteAssetAmount: new _1.BN(0),
             lastCumulativeFundingRate: numericConstants_1.ZERO,
             quoteEntryAmount: new _1.BN(0),
@@ -534,13 +630,13 @@ class ClearingHouseUser {
         };
         if (proposedBaseAssetAmount.eq(numericConstants_1.ZERO))
             return new _1.BN(-1);
-        const market = this.clearingHouse.getMarketAccount(proposedMarketPosition.marketIndex);
-        const proposedMarketPositionValue = (0, margin_1.calculateBaseAssetValueWithOracle)(market, proposedMarketPosition, this.getOracleDataForMarket(market.marketIndex));
+        const market = this.clearingHouse.getPerpMarketAccount(proposedPerpPosition.marketIndex);
+        const proposedPerpPositionValue = (0, margin_1.calculateBaseAssetValueWithOracle)(market, proposedPerpPosition, this.getOracleDataForMarket(market.marketIndex));
         // total position value after trade
-        const totalPositionValueAfterTrade = totalPositionValueExcludingTargetMarket.add(proposedMarketPositionValue);
-        const marginRequirementExcludingTargetMarket = this.getUserAccount().positions.reduce((totalMarginRequirement, position) => {
-            if (!position.marketIndex.eq(marketPosition.marketIndex)) {
-                const market = this.clearingHouse.getMarketAccount(position.marketIndex);
+        const totalPositionValueAfterTrade = totalPositionValueExcludingTargetMarket.add(proposedPerpPositionValue);
+        const marginRequirementExcludingTargetMarket = this.getUserAccount().perpPositions.reduce((totalMarginRequirement, position) => {
+            if (!position.marketIndex.eq(perpPosition.marketIndex)) {
+                const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
                 const positionValue = (0, margin_1.calculateBaseAssetValueWithOracle)(market, position, this.getOracleDataForMarket(market.marketIndex));
                 const marketMarginRequirement = positionValue
                     .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, position.baseAssetAmount.abs(), 'Maintenance')))
@@ -552,14 +648,14 @@ class ClearingHouseUser {
         const freeCollateralExcludingTargetMarket = totalCollateral.sub(marginRequirementExcludingTargetMarket);
         // if the position value after the trade is less than free collateral, there is no liq price
         if (totalPositionValueAfterTrade.lte(freeCollateralExcludingTargetMarket) &&
-            proposedMarketPosition.baseAssetAmount.abs().gt(numericConstants_1.ZERO)) {
+            proposedPerpPosition.baseAssetAmount.abs().gt(numericConstants_1.ZERO)) {
             return new _1.BN(-1);
         }
-        const marginRequirementAfterTrade = marginRequirementExcludingTargetMarket.add(proposedMarketPositionValue
-            .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, proposedMarketPosition.baseAssetAmount.abs(), 'Maintenance')))
+        const marginRequirementAfterTrade = marginRequirementExcludingTargetMarket.add(proposedPerpPositionValue
+            .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, proposedPerpPosition.baseAssetAmount.abs(), 'Maintenance')))
             .div(numericConstants_1.MARGIN_PRECISION));
         const freeCollateralAfterTrade = totalCollateral.sub(marginRequirementAfterTrade);
-        const marketMaxLeverage = this.getMaxLeverage(proposedMarketPosition.marketIndex, 'Maintenance');
+        const marketMaxLeverage = this.getMaxLeverage(proposedPerpPosition.marketIndex, 'Maintenance');
         let priceDelta;
         if (proposedBaseAssetAmount.lt(numericConstants_1.ZERO)) {
             priceDelta = freeCollateralAfterTrade
@@ -579,13 +675,13 @@ class ClearingHouseUser {
         }
         let markPriceAfterTrade;
         if (positionBaseSizeChange.eq(numericConstants_1.ZERO)) {
-            markPriceAfterTrade = (0, _1.calculateMarkPrice)(this.clearingHouse.getMarketAccount(marketPosition.marketIndex), this.getOracleDataForMarket(marketPosition.marketIndex));
+            markPriceAfterTrade = (0, _1.calculateMarkPrice)(this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex), this.getOracleDataForMarket(perpPosition.marketIndex));
         }
         else {
             const direction = positionBaseSizeChange.gt(numericConstants_1.ZERO)
                 ? _1.PositionDirection.LONG
                 : _1.PositionDirection.SHORT;
-            markPriceAfterTrade = (0, _1.calculateTradeSlippage)(direction, positionBaseSizeChange.abs(), this.clearingHouse.getMarketAccount(marketPosition.marketIndex), 'base', this.getOracleDataForMarket(marketPosition.marketIndex))[3]; // newPrice after swap
+            markPriceAfterTrade = (0, _1.calculateTradeSlippage)(direction, positionBaseSizeChange.abs(), this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex), 'base', this.getOracleDataForMarket(perpPosition.marketIndex))[3]; // newPrice after swap
         }
         if (priceDelta.gt(markPriceAfterTrade)) {
             return new _1.BN(-1);
@@ -647,7 +743,7 @@ class ClearingHouseUser {
         // add any position we have on the opposite side of the current trade, because we can "flip" the size of this position without taking any extra leverage.
         const oppositeSizeValueUSDC = targetingSameSide
             ? numericConstants_1.ZERO
-            : this.getPositionValue(targetMarketIndex, oracleData);
+            : this.getPerpPositionValue(targetMarketIndex, oracleData);
         let maxPositionSize = this.getBuyingPower(targetMarketIndex);
         if (maxPositionSize.gte(numericConstants_1.ZERO)) {
             if (oppositeSizeValueUSDC.eq(numericConstants_1.ZERO)) {
@@ -662,23 +758,23 @@ class ClearingHouseUser {
         else {
             // current leverage is greater than max leverage - can only reduce position size
             if (!targetingSameSide) {
-                const market = this.clearingHouse.getMarketAccount(targetMarketIndex);
-                const marketPositionValue = this.getPositionValue(targetMarketIndex, oracleData);
+                const market = this.clearingHouse.getPerpMarketAccount(targetMarketIndex);
+                const perpPositionValue = this.getPerpPositionValue(targetMarketIndex, oracleData);
                 const totalCollateral = this.getTotalCollateral();
                 const marginRequirement = this.getInitialMarginRequirement();
-                const marginFreedByClosing = marketPositionValue
+                const marginFreedByClosing = perpPositionValue
                     .mul(new _1.BN(market.marginRatioInitial))
                     .div(numericConstants_1.MARGIN_PRECISION);
                 const marginRequirementAfterClosing = marginRequirement.sub(marginFreedByClosing);
                 if (marginRequirementAfterClosing.gt(totalCollateral)) {
-                    maxPositionSize = marketPositionValue;
+                    maxPositionSize = perpPositionValue;
                 }
                 else {
                     const freeCollateralAfterClose = totalCollateral.sub(marginRequirementAfterClosing);
                     const buyingPowerAfterClose = freeCollateralAfterClose
                         .mul(this.getMaxLeverage(targetMarketIndex))
                         .div(numericConstants_1.TEN_THOUSAND);
-                    maxPositionSize = marketPositionValue.add(buyingPowerAfterClose);
+                    maxPositionSize = perpPositionValue.add(buyingPowerAfterClose);
                 }
             }
             else {
@@ -702,7 +798,7 @@ class ClearingHouseUser {
         const currentPosition = this.getUserPosition(targetMarketIndex) ||
             this.getEmptyPosition(targetMarketIndex);
         const oracleData = this.getOracleDataForMarket(targetMarketIndex);
-        let currentPositionQuoteAmount = this.getPositionValue(targetMarketIndex, oracleData);
+        let currentPositionQuoteAmount = this.getPerpPositionValue(targetMarketIndex, oracleData);
         const currentSide = currentPosition && currentPosition.baseAssetAmount.isNeg()
             ? _1.PositionDirection.SHORT
             : _1.PositionDirection.LONG;
@@ -710,13 +806,13 @@ class ClearingHouseUser {
             currentPositionQuoteAmount = currentPositionQuoteAmount.neg();
         if (tradeSide === _1.PositionDirection.SHORT)
             tradeQuoteAmount = tradeQuoteAmount.neg();
-        const currentMarketPositionAfterTrade = currentPositionQuoteAmount
+        const currentPerpPositionAfterTrade = currentPositionQuoteAmount
             .add(tradeQuoteAmount)
             .abs();
-        const totalPositionAfterTradeExcludingTargetMarket = this.getTotalPositionValueExcludingMarket(targetMarketIndex);
+        const totalPositionAfterTradeExcludingTargetMarket = this.getTotalPerpPositionValueExcludingMarket(targetMarketIndex);
         const totalCollateral = this.getTotalCollateral();
         if (totalCollateral.gt(numericConstants_1.ZERO)) {
-            const newLeverage = currentMarketPositionAfterTrade
+            const newLeverage = currentPerpPositionAfterTrade
                 .add(totalPositionAfterTradeExcludingTargetMarket)
                 .abs()
                 .mul(numericConstants_1.TEN_THOUSAND)
@@ -733,7 +829,7 @@ class ClearingHouseUser {
      * @returns feeForQuote : Precision QUOTE_PRECISION
      */
     calculateFeeForQuoteAmount(quoteAmount) {
-        const feeStructure = this.clearingHouse.getStateAccount().feeStructure;
+        const feeStructure = this.clearingHouse.getStateAccount().perpFeeStructure;
         return quoteAmount
             .mul(feeStructure.feeNumerator)
             .div(feeStructure.feeDenominator);
@@ -743,23 +839,23 @@ class ClearingHouseUser {
      * @param marketToIgnore
      * @returns positionValue : Precision QUOTE_PRECISION
      */
-    getTotalPositionValueExcludingMarket(marketToIgnore) {
-        const currentMarketPosition = this.getUserPosition(marketToIgnore) ||
+    getTotalPerpPositionValueExcludingMarket(marketToIgnore) {
+        const currentPerpPosition = this.getUserPosition(marketToIgnore) ||
             this.getEmptyPosition(marketToIgnore);
         const oracleData = this.getOracleDataForMarket(marketToIgnore);
-        let currentMarketPositionValueUSDC = numericConstants_1.ZERO;
-        if (currentMarketPosition) {
-            currentMarketPositionValueUSDC = this.getPositionValue(marketToIgnore, oracleData);
+        let currentPerpPositionValueUSDC = numericConstants_1.ZERO;
+        if (currentPerpPosition) {
+            currentPerpPositionValueUSDC = this.getPerpPositionValue(marketToIgnore, oracleData);
         }
-        return this.getTotalPositionValue().sub(currentMarketPositionValueUSDC);
+        return this.getTotalPerpPositionValue().sub(currentPerpPositionValueUSDC);
     }
     getOracleDataForMarket(marketIndex) {
-        const oracleKey = this.clearingHouse.getMarketAccount(marketIndex).amm.oracle;
+        const oracleKey = this.clearingHouse.getPerpMarketAccount(marketIndex).amm.oracle;
         const oracleData = this.clearingHouse.getOraclePriceDataAndSlot(oracleKey).data;
         return oracleData;
     }
-    getOracleDataForBank(bankIndex) {
-        const oracleKey = this.clearingHouse.getBankAccount(bankIndex).oracle;
+    getOracleDataForSpotMarket(marketIndex) {
+        const oracleKey = this.clearingHouse.getSpotMarketAccount(marketIndex).oracle;
         const oracleData = this.clearingHouse.getOraclePriceDataAndSlot(oracleKey).data;
         return oracleData;
     }