@drift-labs/common 1.0.59 → 1.0.60

package/lib/utils/orders/sort.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUIOrderRecordsLaterThanTarget = exports.getLatestOfTwoOrderRecords = exports.getLatestOfTwoUIOrderRecords = exports.sortOrderRecords = exports.sortUIOrderRecords = exports.sortUIOrderActionRecords = exports.sortUIMatchedOrderRecordAndAction = exports.getSortScoreForOrderActionRecords = exports.getSortScoreForOrderRecords = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const enum_1 = require("../enum");
+const getChronologicalValueForOrderAction = (action) => {
+    return (0, enum_1.matchEnum)(action, sdk_1.OrderAction.PLACE)
+        ? 0
+        : (0, enum_1.matchEnum)(action, sdk_1.OrderAction.FILL)
+            ? 1
+            : 2;
+};
+/**
+ * Returns 1 if the first Order is chronologically later than the second Order, -1 if before, 0 if equal
+ * @param orderA
+ * @param orderB
+ * @returns
+ */
+const getSortScoreForOrderRecords = (orderA, orderB) => {
+    if (orderA.slot !== orderB.slot) {
+        return orderA.slot > orderB.slot ? 1 : -1;
+    }
+    return 0;
+};
+exports.getSortScoreForOrderRecords = getSortScoreForOrderRecords;
+/**
+ * Returns 1 if the first Order is chronologically later than the second Order, -1 if before, 0 if equal
+ * @param orderA
+ * @param orderB
+ * @returns
+ */
+const getSortScoreForOrderActionRecords = (orderA, orderB) => {
+    if (orderA.slot !== orderB.slot) {
+        return orderA.slot > orderB.slot ? 1 : -1;
+    }
+    if (!(0, enum_1.matchEnum)(orderA.action, orderB.action)) {
+        // @ts-ignore
+        const orderAActionVal = getChronologicalValueForOrderAction(orderA.action);
+        // @ts-ignore
+        const orderBActionVal = getChronologicalValueForOrderAction(orderB.action);
+        return orderAActionVal > orderBActionVal ? 1 : -1;
+    }
+    // @ts-ignore
+    if (orderA.fillRecordId && orderB.fillRecordId) {
+        if (!orderA.fillRecordId.eq(orderB.fillRecordId)) {
+            // @ts-ignore
+            return orderA.fillRecordId.gt(orderB.fillRecordId) ? 1 : -1;
+        }
+    }
+    return 0;
+};
+exports.getSortScoreForOrderActionRecords = getSortScoreForOrderActionRecords;
+const sortUIMatchedOrderRecordAndAction = (records, direction = 'desc') => {
+    const ascSortedRecords = records.sort((a, b) => (0, exports.getSortScoreForOrderActionRecords)(a.actionRecord, b.actionRecord));
+    return direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;
+};
+exports.sortUIMatchedOrderRecordAndAction = sortUIMatchedOrderRecordAndAction;
+const sortUIOrderActionRecords = (records, direction = 'desc') => {
+    const ascSortedRecords = records.sort(exports.getSortScoreForOrderActionRecords);
+    return direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;
+};
+exports.sortUIOrderActionRecords = sortUIOrderActionRecords;
+const sortUIOrderRecords = (records, direction = 'desc') => {
+    const ascSortedRecords = records.sort(exports.getSortScoreForOrderRecords);
+    return direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;
+};
+exports.sortUIOrderRecords = sortUIOrderRecords;
+const sortOrderRecords = (records, direction = 'desc') => {
+    const ascSortedRecords = records.sort(exports.getSortScoreForOrderRecords);
+    return direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;
+};
+exports.sortOrderRecords = sortOrderRecords;
+const getLatestOfTwoUIOrderRecords = (orderA, orderB) => {
+    return (0, exports.getSortScoreForOrderRecords)(orderA, orderB) === 1 ? orderA : orderB;
+};
+exports.getLatestOfTwoUIOrderRecords = getLatestOfTwoUIOrderRecords;
+const getLatestOfTwoOrderRecords = (orderA, orderB) => {
+    return (0, exports.getSortScoreForOrderRecords)(orderA, orderB) === 1 ? orderA : orderB;
+};
+exports.getLatestOfTwoOrderRecords = getLatestOfTwoOrderRecords;
+const getUIOrderRecordsLaterThanTarget = (target, records) => records.filter((record) => (0, exports.getLatestOfTwoUIOrderRecords)(record, target) === record);
+exports.getUIOrderRecordsLaterThanTarget = getUIOrderRecordsLaterThanTarget;
+//# sourceMappingURL=sort.js.map

package/lib/utils/orders/sort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../../src/utils/orders/sort.ts"],"names":[],"mappings":";;;AAAA,yCAKyB;AAKzB,kCAAoC;AAyCpC,MAAM,mCAAmC,GAAG,CAAC,MAAmB,EAAE,EAAE;IACnE,OAAO,IAAA,gBAAS,EAAC,MAAM,EAAE,iBAAW,CAAC,KAAK,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,IAAA,gBAAS,EAAC,MAAM,EAAE,iBAAW,CAAC,IAAI,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,2BAA2B,GAAG,CAC1C,MAAwB,EACxB,MAAwB,EACvB,EAAE;IACH,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC,CAAC;AATW,QAAA,2BAA2B,+BAStC;AAEF;;;;;GAKG;AACI,MAAM,iCAAiC,GAAG,CAChD,MAAgC,EAChC,MAAgC,EAC/B,EAAE;IACH,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,IAAA,gBAAS,EAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9C,aAAa;QACb,MAAM,eAAe,GAAG,mCAAmC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3E,aAAa;QACb,MAAM,eAAe,GAAG,mCAAmC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE3E,OAAO,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,aAAa;IACb,IAAI,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;YAClD,aAAa;YACb,OAAO,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC;IACF,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC,CAAC;AAzBW,QAAA,iCAAiC,qCAyB5C;AAEK,MAAM,iCAAiC,GAAG,CAChD,OAAwC,EACxC,YAA4B,MAAM,EACjC,EAAE;IACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9C,IAAA,yCAAiC,EAAC,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,YAAY,CAAC,CACjE,CAAC;IAEF,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC7E,CAAC,CAAC;AATW,QAAA,iCAAiC,qCAS5C;AAEK,MAAM,wBAAwB,GAAG,CACvC,OAAiD,EACjD,YAA4B,MAAM,EACjC,EAAE;IACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,yCAAiC,CAAC,CAAC;IAEzE,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC7E,CAAC,CAAC;AAPW,QAAA,wBAAwB,4BAOnC;AAEK,MAAM,kBAAkB,GAAG,CACjC,OAAY,EACZ,YAA4B,MAAM,EACjC,EAAE;IACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC;IAEnE,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC7E,CAAC,CAAC;AAPW,QAAA,kBAAkB,sBAO7B;AAEK,MAAM,gBAAgB,GAAG,CAC/B,OAA6B,EAC7B,YAA4B,MAAM,EACjC,EAAE;IACH,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC;IAEnE,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;AAC7E,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAEK,MAAM,4BAA4B,GAAG,CAC3C,MAAS,EACT,MAAS,EACR,EAAE;IACH,OAAO,IAAA,mCAA2B,EAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;AAC5E,CAAC,CAAC;AALW,QAAA,4BAA4B,gCAKvC;AAEK,MAAM,0BAA0B,GAAG,CACzC,MAAS,EACT,MAAS,EACR,EAAE;IACH,OAAO,IAAA,mCAA2B,EAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;AAC5E,CAAC,CAAC;AALW,QAAA,0BAA0B,8BAKrC;AAEK,MAAM,gCAAgC,GAAG,CAC/C,MAAS,EACT,OAAY,EACX,EAAE,CACH,OAAO,CAAC,MAAM,CACb,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,oCAA4B,EAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CACnE,CAAC;AANU,QAAA,gCAAgC,oCAM1C","sourcesContent":["import {\n\tEvent,\n\tOrderAction,\n\tOrderActionRecord,\n\tOrderRecord,\n} from '@drift-labs/sdk';\nimport {\n\tUIMatchedOrderRecordAndAction,\n\tUISerializableOrderActionRecord,\n} from '../../serializableTypes';\nimport { matchEnum } from '../enum';\n\nexport type PartialOrderActionRecord =\n\t| PartialUISerializableOrderActionRecord\n\t| PartialOrderActionEventRecord;\n\nexport type PartialUISerializableOrderActionRecord = Pick<\n\tUISerializableOrderActionRecord,\n\t| 'quoteAssetAmountFilled'\n\t| 'baseAssetAmountFilled'\n\t| 'ts'\n\t| 'slot'\n\t| 'action'\n\t| 'fillRecordId'\n\t| 'taker'\n\t| 'takerOrderBaseAssetAmount'\n\t| 'makerOrderBaseAssetAmount'\n\t| 'takerOrderCumulativeBaseAssetAmountFilled'\n\t| 'makerOrderCumulativeBaseAssetAmountFilled'\n\t| 'takerOrderCumulativeQuoteAssetAmountFilled'\n\t| 'makerOrderCumulativeQuoteAssetAmountFilled'\n\t| 'oraclePrice'\n>;\n\nexport type PartialOrderActionEventRecord = Pick<\n\tEvent<OrderActionRecord>,\n\t| 'quoteAssetAmountFilled'\n\t| 'baseAssetAmountFilled'\n\t| 'ts'\n\t| 'slot'\n\t| 'action'\n\t| 'fillRecordId'\n\t| 'taker'\n\t| 'takerOrderBaseAssetAmount'\n\t| 'makerOrderBaseAssetAmount'\n\t| 'takerOrderCumulativeBaseAssetAmountFilled'\n\t| 'makerOrderCumulativeBaseAssetAmountFilled'\n\t| 'takerOrderCumulativeQuoteAssetAmountFilled'\n\t| 'makerOrderCumulativeQuoteAssetAmountFilled'\n>;\n\nconst getChronologicalValueForOrderAction = (action: OrderAction) => {\n\treturn matchEnum(action, OrderAction.PLACE)\n\t\t? 0\n\t\t: matchEnum(action, OrderAction.FILL)\n\t\t? 1\n\t\t: 2;\n};\n\n/**\n * Returns 1 if the first Order is chronologically later than the second Order, -1 if before, 0 if equal\n * @param orderA\n * @param orderB\n * @returns\n */\nexport const getSortScoreForOrderRecords = (\n\torderA: { slot: number },\n\torderB: { slot: number }\n) => {\n\tif (orderA.slot !== orderB.slot) {\n\t\treturn orderA.slot > orderB.slot ? 1 : -1;\n\t}\n\n\treturn 0;\n};\n\n/**\n * Returns 1 if the first Order is chronologically later than the second Order, -1 if before, 0 if equal\n * @param orderA\n * @param orderB\n * @returns\n */\nexport const getSortScoreForOrderActionRecords = (\n\torderA: PartialOrderActionRecord,\n\torderB: PartialOrderActionRecord\n) => {\n\tif (orderA.slot !== orderB.slot) {\n\t\treturn orderA.slot > orderB.slot ? 1 : -1;\n\t}\n\n\tif (!matchEnum(orderA.action, orderB.action)) {\n\t\t// @ts-ignore\n\t\tconst orderAActionVal = getChronologicalValueForOrderAction(orderA.action);\n\t\t// @ts-ignore\n\t\tconst orderBActionVal = getChronologicalValueForOrderAction(orderB.action);\n\n\t\treturn orderAActionVal > orderBActionVal ? 1 : -1;\n\t}\n\t// @ts-ignore\n\tif (orderA.fillRecordId && orderB.fillRecordId) {\n\t\tif (!orderA.fillRecordId.eq(orderB.fillRecordId)) {\n\t\t\t// @ts-ignore\n\t\t\treturn orderA.fillRecordId.gt(orderB.fillRecordId) ? 1 : -1;\n\t\t}\n\t}\n\n\treturn 0;\n};\n\nexport const sortUIMatchedOrderRecordAndAction = (\n\trecords: UIMatchedOrderRecordAndAction[],\n\tdirection: 'asc' | 'desc' = 'desc'\n) => {\n\tconst ascSortedRecords = records.sort((a, b) =>\n\t\tgetSortScoreForOrderActionRecords(a.actionRecord, b.actionRecord)\n\t);\n\n\treturn direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;\n};\n\nexport const sortUIOrderActionRecords = (\n\trecords: PartialUISerializableOrderActionRecord[],\n\tdirection: 'asc' | 'desc' = 'desc'\n) => {\n\tconst ascSortedRecords = records.sort(getSortScoreForOrderActionRecords);\n\n\treturn direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;\n};\n\nexport const sortUIOrderRecords = <T extends { slot: number }>(\n\trecords: T[],\n\tdirection: 'asc' | 'desc' = 'desc'\n) => {\n\tconst ascSortedRecords = records.sort(getSortScoreForOrderRecords);\n\n\treturn direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;\n};\n\nexport const sortOrderRecords = (\n\trecords: Event<OrderRecord>[],\n\tdirection: 'asc' | 'desc' = 'desc'\n) => {\n\tconst ascSortedRecords = records.sort(getSortScoreForOrderRecords);\n\n\treturn direction === 'desc' ? ascSortedRecords.reverse() : ascSortedRecords;\n};\n\nexport const getLatestOfTwoUIOrderRecords = <T extends { slot: number }>(\n\torderA: T,\n\torderB: T\n) => {\n\treturn getSortScoreForOrderRecords(orderA, orderB) === 1 ? orderA : orderB;\n};\n\nexport const getLatestOfTwoOrderRecords = <T extends { slot: number }>(\n\torderA: T,\n\torderB: T\n) => {\n\treturn getSortScoreForOrderRecords(orderA, orderB) === 1 ? orderA : orderB;\n};\n\nexport const getUIOrderRecordsLaterThanTarget = <T extends { slot: number }>(\n\ttarget: T,\n\trecords: T[]\n) =>\n\trecords.filter(\n\t\t(record) => getLatestOfTwoUIOrderRecords(record, target) === record\n\t);\n"]}

package/lib/utils/positions/index.d.ts

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

package/lib/{common-ui-utils → utils/positions}/index.js

@@ -14,10 +14,6 @@ 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("./commonUiUtils"), exports);
-__exportStar(require("./market"), exports);
-__exportStar(require("./order"), exports);
-__exportStar(require("./trading"), exports);
+__exportStar(require("./open"), exports);
 __exportStar(require("./user"), exports);
-__exportStar(require("./settings/settings"), exports);
 //# sourceMappingURL=index.js.map

package/lib/utils/positions/index.js.map

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

package/lib/utils/positions/open.d.ts

@@ -0,0 +1,4 @@
+import { BN, DriftClient, PerpMarketConfig, PerpPosition, User } from '@drift-labs/sdk';
+import { OpenPosition } from '../../types';
+declare const getOpenPositionData: (driftClient: DriftClient, userPositions: PerpPosition[], user: User, perpMarketLookup: PerpMarketConfig[], markPriceCallback?: (marketIndex: number) => BN) => OpenPosition[];
+export { getOpenPositionData };

package/lib/{common-ui-utils/user.js → utils/positions/open.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_UTILS = void 0;
+exports.getOpenPositionData = void 0;
 const sdk_1 = require("@drift-labs/sdk");
-const types_1 = require("../types");
-const trading_1 = require("./trading");
-const utils_1 = require("../utils");
+const types_1 = require("../../types");
+const pnl_1 = require("../trading/pnl");
+const enum_1 = require("../enum");
 const getOpenPositionData = (driftClient, userPositions, user, perpMarketLookup, markPriceCallback) => {
     const oracleGuardRails = driftClient.getStateAccount().oracleGuardRails;
     const newResult = userPositions
@@ -25,8 +25,8 @@ const getOpenPositionData = (driftClient, userPositions, user, perpMarketLookup,
         const entryPrice = (0, sdk_1.calculateEntryPrice)(position);
         const isShort = position.baseAssetAmount.isNeg();
         if (types_1.UIMarket.checkIsPredictionMarket(perpMarketConfig)) {
-            const isResolved = utils_1.ENUM_UTILS.match(perpMarket === null || perpMarket === void 0 ? void 0 : perpMarket.status, sdk_1.MarketStatus.SETTLEMENT) ||
-                utils_1.ENUM_UTILS.match(perpMarket === null || perpMarket === void 0 ? void 0 : perpMarket.status, sdk_1.MarketStatus.DELISTED);
+            const isResolved = enum_1.ENUM_UTILS.match(perpMarket === null || perpMarket === void 0 ? void 0 : perpMarket.status, sdk_1.MarketStatus.SETTLEMENT) ||
+                enum_1.ENUM_UTILS.match(perpMarket === null || perpMarket === void 0 ? void 0 : perpMarket.status, sdk_1.MarketStatus.DELISTED);
             if (isResolved) {
                 const resolvedToNo = perpMarket.expiryPrice.lte(sdk_1.ZERO.add(perpMarket.amm.orderTickSize));
                 const price = resolvedToNo
@@ -44,7 +44,7 @@ const getOpenPositionData = (driftClient, userPositions, user, perpMarketLookup,
         if (oraclePrice.lte(sdk_1.ZERO) && markPrice.gt(sdk_1.ZERO)) {
             oraclePrice = markPrice;
         }
-        const pnlVsMark = trading_1.TRADING_UTILS.calculatePotentialProfit({
+        const pnlVsMark = (0, pnl_1.calculatePotentialProfit)({
             currentPositionSize: sdk_1.BigNum.from(position.baseAssetAmount.abs(), sdk_1.BASE_PRECISION_EXP),
             currentPositionDirection: isShort
                 ? sdk_1.PositionDirection.SHORT
@@ -57,7 +57,7 @@ const getOpenPositionData = (driftClient, userPositions, user, perpMarketLookup,
             exitPrice: sdk_1.BigNum.from(markPrice, sdk_1.PRICE_PRECISION_EXP),
             takerFeeBps: 0,
         }).estimatedProfit.shiftTo(sdk_1.QUOTE_PRECISION_EXP).val;
-        const pnlVsOracle = trading_1.TRADING_UTILS.calculatePotentialProfit({
+        const pnlVsOracle = (0, pnl_1.calculatePotentialProfit)({
             currentPositionSize: sdk_1.BigNum.from(position.baseAssetAmount.abs(), sdk_1.BASE_PRECISION_EXP),
             currentPositionDirection: isShort
                 ? sdk_1.PositionDirection.SHORT
@@ -106,76 +106,5 @@ const getOpenPositionData = (driftClient, userPositions, user, perpMarketLookup,
     });
     return newResult;
 };
-const checkIfUserAccountExists = async (driftClient, config) => {
-    let userPubKey;
-    if (config.type === 'userPubKey') {
-        userPubKey = config.userPubKey;
-    }
-    else {
-        userPubKey = (0, sdk_1.getUserAccountPublicKeySync)(driftClient.program.programId, config.authority, config.subAccountId);
-    }
-    const accountInfo = await driftClient.connection.getAccountInfo(userPubKey);
-    return accountInfo !== null;
-};
-/**
- * A user's max leverage for a market is stored on-chain in the `PerpPosition` struct of the `UserAccount`.
- * There are a few scenarios for how a market's max leverage is defined:
- *
- * 1. When the user does not have a position ("empty" or not) in the market in their `UserAccount` data,
- * and creates an order for the market, an "empty" `PerpPosition` will be upsert to the `UserAccount` data,
- * and will contain the max margin ratio set by the user. Note that the `UserAccount` data can store up
- * to 8 `PerpPosition` structs, and most of the time the majority of the `PerpPosition` structs will be
- * "empty" if the user does not have the max 8 perp positions open. The max leverage is then derived from
- * the max margin ratio set in the `PerpPosition` struct.
- *
- * 2. If the user has a position ("empty" or not), but no open orders and is provided with a saved max leverage,
- * the saved max leverage is used.
- *
- * 3. When the user does not have a position ("empty" or not), it is expected of the UI to store and persist
- * the max leverage in the UI client.
- *
- * 4. In cases where the user has a position before the market max leverage feature was shipped, the
- * position is not expected to have a max margin ratio set, and the UI should display the regular max
- * leverage for the market, unless the user is already in High Leverage Mode, in which case the UI should
- * display the high leverage max leverage for the market (if any).
- */
-const getUserMaxLeverageForMarket = (user, marketIndex, marketLeverageDetails, uiSavedMaxLeverage) => {
-    // if no saved max leverage is provided, return the regular max leverage for the market
-    const DEFAULT_MAX_LEVERAGE = uiSavedMaxLeverage !== null && uiSavedMaxLeverage !== void 0 ? uiSavedMaxLeverage : marketLeverageDetails.regularMaxLeverage;
-    if (!user) {
-        return DEFAULT_MAX_LEVERAGE;
-    }
-    const openOrClosedPosition = user.getPerpPosition(marketIndex); // this position does not have to be open, it can be a closed position (a.k.a "empty") but has max margin ratio set.
-    if (!openOrClosedPosition) {
-        return DEFAULT_MAX_LEVERAGE;
-    }
-    const positionHasMaxMarginRatioSet = !!openOrClosedPosition.maxMarginRatio;
-    const isPositionOpen = !openOrClosedPosition.baseAssetAmount.eq(sdk_1.ZERO);
-    const hasNoOpenOrders = openOrClosedPosition.openOrders === 0;
-    if (positionHasMaxMarginRatioSet) {
-        // Special case: open position with no orders - use UI saved value if available
-        if (isPositionOpen && hasNoOpenOrders && uiSavedMaxLeverage) {
-            return uiSavedMaxLeverage;
-        }
-        return parseFloat(((1 / openOrClosedPosition.maxMarginRatio) * 10000).toFixed(2));
-    }
-    if (isPositionOpen) {
-        // user has an existing position from before PML ship (this means no max margin ratio set onchain yet)
-        // display max leverage for the leverage mode their account is in
-        const isUserInHighLeverageMode = user.isHighLeverageMode('Initial');
-        const grandfatheredMaxLev = isUserInHighLeverageMode
-            ? marketLeverageDetails.hasHighLeverage
-                ? marketLeverageDetails.highLeverageMaxLeverage
-                : marketLeverageDetails.regularMaxLeverage
-            : marketLeverageDetails.regularMaxLeverage;
-        return grandfatheredMaxLev;
-    }
-    // user has closed position with no margin ratio set, return default value
-    return DEFAULT_MAX_LEVERAGE;
-};
-exports.USER_UTILS = {
-    getOpenPositionData,
-    checkIfUserAccountExists,
-    getUserMaxLeverageForMarket,
-};
-//# sourceMappingURL=user.js.map
+exports.getOpenPositionData = getOpenPositionData;
+//# sourceMappingURL=open.js.map

package/lib/utils/positions/open.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open.js","sourceRoot":"","sources":["../../../src/utils/positions/open.ts"],"names":[],"mappings":";;;AAAA,yCAwByB;AACzB,uCAAqD;AACrD,wCAA0D;AAC1D,kCAAqC;AAErC,MAAM,mBAAmB,GAAG,CAC3B,WAAwB,EACxB,aAA6B,EAC7B,IAAU,EACV,gBAAoC,EACpC,iBAA+C,EAC9B,EAAE;IACnB,MAAM,gBAAgB,GAAG,WAAW,CAAC,eAAe,EAAE,CAAC,gBAAgB,CAAC;IAExE,MAAM,SAAS,GAAmB,aAAa;SAC7C,MAAM,CACN,CAAC,QAAQ,EAAE,EAAE,CACZ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,UAAI,CAAC;QAClC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAI,CAAC,CACpC;SACA,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;;QACjB,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAChE,MAAM,UAAU,GAAG,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE1E,MAAM,cAAc,GAAG,WAAW,CAAC,oBAAoB,CACtD,6BAAuB,CACvB,CAAC;QAEF,MAAM,eAAe,GAAG,WAAW,CAAC,0BAA0B,CAC7D,QAAQ,CAAC,WAAW,CACpB,CAAC;QAEF,IAAI,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC;QAExC,kGAAkG;QAClG,IAAI,SAAS,GAAG,iBAAiB;YAChC,CAAC,CAAC,MAAA,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,mCAAI,eAAe,CAAC,KAAK;YAClE,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC;QAEzB,IAAI,YAAY,GAAG,IAAI,CAAC,mCAAmC,CAC1D,QAAQ,EACR,QAAQ,CAAC,eAAe,CACxB,CAAC,CAAC,CAAC,CAAC;QAEL,MAAM,UAAU,GAAG,IAAA,yBAAmB,EAAC,QAAQ,CAAC,CAAC;QAEjD,MAAM,OAAO,GAAG,QAAQ,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAEjD,IAAI,gBAAQ,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACxD,MAAM,UAAU,GACf,iBAAU,CAAC,KAAK,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,EAAE,kBAAY,CAAC,UAAU,CAAC;gBAC7D,iBAAU,CAAC,KAAK,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,EAAE,kBAAY,CAAC,QAAQ,CAAC,CAAC;YAE7D,IAAI,UAAU,EAAE,CAAC;gBAChB,MAAM,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAC9C,UAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CACtC,CAAC;gBAEF,MAAM,KAAK,GAAG,YAAY;oBACzB,CAAC,CAAC,UAAI,CAAC,GAAG,CAAC,qBAAe,CAAC;oBAC3B,CAAC,CAAC,SAAG,CAAC,GAAG,CAAC,qBAAe,CAAC,CAAC;gBAE5B,YAAY,GAAG,KAAK,CAAC;gBACrB,SAAS,GAAG,KAAK,CAAC;gBAClB,WAAW,GAAG,KAAK,CAAC;YACrB,CAAC;QACF,CAAC;QAED,4GAA4G;QAC5G,IAAI,SAAS,CAAC,GAAG,CAAC,UAAI,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC,UAAI,CAAC,EAAE,CAAC;YACjD,SAAS,GAAG,WAAW,CAAC;QACzB,CAAC;QAED,IAAI,WAAW,CAAC,GAAG,CAAC,UAAI,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,UAAI,CAAC,EAAE,CAAC;YACjD,WAAW,GAAG,SAAS,CAAC;QACzB,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,8BAAwB,EAAC;YAC1C,mBAAmB,EAAE,YAAM,CAAC,IAAI,CAC/B,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAC9B,wBAAkB,CAClB;YACD,wBAAwB,EAAE,OAAO;gBAChC,CAAC,CAAC,uBAAiB,CAAC,KAAK;gBACzB,CAAC,CAAC,uBAAiB,CAAC,IAAI;YACzB,yBAAyB,EAAE,YAAM,CAAC,IAAI,CAAC,UAAU,EAAE,yBAAmB,CAAC;YACvE,cAAc,EAAE,OAAO;gBACtB,CAAC,CAAC,uBAAiB,CAAC,IAAI;gBACxB,CAAC,CAAC,uBAAiB,CAAC,KAAK;YAC1B,YAAY,EAAE,YAAM,CAAC,IAAI,CACxB,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAC9B,wBAAkB,CAClB;YACD,SAAS,EAAE,YAAM,CAAC,IAAI,CAAC,SAAS,EAAE,yBAAmB,CAAC;YACtD,WAAW,EAAE,CAAC;SACd,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,yBAAmB,CAAC,CAAC,GAAG,CAAC;QAEpD,MAAM,WAAW,GAAG,IAAA,8BAAwB,EAAC;YAC5C,mBAAmB,EAAE,YAAM,CAAC,IAAI,CAC/B,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAC9B,wBAAkB,CAClB;YACD,wBAAwB,EAAE,OAAO;gBAChC,CAAC,CAAC,uBAAiB,CAAC,KAAK;gBACzB,CAAC,CAAC,uBAAiB,CAAC,IAAI;YACzB,yBAAyB,EAAE,YAAM,CAAC,IAAI,CAAC,UAAU,EAAE,yBAAmB,CAAC;YACvE,cAAc,EAAE,OAAO;gBACtB,CAAC,CAAC,uBAAiB,CAAC,IAAI;gBACxB,CAAC,CAAC,uBAAiB,CAAC,KAAK;YAC1B,YAAY,EAAE,YAAM,CAAC,IAAI,CACxB,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAC9B,wBAAkB,CAClB;YACD,SAAS,EAAE,YAAM,CAAC,IAAI,CAAC,WAAW,EAAE,yBAAmB,CAAC;YACxD,WAAW,EAAE,CAAC;SACd,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,yBAAmB,CAAC,CAAC,GAAG,CAAC;QAEpD,OAAO;YACN,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,YAAY,EAAE,gBAAgB,CAAC,MAAM;YACrC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;YACrC,QAAQ,EAAE,QAAQ,CAAC,eAAe;iBAChC,GAAG,EAAE;iBACL,GAAG,CAAC,SAAS,CAAC;iBACd,GAAG,CAAC,2BAAqB,CAAC;YAC5B,QAAQ,EAAE,QAAQ,CAAC,eAAe;YAClC,SAAS;YACT,UAAU;YACV,SAAS,EAAE,YAAY;YACvB,QAAQ,EAAE,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC;gBAC9C,CAAC,CAAC,IAAI,CAAC,gBAAgB,CACrB,QAAQ,CAAC,WAAW,EACpB,UAAI,EACJ,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,UAAU,CACT;gBACH,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAI,CAAC;YACpD,wBAAwB,EAAE,QAAQ,CAAC,gBAAgB;YACnD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;YAC3C,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB;YACnD,SAAS;YACT,WAAW;YACX,YAAY,EAAE,IAAA,2BAAqB,EAClC,UAAU,EACV,cAAc,EACd,QAAQ,EACR,eAAe,CACf;YACD,mBAAmB,EAAE,IAAA,kCAA4B,EAAC,UAAU,EAAE,QAAQ,CAAC;YACvE,8DAA8D;YAC9D,iBAAiB,EAAE,IAAA,gCAA0B,EAAC,UAAU,EAAE,QAAQ,CAAC;YACnE,kBAAkB,EAAE,IAAA,0BAAoB,EACvC,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,eAAe,CACf;YACD,oBAAoB,EAAE,IAAI,CAAC,uBAAuB,CACjD,QAAQ,CAAC,WAAW,CACpB;YACD,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB;YAC7D,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,SAAS,EAAE,IAAA,wBAAkB,EAAC,QAAQ,CAAC;YACvC,WAAW,EAAE,QAAQ,CAAC,UAAU;YAChC,cAAc,EAAE,IAAA,mBAAa,EAC5B,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,MAAA,UAAU,CAAC,GAAG,CAAC,cAAc,0CAAE,QAAQ,EAAE,CACzC;YACD,cAAc,EAAE,QAAQ,CAAC,cAAc;SACvC,CAAC;IACH,CAAC,CAAC,CAAC;IAEJ,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEO,kDAAmB","sourcesContent":["import {\n\tBASE_PRECISION_EXP,\n\tBN,\n\tBigNum,\n\tDriftClient,\n\tMarketStatus,\n\tONE,\n\tPRICE_PRECISION,\n\tPRICE_PRECISION_EXP,\n\tPerpMarketConfig,\n\tPerpPosition,\n\tPositionDirection,\n\tQUOTE_PRECISION_EXP,\n\tQUOTE_SPOT_MARKET_INDEX,\n\tUser,\n\tZERO,\n\tcalculateClaimablePnl,\n\tcalculateCostBasis,\n\tcalculateEntryPrice,\n\tcalculateFeesAndFundingPnl,\n\tcalculatePositionPNL,\n\tcalculateUnsettledFundingPnl,\n\tisOracleValid,\n\tAMM_RESERVE_PRECISION,\n} from '@drift-labs/sdk';\nimport { OpenPosition, UIMarket } from '../../types';\nimport { calculatePotentialProfit } from '../trading/pnl';\nimport { ENUM_UTILS } from '../enum';\n\nconst getOpenPositionData = (\n\tdriftClient: DriftClient,\n\tuserPositions: PerpPosition[],\n\tuser: User,\n\tperpMarketLookup: PerpMarketConfig[],\n\tmarkPriceCallback?: (marketIndex: number) => BN\n): OpenPosition[] => {\n\tconst oracleGuardRails = driftClient.getStateAccount().oracleGuardRails;\n\n\tconst newResult: OpenPosition[] = userPositions\n\t\t.filter(\n\t\t\t(position) =>\n\t\t\t\t!position.baseAssetAmount.eq(ZERO) ||\n\t\t\t\t!position.quoteAssetAmount.eq(ZERO)\n\t\t)\n\t\t.map((position) => {\n\t\t\tconst perpMarketConfig = perpMarketLookup[position.marketIndex];\n\t\t\tconst perpMarket = driftClient.getPerpMarketAccount(position.marketIndex);\n\n\t\t\tconst usdcSpotMarket = driftClient.getSpotMarketAccount(\n\t\t\t\tQUOTE_SPOT_MARKET_INDEX\n\t\t\t);\n\n\t\t\tconst oraclePriceData = driftClient.getOracleDataForPerpMarket(\n\t\t\t\tposition.marketIndex\n\t\t\t);\n\n\t\t\tlet oraclePrice = oraclePriceData.price;\n\n\t\t\t// mark price fetched with a callback so we don't need extra dlob server calls. fallback to oracle\n\t\t\tlet markPrice = markPriceCallback\n\t\t\t\t? markPriceCallback(position.marketIndex) ?? oraclePriceData.price\n\t\t\t\t: oraclePriceData.price;\n\n\t\t\tlet estExitPrice = user.getPositionEstimatedExitPriceAndPnl(\n\t\t\t\tposition,\n\t\t\t\tposition.baseAssetAmount\n\t\t\t)[0];\n\n\t\t\tconst entryPrice = calculateEntryPrice(position);\n\n\t\t\tconst isShort = position.baseAssetAmount.isNeg();\n\n\t\t\tif (UIMarket.checkIsPredictionMarket(perpMarketConfig)) {\n\t\t\t\tconst isResolved =\n\t\t\t\t\tENUM_UTILS.match(perpMarket?.status, MarketStatus.SETTLEMENT) ||\n\t\t\t\t\tENUM_UTILS.match(perpMarket?.status, MarketStatus.DELISTED);\n\n\t\t\t\tif (isResolved) {\n\t\t\t\t\tconst resolvedToNo = perpMarket.expiryPrice.lte(\n\t\t\t\t\t\tZERO.add(perpMarket.amm.orderTickSize)\n\t\t\t\t\t);\n\n\t\t\t\t\tconst price = resolvedToNo\n\t\t\t\t\t\t? ZERO.mul(PRICE_PRECISION)\n\t\t\t\t\t\t: ONE.mul(PRICE_PRECISION);\n\n\t\t\t\t\testExitPrice = price;\n\t\t\t\t\tmarkPrice = price;\n\t\t\t\t\toraclePrice = price;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// if for any reason oracle or mark price blips to 0, fallback to the other one so we don't show a crazy pnl\n\t\t\tif (markPrice.lte(ZERO) && oraclePrice.gt(ZERO)) {\n\t\t\t\tmarkPrice = oraclePrice;\n\t\t\t}\n\n\t\t\tif (oraclePrice.lte(ZERO) && markPrice.gt(ZERO)) {\n\t\t\t\toraclePrice = markPrice;\n\t\t\t}\n\n\t\t\tconst pnlVsMark = calculatePotentialProfit({\n\t\t\t\tcurrentPositionSize: BigNum.from(\n\t\t\t\t\tposition.baseAssetAmount.abs(),\n\t\t\t\t\tBASE_PRECISION_EXP\n\t\t\t\t),\n\t\t\t\tcurrentPositionDirection: isShort\n\t\t\t\t\t? PositionDirection.SHORT\n\t\t\t\t\t: PositionDirection.LONG,\n\t\t\t\tcurrentPositionEntryPrice: BigNum.from(entryPrice, PRICE_PRECISION_EXP),\n\t\t\t\ttradeDirection: isShort\n\t\t\t\t\t? PositionDirection.LONG\n\t\t\t\t\t: PositionDirection.SHORT,\n\t\t\t\texitBaseSize: BigNum.from(\n\t\t\t\t\tposition.baseAssetAmount.abs(),\n\t\t\t\t\tBASE_PRECISION_EXP\n\t\t\t\t),\n\t\t\t\texitPrice: BigNum.from(markPrice, PRICE_PRECISION_EXP),\n\t\t\t\ttakerFeeBps: 0,\n\t\t\t}).estimatedProfit.shiftTo(QUOTE_PRECISION_EXP).val;\n\n\t\t\tconst pnlVsOracle = calculatePotentialProfit({\n\t\t\t\tcurrentPositionSize: BigNum.from(\n\t\t\t\t\tposition.baseAssetAmount.abs(),\n\t\t\t\t\tBASE_PRECISION_EXP\n\t\t\t\t),\n\t\t\t\tcurrentPositionDirection: isShort\n\t\t\t\t\t? PositionDirection.SHORT\n\t\t\t\t\t: PositionDirection.LONG,\n\t\t\t\tcurrentPositionEntryPrice: BigNum.from(entryPrice, PRICE_PRECISION_EXP),\n\t\t\t\ttradeDirection: isShort\n\t\t\t\t\t? PositionDirection.LONG\n\t\t\t\t\t: PositionDirection.SHORT,\n\t\t\t\texitBaseSize: BigNum.from(\n\t\t\t\t\tposition.baseAssetAmount.abs(),\n\t\t\t\t\tBASE_PRECISION_EXP\n\t\t\t\t),\n\t\t\t\texitPrice: BigNum.from(oraclePrice, PRICE_PRECISION_EXP),\n\t\t\t\ttakerFeeBps: 0,\n\t\t\t}).estimatedProfit.shiftTo(QUOTE_PRECISION_EXP).val;\n\n\t\t\treturn {\n\t\t\t\tmarketIndex: position.marketIndex,\n\t\t\t\tmarketSymbol: perpMarketConfig.symbol,\n\t\t\t\tdirection: isShort ? 'short' : 'long',\n\t\t\t\tnotional: position.baseAssetAmount\n\t\t\t\t\t.abs()\n\t\t\t\t\t.mul(markPrice)\n\t\t\t\t\t.div(AMM_RESERVE_PRECISION),\n\t\t\t\tbaseSize: position.baseAssetAmount,\n\t\t\t\tmarkPrice,\n\t\t\t\tentryPrice,\n\t\t\t\texitPrice: estExitPrice,\n\t\t\t\tliqPrice: user.isPerpPositionIsolated(position)\n\t\t\t\t\t? user.liquidationPrice(\n\t\t\t\t\t\t\tposition.marketIndex,\n\t\t\t\t\t\t\tZERO,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t\t'Isolated'\n\t\t\t\t\t  )\n\t\t\t\t\t: user.liquidationPrice(position.marketIndex, ZERO),\n\t\t\t\tquoteAssetNotionalAmount: position.quoteAssetAmount,\n\t\t\t\tquoteEntryAmount: position.quoteEntryAmount,\n\t\t\t\tquoteBreakEvenAmount: position.quoteBreakEvenAmount,\n\t\t\t\tpnlVsMark,\n\t\t\t\tpnlVsOracle,\n\t\t\t\tunsettledPnl: calculateClaimablePnl(\n\t\t\t\t\tperpMarket,\n\t\t\t\t\tusdcSpotMarket,\n\t\t\t\t\tposition,\n\t\t\t\t\toraclePriceData\n\t\t\t\t),\n\t\t\t\tunsettledFundingPnl: calculateUnsettledFundingPnl(perpMarket, position),\n\t\t\t\t// Includes both settled and unsettled funding as well as fees\n\t\t\t\tfeesAndFundingPnl: calculateFeesAndFundingPnl(perpMarket, position),\n\t\t\t\ttotalUnrealizedPnl: calculatePositionPNL(\n\t\t\t\t\tperpMarket,\n\t\t\t\t\tposition,\n\t\t\t\t\ttrue,\n\t\t\t\t\toraclePriceData\n\t\t\t\t),\n\t\t\t\tunrealizedFundingPnl: user.getUnrealizedFundingPNL(\n\t\t\t\t\tposition.marketIndex\n\t\t\t\t),\n\t\t\t\tlastCumulativeFundingRate: position.lastCumulativeFundingRate,\n\t\t\t\topenOrders: position.openOrders,\n\t\t\t\tcostBasis: calculateCostBasis(position),\n\t\t\t\trealizedPnl: position.settledPnl,\n\t\t\t\tpnlIsClaimable: isOracleValid(\n\t\t\t\t\tperpMarket,\n\t\t\t\t\toraclePriceData,\n\t\t\t\t\toracleGuardRails,\n\t\t\t\t\tperpMarket.amm.lastUpdateSlot?.toNumber()\n\t\t\t\t),\n\t\t\t\tmaxMarginRatio: position.maxMarginRatio,\n\t\t\t};\n\t\t});\n\n\treturn newResult;\n};\n\nexport { getOpenPositionData };\n"]}

package/lib/utils/positions/user.d.ts

@@ -0,0 +1,37 @@
+import { DriftClient, PublicKey, User } from '@drift-labs/sdk';
+declare const checkIfUserAccountExists: (driftClient: DriftClient, config: {
+    type: 'userPubKey';
+    userPubKey: PublicKey;
+} | {
+    type: 'subAccountId';
+    subAccountId: number;
+    authority: PublicKey;
+}) => Promise<boolean>;
+/**
+ * A user's max leverage for a market is stored on-chain in the `PerpPosition` struct of the `UserAccount`.
+ * There are a few scenarios for how a market's max leverage is defined:
+ *
+ * 1. When the user does not have a position ("empty" or not) in the market in their `UserAccount` data,
+ * and creates an order for the market, an "empty" `PerpPosition` will be upsert to the `UserAccount` data,
+ * and will contain the max margin ratio set by the user. Note that the `UserAccount` data can store up
+ * to 8 `PerpPosition` structs, and most of the time the majority of the `PerpPosition` structs will be
+ * "empty" if the user does not have the max 8 perp positions open. The max leverage is then derived from
+ * the max margin ratio set in the `PerpPosition` struct.
+ *
+ * 2. If the user has a position ("empty" or not), but no open orders and is provided with a saved max leverage,
+ * the saved max leverage is used.
+ *
+ * 3. When the user does not have a position ("empty" or not), it is expected of the UI to store and persist
+ * the max leverage in the UI client.
+ *
+ * 4. In cases where the user has a position before the market max leverage feature was shipped, the
+ * position is not expected to have a max margin ratio set, and the UI should display the regular max
+ * leverage for the market, unless the user is already in High Leverage Mode, in which case the UI should
+ * display the high leverage max leverage for the market (if any).
+ */
+declare const getUserMaxLeverageForMarket: (user: User | undefined, marketIndex: number, marketLeverageDetails: {
+    regularMaxLeverage: number;
+    highLeverageMaxLeverage: number;
+    hasHighLeverage: boolean;
+}, uiSavedMaxLeverage?: number) => number;
+export { checkIfUserAccountExists, getUserMaxLeverageForMarket };

package/lib/utils/positions/user.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserMaxLeverageForMarket = exports.checkIfUserAccountExists = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const checkIfUserAccountExists = async (driftClient, config) => {
+    let userPubKey;
+    if (config.type === 'userPubKey') {
+        userPubKey = config.userPubKey;
+    }
+    else {
+        userPubKey = (0, sdk_1.getUserAccountPublicKeySync)(driftClient.program.programId, config.authority, config.subAccountId);
+    }
+    const accountInfo = await driftClient.connection.getAccountInfo(userPubKey);
+    return accountInfo !== null;
+};
+exports.checkIfUserAccountExists = checkIfUserAccountExists;
+/**
+ * A user's max leverage for a market is stored on-chain in the `PerpPosition` struct of the `UserAccount`.
+ * There are a few scenarios for how a market's max leverage is defined:
+ *
+ * 1. When the user does not have a position ("empty" or not) in the market in their `UserAccount` data,
+ * and creates an order for the market, an "empty" `PerpPosition` will be upsert to the `UserAccount` data,
+ * and will contain the max margin ratio set by the user. Note that the `UserAccount` data can store up
+ * to 8 `PerpPosition` structs, and most of the time the majority of the `PerpPosition` structs will be
+ * "empty" if the user does not have the max 8 perp positions open. The max leverage is then derived from
+ * the max margin ratio set in the `PerpPosition` struct.
+ *
+ * 2. If the user has a position ("empty" or not), but no open orders and is provided with a saved max leverage,
+ * the saved max leverage is used.
+ *
+ * 3. When the user does not have a position ("empty" or not), it is expected of the UI to store and persist
+ * the max leverage in the UI client.
+ *
+ * 4. In cases where the user has a position before the market max leverage feature was shipped, the
+ * position is not expected to have a max margin ratio set, and the UI should display the regular max
+ * leverage for the market, unless the user is already in High Leverage Mode, in which case the UI should
+ * display the high leverage max leverage for the market (if any).
+ */
+const getUserMaxLeverageForMarket = (user, marketIndex, marketLeverageDetails, uiSavedMaxLeverage) => {
+    // if no saved max leverage is provided, return the regular max leverage for the market
+    const DEFAULT_MAX_LEVERAGE = uiSavedMaxLeverage !== null && uiSavedMaxLeverage !== void 0 ? uiSavedMaxLeverage : marketLeverageDetails.regularMaxLeverage;
+    if (!user) {
+        return DEFAULT_MAX_LEVERAGE;
+    }
+    const openOrClosedPosition = user.getPerpPosition(marketIndex); // this position does not have to be open, it can be a closed position (a.k.a "empty") but has max margin ratio set.
+    if (!openOrClosedPosition) {
+        return DEFAULT_MAX_LEVERAGE;
+    }
+    const positionHasMaxMarginRatioSet = !!openOrClosedPosition.maxMarginRatio;
+    const isPositionOpen = !openOrClosedPosition.baseAssetAmount.eq(sdk_1.ZERO);
+    const hasNoOpenOrders = openOrClosedPosition.openOrders === 0;
+    if (positionHasMaxMarginRatioSet) {
+        // Special case: open position with no orders - use UI saved value if available
+        if (isPositionOpen && hasNoOpenOrders && uiSavedMaxLeverage) {
+            return uiSavedMaxLeverage;
+        }
+        return parseFloat(((1 / openOrClosedPosition.maxMarginRatio) * 10000).toFixed(2));
+    }
+    if (isPositionOpen) {
+        // user has an existing position from before PML ship (this means no max margin ratio set onchain yet)
+        // display max leverage for the leverage mode their account is in
+        const isUserInHighLeverageMode = user.isHighLeverageMode('Initial');
+        const grandfatheredMaxLev = isUserInHighLeverageMode
+            ? marketLeverageDetails.hasHighLeverage
+                ? marketLeverageDetails.highLeverageMaxLeverage
+                : marketLeverageDetails.regularMaxLeverage
+            : marketLeverageDetails.regularMaxLeverage;
+        return grandfatheredMaxLev;
+    }
+    // user has closed position with no margin ratio set, return default value
+    return DEFAULT_MAX_LEVERAGE;
+};
+exports.getUserMaxLeverageForMarket = getUserMaxLeverageForMarket;
+//# sourceMappingURL=user.js.map

package/lib/utils/positions/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/utils/positions/user.ts"],"names":[],"mappings":";;;AAAA,yCAMyB;AAEzB,MAAM,wBAAwB,GAAG,KAAK,EACrC,WAAwB,EACxB,MASI,EACH,EAAE;IACH,IAAI,UAAqB,CAAC;IAE1B,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;SAAM,CAAC;QACP,UAAU,GAAG,IAAA,iCAA2B,EACvC,WAAW,CAAC,OAAO,CAAC,SAAS,EAC7B,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,YAAY,CACnB,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAE5E,OAAO,WAAW,KAAK,IAAI,CAAC;AAC7B,CAAC,CAAC;AA+EO,4DAAwB;AA7EjC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,2BAA2B,GAAG,CACnC,IAAsB,EACtB,WAAmB,EACnB,qBAIC,EACD,kBAA2B,EAC1B,EAAE;IACH,uFAAuF;IACvF,MAAM,oBAAoB,GACzB,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,qBAAqB,CAAC,kBAAkB,CAAC;IAEhE,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,OAAO,oBAAoB,CAAC;IAC7B,CAAC;IAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,oHAAoH;IAEpL,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC3B,OAAO,oBAAoB,CAAC;IAC7B,CAAC;IAED,MAAM,4BAA4B,GAAG,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC;IAC3E,MAAM,cAAc,GAAG,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,CAAC,UAAI,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,oBAAoB,CAAC,UAAU,KAAK,CAAC,CAAC;IAE9D,IAAI,4BAA4B,EAAE,CAAC;QAClC,+EAA+E;QAC/E,IAAI,cAAc,IAAI,eAAe,IAAI,kBAAkB,EAAE,CAAC;YAC7D,OAAO,kBAAkB,CAAC;QAC3B,CAAC;QAED,OAAO,UAAU,CAChB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAC9D,CAAC;IACH,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACpB,sGAAsG;QACtG,iEAAiE;QACjE,MAAM,wBAAwB,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,mBAAmB,GAAG,wBAAwB;YACnD,CAAC,CAAC,qBAAqB,CAAC,eAAe;gBACtC,CAAC,CAAC,qBAAqB,CAAC,uBAAuB;gBAC/C,CAAC,CAAC,qBAAqB,CAAC,kBAAkB;YAC3C,CAAC,CAAC,qBAAqB,CAAC,kBAAkB,CAAC;QAC5C,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAED,0EAA0E;IAC1E,OAAO,oBAAoB,CAAC;AAC7B,CAAC,CAAC;AAEiC,kEAA2B","sourcesContent":["import {\n\tDriftClient,\n\tPublicKey,\n\tUser,\n\tZERO,\n\tgetUserAccountPublicKeySync,\n} from '@drift-labs/sdk';\n\nconst checkIfUserAccountExists = async (\n\tdriftClient: DriftClient,\n\tconfig:\n\t\t| {\n\t\t\t\ttype: 'userPubKey';\n\t\t\t\tuserPubKey: PublicKey;\n\t\t  }\n\t\t| {\n\t\t\t\ttype: 'subAccountId';\n\t\t\t\tsubAccountId: number;\n\t\t\t\tauthority: PublicKey;\n\t\t  }\n) => {\n\tlet userPubKey: PublicKey;\n\n\tif (config.type === 'userPubKey') {\n\t\tuserPubKey = config.userPubKey;\n\t} else {\n\t\tuserPubKey = getUserAccountPublicKeySync(\n\t\t\tdriftClient.program.programId,\n\t\t\tconfig.authority,\n\t\t\tconfig.subAccountId\n\t\t);\n\t}\n\n\tconst accountInfo = await driftClient.connection.getAccountInfo(userPubKey);\n\n\treturn accountInfo !== null;\n};\n\n/**\n * A user's max leverage for a market is stored on-chain in the `PerpPosition` struct of the `UserAccount`.\n * There are a few scenarios for how a market's max leverage is defined:\n *\n * 1. When the user does not have a position (\"empty\" or not) in the market in their `UserAccount` data,\n * and creates an order for the market, an \"empty\" `PerpPosition` will be upsert to the `UserAccount` data,\n * and will contain the max margin ratio set by the user. Note that the `UserAccount` data can store up\n * to 8 `PerpPosition` structs, and most of the time the majority of the `PerpPosition` structs will be\n * \"empty\" if the user does not have the max 8 perp positions open. The max leverage is then derived from\n * the max margin ratio set in the `PerpPosition` struct.\n *\n * 2. If the user has a position (\"empty\" or not), but no open orders and is provided with a saved max leverage,\n * the saved max leverage is used.\n *\n * 3. When the user does not have a position (\"empty\" or not), it is expected of the UI to store and persist\n * the max leverage in the UI client.\n *\n * 4. In cases where the user has a position before the market max leverage feature was shipped, the\n * position is not expected to have a max margin ratio set, and the UI should display the regular max\n * leverage for the market, unless the user is already in High Leverage Mode, in which case the UI should\n * display the high leverage max leverage for the market (if any).\n */\nconst getUserMaxLeverageForMarket = (\n\tuser: User | undefined,\n\tmarketIndex: number,\n\tmarketLeverageDetails: {\n\t\tregularMaxLeverage: number;\n\t\thighLeverageMaxLeverage: number;\n\t\thasHighLeverage: boolean;\n\t},\n\tuiSavedMaxLeverage?: number\n) => {\n\t// if no saved max leverage is provided, return the regular max leverage for the market\n\tconst DEFAULT_MAX_LEVERAGE =\n\t\tuiSavedMaxLeverage ?? marketLeverageDetails.regularMaxLeverage;\n\n\tif (!user) {\n\t\treturn DEFAULT_MAX_LEVERAGE;\n\t}\n\n\tconst openOrClosedPosition = user.getPerpPosition(marketIndex); // this position does not have to be open, it can be a closed position (a.k.a \"empty\") but has max margin ratio set.\n\n\tif (!openOrClosedPosition) {\n\t\treturn DEFAULT_MAX_LEVERAGE;\n\t}\n\n\tconst positionHasMaxMarginRatioSet = !!openOrClosedPosition.maxMarginRatio;\n\tconst isPositionOpen = !openOrClosedPosition.baseAssetAmount.eq(ZERO);\n\tconst hasNoOpenOrders = openOrClosedPosition.openOrders === 0;\n\n\tif (positionHasMaxMarginRatioSet) {\n\t\t// Special case: open position with no orders - use UI saved value if available\n\t\tif (isPositionOpen && hasNoOpenOrders && uiSavedMaxLeverage) {\n\t\t\treturn uiSavedMaxLeverage;\n\t\t}\n\n\t\treturn parseFloat(\n\t\t\t((1 / openOrClosedPosition.maxMarginRatio) * 10000).toFixed(2)\n\t\t);\n\t}\n\n\tif (isPositionOpen) {\n\t\t// user has an existing position from before PML ship (this means no max margin ratio set onchain yet)\n\t\t// display max leverage for the leverage mode their account is in\n\t\tconst isUserInHighLeverageMode = user.isHighLeverageMode('Initial');\n\t\tconst grandfatheredMaxLev = isUserInHighLeverageMode\n\t\t\t? marketLeverageDetails.hasHighLeverage\n\t\t\t\t? marketLeverageDetails.highLeverageMaxLeverage\n\t\t\t\t: marketLeverageDetails.regularMaxLeverage\n\t\t\t: marketLeverageDetails.regularMaxLeverage;\n\t\treturn grandfatheredMaxLev;\n\t}\n\n\t// user has closed position with no margin ratio set, return default value\n\treturn DEFAULT_MAX_LEVERAGE;\n};\n\nexport { checkIfUserAccountExists, getUserMaxLeverageForMarket };\n"]}

package/lib/utils/settings/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../src/utils/settings/settings.ts"],"names":[],"mappings":";;;AAAA,iCAAuC;AAUvC,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC7B,2CAAqB,CAAA;IACrB,iDAA2B,CAAA;IAC3B,uDAAiC,CAAA;AAClC,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAWD;;;;;;;;;GASG;AACI,MAAM,4BAA4B,GAAG,CAC3C,uBAA+B,EAC/B,OAAgB,EAChB,OAA+B,EAC/B,IAAwB,EACxB,qBAA6B,EAC7B,sBAA8B,EACL,EAAE,CAAC,CAAC;IAC7B,uBAAuB;IACvB,OAAO;IACP,OAAO;IACP,IAAI;IACJ,qBAAqB;IACrB,sBAAsB;CACtB,CAAC,CAAC;AAdU,QAAA,4BAA4B,gCActC;AAKH;;GAEG;AACH,MAAa,wBAAwB;IAGpC;;;;;OAKG;IACH,KAAK,CAAC,QAAW;;QAChB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAClC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,GAAG,CAAC,CAAC,uBAAuB,CAC/D,CAAC;QAEF,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAChD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;gBAClD,OAAO,IAAI,CAAC;YACb,CAAC;YACD,OAAO,IAAI,CAAC,uBAAuB,IAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,CAAA,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAC1B,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAC1D,MAAA,QAAQ,CAAC,OAAO,mCAAI,CAAC,CAAC,CACtB,CAAC;QAEF,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QAE1C,MAAM,iBAAiB,GAA6B,EAAE,CAAC;QAEvD,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7B,WAAW,CAAC,OAAO,GAAG,IAAA,eAAO,EAAC,WAAW,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC5D,MAAM,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,GACvD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAErB,IAAI,oBAAoB,EAAE,CAAC;oBAC1B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9B,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1D,WAAW,CAAC,OAAO,GAAG,IAAA,eAAO,EAAC,WAAW,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5D,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,IAAI,yBAAyB,GAAG,EAAE,CAAC;QAEnC,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,yBAAyB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,yBAAyB,GAAG,iEAAiE,iBAAiB;iBAC5G,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC;iBAC1C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAChB,CAAC;QAED,OAAO;YACN,wBAAwB,EAAE,oBAAoB;YAC9C,mBAAmB,EAAE,WAAW,CAAC,OAAO;YACxC,yBAAyB;SACzB,CAAC;IACH,CAAC;IAED,YAAY,KAAgC;QAC3C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;CACD;AArED,4DAqEC","sourcesContent":["import { Draft, produce } from 'immer';\n\nexport declare type TransformerFunction<S> = (draft: Draft<S>) => {\n\ttransformationWasApplied: boolean;\n};\n\ntype VersionedSettings = Record<string, unknown> & {\n\tversion?: number;\n};\n\nexport enum SettingHandlerType {\n\tAdditive = 'additive',\n\tSubtractive = 'subtractive',\n\tTransformative = 'transformative',\n}\n\nexport type SettingsVersionRule<T = VersionedSettings> = {\n\tminVersionDiscriminator: number;\n\tsetting: keyof T;\n\thandler: TransformerFunction<T>;\n\ttype: SettingHandlerType;\n\tlongChangeDescription: string;\n\tshortChangeDescription: string;\n};\n\n/**\n *\n * @param minVersionDiscriminator\n * @param setting\n * @param handler\n * @param type\n * @param longChangeDescription : This description will be returned if this was the ONLY transformation rule that needed to apply. E.g. : \"Priority fee upgrades were recently release, and your priority fee settings were recently reset to defaults.\"\n * @param shortChangeDescription : This description will be returned if this was one of many transformation rules that needed to apply, they will be presented in a list. E.g. : \"Your priority fee settings were recently reset to defaults.\" => \"The following settings were changed to support new features : 'Your priority fee settings were recently reset to defaults.',  '{something else}', etc.\"\"\n * @returns\n */\nexport const VersionedSettingsRuleFactory = <T = VersionedSettings>(\n\tminVersionDiscriminator: number,\n\tsetting: keyof T,\n\thandler: TransformerFunction<T>,\n\ttype: SettingHandlerType,\n\tlongChangeDescription: string,\n\tshortChangeDescription: string\n): SettingsVersionRule<T> => ({\n\tminVersionDiscriminator,\n\tsetting,\n\thandler,\n\ttype,\n\tlongChangeDescription,\n\tshortChangeDescription,\n});\n\nexport type VersionedSettingsRules<T extends VersionedSettings> =\n\tSettingsVersionRule<T>[];\n\n/**\n * The versioned settings handler ensures that old settings can be upgraded into newer versioned settings. It reports back on any changes if they were applied.\n */\nexport class VersionedSettingsHandler<T extends VersionedSettings> {\n\tprivate rules: VersionedSettingsRules<T>;\n\n\t/**\n\t * Applies each of the handlers in order, depending on the version of the incoming settings.\n\t *\n\t * Returns the new settings, with a list of change descriptions and an updated version number.\n\t * @param settings\n\t */\n\tapply(settings: T) {\n\t\tconst sortedRules = this.rules.sort(\n\t\t\t(a, b) => a.minVersionDiscriminator - b.minVersionDiscriminator\n\t\t);\n\n\t\tconst rulesToApply = sortedRules.filter((rule) => {\n\t\t\tif (!settings[rule.setting] || !settings.version) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t\treturn rule.minVersionDiscriminator > settings?.version;\n\t\t});\n\n\t\tconst maxVersion = Math.max(\n\t\t\t...sortedRules.map((rule) => rule.minVersionDiscriminator),\n\t\t\tsettings.version ?? -1\n\t\t);\n\n\t\tconst newSettings = { current: settings };\n\n\t\tconst transformsApplied: SettingsVersionRule<T>[] = [];\n\n\t\trulesToApply.forEach((rule) => {\n\t\t\tnewSettings.current = produce(newSettings.current, (draft) => {\n\t\t\t\tconst { transformationWasApplied: ruleTransformApplied } =\n\t\t\t\t\trule.handler(draft);\n\n\t\t\t\tif (ruleTransformApplied) {\n\t\t\t\t\ttransformsApplied.push(rule);\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\n\t\tconst aTransformWasApplied = transformsApplied.length > 0;\n\n\t\tnewSettings.current = produce(newSettings.current, (draft) => {\n\t\t\tdraft.version = maxVersion;\n\t\t});\n\n\t\tlet transformationDescription = '';\n\n\t\tif (transformsApplied.length === 1) {\n\t\t\ttransformationDescription = transformsApplied[0].longChangeDescription;\n\t\t}\n\n\t\tif (transformsApplied.length > 1) {\n\t\t\ttransformationDescription = `The following settings were changed to support new features : ${transformsApplied\n\t\t\t\t.map((rule) => rule.shortChangeDescription)\n\t\t\t\t.join(', ')}`;\n\t\t}\n\n\t\treturn {\n\t\t\ttransformationWasApplied: aTransformWasApplied,\n\t\t\ttransformedSettings: newSettings.current,\n\t\t\ttransformationDescription,\n\t\t};\n\t}\n\n\tconstructor(rules: VersionedSettingsRules<T>) {\n\t\tthis.rules = rules;\n\t}\n}\n"]}

package/lib/utils/strings/convert.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Recursively converts various types into printable strings.
+ */
+export declare function toPrintableObject(obj: unknown, 
+/** Used to guard against circular refs during recursion. */
+seen?: WeakSet<object>): unknown;
+export declare function convertStringValuesToNumbers<T>(obj: T): T;
+/**
+ * Returns an array of an object's string values (deep).
+ */
+export declare function extractStringValuesFromObject(value: object): string[];

package/lib/utils/{strings.js → strings/convert.js}

@@ -1,56 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractStringValuesFromObject = exports.convertStringValuesToNumbers = exports.toPrintableObject = exports.lastOrderStatusToNormalEng = exports.disallowNegativeStringInput = exports.lowerCaseNonFirstWords = exports.splitByCapitalLetters = exports.abbreviateAccountName = exports.isValidBase58 = void 0;
+exports.extractStringValuesFromObject = exports.convertStringValuesToNumbers = exports.toPrintableObject = void 0;
 const sdk_1 = require("@drift-labs/sdk");
-const isValidBase58 = (str) => /^[1-9A-HJ-NP-Za-km-z]{32,44}$/.test(str);
-exports.isValidBase58 = isValidBase58;
-function abbreviateAccountName(name, size = 8, opts) {
-    if (name.length <= size)
-        return name;
-    if (opts === null || opts === void 0 ? void 0 : opts.ellipsisMiddle) {
-        const length = name.length;
-        const sizeMid = Math.floor(size / 2);
-        return name.slice(0, sizeMid) + '...' + name.slice(length - sizeMid);
-    }
-    return name.slice(0, size) + '...';
-}
-exports.abbreviateAccountName = abbreviateAccountName;
-function splitByCapitalLetters(word) {
-    return word.replace(/([A-Z])/g, ' $1').trim();
-}
-exports.splitByCapitalLetters = splitByCapitalLetters;
-function lowerCaseNonFirstWords(sentence) {
-    const words = sentence.split(' ');
-    for (let i = 1; i < words.length; i++) {
-        words[i] = words[i].toLowerCase();
-    }
-    return words.join(' ');
-}
-exports.lowerCaseNonFirstWords = lowerCaseNonFirstWords;
-const disallowNegativeStringInput = (str) => {
-    if (str && str.charAt(0) === '-') {
-        return '0';
-    }
-    return str;
-};
-exports.disallowNegativeStringInput = disallowNegativeStringInput;
-/**
- * LastOrder status types from https://github.com/drift-labs/infrastructure-v3/blob/8ab1888eaaaed96228406b562d4a399729d042d7/packages/common/src/types/index.ts#L221
- */
-const LAST_ORDER_STATUS_LABELS = {
-    open: 'Open',
-    filled: 'Filled',
-    partial_fill: 'Partially Filled',
-    cancelled: 'Canceled',
-    partial_fill_cancelled: 'Partially Filled & Canceled',
-    expired: 'Expired',
-    trigger: 'Triggered',
-};
-function lastOrderStatusToNormalEng(status) {
-    var _a;
-    return (_a = LAST_ORDER_STATUS_LABELS[status]) !== null && _a !== void 0 ? _a : status;
-}
-exports.lastOrderStatusToNormalEng = lastOrderStatusToNormalEng;
 /**
  * Recursively converts various types into printable strings.
  */
@@ -118,4 +69,4 @@ function extractStringValuesFromObject(value) {
     return [];
 }
 exports.extractStringValuesFromObject = extractStringValuesFromObject;
-//# sourceMappingURL=strings.js.map
+//# sourceMappingURL=convert.js.map

package/lib/utils/strings/convert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.js","sourceRoot":"","sources":["../../../src/utils/strings/convert.ts"],"names":[],"mappings":";;;AAAA,yCAA6C;AAE7C;;GAEG;AACH,SAAgB,iBAAiB,CAChC,GAAY;AACZ,4DAA4D;AAC5D,OAAwB,IAAI,OAAO,EAAE;IAErC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,GAAG,YAAY,YAAM,IAAI,QAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACtE,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAE3B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,cAAc,CAAC;QACvB,CAAC;QAED,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,OAAO,YAAY,CAAC;QACrB,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEd,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YACzC,GAAG;YACH,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC;SAC9B,CAAC,CACF,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AA3CD,8CA2CC;AAED,SAAgB,4BAA4B,CAAI,GAAM;IACrD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACpD,OAAO,MAAM,CAAC,GAAG,CAAM,CAAC;IACzB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,GAAG,CAAC,4BAA4B,CAAM,CAAC;IACnD,CAAC;IAED,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC7C,OAAO,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YACzC,GAAG;YACH,4BAA4B,CAAC,KAAK,CAAC;SACnC,CAAC,CACG,CAAC;IACR,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AAnBD,oEAmBC;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAAC,KAAa;IAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAdD,sEAcC","sourcesContent":["import { BN, BigNum } from '@drift-labs/sdk';\n\n/**\n * Recursively converts various types into printable strings.\n */\nexport function toPrintableObject(\n\tobj: unknown,\n\t/** Used to guard against circular refs during recursion. */\n\tseen: WeakSet<object> = new WeakSet()\n): unknown {\n\tif (obj == null) {\n\t\treturn null;\n\t}\n\n\tif (obj instanceof BigNum || BN.isBN(obj) || typeof obj === 'bigint') {\n\t\treturn obj.toString();\n\t}\n\n\tif (obj instanceof Date) {\n\t\tconst time = obj.getTime();\n\n\t\tif (Number.isNaN(time)) {\n\t\t\treturn 'Invalid Date';\n\t\t}\n\n\t\treturn obj.toISOString();\n\t}\n\n\tif (typeof obj === 'object') {\n\t\tif (seen.has(obj)) {\n\t\t\treturn '[Circular]';\n\t\t}\n\n\t\tseen.add(obj);\n\n\t\tif (Array.isArray(obj)) {\n\t\t\treturn obj.map((value) => toPrintableObject(value, seen));\n\t\t}\n\n\t\treturn Object.fromEntries(\n\t\t\tObject.entries(obj).map(([key, value]) => [\n\t\t\t\tkey,\n\t\t\t\ttoPrintableObject(value, seen),\n\t\t\t])\n\t\t);\n\t}\n\n\treturn obj;\n}\n\nexport function convertStringValuesToNumbers<T>(obj: T): T {\n\tif (typeof obj === 'string' && !isNaN(Number(obj))) {\n\t\treturn Number(obj) as T;\n\t}\n\n\tif (Array.isArray(obj)) {\n\t\treturn obj.map(convertStringValuesToNumbers) as T;\n\t}\n\n\tif (obj !== null && typeof obj === 'object') {\n\t\treturn Object.fromEntries(\n\t\t\tObject.entries(obj).map(([key, value]) => [\n\t\t\t\tkey,\n\t\t\t\tconvertStringValuesToNumbers(value),\n\t\t\t])\n\t\t) as T;\n\t}\n\n\treturn obj;\n}\n\n/**\n * Returns an array of an object's string values (deep).\n */\nexport function extractStringValuesFromObject(value: object): string[] {\n\tif (typeof value === 'string') {\n\t\treturn [value];\n\t}\n\n\tif (Array.isArray(value)) {\n\t\treturn value.flatMap(extractStringValuesFromObject);\n\t}\n\n\tif (value && typeof value === 'object') {\n\t\treturn Object.values(value).flatMap(extractStringValuesFromObject);\n\t}\n\n\treturn [];\n}\n"]}

package/lib/utils/strings/format.d.ts

@@ -0,0 +1,14 @@
+import { PublicKey } from '@drift-labs/sdk';
+export declare const abbreviateAddress: (address: string | PublicKey, length?: number) => string;
+/**
+ * Trim trailing zeros from a numerical string
+ * @param str - numerical string to format
+ * @param zerosToShow - max number of zeros to show after the decimal. Similar to number.toFixed() but won't trim non-zero values. Optional, default value is 1
+ */
+export declare const trimTrailingZeros: (str: string, zerosToShow?: number) => string;
+export declare const toSnakeCase: (str: string) => string;
+export declare const toCamelCase: (str: string) => string;
+export declare const normalizeBaseAssetSymbol: (symbol: string) => string;
+export declare function abbreviateAccountName(name: string, size?: number, opts?: {
+    ellipsisMiddle?: boolean;
+}): string;

package/lib/utils/strings/format.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.abbreviateAccountName = exports.normalizeBaseAssetSymbol = exports.toCamelCase = exports.toSnakeCase = exports.trimTrailingZeros = exports.abbreviateAddress = void 0;
+const cache_1 = require("../core/cache");
+const abbreviateAddress = (address, length = 4) => {
+    if (!address)
+        return '';
+    const authString = address.toString();
+    return (0, cache_1.getCachedUiString)('abbreviate', authString, length);
+};
+exports.abbreviateAddress = abbreviateAddress;
+/**
+ * Trim trailing zeros from a numerical string
+ * @param str - numerical string to format
+ * @param zerosToShow - max number of zeros to show after the decimal. Similar to number.toFixed() but won't trim non-zero values. Optional, default value is 1
+ */
+const trimTrailingZeros = (str, zerosToShow = 1) => {
+    // Ignore strings with no decimal point
+    if (!str.includes('.'))
+        return str;
+    const sides = str.split('.');
+    sides[1] = sides[1].replace(/0+$/, '');
+    if (sides[1].length < zerosToShow) {
+        const zerosToAdd = zerosToShow - sides[1].length;
+        sides[1] = `${sides[1]}${Array(zerosToAdd).fill('0').join('')}`;
+    }
+    if (sides[1].length === 0) {
+        return sides[0];
+    }
+    else {
+        return sides.join('.');
+    }
+};
+exports.trimTrailingZeros = trimTrailingZeros;
+const toSnakeCase = (str) => str.replace(/[^\w]/g, '_').toLowerCase();
+exports.toSnakeCase = toSnakeCase;
+const toCamelCase = (str) => {
+    const words = str.split(/[_\-\s]+/); // split on underscores, hyphens, and spaces
+    const firstWord = words[0].toLowerCase();
+    const restWords = words
+        .slice(1)
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase());
+    return [firstWord, ...restWords].join('');
+};
+exports.toCamelCase = toCamelCase;
+const normalizeBaseAssetSymbol = (symbol) => {
+    return symbol.replace(/^1M/, '');
+};
+exports.normalizeBaseAssetSymbol = normalizeBaseAssetSymbol;
+function abbreviateAccountName(name, size = 8, opts) {
+    if (name.length <= size)
+        return name;
+    if (opts === null || opts === void 0 ? void 0 : opts.ellipsisMiddle) {
+        const length = name.length;
+        const sizeMid = Math.floor(size / 2);
+        return name.slice(0, sizeMid) + '...' + name.slice(length - sizeMid);
+    }
+    return name.slice(0, size) + '...';
+}
+exports.abbreviateAccountName = abbreviateAccountName;
+//# sourceMappingURL=format.js.map

package/lib/utils/strings/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/utils/strings/format.ts"],"names":[],"mappings":";;;AACA,yCAAkD;AAE3C,MAAM,iBAAiB,GAAG,CAAC,OAA2B,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE;IAC5E,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACtC,OAAO,IAAA,yBAAiB,EAAC,YAAY,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAC5D,CAAC,CAAC;AAJW,QAAA,iBAAiB,qBAI5B;AAEF;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,WAAW,GAAG,CAAC,EAAE,EAAE;IACjE,uCAAuC;IACvC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IAEnC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7B,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAEvC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACjD,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;IACjE,CAAC;IAED,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;SAAM,CAAC;QACP,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;AACF,CAAC,CAAC;AAlBW,QAAA,iBAAiB,qBAkB5B;AAEK,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE,CAClD,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;AAD7B,QAAA,WAAW,eACkB;AAEnC,MAAM,WAAW,GAAG,CAAC,GAAW,EAAU,EAAE;IAClD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,4CAA4C;IACjF,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,KAAK;SACrB,KAAK,CAAC,CAAC,CAAC;SACR,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5E,OAAO,CAAC,SAAS,EAAE,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAPW,QAAA,WAAW,eAOtB;AAEK,MAAM,wBAAwB,GAAG,CAAC,MAAc,EAAE,EAAE;IAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAClC,CAAC,CAAC;AAFW,QAAA,wBAAwB,4BAEnC;AAEF,SAAgB,qBAAqB,CACpC,IAAY,EACZ,IAAI,GAAG,CAAC,EACR,IAEC;IAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAErC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;QAErC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;AACpC,CAAC;AAjBD,sDAiBC","sourcesContent":["import { PublicKey } from '@drift-labs/sdk';\nimport { getCachedUiString } from '../core/cache';\n\nexport const abbreviateAddress = (address: string | PublicKey, length = 4) => {\n\tif (!address) return '';\n\tconst authString = address.toString();\n\treturn getCachedUiString('abbreviate', authString, length);\n};\n\n/**\n * Trim trailing zeros from a numerical string\n * @param str - numerical string to format\n * @param zerosToShow - max number of zeros to show after the decimal. Similar to number.toFixed() but won't trim non-zero values. Optional, default value is 1\n */\nexport const trimTrailingZeros = (str: string, zerosToShow = 1) => {\n\t// Ignore strings with no decimal point\n\tif (!str.includes('.')) return str;\n\n\tconst sides = str.split('.');\n\n\tsides[1] = sides[1].replace(/0+$/, '');\n\n\tif (sides[1].length < zerosToShow) {\n\t\tconst zerosToAdd = zerosToShow - sides[1].length;\n\t\tsides[1] = `${sides[1]}${Array(zerosToAdd).fill('0').join('')}`;\n\t}\n\n\tif (sides[1].length === 0) {\n\t\treturn sides[0];\n\t} else {\n\t\treturn sides.join('.');\n\t}\n};\n\nexport const toSnakeCase = (str: string): string =>\n\tstr.replace(/[^\\w]/g, '_').toLowerCase();\n\nexport const toCamelCase = (str: string): string => {\n\tconst words = str.split(/[_\\-\\s]+/); // split on underscores, hyphens, and spaces\n\tconst firstWord = words[0].toLowerCase();\n\tconst restWords = words\n\t\t.slice(1)\n\t\t.map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase());\n\treturn [firstWord, ...restWords].join('');\n};\n\nexport const normalizeBaseAssetSymbol = (symbol: string) => {\n\treturn symbol.replace(/^1M/, '');\n};\n\nexport function abbreviateAccountName(\n\tname: string,\n\tsize = 8,\n\topts?: {\n\t\tellipsisMiddle?: boolean;\n\t}\n) {\n\tif (name.length <= size) return name;\n\n\tif (opts?.ellipsisMiddle) {\n\t\tconst length = name.length;\n\t\tconst sizeMid = Math.floor(size / 2);\n\n\t\treturn name.slice(0, sizeMid) + '...' + name.slice(length - sizeMid);\n\t}\n\n\treturn name.slice(0, size) + '...';\n}\n"]}

package/lib/utils/strings/index.d.ts

@@ -0,0 +1,4 @@
+export * from './convert';
+export * from './format';
+export * from './parse';
+export * from './status';