@velocity-exchange/sdk 0.0.2 → 0.0.3

package/lib/browser/user.js

@@ -27,6 +27,10 @@ const strictOraclePrice_1 = require("./oracles/strictOraclePrice");
 const grpcUserAccountSubscriber_1 = require("./accounts/grpcUserAccountSubscriber");
 const marginCalculation_1 = require("./marginCalculation");
 class User {
+    /** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+    get driftClient() {
+        return this.velocityClient;
+    }
     get isSubscribed() {
         return this._isSubscribed && this.accountSubscriber.isSubscribed;
     }
@@ -34,38 +38,40 @@ class User {
         this._isSubscribed = val;
     }
     constructor(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         this._isSubscribed = false;
-        this.driftClient = config.driftClient;
+        // Type-system guarantees at least one of the two is supplied.
+        const velocityClient = ((_a = config.velocityClient) !== null && _a !== void 0 ? _a : config.driftClient);
+        this.velocityClient = velocityClient;
         this.userAccountPublicKey = config.userAccountPublicKey;
-        if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
-            this.accountSubscriber = new pollingUserAccountSubscriber_1.PollingUserAccountSubscriber(config.driftClient.connection, config.userAccountPublicKey, config.accountSubscription.accountLoader, this.driftClient.program.account.user.coder.accounts.decodeUnchecked.bind(this.driftClient.program.account.user.coder.accounts));
+        if (((_b = config.accountSubscription) === null || _b === void 0 ? void 0 : _b.type) === 'polling') {
+            this.accountSubscriber = new pollingUserAccountSubscriber_1.PollingUserAccountSubscriber(velocityClient.connection, config.userAccountPublicKey, config.accountSubscription.accountLoader, this.velocityClient.program.account.user.coder.accounts.decodeUnchecked.bind(this.velocityClient.program.account.user.coder.accounts));
         }
-        else if (((_b = config.accountSubscription) === null || _b === void 0 ? void 0 : _b.type) === 'custom') {
+        else if (((_c = config.accountSubscription) === null || _c === void 0 ? void 0 : _c.type) === 'custom') {
             this.accountSubscriber = config.accountSubscription.userAccountSubscriber;
         }
-        else if (((_c = config.accountSubscription) === null || _c === void 0 ? void 0 : _c.type) === 'grpc') {
+        else if (((_d = config.accountSubscription) === null || _d === void 0 ? void 0 : _d.type) === 'grpc') {
             if (config.accountSubscription.grpcMultiUserAccountSubscriber) {
                 this.accountSubscriber =
                     config.accountSubscription.grpcMultiUserAccountSubscriber.forUser(config.userAccountPublicKey);
             }
             else {
-                this.accountSubscriber = new grpcUserAccountSubscriber_1.grpcUserAccountSubscriber(config.accountSubscription.grpcConfigs, config.driftClient.program, config.userAccountPublicKey, {
-                    resubTimeoutMs: (_d = config.accountSubscription) === null || _d === void 0 ? void 0 : _d.resubTimeoutMs,
-                    logResubMessages: (_e = config.accountSubscription) === null || _e === void 0 ? void 0 : _e.logResubMessages,
+                this.accountSubscriber = new grpcUserAccountSubscriber_1.grpcUserAccountSubscriber(config.accountSubscription.grpcConfigs, velocityClient.program, config.userAccountPublicKey, {
+                    resubTimeoutMs: (_e = config.accountSubscription) === null || _e === void 0 ? void 0 : _e.resubTimeoutMs,
+                    logResubMessages: (_f = config.accountSubscription) === null || _f === void 0 ? void 0 : _f.logResubMessages,
                 });
             }
         }
         else {
-            if (((_f = config.accountSubscription) === null || _f === void 0 ? void 0 : _f.type) === 'websocket' &&
-                ((_g = config.accountSubscription) === null || _g === void 0 ? void 0 : _g.programUserAccountSubscriber)) {
-                this.accountSubscriber = new websocketProgramUserAccountSubscriber_1.WebSocketProgramUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey, config.accountSubscription.programUserAccountSubscriber);
+            if (((_g = config.accountSubscription) === null || _g === void 0 ? void 0 : _g.type) === 'websocket' &&
+                ((_h = config.accountSubscription) === null || _h === void 0 ? void 0 : _h.programUserAccountSubscriber)) {
+                this.accountSubscriber = new websocketProgramUserAccountSubscriber_1.WebSocketProgramUserAccountSubscriber(velocityClient.program, config.userAccountPublicKey, config.accountSubscription.programUserAccountSubscriber);
             }
             else {
-                this.accountSubscriber = new webSocketUserAccountSubscriber_1.WebSocketUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey, {
-                    resubTimeoutMs: (_h = config.accountSubscription) === null || _h === void 0 ? void 0 : _h.resubTimeoutMs,
-                    logResubMessages: (_j = config.accountSubscription) === null || _j === void 0 ? void 0 : _j.logResubMessages,
-                }, (_k = config.accountSubscription) === null || _k === void 0 ? void 0 : _k.commitment);
+                this.accountSubscriber = new webSocketUserAccountSubscriber_1.WebSocketUserAccountSubscriber(velocityClient.program, config.userAccountPublicKey, {
+                    resubTimeoutMs: (_j = config.accountSubscription) === null || _j === void 0 ? void 0 : _j.resubTimeoutMs,
+                    logResubMessages: (_k = config.accountSubscription) === null || _k === void 0 ? void 0 : _k.logResubMessages,
+                }, (_l = config.accountSubscription) === null || _l === void 0 ? void 0 : _l.commitment);
             }
         }
         this.eventEmitter = this.accountSubscriber.eventEmitter;
@@ -166,7 +172,7 @@ class User {
         if (spotPosition === undefined) {
             return numericConstants_1.ZERO;
         }
-        const spotMarket = this.driftClient.getSpotMarketAccount(marketIndex);
+        const spotMarket = this.velocityClient.getSpotMarketAccount(marketIndex);
         return (0, spotBalance_1.getSignedTokenAmount)((0, spotBalance_2.getTokenAmount)(spotPosition.scaledBalance, spotMarket, spotPosition.balanceType), spotPosition.balanceType);
     }
     getEmptyPosition(marketIndex) {
@@ -195,8 +201,8 @@ class User {
         const perpPosition = this.getPerpPosition(perpMarketIndex);
         if (!perpPosition)
             return numericConstants_1.ZERO;
-        const perpMarket = this.driftClient.getPerpMarketAccount(perpMarketIndex);
-        const spotMarket = this.driftClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
+        const perpMarket = this.velocityClient.getPerpMarketAccount(perpMarketIndex);
+        const spotMarket = this.velocityClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
         if (perpPosition === undefined) {
             return numericConstants_1.ZERO;
         }
@@ -212,8 +218,8 @@ class User {
             if (!((_a = perpPosition.isolatedPositionScaledBalance) === null || _a === void 0 ? void 0 : _a.gt(numericConstants_1.ZERO))) {
                 return total;
             }
-            const perpMarket = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
+            const perpMarket = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.getOracleDataForSpotMarket(perpMarket.quoteSpotMarketIndex);
             const strictOracle = new strictOraclePrice_1.StrictOraclePrice(quoteOraclePriceData.price, quoteOraclePriceData.twap);
             const tokenAmount = (0, spotBalance_2.getTokenAmount)(perpPosition.isolatedPositionScaledBalance, quoteSpotMarket, types_2.SpotBalanceType.DEPOSIT);
@@ -281,7 +287,7 @@ class User {
         return this.userAccountPublicKey;
     }
     async exists() {
-        const userAccountRPCResponse = await this.driftClient.connection.getParsedAccountInfo(this.userAccountPublicKey);
+        const userAccountRPCResponse = await this.velocityClient.connection.getParsedAccountInfo(this.userAccountPublicKey);
         return userAccountRPCResponse.value !== null;
     }
     /**
@@ -301,7 +307,7 @@ class User {
      */
     getPerpBuyingPower(marketIndex, collateralBuffer = numericConstants_1.ZERO, maxMarginRatio = undefined, positionType = 'cross') {
         const perpPosition = this.getPerpPositionOrEmpty(marketIndex);
-        const perpMarket = this.driftClient.getPerpMarketAccount(marketIndex);
+        const perpMarket = this.velocityClient.getPerpMarketAccount(marketIndex);
         const oraclePriceData = this.getOracleDataForPerpMarket(marketIndex);
         const worstCaseBaseAssetAmount = perpPosition
             ? (0, margin_2.calculateWorstCaseBaseAssetAmount)(perpPosition, perpMarket, oraclePriceData.price)
@@ -322,7 +328,7 @@ class User {
     }
     getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex, freeCollateral, baseAssetAmount, perpMarketMaxMarginRatio = undefined) {
         const maxMarginRatio = Math.max(perpMarketMaxMarginRatio, this.getUserAccount().maxMarginRatio);
-        const marginRatio = (0, market_1.calculateMarketMarginRatio)(this.driftClient.getPerpMarketAccount(marketIndex), baseAssetAmount, 'Initial', maxMarginRatio);
+        const marginRatio = (0, market_1.calculateMarketMarginRatio)(this.velocityClient.getPerpMarketAccount(marketIndex), baseAssetAmount, 'Initial', maxMarginRatio);
         return freeCollateral.mul(numericConstants_1.MARGIN_PRECISION).div(new anchor_1.BN(marginRatio));
     }
     /**
@@ -434,9 +440,9 @@ class User {
         return this.getActivePerpPositions()
             .filter((pos) => marketIndex !== undefined ? pos.marketIndex === marketIndex : true)
             .reduce((unrealizedPnl, perpPosition) => {
-            const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
+            const market = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
             const oraclePriceData = this.getMMOracleDataForPerpMarket(market.marketIndex);
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.getOracleDataForSpotMarket(market.quoteSpotMarketIndex);
             let positionUnrealizedPnl = (0, position_2.calculatePositionPNL)(market, perpPosition, withFunding, oraclePriceData);
             let quotePrice;
@@ -473,7 +479,7 @@ class User {
         return this.getUserAccount()
             .perpPositions.filter((pos) => marketIndex !== undefined ? pos.marketIndex === marketIndex : true)
             .reduce((pnl, perpPosition) => {
-            const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
+            const market = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
             return pnl.add((0, position_1.calculateUnsettledFundingPnl)(market, perpPosition));
         }, numericConstants_1.ZERO);
     }
@@ -491,7 +497,7 @@ class User {
                 (!countForBase && !countForQuote)) {
                 continue;
             }
-            const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
+            const spotMarketAccount = this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex);
             const oraclePriceData = this.getOracleDataForSpotMarket(spotPosition.marketIndex);
             let twap5min;
             if (strict) {
@@ -617,12 +623,12 @@ class User {
     getLiquidationBuffer() {
         const liquidationBufferMap = new Map();
         if (this.isBeingLiquidated()) {
-            liquidationBufferMap.set('cross', new anchor_1.BN(this.driftClient.getStateAccount().liquidationMarginBufferRatio));
+            liquidationBufferMap.set('cross', new anchor_1.BN(this.velocityClient.getStateAccount().liquidationMarginBufferRatio));
         }
         for (const position of this.getActivePerpPositions()) {
             if (position.positionFlag &
                 (types_2.PositionFlag.BeingLiquidated | types_2.PositionFlag.Bankruptcy)) {
-                liquidationBufferMap.set(position.marketIndex, new anchor_1.BN(this.driftClient.getStateAccount().liquidationMarginBufferRatio));
+                liquidationBufferMap.set(position.marketIndex, new anchor_1.BN(this.velocityClient.getStateAccount().liquidationMarginBufferRatio));
             }
         }
         return liquidationBufferMap;
@@ -667,7 +673,7 @@ class User {
         return health;
     }
     calculateWeightedPerpPositionLiability(perpPosition, marginCategory, liquidationBuffer, includeOpenOrders, strict = false) {
-        const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
+        const market = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
         let valuationPrice = this.getOracleDataForPerpMarket(market.marketIndex).price;
         if ((0, types_1.isVariant)(market.status, 'settlement')) {
             valuationPrice = market.expiryPrice;
@@ -692,8 +698,8 @@ class User {
             if ((0, types_1.isVariant)(market.status, 'settlement')) {
                 marginRatio = numericConstants_1.ZERO;
             }
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
-            const quoteOraclePriceData = this.driftClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
+            const quoteOraclePriceData = this.velocityClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
             let quotePrice;
             if (strict) {
                 quotePrice = anchor_1.BN.max(quoteOraclePriceData.price, quoteSpotMarket.historicalOracleData.lastOraclePriceTwap5Min);
@@ -736,7 +742,7 @@ class User {
      */
     getPerpPositionValue(marketIndex, oraclePriceData, includeOpenOrders = false) {
         const userPosition = this.getPerpPositionOrEmpty(marketIndex);
-        const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
+        const market = this.velocityClient.getPerpMarketAccount(userPosition.marketIndex);
         return (0, margin_2.calculateBaseAssetValueWithOracle)(market, userPosition, oraclePriceData, includeOpenOrders);
     }
     /**
@@ -745,7 +751,7 @@ class User {
      */
     getPerpLiabilityValue(marketIndex, oraclePriceData, includeOpenOrders = false) {
         const userPosition = this.getPerpPositionOrEmpty(marketIndex);
-        const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
+        const market = this.velocityClient.getPerpMarketAccount(userPosition.marketIndex);
         if (includeOpenOrders) {
             return (0, margin_1.calculateWorstCasePerpLiabilityValue)(userPosition, market, oraclePriceData.price).worstCaseLiabilityValue;
         }
@@ -769,7 +775,7 @@ class User {
      * @returns : Precision PRICE_PRECISION
      */
     getPositionEstimatedExitPriceAndPnl(position, amountToClose, useAMMClose = false) {
-        const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
+        const market = this.velocityClient.getPerpMarketAccount(position.marketIndex);
         const entryPrice = (0, position_1.calculateEntryPrice)(position);
         const oraclePriceData = this.getMMOracleDataForPerpMarket(position.marketIndex);
         if (amountToClose) {
@@ -825,9 +831,9 @@ class User {
         if (perpMarketIndex) {
             const perpPosition = this.getPerpPositionOrEmpty(perpMarketIndex);
             const perpLiability = this.calculateWeightedPerpPositionLiability(perpPosition, marginCategory, undefined, includeOpenOrders);
-            const perpMarket = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
+            const perpMarket = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
             const oraclePriceData = this.getOracleDataForPerpMarket(perpPosition.marketIndex);
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.getOracleDataForSpotMarket(perpMarket.quoteSpotMarketIndex);
             const strictOracle = new strictOraclePrice_1.StrictOraclePrice(quoteOraclePriceData.price, quoteOraclePriceData.twap);
             const positionUnrealizedPnl = (0, position_2.calculatePositionPNL)(perpMarket, perpPosition, true, oraclePriceData);
@@ -872,7 +878,7 @@ class User {
         return false;
     }
     getSpotMarketAccountsWithDustPosition() {
-        const spotMarketAccounts = this.driftClient.getSpotMarketAccounts();
+        const spotMarketAccounts = this.velocityClient.getSpotMarketAccounts();
         const dustPositionAccounts = [];
         for (const spotMarketAccount of spotMarketAccounts) {
             const isDust = this.isDustDepositPosition(spotMarketAccount);
@@ -1095,7 +1101,7 @@ class User {
             if (userPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {
                 continue;
             }
-            const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
+            const market = this.velocityClient.getPerpMarketAccount(userPosition.marketIndex);
             if (market.amm.cumulativeFundingRateLong.eq(userPosition.lastCumulativeFundingRate) ||
                 market.amm.cumulativeFundingRateShort.eq(userPosition.lastCumulativeFundingRate)) {
                 continue;
@@ -1117,7 +1123,7 @@ class User {
         const totalCollateral = this.getTotalCollateral('Maintenance');
         const maintenanceMarginRequirement = this.getMaintenanceMarginRequirement();
         const freeCollateral = anchor_1.BN.max(numericConstants_1.ZERO, totalCollateral.sub(maintenanceMarginRequirement));
-        const market = this.driftClient.getSpotMarketAccount(marketIndex);
+        const market = this.velocityClient.getSpotMarketAccount(marketIndex);
         let signedTokenAmount = (0, spotBalance_1.getSignedTokenAmount)((0, spotBalance_2.getTokenAmount)(currentSpotPosition.scaledBalance, market, currentSpotPosition.balanceType), currentSpotPosition.balanceType);
         signedTokenAmount = signedTokenAmount.add(positionBaseSizeChange);
         if (signedTokenAmount.eq(numericConstants_1.ZERO)) {
@@ -1125,10 +1131,10 @@ class User {
         }
         let freeCollateralDelta = this.calculateFreeCollateralDeltaForSpot(market, signedTokenAmount);
         const oracle = market.oracle;
-        const perpMarketWithSameOracle = this.driftClient
+        const perpMarketWithSameOracle = this.velocityClient
             .getPerpMarketAccounts()
             .find((market) => market.amm.oracle.equals(oracle));
-        const oraclePrice = this.driftClient.getOracleDataForSpotMarket(marketIndex).price;
+        const oraclePrice = this.velocityClient.getOracleDataForSpotMarket(marketIndex).price;
         if (perpMarketWithSameOracle) {
             const perpPosition = this.getPerpPositionOrEmpty(perpMarketWithSameOracle.marketIndex);
             if (perpPosition) {
@@ -1165,9 +1171,9 @@ class User {
      * @returns Precision : PRICE_PRECISION
      */
     liquidationPrice(marketIndex, positionBaseSizeChange = numericConstants_1.ZERO, estimatedEntryPrice = numericConstants_1.ZERO, marginCategory = 'Maintenance', includeOpenOrders = false, offsetCollateral = numericConstants_1.ZERO, marginType) {
-        const market = this.driftClient.getPerpMarketAccount(marketIndex);
-        const oracle = this.driftClient.getPerpMarketAccount(marketIndex).amm.oracle;
-        const oraclePrice = this.driftClient.getOracleDataForPerpMarket(marketIndex).price;
+        const market = this.velocityClient.getPerpMarketAccount(marketIndex);
+        const oracle = this.velocityClient.getPerpMarketAccount(marketIndex).amm.oracle;
+        const oraclePrice = this.velocityClient.getOracleDataForPerpMarket(marketIndex).price;
         const currentPerpPosition = this.getPerpPositionOrEmpty(marketIndex);
         if (marginType === 'Isolated') {
             const marginCalculation = this.getMarginCalculation(marginCategory, {
@@ -1202,7 +1208,7 @@ class User {
         if (!freeCollateralDelta) {
             return new anchor_1.BN(-1);
         }
-        const spotMarketWithSameOracle = this.driftClient
+        const spotMarketWithSameOracle = this.velocityClient
             .getSpotMarketAccounts()
             .find((market) => market.oracle.equals(oracle));
         if (spotMarketWithSameOracle) {
@@ -1250,7 +1256,7 @@ class User {
                 freeCollateralChange = newPositionValue.sub(costBasis);
             }
             // assume worst fee tier
-            const takerFeeTier = this.driftClient.getStateAccount().perpFeeStructure.feeTiers[0];
+            const takerFeeTier = this.velocityClient.getStateAccount().perpFeeStructure.feeTiers[0];
             const takerFee = newPositionValue
                 .muln(takerFeeTier.feeNumerator)
                 .divn(takerFeeTier.feeDenominator);
@@ -1315,7 +1321,8 @@ class User {
     calculateFreeCollateralDeltaForSpot(market, signedTokenAmount, marginCategory = 'Maintenance') {
         const tokenPrecision = new anchor_1.BN(Math.pow(10, market.decimals));
         if (signedTokenAmount.gt(numericConstants_1.ZERO)) {
-            const assetWeight = (0, spotBalance_2.calculateAssetWeight)(signedTokenAmount, this.driftClient.getOracleDataForSpotMarket(market.marketIndex).price, market, marginCategory);
+            const assetWeight = (0, spotBalance_2.calculateAssetWeight)(signedTokenAmount, this.velocityClient.getOracleDataForSpotMarket(market.marketIndex)
+                .price, market, marginCategory);
             return numericConstants_1.QUOTE_PRECISION.mul(assetWeight)
                 .div(numericConstants_1.SPOT_MARKET_WEIGHT_PRECISION)
                 .mul(signedTokenAmount)
@@ -1349,11 +1356,11 @@ class User {
     }
     getMarginUSDCRequiredForTrade(targetMarketIndex, baseSize, estEntryPrice, perpMarketMaxMarginRatio) {
         const maxMarginRatio = Math.max(perpMarketMaxMarginRatio, this.getUserAccount().maxMarginRatio);
-        return (0, margin_2.calculateMarginUSDCRequiredForTrade)(this.driftClient, targetMarketIndex, baseSize, maxMarginRatio, estEntryPrice);
+        return (0, margin_2.calculateMarginUSDCRequiredForTrade)(this.velocityClient, targetMarketIndex, baseSize, maxMarginRatio, estEntryPrice);
     }
     getCollateralDepositRequiredForTrade(targetMarketIndex, baseSize, collateralIndex, perpMarketMaxMarginRatio) {
         const maxMarginRatio = Math.max(perpMarketMaxMarginRatio, this.getUserAccount().maxMarginRatio);
-        return (0, margin_2.calculateCollateralDepositRequiredForTrade)(this.driftClient, targetMarketIndex, baseSize, collateralIndex, maxMarginRatio);
+        return (0, margin_2.calculateCollateralDepositRequiredForTrade)(this.velocityClient, targetMarketIndex, baseSize, collateralIndex, maxMarginRatio);
     }
     /**
      * Separates the max trade size into two parts:
@@ -1375,7 +1382,7 @@ class User {
             ? true
             : targetSide === currentPositionSide;
         const oracleData = this.getMMOracleDataForPerpMarket(targetMarketIndex);
-        const marketAccount = this.driftClient.getPerpMarketAccount(targetMarketIndex);
+        const marketAccount = this.velocityClient.getPerpMarketAccount(targetMarketIndex);
         // 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 oppositeSizeLiabilityValue = targetingSameSide
             ? numericConstants_1.ZERO
@@ -1446,8 +1453,8 @@ class User {
      * @returns tradeSizeAllowed : Precision QUOTE_PRECISION
      */
     getMaxTradeSizeUSDCForSpot(targetMarketIndex, direction, currentQuoteAssetValue, currentSpotMarketNetValue) {
-        const market = this.driftClient.getSpotMarketAccount(targetMarketIndex);
-        const oraclePrice = this.driftClient.getOracleDataForSpotMarket(targetMarketIndex).price;
+        const market = this.velocityClient.getSpotMarketAccount(targetMarketIndex);
+        const oraclePrice = this.velocityClient.getOracleDataForSpotMarket(targetMarketIndex).price;
         currentQuoteAssetValue = this.getSpotMarketAssetValue(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
         currentSpotMarketNetValue =
             currentSpotMarketNetValue !== null && currentSpotMarketNetValue !== void 0 ? currentSpotMarketNetValue : this.getSpotPositionValue(targetMarketIndex);
@@ -1489,8 +1496,8 @@ class User {
      * @param iterationLimit how long to run appromixation before erroring out
      */
     getMaxSwapAmount({ inMarketIndex, outMarketIndex, calculateSwap, iterationLimit = 1000, }) {
-        const inMarket = this.driftClient.getSpotMarketAccount(inMarketIndex);
-        const outMarket = this.driftClient.getSpotMarketAccount(outMarketIndex);
+        const inMarket = this.velocityClient.getSpotMarketAccount(inMarketIndex);
+        const outMarket = this.velocityClient.getSpotMarketAccount(outMarketIndex);
         const inOraclePriceData = this.getOracleDataForSpotMarket(inMarketIndex);
         const inOraclePrice = inOraclePriceData.price;
         const outOraclePriceData = this.getOracleDataForSpotMarket(outMarketIndex);
@@ -1618,14 +1625,14 @@ class User {
     }
     calculateSpotPositionFreeCollateralContribution(spotPosition, strictOraclePrice) {
         const marginCategory = 'Initial';
-        const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
+        const spotMarketAccount = this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex);
         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 spotMarketAccount = this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex);
         const { tokenValue, ordersValue } = (0, spotPosition_1.getWorstCaseTokenAmounts)(spotPosition, spotMarketAccount, strictOraclePrice, 'Initial', this.getUserAccount().maxMarginRatio);
         if (tokenValue.gte(numericConstants_1.ZERO)) {
             totalAssetValue = tokenValue;
@@ -1652,8 +1659,8 @@ class User {
      * @param outAmount
      */
     accountLeverageAfterSwap({ inMarketIndex, outMarketIndex, inAmount, outAmount, }) {
-        const inMarket = this.driftClient.getSpotMarketAccount(inMarketIndex);
-        const outMarket = this.driftClient.getSpotMarketAccount(outMarketIndex);
+        const inMarket = this.velocityClient.getSpotMarketAccount(inMarketIndex);
+        const outMarket = this.velocityClient.getSpotMarketAccount(outMarketIndex);
         const inOraclePriceData = this.getOracleDataForSpotMarket(inMarketIndex);
         const inOraclePrice = inOraclePriceData.price;
         const outOraclePriceData = this.getOracleDataForSpotMarket(outMarketIndex);
@@ -1740,7 +1747,7 @@ class User {
             return newLeverage;
         }
         const currentPosition = this.getPerpPositionOrEmpty(targetMarketIndex);
-        const perpMarket = this.driftClient.getPerpMarketAccount(targetMarketIndex);
+        const perpMarket = this.velocityClient.getPerpMarketAccount(targetMarketIndex);
         const oracleData = this.getOracleDataForPerpMarket(targetMarketIndex);
         let { 
         // eslint-disable-next-line prefer-const
@@ -1774,10 +1781,10 @@ class User {
         return newLeverage;
     }
     getUserFeeTier(marketType, now) {
-        const state = this.driftClient.getStateAccount();
+        const state = this.velocityClient.getStateAccount();
         const feeTierIndex = 0;
         if ((0, types_1.isVariant)(marketType, 'perp')) {
-            const userStatsAccount = this.driftClient
+            const userStatsAccount = this.velocityClient
                 .getUserStats()
                 .getAccount();
             const total30dVolume = (0, trade_1.getUser30dRollingVolumeEstimate)(userStatsAccount, now);
@@ -1829,7 +1836,7 @@ class User {
      */
     calculateFeeForQuoteAmount(quoteAmount, marketIndex) {
         if (marketIndex !== undefined) {
-            const takerFeeMultiplier = this.driftClient.getMarketFees(types_2.MarketType.PERP, marketIndex, this).takerFee;
+            const takerFeeMultiplier = this.velocityClient.getMarketFees(types_2.MarketType.PERP, marketIndex, this).takerFee;
             const feeAmountNum = bigNum_1.BigNum.from(quoteAmount, numericConstants_1.QUOTE_PRECISION_EXP).toNum() *
                 takerFeeMultiplier;
             return bigNum_1.BigNum.fromPrint(feeAmountNum.toString(), numericConstants_1.QUOTE_PRECISION_EXP).val;
@@ -1849,7 +1856,7 @@ class User {
      */
     getWithdrawalLimit(marketIndex, reduceOnly) {
         const nowTs = new anchor_1.BN(Math.floor(Date.now() / 1000));
-        const spotMarket = this.driftClient.getSpotMarketAccount(marketIndex);
+        const spotMarket = this.velocityClient.getSpotMarketAccount(marketIndex);
         // eslint-disable-next-line prefer-const
         let { borrowLimit, withdrawLimit } = (0, spotBalance_2.calculateWithdrawLimit)(spotMarket, nowTs);
         const freeCollateral = this.getFreeCollateral();
@@ -1902,7 +1909,7 @@ class User {
         }
     }
     canBypassWithdrawLimits(marketIndex) {
-        const spotMarket = this.driftClient.getSpotMarketAccount(marketIndex);
+        const spotMarket = this.velocityClient.getSpotMarketAccount(marketIndex);
         const maxDepositAmount = spotMarket.withdrawGuardThreshold.div(new anchor_1.BN(10));
         const position = this.getSpotPosition(marketIndex);
         const netDeposits = this.getUserAccount().totalDeposits.sub(this.getUserAccount().totalWithdraws);
@@ -1983,9 +1990,9 @@ class User {
     }
     canBeDeleted(userStatsAccount, now) {
         const userAccount = this.getUserAccount();
-        const userStatsAccountToUse = userStatsAccount || this.driftClient.getUserStats().getAccount();
+        const userStatsAccountToUse = userStatsAccount || this.velocityClient.getUserStats().getAccount();
         const nowInSeconds = now || new anchor_1.BN(Math.floor(Date.now() / 1000));
-        const stateAccount = this.driftClient.getStateAccount();
+        const stateAccount = this.velocityClient.getStateAccount();
         // Referrer cannot delete sub_account_id 0
         const isReferrer = (userStatsAccountToUse.referrerStatus & types_1.ReferrerStatus.IsReferrer) > 0;
         if (isReferrer && userAccount.subAccountId === 0) {
@@ -2034,13 +2041,13 @@ class User {
         let safestPerpTier = 4;
         let safestSpotTier = 4;
         for (const perpPosition of this.getActivePerpPositions()) {
-            safestPerpTier = Math.min(safestPerpTier, (0, tiers_1.getPerpMarketTierNumber)(this.driftClient.getPerpMarketAccount(perpPosition.marketIndex)));
+            safestPerpTier = Math.min(safestPerpTier, (0, tiers_1.getPerpMarketTierNumber)(this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex)));
         }
         for (const spotPosition of this.getActiveSpotPositions()) {
             if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
                 continue;
             }
-            safestSpotTier = Math.min(safestSpotTier, (0, tiers_1.getSpotMarketTierNumber)(this.driftClient.getSpotMarketAccount(spotPosition.marketIndex)));
+            safestSpotTier = Math.min(safestSpotTier, (0, tiers_1.getSpotMarketTierNumber)(this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex)));
         }
         return {
             perpTier: safestPerpTier,
@@ -2048,9 +2055,9 @@ class User {
         };
     }
     getPerpPositionHealth({ marginCategory, perpPosition, oraclePriceData, quoteOraclePriceData, includeOpenOrders = true, }) {
-        const perpMarket = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
+        const perpMarket = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
         const _oraclePriceData = oraclePriceData ||
-            this.driftClient.getOracleDataForPerpMarket(perpMarket.marketIndex);
+            this.velocityClient.getOracleDataForPerpMarket(perpMarket.marketIndex);
         const oraclePrice = _oraclePriceData.price;
         let worstCaseBaseAmount;
         let worstCaseLiabilityValue;
@@ -2066,7 +2073,7 @@ class User {
         const userCustomMargin = Math.max(perpPosition.maxMarginRatio, this.getUserAccount().maxMarginRatio);
         const marginRatio = new anchor_1.BN((0, market_1.calculateMarketMarginRatio)(perpMarket, worstCaseBaseAmount.abs(), marginCategory, userCustomMargin));
         const _quoteOraclePriceData = quoteOraclePriceData ||
-            this.driftClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
+            this.velocityClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
         let marginRequirement = worstCaseLiabilityValue
             .mul(_quoteOraclePriceData.price)
             .div(numericConstants_1.PRICE_PRECISION)
@@ -2089,16 +2096,16 @@ class User {
             perpPnl: [],
         };
         for (const perpPosition of this.getActivePerpPositions()) {
-            const perpMarket = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
-            const oraclePriceData = this.driftClient.getOracleDataForPerpMarket(perpMarket.marketIndex);
-            const quoteOraclePriceData = this.driftClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
+            const perpMarket = this.velocityClient.getPerpMarketAccount(perpPosition.marketIndex);
+            const oraclePriceData = this.velocityClient.getOracleDataForPerpMarket(perpMarket.marketIndex);
+            const quoteOraclePriceData = this.velocityClient.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
             healthComponents.perpPositions.push(this.getPerpPositionHealth({
                 marginCategory,
                 perpPosition,
                 oraclePriceData,
                 quoteOraclePriceData,
             }));
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(perpMarket.quoteSpotMarketIndex);
             const positionUnrealizedPnl = (0, position_2.calculatePositionPNL)(perpMarket, perpPosition, true, oraclePriceData);
             let pnlWeight;
             if (positionUnrealizedPnl.gt(numericConstants_1.ZERO)) {
@@ -2123,7 +2130,7 @@ class User {
         }
         let netQuoteValue = numericConstants_1.ZERO;
         for (const spotPosition of this.getActiveSpotPositions()) {
-            const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
+            const spotMarketAccount = this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex);
             const oraclePriceData = this.getOracleDataForSpotMarket(spotPosition.marketIndex);
             const strictOraclePrice = new strictOraclePrice_1.StrictOraclePrice(oraclePriceData.price);
             if (spotPosition.marketIndex === numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
@@ -2155,7 +2162,7 @@ class User {
             }
         }
         if (!netQuoteValue.eq(numericConstants_1.ZERO)) {
-            const spotMarketAccount = this.driftClient.getQuoteSpotMarketAccount();
+            const spotMarketAccount = this.velocityClient.getQuoteSpotMarketAccount();
             const oraclePriceData = this.getOracleDataForSpotMarket(numericConstants_1.QUOTE_SPOT_MARKET_INDEX);
             const baseAssetValue = (0, spotBalance_1.getTokenValue)(netQuoteValue, spotMarketAccount.decimals, oraclePriceData);
             const { weight, weightedTokenValue } = (0, spotPosition_1.calculateWeightedTokenValue)(netQuoteValue, baseAssetValue, oraclePriceData.price, spotMarketAccount, marginCategory, this.getUserAccount().maxMarginRatio);
@@ -2195,13 +2202,13 @@ class User {
         return this.getTotalPerpPositionLiability(marginCategory, liquidationBuffer, includeOpenOrders).sub(currentPerpPositionValueUSDC);
     }
     getMMOracleDataForPerpMarket(marketIndex) {
-        return this.driftClient.getMMOracleDataForPerpMarket(marketIndex);
+        return this.velocityClient.getMMOracleDataForPerpMarket(marketIndex);
     }
     getOracleDataForPerpMarket(marketIndex) {
-        return this.driftClient.getOracleDataForPerpMarket(marketIndex);
+        return this.velocityClient.getOracleDataForPerpMarket(marketIndex);
     }
     getOracleDataForSpotMarket(marketIndex) {
-        return this.driftClient.getOracleDataForSpotMarket(marketIndex);
+        return this.velocityClient.getOracleDataForSpotMarket(marketIndex);
     }
     /**
      * Get the active perp and spot positions of the user.
@@ -2243,7 +2250,7 @@ class User {
             if ((0, spotPosition_1.isSpotPositionAvailable)(spotPosition))
                 continue;
             const isQuote = spotPosition.marketIndex === numericConstants_1.QUOTE_SPOT_MARKET_INDEX;
-            const spotMarket = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
+            const spotMarket = this.velocityClient.getSpotMarketAccount(spotPosition.marketIndex);
             const oraclePriceData = this.getOracleDataForSpotMarket(spotPosition.marketIndex);
             const twap5 = strict
                 ? (0, oracles_1.calculateLiveOracleTwap)(spotMarket.historicalOracleData, oraclePriceData, new anchor_1.BN(Math.floor(Date.now() / 1000)), numericConstants_1.FIVE_MINUTE)
@@ -2292,8 +2299,8 @@ class User {
         }
         // PERP POSITIONS
         for (const marketPosition of this.getActivePerpPositions()) {
-            const market = this.driftClient.getPerpMarketAccount(marketPosition.marketIndex);
-            const quoteSpotMarket = this.driftClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
+            const market = this.velocityClient.getPerpMarketAccount(marketPosition.marketIndex);
+            const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
             const quoteOraclePriceData = this.getOracleDataForSpotMarket(market.quoteSpotMarketIndex);
             const oraclePriceData = this.getMMOracleDataForPerpMarket(market.marketIndex);
             const nonMmmOraclePriceData = this.getOracleDataForPerpMarket(market.marketIndex);
@@ -2346,7 +2353,7 @@ class User {
                 // derive isolated quote deposit value, mirroring on-chain logic
                 let depositValue = numericConstants_1.ZERO;
                 if ((_h = marketPosition.isolatedPositionScaledBalance) === null || _h === void 0 ? void 0 : _h.gt(numericConstants_1.ZERO)) {
-                    const quoteSpotMarket = this.driftClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
+                    const quoteSpotMarket = this.velocityClient.getSpotMarketAccount(market.quoteSpotMarketIndex);
                     const quoteOraclePriceData = this.getOracleDataForSpotMarket(market.quoteSpotMarketIndex);
                     const strictQuote = new strictOraclePrice_1.StrictOraclePrice(quoteOraclePriceData.price, strict
                         ? quoteSpotMarket.historicalOracleData.lastOraclePriceTwap5Min

package/lib/browser/userConfig.d.ts

@@ -5,11 +5,12 @@ import { GrpcConfigs, UserAccountSubscriber } from './accounts/types';
 import { WebSocketProgramAccountSubscriber } from './accounts/webSocketProgramAccountSubscriber';
 import { UserAccount } from './types';
 import { grpcMultiUserAccountSubscriber } from './accounts/grpcMultiUserAccountSubscriber';
-export type UserConfig = {
+import { AtLeastOne } from './util/deprecatedAlias';
+type UserConfigBase = {
     accountSubscription?: UserSubscriptionConfig;
-    driftClient: VelocityClient;
     userAccountPublicKey: PublicKey;
 };
+export type UserConfig = UserConfigBase & AtLeastOne<'velocityClient', 'driftClient', VelocityClient>;
 export type UserSubscriptionConfig = {
     type: 'grpc';
     resubTimeoutMs?: number;
@@ -29,3 +30,4 @@ export type UserSubscriptionConfig = {
     type: 'custom';
     userAccountSubscriber: UserAccountSubscriber;
 };
+export {};

package/lib/browser/userMap/referrerMap.d.ts

@@ -11,16 +11,18 @@ export declare class ReferrerMap {
      * Will be undefined if the referrer is not in the map yet.
      */
     private referrerReferrerInfoMap;
-    private driftClient;
+    private velocityClient;
+    /** @deprecated Use `velocityClient` instead. `driftClient` will be removed in a future major. */
+    private get driftClient();
     private parallelSync;
     private fetchPromise?;
     private fetchPromiseResolver;
     /**
      * Creates a new UserStatsMap instance.
      *
-     * @param {VelocityClient} driftClient - The VelocityClient instance.
+     * @param {VelocityClient} velocityClient - The VelocityClient instance.
      */
-    constructor(driftClient: VelocityClient, parallelSync?: boolean);
+    constructor(velocityClient: VelocityClient, parallelSync?: boolean);
     /**
      * Subscribe to all UserStats accounts.
      */