@metamask-previews/perps-controller 10.0.0-preview-a42e8d0d2 → 10.0.0-preview-5a03e1b92

package/dist/utils/orderTypes.d.mts

@@ -0,0 +1,114 @@
+import type { Order, PositionTriggerOrder } from "../types/index.mjs";
+import type { OrderExecution, OrderType, TriggerDirection, TriggerOrderType } from "../types/perps-types.mjs";
+/**
+ * All trigger placement types, in a stable order suitable for iteration
+ * (validation tables, e2e matrices).
+ */
+export declare const TRIGGER_ORDER_TYPES: readonly ["stop_market", "stop_limit", "take_profit_market", "take_profit_limit"];
+/**
+ * Check whether an order type is a trigger placement (stop / take profit).
+ *
+ * @param orderType - Order type to check.
+ * @returns True when the type requires `OrderParams.triggerPrice`.
+ */
+export declare function isTriggerOrderType(orderType: OrderType): orderType is TriggerOrderType;
+/**
+ * Check whether an order type executes as a limit order.
+ *
+ * Covers plain limit orders and the `*_limit` trigger types, both of which
+ * require `OrderParams.price`.
+ *
+ * @param orderType - Order type to check.
+ * @returns True when the order executes as a limit order.
+ */
+export declare function isLimitExecutionOrderType(orderType: OrderType): boolean;
+/**
+ * Get how an order executes, ignoring whether it is trigger-gated.
+ *
+ * This is also the coarse execution type that consumers predating trigger orders
+ * understand (fee tiers, max order value, analytics).
+ *
+ * @param orderType - Order type to inspect.
+ * @returns `'limit'` for limit and `*_limit` types, `'market'` otherwise.
+ */
+export declare function getTriggerExecution(orderType: OrderType): OrderExecution;
+/**
+ * Get the direction a trigger order fires in.
+ *
+ * @param orderType - Trigger order type.
+ * @returns `'stop'` for `stop_*`, `'take_profit'` for `take_profit_*`.
+ */
+export declare function getTriggerDirection(orderType: TriggerOrderType): TriggerDirection;
+/**
+ * Recover which way a trigger fires from its price relative to the entry.
+ *
+ * Used when the exchange reports a trigger without naming its placement type:
+ * a long takes profit above its entry and stops out below, a short the other
+ * way round. Shared by both transports so they classify identically.
+ *
+ * @param params - Classification parameters
+ * @param params.triggerPrice - Price at which the order activates
+ * @param params.entryPrice - Entry price of the position it is attached to
+ * @param params.positionSize - Signed position size; its sign gives the side
+ * @returns The direction, or undefined when there is nothing to compare against
+ */
+export declare function classifyTriggerDirection(params: {
+    triggerPrice?: string;
+    entryPrice?: string;
+    positionSize: string;
+}): TriggerDirection | undefined;
+/**
+ * Project a normalized open order onto the position-state view of a trigger order.
+ *
+ * Returns undefined when the order is not a trigger, or when its direction can
+ * be established neither from a named placement type nor from its price.
+ *
+ * @param params - Mapping parameters
+ * @param params.order - Normalized open order
+ * @param params.positionSize - Size of the position the trigger is attached to
+ * @param params.entryPrice - Entry price, used to classify an unnamed trigger
+ * @returns The position trigger order, or undefined
+ */
+export declare function buildPositionTriggerOrderFromOrder(params: {
+    order: Order;
+    positionSize: string;
+    entryPrice?: string;
+}): PositionTriggerOrder | undefined;
+/**
+ * Build a trigger order type from its two independent dimensions.
+ *
+ * @param params - Trigger dimensions.
+ * @param params.direction - Whether the trigger is a stop or a take profit.
+ * @param params.execution - How the order executes once triggered.
+ * @returns The matching trigger order type.
+ */
+export declare function buildTriggerOrderType(params: {
+    direction: TriggerDirection;
+    execution: OrderExecution;
+}): TriggerOrderType;
+/**
+ * Map the controller's time in force onto the exchange's spelling.
+ *
+ * Shared by the two order-building paths so they cannot drift apart.
+ *
+ * @param timeInForce - Requested time in force; defaults to GTC.
+ * @returns The SDK time-in-force value.
+ */
+export declare function toSDKTimeInForce(timeInForce?: 'GTC' | 'IOC' | 'ALO'): 'Gtc' | 'Ioc' | 'Alo';
+/**
+ * Hash the identity of a position's trigger orders for change detection.
+ *
+ * Streamed positions only re-emit when their hash changes, so this has to move
+ * when a trigger is added, removed, repriced, resized, or retyped — otherwise
+ * subscribers never receive the updated arrays.
+ *
+ * The placement type is part of the identity because a trigger can be modified
+ * in place: switching a stop from market to limit execution keeps its order ID,
+ * trigger price, and size, so nothing else here would move even though the
+ * execution semantics subscribers rely on have changed.
+ *
+ * @param orders - Trigger orders attached to a position, if any.
+ * @returns A stable string; `'0'` for both empty and absent.
+ */
+export declare function hashTriggerOrders(orders?: PositionTriggerOrder[]): string;
+//# sourceMappingURL=orderTypes.d.mts.map

package/dist/utils/orderTypes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderTypes.d.mts","sourceRoot":"","sources":["../../src/utils/orderTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,2BAA0B;AACrE,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EACjB,iCAAgC;AAEjC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mFAKgB,CAAC;AAYjD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,SAAS,GACnB,SAAS,IAAI,gBAAgB,CAE/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAIvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,gBAAgB,GAC1B,gBAAgB,CAIlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,gBAAgB,GAAG,SAAS,CAuB/B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kCAAkC,CAAC,MAAM,EAAE;IACzD,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,oBAAoB,GAAG,SAAS,CAqDnC;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE;IAC5C,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,cAAc,CAAC;CAC3B,GAAG,gBAAgB,CAQnB;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAClC,KAAK,GAAG,KAAK,GAAG,KAAK,CASvB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,MAAM,CAUzE"}

package/dist/utils/orderTypes.mjs

@@ -0,0 +1,210 @@
+/**
+ * All trigger placement types, in a stable order suitable for iteration
+ * (validation tables, e2e matrices).
+ */
+export const TRIGGER_ORDER_TYPES = [
+    'stop_market',
+    'stop_limit',
+    'take_profit_market',
+    'take_profit_limit',
+];
+/**
+ * Order types whose price field (`OrderParams.price`) is a real limit price the
+ * exchange must honour, as opposed to a slippage cap derived from the market.
+ */
+const LIMIT_EXECUTION_ORDER_TYPES = [
+    'limit',
+    'stop_limit',
+    'take_profit_limit',
+];
+/**
+ * Check whether an order type is a trigger placement (stop / take profit).
+ *
+ * @param orderType - Order type to check.
+ * @returns True when the type requires `OrderParams.triggerPrice`.
+ */
+export function isTriggerOrderType(orderType) {
+    return TRIGGER_ORDER_TYPES.includes(orderType);
+}
+/**
+ * Check whether an order type executes as a limit order.
+ *
+ * Covers plain limit orders and the `*_limit` trigger types, both of which
+ * require `OrderParams.price`.
+ *
+ * @param orderType - Order type to check.
+ * @returns True when the order executes as a limit order.
+ */
+export function isLimitExecutionOrderType(orderType) {
+    return LIMIT_EXECUTION_ORDER_TYPES.includes(orderType);
+}
+/**
+ * Get how an order executes, ignoring whether it is trigger-gated.
+ *
+ * This is also the coarse execution type that consumers predating trigger orders
+ * understand (fee tiers, max order value, analytics).
+ *
+ * @param orderType - Order type to inspect.
+ * @returns `'limit'` for limit and `*_limit` types, `'market'` otherwise.
+ */
+export function getTriggerExecution(orderType) {
+    return isLimitExecutionOrderType(orderType) ? 'limit' : 'market';
+}
+/**
+ * Get the direction a trigger order fires in.
+ *
+ * @param orderType - Trigger order type.
+ * @returns `'stop'` for `stop_*`, `'take_profit'` for `take_profit_*`.
+ */
+export function getTriggerDirection(orderType) {
+    return orderType === 'stop_market' || orderType === 'stop_limit'
+        ? 'stop'
+        : 'take_profit';
+}
+/**
+ * Recover which way a trigger fires from its price relative to the entry.
+ *
+ * Used when the exchange reports a trigger without naming its placement type:
+ * a long takes profit above its entry and stops out below, a short the other
+ * way round. Shared by both transports so they classify identically.
+ *
+ * @param params - Classification parameters
+ * @param params.triggerPrice - Price at which the order activates
+ * @param params.entryPrice - Entry price of the position it is attached to
+ * @param params.positionSize - Signed position size; its sign gives the side
+ * @returns The direction, or undefined when there is nothing to compare against
+ */
+export function classifyTriggerDirection(params) {
+    const { triggerPrice, entryPrice, positionSize } = params;
+    const trigger = parseFloat(triggerPrice ?? '');
+    const entry = parseFloat(entryPrice ?? '');
+    const signedSize = parseFloat(positionSize || '0');
+    if (!Number.isFinite(trigger) || !Number.isFinite(entry) || entry <= 0) {
+        return undefined;
+    }
+    // A long takes profit above its entry and stops out below; a short is the
+    // mirror image. A trigger sitting exactly at entry is neither, so both sides
+    // fall to 'stop' — matching the legacy price fallback the scalar
+    // takeProfitPrice/stopLossPrice fields still use. Splitting that tie the
+    // other way would file the order under takeProfitOrders while the scalar
+    // still reported it as a stop.
+    const isLong = signedSize > 0;
+    if (isLong) {
+        return trigger > entry ? 'take_profit' : 'stop';
+    }
+    return trigger < entry ? 'take_profit' : 'stop';
+}
+/**
+ * Project a normalized open order onto the position-state view of a trigger order.
+ *
+ * Returns undefined when the order is not a trigger, or when its direction can
+ * be established neither from a named placement type nor from its price.
+ *
+ * @param params - Mapping parameters
+ * @param params.order - Normalized open order
+ * @param params.positionSize - Size of the position the trigger is attached to
+ * @param params.entryPrice - Entry price, used to classify an unnamed trigger
+ * @returns The position trigger order, or undefined
+ */
+export function buildPositionTriggerOrderFromOrder(params) {
+    const { order, positionSize, entryPrice } = params;
+    if (!order.isTrigger) {
+        return undefined;
+    }
+    // HyperLiquid sometimes reports a bare 'Trigger', naming neither direction
+    // nor execution. The direction is still recoverable from the trigger price
+    // against the entry, and it is what decides which array the order belongs
+    // to — so an unnamed trigger is kept rather than dropped, with its execution
+    // mode left unstated. Without a position to compare against there is nothing
+    // to recover, and it is dropped.
+    const direction = order.triggerOrderType === undefined
+        ? classifyTriggerDirection({
+            triggerPrice: order.triggerPrice ?? order.price,
+            entryPrice,
+            positionSize,
+        })
+        : getTriggerDirection(order.triggerOrderType);
+    if (!direction) {
+        return undefined;
+    }
+    const absolutePositionSize = Math.abs(parseFloat(positionSize || '0'));
+    const rawSize = Math.abs(parseFloat(order.size || '0'));
+    // A position-bound TP/SL covers whatever the position currently is. The
+    // exchange encodes that as size 0, but `adaptOrderFromSDK` has already
+    // resolved it against the position as it stood when the order was adapted,
+    // so the size carried here goes stale as soon as the position is resized.
+    // The flag is the durable statement of what the trigger covers; the number
+    // is not. Reading the number instead would report the old size, and would
+    // call the order partial whenever the position had since grown.
+    const isPositionBound = order.isPositionTpsl === true;
+    const size = isPositionBound || rawSize === 0 ? absolutePositionSize : rawSize;
+    return {
+        orderId: order.orderId,
+        direction,
+        orderType: order.triggerOrderType,
+        triggerPrice: order.triggerPrice ?? order.price,
+        size: size.toString(),
+        isPartial: !isPositionBound &&
+            rawSize > 0 &&
+            absolutePositionSize > 0 &&
+            rawSize < absolutePositionSize,
+        reduceOnly: Boolean(order.reduceOnly),
+    };
+}
+/**
+ * Build a trigger order type from its two independent dimensions.
+ *
+ * @param params - Trigger dimensions.
+ * @param params.direction - Whether the trigger is a stop or a take profit.
+ * @param params.execution - How the order executes once triggered.
+ * @returns The matching trigger order type.
+ */
+export function buildTriggerOrderType(params) {
+    const { direction, execution } = params;
+    if (direction === 'stop') {
+        return execution === 'limit' ? 'stop_limit' : 'stop_market';
+    }
+    return execution === 'limit' ? 'take_profit_limit' : 'take_profit_market';
+}
+/**
+ * Map the controller's time in force onto the exchange's spelling.
+ *
+ * Shared by the two order-building paths so they cannot drift apart.
+ *
+ * @param timeInForce - Requested time in force; defaults to GTC.
+ * @returns The SDK time-in-force value.
+ */
+export function toSDKTimeInForce(timeInForce) {
+    switch (timeInForce) {
+        case 'IOC':
+            return 'Ioc';
+        case 'ALO':
+            return 'Alo';
+        default:
+            return 'Gtc';
+    }
+}
+/**
+ * Hash the identity of a position's trigger orders for change detection.
+ *
+ * Streamed positions only re-emit when their hash changes, so this has to move
+ * when a trigger is added, removed, repriced, resized, or retyped — otherwise
+ * subscribers never receive the updated arrays.
+ *
+ * The placement type is part of the identity because a trigger can be modified
+ * in place: switching a stop from market to limit execution keeps its order ID,
+ * trigger price, and size, so nothing else here would move even though the
+ * execution semantics subscribers rely on have changed.
+ *
+ * @param orders - Trigger orders attached to a position, if any.
+ * @returns A stable string; `'0'` for both empty and absent.
+ */
+export function hashTriggerOrders(orders) {
+    if (!orders || orders.length === 0) {
+        return '0';
+    }
+    return orders
+        .map((order) => `${order.orderId}:${order.direction}:${order.orderType ?? '?'}@${order.triggerPrice}x${order.size}${order.isPartial ? 'p' : ''}`)
+        .join(',');
+}
+//# sourceMappingURL=orderTypes.mjs.map

package/dist/utils/orderTypes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderTypes.mjs","sourceRoot":"","sources":["../../src/utils/orderTypes.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa;IACb,YAAY;IACZ,oBAAoB;IACpB,mBAAmB;CAC2B,CAAC;AAEjD;;;GAGG;AACH,MAAM,2BAA2B,GAAG;IAClC,OAAO;IACP,YAAY;IACZ,mBAAmB;CACoB,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAAoB;IAEpB,OAAQ,mBAA4C,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CAAC,SAAoB;IAC5D,OAAQ,2BAAoD,CAAC,QAAQ,CACnE,SAAS,CACV,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAoB;IACtD,OAAO,yBAAyB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AACnE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAA2B;IAE3B,OAAO,SAAS,KAAK,aAAa,IAAI,SAAS,KAAK,YAAY;QAC9D,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,aAAa,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAIxC;IACC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IAE1D,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC;IAEnD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACvE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,0EAA0E;IAC1E,6EAA6E;IAC7E,iEAAiE;IACjE,yEAAyE;IACzE,yEAAyE;IACzE,+BAA+B;IAC/B,MAAM,MAAM,GAAG,UAAU,GAAG,CAAC,CAAC;IAE9B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;IAClD,CAAC;IACD,OAAO,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kCAAkC,CAAC,MAIlD;IACC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAEnD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,2EAA2E;IAC3E,2EAA2E;IAC3E,0EAA0E;IAC1E,6EAA6E;IAC7E,6EAA6E;IAC7E,iCAAiC;IACjC,MAAM,SAAS,GACb,KAAK,CAAC,gBAAgB,KAAK,SAAS;QAClC,CAAC,CAAC,wBAAwB,CAAC;YACvB,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,KAAK;YAC/C,UAAU;YACV,YAAY;SACb,CAAC;QACJ,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAElD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;IAExD,wEAAwE;IACxE,uEAAuE;IACvE,2EAA2E;IAC3E,0EAA0E;IAC1E,2EAA2E;IAC3E,0EAA0E;IAC1E,gEAAgE;IAChE,MAAM,eAAe,GAAG,KAAK,CAAC,cAAc,KAAK,IAAI,CAAC;IACtD,MAAM,IAAI,GACR,eAAe,IAAI,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC;IAEpE,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,SAAS;QACT,SAAS,EAAE,KAAK,CAAC,gBAAgB;QACjC,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,KAAK;QAC/C,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;QACrB,SAAS,EACP,CAAC,eAAe;YAChB,OAAO,GAAG,CAAC;YACX,oBAAoB,GAAG,CAAC;YACxB,OAAO,GAAG,oBAAoB;QAChC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;KACtC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAGrC;IACC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAExC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC;IAC9D,CAAC;IAED,OAAO,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,oBAAoB,CAAC;AAC5E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,WAAmC;IAEnC,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,KAAK,CAAC;QACf,KAAK,KAAK;YACR,OAAO,KAAK,CAAC;QACf;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA+B;IAC/D,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,MAAM;SACV,GAAG,CACF,CAAC,KAAK,EAAE,EAAE,CACR,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACnI;SACA,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC","sourcesContent":["import type { Order, PositionTriggerOrder } from '../types/index.js';\nimport type {\n  OrderExecution,\n  OrderType,\n  TriggerDirection,\n  TriggerOrderType,\n} from '../types/perps-types.js';\n\n/**\n * All trigger placement types, in a stable order suitable for iteration\n * (validation tables, e2e matrices).\n */\nexport const TRIGGER_ORDER_TYPES = [\n  'stop_market',\n  'stop_limit',\n  'take_profit_market',\n  'take_profit_limit',\n] as const satisfies readonly TriggerOrderType[];\n\n/**\n * Order types whose price field (`OrderParams.price`) is a real limit price the\n * exchange must honour, as opposed to a slippage cap derived from the market.\n */\nconst LIMIT_EXECUTION_ORDER_TYPES = [\n  'limit',\n  'stop_limit',\n  'take_profit_limit',\n] as const satisfies readonly OrderType[];\n\n/**\n * Check whether an order type is a trigger placement (stop / take profit).\n *\n * @param orderType - Order type to check.\n * @returns True when the type requires `OrderParams.triggerPrice`.\n */\nexport function isTriggerOrderType(\n  orderType: OrderType,\n): orderType is TriggerOrderType {\n  return (TRIGGER_ORDER_TYPES as readonly OrderType[]).includes(orderType);\n}\n\n/**\n * Check whether an order type executes as a limit order.\n *\n * Covers plain limit orders and the `*_limit` trigger types, both of which\n * require `OrderParams.price`.\n *\n * @param orderType - Order type to check.\n * @returns True when the order executes as a limit order.\n */\nexport function isLimitExecutionOrderType(orderType: OrderType): boolean {\n  return (LIMIT_EXECUTION_ORDER_TYPES as readonly OrderType[]).includes(\n    orderType,\n  );\n}\n\n/**\n * Get how an order executes, ignoring whether it is trigger-gated.\n *\n * This is also the coarse execution type that consumers predating trigger orders\n * understand (fee tiers, max order value, analytics).\n *\n * @param orderType - Order type to inspect.\n * @returns `'limit'` for limit and `*_limit` types, `'market'` otherwise.\n */\nexport function getTriggerExecution(orderType: OrderType): OrderExecution {\n  return isLimitExecutionOrderType(orderType) ? 'limit' : 'market';\n}\n\n/**\n * Get the direction a trigger order fires in.\n *\n * @param orderType - Trigger order type.\n * @returns `'stop'` for `stop_*`, `'take_profit'` for `take_profit_*`.\n */\nexport function getTriggerDirection(\n  orderType: TriggerOrderType,\n): TriggerDirection {\n  return orderType === 'stop_market' || orderType === 'stop_limit'\n    ? 'stop'\n    : 'take_profit';\n}\n\n/**\n * Recover which way a trigger fires from its price relative to the entry.\n *\n * Used when the exchange reports a trigger without naming its placement type:\n * a long takes profit above its entry and stops out below, a short the other\n * way round. Shared by both transports so they classify identically.\n *\n * @param params - Classification parameters\n * @param params.triggerPrice - Price at which the order activates\n * @param params.entryPrice - Entry price of the position it is attached to\n * @param params.positionSize - Signed position size; its sign gives the side\n * @returns The direction, or undefined when there is nothing to compare against\n */\nexport function classifyTriggerDirection(params: {\n  triggerPrice?: string;\n  entryPrice?: string;\n  positionSize: string;\n}): TriggerDirection | undefined {\n  const { triggerPrice, entryPrice, positionSize } = params;\n\n  const trigger = parseFloat(triggerPrice ?? '');\n  const entry = parseFloat(entryPrice ?? '');\n  const signedSize = parseFloat(positionSize || '0');\n\n  if (!Number.isFinite(trigger) || !Number.isFinite(entry) || entry <= 0) {\n    return undefined;\n  }\n\n  // A long takes profit above its entry and stops out below; a short is the\n  // mirror image. A trigger sitting exactly at entry is neither, so both sides\n  // fall to 'stop' — matching the legacy price fallback the scalar\n  // takeProfitPrice/stopLossPrice fields still use. Splitting that tie the\n  // other way would file the order under takeProfitOrders while the scalar\n  // still reported it as a stop.\n  const isLong = signedSize > 0;\n\n  if (isLong) {\n    return trigger > entry ? 'take_profit' : 'stop';\n  }\n  return trigger < entry ? 'take_profit' : 'stop';\n}\n\n/**\n * Project a normalized open order onto the position-state view of a trigger order.\n *\n * Returns undefined when the order is not a trigger, or when its direction can\n * be established neither from a named placement type nor from its price.\n *\n * @param params - Mapping parameters\n * @param params.order - Normalized open order\n * @param params.positionSize - Size of the position the trigger is attached to\n * @param params.entryPrice - Entry price, used to classify an unnamed trigger\n * @returns The position trigger order, or undefined\n */\nexport function buildPositionTriggerOrderFromOrder(params: {\n  order: Order;\n  positionSize: string;\n  entryPrice?: string;\n}): PositionTriggerOrder | undefined {\n  const { order, positionSize, entryPrice } = params;\n\n  if (!order.isTrigger) {\n    return undefined;\n  }\n\n  // HyperLiquid sometimes reports a bare 'Trigger', naming neither direction\n  // nor execution. The direction is still recoverable from the trigger price\n  // against the entry, and it is what decides which array the order belongs\n  // to — so an unnamed trigger is kept rather than dropped, with its execution\n  // mode left unstated. Without a position to compare against there is nothing\n  // to recover, and it is dropped.\n  const direction =\n    order.triggerOrderType === undefined\n      ? classifyTriggerDirection({\n          triggerPrice: order.triggerPrice ?? order.price,\n          entryPrice,\n          positionSize,\n        })\n      : getTriggerDirection(order.triggerOrderType);\n\n  if (!direction) {\n    return undefined;\n  }\n\n  const absolutePositionSize = Math.abs(parseFloat(positionSize || '0'));\n  const rawSize = Math.abs(parseFloat(order.size || '0'));\n\n  // A position-bound TP/SL covers whatever the position currently is. The\n  // exchange encodes that as size 0, but `adaptOrderFromSDK` has already\n  // resolved it against the position as it stood when the order was adapted,\n  // so the size carried here goes stale as soon as the position is resized.\n  // The flag is the durable statement of what the trigger covers; the number\n  // is not. Reading the number instead would report the old size, and would\n  // call the order partial whenever the position had since grown.\n  const isPositionBound = order.isPositionTpsl === true;\n  const size =\n    isPositionBound || rawSize === 0 ? absolutePositionSize : rawSize;\n\n  return {\n    orderId: order.orderId,\n    direction,\n    orderType: order.triggerOrderType,\n    triggerPrice: order.triggerPrice ?? order.price,\n    size: size.toString(),\n    isPartial:\n      !isPositionBound &&\n      rawSize > 0 &&\n      absolutePositionSize > 0 &&\n      rawSize < absolutePositionSize,\n    reduceOnly: Boolean(order.reduceOnly),\n  };\n}\n\n/**\n * Build a trigger order type from its two independent dimensions.\n *\n * @param params - Trigger dimensions.\n * @param params.direction - Whether the trigger is a stop or a take profit.\n * @param params.execution - How the order executes once triggered.\n * @returns The matching trigger order type.\n */\nexport function buildTriggerOrderType(params: {\n  direction: TriggerDirection;\n  execution: OrderExecution;\n}): TriggerOrderType {\n  const { direction, execution } = params;\n\n  if (direction === 'stop') {\n    return execution === 'limit' ? 'stop_limit' : 'stop_market';\n  }\n\n  return execution === 'limit' ? 'take_profit_limit' : 'take_profit_market';\n}\n\n/**\n * Map the controller's time in force onto the exchange's spelling.\n *\n * Shared by the two order-building paths so they cannot drift apart.\n *\n * @param timeInForce - Requested time in force; defaults to GTC.\n * @returns The SDK time-in-force value.\n */\nexport function toSDKTimeInForce(\n  timeInForce?: 'GTC' | 'IOC' | 'ALO',\n): 'Gtc' | 'Ioc' | 'Alo' {\n  switch (timeInForce) {\n    case 'IOC':\n      return 'Ioc';\n    case 'ALO':\n      return 'Alo';\n    default:\n      return 'Gtc';\n  }\n}\n\n/**\n * Hash the identity of a position's trigger orders for change detection.\n *\n * Streamed positions only re-emit when their hash changes, so this has to move\n * when a trigger is added, removed, repriced, resized, or retyped — otherwise\n * subscribers never receive the updated arrays.\n *\n * The placement type is part of the identity because a trigger can be modified\n * in place: switching a stop from market to limit execution keeps its order ID,\n * trigger price, and size, so nothing else here would move even though the\n * execution semantics subscribers rely on have changed.\n *\n * @param orders - Trigger orders attached to a position, if any.\n * @returns A stable string; `'0'` for both empty and absent.\n */\nexport function hashTriggerOrders(orders?: PositionTriggerOrder[]): string {\n  if (!orders || orders.length === 0) {\n    return '0';\n  }\n  return orders\n    .map(\n      (order) =>\n        `${order.orderId}:${order.direction}:${order.orderType ?? '?'}@${order.triggerPrice}x${order.size}${order.isPartial ? 'p' : ''}`,\n    )\n    .join(',');\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/perps-controller",
-  "version": "10.0.0-preview-a42e8d0d2",
+  "version": "10.0.0-preview-5a03e1b92",
   "description": "Controller for perpetual trading functionality in MetaMask",
   "keywords": [
     "Ethereum",
@@ -113,13 +113,13 @@
     "@metamask/account-tree-controller": "^7.5.5",
     "@metamask/authenticated-user-storage": "^3.0.1",
     "@metamask/auto-changelog": "^6.1.0",
-    "@metamask/geolocation-controller": "^0.1.3",
+    "@metamask/geolocation-controller": "^1.0.0",
     "@metamask/keyring-controller": "^27.1.0",
     "@metamask/keyring-internal-api": "^11.0.2",
-    "@metamask/network-controller": "^34.0.0",
+    "@metamask/network-controller": "^35.0.0",
     "@metamask/profile-sync-controller": "^28.3.0",
-    "@metamask/remote-feature-flag-controller": "^4.2.2",
-    "@metamask/transaction-controller": "^69.3.0",
+    "@metamask/remote-feature-flag-controller": "^5.0.0",
+    "@metamask/transaction-controller": "^69.4.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
     "@types/uuid": "^8.3.0",
@@ -129,7 +129,8 @@
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.3.3"
+    "typescript": "~5.3.3",
+    "viem": "^2.55.8"
   },
   "optionalDependencies": {
     "@myx-trade/sdk": "^0.1.265"