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

package/src/userMap/userMap.ts

@@ -1,10 +1,10 @@
 import {
-	ClearingHouseUser,
-	ClearingHouse,
+	User,
+	DriftClient,
 	UserAccount,
 	bulkPollingUserSubscribe,
 	OrderRecord,
-	ClearingHouseUserAccountSubscriptionConfig,
+	UserSubscriptionConfig,
 } from '..';
 import { ProgramAccount } from '@project-serum/anchor';
 
@@ -14,38 +14,38 @@ 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 class UserMap implements UserMapInterface {
-	private userMap = new Map<string, ClearingHouseUser>();
-	private clearingHouse: ClearingHouse;
-	private accountSubscription: ClearingHouseUserAccountSubscriptionConfig;
+	private userMap = new Map<string, User>();
+	private driftClient: DriftClient;
+	private accountSubscription: UserSubscriptionConfig;
 
 	constructor(
-		clearingHouse: ClearingHouse,
-		accountSubscription: ClearingHouseUserAccountSubscriptionConfig
+		driftClient: DriftClient,
+		accountSubscription: UserSubscriptionConfig
 	) {
-		this.clearingHouse = clearingHouse;
+		this.driftClient = driftClient;
 		this.accountSubscription = accountSubscription;
 	}
 
 	public async fetchAllUsers() {
-		const userArray: ClearingHouseUser[] = [];
+		const userArray: User[] = [];
 
 		const programUserAccounts =
-			(await this.clearingHouse.program.account.user.all()) as ProgramAccount<UserAccount>[];
+			(await this.driftClient.program.account.user.all()) as ProgramAccount<UserAccount>[];
 		for (const programUserAccount of programUserAccounts) {
 			if (this.userMap.has(programUserAccount.publicKey.toString())) {
 				continue;
 			}
 
-			const user = new ClearingHouseUser({
-				clearingHouse: this.clearingHouse,
+			const user = new User({
+				driftClient: this.driftClient,
 				userAccountPublicKey: programUserAccount.publicKey,
 				accountSubscription: this.accountSubscription,
 			});
@@ -65,8 +65,8 @@ export class UserMap implements UserMapInterface {
 	}
 
 	public async addPubkey(userAccountPublicKey: PublicKey) {
-		const user = new ClearingHouseUser({
-			clearingHouse: this.clearingHouse,
+		const user = new User({
+			driftClient: this.driftClient,
 			userAccountPublicKey,
 			accountSubscription: this.accountSubscription,
 		});
@@ -79,20 +79,20 @@ export class UserMap implements UserMapInterface {
 	}
 
 	/**
-	 * 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
 	 */
-	public get(key: string): ClearingHouseUser | undefined {
+	public get(key: string): User | undefined {
 		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
 	 */
-	public async mustGet(key: string): Promise<ClearingHouseUser> {
+	public async mustGet(key: string): Promise<User> {
 		if (!this.has(key)) {
 			await this.addPubkey(new PublicKey(key));
 		}
@@ -102,8 +102,8 @@ export class UserMap implements UserMapInterface {
 	}
 
 	/**
-	 * 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
 	 */
 	public getUserAuthority(key: string): PublicKey | undefined {
@@ -118,7 +118,7 @@ export class UserMap implements UserMapInterface {
 		await this.addPubkey(record.user);
 	}
 
-	public values(): IterableIterator<ClearingHouseUser> {
+	public values(): IterableIterator<User> {
 		return this.userMap.values();
 	}
 }

package/src/userMap/userStatsMap.ts

@@ -1,10 +1,10 @@
 import {
-	ClearingHouse,
+	DriftClient,
 	getUserStatsAccountPublicKey,
 	OrderRecord,
 	UserStatsAccount,
-	ClearingHouseUserStats,
-	ClearingHouseUserStatsAccountSubscriptionConfig,
+	UserStats,
+	UserStatsSubscriptionConfig,
 	bulkPollingUserStatsSubscribe,
 } from '..';
 import { ProgramAccount } from '@project-serum/anchor';
@@ -14,25 +14,25 @@ import { UserMap } from './userMap';
 
 export class UserStatsMap {
 	/**
-	 * map from authority pubkey to ClearingHouseUserStats
+	 * map from authority pubkey to UserStats
 	 */
-	private userStatsMap = new Map<string, ClearingHouseUserStats>();
-	private clearingHouse: ClearingHouse;
-	private accountSubscription: ClearingHouseUserStatsAccountSubscriptionConfig;
+	private userStatsMap = new Map<string, UserStats>();
+	private driftClient: DriftClient;
+	private accountSubscription: UserStatsSubscriptionConfig;
 
 	constructor(
-		clearingHouse: ClearingHouse,
-		accountSubscription: ClearingHouseUserStatsAccountSubscriptionConfig
+		driftClient: DriftClient,
+		accountSubscription: UserStatsSubscriptionConfig
 	) {
-		this.clearingHouse = clearingHouse;
+		this.driftClient = driftClient;
 		this.accountSubscription = accountSubscription;
 	}
 
 	public async fetchAllUserStats() {
-		const userStatArray: ClearingHouseUserStats[] = [];
+		const userStatArray: UserStats[] = [];
 
 		const programUserAccounts =
-			(await this.clearingHouse.program.account.userStats.all()) as ProgramAccount<UserStatsAccount>[];
+			(await this.driftClient.program.account.userStats.all()) as ProgramAccount<UserStatsAccount>[];
 
 		for (const programUserAccount of programUserAccounts) {
 			const userStat: UserStatsAccount = programUserAccount.account;
@@ -40,10 +40,10 @@ export class UserStatsMap {
 				continue;
 			}
 
-			const chUserStat = new ClearingHouseUserStats({
-				clearingHouse: this.clearingHouse,
+			const chUserStat = new UserStats({
+				driftClient: this.driftClient,
 				userStatsAccountPublicKey: getUserStatsAccountPublicKey(
-					this.clearingHouse.program.programId,
+					this.driftClient.program.programId,
 					userStat.authority
 				),
 				accountSubscription: this.accountSubscription,
@@ -67,10 +67,10 @@ export class UserStatsMap {
 	}
 
 	public async addUserStat(authority: PublicKey) {
-		const userStat = new ClearingHouseUserStats({
-			clearingHouse: this.clearingHouse,
+		const userStat = new UserStats({
+			driftClient: this.driftClient,
 			userStatsAccountPublicKey: getUserStatsAccountPublicKey(
-				this.clearingHouse.program.programId,
+				this.driftClient.program.programId,
 				authority
 			),
 			accountSubscription: this.accountSubscription,
@@ -91,20 +91,18 @@ export class UserStatsMap {
 		return this.userStatsMap.has(authorityPublicKey);
 	}
 
-	public get(authorityPublicKey: string): ClearingHouseUserStats {
+	public get(authorityPublicKey: string): UserStats {
 		return this.userStatsMap.get(authorityPublicKey);
 	}
 
-	public async mustGet(
-		authorityPublicKey: string
-	): Promise<ClearingHouseUserStats> {
+	public async mustGet(authorityPublicKey: string): Promise<UserStats> {
 		if (!this.has(authorityPublicKey)) {
 			await this.addUserStat(new PublicKey(authorityPublicKey));
 		}
 		return this.get(authorityPublicKey);
 	}
 
-	public values(): IterableIterator<ClearingHouseUserStats> {
+	public values(): IterableIterator<UserStats> {
 		return this.userStatsMap.values();
 	}
 }

package/src/{clearingHouseUserStats.ts → userStats.ts}

@@ -1,7 +1,7 @@
-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 { PollingUserStatsAccountSubscriber } from './accounts/pollingUserStatsAccountSubscriber';
 import { WebSocketUserStatsAccountSubscriber } from './accounts/webSocketUserStatsAccountSubsriber';
 import { ReferrerInfo, UserStatsAccount } from './types';
@@ -10,24 +10,24 @@ import {
 	getUserStatsAccountPublicKey,
 } from './addresses/pda';
 
-export class ClearingHouseUserStats {
-	clearingHouse: ClearingHouse;
+export class UserStats {
+	driftClient: DriftClient;
 	userStatsAccountPublicKey: PublicKey;
 	accountSubscriber: UserStatsAccountSubscriber;
 	isSubscribed: boolean;
 
-	public constructor(config: ClearingHouseUserStatsConfig) {
-		this.clearingHouse = config.clearingHouse;
+	public constructor(config: UserStatsConfig) {
+		this.driftClient = config.driftClient;
 		this.userStatsAccountPublicKey = config.userStatsAccountPublicKey;
 		if (config.accountSubscription?.type === 'polling') {
 			this.accountSubscriber = new PollingUserStatsAccountSubscriber(
-				config.clearingHouse.program,
+				config.driftClient.program,
 				config.userStatsAccountPublicKey,
 				config.accountSubscription.accountLoader
 			);
 		} else {
 			this.accountSubscriber = new WebSocketUserStatsAccountSubscriber(
-				config.clearingHouse.program,
+				config.driftClient.program,
 				config.userStatsAccountPublicKey
 			);
 		}
@@ -61,12 +61,12 @@ export class ClearingHouseUserStats {
 		} else {
 			return {
 				referrer: getUserAccountPublicKeySync(
-					this.clearingHouse.program.programId,
+					this.driftClient.program.programId,
 					this.getAccount().referrer,
 					0
 				),
 				referrerStats: getUserStatsAccountPublicKey(
-					this.clearingHouse.program.programId,
+					this.driftClient.program.programId,
 					this.getAccount().referrer
 				),
 			};

package/src/userStatsConfig.ts

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

package/tests/dlob/helpers.ts

@@ -4,8 +4,8 @@ import {
 	AssetTier,
 	PerpPosition,
 	BN,
-	ClearingHouse,
-	ClearingHouseUser,
+	DriftClient,
+	User,
 	PerpMarketAccount,
 	SpotMarketAccount,
 	MarketStatus,
@@ -21,6 +21,7 @@ import {
 	OrderRecord,
 	ExchangeStatus,
 	ZERO,
+	ContractTier,
 } from '../../src';
 
 export const mockPerpPosition: PerpPosition = {
@@ -71,7 +72,6 @@ export const mockAMM: AMM = {
 	fundingPeriod: new BN(0),
 	cumulativeFundingRateLong: new BN(0),
 	cumulativeFundingRateShort: new BN(0),
-	cumulativeFundingRateLp: new BN(0),
 	totalFeeMinusDistributions: new BN(0),
 	totalFeeWithdrawn: new BN(0),
 	totalFee: new BN(0),
@@ -79,6 +79,14 @@ export const mockAMM: AMM = {
 	baseAssetAmountWithUnsettledLp: new BN(0),
 	orderStepSize: new BN(0),
 	orderTickSize: new BN(1),
+	last24hAvgFundingRate: new BN(0),
+	lastFundingRateShort: new BN(0),
+	lastFundingRateLong: new BN(0),
+	concentrationCoef: new BN(0),
+	lastTradeTs: new BN(0),
+	lastOracleNormalisedPrice: new BN(0),
+	maxOpenInterest: new BN(0),
+	totalLiquidationFee: new BN(0),
 	maxFillReserveFraction: 0,
 	baseSpread: 0,
 	curveUpdateIntensity: 0,
@@ -107,6 +115,25 @@ export const mockAMM: AMM = {
 	cumulativeSocialLoss: new BN(0),
 	baseAssetAmountPerLp: new BN(0),
 	quoteAssetAmountPerLp: new BN(0),
+
+	quoteBreakEvenAmountLong: new BN(0),
+	quoteBreakEvenAmountShort: new BN(0),
+	quoteEntryAmountLong: new BN(0),
+	quoteEntryAmountShort: new BN(0),
+
+	markStd: new BN(0),
+	longIntensityCount: 0,
+	longIntensityVolume: new BN(0),
+	shortIntensityCount: 0,
+	shortIntensityVolume: new BN(0),
+	volume24h: new BN(0),
+	minOrderSize: new BN(0),
+	maxPositionSize: new BN(0),
+
+	bidBaseAssetReserve: new BN(0),
+	bidQuoteAssetReserve: new BN(0),
+	askBaseAssetReserve: new BN(0),
+	askQuoteAssetReserve: new BN(0),
 };
 
 export const mockPerpMarkets: Array<PerpMarketAccount> = [
@@ -114,6 +141,7 @@ export const mockPerpMarkets: Array<PerpMarketAccount> = [
 		status: MarketStatus.INITIALIZED,
 		name: [],
 		contractType: ContractType.PERPETUAL,
+		contractTier: ContractTier.A,
 		expiryTs: new BN(0),
 		expiryPrice: new BN(0),
 		marketIndex: 0,
@@ -131,6 +159,8 @@ export const mockPerpMarkets: Array<PerpMarketAccount> = [
 		ifLiquidationFee: 0,
 		liquidatorFee: 0,
 		imfFactor: 0,
+		nextFundingRateRecordId: new BN(0),
+		nextCurveRecordId: new BN(0),
 		unrealizedPnlImfFactor: 0,
 		unrealizedPnlMaxImbalance: ZERO,
 		unrealizedPnlInitialAssetWeight: 0,
@@ -145,6 +175,9 @@ export const mockPerpMarkets: Array<PerpMarketAccount> = [
 	},
 	{
 		status: MarketStatus.INITIALIZED,
+		contractTier: ContractTier.A,
+		nextFundingRateRecordId: new BN(0),
+		nextCurveRecordId: new BN(0),
 		name: [],
 		contractType: ContractType.PERPETUAL,
 		expiryTs: new BN(0),
@@ -178,6 +211,9 @@ export const mockPerpMarkets: Array<PerpMarketAccount> = [
 	},
 	{
 		status: MarketStatus.INITIALIZED,
+		contractTier: ContractTier.A,
+		nextFundingRateRecordId: new BN(0),
+		nextCurveRecordId: new BN(0),
 		name: [],
 		contractType: ContractType.PERPETUAL,
 		expiryTs: new BN(0),
@@ -260,6 +296,8 @@ export const mockSpotMarkets: Array<SpotMarketAccount> = [
 		orderStepSize: new BN(0),
 		orderTickSize: new BN(0),
 		nextFillRecordId: new BN(0),
+		nextDepositRecordId: new BN(0),
+		ordersEnabled: true,
 		spotFeePool: {
 			scaledBalance: new BN(0),
 			marketIndex: 0,
@@ -330,6 +368,8 @@ export const mockSpotMarkets: Array<SpotMarketAccount> = [
 		orderStepSize: new BN(0),
 		orderTickSize: new BN(0),
 		nextFillRecordId: new BN(0),
+		nextDepositRecordId: new BN(0),
+		ordersEnabled: true,
 		spotFeePool: {
 			scaledBalance: new BN(0),
 			marketIndex: 0,
@@ -400,6 +440,8 @@ export const mockSpotMarkets: Array<SpotMarketAccount> = [
 		orderStepSize: new BN(0),
 		orderTickSize: new BN(0),
 		nextFillRecordId: new BN(0),
+		nextDepositRecordId: new BN(0),
+		ordersEnabled: true,
 		spotFeePool: {
 			scaledBalance: new BN(0),
 			marketIndex: 0,
@@ -502,14 +544,14 @@ export const mockStateAccount: StateAccount = {
 };
 
 export class MockUserMap implements UserMapInterface {
-	private userMap = new Map<string, ClearingHouseUser>();
+	private userMap = new Map<string, User>();
 	private userAccountToAuthority = new Map<string, string>();
-	private clearingHouse: ClearingHouse;
+	private driftClient: DriftClient;
 
 	constructor() {
 		this.userMap = new Map();
 		this.userAccountToAuthority = new Map();
-		this.clearingHouse = new ClearingHouse({
+		this.driftClient = new DriftClient({
 			connection: new Connection('http://localhost:8899'),
 			wallet: new Wallet(new Keypair()),
 			programID: PublicKey.default,
@@ -519,8 +561,8 @@ export class MockUserMap implements UserMapInterface {
 	public async fetchAllUsers(): Promise<void> {}
 
 	public async addPubkey(userAccountPublicKey: PublicKey): Promise<void> {
-		const user = new ClearingHouseUser({
-			clearingHouse: this.clearingHouse,
+		const user = new User({
+			driftClient: this.driftClient,
 			userAccountPublicKey: userAccountPublicKey,
 		});
 		this.userMap.set(userAccountPublicKey.toBase58(), user);
@@ -544,13 +586,13 @@ export class MockUserMap implements UserMapInterface {
 		return this.userMap.has(key);
 	}
 
-	public get(_key: string): ClearingHouseUser | undefined {
+	public get(_key: string): User | undefined {
 		return undefined;
 	}
 
-	public async mustGet(_key: string): Promise<ClearingHouseUser> {
-		return new ClearingHouseUser({
-			clearingHouse: this.clearingHouse,
+	public async mustGet(_key: string): Promise<User> {
+		return new User({
+			driftClient: this.driftClient,
 			userAccountPublicKey: PublicKey.default,
 		});
 	}
@@ -563,7 +605,7 @@ export class MockUserMap implements UserMapInterface {
 
 	public async updateWithOrderRecord(_record: OrderRecord): Promise<void> {}
 
-	public values(): IterableIterator<ClearingHouseUser> {
+	public values(): IterableIterator<User> {
 		return this.userMap.values();
 	}
 }

package/lib/clearingHouseUserConfig.d.ts

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

package/lib/clearingHouseUserStatsConfig.d.ts

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

package/src/clearingHouseUserStatsConfig.ts

@@ -1,18 +0,0 @@
-import { ClearingHouse } from './clearingHouse';
-import { PublicKey } from '@solana/web3.js';
-import { BulkAccountLoader } from './accounts/bulkAccountLoader';
-
-export type ClearingHouseUserStatsConfig = {
-	accountSubscription?: ClearingHouseUserStatsAccountSubscriptionConfig;
-	clearingHouse: ClearingHouse;
-	userStatsAccountPublicKey: PublicKey;
-};
-
-export type ClearingHouseUserStatsAccountSubscriptionConfig =
-	| {
-			type: 'websocket';
-	  }
-	| {
-			type: 'polling';
-			accountLoader: BulkAccountLoader;
-	  };