@metamask-previews/perps-controller 17.4.0-preview-be4d68b → 17.4.0-preview-4f493fb

package/dist/services/TradingService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TradingService.d.ts","sourceRoot":"","sources":["../../src/services/TradingService.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACV,aAAa,EAEb,WAAW,EACX,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,QAAQ,EACR,YAAY,EACZ,wBAAwB,EAExB,yBAAyB,EAE1B,MAAM,mBAAmB,CAAC;AAM3B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,yBAAyB,EAAE,yBAAyB,CAAC;CACtD,CAAC;AAYF;;;;;;;;;GASG;AACH,qBAAa,cAAc;;IAezB;;;;OAIG;IACH,YAAY,IAAI,EAAE,yBAAyB,EAE1C;IAED;;;;;OAKG;IACH,yBAAyB,CACvB,cAAc,EAAE,4BAA4B,GAC3C,IAAI,CAEN;IAyaD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,OAAO,EAAE;QACxB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,EAAE,cAAc,CAAC;QACxB,qBAAqB,EAAE,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACrD,GAAG,OAAO,CAAC,WAAW,CAAC,CA+NvB;IAotBD;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,eAAe,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA2IvB;IAED;;;;;;;;;;OAUG;IACG,WAAW,CAAC,OAAO,EAAE;QACzB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,cAAc,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA0H7B;IAED;;;;;;;;;;OAUG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,kBAAkB,CAAC;QAC3B,OAAO,EAAE,cAAc,CAAC;QACxB,eAAe,EAAE,CAAC,OAAO,EACvB,SAAS,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EACjC,QAAQ,EAAE,MAAM,EAAE,KACf,OAAO,CAAC,OAAO,CAAC,CAAC;KACvB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAqL9B;IAED;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,mBAAmB,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;QACxB,qBAAqB,EAAE,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SAChB,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACpD,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,WAAW,CAAC,CA+JvB;IAED;;;;;;;;;OASG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,oBAAoB,CAAC;QAC7B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA8LhC;IAED;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,EAAE;QAChC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,wBAAwB,CAAC;QACjC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA6MvB;IAED;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAmGhD;IAED;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,QAAQ,EAAE,QAAQ,CAAC;QACnB,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA+LvB;CACF"}
+{"version":3,"file":"TradingService.d.ts","sourceRoot":"","sources":["../../src/services/TradingService.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EACV,aAAa,EAEb,WAAW,EACX,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,QAAQ,EACR,YAAY,EACZ,wBAAwB,EAExB,yBAAyB,EAE1B,MAAM,mBAAmB,CAAC;AAM3B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,yBAAyB,EAAE,yBAAyB,CAAC;CACtD,CAAC;AAYF;;;;;;;;;GASG;AACH,qBAAa,cAAc;;IAezB;;;;OAIG;IACH,YAAY,IAAI,EAAE,yBAAyB,EAE1C;IAED;;;;;OAKG;IACH,yBAAyB,CACvB,cAAc,EAAE,4BAA4B,GAC3C,IAAI,CAEN;IA4dD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,OAAO,EAAE;QACxB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,EAAE,cAAc,CAAC;QACxB,qBAAqB,EAAE,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACrD,GAAG,OAAO,CAAC,WAAW,CAAC,CAgOvB;IA6tBD;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,eAAe,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA2IvB;IAED;;;;;;;;;;OAUG;IACG,WAAW,CAAC,OAAO,EAAE;QACzB,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,cAAc,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA0H7B;IAED;;;;;;;;;;OAUG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,kBAAkB,CAAC;QAC3B,OAAO,EAAE,cAAc,CAAC;QACxB,eAAe,EAAE,CAAC,OAAO,EACvB,SAAS,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EACjC,QAAQ,EAAE,MAAM,EAAE,KACf,OAAO,CAAC,OAAO,CAAC,CAAC;KACvB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAqL9B;IAED;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,OAAO,EAAE;QAC3B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,mBAAmB,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;QACxB,qBAAqB,EAAE,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SAChB,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACpD,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,WAAW,CAAC,CAgKvB;IAED;;;;;;;;;OASG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,oBAAoB,CAAC;QAC7B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA8LhC;IAED;;;;;;;;;OASG;IACG,kBAAkB,CAAC,OAAO,EAAE;QAChC,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,wBAAwB,CAAC;QACjC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA6MvB;IAED;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAmGhD;IAED;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,aAAa,CAAC;QACxB,QAAQ,EAAE,QAAQ,CAAC;QACnB,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG,OAAO,CAAC,WAAW,CAAC,CA+LvB;CACF"}

package/dist/services/TradingService.js

@@ -4,6 +4,8 @@ import { PERPS_EVENT_PROPERTY, PERPS_EVENT_VALUE, } from '../constants/eventName
 import { isTPSLOrder } from '../constants/orderTypes.js';
 import { PerpsMeasurementName } from '../constants/performanceMetrics.js';
 import { PERPS_CONSTANTS } from '../constants/perpsConfig.js';
+import { PerpsControllerError } from '../errors.js';
+import { PERPS_ERROR_CODES } from '../perpsErrorCodes.js';
 import { PerpsAnalyticsEvent, PerpsTraceNames, PerpsTraceOperations, } from '../types/index.js';
 import { ensureError } from '../utils/errorUtils.js';
 import { isLimitExecutionOrderType, SCALE_ORDER_COUNT, } from '../utils/orderTypes.js';
@@ -86,6 +88,43 @@ export class TradingService {
         }
         return properties;
     }
+    /**
+     * Build normalized slippage and failure properties without removing the
+     * existing raw error message used by current analytics dashboards.
+     *
+     * @param trackingData - Optional caller-provided slippage context.
+     * @param result - Provider result, when available.
+     * @param error - Thrown provider error, when available.
+     * @returns Slippage and normalized failure properties.
+     */
+    #buildSlippageProperties(trackingData, result, error) {
+        const properties = {};
+        if (trackingData?.maxSlippageBps !== undefined) {
+            properties[PERPS_EVENT_PROPERTY.MAX_SLIPPAGE_PCT] =
+                trackingData.maxSlippageBps / 100;
+        }
+        if (trackingData?.maxSlippageSource !== undefined) {
+            properties[PERPS_EVENT_PROPERTY.MAX_SLIPPAGE_SOURCE] =
+                trackingData.maxSlippageSource;
+        }
+        if (trackingData?.estimatedSlippageBps !== undefined) {
+            properties[PERPS_EVENT_PROPERTY.ESTIMATED_SLIPPAGE_PCT] =
+                trackingData.estimatedSlippageBps / 100;
+        }
+        const errorCode = result?.errorCode ??
+            (error instanceof PerpsControllerError ? error.errorCode : undefined);
+        const errorDetails = result?.errorDetails ??
+            (error instanceof PerpsControllerError ? error.errorDetails : undefined);
+        if (errorCode !== undefined) {
+            properties[PERPS_EVENT_PROPERTY.FAILURE_REASON] = errorCode;
+        }
+        if (errorDetails?.code === PERPS_ERROR_CODES.PRICE_MOVED &&
+            Number.isFinite(errorDetails.priceDeltaBps)) {
+            properties[PERPS_EVENT_PROPERTY.PRICE_DELTA_BPS] =
+                errorDetails.priceDeltaBps;
+        }
+        return properties;
+    }
     /**
      * Build properties that identify the submitted order intent.
      *
@@ -138,6 +177,7 @@ export class TradingService {
                 ? PERPS_EVENT_VALUE.DIRECTION.LONG
                 : PERPS_EVENT_VALUE.DIRECTION.SHORT,
             ...this.#buildTradeIntentProperties(params),
+            ...this.#buildSlippageProperties(params.trackingData, result, error),
             [PERPS_EVENT_PROPERTY.LEVERAGE]: parseFloat(String(params.leverage ?? 1)),
             [PERPS_EVENT_PROPERTY.ORDER_SIZE]: trackedOrderSize,
             [PERPS_EVENT_PROPERTY.COMPLETION_DURATION]: duration,
@@ -463,6 +503,7 @@ export class TradingService {
                     : PERPS_EVENT_VALUE.DIRECTION.SHORT,
                 ...this.#buildTradeIntentProperties(params),
                 [PERPS_EVENT_PROPERTY.LEVERAGE]: parseFloat(String(params.leverage ?? 1)),
+                ...this.#buildSlippageProperties(params.trackingData),
                 ...this.#buildAttributionProperties(params.trackingData),
             });
             // Observational threshold: when the provider round-trip exceeds
@@ -688,6 +729,7 @@ export class TradingService {
             [PERPS_EVENT_PROPERTY.DIRECTION]: metrics.direction,
             [PERPS_EVENT_PROPERTY.ORDER_TYPE]: metrics.orderType,
             [PERPS_EVENT_PROPERTY.ORDER_SIZE]: metrics.requestedSize,
+            [PERPS_EVENT_PROPERTY.CLOSE_TYPE]: metrics.closeType,
             [PERPS_EVENT_PROPERTY.OPEN_POSITION_SIZE]: Math.abs(parseFloat(position.size)),
             [PERPS_EVENT_PROPERTY.PERCENTAGE_CLOSED]: metrics.closePercentage,
             ...(position.unrealizedPnl && {
@@ -733,6 +775,7 @@ export class TradingService {
             ...(params.trackingData?.vipDiscount !== undefined && {
                 [PERPS_EVENT_PROPERTY.VIP_DISCOUNT]: params.trackingData.vipDiscount,
             }),
+            ...this.#buildSlippageProperties(params.trackingData, result, error instanceof Error ? error : undefined),
             // Effective leverage on close events
             ...(effectiveLeverage !== undefined && {
                 [PERPS_EVENT_PROPERTY.LEVERAGE]: effectiveLeverage,
@@ -751,7 +794,6 @@ export class TradingService {
         if (status === PERPS_EVENT_VALUE.STATUS.EXECUTED) {
             return {
                 ...baseProperties,
-                [PERPS_EVENT_PROPERTY.CLOSE_TYPE]: metrics.closeType,
                 ...(orderValue !== undefined && {
                     [PERPS_EVENT_PROPERTY.ORDER_VALUE]: orderValue,
                 }),
@@ -760,7 +802,9 @@ export class TradingService {
         // Add error for failures
         return {
             ...baseProperties,
-            ...(error && { [PERPS_EVENT_PROPERTY.ERROR_MESSAGE]: error }),
+            ...(error && {
+                [PERPS_EVENT_PROPERTY.ERROR_MESSAGE]: error instanceof Error ? error.message : error,
+            }),
             ...(orderValue !== undefined && {
                 [PERPS_EVENT_PROPERTY.ORDER_VALUE]: orderValue,
             }),
@@ -801,6 +845,7 @@ export class TradingService {
                 ...(errorMessage && {
                     [PERPS_EVENT_PROPERTY.ERROR_MESSAGE]: errorMessage,
                 }),
+                ...this.#buildSlippageProperties(params.trackingData, result, error),
                 ...this.#buildAttributionProperties(params.trackingData),
                 ...bulkActionProps,
             });
@@ -841,7 +886,7 @@ export class TradingService {
             : PERPS_EVENT_VALUE.STATUS.FAILED;
         const errorMessage = error?.message ?? result?.error;
         // Track main close event
-        const eventProperties = this.#buildCloseEventProperties(position, params, metrics, result, status, errorMessage);
+        const eventProperties = this.#buildCloseEventProperties(position, params, metrics, result, status, error ?? errorMessage);
         this.#deps.metrics.trackPerpsEvent(PerpsAnalyticsEvent.PositionCloseTransaction, {
             ...eventProperties,
             [PERPS_EVENT_PROPERTY.COMPLETION_DURATION]: duration,
@@ -1537,6 +1582,7 @@ export class TradingService {
             this.#trackSubmitted(PerpsAnalyticsEvent.PositionCloseTransaction, {
                 [PERPS_EVENT_PROPERTY.ASSET]: params.symbol,
                 [PERPS_EVENT_PROPERTY.ORDER_TYPE]: params.orderType ?? PERPS_EVENT_VALUE.ORDER_TYPE.MARKET,
+                ...this.#buildSlippageProperties(params.trackingData),
                 ...this.#buildAttributionProperties(params.trackingData),
                 ...(bulkActionId && {
                     [PERPS_EVENT_PROPERTY.BULK_ACTION_ID]: bulkActionId,