@drift-labs/common 1.0.0

package/lib/drift/base/actions/user/create.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserAndDepositCollateralBaseTxn = exports.createUserAndDepositCollateralBaseIxs = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const token_1 = require("../../../../utils/token");
+const accountNames_1 = require("../../constants/accountNames");
+const pools_1 = require("../../../../constants/pools");
+const user_1 = require("../../../../common-ui-utils/user");
+/**
+ * Creates transaction instructions for initializing a new user account and depositing collateral.
+ *
+ * This function generates the necessary transaction instructions to:
+ * 1. Initialize a new user account in the Drift protocol
+ * 2. Deposit collateral into the newly created account
+ *
+ * @param driftClient - The Drift client instance for interacting with the protocol
+ * @param amount - The amount of collateral to deposit (in base units)
+ * @param spotMarketConfig - The spot market config of the deposit collateral
+ * @param authority - The public key of the account authority (wallet owner)
+ * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID
+ * @param referrerName - Optional name of the referrer for referral tracking
+ * @param accountName - Optional custom name for the account (defaults to pool-specific name)
+ * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)
+ * @param fromSubAccountId - Optional sub-account ID to transfer funds from
+ * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account
+ *
+ * @returns Promise resolving to an object containing:
+ *   - subAccountId: The ID of the newly created sub-account
+ *   - userAccountPublicKey: The public key of the created user account
+ *   - ixs: Array of transaction instructions to execute
+ */
+const createUserAndDepositCollateralBaseIxs = async ({ driftClient, amount, spotMarketConfig, authority, userStatsAccount, referrerName, accountName, poolId = pools_1.MAIN_POOL_ID, fromSubAccountId, customMaxMarginRatio, }) => {
+    var _a;
+    const nextUserId = (_a = userStatsAccount === null || userStatsAccount === void 0 ? void 0 : userStatsAccount.numberOfSubAccountsCreated) !== null && _a !== void 0 ? _a : 0; // userId is zero indexed
+    const associatedDepositTokenAddressPromise = (0, token_1.getTokenAddressForDepositAndWithdraw)(spotMarketConfig.mint, authority);
+    const referrerInfoPromise = referrerName
+        ? driftClient.fetchReferrerNameAccount(referrerName)
+        : Promise.resolve(undefined);
+    const subaccountExistsPromise = user_1.USER_UTILS.checkIfUserAccountExists(driftClient, {
+        type: 'subAccountId',
+        subAccountId: nextUserId,
+        authority,
+    });
+    const [associatedDepositTokenAddress, referrerInfo, subaccountExists] = await Promise.all([
+        associatedDepositTokenAddressPromise,
+        referrerInfoPromise,
+        subaccountExistsPromise,
+    ]);
+    if (subaccountExists) {
+        throw new Error('Subaccount already exists');
+    }
+    const accountNameToUse = accountName !== null && accountName !== void 0 ? accountName : (poolId !== pools_1.MAIN_POOL_ID || nextUserId === 0
+        ? accountNames_1.DEFAULT_ACCOUNT_NAMES_BY_POOL_ID[poolId]
+        : `Account ${nextUserId}`);
+    const { ixs, userAccountPublicKey } = await driftClient.createInitializeUserAccountAndDepositCollateralIxs(amount, associatedDepositTokenAddress, spotMarketConfig.marketIndex, nextUserId, accountNameToUse, fromSubAccountId, referrerInfo, sdk_1.ZERO, customMaxMarginRatio, poolId);
+    return {
+        subAccountId: nextUserId,
+        userAccountPublicKey,
+        ixs,
+    };
+};
+exports.createUserAndDepositCollateralBaseIxs = createUserAndDepositCollateralBaseIxs;
+/**
+ * Creates a complete transaction for initializing a new user account and depositing collateral.
+ *
+ * This function is a higher-level wrapper around `createUserAndDepositCollateralBaseIxs` that:
+ * 1. Generates the necessary transaction instructions
+ * 2. Builds a complete transaction ready for signing and submission
+ *
+ * @param driftClient - The Drift client instance for interacting with the protocol
+ * @param amount - The amount of collateral to deposit (in base units)
+ * @param spotMarketConfig - The spot market config of the deposit collateral
+ * @param authority - The public key of the account authority (wallet owner)
+ * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID
+ * @param referrerName - Optional name of the referrer for referral tracking
+ * @param accountName - Optional custom name for the account (defaults to pool-specific name)
+ * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)
+ * @param fromSubAccountId - Optional sub-account ID to transfer funds from
+ * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account
+ * @param txParams - Transaction parameters for building the transaction (compute units, priority fees, etc.)
+ *
+ * @returns Promise resolving to an object containing:
+ *   - transaction: The built transaction ready for signing (Transaction or VersionedTransaction)
+ *   - userAccountPublicKey: The public key of the created user account
+ *   - subAccountId: The ID of the newly created sub-account
+ */
+const createUserAndDepositCollateralBaseTxn = async ({ driftClient, amount, spotMarketConfig, authority, userStatsAccount, referrerName, accountName, poolId = pools_1.MAIN_POOL_ID, fromSubAccountId, customMaxMarginRatio, txParams, }) => {
+    const { ixs, userAccountPublicKey, subAccountId } = await (0, exports.createUserAndDepositCollateralBaseIxs)({
+        driftClient,
+        amount,
+        spotMarketConfig,
+        authority,
+        userStatsAccount,
+        referrerName,
+        accountName,
+        poolId,
+        fromSubAccountId,
+        customMaxMarginRatio,
+    });
+    const tx = await driftClient.buildTransaction(ixs, txParams);
+    return { transaction: tx, userAccountPublicKey, subAccountId };
+};
+exports.createUserAndDepositCollateralBaseTxn = createUserAndDepositCollateralBaseTxn;
+//# sourceMappingURL=create.js.map

package/lib/drift/base/actions/user/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../../../src/drift/base/actions/user/create.ts"],"names":[],"mappings":";;;AAAA,yCASyB;AACzB,mDAA+E;AAC/E,+DAAgF;AAChF,uDAA2D;AAM3D,2DAA8D;AAe9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,MAAM,qCAAqC,GAAG,KAAK,EAAE,EAC3D,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,MAAM,GAAG,oBAAY,EACrB,gBAAgB,EAChB,oBAAoB,GACyB,EAI3C,EAAE;;IACJ,MAAM,UAAU,GAAG,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,0BAA0B,mCAAI,CAAC,CAAC,CAAC,yBAAyB;IAE/F,MAAM,oCAAoC,GACzC,IAAA,4CAAoC,EAAC,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACxE,MAAM,mBAAmB,GAAsC,YAAY;QAC1E,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,YAAY,CAAC;QACpD,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9B,MAAM,uBAAuB,GAAG,iBAAU,CAAC,wBAAwB,CAClE,WAAW,EACX;QACC,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,UAAU;QACxB,SAAS;KACT,CACD,CAAC;IAEF,MAAM,CAAC,6BAA6B,EAAE,YAAY,EAAE,gBAAgB,CAAC,GACpE,MAAM,OAAO,CAAC,GAAG,CAAC;QACjB,oCAAoC;QACpC,mBAAmB;QACnB,uBAAuB;KACvB,CAAC,CAAC;IAEJ,IAAI,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,gBAAgB,GACrB,WAAW,aAAX,WAAW,cAAX,WAAW,GACX,CAAC,MAAM,KAAK,oBAAY,IAAI,UAAU,KAAK,CAAC;QAC3C,CAAC,CAAC,+CAAgC,CAAC,MAAM,CAAC;QAC1C,CAAC,CAAC,WAAW,UAAU,EAAE,CAAC,CAAC;IAE7B,MAAM,EAAE,GAAG,EAAE,oBAAoB,EAAE,GAClC,MAAM,WAAW,CAAC,kDAAkD,CACnE,MAAM,EACN,6BAA6B,EAC7B,gBAAgB,CAAC,WAAW,EAC5B,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,UAAI,EACJ,oBAAoB,EACpB,MAAM,CACN,CAAC;IAEH,OAAO;QACN,YAAY,EAAE,UAAU;QACxB,oBAAoB;QACpB,GAAG;KACH,CAAC;AACH,CAAC,CAAC;AApEW,QAAA,qCAAqC,yCAoEhD;AAOF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,qCAAqC,GAAG,KAAK,EAAE,EAC3D,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,MAAM,GAAG,oBAAY,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,GACqC,EAI3C,EAAE;IACJ,MAAM,EAAE,GAAG,EAAE,oBAAoB,EAAE,YAAY,EAAE,GAChD,MAAM,IAAA,6CAAqC,EAAC;QAC3C,WAAW;QACX,MAAM;QACN,gBAAgB;QAChB,SAAS;QACT,gBAAgB;QAChB,YAAY;QACZ,WAAW;QACX,MAAM;QACN,gBAAgB;QAChB,oBAAoB;KACpB,CAAC,CAAC;IAEJ,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAE7D,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,oBAAoB,EAAE,YAAY,EAAE,CAAC;AAChE,CAAC,CAAC;AAlCW,QAAA,qCAAqC,yCAkChD","sourcesContent":["import {\n\tBN,\n\tDriftClient,\n\tPublicKey,\n\tReferrerInfo,\n\tSpotMarketConfig,\n\tTxParams,\n\tUserStatsAccount,\n\tZERO,\n} from '@drift-labs/sdk';\nimport { getTokenAddressForDepositAndWithdraw } from '../../../../utils/token';\nimport { DEFAULT_ACCOUNT_NAMES_BY_POOL_ID } from '../../constants/accountNames';\nimport { MAIN_POOL_ID } from '../../../../constants/pools';\nimport {\n\tTransaction,\n\tTransactionInstruction,\n\tVersionedTransaction,\n} from '@solana/web3.js';\nimport { USER_UTILS } from '../../../../common-ui-utils/user';\n\ninterface CreateUserAndDepositCollateralBaseIxsParams {\n\tdriftClient: DriftClient;\n\tamount: BN;\n\tspotMarketConfig: SpotMarketConfig;\n\tauthority: PublicKey;\n\tuserStatsAccount: UserStatsAccount | undefined;\n\treferrerName?: string;\n\taccountName?: string;\n\tpoolId?: number;\n\tfromSubAccountId?: number;\n\tcustomMaxMarginRatio?: number;\n}\n\n/**\n * Creates transaction instructions for initializing a new user account and depositing collateral.\n *\n * This function generates the necessary transaction instructions to:\n * 1. Initialize a new user account in the Drift protocol\n * 2. Deposit collateral into the newly created account\n *\n * @param driftClient - The Drift client instance for interacting with the protocol\n * @param amount - The amount of collateral to deposit (in base units)\n * @param spotMarketConfig - The spot market config of the deposit collateral\n * @param authority - The public key of the account authority (wallet owner)\n * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID\n * @param referrerName - Optional name of the referrer for referral tracking\n * @param accountName - Optional custom name for the account (defaults to pool-specific name)\n * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)\n * @param fromSubAccountId - Optional sub-account ID to transfer funds from\n * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account\n *\n * @returns Promise resolving to an object containing:\n *   - subAccountId: The ID of the newly created sub-account\n *   - userAccountPublicKey: The public key of the created user account\n *   - ixs: Array of transaction instructions to execute\n */\nexport const createUserAndDepositCollateralBaseIxs = async ({\n\tdriftClient,\n\tamount,\n\tspotMarketConfig,\n\tauthority,\n\tuserStatsAccount,\n\treferrerName,\n\taccountName,\n\tpoolId = MAIN_POOL_ID,\n\tfromSubAccountId,\n\tcustomMaxMarginRatio,\n}: CreateUserAndDepositCollateralBaseIxsParams): Promise<{\n\tsubAccountId: number;\n\tuserAccountPublicKey: PublicKey;\n\tixs: TransactionInstruction[];\n}> => {\n\tconst nextUserId = userStatsAccount?.numberOfSubAccountsCreated ?? 0; // userId is zero indexed\n\n\tconst associatedDepositTokenAddressPromise =\n\t\tgetTokenAddressForDepositAndWithdraw(spotMarketConfig.mint, authority);\n\tconst referrerInfoPromise: Promise<ReferrerInfo | undefined> = referrerName\n\t\t? driftClient.fetchReferrerNameAccount(referrerName)\n\t\t: Promise.resolve(undefined);\n\tconst subaccountExistsPromise = USER_UTILS.checkIfUserAccountExists(\n\t\tdriftClient,\n\t\t{\n\t\t\ttype: 'subAccountId',\n\t\t\tsubAccountId: nextUserId,\n\t\t\tauthority,\n\t\t}\n\t);\n\n\tconst [associatedDepositTokenAddress, referrerInfo, subaccountExists] =\n\t\tawait Promise.all([\n\t\t\tassociatedDepositTokenAddressPromise,\n\t\t\treferrerInfoPromise,\n\t\t\tsubaccountExistsPromise,\n\t\t]);\n\n\tif (subaccountExists) {\n\t\tthrow new Error('Subaccount already exists');\n\t}\n\n\tconst accountNameToUse =\n\t\taccountName ??\n\t\t(poolId !== MAIN_POOL_ID || nextUserId === 0\n\t\t\t? DEFAULT_ACCOUNT_NAMES_BY_POOL_ID[poolId]\n\t\t\t: `Account ${nextUserId}`);\n\n\tconst { ixs, userAccountPublicKey } =\n\t\tawait driftClient.createInitializeUserAccountAndDepositCollateralIxs(\n\t\t\tamount,\n\t\t\tassociatedDepositTokenAddress,\n\t\t\tspotMarketConfig.marketIndex,\n\t\t\tnextUserId,\n\t\t\taccountNameToUse,\n\t\t\tfromSubAccountId,\n\t\t\treferrerInfo,\n\t\t\tZERO,\n\t\t\tcustomMaxMarginRatio,\n\t\t\tpoolId\n\t\t);\n\n\treturn {\n\t\tsubAccountId: nextUserId,\n\t\tuserAccountPublicKey,\n\t\tixs,\n\t};\n};\n\ninterface CreateUserAndDepositCollateralBaseTxnParams\n\textends CreateUserAndDepositCollateralBaseIxsParams {\n\ttxParams?: TxParams;\n}\n\n/**\n * Creates a complete transaction for initializing a new user account and depositing collateral.\n *\n * This function is a higher-level wrapper around `createUserAndDepositCollateralBaseIxs` that:\n * 1. Generates the necessary transaction instructions\n * 2. Builds a complete transaction ready for signing and submission\n *\n * @param driftClient - The Drift client instance for interacting with the protocol\n * @param amount - The amount of collateral to deposit (in base units)\n * @param spotMarketConfig - The spot market config of the deposit collateral\n * @param authority - The public key of the account authority (wallet owner)\n * @param userStatsAccount - Existing user stats account, used to determine next sub-account ID\n * @param referrerName - Optional name of the referrer for referral tracking\n * @param accountName - Optional custom name for the account (defaults to pool-specific name)\n * @param poolId - The pool ID to associate the account with (defaults to MAIN_POOL_ID)\n * @param fromSubAccountId - Optional sub-account ID to transfer funds from\n * @param customMaxMarginRatio - Optional custom maximum margin ratio for the account\n * @param txParams - Transaction parameters for building the transaction (compute units, priority fees, etc.)\n *\n * @returns Promise resolving to an object containing:\n *   - transaction: The built transaction ready for signing (Transaction or VersionedTransaction)\n *   - userAccountPublicKey: The public key of the created user account\n *   - subAccountId: The ID of the newly created sub-account\n */\nexport const createUserAndDepositCollateralBaseTxn = async ({\n\tdriftClient,\n\tamount,\n\tspotMarketConfig,\n\tauthority,\n\tuserStatsAccount,\n\treferrerName,\n\taccountName,\n\tpoolId = MAIN_POOL_ID,\n\tfromSubAccountId,\n\tcustomMaxMarginRatio,\n\ttxParams,\n}: CreateUserAndDepositCollateralBaseTxnParams): Promise<{\n\ttransaction: Transaction | VersionedTransaction;\n\tuserAccountPublicKey: PublicKey;\n\tsubAccountId: number;\n}> => {\n\tconst { ixs, userAccountPublicKey, subAccountId } =\n\t\tawait createUserAndDepositCollateralBaseIxs({\n\t\t\tdriftClient,\n\t\t\tamount,\n\t\t\tspotMarketConfig,\n\t\t\tauthority,\n\t\t\tuserStatsAccount,\n\t\t\treferrerName,\n\t\t\taccountName,\n\t\t\tpoolId,\n\t\t\tfromSubAccountId,\n\t\t\tcustomMaxMarginRatio,\n\t\t});\n\n\tconst tx = await driftClient.buildTransaction(ixs, txParams);\n\n\treturn { transaction: tx, userAccountPublicKey, subAccountId };\n};\n"]}

package/lib/drift/base/actions/user/delete.d.ts

@@ -0,0 +1,47 @@
+import { DriftClient, TxParams, User } from '@drift-labs/sdk';
+/**
+ * Parameters required for deleting a user instruction
+ */
+interface DeleteUserIxParams {
+    /** The Drift protocol client instance */
+    driftClient: DriftClient;
+    /** The user account to be deleted */
+    user: User;
+}
+/**
+ * Creates a user deletion instruction.
+ *
+ * @example
+ * ```typescript
+ * const deleteIx = await deleteUserIx({
+ *   driftClient: driftClient,
+ *   user: userClient
+ * });
+ * ```
+ */
+export declare const deleteUserIx: ({ driftClient, user, }: DeleteUserIxParams) => Promise<import("@solana/web3.js").TransactionInstruction>;
+/**
+ * Parameters required for creating a user deletion transaction
+ * Extends DeleteUserIxParams with optional transaction parameters
+ */
+interface DeleteUserTxnParams extends DeleteUserIxParams {
+    /** Optional transaction parameters for customizing the transaction */
+    txParams?: TxParams;
+}
+/**
+ * Creates a user deletion transaction.
+ *
+ * @example
+ * ```typescript
+ * const deleteTxn = await deleteUserTxn({
+ *   driftClient: driftClient,
+ *   user: userClient,
+ *   txParams: { useSimulatedComputeUnits: true }
+ * });
+ *
+ * // Sign and send the transaction
+ * const signature = await driftClient.sendTransaction(deleteTxn);
+ * ```
+ */
+export declare const deleteUserTxn: ({ driftClient, user, txParams, }: DeleteUserTxnParams) => Promise<import("@solana/web3.js").Transaction | import("@solana/web3.js").VersionedTransaction>;
+export {};

package/lib/drift/base/actions/user/delete.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteUserTxn = exports.deleteUserIx = void 0;
+/**
+ * Creates a user deletion instruction.
+ *
+ * @example
+ * ```typescript
+ * const deleteIx = await deleteUserIx({
+ *   driftClient: driftClient,
+ *   user: userClient
+ * });
+ * ```
+ */
+const deleteUserIx = async ({ driftClient, user, }) => {
+    return driftClient.getUserDeletionIx(user.userAccountPublicKey);
+};
+exports.deleteUserIx = deleteUserIx;
+/**
+ * Creates a user deletion transaction.
+ *
+ * @example
+ * ```typescript
+ * const deleteTxn = await deleteUserTxn({
+ *   driftClient: driftClient,
+ *   user: userClient,
+ *   txParams: { useSimulatedComputeUnits: true }
+ * });
+ *
+ * // Sign and send the transaction
+ * const signature = await driftClient.sendTransaction(deleteTxn);
+ * ```
+ */
+const deleteUserTxn = async ({ driftClient, user, txParams, }) => {
+    const deleteIx = await (0, exports.deleteUserIx)({ driftClient, user });
+    return driftClient.buildTransaction(deleteIx, txParams);
+};
+exports.deleteUserTxn = deleteUserTxn;
+//# sourceMappingURL=delete.js.map

package/lib/drift/base/actions/user/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../../../../src/drift/base/actions/user/delete.ts"],"names":[],"mappings":";;;AAYA;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,KAAK,EAAE,EAClC,WAAW,EACX,IAAI,GACgB,EAAE,EAAE;IACxB,OAAO,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AACjE,CAAC,CAAC;AALW,QAAA,YAAY,gBAKvB;AAWF;;;;;;;;;;;;;;GAcG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,EACnC,WAAW,EACX,IAAI,EACJ,QAAQ,GACa,EAAE,EAAE;IACzB,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAY,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,OAAO,WAAW,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACzD,CAAC,CAAC;AAPW,QAAA,aAAa,iBAOxB","sourcesContent":["import { DriftClient, TxParams, User } from '@drift-labs/sdk';\n\n/**\n * Parameters required for deleting a user instruction\n */\ninterface DeleteUserIxParams {\n\t/** The Drift protocol client instance */\n\tdriftClient: DriftClient;\n\t/** The user account to be deleted */\n\tuser: User;\n}\n\n/**\n * Creates a user deletion instruction.\n *\n * @example\n * ```typescript\n * const deleteIx = await deleteUserIx({\n *   driftClient: driftClient,\n *   user: userClient\n * });\n * ```\n */\nexport const deleteUserIx = async ({\n\tdriftClient,\n\tuser,\n}: DeleteUserIxParams) => {\n\treturn driftClient.getUserDeletionIx(user.userAccountPublicKey);\n};\n\n/**\n * Parameters required for creating a user deletion transaction\n * Extends DeleteUserIxParams with optional transaction parameters\n */\ninterface DeleteUserTxnParams extends DeleteUserIxParams {\n\t/** Optional transaction parameters for customizing the transaction */\n\ttxParams?: TxParams;\n}\n\n/**\n * Creates a user deletion transaction.\n *\n * @example\n * ```typescript\n * const deleteTxn = await deleteUserTxn({\n *   driftClient: driftClient,\n *   user: userClient,\n *   txParams: { useSimulatedComputeUnits: true }\n * });\n *\n * // Sign and send the transaction\n * const signature = await driftClient.sendTransaction(deleteTxn);\n * ```\n */\nexport const deleteUserTxn = async ({\n\tdriftClient,\n\tuser,\n\ttxParams,\n}: DeleteUserTxnParams) => {\n\tconst deleteIx = await deleteUserIx({ driftClient, user });\n\treturn driftClient.buildTransaction(deleteIx, txParams);\n};\n"]}

package/lib/drift/base/actions/user/index.d.ts

@@ -0,0 +1 @@
+export * from './create';

package/lib/drift/base/actions/user/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create"), exports);
+//# sourceMappingURL=index.js.map

package/lib/drift/base/actions/user/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/drift/base/actions/user/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB","sourcesContent":["export * from './create';\n"]}

package/lib/drift/base/constants/accountNames.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_ACCOUNT_NAMES_BY_POOL_ID: Record<number, string>;

package/lib/drift/base/constants/accountNames.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ACCOUNT_NAMES_BY_POOL_ID = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const pools_1 = require("../../../constants/pools");
+exports.DEFAULT_ACCOUNT_NAMES_BY_POOL_ID = {
+    [pools_1.MAIN_POOL_ID]: sdk_1.DEFAULT_USER_NAME,
+    [pools_1.JLP_POOL_ID]: 'JLP Market - Isolated Pool',
+    [pools_1.EXPONENT_POOL_ID]: 'Exponent Market - Isolated Pool',
+    [pools_1.SACRED_POOL_ID]: 'ACRED Market - Isolated Pool',
+    [pools_1.LST_POOL_ID]: 'LST Market - Isolated Pool',
+};
+//# sourceMappingURL=accountNames.js.map

package/lib/drift/base/constants/accountNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountNames.js","sourceRoot":"","sources":["../../../../src/drift/base/constants/accountNames.ts"],"names":[],"mappings":";;;AAAA,yCAAoD;AACpD,oDAMkC;AAErB,QAAA,gCAAgC,GAA2B;IACvE,CAAC,oBAAY,CAAC,EAAE,uBAAiB;IACjC,CAAC,mBAAW,CAAC,EAAE,4BAA4B;IAC3C,CAAC,wBAAgB,CAAC,EAAE,iCAAiC;IACrD,CAAC,sBAAc,CAAC,EAAE,8BAA8B;IAChD,CAAC,mBAAW,CAAC,EAAE,4BAA4B;CAC3C,CAAC","sourcesContent":["import { DEFAULT_USER_NAME } from '@drift-labs/sdk';\nimport {\n\tJLP_POOL_ID,\n\tMAIN_POOL_ID,\n\tSACRED_POOL_ID,\n\tLST_POOL_ID,\n\tEXPONENT_POOL_ID,\n} from '../../../constants/pools';\n\nexport const DEFAULT_ACCOUNT_NAMES_BY_POOL_ID: Record<number, string> = {\n\t[MAIN_POOL_ID]: DEFAULT_USER_NAME,\n\t[JLP_POOL_ID]: 'JLP Market - Isolated Pool',\n\t[EXPONENT_POOL_ID]: 'Exponent Market - Isolated Pool',\n\t[SACRED_POOL_ID]: 'ACRED Market - Isolated Pool',\n\t[LST_POOL_ID]: 'LST Market - Isolated Pool',\n};\n"]}

package/lib/drift/base/details/index.d.ts

@@ -0,0 +1,2 @@
+export * from './user';
+export * from './market';

package/lib/drift/base/details/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./user"), exports);
+__exportStar(require("./market"), exports);
+//# sourceMappingURL=index.js.map

package/lib/drift/base/details/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/drift/base/details/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,2CAAyB","sourcesContent":["export * from './user';\nexport * from './market';\n"]}

package/lib/drift/base/details/market/funding.d.ts

@@ -0,0 +1,9 @@
+import { DriftClient } from '@drift-labs/sdk';
+export declare const getMarketPredictedFunding: (driftClient: DriftClient, marketIndex: number) => {
+    longFundingRate: number;
+    shortFundingRate: number;
+};
+export declare const getMarketHistoricalFunding: (marketSymbol?: string) => Promise<Array<{
+    slot: number;
+    fundingRatePct: number;
+}>>;

package/lib/drift/base/details/market/funding.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMarketHistoricalFunding = exports.getMarketPredictedFunding = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const Drift_1 = require("../../../Drift");
+const types_1 = require("../../../../types");
+const funding_1 = require("../../../utils/funding");
+const apiUrls_1 = require("../../../constants/apiUrls");
+const getMarketPredictedFunding = (driftClient, marketIndex) => {
+    const perpMarketAccount = driftClient.getPerpMarketAccount(marketIndex);
+    const rawMmOraclePriceData = driftClient.getMMOracleDataForPerpMarket(marketIndex);
+    const rawOraclePriceData = driftClient.getOracleDataForPerpMarket(marketIndex);
+    const markPriceCache = new Drift_1.MarkPriceCache();
+    const marketId = types_1.MarketId.createPerpMarket(marketIndex);
+    const markPrice = markPriceCache.getMarkPrice(marketId.key);
+    const nowBN = new sdk_1.BN(Date.now());
+    const [_markTwapLive, oracleTwapLive, longFundingRate, shortFundingRate] = (0, sdk_1.calculateLongShortFundingRateAndLiveTwaps)(perpMarketAccount, rawMmOraclePriceData, rawOraclePriceData, markPrice, nowBN);
+    return {
+        longFundingRate: (0, funding_1.getFundingRate)(longFundingRate, oracleTwapLive),
+        shortFundingRate: (0, funding_1.getFundingRate)(shortFundingRate, oracleTwapLive),
+    };
+};
+exports.getMarketPredictedFunding = getMarketPredictedFunding;
+const getMarketHistoricalFunding = async (marketSymbol = 'SOL-PERP') => {
+    // TODO: if we're hitting the data api a lot we should set up a client file for it.. not sure if necessary
+    const url = `${apiUrls_1.API_URLS.DATA_API}${apiUrls_1.API_ENDPOINTS.FUNDING_RATES}?marketName=${marketSymbol}`;
+    try {
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`HTTP error! status: ${response.status}`);
+        }
+        const data = await response.json();
+        const rates = data.fundingRates || [];
+        return rates.map((rate) => {
+            const fundingRateBN = new sdk_1.BN(rate.fundingRate);
+            const oracleTwapBN = new sdk_1.BN(rate.oraclePriceTwap);
+            const fundingRatePct = (0, funding_1.getFundingRate)(fundingRateBN, oracleTwapBN);
+            return {
+                slot: rate.slot,
+                fundingRatePct,
+            };
+        });
+    }
+    catch (error) {
+        console.error('Error fetching funding rates:', error);
+        return [];
+    }
+};
+exports.getMarketHistoricalFunding = getMarketHistoricalFunding;
+//# sourceMappingURL=funding.js.map

package/lib/drift/base/details/market/funding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"funding.js","sourceRoot":"","sources":["../../../../../src/drift/base/details/market/funding.ts"],"names":[],"mappings":";;;AAAA,yCAIyB;AACzB,0CAAgD;AAChD,6CAA6C;AAC7C,oDAAwD;AACxD,wDAAqE;AAE9D,MAAM,yBAAyB,GAAG,CACxC,WAAwB,EACxB,WAAmB,EAIlB,EAAE;IACH,MAAM,iBAAiB,GAAG,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,oBAAoB,GACzB,WAAW,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC;IACvD,MAAM,kBAAkB,GACvB,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;IAErD,MAAM,cAAc,GAAG,IAAI,sBAAc,EAAE,CAAC;IAC5C,MAAM,QAAQ,GAAG,gBAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAExD,MAAM,SAAS,GAAG,cAAc,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,QAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAEjC,MAAM,CAAC,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,gBAAgB,CAAC,GACvE,IAAA,+CAAyC,EACxC,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,SAAS,EACT,KAAK,CACL,CAAC;IAEH,OAAO;QACN,eAAe,EAAE,IAAA,wBAAc,EAAC,eAAe,EAAE,cAAc,CAAC;QAChE,gBAAgB,EAAE,IAAA,wBAAc,EAAC,gBAAgB,EAAE,cAAc,CAAC;KAClE,CAAC;AACH,CAAC,CAAC;AAhCW,QAAA,yBAAyB,6BAgCpC;AAQK,MAAM,0BAA0B,GAAG,KAAK,EAC9C,eAAuB,UAAU,EAC0B,EAAE;IAC7D,0GAA0G;IAC1G,MAAM,GAAG,GAAG,GAAG,kBAAQ,CAAC,QAAQ,GAAG,uBAAa,CAAC,aAAa,eAAe,YAAY,EAAE,CAAC;IAE5F,IAAI,CAAC;QACJ,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,KAAK,GAA6B,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;QAEhE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,aAAa,GAAG,IAAI,QAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/C,MAAM,YAAY,GAAG,IAAI,QAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAClD,MAAM,cAAc,GAAG,IAAA,wBAAc,EAAC,aAAa,EAAE,YAAY,CAAC,CAAC;YAEnE,OAAO;gBACN,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,cAAc;aACd,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;QACtD,OAAO,EAAE,CAAC;IACX,CAAC;AACF,CAAC,CAAC;AA5BW,QAAA,0BAA0B,8BA4BrC","sourcesContent":["import {\n\tBN,\n\tcalculateLongShortFundingRateAndLiveTwaps,\n\tDriftClient,\n} from '@drift-labs/sdk';\nimport { MarkPriceCache } from '../../../Drift';\nimport { MarketId } from '../../../../types';\nimport { getFundingRate } from '../../../utils/funding';\nimport { API_URLS, API_ENDPOINTS } from '../../../constants/apiUrls';\n\nexport const getMarketPredictedFunding = (\n\tdriftClient: DriftClient,\n\tmarketIndex: number\n): {\n\tlongFundingRate: number;\n\tshortFundingRate: number;\n} => {\n\tconst perpMarketAccount = driftClient.getPerpMarketAccount(marketIndex);\n\tconst rawMmOraclePriceData =\n\t\tdriftClient.getMMOracleDataForPerpMarket(marketIndex);\n\tconst rawOraclePriceData =\n\t\tdriftClient.getOracleDataForPerpMarket(marketIndex);\n\n\tconst markPriceCache = new MarkPriceCache();\n\tconst marketId = MarketId.createPerpMarket(marketIndex);\n\n\tconst markPrice = markPriceCache.getMarkPrice(marketId.key);\n\tconst nowBN = new BN(Date.now());\n\n\tconst [_markTwapLive, oracleTwapLive, longFundingRate, shortFundingRate] =\n\t\tcalculateLongShortFundingRateAndLiveTwaps(\n\t\t\tperpMarketAccount,\n\t\t\trawMmOraclePriceData,\n\t\t\trawOraclePriceData,\n\t\t\tmarkPrice,\n\t\t\tnowBN\n\t\t);\n\n\treturn {\n\t\tlongFundingRate: getFundingRate(longFundingRate, oracleTwapLive),\n\t\tshortFundingRate: getFundingRate(shortFundingRate, oracleTwapLive),\n\t};\n};\n\ninterface FundingRateApiResponse {\n\tslot: number;\n\tfundingRate: string;\n\toraclePriceTwap: string;\n}\n\nexport const getMarketHistoricalFunding = async (\n\tmarketSymbol: string = 'SOL-PERP'\n): Promise<Array<{ slot: number; fundingRatePct: number }>> => {\n\t// TODO: if we're hitting the data api a lot we should set up a client file for it.. not sure if necessary\n\tconst url = `${API_URLS.DATA_API}${API_ENDPOINTS.FUNDING_RATES}?marketName=${marketSymbol}`;\n\n\ttry {\n\t\tconst response = await fetch(url);\n\t\tif (!response.ok) {\n\t\t\tthrow new Error(`HTTP error! status: ${response.status}`);\n\t\t}\n\t\tconst data = await response.json();\n\t\tconst rates: FundingRateApiResponse[] = data.fundingRates || [];\n\n\t\treturn rates.map((rate) => {\n\t\t\tconst fundingRateBN = new BN(rate.fundingRate);\n\t\t\tconst oracleTwapBN = new BN(rate.oraclePriceTwap);\n\t\t\tconst fundingRatePct = getFundingRate(fundingRateBN, oracleTwapBN);\n\n\t\t\treturn {\n\t\t\t\tslot: rate.slot,\n\t\t\t\tfundingRatePct,\n\t\t\t};\n\t\t});\n\t} catch (error) {\n\t\tconsole.error('Error fetching funding rates:', error);\n\t\treturn [];\n\t}\n};\n"]}

package/lib/drift/base/details/market/index.d.ts

@@ -0,0 +1,2 @@
+export * from './funding';
+export * from './openInterest';

package/lib/drift/base/details/market/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./funding"), exports);
+__exportStar(require("./openInterest"), exports);
+//# sourceMappingURL=index.js.map

package/lib/drift/base/details/market/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/drift/base/details/market/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B","sourcesContent":["export * from './funding';\nexport * from './openInterest';\n"]}

package/lib/drift/base/details/market/openInterest.d.ts

@@ -0,0 +1,5 @@
+import { BigNum, DriftClient } from '@drift-labs/sdk';
+export declare const getMarketOpenInterest: (driftClient: DriftClient, marketIndex: number) => {
+    longOpenInterest: BigNum;
+    shortOpenInterest: BigNum;
+};

package/lib/drift/base/details/market/openInterest.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMarketOpenInterest = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const getMarketOpenInterest = (driftClient, marketIndex) => {
+    const perpMarketAccount = driftClient.getPerpMarketAccount(marketIndex);
+    const longOpenInterest = sdk_1.BigNum.from(perpMarketAccount.amm.baseAssetAmountLong, sdk_1.BASE_PRECISION_EXP);
+    const shortOpenInterest = sdk_1.BigNum.from(perpMarketAccount.amm.baseAssetAmountShort, sdk_1.BASE_PRECISION_EXP);
+    return { longOpenInterest, shortOpenInterest };
+};
+exports.getMarketOpenInterest = getMarketOpenInterest;
+//# sourceMappingURL=openInterest.js.map

package/lib/drift/base/details/market/openInterest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openInterest.js","sourceRoot":"","sources":["../../../../../src/drift/base/details/market/openInterest.ts"],"names":[],"mappings":";;;AAAA,yCAA0E;AAEnE,MAAM,qBAAqB,GAAG,CACpC,WAAwB,EACxB,WAAmB,EACuC,EAAE;IAC5D,MAAM,iBAAiB,GAAG,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,gBAAgB,GAAG,YAAM,CAAC,IAAI,CACnC,iBAAiB,CAAC,GAAG,CAAC,mBAAmB,EACzC,wBAAkB,CAClB,CAAC;IACF,MAAM,iBAAiB,GAAG,YAAM,CAAC,IAAI,CACpC,iBAAiB,CAAC,GAAG,CAAC,oBAAoB,EAC1C,wBAAkB,CAClB,CAAC;IACF,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC;AAChD,CAAC,CAAC;AAdW,QAAA,qBAAqB,yBAchC","sourcesContent":["import { BASE_PRECISION_EXP, BigNum, DriftClient } from '@drift-labs/sdk';\n\nexport const getMarketOpenInterest = (\n\tdriftClient: DriftClient,\n\tmarketIndex: number\n): { longOpenInterest: BigNum; shortOpenInterest: BigNum } => {\n\tconst perpMarketAccount = driftClient.getPerpMarketAccount(marketIndex);\n\tconst longOpenInterest = BigNum.from(\n\t\tperpMarketAccount.amm.baseAssetAmountLong,\n\t\tBASE_PRECISION_EXP\n\t);\n\tconst shortOpenInterest = BigNum.from(\n\t\tperpMarketAccount.amm.baseAssetAmountShort,\n\t\tBASE_PRECISION_EXP\n\t);\n\treturn { longOpenInterest, shortOpenInterest };\n};\n"]}

package/lib/drift/base/details/user/balances.d.ts

@@ -0,0 +1,40 @@
+import { BigNum, BN, DriftClient, User } from '@drift-labs/sdk';
+/**
+ * Essential balance information for a spot market position.
+ * Contains the three key metrics needed for balance display and analysis.
+ */
+export interface SpotBalanceInfo {
+    marketIndex: number;
+    /**
+     * Net balance in base asset terms (deposits - borrows).
+     * Positive values indicate net deposits, negative values indicate net borrows.
+     */
+    baseBalance: BigNum;
+    /**
+     * USD notional value of the net balance based on oracle price.
+     * This represents the current market value of the position.
+     */
+    notionalBalance: BigNum;
+    /**
+     * Oracle price at which this balance would contribute to account liquidation.
+     * Returns zero if liquidation price cannot be calculated.
+     */
+    liquidationPrice: BigNum;
+}
+/**
+ * Derives essential balance display information from a User's SpotPosition.
+ *
+ * Key features:
+ * - Calculates net balance (deposits minus borrows) in base asset terms
+ * - Computes USD notional value using current oracle price
+ * - Determines liquidation price for the specific market
+ * - Handles edge cases like zero balances and invalid liquidation prices
+ *
+ * @param driftClient - The DriftClient instance.
+ * @param user - The User instance.
+ * @param marketIndex - The market index for the spot market.
+ * @param oraclePrice - The oracle price for the spot market.
+ *
+ * @returns SpotBalanceInfo object containing the three essential balance metrics
+ */
+export declare const getSpotBalanceInfo: (driftClient: DriftClient, user: User, marketIndex: number, oraclePrice: BN) => SpotBalanceInfo;

package/lib/drift/base/details/user/balances.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpotBalanceInfo = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const market_1 = require("../../../../common-ui-utils/market");
+/**
+ * Derives essential balance display information from a User's SpotPosition.
+ *
+ * Key features:
+ * - Calculates net balance (deposits minus borrows) in base asset terms
+ * - Computes USD notional value using current oracle price
+ * - Determines liquidation price for the specific market
+ * - Handles edge cases like zero balances and invalid liquidation prices
+ *
+ * @param driftClient - The DriftClient instance.
+ * @param user - The User instance.
+ * @param marketIndex - The market index for the spot market.
+ * @param oraclePrice - The oracle price for the spot market.
+ *
+ * @returns SpotBalanceInfo object containing the three essential balance metrics
+ */
+const getSpotBalanceInfo = (driftClient, user, marketIndex, oraclePrice) => {
+    const spotMarketConfig = market_1.MARKET_UTILS.getMarketConfig(driftClient.env, sdk_1.MarketType.SPOT, marketIndex);
+    const baseBalance = user.getTokenAmount(marketIndex);
+    const baseBalanceBigNum = sdk_1.BigNum.from(baseBalance, spotMarketConfig.precisionExp);
+    const notionalBalance = baseBalanceBigNum
+        .mul(sdk_1.BigNum.from(oraclePrice, sdk_1.PRICE_PRECISION_EXP))
+        .shiftTo(sdk_1.QUOTE_PRECISION_EXP);
+    const liqPrice = user.spotLiquidationPrice(marketIndex);
+    const liquidationPrice = sdk_1.BigNum.from(liqPrice, sdk_1.PRICE_PRECISION_EXP);
+    return {
+        marketIndex,
+        baseBalance: baseBalanceBigNum,
+        notionalBalance,
+        liquidationPrice,
+    };
+};
+exports.getSpotBalanceInfo = getSpotBalanceInfo;
+//# sourceMappingURL=balances.js.map

package/lib/drift/base/details/user/balances.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balances.js","sourceRoot":"","sources":["../../../../../src/drift/base/details/user/balances.ts"],"names":[],"mappings":";;;AAAA,yCAQyB;AACzB,+DAAkE;AA2BlE;;;;;;;;;;;;;;;GAeG;AACI,MAAM,kBAAkB,GAAG,CACjC,WAAwB,EACxB,IAAU,EACV,WAAmB,EACnB,WAAe,EACG,EAAE;IACpB,MAAM,gBAAgB,GAAG,qBAAY,CAAC,eAAe,CACpD,WAAW,CAAC,GAAG,EACf,gBAAU,CAAC,IAAI,EACf,WAAW,CACX,CAAC;IAEF,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACrD,MAAM,iBAAiB,GAAG,YAAM,CAAC,IAAI,CACpC,WAAW,EACX,gBAAgB,CAAC,YAAY,CAC7B,CAAC;IAEF,MAAM,eAAe,GAAG,iBAAiB;SACvC,GAAG,CAAC,YAAM,CAAC,IAAI,CAAC,WAAW,EAAE,yBAAmB,CAAC,CAAC;SAClD,OAAO,CAAC,yBAAmB,CAAC,CAAC;IAE/B,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;IACxD,MAAM,gBAAgB,GAAG,YAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,yBAAmB,CAAC,CAAC;IAEpE,OAAO;QACN,WAAW;QACX,WAAW,EAAE,iBAAiB;QAC9B,eAAe;QACf,gBAAgB;KAChB,CAAC;AACH,CAAC,CAAC;AA/BW,QAAA,kBAAkB,sBA+B7B","sourcesContent":["import {\n\tBigNum,\n\tBN,\n\tDriftClient,\n\tMarketType,\n\tPRICE_PRECISION_EXP,\n\tQUOTE_PRECISION_EXP,\n\tUser,\n} from '@drift-labs/sdk';\nimport { MARKET_UTILS } from '../../../../common-ui-utils/market';\n\n/**\n * Essential balance information for a spot market position.\n * Contains the three key metrics needed for balance display and analysis.\n */\nexport interface SpotBalanceInfo {\n\tmarketIndex: number;\n\t/**\n\t * Net balance in base asset terms (deposits - borrows).\n\t * Positive values indicate net deposits, negative values indicate net borrows.\n\t */\n\tbaseBalance: BigNum;\n\n\t/**\n\t * USD notional value of the net balance based on oracle price.\n\t * This represents the current market value of the position.\n\t */\n\tnotionalBalance: BigNum;\n\n\t/**\n\t * Oracle price at which this balance would contribute to account liquidation.\n\t * Returns zero if liquidation price cannot be calculated.\n\t */\n\tliquidationPrice: BigNum;\n}\n\n/**\n * Derives essential balance display information from a User's SpotPosition.\n *\n * Key features:\n * - Calculates net balance (deposits minus borrows) in base asset terms\n * - Computes USD notional value using current oracle price\n * - Determines liquidation price for the specific market\n * - Handles edge cases like zero balances and invalid liquidation prices\n *\n * @param driftClient - The DriftClient instance.\n * @param user - The User instance.\n * @param marketIndex - The market index for the spot market.\n * @param oraclePrice - The oracle price for the spot market.\n *\n * @returns SpotBalanceInfo object containing the three essential balance metrics\n */\nexport const getSpotBalanceInfo = (\n\tdriftClient: DriftClient,\n\tuser: User,\n\tmarketIndex: number,\n\toraclePrice: BN\n): SpotBalanceInfo => {\n\tconst spotMarketConfig = MARKET_UTILS.getMarketConfig(\n\t\tdriftClient.env,\n\t\tMarketType.SPOT,\n\t\tmarketIndex\n\t);\n\n\tconst baseBalance = user.getTokenAmount(marketIndex);\n\tconst baseBalanceBigNum = BigNum.from(\n\t\tbaseBalance,\n\t\tspotMarketConfig.precisionExp\n\t);\n\n\tconst notionalBalance = baseBalanceBigNum\n\t\t.mul(BigNum.from(oraclePrice, PRICE_PRECISION_EXP))\n\t\t.shiftTo(QUOTE_PRECISION_EXP);\n\n\tconst liqPrice = user.spotLiquidationPrice(marketIndex);\n\tconst liquidationPrice = BigNum.from(liqPrice, PRICE_PRECISION_EXP);\n\n\treturn {\n\t\tmarketIndex,\n\t\tbaseBalance: baseBalanceBigNum,\n\t\tnotionalBalance,\n\t\tliquidationPrice,\n\t};\n};\n"]}

package/lib/drift/base/details/user/index.d.ts

@@ -0,0 +1,4 @@
+export * from './positions';
+export * from './balances';
+export * from './orders';
+export * from './marginInfo';

package/lib/drift/base/details/user/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./positions"), exports);
+__exportStar(require("./balances"), exports);
+__exportStar(require("./orders"), exports);
+__exportStar(require("./marginInfo"), exports);
+//# sourceMappingURL=index.js.map

package/lib/drift/base/details/user/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/drift/base/details/user/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,+CAA6B","sourcesContent":["export * from './positions';\nexport * from './balances';\nexport * from './orders';\nexport * from './marginInfo';\n"]}

package/lib/drift/base/details/user/marginInfo.d.ts

@@ -0,0 +1,29 @@
+import { BN, BigNum, User, DriftClient } from '@drift-labs/sdk';
+import { MarketKey } from '../../../../types';
+export type AccountMarginInfo = {
+    /** Net USD value of the account, including spot balances and unsettled P&L from perp positions. */
+    netUsdValue: BigNum;
+    /** Total unsettled P&L from perp positions. Includes position P&L and funding P&L. */
+    totalUnsettledPnl: BigNum;
+    /** Total unsettled funding P&L from perp positions. */
+    totalUnsettledFundingPnL: BigNum;
+    /** Total claimable P&L from the P&L pool for perp positions. */
+    totalClaimablePnl: BigNum;
+    /** Total initial margin in the account. Includes weighted values of spot balances and unsettled P&L from perp positions. */
+    totalInitialMargin: BigNum;
+    /** Total maintenance margin in the account. Includes weighted values of spot balances and unsettled P&L from perp positions. */
+    totalMaintenanceMargin: BigNum;
+    /** Free initial margin in the account, used to open new positions. */
+    freeInitialMargin: BigNum;
+    /** Free maintenance margin in the account, used to avoid liquidations. */
+    freeMaintenanceMargin: BigNum;
+    /** Current leverage multiplier of the account. */
+    leverage: number;
+    /** Initial margin required to open a new position. */
+    initialReq: BigNum;
+    /** Maintenance margin required to avoid liquidations. */
+    maintenanceReq: BigNum;
+    /** Margin ratio of the account. */
+    marginRatioPct: number;
+};
+export declare const getAccountMarginInfo: (driftClient: DriftClient, user: User, getOraclePrice: (marketKey: MarketKey) => BN) => AccountMarginInfo;

package/lib/drift/base/details/user/marginInfo.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccountMarginInfo = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const constants_1 = require("../../../../constants");
+const types_1 = require("../../../../types");
+const getAccountMarginInfo = (driftClient, user, getOraclePrice) => {
+    const netUsdValue = user.getNetUsdValue();
+    const totalUnsettledPnl = user.getUnrealizedPNL(true); // method from SDK is inappropriately named, totalUnsettledPnl is the right definition here
+    const totalUnsettledFundingPnL = user.getUnrealizedFundingPNL();
+    const totalInitialMargin = user.getTotalCollateral();
+    const totalMaintenanceMargin = user.getTotalCollateral('Maintenance');
+    const freeInitialMargin = user.getFreeCollateral();
+    const freeMaintenanceMargin = user.getFreeCollateral('Maintenance');
+    const initialReq = user.getInitialMarginRequirement();
+    const maintenanceReq = user.getMaintenanceMarginRequirement();
+    const userLeverage = user.getLeverage();
+    let userMarginRatio = user.getMarginRatio();
+    // weird to display massive fraction when really it just means that their position is zero
+    if (userMarginRatio.eq(new sdk_1.BN(Number.MAX_SAFE_INTEGER)))
+        userMarginRatio = sdk_1.ZERO;
+    const usdcSpotMarketAccount = driftClient.getSpotMarketAccount(constants_1.USDC_SPOT_MARKET_INDEX);
+    const totalClaimablePnl = user
+        .getActivePerpPositions()
+        .reduce((acc, position) => {
+        const perpMarket = driftClient.getPerpMarketAccount(position.marketIndex);
+        const oraclePrice = getOraclePrice(types_1.MarketId.createPerpMarket(position.marketIndex).key);
+        const positionClaimablePnl = (0, sdk_1.calculateClaimablePnl)(perpMarket, usdcSpotMarketAccount, position, {
+            price: oraclePrice,
+        });
+        return acc.add(positionClaimablePnl);
+    }, sdk_1.ZERO);
+    return {
+        netUsdValue: sdk_1.BigNum.from(netUsdValue, sdk_1.QUOTE_PRECISION_EXP),
+        totalUnsettledPnl: sdk_1.BigNum.from(totalUnsettledPnl, sdk_1.QUOTE_PRECISION_EXP),
+        totalUnsettledFundingPnL: sdk_1.BigNum.from(totalUnsettledFundingPnL, sdk_1.QUOTE_PRECISION_EXP),
+        totalClaimablePnl: sdk_1.BigNum.from(totalClaimablePnl, sdk_1.QUOTE_PRECISION_EXP),
+        totalInitialMargin: sdk_1.BigNum.from(totalInitialMargin, sdk_1.QUOTE_PRECISION_EXP),
+        totalMaintenanceMargin: sdk_1.BigNum.from(totalMaintenanceMargin, sdk_1.QUOTE_PRECISION_EXP),
+        freeInitialMargin: sdk_1.BigNum.from(freeInitialMargin, sdk_1.QUOTE_PRECISION_EXP),
+        freeMaintenanceMargin: sdk_1.BigNum.from(freeMaintenanceMargin, sdk_1.QUOTE_PRECISION_EXP),
+        leverage: sdk_1.BigNum.from(userLeverage, sdk_1.FOUR).toNum(),
+        maintenanceReq: sdk_1.BigNum.from(maintenanceReq, sdk_1.QUOTE_PRECISION_EXP),
+        initialReq: sdk_1.BigNum.from(initialReq, sdk_1.QUOTE_PRECISION_EXP),
+        marginRatioPct: sdk_1.BigNum.from(userMarginRatio, sdk_1.TWO).toNum(),
+    };
+};
+exports.getAccountMarginInfo = getAccountMarginInfo;
+//# sourceMappingURL=marginInfo.js.map