@drift-labs/sdk 0.1.19-master.0 → 0.1.21-master.0

package/src/clearingHouseUser.ts

@@ -1,5 +1,4 @@
 import { PublicKey } from '@solana/web3.js';
-import BN from 'bn.js';
 import { EventEmitter } from 'events';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { ClearingHouse } from './clearingHouse';
@@ -18,7 +17,6 @@ import {
 	PRICE_TO_QUOTE_PRECISION,
 } from './constants/numericConstants';
 import { UserAccountSubscriber, UserAccountEvents } from './accounts/types';
-import { DefaultUserAccountSubscriber } from './accounts/defaultUserAccountSubscriber';
 import {
 	calculateMarkPrice,
 	calculateBaseAssetValue,
@@ -26,26 +24,48 @@ import {
 	calculatePositionPNL,
 	PositionDirection,
 	calculateTradeSlippage,
+	BN,
 } from '.';
 import { getUserAccountPublicKey } from './addresses';
+import {
+	getClearingHouseUser,
+	getWebSocketClearingHouseUserConfig,
+} from './factory/clearingHouseUser';
 
 export class ClearingHouseUser {
 	clearingHouse: ClearingHouse;
 	authority: PublicKey;
 	accountSubscriber: UserAccountSubscriber;
 	userAccountPublicKey?: PublicKey;
-	isSubscribed = false;
+	_isSubscribed = false;
 	eventEmitter: StrictEventEmitter<EventEmitter, UserAccountEvents>;
 
+	public get isSubscribed() {
+		return this._isSubscribed && this.accountSubscriber.isSubscribed;
+	}
+
+	public set isSubscribed(val: boolean) {
+		this._isSubscribed = val;
+	}
+
+	/**
+	 * @deprecated You should use getClearingHouseUser factory method instead
+	 * @param clearingHouse
+	 * @param authority
+	 * @returns
+	 */
 	public static from(
 		clearingHouse: ClearingHouse,
 		authority: PublicKey
 	): ClearingHouseUser {
-		const accountSubscriber = new DefaultUserAccountSubscriber(
-			clearingHouse.program,
+		if (clearingHouse.accountSubscriber.type !== 'websocket')
+			throw 'This method only works for clearing houses with a websocket account listener. Try using the getClearingHouseUser factory method to initialize a ClearingHouseUser instead';
+
+		const config = getWebSocketClearingHouseUserConfig(
+			clearingHouse,
 			authority
 		);
-		return new ClearingHouseUser(clearingHouse, authority, accountSubscriber);
+		return getClearingHouseUser(config);
 	}
 
 	public constructor(

package/src/constants/markets.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 
 type Market = {
 	symbol: string;
@@ -98,6 +98,14 @@ export const Markets: Market[] = [
 		mainnetPythOracle: 'HqFyq1wh1xKvL7KDqqT7NJeSPdAqsDqnmBisUC2XdXAX',
 		launchTs: 1643686767000,
 	},
+	{
+		symbol: 'FTT-PERP',
+		baseAssetSymbol: 'FTT',
+		marketIndex: new BN(11),
+		devnetPythOracle: '6vivTRs5ZPeeXbjo7dfburfaYDWoXjBtdtuYgQRuGfu',
+		mainnetPythOracle: '8JPJJkmDScpcNmBRKGZuPuG2GYAveQgP3t5gFuMymwvF',
+		launchTs: 1644382122000,
+	},
 	// {
 	// 	symbol: 'mSOL-PERP',
 	// 	baseAssetSymbol: 'mSOL',

package/src/constants/numericConstants.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 
 export const ZERO = new BN(0);
 export const ONE = new BN(1);
@@ -15,6 +15,7 @@ export const FUNDING_PAYMENT_PRECISION = new BN(10000);
 export const PEG_PRECISION = new BN(1000);
 
 export const AMM_RESERVE_PRECISION = new BN(10 ** 13);
+export const BASE_PRECISION = AMM_RESERVE_PRECISION;
 export const AMM_TO_QUOTE_PRECISION_RATIO =
 	AMM_RESERVE_PRECISION.div(QUOTE_PRECISION); // 10^7
 export const PRICE_TO_QUOTE_PRECISION =

package/src/examples/makeTradeExample.ts

@@ -95,7 +95,10 @@ const main = async () => {
 		clearingHouse.getMarket(solMarketInfo.marketIndex)
 	);
 
-	const formattedPrice = convertToNumber(currentMarketPrice, QUOTE_PRECISION);
+	const formattedPrice = convertToNumber(
+		currentMarketPrice,
+		MARK_PRICE_PRECISION
+	);
 
 	console.log(`Current Market Price is $${formattedPrice}`);
 

package/src/factory/clearingHouse.ts

@@ -0,0 +1,125 @@
+import { ConfirmOptions, Connection, PublicKey } from '@solana/web3.js';
+import { IWallet } from '../types';
+import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
+import { TxSender } from '../tx/types';
+import { Idl, Program, Provider } from '@project-serum/anchor';
+import { ClearingHouse } from '../clearingHouse';
+import clearingHouseIDL from '../idl/clearing_house.json';
+import { WebSocketClearingHouseAccountSubscriber } from '../accounts/webSocketClearingHouseAccountSubscriber';
+import { DefaultTxSender } from '../tx/defaultTxSender';
+import { ClearingHouseAccountSubscriber } from '../accounts/types';
+import { PollingClearingHouseAccountSubscriber } from '../accounts/pollingClearingHouseAccountSubscriber';
+import { Admin } from '../admin';
+
+export type ClearingHouseConfigType = 'websocket' | 'polling' | 'custom';
+
+type BaseClearingHouseConfig = {
+	type: ClearingHouseConfigType;
+	connection: Connection;
+	wallet: IWallet;
+	programID: PublicKey;
+	opts?: ConfirmOptions;
+	txSender?: TxSender;
+};
+
+type WebSocketClearingHouseConfiguration = BaseClearingHouseConfig;
+
+type PollingClearingHouseConfiguration = BaseClearingHouseConfig & {
+	accountLoader: BulkAccountLoader;
+};
+
+type ClearingHouseConfig =
+	| PollingClearingHouseConfiguration
+	| WebSocketClearingHouseConfiguration;
+
+export function getWebSocketClearingHouseConfig(
+	connection: Connection,
+	wallet: IWallet,
+	programID: PublicKey,
+	opts: ConfirmOptions = Provider.defaultOptions(),
+	txSender?: TxSender
+): WebSocketClearingHouseConfiguration {
+	return {
+		type: 'websocket',
+		connection,
+		wallet,
+		programID,
+		opts,
+		txSender,
+	};
+}
+
+export function getPollingClearingHouseConfig(
+	connection: Connection,
+	wallet: IWallet,
+	programID: PublicKey,
+	accountLoader: BulkAccountLoader,
+	opts: ConfirmOptions = Provider.defaultOptions(),
+	txSender?: TxSender
+): PollingClearingHouseConfiguration {
+	return {
+		type: 'polling',
+		connection,
+		wallet,
+		programID,
+		accountLoader,
+		opts,
+		txSender,
+	};
+}
+
+export function getClearingHouse(config: ClearingHouseConfig): ClearingHouse {
+	const provider = new Provider(config.connection, config.wallet, config.opts);
+	const program = new Program(
+		clearingHouseIDL as Idl,
+		config.programID,
+		provider
+	);
+	let accountSubscriber: ClearingHouseAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketClearingHouseAccountSubscriber(program);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingClearingHouseAccountSubscriber(
+			program,
+			(config as PollingClearingHouseConfiguration).accountLoader
+		);
+	}
+
+	const txSender = config.txSender || new DefaultTxSender(provider);
+	return new ClearingHouse(
+		config.connection,
+		config.wallet,
+		program,
+		accountSubscriber,
+		txSender,
+		config.opts
+	);
+}
+
+export function getAdmin(config: ClearingHouseConfig): Admin {
+	const provider = new Provider(config.connection, config.wallet, config.opts);
+	const program = new Program(
+		clearingHouseIDL as Idl,
+		config.programID,
+		provider
+	);
+	let accountSubscriber: ClearingHouseAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketClearingHouseAccountSubscriber(program);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingClearingHouseAccountSubscriber(
+			program,
+			(config as PollingClearingHouseConfiguration).accountLoader
+		);
+	}
+
+	const txSender = config.txSender || new DefaultTxSender(provider);
+	return new Admin(
+		config.connection,
+		config.wallet,
+		program,
+		accountSubscriber,
+		txSender,
+		config.opts
+	);
+}

package/src/factory/clearingHouseUser.ts

@@ -0,0 +1,73 @@
+import { PublicKey } from '@solana/web3.js';
+import { ClearingHouse } from '../clearingHouse';
+import { BulkAccountLoader } from '../accounts/bulkAccountLoader';
+import { ClearingHouseUser } from '../clearingHouseUser';
+import { UserAccountSubscriber } from '../accounts/types';
+import { WebSocketUserAccountSubscriber } from '../accounts/webSocketUserAccountSubscriber';
+import { PollingUserAccountSubscriber } from '../accounts/pollingUserAccountSubscriber';
+
+export type ClearingHouseUserConfigType = 'websocket' | 'polling' | 'custom';
+
+type BaseClearingHouseUserConfig = {
+	type: ClearingHouseUserConfigType;
+	clearingHouse: ClearingHouse;
+	authority: PublicKey;
+};
+
+type WebSocketClearingHouseUserConfig = BaseClearingHouseUserConfig;
+
+type PollingClearingHouseUserConfig = BaseClearingHouseUserConfig & {
+	accountLoader: BulkAccountLoader;
+};
+
+type ClearingHouseUserConfig =
+	| PollingClearingHouseUserConfig
+	| WebSocketClearingHouseUserConfig;
+
+export function getWebSocketClearingHouseUserConfig(
+	clearingHouse: ClearingHouse,
+	authority: PublicKey
+): WebSocketClearingHouseUserConfig {
+	return {
+		type: 'websocket',
+		clearingHouse,
+		authority,
+	};
+}
+
+export function getPollingClearingHouseUserConfig(
+	clearingHouse: ClearingHouse,
+	authority: PublicKey,
+	accountLoader: BulkAccountLoader
+): PollingClearingHouseUserConfig {
+	return {
+		type: 'polling',
+		clearingHouse,
+		authority,
+		accountLoader,
+	};
+}
+
+export function getClearingHouseUser(
+	config: ClearingHouseUserConfig
+): ClearingHouseUser {
+	let accountSubscriber: UserAccountSubscriber;
+	if (config.type === 'websocket') {
+		accountSubscriber = new WebSocketUserAccountSubscriber(
+			config.clearingHouse.program,
+			config.authority
+		);
+	} else if (config.type === 'polling') {
+		accountSubscriber = new PollingUserAccountSubscriber(
+			config.clearingHouse.program,
+			config.authority,
+			(config as PollingClearingHouseUserConfig).accountLoader
+		);
+	}
+
+	return new ClearingHouseUser(
+		config.clearingHouse,
+		config.authority,
+		accountSubscriber
+	);
+}

package/src/index.ts

@@ -1,15 +1,21 @@
 import { BN } from '@project-serum/anchor';
+import { PublicKey } from '@solana/web3.js';
 
 export * from './mockUSDCFaucet';
 export * from './pythClient';
 export * from './types';
 export * from './constants/markets';
-export * from './accounts/defaultClearingHouseAccountSubscriber';
+export * from './accounts/webSocketClearingHouseAccountSubscriber';
+export * from './accounts/bulkAccountLoader';
+export * from './accounts/pollingClearingHouseAccountSubscriber';
+export * from './accounts/pollingTokenAccountSubscriber';
 export * from './accounts/types';
 export * from './addresses';
 export * from './admin';
 export * from './clearingHouseUser';
 export * from './clearingHouse';
+export * from './factory/clearingHouse';
+export * from './factory/clearingHouseUser';
 export * from './math/conversion';
 export * from './math/funding';
 export * from './math/insuranceFund';
@@ -25,4 +31,4 @@ export * from './constants/numericConstants';
 export * from './util/computeUnits';
 export * from './util/tps';
 
-export { BN };
+export { BN, PublicKey };

package/src/math/conversion.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 import {
 	MARK_PRICE_PRECISION,
 	PEG_PRECISION,

package/src/math/insuranceFund.ts

@@ -1,5 +1,5 @@
 import { MarketsAccount, StateAccount } from '../types';
-import BN from 'bn.js';
+import { BN } from '../';
 import { Connection } from '@solana/web3.js';
 
 /**

package/src/math/position.ts

@@ -1,4 +1,4 @@
-import BN from 'bn.js';
+import { BN } from '../';
 import {
 	AMM_RESERVE_PRECISION,
 	AMM_TIMES_PEG_TO_QUOTE_PRECISION_RATIO,

package/src/math/utils.ts

@@ -1,4 +1,4 @@
-import { BN } from 'bn.js';
+import { BN } from '../';
 
 export const squareRootBN = (n, closeness = new BN(1)) => {
 	// Assuming the sqrt of n as n only

package/src/mockUSDCFaucet.ts

@@ -17,7 +17,7 @@ import {
 	TransactionInstruction,
 	TransactionSignature,
 } from '@solana/web3.js';
-import BN from 'bn.js';
+import { BN } from '.';
 import mockUSDCFaucetIDL from './idl/mock_usdc_faucet.json';
 import { IWallet } from './types';
 

package/src/token/index.ts

@@ -0,0 +1,37 @@
+import { AccountInfo, AccountLayout, u64 } from '@solana/spl-token';
+import { PublicKey } from '@solana/web3.js';
+
+export function parseTokenAccount(data: Buffer): AccountInfo {
+	const accountInfo = AccountLayout.decode(data);
+	accountInfo.mint = new PublicKey(accountInfo.mint);
+	accountInfo.owner = new PublicKey(accountInfo.owner);
+	accountInfo.amount = u64.fromBuffer(accountInfo.amount);
+
+	if (accountInfo.delegateOption === 0) {
+		accountInfo.delegate = null;
+		// eslint-disable-next-line new-cap
+		accountInfo.delegatedAmount = new u64(0);
+	} else {
+		accountInfo.delegate = new PublicKey(accountInfo.delegate);
+		accountInfo.delegatedAmount = u64.fromBuffer(accountInfo.delegatedAmount);
+	}
+
+	accountInfo.isInitialized = accountInfo.state !== 0;
+	accountInfo.isFrozen = accountInfo.state === 2;
+
+	if (accountInfo.isNativeOption === 1) {
+		accountInfo.rentExemptReserve = u64.fromBuffer(accountInfo.isNative);
+		accountInfo.isNative = true;
+	} else {
+		accountInfo.rentExemptReserve = null;
+		accountInfo.isNative = false;
+	}
+
+	if (accountInfo.closeAuthorityOption === 0) {
+		accountInfo.closeAuthority = null;
+	} else {
+		accountInfo.closeAuthority = new PublicKey(accountInfo.closeAuthority);
+	}
+
+	return accountInfo;
+}

package/src/types.ts

@@ -1,5 +1,5 @@
 import { PublicKey, Transaction } from '@solana/web3.js';
-import BN from 'bn.js';
+import { BN } from '.';
 
 // # Utility Types / Enums / Constants
 export class SwapDirection {

package/lib/accounts/defaultClearingHouseAccountSubscriber.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultClearingHouseAccountSubscriber.d.ts","sourceRoot":"","sources":["../../src/accounts/defaultClearingHouseAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,8BAA8B,EAC9B,0BAA0B,EAC1B,yBAAyB,EACzB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,iBAAiB,EAAsB,MAAM,SAAS,CAAC;AAChE,OAAO,EACN,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,qBAAa,qCACZ,YAAW,8BAA8B;IAEzC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,0BAA0B,CAAC,CAAC;IAC3E,sBAAsB,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;IACzD,wBAAwB,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC7D,6BAA6B,CAAC,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;IACvE,+BAA+B,CAAC,EAAE,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IAC3E,sCAAsC,CAAC,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;IACzF,mCAAmC,CAAC,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;IACnF,6BAA6B,CAAC,EAAE,iBAAiB,CAAC,2BAA2B,CAAC,CAAC;IAC/E,mCAAmC,CAAC,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;IAEnF,0BAA0B,EAAE,yBAAyB,EAAE,CAAM;IAE7D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,mBAAmB,CAAmB;IAC9C,OAAO,CAAC,2BAA2B,CAAyB;gBAEzC,OAAO,EAAE,OAAO;IAMtB,SAAS,CACrB,qBAAqB,CAAC,EAAE,yBAAyB,EAAE,GACjD,OAAO,CAAC,OAAO,CAAC;IAiJN,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBtB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAqCzC,kBAAkB,IAAI,IAAI;IAQ1B,0BAA0B,CACzB,oBAAoB,EAAE,yBAAyB,GAC7C,IAAI;IAcA,eAAe,IAAI,YAAY;IAK/B,iBAAiB,IAAI,cAAc;IAKnC,sBAAsB,IAAI,mBAAmB;IAM7C,wBAAwB,IAAI,qBAAqB;IAMjD,+BAA+B,IAAI,4BAA4B;IAM/D,4BAA4B,IAAI,yBAAyB;IAMzD,sBAAsB,IAAI,2BAA2B;IAMrD,4BAA4B,IAAI,yBAAyB;CAKhE"}

package/lib/accounts/defaultUserAccountSubscriber.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultUserAccountSubscriber.d.ts","sourceRoot":"","sources":["../../src/accounts/defaultUserAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,iBAAiB,EAEjB,iBAAiB,EACjB,qBAAqB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAE7D,qBAAa,4BAA6B,YAAW,qBAAqB;IACzE,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAClE,SAAS,EAAE,SAAS,CAAC;IAErB,yBAAyB,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC1D,8BAA8B,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;gBAErD,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;IAOnD,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAsC7B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAalC,kBAAkB,IAAI,IAAI;IAQnB,cAAc,IAAI,WAAW;IAK7B,uBAAuB,IAAI,oBAAoB;CAItD"}