@drift-labs/sdk 2.20.0 → 2.21.0-beta.0

package/lib/driftClient.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="bn.js" />
-import { AnchorProvider, BN, Program } from '@project-serum/anchor';
+import { AnchorProvider, BN, Program, ProgramAccount } from '@project-serum/anchor';
 import { StateAccount, IWallet, PositionDirection, UserAccount, PerpMarketAccount, OrderParams, Order, SpotMarketAccount, SpotPosition, MakerInfo, TakerInfo, OptionalOrderParams, OrderType, ReferrerInfo, MarketType, TxParams, SerumV3FulfillmentConfigAccount, ReferrerNameAccount, OrderTriggerCondition, PerpMarketExtendedInfo } from './types';
 import * as anchor from '@project-serum/anchor';
 import { Connection, PublicKey, TransactionSignature, ConfirmOptions, Transaction, TransactionInstruction, AccountMeta, Signer, AddressLookupTableAccount } from '@solana/web3.js';
@@ -101,6 +101,7 @@ export declare class DriftClient {
     updateUserCustomMarginRatio(marginRatio: number, subAccountId?: number): Promise<TransactionSignature>;
     updateUserMarginTradingEnabled(marginTradingEnabled: boolean, subAccountId?: number): Promise<TransactionSignature>;
     updateUserDelegate(delegate: PublicKey, subAccountId?: number): Promise<TransactionSignature>;
+    fetchAllUserAccounts(includeIdle?: boolean): Promise<ProgramAccount<UserAccount>[]>;
     getUserAccountsForDelegate(delegate: PublicKey): Promise<UserAccount[]>;
     getUserAccountsForAuthority(authority: PublicKey): Promise<UserAccount[]>;
     deleteUser(subAccountId?: number, txParams?: TxParams): Promise<TransactionSignature>;
@@ -200,6 +201,8 @@ export declare class DriftClient {
     getTriggerOrderIx(userAccountPublicKey: PublicKey, userAccount: UserAccount, order: Order): Promise<TransactionInstruction>;
     forceCancelOrders(userAccountPublicKey: PublicKey, user: UserAccount, txParams?: TxParams): Promise<TransactionSignature>;
     getForceCancelOrdersIx(userAccountPublicKey: PublicKey, userAccount: UserAccount): Promise<TransactionInstruction>;
+    updateUserInactive(userAccountPublicKey: PublicKey, user: UserAccount, txParams?: TxParams): Promise<TransactionSignature>;
+    getUpdateUserInactiveIx(userAccountPublicKey: PublicKey, userAccount: UserAccount): Promise<TransactionInstruction>;
     placeAndTakePerpOrder(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<TransactionSignature>;
     getPlaceAndTakePerpOrderIx(orderParams: OptionalOrderParams, makerInfo?: MakerInfo | MakerInfo[], referrerInfo?: ReferrerInfo): Promise<TransactionInstruction>;
     placeAndMakePerpOrder(orderParams: OptionalOrderParams, takerInfo: TakerInfo, referrerInfo?: ReferrerInfo, txParams?: TxParams): Promise<TransactionSignature>;

package/lib/driftClient.js

@@ -424,6 +424,20 @@ class DriftClient {
         const { txSig } = await this.sendTransaction(tx, [], this.opts);
         return txSig;
     }
+    async fetchAllUserAccounts(includeIdle = true) {
+        let filters = undefined;
+        if (!includeIdle) {
+            filters = [
+                {
+                    memcmp: {
+                        offset: 4350,
+                        bytes: bs58_1.default.encode(Uint8Array.from([0])),
+                    },
+                },
+            ];
+        }
+        return (await this.program.account.user.all(filters));
+    }
     async getUserAccountsForDelegate(delegate) {
         const programAccounts = await this.program.account.user.all([
             {
@@ -1578,6 +1592,25 @@ class DriftClient {
             remainingAccounts,
         });
     }
+    async updateUserInactive(userAccountPublicKey, user, txParams) {
+        const { txSig } = await this.txSender.send((0, utils_1.wrapInTx)(await this.getUpdateUserInactiveIx(userAccountPublicKey, user), txParams === null || txParams === void 0 ? void 0 : txParams.computeUnits, txParams === null || txParams === void 0 ? void 0 : txParams.computeUnitsPrice), [], this.opts);
+        return txSig;
+    }
+    async getUpdateUserInactiveIx(userAccountPublicKey, userAccount) {
+        const fillerPublicKey = await this.getUserAccountPublicKey();
+        const remainingAccounts = this.getRemainingAccounts({
+            userAccounts: [userAccount],
+        });
+        return await this.program.instruction.updateUserInactive({
+            accounts: {
+                state: await this.getStatePublicKey(),
+                filler: fillerPublicKey,
+                user: userAccountPublicKey,
+                authority: this.wallet.publicKey,
+            },
+            remainingAccounts,
+        });
+    }
     async placeAndTakePerpOrder(orderParams, makerInfo, referrerInfo, txParams) {
         const { txSig, slot } = await this.sendTransaction((0, utils_1.wrapInTx)(await this.getPlaceAndTakePerpOrderIx(orderParams, makerInfo, referrerInfo), txParams === null || txParams === void 0 ? void 0 : txParams.computeUnits, txParams === null || txParams === void 0 ? void 0 : txParams.computeUnitsPrice), [], this.opts);
         this.perpMarketLastSlotCache.set(orderParams.marketIndex, slot);

package/lib/idl/drift.json

@@ -1,5 +1,5 @@
 {
-    "version": "2.20.0",
+    "version": "2.21.0-beta.0",
     "name": "drift",
     "instructions": [
         {
@@ -4543,7 +4543,7 @@
                         "type": "u64"
                     },
                     {
-                        "name": "liquidationStartSlot",
+                        "name": "lastActiveSlot",
                         "type": "u64"
                     },
                     {
@@ -4572,12 +4572,16 @@
                         "name": "isMarginTradingEnabled",
                         "type": "bool"
                     },
+                    {
+                        "name": "idle",
+                        "type": "bool"
+                    },
                     {
                         "name": "padding",
                         "type": {
                             "array": [
                                 "u8",
-                                26
+                                25
                             ]
                         }
                     }
@@ -8733,6 +8737,11 @@
             "code": 6237,
             "name": "UnableToLoadUserStatsAccount",
             "msg": "UnableToLoadUserStatsAccount"
+        },
+        {
+            "code": 6238,
+            "name": "UserNotInactive",
+            "msg": "User Not Inactive"
         }
     ]
 }

package/lib/types.d.ts

@@ -845,8 +845,9 @@ export type UserAccount = {
     totalSocialLoss: BN;
     cumulativePerpFunding: BN;
     liquidationMarginFreed: BN;
-    liquidationStartSlot: BN;
+    lastActiveSlot: BN;
     isMarginTradingEnabled: boolean;
+    inactive: boolean;
 };
 export type SpotPosition = {
     marketIndex: number;

package/lib/user.d.ts

@@ -269,6 +269,7 @@ export declare class User {
         depositAmount: BN;
         maxDepositAmount: BN;
     };
+    canMakeIdle(slot: BN, slotsBeforeIdle: BN): boolean;
     /**
      * Get the total position value, excluding any position coming from the given target market
      * @param marketToIgnore

package/lib/user.js

@@ -1212,6 +1212,38 @@ class User {
             depositAmount,
         };
     }
+    canMakeIdle(slot, slotsBeforeIdle) {
+        const userAccount = this.getUserAccount();
+        if (userAccount.inactive) {
+            return false;
+        }
+        const userLastActiveSlot = userAccount.lastActiveSlot;
+        if (userLastActiveSlot.lt(slotsBeforeIdle)) {
+            return false;
+        }
+        if (this.isBeingLiquidated()) {
+            return false;
+        }
+        for (const perpPosition of userAccount.perpPositions) {
+            if (!(0, position_1.positionIsAvailable)(perpPosition)) {
+                return false;
+            }
+        }
+        for (const spotPosition of userAccount.spotPositions) {
+            if ((0, types_1.isVariant)(spotPosition.balanceType, 'borrow')) {
+                return false;
+            }
+            if (spotPosition.openOrders !== 0) {
+                return false;
+            }
+        }
+        for (const order of userAccount.orders) {
+            if (!(0, types_1.isVariant)(order.status, 'init')) {
+                return false;
+            }
+        }
+        return true;
+    }
     /**
      * Get the total position value, excluding any position coming from the given target market
      * @param marketToIgnore

package/lib/userMap/userMap.d.ts

@@ -15,7 +15,7 @@ export declare class UserMap implements UserMapInterface {
     private driftClient;
     private accountSubscription;
     constructor(driftClient: DriftClient, accountSubscription: UserSubscriptionConfig);
-    fetchAllUsers(): Promise<void>;
+    fetchAllUsers(includeIdle?: boolean): Promise<void>;
     addPubkey(userAccountPublicKey: PublicKey): Promise<void>;
     has(key: string): boolean;
     /**

package/lib/userMap/userMap.js

@@ -9,10 +9,10 @@ class UserMap {
         this.driftClient = driftClient;
         this.accountSubscription = accountSubscription;
     }
-    async fetchAllUsers() {
+    async fetchAllUsers(includeIdle = true) {
         const userArray = [];
         const userAccountArray = [];
-        const programUserAccounts = (await this.driftClient.program.account.user.all());
+        const programUserAccounts = await this.driftClient.fetchAllUserAccounts(includeIdle);
         for (const programUserAccount of programUserAccounts) {
             if (this.userMap.has(programUserAccount.publicKey.toString())) {
                 continue;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.20.0",
+	"version": "2.21.0-beta.0",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",

package/src/driftClient.ts

@@ -1,4 +1,10 @@
-import { AnchorProvider, BN, Idl, Program } from '@project-serum/anchor';
+import {
+	AnchorProvider,
+	BN,
+	Idl,
+	Program,
+	ProgramAccount,
+} from '@project-serum/anchor';
 import bs58 from 'bs58';
 import {
 	ASSOCIATED_TOKEN_PROGRAM_ID,
@@ -713,6 +719,25 @@ export class DriftClient {
 		return txSig;
 	}
 
+	public async fetchAllUserAccounts(
+		includeIdle = true
+	): Promise<ProgramAccount<UserAccount>[]> {
+		let filters = undefined;
+		if (!includeIdle) {
+			filters = [
+				{
+					memcmp: {
+						offset: 4350,
+						bytes: bs58.encode(Uint8Array.from([0])),
+					},
+				},
+			];
+		}
+		return (await this.program.account.user.all(
+			filters
+		)) as ProgramAccount<UserAccount>[];
+	}
+
 	public async getUserAccountsForDelegate(
 		delegate: PublicKey
 	): Promise<UserAccount[]> {
@@ -2734,6 +2759,44 @@ export class DriftClient {
 		});
 	}
 
+	public async updateUserInactive(
+		userAccountPublicKey: PublicKey,
+		user: UserAccount,
+		txParams?: TxParams
+	): Promise<TransactionSignature> {
+		const { txSig } = await this.txSender.send(
+			wrapInTx(
+				await this.getUpdateUserInactiveIx(userAccountPublicKey, user),
+				txParams?.computeUnits,
+				txParams?.computeUnitsPrice
+			),
+			[],
+			this.opts
+		);
+		return txSig;
+	}
+
+	public async getUpdateUserInactiveIx(
+		userAccountPublicKey: PublicKey,
+		userAccount: UserAccount
+	): Promise<TransactionInstruction> {
+		const fillerPublicKey = await this.getUserAccountPublicKey();
+
+		const remainingAccounts = this.getRemainingAccounts({
+			userAccounts: [userAccount],
+		});
+
+		return await this.program.instruction.updateUserInactive({
+			accounts: {
+				state: await this.getStatePublicKey(),
+				filler: fillerPublicKey,
+				user: userAccountPublicKey,
+				authority: this.wallet.publicKey,
+			},
+			remainingAccounts,
+		});
+	}
+
 	public async placeAndTakePerpOrder(
 		orderParams: OptionalOrderParams,
 		makerInfo?: MakerInfo | MakerInfo[],

package/src/idl/drift.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.20.0",
+  "version": "2.21.0-beta.0",
   "name": "drift",
   "instructions": [
     {
@@ -4543,7 +4543,7 @@
             "type": "u64"
           },
           {
-            "name": "liquidationStartSlot",
+            "name": "lastActiveSlot",
             "type": "u64"
           },
           {
@@ -4572,12 +4572,16 @@
             "name": "isMarginTradingEnabled",
             "type": "bool"
           },
+          {
+            "name": "idle",
+            "type": "bool"
+          },
           {
             "name": "padding",
             "type": {
               "array": [
                 "u8",
-                26
+                25
               ]
             }
           }
@@ -8733,6 +8737,11 @@
       "code": 6237,
       "name": "UnableToLoadUserStatsAccount",
       "msg": "UnableToLoadUserStatsAccount"
+    },
+    {
+      "code": 6238,
+      "name": "UserNotInactive",
+      "msg": "User Not Inactive"
     }
   ]
 }

package/src/types.ts

@@ -798,8 +798,9 @@ export type UserAccount = {
 	totalSocialLoss: BN;
 	cumulativePerpFunding: BN;
 	liquidationMarginFreed: BN;
-	liquidationStartSlot: BN;
+	lastActiveSlot: BN;
 	isMarginTradingEnabled: boolean;
+	inactive: boolean;
 };
 
 export type SpotPosition = {

package/src/user.ts

@@ -12,7 +12,7 @@ import {
 	isOneOfVariant,
 	PerpMarketAccount,
 } from './types';
-import { calculateEntryPrice } from './math/position';
+import { calculateEntryPrice, positionIsAvailable } from './math/position';
 import {
 	PRICE_PRECISION,
 	AMM_TO_QUOTE_PRECISION_RATIO,
@@ -2171,6 +2171,46 @@ export class User {
 		};
 	}
 
+	public canMakeIdle(slot: BN, slotsBeforeIdle: BN): boolean {
+		const userAccount = this.getUserAccount();
+		if (userAccount.inactive) {
+			return false;
+		}
+
+		const userLastActiveSlot = userAccount.lastActiveSlot;
+		if (userLastActiveSlot.lt(slotsBeforeIdle)) {
+			return false;
+		}
+
+		if (this.isBeingLiquidated()) {
+			return false;
+		}
+
+		for (const perpPosition of userAccount.perpPositions) {
+			if (!positionIsAvailable(perpPosition)) {
+				return false;
+			}
+		}
+
+		for (const spotPosition of userAccount.spotPositions) {
+			if (isVariant(spotPosition.balanceType, 'borrow')) {
+				return false;
+			}
+
+			if (spotPosition.openOrders !== 0) {
+				return false;
+			}
+		}
+
+		for (const order of userAccount.orders) {
+			if (!isVariant(order.status, 'init')) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
 	/**
 	 * Get the total position value, excluding any position coming from the given target market
 	 * @param marketToIgnore

package/src/userMap/userMap.ts

@@ -14,7 +14,6 @@ import {
 	NewUserRecord,
 	LPRecord,
 } from '..';
-import { ProgramAccount } from '@project-serum/anchor';
 
 import { PublicKey } from '@solana/web3.js';
 
@@ -42,12 +41,13 @@ export class UserMap implements UserMapInterface {
 		this.accountSubscription = accountSubscription;
 	}
 
-	public async fetchAllUsers() {
+	public async fetchAllUsers(includeIdle = true) {
 		const userArray: User[] = [];
 		const userAccountArray: UserAccount[] = [];
 
-		const programUserAccounts =
-			(await this.driftClient.program.account.user.all()) as ProgramAccount<UserAccount>[];
+		const programUserAccounts = await this.driftClient.fetchAllUserAccounts(
+			includeIdle
+		);
 		for (const programUserAccount of programUserAccounts) {
 			if (this.userMap.has(programUserAccount.publicKey.toString())) {
 				continue;

package/src/assert/assert.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assert = void 0;
-function assert(condition, error) {
-    if (!condition) {
-        throw new Error(error || 'Unspecified AssertionError');
-    }
-}
-exports.assert = assert;

package/src/token/index.js

@@ -1,38 +0,0 @@
-"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/util/computeUnits.js

@@ -1,27 +0,0 @@
-"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

@@ -1,9 +0,0 @@
-"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

@@ -1,14 +0,0 @@
-"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

@@ -1,27 +0,0 @@
-"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;