@drift-labs/sdk 0.2.0-master.19 → 0.2.0-master.21

package/lib/accounts/types.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
-/// <reference types="node" />
 import { BankAccount, MarketAccount, OracleSource, StateAccount, UserAccount, UserStatsAccount } from '../types';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';

package/lib/clearingHouse.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
 import { AnchorProvider, BN, Program } from '@project-serum/anchor';
-import { StateAccount, IWallet, PositionDirection, UserAccount, MarketAccount, OrderParams, Order, BankAccount, UserBankBalance, MakerInfo, TakerInfo, OptionalOrderParams } from './types';
+import { StateAccount, IWallet, PositionDirection, UserAccount, MarketAccount, OrderParams, Order, BankAccount, UserBankBalance, MakerInfo, TakerInfo, OptionalOrderParams, ReferrerInfo } from './types';
 import { Connection, PublicKey, TransactionSignature, ConfirmOptions, TransactionInstruction, AccountMeta } from '@solana/web3.js';
 import { TokenFaucet } from './tokenFaucet';
 import { EventEmitter } from 'events';
@@ -62,8 +62,8 @@ export declare class ClearingHouse {
     updateWallet(newWallet: IWallet, userIds?: number[], activeUserId?: number): Promise<void>;
     switchActiveUser(userId: number): Promise<void>;
     addUser(userId: number): Promise<void>;
-    initializeUserAccount(userId?: number, name?: string): Promise<[TransactionSignature, PublicKey]>;
-    getInitializeUserInstructions(userId?: number, name?: string): Promise<[PublicKey, TransactionInstruction]>;
+    initializeUserAccount(userId?: number, name?: string, referrerInfo?: ReferrerInfo): Promise<[TransactionSignature, PublicKey]>;
+    getInitializeUserInstructions(userId?: number, name?: string, referrerInfo?: ReferrerInfo): Promise<[PublicKey, TransactionInstruction]>;
     getInitializeUserStatsIx(): Promise<TransactionInstruction>;
     getUser(userId?: number): ClearingHouseUser;
     getUsers(): ClearingHouseUser[];
@@ -97,8 +97,8 @@ export declare class ClearingHouse {
      * @param fromUserId
      * @returns
      */
-    initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, bankIndex?: BN, userId?: number, name?: string, fromUserId?: number): Promise<[TransactionSignature, PublicKey]>;
-    initializeUserAccountForDevnet(userId: number, name: string, bankIndex: BN, tokenFaucet: TokenFaucet, amount: BN): Promise<[TransactionSignature, PublicKey]>;
+    initializeUserAccountAndDepositCollateral(amount: BN, userTokenAccount: PublicKey, bankIndex?: BN, userId?: number, name?: string, fromUserId?: number, referrerInfo?: ReferrerInfo): Promise<[TransactionSignature, PublicKey]>;
+    initializeUserAccountForDevnet(userId: number, name: string, bankIndex: BN, tokenFaucet: TokenFaucet, amount: BN, referrerInfo?: ReferrerInfo): Promise<[TransactionSignature, PublicKey]>;
     withdraw(amount: BN, bankIndex: BN, userTokenAccount: PublicKey, reduceOnly?: boolean): Promise<TransactionSignature>;
     getWithdrawIx(amount: BN, bankIndex: BN, userTokenAccount: PublicKey, reduceOnly?: boolean): Promise<TransactionInstruction>;
     transferDeposit(amount: BN, bankIndex: BN, fromUserId: number, toUserId: number): Promise<TransactionSignature>;
@@ -121,14 +121,14 @@ export declare class ClearingHouse {
     getCancelOrderIx(orderId?: BN): Promise<TransactionInstruction>;
     cancelOrderByUserId(userOrderId: number): Promise<TransactionSignature>;
     getCancelOrderByUserIdIx(userOrderId: number): Promise<TransactionInstruction>;
-    fillOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Order, makerInfo?: MakerInfo): Promise<TransactionSignature>;
-    getFillOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order, makerInfo?: MakerInfo): Promise<TransactionInstruction>;
+    fillOrder(userAccountPublicKey: PublicKey, user: UserAccount, order?: Order, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionSignature>;
+    getFillOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>;
     triggerOrder(userAccountPublicKey: PublicKey, user: UserAccount, order: Order): Promise<TransactionSignature>;
     getTriggerOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order): Promise<TransactionInstruction>;
-    placeAndTake(orderParams: OptionalOrderParams, makerInfo?: MakerInfo): Promise<TransactionSignature>;
-    getPlaceAndTakeIx(orderParams: OptionalOrderParams, makerInfo?: MakerInfo): Promise<TransactionInstruction>;
-    placeAndMake(orderParams: OptionalOrderParams, takerInfo: TakerInfo): Promise<TransactionSignature>;
-    getPlaceAndMakeIx(orderParams: OptionalOrderParams, takerInfo: TakerInfo): Promise<TransactionInstruction>;
+    placeAndTake(orderParams: OptionalOrderParams, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionSignature>;
+    getPlaceAndTakeIx(orderParams: OptionalOrderParams, makerInfo?: MakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>;
+    placeAndMake(orderParams: OptionalOrderParams, takerInfo: TakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionSignature>;
+    getPlaceAndMakeIx(orderParams: OptionalOrderParams, takerInfo: TakerInfo, referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>;
     /**
      * Close an entire position. If you want to reduce a position, use the {@link openPosition} method in the opposite direction of the current position.
      * @param marketIndex
@@ -153,8 +153,8 @@ export declare class ClearingHouse {
     getResolvePerpBankruptcyIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, marketIndex: BN): Promise<TransactionInstruction>;
     resolveBorrowBankruptcy(userAccountPublicKey: PublicKey, userAccount: UserAccount, bankIndex: BN): Promise<TransactionSignature>;
     getResolveBorrowBankruptcyIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, bankIndex: BN): Promise<TransactionInstruction>;
-    getRemainingAccountsForLiquidation(params: {
-        userAccount: UserAccount;
+    getRemainingAccountsWithCounterparty(params: {
+        counterPartyUserAccount: UserAccount;
         writableMarketIndex?: BN;
         writableBankIndexes?: BN[];
     }): AccountMeta[];

package/lib/clearingHouse.js

@@ -133,9 +133,13 @@ class ClearingHouse {
      *	Forces the accountSubscriber to fetch account updates from rpc
      */
     async fetchAccounts() {
-        await Promise.all([...this.users.values()]
+        const promises = [...this.users.values()]
             .map((user) => user.fetchAccounts())
-            .concat(this.accountSubscriber.fetch()));
+            .concat(this.accountSubscriber.fetch());
+        if (this.userStats) {
+            promises.concat(this.userStats.fetchAccounts());
+        }
+        await Promise.all(promises);
     }
     async unsubscribe() {
         const unsubscribePromises = this.unsubscribeUsers().concat(this.accountSubscriber.unsubscribe());
@@ -215,8 +219,8 @@ class ClearingHouse {
         await user.subscribe();
         this.users.set(userId, user);
     }
-    async initializeUserAccount(userId = 0, name = userName_1.DEFAULT_USER_NAME) {
-        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name);
+    async initializeUserAccount(userId = 0, name = userName_1.DEFAULT_USER_NAME, referrerInfo) {
+        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name, referrerInfo);
         const tx = new web3_js_1.Transaction();
         if (userId === 0) {
             // not the safest assumption, can explicitly check if user stats account exists if it causes problems
@@ -226,8 +230,21 @@ class ClearingHouse {
         const { txSig } = await this.txSender.send(tx, [], this.opts);
         return [txSig, userAccountPublicKey];
     }
-    async getInitializeUserInstructions(userId = 0, name = userName_1.DEFAULT_USER_NAME) {
+    async getInitializeUserInstructions(userId = 0, name = userName_1.DEFAULT_USER_NAME, referrerInfo) {
         const userAccountPublicKey = await (0, pda_1.getUserAccountPublicKey)(this.program.programId, this.wallet.publicKey, userId);
+        const remainingAccounts = new Array();
+        if (referrerInfo !== undefined) {
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrer,
+                isWritable: true,
+                isSigner: false,
+            });
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrerStats,
+                isWritable: true,
+                isSigner: false,
+            });
+        }
         const nameBuffer = (0, userName_1.encodeName)(name);
         const initializeUserAccountIx = await this.program.instruction.initializeUser(userId, nameBuffer, {
             accounts: {
@@ -239,6 +256,7 @@ class ClearingHouse {
                 systemProgram: anchor.web3.SystemProgram.programId,
                 state: await this.getStatePublicKey(),
             },
+            remainingAccounts,
         });
         return [userAccountPublicKey, initializeUserAccountIx];
     }
@@ -466,6 +484,7 @@ class ClearingHouse {
                 bank: bank.pubkey,
                 bankVault: bank.vault,
                 user: userAccountPublicKey,
+                userStats: this.getUserStatsAccountPublicKey(),
                 userTokenAccount: userTokenAccount,
                 authority: this.wallet.publicKey,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
@@ -535,8 +554,8 @@ class ClearingHouse {
      * @param fromUserId
      * @returns
      */
-    async initializeUserAccountAndDepositCollateral(amount, userTokenAccount, bankIndex = new anchor_1.BN(0), userId = 0, name = userName_1.DEFAULT_USER_NAME, fromUserId) {
-        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name);
+    async initializeUserAccountAndDepositCollateral(amount, userTokenAccount, bankIndex = new anchor_1.BN(0), userId = 0, name = userName_1.DEFAULT_USER_NAME, fromUserId, referrerInfo) {
+        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name, referrerInfo);
         const additionalSigners = [];
         const bank = this.getBankAccount(bankIndex);
         const isSolBank = bank.mint.equals(banks_1.WRAPPED_SOL_MINT);
@@ -565,9 +584,9 @@ class ClearingHouse {
         const { txSig } = await this.txSender.send(tx, additionalSigners, this.opts);
         return [txSig, userAccountPublicKey];
     }
-    async initializeUserAccountForDevnet(userId = 0, name = userName_1.DEFAULT_USER_NAME, bankIndex, tokenFaucet, amount) {
+    async initializeUserAccountForDevnet(userId = 0, name = userName_1.DEFAULT_USER_NAME, bankIndex, tokenFaucet, amount, referrerInfo) {
         const [associateTokenPublicKey, createAssociatedAccountIx, mintToIx] = await tokenFaucet.createAssociatedTokenAccountAndMintToInstructions(this.wallet.publicKey, amount);
-        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name);
+        const [userAccountPublicKey, initializeUserAccountIx] = await this.getInitializeUserInstructions(userId, name, referrerInfo);
         const depositCollateralIx = await this.getDepositInstruction(amount, bankIndex, associateTokenPublicKey, userId, false, false);
         const tx = new web3_js_1.Transaction().add(createAssociatedAccountIx).add(mintToIx);
         if (userId === 0) {
@@ -614,6 +633,7 @@ class ClearingHouse {
                 bankVault: bank.vault,
                 bankVaultAuthority: bank.vaultAuthority,
                 user: userAccountPublicKey,
+                userStats: this.getUserStatsAccountPublicKey(),
                 userTokenAccount: userTokenAccount,
                 authority: this.wallet.publicKey,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
@@ -636,6 +656,7 @@ class ClearingHouse {
                 authority: this.wallet.publicKey,
                 fromUser,
                 toUser,
+                userStats: this.getUserStatsAccountPublicKey(),
                 state: await this.getStatePublicKey(),
             },
             remainingAccounts,
@@ -831,15 +852,17 @@ class ClearingHouse {
             remainingAccounts,
         });
     }
-    async fillOrder(userAccountPublicKey, user, order, makerInfo) {
-        const { txSig } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getFillOrderIx(userAccountPublicKey, user, order, makerInfo)), [], this.opts);
+    async fillOrder(userAccountPublicKey, user, order, makerInfo, referrerInfo) {
+        const { txSig } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getFillOrderIx(userAccountPublicKey, user, order, makerInfo, referrerInfo)), [], this.opts);
         return txSig;
     }
-    async getFillOrderIx(userAccountPublicKey, userAccount, order, makerInfo) {
+    async getFillOrderIx(userAccountPublicKey, userAccount, order, makerInfo, referrerInfo) {
         const userStatsPublicKey = (0, pda_1.getUserStatsAccountPublicKey)(this.program.programId, userAccount.authority);
         const fillerPublicKey = await this.getUserAccountPublicKey();
         const fillerStatsPublicKey = this.getUserStatsAccountPublicKey();
-        const marketIndex = order.marketIndex;
+        const marketIndex = order
+            ? order.marketIndex
+            : userAccount.orders.find((order) => order.orderId.eq(userAccount.nextOrderId.sub(numericConstants_1.ONE))).marketIndex;
         const marketAccount = this.getMarketAccount(marketIndex);
         const oracleAccountMap = new Map();
         const bankAccountMap = new Map();
@@ -904,6 +927,18 @@ class ClearingHouse {
                 isSigner: false,
             });
         }
+        if (referrerInfo) {
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrer,
+                isWritable: true,
+                isSigner: false,
+            });
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrerStats,
+                isWritable: true,
+                isSigner: false,
+            });
+        }
         const orderId = order.orderId;
         const makerOrderId = makerInfo ? makerInfo.order.orderId : null;
         return await this.program.instruction.fillOrder(orderId, makerOrderId, {
@@ -988,12 +1023,12 @@ class ClearingHouse {
             remainingAccounts,
         });
     }
-    async placeAndTake(orderParams, makerInfo) {
-        const { txSig, slot } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getPlaceAndTakeIx(orderParams, makerInfo)), [], this.opts);
+    async placeAndTake(orderParams, makerInfo, referrerInfo) {
+        const { txSig, slot } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getPlaceAndTakeIx(orderParams, makerInfo, referrerInfo)), [], this.opts);
         this.marketLastSlotCache.set(orderParams.marketIndex.toNumber(), slot);
         return txSig;
     }
-    async getPlaceAndTakeIx(orderParams, makerInfo) {
+    async getPlaceAndTakeIx(orderParams, makerInfo, referrerInfo) {
         orderParams = this.getOrderParams(orderParams);
         const userStatsPublicKey = await this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
@@ -1015,6 +1050,18 @@ class ClearingHouse {
                 isWritable: true,
             });
         }
+        if (referrerInfo) {
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrer,
+                isWritable: true,
+                isSigner: false,
+            });
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrerStats,
+                isWritable: true,
+                isSigner: false,
+            });
+        }
         return await this.program.instruction.placeAndTake(orderParams, makerOrderId, {
             accounts: {
                 state: await this.getStatePublicKey(),
@@ -1025,18 +1072,32 @@ class ClearingHouse {
             remainingAccounts,
         });
     }
-    async placeAndMake(orderParams, takerInfo) {
-        const { txSig, slot } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getPlaceAndMakeIx(orderParams, takerInfo)), [], this.opts);
+    async placeAndMake(orderParams, takerInfo, referrerInfo) {
+        const { txSig, slot } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getPlaceAndMakeIx(orderParams, takerInfo, referrerInfo)), [], this.opts);
         this.marketLastSlotCache.set(orderParams.marketIndex.toNumber(), slot);
         return txSig;
     }
-    async getPlaceAndMakeIx(orderParams, takerInfo) {
+    async getPlaceAndMakeIx(orderParams, takerInfo, referrerInfo) {
         orderParams = this.getOrderParams(orderParams);
         const userStatsPublicKey = this.getUserStatsAccountPublicKey();
         const userAccountPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccounts({
+        // todo merge this with getRemainingAccounts
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
+            counterPartyUserAccount: takerInfo.takerUserAccount,
             writableMarketIndex: orderParams.marketIndex,
         });
+        if (referrerInfo) {
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrer,
+                isWritable: true,
+                isSigner: false,
+            });
+            remainingAccounts.push({
+                pubkey: referrerInfo.referrerStats,
+                isWritable: true,
+                isSigner: false,
+            });
+        }
         const takerOrderId = takerInfo.order.orderId;
         return await this.program.instruction.placeAndMake(orderParams, takerOrderId, {
             accounts: {
@@ -1076,7 +1137,7 @@ class ClearingHouse {
         }
         const tx = new web3_js_1.Transaction()
             .add(web3_js_1.ComputeBudgetProgram.requestUnits({
-            units: 1200000,
+            units: 1000000,
             additionalFee: 0,
         }))
             .add(...ixs);
@@ -1161,9 +1222,9 @@ class ClearingHouse {
         const userStatsPublicKey = (0, pda_1.getUserStatsAccountPublicKey)(this.program.programId, userAccount.authority);
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
         const liquidatorStatsPublicKey = this.getUserStatsAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
             writableMarketIndex: marketIndex,
-            userAccount,
+            counterPartyUserAccount: userAccount,
         });
         return await this.program.instruction.liquidatePerp(marketIndex, maxBaseAssetAmount, {
             accounts: {
@@ -1183,8 +1244,8 @@ class ClearingHouse {
     }
     async getLiquidateBorrowIx(userAccountPublicKey, userAccount, assetBankIndex, liabilityBankIndex, maxLiabilityTransfer) {
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
-            userAccount,
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
+            counterPartyUserAccount: userAccount,
             writableBankIndexes: [liabilityBankIndex, assetBankIndex],
         });
         return await this.program.instruction.liquidateBorrow(assetBankIndex, liabilityBankIndex, maxLiabilityTransfer, {
@@ -1203,8 +1264,8 @@ class ClearingHouse {
     }
     async getLiquidateBorrowForPerpPnlIx(userAccountPublicKey, userAccount, perpMarketIndex, liabilityBankIndex, maxLiabilityTransfer) {
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
-            userAccount,
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
+            counterPartyUserAccount: userAccount,
             writableMarketIndex: perpMarketIndex,
             writableBankIndexes: [liabilityBankIndex],
         });
@@ -1224,8 +1285,8 @@ class ClearingHouse {
     }
     async getLiquidatePerpPnlForDepositIx(userAccountPublicKey, userAccount, perpMarketIndex, assetBankIndex, maxPnlTransfer) {
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
-            userAccount,
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
+            counterPartyUserAccount: userAccount,
             writableMarketIndex: perpMarketIndex,
             writableBankIndexes: [assetBankIndex],
         });
@@ -1245,9 +1306,9 @@ class ClearingHouse {
     }
     async getResolvePerpBankruptcyIx(userAccountPublicKey, userAccount, marketIndex) {
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
             writableMarketIndex: marketIndex,
-            userAccount,
+            counterPartyUserAccount: userAccount,
         });
         return await this.program.instruction.resolvePerpBankruptcy(marketIndex, {
             accounts: {
@@ -1265,9 +1326,9 @@ class ClearingHouse {
     }
     async getResolveBorrowBankruptcyIx(userAccountPublicKey, userAccount, bankIndex) {
         const liquidatorPublicKey = await this.getUserAccountPublicKey();
-        const remainingAccounts = this.getRemainingAccountsForLiquidation({
+        const remainingAccounts = this.getRemainingAccountsWithCounterparty({
             writableBankIndexes: [bankIndex],
-            userAccount,
+            counterPartyUserAccount: userAccount,
         });
         return await this.program.instruction.resolveBorrowBankruptcy(bankIndex, {
             accounts: {
@@ -1279,12 +1340,12 @@ class ClearingHouse {
             remainingAccounts: remainingAccounts,
         });
     }
-    getRemainingAccountsForLiquidation(params) {
-        const liquidateeUserAccount = params.userAccount;
+    getRemainingAccountsWithCounterparty(params) {
+        const counterPartyUserAccount = params.counterPartyUserAccount;
         const oracleAccountMap = new Map();
         const bankAccountMap = new Map();
         const marketAccountMap = new Map();
-        for (const bankBalance of liquidateeUserAccount.bankBalances) {
+        for (const bankBalance of counterPartyUserAccount.bankBalances) {
             if (!bankBalance.balance.eq(numericConstants_1.ZERO)) {
                 const bankAccount = this.getBankAccount(bankBalance.bankIndex);
                 bankAccountMap.set(bankBalance.bankIndex.toNumber(), {
@@ -1301,7 +1362,7 @@ class ClearingHouse {
                 }
             }
         }
-        for (const position of liquidateeUserAccount.positions) {
+        for (const position of counterPartyUserAccount.positions) {
             if (!(0, position_1.positionIsAvailable)(position)) {
                 const market = this.getMarketAccount(position.marketIndex);
                 marketAccountMap.set(position.marketIndex.toNumber(), {

package/lib/clearingHouseUser.d.ts

@@ -37,6 +37,7 @@ export declare class ClearingHouseUser {
      */
     getUserPosition(marketIndex: BN): UserPosition | undefined;
     getEmptyPosition(marketIndex: BN): UserPosition;
+    getClonedPosition(position: UserPosition): UserPosition;
     /**
      * @param orderId
      * @returns Order
@@ -53,7 +54,7 @@ export declare class ClearingHouseUser {
      * calculates the market position if the lp position was settled
      * @returns : userPosition
      */
-    getSettledLPPosition(marketIndex: BN): [UserPosition, BN];
+    getSettledLPPosition(marketIndex: BN): [UserPosition, BN, BN];
     /**
      * calculates Buying Power = FC * MAX_LEVERAGE
      * @returns : Precision QUOTE_PRECISION
@@ -64,6 +65,13 @@ export declare class ClearingHouseUser {
      * @returns : Precision QUOTE_PRECISION
      */
     getFreeCollateral(): BN;
+    /**
+     * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
+     */
+    getMarginRequirement(type: MarginCategory): BN;
+    /**
+     * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
+     */
     getInitialMarginRequirement(): BN;
     /**
      * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION

package/lib/clearingHouseUser.js

@@ -78,6 +78,10 @@ class ClearingHouseUser {
             lastNetQuoteAssetAmountPerLp: numericConstants_1.ZERO,
         };
     }
+    getClonedPosition(position) {
+        const clonedPosition = Object.assign({}, position);
+        return clonedPosition;
+    }
     /**
      * @param orderId
      * @returns Order
@@ -104,7 +108,8 @@ class ClearingHouseUser {
      * @returns : userPosition
      */
     getSettledLPPosition(marketIndex) {
-        const position = this.getUserPosition(marketIndex);
+        const _position = this.getUserPosition(marketIndex);
+        const position = this.getClonedPosition(_position);
         const market = this.clearingHouse.getMarketAccount(position.marketIndex);
         const nShares = position.lpShares;
         const deltaBaa = market.amm.marketPositionPerLp.baseAssetAmount
@@ -180,7 +185,7 @@ class ClearingHouseUser {
         else {
             position.lastCumulativeFundingRate = numericConstants_1.ZERO;
         }
-        return [position, pnl];
+        return [position, remainderBaa, pnl];
     }
     /**
      * calculates Buying Power = FC * MAX_LEVERAGE
@@ -201,37 +206,69 @@ class ClearingHouseUser {
         const freeCollateral = totalCollateral.sub(initialMarginRequirement);
         return freeCollateral.gte(numericConstants_1.ZERO) ? freeCollateral : numericConstants_1.ZERO;
     }
-    getInitialMarginRequirement() {
-        const postionMarginRequirement = this.getUserAccount().positions.reduce((marginRequirement, marketPosition) => {
-            const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            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));
-            const marketMarginRatio = new _1.BN((0, _1.calculateMarketMarginRatio)(market, worstCaseBaseAssetAmount.abs(), 'Initial'));
-            return marginRequirement.add(worstCaseAssetValue.mul(marketMarginRatio).div(numericConstants_1.MARGIN_PRECISION));
-        }, numericConstants_1.ZERO);
-        const bankMarginRequirement = this.getBankLiabilityValue(undefined, 'Initial');
-        return bankMarginRequirement.add(postionMarginRequirement);
-    }
     /**
-     * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION
+     * @returns The margin requirement of a certain type (Initial or Maintenance) in USDC. : QUOTE_PRECISION
      */
-    getMaintenanceMarginRequirement() {
+    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(), 'Maintenance')))
+                .mul(new _1.BN((0, _1.calculateMarketMarginRatio)(market, worstCaseBaseAssetAmount.abs(), type)))
                 .div(numericConstants_1.MARGIN_PRECISION));
         }, numericConstants_1.ZERO)
-            .add(this.getBankLiabilityValue(undefined, 'Maintenance'));
+            .add(this.getBankLiabilityValue(undefined, type));
+    }
+    /**
+     * @returns The initial margin requirement in USDC. : QUOTE_PRECISION
+     */
+    getInitialMarginRequirement() {
+        return this.getMarginRequirement('Initial');
+    }
+    /**
+     * @returns The maintenance margin requirement in USDC. : QUOTE_PRECISION
+     */
+    getMaintenanceMarginRequirement() {
+        return this.getMarginRequirement('Maintenance');
     }
     /**
      * calculates unrealized position price pnl
@@ -240,17 +277,17 @@ class ClearingHouseUser {
     getUnrealizedPNL(withFunding, marketIndex, withWeightMarginCategory) {
         return this.getUserAccount()
             .positions.filter((pos) => marketIndex ? pos.marketIndex === marketIndex : true)
-            .reduce((pnl, marketPosition) => {
+            .reduce((unrealizedPnl, marketPosition) => {
             const market = this.clearingHouse.getMarketAccount(marketPosition.marketIndex);
-            let pnl0 = (0, _1.calculatePositionPNL)(market, marketPosition, withFunding, this.getOracleDataForMarket(market.marketIndex));
+            let positionUnrealizedPnl = (0, _1.calculatePositionPNL)(market, marketPosition, withFunding, this.getOracleDataForMarket(market.marketIndex));
             if (withWeightMarginCategory !== undefined) {
-                if (pnl0.gt(numericConstants_1.ZERO)) {
-                    pnl0 = pnl0
-                        .mul((0, _1.calculateUnsettledAssetWeight)(market, pnl0, withWeightMarginCategory))
+                if (positionUnrealizedPnl.gt(numericConstants_1.ZERO)) {
+                    positionUnrealizedPnl = positionUnrealizedPnl
+                        .mul((0, _1.calculateUnrealizedAssetWeight)(market, positionUnrealizedPnl, withWeightMarginCategory))
                         .div(new _1.BN(numericConstants_1.BANK_WEIGHT_PRECISION));
                 }
             }
-            return pnl.add(pnl0);
+            return unrealizedPnl.add(positionUnrealizedPnl);
         }, numericConstants_1.ZERO);
     }
     /**
@@ -317,25 +354,7 @@ class ClearingHouseUser {
      * @returns : Precision QUOTE_PRECISION
      */
     getTotalCollateral(marginCategory = 'Initial') {
-        return this.getUserAccount()
-            .bankBalances.reduce((totalAssetValue, bankBalance) => {
-            if (bankBalance.balance.eq(numericConstants_1.ZERO) ||
-                (0, types_1.isVariant)(bankBalance.balanceType, 'borrow')) {
-                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);
-            const weight = (0, bankBalance_1.calculateAssetWeight)(tokenAmount, bankAccount, marginCategory);
-            return totalAssetValue.add(tokenAmount
-                .mul(this.getOracleDataForBank(bankAccount.bankIndex).price)
-                .mul(weight)
-                .div(numericConstants_1.BANK_WEIGHT_PRECISION)
-                .div(numericConstants_1.MARK_PRICE_PRECISION)
-                // Adjust for decimals of bank account
-                .div(new _1.BN(10).pow(new _1.BN(bankAccount.decimals).sub(numericConstants_1.BANK_BALANCE_PRECISION_EXP))));
-        }, numericConstants_1.ZERO)
-            .add(this.getUnrealizedPNL(true, undefined, marginCategory));
+        return this.getBankAssetValue(undefined, marginCategory).add(this.getUnrealizedPNL(true, undefined, marginCategory));
     }
     /**
      * calculates sum of position value across all positions in margin system

package/lib/clearingHouseUserStats.d.ts

@@ -2,7 +2,7 @@ import { ClearingHouse } from './clearingHouse';
 import { PublicKey } from '@solana/web3.js';
 import { DataAndSlot, UserStatsAccountSubscriber } from './accounts/types';
 import { ClearingHouseUserStatsConfig } from './clearingHouseUserStatsConfig';
-import { UserStatsAccount } from './types';
+import { ReferrerInfo, UserStatsAccount } from './types';
 export declare class ClearingHouseUserStats {
     clearingHouse: ClearingHouse;
     userStatsAccountPublicKey: PublicKey;
@@ -14,4 +14,5 @@ export declare class ClearingHouseUserStats {
     unsubscribe(): Promise<void>;
     getAccountAndSlot(): DataAndSlot<UserStatsAccount>;
     getAccount(): UserStatsAccount;
+    getReferrerInfo(): ReferrerInfo | undefined;
 }

package/lib/clearingHouseUserStats.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClearingHouseUserStats = 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 {
     constructor(config) {
         var _a;
@@ -32,5 +34,16 @@ class ClearingHouseUserStats {
     getAccount() {
         return this.accountSubscriber.getUserStatsAccountAndSlot().data;
     }
+    getReferrerInfo() {
+        if (this.getAccount().referrer.equals(web3_js_1.PublicKey.default)) {
+            return undefined;
+        }
+        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),
+            };
+        }
+    }
 }
 exports.ClearingHouseUserStats = ClearingHouseUserStats;

package/lib/config.js

@@ -7,7 +7,7 @@ exports.configs = {
     devnet: {
         ENV: 'devnet',
         PYTH_ORACLE_MAPPING_ADDRESS: 'BmA9Z6FjioHJPpjT39QazZyhDRUdZy2ezwx4GiDdE2u2',
-        CLEARING_HOUSE_PROGRAM_ID: 'D9bW92Maa1yDigJqvabRgr5S5VybPNDB5xxSpQD6mkkV',
+        CLEARING_HOUSE_PROGRAM_ID: '65sz7dRiWDRPZjiRxcTxPM7AE6VK4Nag9HEK6oBJXhJn',
         USDC_MINT_ADDRESS: '8zGuJQqwhZafTah7Uc7Z4tXRnguqkn5KLFAP8oV6PHe2',
         MARKETS: markets_1.DevnetMarkets,
         BANKS: banks_1.DevnetBanks,

package/lib/events/types.d.ts

@@ -1,5 +1,5 @@
 import { Commitment, TransactionSignature } from '@solana/web3.js';
-import { DepositRecord, FundingPaymentRecord, FundingRateRecord, LiquidationRecord, OrderRecord, SettlePnlRecord } from '../index';
+import { DepositRecord, FundingPaymentRecord, FundingRateRecord, LiquidationRecord, NewUserRecord, OrderRecord, SettlePnlRecord } from '../index';
 export declare type EventSubscriptionOptions = {
     eventTypes?: EventType[];
     maxEventsPerType?: number;
@@ -28,6 +28,7 @@ export declare type EventMap = {
     FundingRateRecord: Event<FundingRateRecord>;
     OrderRecord: Event<OrderRecord>;
     SettlePnlRecord: Event<SettlePnlRecord>;
+    NewUserRecord: Event<NewUserRecord>;
 };
 export declare type EventType = keyof EventMap;
 export interface EventSubscriberEvents {