@drift-labs/sdk 0.2.0-master.32 → 0.2.0-master.34

package/src/token/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTokenAccount = void 0;
+const spl_token_1 = require("@solana/spl-token");
+const web3_js_1 = require("@solana/web3.js");
+function parseTokenAccount(data) {
+    const accountInfo = spl_token_1.AccountLayout.decode(data);
+    accountInfo.mint = new web3_js_1.PublicKey(accountInfo.mint);
+    accountInfo.owner = new web3_js_1.PublicKey(accountInfo.owner);
+    accountInfo.amount = spl_token_1.u64.fromBuffer(accountInfo.amount);
+    if (accountInfo.delegateOption === 0) {
+        accountInfo.delegate = null;
+        // eslint-disable-next-line new-cap
+        accountInfo.delegatedAmount = new spl_token_1.u64(0);
+    }
+    else {
+        accountInfo.delegate = new web3_js_1.PublicKey(accountInfo.delegate);
+        accountInfo.delegatedAmount = spl_token_1.u64.fromBuffer(accountInfo.delegatedAmount);
+    }
+    accountInfo.isInitialized = accountInfo.state !== 0;
+    accountInfo.isFrozen = accountInfo.state === 2;
+    if (accountInfo.isNativeOption === 1) {
+        accountInfo.rentExemptReserve = spl_token_1.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 web3_js_1.PublicKey(accountInfo.closeAuthority);
+    }
+    return accountInfo;
+}
+exports.parseTokenAccount = parseTokenAccount;

package/src/tx/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/tx/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapInTx = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const COMPUTE_UNITS_DEFAULT = 200000;
+function wrapInTx(instruction, computeUnits = 600000 // TODO, requires less code change
+) {
+    const tx = new web3_js_1.Transaction();
+    if (computeUnits != COMPUTE_UNITS_DEFAULT) {
+        tx.add(web3_js_1.ComputeBudgetProgram.requestUnits({
+            units: computeUnits,
+            additionalFee: 0,
+        }));
+    }
+    return tx.add(instruction);
+}
+exports.wrapInTx = wrapInTx;

package/src/types.ts

@@ -169,7 +169,7 @@ export type NewUserRecord = {
 	ts: BN;
 	userAuthority: PublicKey;
 	user: PublicKey;
-	userId: number;
+	subAccount: number;
 	name: number[];
 	referrer: PublicKey;
 };
@@ -266,8 +266,8 @@ export type FundingRateRecord = {
 	oraclePriceTwap: BN;
 	markPriceTwap: BN;
 	periodRevenue: BN;
-	netBaseAssetAmount: BN;
-	netUnsettledLpBaseAssetAmount: BN;
+	baseAssetAmountWithAmm: BN;
+	baseAssetAmountWithUnsettledLp: BN;
 };
 
 export type FundingPaymentRecord = {
@@ -413,7 +413,6 @@ export type OrderActionRecord = {
 	makerOrderBaseAssetAmount: BN | null;
 	makerOrderCumulativeBaseAssetAmountFilled: BN | null;
 	makerOrderCumulativeQuoteAssetAmountFilled: BN | null;
-	makerOrderFee: BN | null;
 	oraclePrice: BN;
 };
 
@@ -425,7 +424,6 @@ export type StateAccount = {
 	oracleGuardRails: OracleGuardRails;
 	numberOfMarkets: number;
 	numberOfSpotMarkets: number;
-	minOrderQuoteAssetAmount: BN;
 	minPerpAuctionDuration: number;
 	defaultMarketOrderTimeInForce: number;
 	defaultSpotAuctionDuration: number;
@@ -436,20 +434,19 @@ export type StateAccount = {
 	srmVault: PublicKey;
 	perpFeeStructure: FeeStructure;
 	spotFeeStructure: FeeStructure;
+	lpCooldownTime: BN;
 };
 
 export type PerpMarketAccount = {
 	status: MarketStatus;
 	contractType: ContractType;
 	expiryTs: BN;
-	settlementPrice: BN;
+	expiryPrice: BN;
 	marketIndex: number;
 	pubkey: PublicKey;
+	name: number[];
 	amm: AMM;
-	baseAssetAmount: BN;
-	baseAssetAmountLong: BN;
-	baseAssetAmountShort: BN;
-	openInterest: BN;
+	numberOfUsers: BN;
 	marginRatioInitial: number;
 	marginRatioMaintenance: number;
 	nextFillRecordId: BN;
@@ -457,15 +454,17 @@ export type PerpMarketAccount = {
 	liquidatorFee: BN;
 	ifLiquidationFee: BN;
 	imfFactor: BN;
-	unrealizedImfFactor: BN;
-	unrealizedMaxImbalance: BN;
-	unrealizedInitialAssetWeight: number;
-	unrealizedMaintenanceAssetWeight: number;
-	revenueWithdrawSinceLastSettle: BN;
-	maxRevenueWithdrawPerPeriod: BN;
-	lastRevenueWithdrawTs: BN;
-	quoteSettledInsurance: BN;
-	quoteMaxInsurance: BN;
+	unrealizedPnlImfFactor: BN;
+	unrealizedPnlMaxImbalance: BN;
+	unrealizedPnlInitialAssetWeight: number;
+	unrealizedPnlMaintenanceAssetWeight: number;
+	insuranceClaim: {
+		revenueWithdrawSinceLastSettle: BN;
+		maxRevenueWithdrawPerPeriod: BN;
+		lastRevenueWithdrawTs: BN;
+		quoteSettledInsurance: BN;
+		quoteMaxInsurance: BN;
+	};
 };
 
 export type HistoricalOracleData = {
@@ -481,7 +480,7 @@ export type HistoricalIndexData = {
 	lastIndexBidPrice: BN;
 	lastIndexAskPrice: BN;
 	lastIndexPriceTwap: BN;
-	lastIndexPriceTwap5Min: BN;
+	lastIndexPriceTwap5min: BN;
 	lastIndexPriceTwapTs: BN;
 };
 
@@ -499,15 +498,20 @@ export type SpotMarketAccount = {
 	historicalOracleData: HistoricalOracleData;
 	historicalIndexData: HistoricalIndexData;
 
-	insuranceFundVault: PublicKey;
-	insuranceWithdrawEscrowPeriod: BN;
-	revenuePool: PoolBalance;
+	insuranceFund: {
+		vault: PublicKey;
+		totalShares: BN;
+		userShares: BN;
+		sharesBase: BN;
+		unstakingPeriod: BN;
+		lastRevenueSettleTs: BN;
+		revenueSettlePeriod: BN;
+		totalFactor: number;
+		userFactor: number;
+	};
 
-	totalIfShares: BN;
-	userIfShares: BN;
+	revenuePool: PoolBalance;
 
-	userIfFactor: number;
-	totalIfFactor: number;
 	ifLiquidationFee: BN;
 
 	decimals: number;
@@ -535,13 +539,14 @@ export type SpotMarketAccount = {
 	utilizationTwap: BN;
 
 	orderStepSize: BN;
+	orderTickSize: BN;
 	nextFillRecordId: BN;
 	spotFeePool: PoolBalance;
 	totalSpotFee: BN;
 };
 
 export type PoolBalance = {
-	balance: BN;
+	scaledBalance: BN;
 	marketIndex: number;
 };
 
@@ -575,14 +580,16 @@ export type AMM = {
 	cumulativeFeePerLp: BN;
 	cumulativeNetBaseAssetAmountPerLp: BN;
 	userLpShares: BN;
-	netUnsettledLpBaseAssetAmount: BN;
-	minimumQuoteAssetTradeSize: BN;
-	baseAssetAmountStepSize: BN;
-	maxBaseAssetAmountRatio: number;
+	baseAssetAmountWithUnsettledLp: BN;
+	orderStepSize: BN;
+	orderTickSize: BN;
+	maxFillReserveFraction: number;
 	maxSlippageRatio: number;
 	baseSpread: number;
 	curveUpdateIntensity: number;
-	netBaseAssetAmount: BN;
+	baseAssetAmountWithAmm: BN;
+	baseAssetAmountLong: BN;
+	baseAssetAmountShort: BN;
 	quoteAssetAmountLong: BN;
 	quoteAssetAmountShort: BN;
 	terminalQuoteAssetReserve: BN;
@@ -597,8 +604,10 @@ export type AMM = {
 	longSpread: BN;
 	shortSpread: BN;
 	maxSpread: number;
-	marketPosition: PerpPosition;
-	marketPositionPerLp: PerpPosition;
+
+	baseAssetAmountPerLp: BN;
+	quoteAssetAmountPerLp: BN;
+
 	ammJitIntensity: number;
 	maxBaseAssetReserve: BN;
 	minBaseAssetReserve: BN;
@@ -623,7 +632,7 @@ export type PerpPosition = {
 };
 
 export type UserStatsAccount = {
-	numberOfUsers: number;
+	numberOfSubAccounts: number;
 	makerVolume30D: BN;
 	takerVolume30D: BN;
 	fillerVolume30D: BN;
@@ -635,33 +644,38 @@ export type UserStatsAccount = {
 		totalFeeRebate: BN;
 		totalTokenDiscount: BN;
 		totalRefereeDiscount: BN;
+		totalReferrerReward: BN;
+		current_epoch_referrer_reward: BN;
 	};
 	referrer: PublicKey;
 	isReferrer: boolean;
-	totalReferrerReward: BN;
 	authority: PublicKey;
-	stakedQuoteAssetAmount: BN;
+	ifStakedQuoteAssetAmount: BN;
 };
 
 export type UserAccount = {
 	authority: PublicKey;
 	delegate: PublicKey;
 	name: number[];
-	userId: number;
+	subAccountId: number;
 	spotPositions: SpotPosition[];
 	perpPositions: PerpPosition[];
 	orders: Order[];
-	beingLiquidated: boolean;
-	bankrupt: boolean;
+	isBeingLiquidated: boolean;
+	isBankrupt: boolean;
 	nextLiquidationId: number;
 	nextOrderId: number;
-	customMarginRatio: number;
+	maxMarginRatio: number;
+	lastAddPerpLpSharesTs: BN;
+	settledPerpPnl: BN;
+	totalDeposits: BN;
+	totalWithdraws: BN;
 };
 
 export type SpotPosition = {
 	marketIndex: number;
 	balanceType: SpotBalanceType;
-	balance: BN;
+	scaledBalance: BN;
 	openOrders: number;
 	openBids: BN;
 	openAsks: BN;
@@ -672,7 +686,6 @@ export type Order = {
 	status: OrderStatus;
 	orderType: OrderType;
 	marketType: MarketType;
-	ts: BN;
 	slot: BN;
 	orderId: number;
 	userOrderId: number;
@@ -682,7 +695,6 @@ export type Order = {
 	baseAssetAmountFilled: BN;
 	quoteAssetAmount: BN;
 	quoteAssetAmountFilled: BN;
-	fee: BN;
 	direction: PositionDirection;
 	reduceOnly: boolean;
 	triggerPrice: BN;
@@ -691,11 +703,11 @@ export type Order = {
 	existingPositionDirection: PositionDirection;
 	postOnly: boolean;
 	immediateOrCancel: boolean;
-	oraclePriceOffset: BN;
+	oraclePriceOffset: number;
 	auctionDuration: number;
 	auctionStartPrice: BN;
 	auctionEndPrice: BN;
-	timeInForce: number;
+	maxTs: BN;
 };
 
 export type OrderParams = {
@@ -712,10 +724,11 @@ export type OrderParams = {
 	triggerPrice: BN | null;
 	triggerCondition: OrderTriggerCondition;
 	positionLimit: BN;
-	oraclePriceOffset: BN | null;
+	oraclePriceOffset: number | null;
 	auctionDuration: number | null;
-	timeInForce: number | null;
+	maxTs: BN | null;
 	auctionStartPrice: BN | null;
+	auctionEndPrice: BN | null;
 };
 
 export type NecessaryOrderParams = {
@@ -729,7 +742,7 @@ export type OptionalOrderParams = {
 	[Property in keyof OrderParams]?: OrderParams[Property];
 } & NecessaryOrderParams;
 
-export const DefaultOrderParams = {
+export const DefaultOrderParams: OrderParams = {
 	orderType: OrderType.MARKET,
 	marketType: MarketType.PERP,
 	userOrderId: 0,
@@ -745,8 +758,9 @@ export const DefaultOrderParams = {
 	positionLimit: ZERO,
 	oraclePriceOffset: null,
 	auctionDuration: null,
-	timeInForce: null,
+	maxTs: null,
 	auctionStartPrice: null,
+	auctionEndPrice: null,
 };
 
 export type MakerInfo = {

package/src/userMap/userMap.ts

@@ -10,7 +10,18 @@ import { ProgramAccount } from '@project-serum/anchor';
 
 import { PublicKey } from '@solana/web3.js';
 
-export class UserMap {
+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>;
+	getUserAuthority(key: string): PublicKey | undefined;
+	updateWithOrderRecord(record: OrderRecord): Promise<void>;
+	values(): IterableIterator<ClearingHouseUser>;
+}
+
+export class UserMap implements UserMapInterface {
 	private userMap = new Map<string, ClearingHouseUser>();
 	private clearingHouse: ClearingHouse;
 	private accountSubscription: ClearingHouseUserAccountSubscriptionConfig;
@@ -90,6 +101,19 @@ export class UserMap {
 		return user;
 	}
 
+	/**
+	 * gets the Authority for a particular userAccountPublicKey, if no ClearingHouseUser exists, undefined is returned
+	 * @param key userAccountPublicKey to get ClearngHouseUserFor
+	 * @returns authority PublicKey | undefined
+	 */
+	public getUserAuthority(key: string): PublicKey | undefined {
+		const chUser = this.userMap.get(key);
+		if (!chUser) {
+			return undefined;
+		}
+		return chUser.getUserAccount().authority;
+	}
+
 	public async updateWithOrderRecord(record: OrderRecord) {
 		await this.addPubkey(record.user);
 	}

package/src/userName.ts

@@ -1,10 +1,11 @@
 export const MAX_NAME_LENGTH = 32;
 
 export const DEFAULT_USER_NAME = 'Main Account';
+export const DEFAULT_MARKET_NAME = 'Default Market Name';
 
 export function encodeName(name: string): number[] {
 	if (name.length > MAX_NAME_LENGTH) {
-		throw Error(`User name (${name}) longer than 32 characters`);
+		throw Error(`Name (${name}) longer than 32 characters`);
 	}
 
 	const buffer = Buffer.alloc(32);

package/src/util/computeUnits.js

@@ -0,0 +1,27 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findComputeUnitConsumption = void 0;
+function findComputeUnitConsumption(programId, connection, txSignature, commitment = 'confirmed') {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tx = yield connection.getTransaction(txSignature, { commitment });
+        const computeUnits = [];
+        const regex = new RegExp(`Program ${programId.toString()} consumed ([0-9]{0,6}) of ([0-9]{0,7}) compute units`);
+        tx.meta.logMessages.forEach((logMessage) => {
+            const match = logMessage.match(regex);
+            if (match && match[1]) {
+                computeUnits.push(match[1]);
+            }
+        });
+        return computeUnits;
+    });
+}
+exports.findComputeUnitConsumption = findComputeUnitConsumption;

package/src/util/getTokenAddress.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTokenAddress = void 0;
+const spl_token_1 = require("@solana/spl-token");
+const web3_js_1 = require("@solana/web3.js");
+const getTokenAddress = (mintAddress, userPubKey) => {
+    return spl_token_1.Token.getAssociatedTokenAddress(spl_token_1.ASSOCIATED_TOKEN_PROGRAM_ID, spl_token_1.TOKEN_PROGRAM_ID, new web3_js_1.PublicKey(mintAddress), new web3_js_1.PublicKey(userPubKey));
+};
+exports.getTokenAddress = getTokenAddress;

package/src/util/promiseTimeout.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promiseTimeout = void 0;
+function promiseTimeout(promise, timeoutMs) {
+    let timeoutId;
+    const timeoutPromise = new Promise((resolve) => {
+        timeoutId = setTimeout(() => resolve(null), timeoutMs);
+    });
+    return Promise.race([promise, timeoutPromise]).then((result) => {
+        clearTimeout(timeoutId);
+        return result;
+    });
+}
+exports.promiseTimeout = promiseTimeout;

package/src/util/tps.js

@@ -0,0 +1,27 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.estimateTps = void 0;
+function estimateTps(programId, connection, failed) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let signatures = yield connection.getSignaturesForAddress(programId, undefined, 'finalized');
+        if (failed) {
+            signatures = signatures.filter((signature) => signature.err);
+        }
+        const numberOfSignatures = signatures.length;
+        if (numberOfSignatures === 0) {
+            return 0;
+        }
+        return (numberOfSignatures /
+            (signatures[0].blockTime - signatures[numberOfSignatures - 1].blockTime));
+    });
+}
+exports.estimateTps = estimateTps;

package/tests/bn/test.ts

@@ -1,4 +1,4 @@
-import { BN } from '../../src';
+import { BN } from '../../src/index';
 import { expect } from 'chai';
 import { BigNum } from '../../src/factory/bigNum';
 import {
@@ -6,6 +6,7 @@ import {
 	BASE_PRECISION_EXP,
 	TEN_THOUSAND,
 } from '../../src/constants/numericConstants';
+
 // if you used the '@types/mocha' method to install mocha type definitions, uncomment the following line
 // import 'mocha';
 
@@ -266,4 +267,24 @@ describe('BigNum Tests', () => {
 		const val10 = BigNum.from('100000000000', 6);
 		expect(val10.prettyPrint(true)).to.equal('100,000');
 	});
+
+	it('can round up and down', () => {
+		const val1 = BigNum.from('1234', 1);
+		expect(val1.toRounded(3).toString()).to.equal('1230');
+
+		const val2 = BigNum.from('1236', 1);
+		expect(val2.toRounded(3).toString()).to.equal('1240');
+
+		const val3 = BigNum.from('123456789', 5);
+		expect(val3.toRounded(4).print()).to.equal('1235.00000');
+
+		const val4 = BigNum.from('123456789', 5);
+		expect(val4.toRounded(3).print()).to.equal('1230.00000');
+
+		const val5 = BigNum.from('123000000', 5);
+		expect(val5.toRounded(3).print()).to.equal('1230.00000');
+
+		const val6 = BigNum.from('0', 5);
+		expect(val6.toRounded(3).print()).to.equal('0.00000');
+	});
 });