@drift-labs/sdk 0.2.0-master.37 → 0.2.0-master.39

package/lib/{clearingHouseUser.js → user.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClearingHouseUser = void 0;
+exports.User = void 0;
 const types_1 = require("./types");
 const position_1 = require("./math/position");
 const numericConstants_1 = require("./constants/numericConstants");
@@ -11,17 +11,17 @@ 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 {
+class User {
     constructor(config) {
         var _a;
         this._isSubscribed = false;
-        this.clearingHouse = config.clearingHouse;
+        this.driftClient = config.driftClient;
         this.userAccountPublicKey = config.userAccountPublicKey;
         if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
-            this.accountSubscriber = new pollingUserAccountSubscriber_1.PollingUserAccountSubscriber(config.clearingHouse.program, config.userAccountPublicKey, config.accountSubscription.accountLoader);
+            this.accountSubscriber = new pollingUserAccountSubscriber_1.PollingUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey, config.accountSubscription.accountLoader);
         }
         else {
-            this.accountSubscriber = new webSocketUserAccountSubscriber_1.WebSocketUserAccountSubscriber(config.clearingHouse.program, config.userAccountPublicKey);
+            this.accountSubscriber = new webSocketUserAccountSubscriber_1.WebSocketUserAccountSubscriber(config.driftClient.program, config.userAccountPublicKey);
         }
         this.eventEmitter = this.accountSubscriber.eventEmitter;
     }
@@ -32,7 +32,7 @@ class ClearingHouseUser {
         this._isSubscribed = val;
     }
     /**
-     * Subscribe to ClearingHouseUser state accounts
+     * Subscribe to User state accounts
      * @returns SusbcriptionSuccess result
      */
     async subscribe() {
@@ -56,13 +56,21 @@ class ClearingHouseUser {
         return this.accountSubscriber.getUserAccountAndSlot();
     }
     /**
-     * Gets the user's current position for a given market. If the user has no position returns undefined
+     * Gets the user's current position for a given perp market. If the user has no position returns undefined
      * @param marketIndex
-     * @returns userPosition
+     * @returns userPerpPosition
      */
-    getUserPosition(marketIndex) {
+    getPerpPosition(marketIndex) {
         return this.getUserAccount().perpPositions.find((position) => position.marketIndex === marketIndex);
     }
+    /**
+     * Gets the user's current position for a given spot market. If the user has no position returns undefined
+     * @param marketIndex
+     * @returns userSpotPosition
+     */
+    getSpotPosition(marketIndex) {
+        return this.getUserAccount().spotPositions.find((position) => position.marketIndex === marketIndex);
+    }
     getEmptyPosition(marketIndex) {
         return {
             baseAssetAmount: numericConstants_1.ZERO,
@@ -103,7 +111,7 @@ class ClearingHouseUser {
         return this.userAccountPublicKey;
     }
     async exists() {
-        const userAccountRPCResponse = await this.clearingHouse.connection.getParsedAccountInfo(this.userAccountPublicKey);
+        const userAccountRPCResponse = await this.driftClient.connection.getParsedAccountInfo(this.userAccountPublicKey);
         return userAccountRPCResponse.value !== null;
     }
     /**
@@ -112,7 +120,7 @@ class ClearingHouseUser {
      * @returns : open asks
      */
     getPerpBidAsks(marketIndex) {
-        const position = this.getUserPosition(marketIndex);
+        const position = this.getPerpPosition(marketIndex);
         const [lpOpenBids, lpOpenAsks] = this.getLPBidAsks(marketIndex);
         const totalOpenBids = lpOpenBids.add(position.openBids);
         const totalOpenAsks = lpOpenAsks.add(position.openAsks);
@@ -124,11 +132,11 @@ class ClearingHouseUser {
      * @returns : lp open asks
      */
     getLPBidAsks(marketIndex) {
-        const position = this.getUserPosition(marketIndex);
-        if (position.lpShares.eq(numericConstants_1.ZERO)) {
+        const position = this.getPerpPosition(marketIndex);
+        if (position === undefined || position.lpShares.eq(numericConstants_1.ZERO)) {
             return [numericConstants_1.ZERO, numericConstants_1.ZERO];
         }
-        const market = this.clearingHouse.getPerpMarketAccount(marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(marketIndex);
         const [marketOpenBids, marketOpenAsks] = (0, amm_1.calculateMarketOpenBidAsk)(market.amm.baseAssetReserve, market.amm.minBaseAssetReserve, market.amm.maxBaseAssetReserve);
         const lpOpenBids = marketOpenBids
             .mul(position.lpShares)
@@ -145,12 +153,12 @@ class ClearingHouseUser {
      * @returns : pnl from settle
      */
     getSettledLPPosition(marketIndex) {
-        const _position = this.getUserPosition(marketIndex);
+        const _position = this.getPerpPosition(marketIndex);
         const position = this.getClonedPosition(_position);
         if (position.lpShares.eq(numericConstants_1.ZERO)) {
             return [position, numericConstants_1.ZERO, numericConstants_1.ZERO];
         }
-        const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
         const nShares = position.lpShares;
         const deltaBaa = market.amm.baseAssetAmountPerLp
             .sub(position.lastNetBaseAssetAmountPerLp)
@@ -267,11 +275,11 @@ class ClearingHouseUser {
      * @returns : Precision QUOTE_PRECISION
      */
     getUnrealizedPNL(withFunding, marketIndex, withWeightMarginCategory) {
-        const quoteSpotMarket = this.clearingHouse.getQuoteSpotMarketAccount();
+        const quoteSpotMarket = this.driftClient.getQuoteSpotMarketAccount();
         return this.getUserAccount()
             .perpPositions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
             .reduce((unrealizedPnl, perpPosition) => {
-            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
             const oraclePriceData = this.getOracleDataForPerpMarket(market.marketIndex);
             let positionUnrealizedPnl = (0, _1.calculatePositionPNL)(market, perpPosition, withFunding, oraclePriceData);
             if (withWeightMarginCategory !== undefined) {
@@ -292,7 +300,7 @@ class ClearingHouseUser {
         return this.getUserAccount()
             .perpPositions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
             .reduce((pnl, perpPosition) => {
-            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
             return pnl.add((0, _1.calculatePositionFundingPNL)(market, perpPosition));
         }, numericConstants_1.ZERO);
     }
@@ -303,7 +311,7 @@ class ClearingHouseUser {
                     spotPosition.marketIndex !== marketIndex)) {
                 return totalLiabilityValue;
             }
-            const spotMarketAccount = this.clearingHouse.getSpotMarketAccount(spotPosition.marketIndex);
+            const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
             if (spotPosition.marketIndex === numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
                 if ((0, types_1.isVariant)(spotPosition.balanceType, 'borrow')) {
                     const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.scaledBalance, spotMarketAccount, spotPosition.balanceType);
@@ -377,7 +385,7 @@ class ClearingHouseUser {
                 return totalAssetValue;
             }
             // Todo this needs to account for whether it's based on initial or maintenance requirements
-            const spotMarketAccount = this.clearingHouse.getSpotMarketAccount(spotPosition.marketIndex);
+            const spotMarketAccount = this.driftClient.getSpotMarketAccount(spotPosition.marketIndex);
             if (spotPosition.marketIndex === numericConstants_1.QUOTE_SPOT_MARKET_INDEX) {
                 if ((0, types_1.isVariant)(spotPosition.balanceType, 'deposit')) {
                     const tokenAmount = (0, spotBalance_1.getTokenAmount)(spotPosition.scaledBalance, spotMarketAccount, spotPosition.balanceType);
@@ -434,7 +442,7 @@ class ClearingHouseUser {
      */
     getTotalPerpPositionValue(marginCategory, liquidationBuffer, includeOpenOrders) {
         return this.getUserAccount().perpPositions.reduce((totalPerpValue, perpPosition) => {
-            const market = this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex);
+            const market = this.driftClient.getPerpMarketAccount(perpPosition.marketIndex);
             if (perpPosition.lpShares.gt(numericConstants_1.ZERO)) {
                 // is an lp
                 // clone so we dont mutate the position
@@ -482,8 +490,8 @@ class ClearingHouseUser {
      * @returns : Precision QUOTE_PRECISION
      */
     getPerpPositionValue(marketIndex, oraclePriceData) {
-        const userPosition = this.getUserPosition(marketIndex) || this.getEmptyPosition(marketIndex);
-        const market = this.clearingHouse.getPerpMarketAccount(userPosition.marketIndex);
+        const userPosition = this.getPerpPosition(marketIndex) || this.getEmptyPosition(marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
         return (0, margin_1.calculateBaseAssetValueWithOracle)(market, userPosition, oraclePriceData);
     }
     getPositionSide(currentPosition) {
@@ -502,7 +510,7 @@ class ClearingHouseUser {
      * @returns : Precision PRICE_PRECISION
      */
     getPositionEstimatedExitPriceAndPnl(position, amountToClose, useAMMClose = false) {
-        const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
         const entryPrice = (0, position_1.calculateEntryPrice)(position);
         const oraclePriceData = this.getOracleDataForPerpMarket(position.marketIndex);
         if (amountToClose) {
@@ -561,7 +569,7 @@ class ClearingHouseUser {
      * @returns : Precision TEN_THOUSAND
      */
     getMaxLeverage(marketIndex, category = 'Initial') {
-        const market = this.clearingHouse.getPerpMarketAccount(marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(marketIndex);
         const totalAssetValue = this.getTotalAssetValue();
         if (totalAssetValue.eq(numericConstants_1.ZERO)) {
             return numericConstants_1.ZERO;
@@ -598,7 +606,7 @@ class ClearingHouseUser {
         // 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().isBeingLiquidated) {
-            liquidationBuffer = new _1.BN(this.clearingHouse.getStateAccount().liquidationMarginBufferRatio);
+            liquidationBuffer = new _1.BN(this.driftClient.getStateAccount().liquidationMarginBufferRatio);
         }
         const maintenanceRequirement = this.getMaintenanceMarginRequirement(liquidationBuffer);
         return totalCollateral.lt(maintenanceRequirement);
@@ -612,7 +620,7 @@ class ClearingHouseUser {
             if (userPosition.baseAssetAmount.eq(numericConstants_1.ZERO)) {
                 continue;
             }
-            const market = this.clearingHouse.getPerpMarketAccount(userPosition.marketIndex);
+            const market = this.driftClient.getPerpMarketAccount(userPosition.marketIndex);
             if (market.amm.cumulativeFundingRateLong.eq(userPosition.lastCumulativeFundingRate) ||
                 market.amm.cumulativeFundingRateShort.eq(userPosition.lastCumulativeFundingRate)) {
                 continue;
@@ -642,7 +650,7 @@ class ClearingHouseUser {
         const totalCollateral = this.getTotalCollateral();
         // calculate the total position value ignoring any value from the target market of the trade
         const totalPositionValueExcludingTargetMarket = this.getTotalPerpPositionValueExcludingMarket(perpPosition.marketIndex);
-        const currentPerpPosition = this.getUserPosition(perpPosition.marketIndex) ||
+        const currentPerpPosition = this.getPerpPosition(perpPosition.marketIndex) ||
             this.getEmptyPosition(perpPosition.marketIndex);
         const currentPerpPositionBaseSize = currentPerpPosition.baseAssetAmount;
         const proposedBaseAssetAmount = currentPerpPositionBaseSize.add(positionBaseSizeChange);
@@ -665,13 +673,13 @@ class ClearingHouseUser {
         };
         if (proposedBaseAssetAmount.eq(numericConstants_1.ZERO))
             return new _1.BN(-1);
-        const market = this.clearingHouse.getPerpMarketAccount(proposedPerpPosition.marketIndex);
+        const market = this.driftClient.getPerpMarketAccount(proposedPerpPosition.marketIndex);
         const proposedPerpPositionValue = (0, margin_1.calculateBaseAssetValueWithOracle)(market, proposedPerpPosition, this.getOracleDataForPerpMarket(market.marketIndex));
         // total position value after trade
         const totalPositionValueAfterTrade = totalPositionValueExcludingTargetMarket.add(proposedPerpPositionValue);
         const marginRequirementExcludingTargetMarket = this.getUserAccount().perpPositions.reduce((totalMarginRequirement, position) => {
             if (position.marketIndex !== perpPosition.marketIndex) {
-                const market = this.clearingHouse.getPerpMarketAccount(position.marketIndex);
+                const market = this.driftClient.getPerpMarketAccount(position.marketIndex);
                 const positionValue = (0, margin_1.calculateBaseAssetValueWithOracle)(market, position, this.getOracleDataForPerpMarket(market.marketIndex));
                 const marketMarginRequirement = positionValue
                     .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, position.baseAssetAmount.abs(), 'Maintenance')))
@@ -710,13 +718,13 @@ class ClearingHouseUser {
         }
         let markPriceAfterTrade;
         if (positionBaseSizeChange.eq(numericConstants_1.ZERO)) {
-            markPriceAfterTrade = (0, _1.calculateReservePrice)(this.clearingHouse.getPerpMarketAccount(perpPosition.marketIndex), this.getOracleDataForPerpMarket(perpPosition.marketIndex));
+            markPriceAfterTrade = (0, _1.calculateReservePrice)(this.driftClient.getPerpMarketAccount(perpPosition.marketIndex), this.getOracleDataForPerpMarket(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.getPerpMarketAccount(perpPosition.marketIndex), 'base', this.getOracleDataForPerpMarket(perpPosition.marketIndex))[3]; // newPrice after swap
+            markPriceAfterTrade = (0, _1.calculateTradeSlippage)(direction, positionBaseSizeChange.abs(), this.driftClient.getPerpMarketAccount(perpPosition.marketIndex), 'base', this.getOracleDataForPerpMarket(perpPosition.marketIndex))[3]; // newPrice after swap
         }
         if (priceDelta.gt(markPriceAfterTrade)) {
             return new _1.BN(-1);
@@ -730,7 +738,7 @@ class ClearingHouseUser {
      * @returns : Precision PRICE_PRECISION
      */
     liquidationPriceAfterClose(positionMarketIndex, closeQuoteAmount) {
-        const currentPosition = this.getUserPosition(positionMarketIndex) ||
+        const currentPosition = this.getPerpPosition(positionMarketIndex) ||
             this.getEmptyPosition(positionMarketIndex);
         const closeBaseAmount = currentPosition.baseAssetAmount
             .mul(closeQuoteAmount)
@@ -765,7 +773,7 @@ class ClearingHouseUser {
      * @returns tradeSizeAllowed : Precision QUOTE_PRECISION
      */
     getMaxTradeSizeUSDC(targetMarketIndex, tradeSide) {
-        const currentPosition = this.getUserPosition(targetMarketIndex) ||
+        const currentPosition = this.getPerpPosition(targetMarketIndex) ||
             this.getEmptyPosition(targetMarketIndex);
         const targetSide = (0, types_1.isVariant)(tradeSide, 'short') ? 'short' : 'long';
         const currentPositionSide = (currentPosition === null || currentPosition === void 0 ? void 0 : currentPosition.baseAssetAmount.isNeg())
@@ -793,7 +801,7 @@ class ClearingHouseUser {
         else {
             // current leverage is greater than max leverage - can only reduce position size
             if (!targetingSameSide) {
-                const market = this.clearingHouse.getPerpMarketAccount(targetMarketIndex);
+                const market = this.driftClient.getPerpMarketAccount(targetMarketIndex);
                 const perpPositionValue = this.getPerpPositionValue(targetMarketIndex, oracleData);
                 const totalCollateral = this.getTotalCollateral();
                 const marginRequirement = this.getInitialMarginRequirement();
@@ -830,7 +838,7 @@ class ClearingHouseUser {
      * @returns leverageRatio : Precision TEN_THOUSAND
      */
     accountLeverageRatioAfterTrade(targetMarketIndex, tradeQuoteAmount, tradeSide, includeOpenOrders = true) {
-        const currentPosition = this.getUserPosition(targetMarketIndex) ||
+        const currentPosition = this.getPerpPosition(targetMarketIndex) ||
             this.getEmptyPosition(targetMarketIndex);
         const oracleData = this.getOracleDataForPerpMarket(targetMarketIndex);
         let currentPositionQuoteAmount = this.getPerpPositionValue(targetMarketIndex, oracleData);
@@ -864,7 +872,7 @@ class ClearingHouseUser {
      * @returns feeForQuote : Precision QUOTE_PRECISION
      */
     calculateFeeForQuoteAmount(quoteAmount) {
-        const feeTier = this.clearingHouse.getStateAccount().perpFeeStructure.feeTiers[0];
+        const feeTier = this.driftClient.getStateAccount().perpFeeStructure.feeTiers[0];
         return quoteAmount
             .mul(new _1.BN(feeTier.feeNumerator))
             .div(new _1.BN(feeTier.feeDenominator));
@@ -877,7 +885,7 @@ class ClearingHouseUser {
      */
     getWithdrawalLimit(marketIndex, reduceOnly) {
         const nowTs = new _1.BN(Math.floor(Date.now() / 1000));
-        const spotMarket = this.clearingHouse.getSpotMarketAccount(marketIndex);
+        const spotMarket = this.driftClient.getSpotMarketAccount(marketIndex);
         const { borrowLimit, withdrawLimit } = (0, spotBalance_1.calculateWithdrawLimit)(spotMarket, nowTs);
         const freeCollateral = this.getFreeCollateral();
         const oracleData = this.getOracleDataForSpotMarket(marketIndex);
@@ -891,7 +899,7 @@ class ClearingHouseUser {
         const userSpotPosition = this.getUserAccount().spotPositions.find((spotPosition) => (0, types_1.isVariant)(spotPosition.balanceType, 'deposit') &&
             spotPosition.marketIndex == marketIndex);
         const userSpotBalance = userSpotPosition
-            ? (0, spotBalance_1.getTokenAmount)(userSpotPosition.scaledBalance, this.clearingHouse.getSpotMarketAccount(marketIndex), _1.SpotBalanceType.DEPOSIT)
+            ? (0, spotBalance_1.getTokenAmount)(userSpotPosition.scaledBalance, this.driftClient.getSpotMarketAccount(marketIndex), _1.SpotBalanceType.DEPOSIT)
             : numericConstants_1.ZERO;
         const maxWithdrawValue = _1.BN.min(_1.BN.min(amountWithdrawable, userSpotBalance), withdrawLimit.abs());
         if (reduceOnly) {
@@ -918,7 +926,7 @@ class ClearingHouseUser {
      * @returns positionValue : Precision QUOTE_PRECISION
      */
     getTotalPerpPositionValueExcludingMarket(marketToIgnore, marginCategory, liquidationBuffer, includeOpenOrders) {
-        const currentPerpPosition = this.getUserPosition(marketToIgnore) ||
+        const currentPerpPosition = this.getPerpPosition(marketToIgnore) ||
             this.getEmptyPosition(marketToIgnore);
         const oracleData = this.getOracleDataForPerpMarket(marketToIgnore);
         let currentPerpPositionValueUSDC = numericConstants_1.ZERO;
@@ -928,14 +936,14 @@ class ClearingHouseUser {
         return this.getTotalPerpPositionValue(marginCategory, liquidationBuffer, includeOpenOrders).sub(currentPerpPositionValueUSDC);
     }
     getOracleDataForPerpMarket(marketIndex) {
-        const oracleKey = this.clearingHouse.getPerpMarketAccount(marketIndex).amm.oracle;
-        const oracleData = this.clearingHouse.getOraclePriceDataAndSlot(oracleKey).data;
+        const oracleKey = this.driftClient.getPerpMarketAccount(marketIndex).amm.oracle;
+        const oracleData = this.driftClient.getOraclePriceDataAndSlot(oracleKey).data;
         return oracleData;
     }
     getOracleDataForSpotMarket(marketIndex) {
-        const oracleKey = this.clearingHouse.getSpotMarketAccount(marketIndex).oracle;
-        const oracleData = this.clearingHouse.getOraclePriceDataAndSlot(oracleKey).data;
+        const oracleKey = this.driftClient.getSpotMarketAccount(marketIndex).oracle;
+        const oracleData = this.driftClient.getOraclePriceDataAndSlot(oracleKey).data;
         return oracleData;
     }
 }
-exports.ClearingHouseUser = ClearingHouseUser;
+exports.User = User;

package/lib/userConfig.d.ts

@@ -0,0 +1,14 @@
+import { DriftClient } from './driftClient';
+import { PublicKey } from '@solana/web3.js';
+import { BulkAccountLoader } from './accounts/bulkAccountLoader';
+export declare type UserConfig = {
+    accountSubscription?: UserSubscriptionConfig;
+    driftClient: DriftClient;
+    userAccountPublicKey: PublicKey;
+};
+export declare type UserSubscriptionConfig = {
+    type: 'websocket';
+} | {
+    type: 'polling';
+    accountLoader: BulkAccountLoader;
+};

package/lib/userMap/userMap.d.ts

@@ -1,41 +1,41 @@
-import { ClearingHouseUser, ClearingHouse, OrderRecord, ClearingHouseUserAccountSubscriptionConfig } from '..';
+import { User, DriftClient, OrderRecord, UserSubscriptionConfig } from '..';
 import { PublicKey } from '@solana/web3.js';
 export interface UserMapInterface {
     fetchAllUsers(): Promise<void>;
     addPubkey(userAccountPublicKey: PublicKey): Promise<void>;
     has(key: string): boolean;
-    get(key: string): ClearingHouseUser | undefined;
-    mustGet(key: string): Promise<ClearingHouseUser>;
+    get(key: string): User | undefined;
+    mustGet(key: string): Promise<User>;
     getUserAuthority(key: string): PublicKey | undefined;
     updateWithOrderRecord(record: OrderRecord): Promise<void>;
-    values(): IterableIterator<ClearingHouseUser>;
+    values(): IterableIterator<User>;
 }
 export declare class UserMap implements UserMapInterface {
     private userMap;
-    private clearingHouse;
+    private driftClient;
     private accountSubscription;
-    constructor(clearingHouse: ClearingHouse, accountSubscription: ClearingHouseUserAccountSubscriptionConfig);
+    constructor(driftClient: DriftClient, accountSubscription: UserSubscriptionConfig);
     fetchAllUsers(): Promise<void>;
     addPubkey(userAccountPublicKey: PublicKey): Promise<void>;
     has(key: string): boolean;
     /**
-     * gets the ClearingHouseUser for a particular userAccountPublicKey, if no ClearingHouseUser exists, undefined is returned
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
-     * @returns user ClearingHouseUser | undefined
+     * gets the User for a particular userAccountPublicKey, if no User exists, undefined is returned
+     * @param key userAccountPublicKey to get User for
+     * @returns user User | undefined
      */
-    get(key: string): ClearingHouseUser | undefined;
+    get(key: string): User | undefined;
     /**
-     * gets the ClearingHouseUser for a particular userAccountPublicKey, if no ClearingHouseUser exists, new one is created
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
-     * @returns  ClearingHouseUser
+     * gets the User for a particular userAccountPublicKey, if no User exists, new one is created
+     * @param key userAccountPublicKey to get User for
+     * @returns  User
      */
-    mustGet(key: string): Promise<ClearingHouseUser>;
+    mustGet(key: string): Promise<User>;
     /**
-     * gets the Authority for a particular userAccountPublicKey, if no ClearingHouseUser exists, undefined is returned
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
+     * gets the Authority for a particular userAccountPublicKey, if no User exists, undefined is returned
+     * @param key userAccountPublicKey to get User for
      * @returns authority PublicKey | undefined
      */
     getUserAuthority(key: string): PublicKey | undefined;
     updateWithOrderRecord(record: OrderRecord): Promise<void>;
-    values(): IterableIterator<ClearingHouseUser>;
+    values(): IterableIterator<User>;
 }

package/lib/userMap/userMap.js

@@ -4,20 +4,20 @@ exports.UserMap = void 0;
 const __1 = require("..");
 const web3_js_1 = require("@solana/web3.js");
 class UserMap {
-    constructor(clearingHouse, accountSubscription) {
+    constructor(driftClient, accountSubscription) {
         this.userMap = new Map();
-        this.clearingHouse = clearingHouse;
+        this.driftClient = driftClient;
         this.accountSubscription = accountSubscription;
     }
     async fetchAllUsers() {
         const userArray = [];
-        const programUserAccounts = (await this.clearingHouse.program.account.user.all());
+        const programUserAccounts = (await this.driftClient.program.account.user.all());
         for (const programUserAccount of programUserAccounts) {
             if (this.userMap.has(programUserAccount.publicKey.toString())) {
                 continue;
             }
-            const user = new __1.ClearingHouseUser({
-                clearingHouse: this.clearingHouse,
+            const user = new __1.User({
+                driftClient: this.driftClient,
                 userAccountPublicKey: programUserAccount.publicKey,
                 accountSubscription: this.accountSubscription,
             });
@@ -31,8 +31,8 @@ class UserMap {
         }
     }
     async addPubkey(userAccountPublicKey) {
-        const user = new __1.ClearingHouseUser({
-            clearingHouse: this.clearingHouse,
+        const user = new __1.User({
+            driftClient: this.driftClient,
             userAccountPublicKey,
             accountSubscription: this.accountSubscription,
         });
@@ -43,17 +43,17 @@ class UserMap {
         return this.userMap.has(key);
     }
     /**
-     * gets the ClearingHouseUser for a particular userAccountPublicKey, if no ClearingHouseUser exists, undefined is returned
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
-     * @returns user ClearingHouseUser | undefined
+     * gets the User for a particular userAccountPublicKey, if no User exists, undefined is returned
+     * @param key userAccountPublicKey to get User for
+     * @returns user User | undefined
      */
     get(key) {
         return this.userMap.get(key);
     }
     /**
-     * gets the ClearingHouseUser for a particular userAccountPublicKey, if no ClearingHouseUser exists, new one is created
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
-     * @returns  ClearingHouseUser
+     * gets the User for a particular userAccountPublicKey, if no User exists, new one is created
+     * @param key userAccountPublicKey to get User for
+     * @returns  User
      */
     async mustGet(key) {
         if (!this.has(key)) {
@@ -64,8 +64,8 @@ class UserMap {
         return user;
     }
     /**
-     * gets the Authority for a particular userAccountPublicKey, if no ClearingHouseUser exists, undefined is returned
-     * @param key userAccountPublicKey to get ClearngHouseUserFor
+     * gets the Authority for a particular userAccountPublicKey, if no User exists, undefined is returned
+     * @param key userAccountPublicKey to get User for
      * @returns authority PublicKey | undefined
      */
     getUserAuthority(key) {

package/lib/userMap/userStatsMap.d.ts

@@ -1,19 +1,19 @@
-import { ClearingHouse, OrderRecord, ClearingHouseUserStats, ClearingHouseUserStatsAccountSubscriptionConfig } from '..';
+import { DriftClient, OrderRecord, UserStats, UserStatsSubscriptionConfig } from '..';
 import { PublicKey } from '@solana/web3.js';
 import { UserMap } from './userMap';
 export declare class UserStatsMap {
     /**
-     * map from authority pubkey to ClearingHouseUserStats
+     * map from authority pubkey to UserStats
      */
     private userStatsMap;
-    private clearingHouse;
+    private driftClient;
     private accountSubscription;
-    constructor(clearingHouse: ClearingHouse, accountSubscription: ClearingHouseUserStatsAccountSubscriptionConfig);
+    constructor(driftClient: DriftClient, accountSubscription: UserStatsSubscriptionConfig);
     fetchAllUserStats(): Promise<void>;
     addUserStat(authority: PublicKey): Promise<void>;
     updateWithOrderRecord(record: OrderRecord, userMap: UserMap): Promise<void>;
     has(authorityPublicKey: string): boolean;
-    get(authorityPublicKey: string): ClearingHouseUserStats;
-    mustGet(authorityPublicKey: string): Promise<ClearingHouseUserStats>;
-    values(): IterableIterator<ClearingHouseUserStats>;
+    get(authorityPublicKey: string): UserStats;
+    mustGet(authorityPublicKey: string): Promise<UserStats>;
+    values(): IterableIterator<UserStats>;
 }

package/lib/userMap/userStatsMap.js

@@ -4,25 +4,25 @@ exports.UserStatsMap = void 0;
 const __1 = require("..");
 const web3_js_1 = require("@solana/web3.js");
 class UserStatsMap {
-    constructor(clearingHouse, accountSubscription) {
+    constructor(driftClient, accountSubscription) {
         /**
-         * map from authority pubkey to ClearingHouseUserStats
+         * map from authority pubkey to UserStats
          */
         this.userStatsMap = new Map();
-        this.clearingHouse = clearingHouse;
+        this.driftClient = driftClient;
         this.accountSubscription = accountSubscription;
     }
     async fetchAllUserStats() {
         const userStatArray = [];
-        const programUserAccounts = (await this.clearingHouse.program.account.userStats.all());
+        const programUserAccounts = (await this.driftClient.program.account.userStats.all());
         for (const programUserAccount of programUserAccounts) {
             const userStat = programUserAccount.account;
             if (this.userStatsMap.has(userStat.authority.toString())) {
                 continue;
             }
-            const chUserStat = new __1.ClearingHouseUserStats({
-                clearingHouse: this.clearingHouse,
-                userStatsAccountPublicKey: (0, __1.getUserStatsAccountPublicKey)(this.clearingHouse.program.programId, userStat.authority),
+            const chUserStat = new __1.UserStats({
+                driftClient: this.driftClient,
+                userStatsAccountPublicKey: (0, __1.getUserStatsAccountPublicKey)(this.driftClient.program.programId, userStat.authority),
                 accountSubscription: this.accountSubscription,
             });
             userStatArray.push(chUserStat);
@@ -35,9 +35,9 @@ class UserStatsMap {
         }
     }
     async addUserStat(authority) {
-        const userStat = new __1.ClearingHouseUserStats({
-            clearingHouse: this.clearingHouse,
-            userStatsAccountPublicKey: (0, __1.getUserStatsAccountPublicKey)(this.clearingHouse.program.programId, authority),
+        const userStat = new __1.UserStats({
+            driftClient: this.driftClient,
+            userStatsAccountPublicKey: (0, __1.getUserStatsAccountPublicKey)(this.driftClient.program.programId, authority),
             accountSubscription: this.accountSubscription,
         });
         await userStat.subscribe();

package/lib/{clearingHouseUserStats.d.ts → userStats.d.ts}

@@ -1,14 +1,14 @@
-import { ClearingHouse } from './clearingHouse';
+import { DriftClient } from './driftClient';
 import { PublicKey } from '@solana/web3.js';
 import { DataAndSlot, UserStatsAccountSubscriber } from './accounts/types';
-import { ClearingHouseUserStatsConfig } from './clearingHouseUserStatsConfig';
+import { UserStatsConfig } from './userStatsConfig';
 import { ReferrerInfo, UserStatsAccount } from './types';
-export declare class ClearingHouseUserStats {
-    clearingHouse: ClearingHouse;
+export declare class UserStats {
+    driftClient: DriftClient;
     userStatsAccountPublicKey: PublicKey;
     accountSubscriber: UserStatsAccountSubscriber;
     isSubscribed: boolean;
-    constructor(config: ClearingHouseUserStatsConfig);
+    constructor(config: UserStatsConfig);
     subscribe(): Promise<boolean>;
     fetchAccounts(): Promise<void>;
     unsubscribe(): Promise<void>;

package/lib/{clearingHouseUserStats.js → userStats.js}

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClearingHouseUserStats = void 0;
+exports.UserStats = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const pollingUserStatsAccountSubscriber_1 = require("./accounts/pollingUserStatsAccountSubscriber");
 const webSocketUserStatsAccountSubsriber_1 = require("./accounts/webSocketUserStatsAccountSubsriber");
 const pda_1 = require("./addresses/pda");
-class ClearingHouseUserStats {
+class UserStats {
     constructor(config) {
         var _a;
-        this.clearingHouse = config.clearingHouse;
+        this.driftClient = config.driftClient;
         this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
         if (((_a = config.accountSubscription) === null || _a === void 0 ? void 0 : _a.type) === 'polling') {
-            this.accountSubscriber = new pollingUserStatsAccountSubscriber_1.PollingUserStatsAccountSubscriber(config.clearingHouse.program, config.userStatsAccountPublicKey, config.accountSubscription.accountLoader);
+            this.accountSubscriber = new pollingUserStatsAccountSubscriber_1.PollingUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey, config.accountSubscription.accountLoader);
         }
         else {
-            this.accountSubscriber = new webSocketUserStatsAccountSubsriber_1.WebSocketUserStatsAccountSubscriber(config.clearingHouse.program, config.userStatsAccountPublicKey);
+            this.accountSubscriber = new webSocketUserStatsAccountSubsriber_1.WebSocketUserStatsAccountSubscriber(config.driftClient.program, config.userStatsAccountPublicKey);
         }
     }
     async subscribe() {
@@ -40,10 +40,10 @@ class ClearingHouseUserStats {
         }
         else {
             return {
-                referrer: (0, pda_1.getUserAccountPublicKeySync)(this.clearingHouse.program.programId, this.getAccount().referrer, 0),
-                referrerStats: (0, pda_1.getUserStatsAccountPublicKey)(this.clearingHouse.program.programId, this.getAccount().referrer),
+                referrer: (0, pda_1.getUserAccountPublicKeySync)(this.driftClient.program.programId, this.getAccount().referrer, 0),
+                referrerStats: (0, pda_1.getUserStatsAccountPublicKey)(this.driftClient.program.programId, this.getAccount().referrer),
             };
         }
     }
 }
-exports.ClearingHouseUserStats = ClearingHouseUserStats;
+exports.UserStats = UserStats;

package/lib/userStatsConfig.d.ts

@@ -0,0 +1,14 @@
+import { DriftClient } from './driftClient';
+import { PublicKey } from '@solana/web3.js';
+import { BulkAccountLoader } from './accounts/bulkAccountLoader';
+export declare type UserStatsConfig = {
+    accountSubscription?: UserStatsSubscriptionConfig;
+    driftClient: DriftClient;
+    userStatsAccountPublicKey: PublicKey;
+};
+export declare type UserStatsSubscriptionConfig = {
+    type: 'websocket';
+} | {
+    type: 'polling';
+    accountLoader: BulkAccountLoader;
+};