@metamask-previews/bridge-controller 66.1.1-preview-33dbba4f3 → 67.0.0-preview-a196307b6

package/dist/utils/metrics/types.d.mts

@@ -54,12 +54,12 @@ export type InputValues = {
 };
 export type QuoteWarning = 'low_return' | 'no_quotes' | 'insufficient_gas_balance' | 'insufficient_gas_for_selected_quote' | 'insufficient_balance' | 'price_impact' | 'tx_alert';
 /**
- * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called
+ * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called.
+ * This is the base type without the `location` property which is added to all events
+ * via the RequiredEventContextFromClient mapped type.
  */
-export type RequiredEventContextFromClient = {
-    [UnifiedSwapBridgeEventName.ButtonClicked]: {
-        location: MetaMetricsSwapsEventSource;
-    } & Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'>;
+type RequiredEventContextFromClientBase = {
+    [UnifiedSwapBridgeEventName.ButtonClicked]: Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'>;
     [UnifiedSwapBridgeEventName.PageViewed]: object;
     [UnifiedSwapBridgeEventName.InputChanged]: {
         input: 'token_source' | 'token_destination' | 'chain_source' | 'chain_destination' | 'slippage';
@@ -134,6 +134,7 @@ export type RequiredEventContextFromClient = {
     };
     [UnifiedSwapBridgeEventName.StatusValidationFailed]: {
         failures: string[];
+        refresh_count: number;
     };
     [UnifiedSwapBridgeEventName.PollingStatusUpdated]: TradeData & Pick<QuoteFetchData, 'price_impact'> & Omit<RequestMetadata, 'security_warnings'> & Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination' | 'chain_id_source' | 'chain_id_destination'> & {
         action_type: MetricsActionType;
@@ -141,6 +142,17 @@ export type RequiredEventContextFromClient = {
         retry_attempts: number;
     };
 };
+/**
+ * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called.
+ * This combines the event-specific properties from RequiredEventContextFromClientBase
+ * with an optional `location` property. When `location` is omitted, the controller
+ * falls back to the value stored via `setLocation()` (defaults to MainView).
+ */
+export type RequiredEventContextFromClient = {
+    [K in keyof RequiredEventContextFromClientBase]: RequiredEventContextFromClientBase[K] & {
+        location?: MetaMetricsSwapsEventSource;
+    };
+};
 /**
  * Properties that can be derived from the bridge controller state
  */
@@ -174,9 +186,7 @@ export type EventPropertiesFromControllerState = {
     [UnifiedSwapBridgeEventName.QuotesValidationFailed]: RequestParams & {
         refresh_count: number;
     };
-    [UnifiedSwapBridgeEventName.StatusValidationFailed]: RequestParams & {
-        refresh_count: number;
-    };
+    [UnifiedSwapBridgeEventName.StatusValidationFailed]: RequestParams;
     [UnifiedSwapBridgeEventName.PollingStatusUpdated]: null;
 };
 /**
@@ -185,5 +195,7 @@ export type EventPropertiesFromControllerState = {
  */
 export type CrossChainSwapsEventProperties<T extends UnifiedSwapBridgeEventName> = {
     action_type: MetricsActionType;
+    location: MetaMetricsSwapsEventSource;
 } | Pick<EventPropertiesFromControllerState, T>[T] | Pick<RequiredEventContextFromClient, T>[T];
+export {};
 //# sourceMappingURL=types.d.mts.map

package/dist/utils/metrics/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/utils/metrics/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,wBAAwB;AAElE,OAAO,KAAK,EACV,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,eAAe,EACf,aAAa,EACd,wBAAoB;AACrB,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,wBAAoB;AAE1D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,eAAe,EAAE,WAAW,CAAC;IAC7B,oBAAoB,EAAE,WAAW,GAAG,IAAI,CAAC;IACzC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,oBAAoB,EAAE,aAAa,CAAC;IACpC,yBAAyB,EAAE,aAAa,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,eAAe,CAAC;IAC3B,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,mBAAmB,CAAC,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;IACrC,4BAA4B,EAAE,MAAM,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,2BAA2B,CAAC,EAAE,WAAW,CAAC;IAC1C,oBAAoB,CAAC,EAAE,WAAW,CAAC;IACnC,kBAAkB,CAAC,EAAE,WAAW,CAAC;IACjC,uBAAuB,CAAC,EAAE,WAAW,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,SAAS,GACjB,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,UAAU,CAAC;AAEf,MAAM,MAAM,WAAW,GAAG;IACxB,YAAY,EAAE,aAAa,CAAC;IAC5B,iBAAiB,EAAE,aAAa,CAAC;IACjC,YAAY,EAAE,WAAW,CAAC;IAC1B,iBAAiB,EAAE,WAAW,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,YAAY,GACZ,WAAW,GACX,0BAA0B,GAC1B,qCAAqC,GACrC,sBAAsB,GACtB,cAAc,GACd,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE;QAC1C,QAAQ,EAAE,2BAA2B,CAAC;KACvC,GAAG,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;IAE5E,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAChD,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE;QACzC,KAAK,EACD,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,UAAU,CAAC;QACf,WAAW,EAAE,WAAW,CAAC,MAAM,WAAW,CAAC,CAAC;KAC7C,CAAC;IACF,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,EAAE;QAC3D,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;QACpE,oBAAoB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;QAC5D,yBAAyB,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;QACtE,eAAe,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;QAClD,oBAAoB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;KAC7D,GAAG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAC/C,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,eAAe,EACf,aAAa,GAAG,mBAAmB,CACpC,GAAG;QACF,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;KACrE,CAAC;IACF,CAAC,0BAA0B,CAAC,cAAc,CAAC,EAAE,SAAS,GAAG;QACvD,QAAQ,EAAE,YAAY,EAAE,CAAC;QACzB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,YAAY,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;QAC7C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;QACzC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,IAAI,CAC5C,eAAe,EACf,aAAa,CACd,GAAG;QACF,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;KACrE,GAAG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAE/C,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,SAAS,GAC/C,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,IAAI,CACF,aAAa,EACX,qBAAqB,GACrB,0BAA0B,GAC1B,iBAAiB,GACjB,sBAAsB,CACzB,GAAG;QACF,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACJ,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,SAAS,GAC/C,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,YAAY,GACZ,aAAa,GAAG;QACd,mBAAmB,EAAE,MAAM,CAAC;QAC5B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,wBAAwB,EAAE,MAAM,CAAC;QACjC,wBAAwB,EAAE,MAAM,CAAC;QACjC,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACJ,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAC/B,gCAAgC;IAClC,CAAC,SAAS,GACN,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CACF,eAAe,EACf,aAAa,GAAG,mBAAmB,GAAG,oBAAoB,CAC3D,GACD,IAAI,CACF,aAAa,EACb,qBAAqB,GAAG,0BAA0B,CACnD,GAAG;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,GAChC,CAAC,aAAa,GACZ,eAAe,GACf,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,YAAY,GACZ,SAAS,GAAG;QACV,mBAAmB,EAAE,MAAM,CAAC;QAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC,CAAC;IAET,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,SAAS,EACT,cAAc,CACf,GACC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,0BAA0B,CAAC,GAAG;QACxE,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;QAC5C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACJ,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,SAAS,EACT,cAAc,CACf,GACC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,0BAA0B,CAAC,GAAG;QACxE,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;QAC5C,UAAU,EAAE,SAAS,CAAC;QACtB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACJ,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,SAAS,GAAG;QACtD,aAAa,EAAE,OAAO,CAAC;QACvB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,YAAY,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;QAC7C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACF,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EAAE;QACtD,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE;QACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE;QACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,EAAE,SAAS,GAC1D,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,IAAI,CACF,aAAa,EACX,qBAAqB,GACrB,0BAA0B,GAC1B,iBAAiB,GACjB,sBAAsB,CACzB,GAAG;QACF,WAAW,EAAE,iBAAiB,CAAC;QAC/B,cAAc,EAAE,aAAa,CAAC;QAC9B,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;CACL,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC1D,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IACvD,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE;QACzC,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,EAAE,aAAa,CAAC;IAC3E,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GAAG;QAChB,oBAAoB,EAAE,OAAO,CAAC;KAC/B,CAAC;IACJ,CAAC,0BAA0B,CAAC,cAAc,CAAC,EAAE,aAAa,GACxD,eAAe,GACf,cAAc,GACd,SAAS,GAAG;QACV,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACJ,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,aAAa,GACrD,eAAe,GAAG;QAChB,oBAAoB,EAAE,OAAO,CAAC;QAC9B,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACJ,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC7C,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC7C,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,aAAa,GAChD,eAAe,GACf,YAAY,GACZ,SAAS,GACT,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GAAG;QACrC,mBAAmB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACJ,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GACf,SAAS,GACT,cAAc,CAAC;IACjB,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GACf,SAAS,GACT,cAAc,CAAC;IACjB,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,aAAa,GACvD,eAAe,GACf,cAAc,GACd,SAAS,CAAC;IACZ,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EAAE,IAAI,CAAC;IAC7D,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE,aAAa,GAAG;QACnE,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE,aAAa,GAAG;QACnE,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,CACxC,CAAC,SAAS,0BAA0B,IAElC;IACE,WAAW,EAAE,iBAAiB,CAAC;CAChC,GACD,IAAI,CAAC,kCAAkC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAC9C,IAAI,CAAC,8BAA8B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/utils/metrics/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,wBAAwB;AAElE,OAAO,KAAK,EACV,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,eAAe,EACf,aAAa,EACd,wBAAoB;AACrB,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,wBAAoB;AAE1D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,eAAe,EAAE,WAAW,CAAC;IAC7B,oBAAoB,EAAE,WAAW,GAAG,IAAI,CAAC;IACzC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,oBAAoB,EAAE,aAAa,CAAC;IACpC,yBAAyB,EAAE,aAAa,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,eAAe,CAAC;IAC3B,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,mBAAmB,CAAC,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;IACrC,4BAA4B,EAAE,MAAM,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,2BAA2B,CAAC,EAAE,WAAW,CAAC;IAC1C,oBAAoB,CAAC,EAAE,WAAW,CAAC;IACnC,kBAAkB,CAAC,EAAE,WAAW,CAAC;IACjC,uBAAuB,CAAC,EAAE,WAAW,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,SAAS,GACjB,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,UAAU,CAAC;AAEf,MAAM,MAAM,WAAW,GAAG;IACxB,YAAY,EAAE,aAAa,CAAC;IAC5B,iBAAiB,EAAE,aAAa,CAAC;IACjC,YAAY,EAAE,WAAW,CAAC;IAC1B,iBAAiB,EAAE,WAAW,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,YAAY,GACZ,WAAW,GACX,0BAA0B,GAC1B,qCAAqC,GACrC,sBAAsB,GACtB,cAAc,GACd,UAAU,CAAC;AAEf;;;;GAIG;AACH,KAAK,kCAAkC,GAAG;IACxC,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,IAAI,CAC9C,aAAa,EACb,qBAAqB,GAAG,0BAA0B,CACnD,CAAC;IAEF,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAChD,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE;QACzC,KAAK,EACD,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,mBAAmB,GACnB,UAAU,CAAC;QACf,WAAW,EAAE,WAAW,CAAC,MAAM,WAAW,CAAC,CAAC;KAC7C,CAAC;IACF,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,EAAE;QAC3D,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;QACpE,oBAAoB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;QAC5D,yBAAyB,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;QACtE,eAAe,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;QAClD,oBAAoB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;KAC7D,GAAG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAC/C,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,eAAe,EACf,aAAa,GAAG,mBAAmB,CACpC,GAAG;QACF,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;KACrE,CAAC;IACF,CAAC,0BAA0B,CAAC,cAAc,CAAC,EAAE,SAAS,GAAG;QACvD,QAAQ,EAAE,YAAY,EAAE,CAAC;QACzB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,YAAY,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;QAC7C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;QACzC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,IAAI,CAC5C,eAAe,EACf,aAAa,CACd,GAAG;QACF,mBAAmB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC1D,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;KACrE,GAAG,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;IAE/C,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,SAAS,GAC/C,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,IAAI,CACF,aAAa,EACX,qBAAqB,GACrB,0BAA0B,GAC1B,iBAAiB,GACjB,sBAAsB,CACzB,GAAG;QACF,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACJ,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,SAAS,GAC/C,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,YAAY,GACZ,aAAa,GAAG;QACd,mBAAmB,EAAE,MAAM,CAAC;QAC5B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,wBAAwB,EAAE,MAAM,CAAC;QACjC,wBAAwB,EAAE,MAAM,CAAC;QACjC,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACJ,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAC/B,gCAAgC;IAClC,CAAC,SAAS,GACN,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CACF,eAAe,EACf,aAAa,GAAG,mBAAmB,GAAG,oBAAoB,CAC3D,GACD,IAAI,CACF,aAAa,EACb,qBAAqB,GAAG,0BAA0B,CACnD,GAAG;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,GAChC,CAAC,aAAa,GACZ,eAAe,GACf,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,YAAY,GACZ,SAAS,GAAG;QACV,mBAAmB,EAAE,MAAM,CAAC;QAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC,CAAC;IAET,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,SAAS,EACT,cAAc,CACf,GACC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,0BAA0B,CAAC,GAAG;QACxE,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;QAC5C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACJ,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,IAAI,CAChD,SAAS,EACT,cAAc,CACf,GACC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,0BAA0B,CAAC,GAAG;QACxE,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;QAC5C,UAAU,EAAE,SAAS,CAAC;QACtB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACJ,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,SAAS,GAAG;QACtD,aAAa,EAAE,OAAO,CAAC;QACvB,mBAAmB,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;QAC3D,YAAY,EAAE,cAAc,CAAC,cAAc,CAAC,CAAC;QAC7C,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;KAC1C,CAAC;IACF,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EAAE;QACtD,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE;QACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE;QACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,EAAE,SAAS,GAC1D,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GACpC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAC1C,IAAI,CACF,aAAa,EACX,qBAAqB,GACrB,0BAA0B,GAC1B,iBAAiB,GACjB,sBAAsB,CACzB,GAAG;QACF,WAAW,EAAE,iBAAiB,CAAC;QAC/B,cAAc,EAAE,aAAa,CAAC;QAC9B,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;CACL,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG;KAC1C,CAAC,IAAI,MAAM,kCAAkC,GAAG,kCAAkC,CAAC,CAAC,CAAC,GAAG;QACvF,QAAQ,CAAC,EAAE,2BAA2B,CAAC;KACxC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC1D,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IACvD,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE;QACzC,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,CAAC,0BAA0B,CAAC,8BAA8B,CAAC,EAAE,aAAa,CAAC;IAC3E,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GAAG;QAChB,oBAAoB,EAAE,OAAO,CAAC;KAC/B,CAAC;IACJ,CAAC,0BAA0B,CAAC,cAAc,CAAC,EAAE,aAAa,GACxD,eAAe,GACf,cAAc,GACd,SAAS,GAAG;QACV,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACJ,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,aAAa,GACrD,eAAe,GAAG;QAChB,oBAAoB,EAAE,OAAO,CAAC;QAC9B,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACJ,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC7C,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC7C,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,aAAa,GAChD,eAAe,GACf,YAAY,GACZ,SAAS,GACT,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,GAAG;QACrC,mBAAmB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACJ,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GACf,SAAS,GACT,cAAc,CAAC;IACjB,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,aAAa,GACzD,eAAe,GACf,SAAS,GACT,cAAc,CAAC;IACjB,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,aAAa,GACvD,eAAe,GACf,cAAc,GACd,SAAS,CAAC;IACZ,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EAAE,IAAI,CAAC;IAC7D,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE,aAAa,GAAG;QACnE,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,CAAC,0BAA0B,CAAC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IACnE,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,CACxC,CAAC,SAAS,0BAA0B,IAElC;IACE,WAAW,EAAE,iBAAiB,CAAC;IAC/B,QAAQ,EAAE,2BAA2B,CAAC;CACvC,GACD,IAAI,CAAC,kCAAkC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAC9C,IAAI,CAAC,8BAA8B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/utils/metrics/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../src/utils/metrics/types.ts"],"names":[],"mappings":"","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport type { CaipAssetType, CaipChainId } from '@metamask/utils';\n\nimport type {\n  UnifiedSwapBridgeEventName,\n  MetaMetricsSwapsEventSource,\n  MetricsActionType,\n  MetricsSwapType,\n  PollingStatus,\n} from './constants';\nimport type { SortOrder, StatusTypes } from '../../types';\n\n/**\n * These properties map to properties required by the segment-schema. For example: https://github.com/Consensys/segment-schema/blob/main/libraries/properties/cross-chain-swaps-action.yaml\n */\nexport type RequestParams = {\n  chain_id_source: CaipChainId;\n  chain_id_destination: CaipChainId | null;\n  token_symbol_source: string;\n  token_symbol_destination: string | null;\n  token_address_source: CaipAssetType;\n  token_address_destination: CaipAssetType | null;\n};\n\nexport type RequestMetadata = {\n  slippage_limit?: number; // undefined === auto\n  custom_slippage: boolean;\n  usd_amount_source: number; // Use quoteResponse when available\n  stx_enabled: boolean;\n  is_hardware_wallet: boolean;\n  swap_type: MetricsSwapType;\n  security_warnings: string[];\n};\n\nexport type QuoteFetchData = {\n  can_submit: boolean;\n  best_quote_provider?: `${string}_${string}`;\n  quotes_count: number;\n  quotes_list: `${string}_${string}`[];\n  initial_load_time_all_quotes: number;\n  price_impact: number;\n  has_gas_included_quote: boolean;\n};\n\nexport type TradeData = {\n  usd_quoted_gas: number;\n  gas_included: boolean;\n  gas_included_7702: boolean;\n  quoted_time_minutes: number;\n  usd_quoted_return: number;\n  provider: `${string}_${string}`;\n};\n\nexport type TxStatusData = {\n  allowance_reset_transaction?: StatusTypes;\n  approval_transaction?: StatusTypes;\n  source_transaction?: StatusTypes;\n  destination_transaction?: StatusTypes;\n};\n\nexport type InputKeys =\n  | 'token_source'\n  | 'token_destination'\n  | 'chain_source'\n  | 'chain_destination'\n  | 'slippage';\n\nexport type InputValues = {\n  token_source: CaipAssetType;\n  token_destination: CaipAssetType;\n  chain_source: CaipChainId;\n  chain_destination: CaipChainId;\n  slippage: number;\n};\n\nexport type QuoteWarning =\n  | 'low_return'\n  | 'no_quotes'\n  | 'insufficient_gas_balance'\n  | 'insufficient_gas_for_selected_quote'\n  | 'insufficient_balance'\n  | 'price_impact'\n  | 'tx_alert';\n\n/**\n * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called\n */\nexport type RequiredEventContextFromClient = {\n  [UnifiedSwapBridgeEventName.ButtonClicked]: {\n    location: MetaMetricsSwapsEventSource;\n  } & Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'>;\n  // When type is object, the payload can be anything\n  [UnifiedSwapBridgeEventName.PageViewed]: object;\n  [UnifiedSwapBridgeEventName.InputChanged]: {\n    input:\n      | 'token_source'\n      | 'token_destination'\n      | 'chain_source'\n      | 'chain_destination'\n      | 'slippage';\n    input_value: InputValues[keyof InputValues];\n  };\n  [UnifiedSwapBridgeEventName.InputSourceDestinationSwitched]: {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n    token_address_source: RequestParams['token_address_source'];\n    token_address_destination: RequestParams['token_address_destination'];\n    chain_id_source: RequestParams['chain_id_source'];\n    chain_id_destination: RequestParams['chain_id_destination'];\n  } & Pick<RequestMetadata, 'security_warnings'>;\n  [UnifiedSwapBridgeEventName.QuotesRequested]: Pick<\n    RequestMetadata,\n    'stx_enabled' | 'usd_amount_source'\n  > & {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n  };\n  [UnifiedSwapBridgeEventName.QuotesReceived]: TradeData & {\n    warnings: QuoteWarning[];\n    best_quote_provider: QuoteFetchData['best_quote_provider'];\n    price_impact: QuoteFetchData['price_impact'];\n    can_submit: QuoteFetchData['can_submit'];\n    usd_balance_source?: number;\n  };\n  [UnifiedSwapBridgeEventName.QuotesError]: Pick<\n    RequestMetadata,\n    'stx_enabled'\n  > & {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n  } & Pick<RequestMetadata, 'security_warnings'>;\n  // Emitted by BridgeStatusController\n  [UnifiedSwapBridgeEventName.Submitted]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    Pick<\n      RequestParams,\n      | 'token_symbol_source'\n      | 'token_symbol_destination'\n      | 'chain_id_source'\n      | 'chain_id_destination'\n    > & {\n      action_type: MetricsActionType;\n    };\n  [UnifiedSwapBridgeEventName.Completed]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    TxStatusData &\n    RequestParams & {\n      actual_time_minutes: number;\n      usd_actual_return: number;\n      usd_actual_gas: number;\n      quote_vs_execution_ratio: number;\n      quoted_vs_used_gas_ratio: number;\n      action_type: MetricsActionType;\n    };\n  [UnifiedSwapBridgeEventName.Failed]:\n    | // Tx failed before confirmation\n    (TradeData &\n        Pick<QuoteFetchData, 'price_impact'> &\n        Pick<\n          RequestMetadata,\n          'stx_enabled' | 'usd_amount_source' | 'is_hardware_wallet'\n        > &\n        Pick<\n          RequestParams,\n          'token_symbol_source' | 'token_symbol_destination'\n        > & { error_message: string }) // Tx failed after confirmation\n    | (RequestParams &\n        RequestMetadata &\n        Pick<QuoteFetchData, 'price_impact'> &\n        TxStatusData &\n        TradeData & {\n          actual_time_minutes: number;\n          error_message?: string;\n        });\n  // Emitted by clients\n  [UnifiedSwapBridgeEventName.AllQuotesOpened]: Pick<\n    TradeData,\n    'gas_included'\n  > &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'> & {\n      stx_enabled: RequestMetadata['stx_enabled'];\n      can_submit: QuoteFetchData['can_submit'];\n    };\n  [UnifiedSwapBridgeEventName.AllQuotesSorted]: Pick<\n    TradeData,\n    'gas_included'\n  > &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'> & {\n      stx_enabled: RequestMetadata['stx_enabled'];\n      sort_order: SortOrder;\n      best_quote_provider: QuoteFetchData['best_quote_provider'];\n      can_submit: QuoteFetchData['can_submit'];\n    };\n  [UnifiedSwapBridgeEventName.QuoteSelected]: TradeData & {\n    is_best_quote: boolean;\n    best_quote_provider: QuoteFetchData['best_quote_provider'];\n    price_impact: QuoteFetchData['price_impact'];\n    can_submit: QuoteFetchData['can_submit'];\n  };\n  [UnifiedSwapBridgeEventName.AssetDetailTooltipClicked]: {\n    token_name: string;\n    token_symbol: string;\n    token_contract: string;\n    chain_name: string;\n    chain_id: string;\n  };\n  [UnifiedSwapBridgeEventName.QuotesValidationFailed]: {\n    failures: string[];\n  };\n  [UnifiedSwapBridgeEventName.StatusValidationFailed]: {\n    failures: string[];\n  };\n  [UnifiedSwapBridgeEventName.PollingStatusUpdated]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    Pick<\n      RequestParams,\n      | 'token_symbol_source'\n      | 'token_symbol_destination'\n      | 'chain_id_source'\n      | 'chain_id_destination'\n    > & {\n      action_type: MetricsActionType;\n      polling_status: PollingStatus;\n      retry_attempts: number;\n    };\n};\n\n/**\n * Properties that can be derived from the bridge controller state\n */\nexport type EventPropertiesFromControllerState = {\n  [UnifiedSwapBridgeEventName.ButtonClicked]: RequestParams;\n  [UnifiedSwapBridgeEventName.PageViewed]: RequestParams;\n  [UnifiedSwapBridgeEventName.InputChanged]: {\n    input: InputKeys;\n    input_value: string;\n  };\n  [UnifiedSwapBridgeEventName.InputSourceDestinationSwitched]: RequestParams;\n  [UnifiedSwapBridgeEventName.QuotesRequested]: RequestParams &\n    RequestMetadata & {\n      has_sufficient_funds: boolean;\n    };\n  [UnifiedSwapBridgeEventName.QuotesReceived]: RequestParams &\n    RequestMetadata &\n    QuoteFetchData &\n    TradeData & {\n      refresh_count: number; // starts from 0\n    };\n  [UnifiedSwapBridgeEventName.QuotesError]: RequestParams &\n    RequestMetadata & {\n      has_sufficient_funds: boolean;\n      error_message: string;\n    };\n  [UnifiedSwapBridgeEventName.Submitted]: null;\n  [UnifiedSwapBridgeEventName.Completed]: null;\n  [UnifiedSwapBridgeEventName.Failed]: RequestParams &\n    RequestMetadata &\n    TxStatusData &\n    TradeData &\n    Pick<QuoteFetchData, 'price_impact'> & {\n      actual_time_minutes: number;\n    };\n  [UnifiedSwapBridgeEventName.AllQuotesOpened]: RequestParams &\n    RequestMetadata &\n    TradeData &\n    QuoteFetchData;\n  [UnifiedSwapBridgeEventName.AllQuotesSorted]: RequestParams &\n    RequestMetadata &\n    TradeData &\n    QuoteFetchData;\n  [UnifiedSwapBridgeEventName.QuoteSelected]: RequestParams &\n    RequestMetadata &\n    QuoteFetchData &\n    TradeData;\n  [UnifiedSwapBridgeEventName.AssetDetailTooltipClicked]: null;\n  [UnifiedSwapBridgeEventName.QuotesValidationFailed]: RequestParams & {\n    refresh_count: number;\n  };\n  [UnifiedSwapBridgeEventName.StatusValidationFailed]: RequestParams & {\n    refresh_count: number;\n  };\n  [UnifiedSwapBridgeEventName.PollingStatusUpdated]: null;\n};\n\n/**\n * trackUnifiedSwapBridgeEvent payload properties consist of required properties from the client\n * and properties from the bridge controller\n */\nexport type CrossChainSwapsEventProperties<\n  T extends UnifiedSwapBridgeEventName,\n> =\n  | {\n      action_type: MetricsActionType;\n    }\n  | Pick<EventPropertiesFromControllerState, T>[T]\n  | Pick<RequiredEventContextFromClient, T>[T];\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../src/utils/metrics/types.ts"],"names":[],"mappings":"","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport type { CaipAssetType, CaipChainId } from '@metamask/utils';\n\nimport type {\n  UnifiedSwapBridgeEventName,\n  MetaMetricsSwapsEventSource,\n  MetricsActionType,\n  MetricsSwapType,\n  PollingStatus,\n} from './constants';\nimport type { SortOrder, StatusTypes } from '../../types';\n\n/**\n * These properties map to properties required by the segment-schema. For example: https://github.com/Consensys/segment-schema/blob/main/libraries/properties/cross-chain-swaps-action.yaml\n */\nexport type RequestParams = {\n  chain_id_source: CaipChainId;\n  chain_id_destination: CaipChainId | null;\n  token_symbol_source: string;\n  token_symbol_destination: string | null;\n  token_address_source: CaipAssetType;\n  token_address_destination: CaipAssetType | null;\n};\n\nexport type RequestMetadata = {\n  slippage_limit?: number; // undefined === auto\n  custom_slippage: boolean;\n  usd_amount_source: number; // Use quoteResponse when available\n  stx_enabled: boolean;\n  is_hardware_wallet: boolean;\n  swap_type: MetricsSwapType;\n  security_warnings: string[];\n};\n\nexport type QuoteFetchData = {\n  can_submit: boolean;\n  best_quote_provider?: `${string}_${string}`;\n  quotes_count: number;\n  quotes_list: `${string}_${string}`[];\n  initial_load_time_all_quotes: number;\n  price_impact: number;\n  has_gas_included_quote: boolean;\n};\n\nexport type TradeData = {\n  usd_quoted_gas: number;\n  gas_included: boolean;\n  gas_included_7702: boolean;\n  quoted_time_minutes: number;\n  usd_quoted_return: number;\n  provider: `${string}_${string}`;\n};\n\nexport type TxStatusData = {\n  allowance_reset_transaction?: StatusTypes;\n  approval_transaction?: StatusTypes;\n  source_transaction?: StatusTypes;\n  destination_transaction?: StatusTypes;\n};\n\nexport type InputKeys =\n  | 'token_source'\n  | 'token_destination'\n  | 'chain_source'\n  | 'chain_destination'\n  | 'slippage';\n\nexport type InputValues = {\n  token_source: CaipAssetType;\n  token_destination: CaipAssetType;\n  chain_source: CaipChainId;\n  chain_destination: CaipChainId;\n  slippage: number;\n};\n\nexport type QuoteWarning =\n  | 'low_return'\n  | 'no_quotes'\n  | 'insufficient_gas_balance'\n  | 'insufficient_gas_for_selected_quote'\n  | 'insufficient_balance'\n  | 'price_impact'\n  | 'tx_alert';\n\n/**\n * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called.\n * This is the base type without the `location` property which is added to all events\n * via the RequiredEventContextFromClient mapped type.\n */\ntype RequiredEventContextFromClientBase = {\n  [UnifiedSwapBridgeEventName.ButtonClicked]: Pick<\n    RequestParams,\n    'token_symbol_source' | 'token_symbol_destination'\n  >;\n  // When type is object, the payload can be anything\n  [UnifiedSwapBridgeEventName.PageViewed]: object;\n  [UnifiedSwapBridgeEventName.InputChanged]: {\n    input:\n      | 'token_source'\n      | 'token_destination'\n      | 'chain_source'\n      | 'chain_destination'\n      | 'slippage';\n    input_value: InputValues[keyof InputValues];\n  };\n  [UnifiedSwapBridgeEventName.InputSourceDestinationSwitched]: {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n    token_address_source: RequestParams['token_address_source'];\n    token_address_destination: RequestParams['token_address_destination'];\n    chain_id_source: RequestParams['chain_id_source'];\n    chain_id_destination: RequestParams['chain_id_destination'];\n  } & Pick<RequestMetadata, 'security_warnings'>;\n  [UnifiedSwapBridgeEventName.QuotesRequested]: Pick<\n    RequestMetadata,\n    'stx_enabled' | 'usd_amount_source'\n  > & {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n  };\n  [UnifiedSwapBridgeEventName.QuotesReceived]: TradeData & {\n    warnings: QuoteWarning[];\n    best_quote_provider: QuoteFetchData['best_quote_provider'];\n    price_impact: QuoteFetchData['price_impact'];\n    can_submit: QuoteFetchData['can_submit'];\n    usd_balance_source?: number;\n  };\n  [UnifiedSwapBridgeEventName.QuotesError]: Pick<\n    RequestMetadata,\n    'stx_enabled'\n  > & {\n    token_symbol_source: RequestParams['token_symbol_source'];\n    token_symbol_destination: RequestParams['token_symbol_destination'];\n  } & Pick<RequestMetadata, 'security_warnings'>;\n  // Emitted by BridgeStatusController\n  [UnifiedSwapBridgeEventName.Submitted]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    Pick<\n      RequestParams,\n      | 'token_symbol_source'\n      | 'token_symbol_destination'\n      | 'chain_id_source'\n      | 'chain_id_destination'\n    > & {\n      action_type: MetricsActionType;\n    };\n  [UnifiedSwapBridgeEventName.Completed]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    TxStatusData &\n    RequestParams & {\n      actual_time_minutes: number;\n      usd_actual_return: number;\n      usd_actual_gas: number;\n      quote_vs_execution_ratio: number;\n      quoted_vs_used_gas_ratio: number;\n      action_type: MetricsActionType;\n    };\n  [UnifiedSwapBridgeEventName.Failed]:\n    | // Tx failed before confirmation\n    (TradeData &\n        Pick<QuoteFetchData, 'price_impact'> &\n        Pick<\n          RequestMetadata,\n          'stx_enabled' | 'usd_amount_source' | 'is_hardware_wallet'\n        > &\n        Pick<\n          RequestParams,\n          'token_symbol_source' | 'token_symbol_destination'\n        > & { error_message: string }) // Tx failed after confirmation\n    | (RequestParams &\n        RequestMetadata &\n        Pick<QuoteFetchData, 'price_impact'> &\n        TxStatusData &\n        TradeData & {\n          actual_time_minutes: number;\n          error_message?: string;\n        });\n  // Emitted by clients\n  [UnifiedSwapBridgeEventName.AllQuotesOpened]: Pick<\n    TradeData,\n    'gas_included'\n  > &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'> & {\n      stx_enabled: RequestMetadata['stx_enabled'];\n      can_submit: QuoteFetchData['can_submit'];\n    };\n  [UnifiedSwapBridgeEventName.AllQuotesSorted]: Pick<\n    TradeData,\n    'gas_included'\n  > &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Pick<RequestParams, 'token_symbol_source' | 'token_symbol_destination'> & {\n      stx_enabled: RequestMetadata['stx_enabled'];\n      sort_order: SortOrder;\n      best_quote_provider: QuoteFetchData['best_quote_provider'];\n      can_submit: QuoteFetchData['can_submit'];\n    };\n  [UnifiedSwapBridgeEventName.QuoteSelected]: TradeData & {\n    is_best_quote: boolean;\n    best_quote_provider: QuoteFetchData['best_quote_provider'];\n    price_impact: QuoteFetchData['price_impact'];\n    can_submit: QuoteFetchData['can_submit'];\n  };\n  [UnifiedSwapBridgeEventName.AssetDetailTooltipClicked]: {\n    token_name: string;\n    token_symbol: string;\n    token_contract: string;\n    chain_name: string;\n    chain_id: string;\n  };\n  [UnifiedSwapBridgeEventName.QuotesValidationFailed]: {\n    failures: string[];\n  };\n  [UnifiedSwapBridgeEventName.StatusValidationFailed]: {\n    failures: string[];\n    refresh_count: number;\n  };\n  [UnifiedSwapBridgeEventName.PollingStatusUpdated]: TradeData &\n    Pick<QuoteFetchData, 'price_impact'> &\n    Omit<RequestMetadata, 'security_warnings'> &\n    Pick<\n      RequestParams,\n      | 'token_symbol_source'\n      | 'token_symbol_destination'\n      | 'chain_id_source'\n      | 'chain_id_destination'\n    > & {\n      action_type: MetricsActionType;\n      polling_status: PollingStatus;\n      retry_attempts: number;\n    };\n};\n\n/**\n * Properties that are required to be provided when trackUnifiedSwapBridgeEvent is called.\n * This combines the event-specific properties from RequiredEventContextFromClientBase\n * with an optional `location` property. When `location` is omitted, the controller\n * falls back to the value stored via `setLocation()` (defaults to MainView).\n */\nexport type RequiredEventContextFromClient = {\n  [K in keyof RequiredEventContextFromClientBase]: RequiredEventContextFromClientBase[K] & {\n    location?: MetaMetricsSwapsEventSource;\n  };\n};\n\n/**\n * Properties that can be derived from the bridge controller state\n */\nexport type EventPropertiesFromControllerState = {\n  [UnifiedSwapBridgeEventName.ButtonClicked]: RequestParams;\n  [UnifiedSwapBridgeEventName.PageViewed]: RequestParams;\n  [UnifiedSwapBridgeEventName.InputChanged]: {\n    input: InputKeys;\n    input_value: string;\n  };\n  [UnifiedSwapBridgeEventName.InputSourceDestinationSwitched]: RequestParams;\n  [UnifiedSwapBridgeEventName.QuotesRequested]: RequestParams &\n    RequestMetadata & {\n      has_sufficient_funds: boolean;\n    };\n  [UnifiedSwapBridgeEventName.QuotesReceived]: RequestParams &\n    RequestMetadata &\n    QuoteFetchData &\n    TradeData & {\n      refresh_count: number; // starts from 0\n    };\n  [UnifiedSwapBridgeEventName.QuotesError]: RequestParams &\n    RequestMetadata & {\n      has_sufficient_funds: boolean;\n      error_message: string;\n    };\n  [UnifiedSwapBridgeEventName.Submitted]: null;\n  [UnifiedSwapBridgeEventName.Completed]: null;\n  [UnifiedSwapBridgeEventName.Failed]: RequestParams &\n    RequestMetadata &\n    TxStatusData &\n    TradeData &\n    Pick<QuoteFetchData, 'price_impact'> & {\n      actual_time_minutes: number;\n    };\n  [UnifiedSwapBridgeEventName.AllQuotesOpened]: RequestParams &\n    RequestMetadata &\n    TradeData &\n    QuoteFetchData;\n  [UnifiedSwapBridgeEventName.AllQuotesSorted]: RequestParams &\n    RequestMetadata &\n    TradeData &\n    QuoteFetchData;\n  [UnifiedSwapBridgeEventName.QuoteSelected]: RequestParams &\n    RequestMetadata &\n    QuoteFetchData &\n    TradeData;\n  [UnifiedSwapBridgeEventName.AssetDetailTooltipClicked]: null;\n  [UnifiedSwapBridgeEventName.QuotesValidationFailed]: RequestParams & {\n    refresh_count: number;\n  };\n  [UnifiedSwapBridgeEventName.StatusValidationFailed]: RequestParams;\n  [UnifiedSwapBridgeEventName.PollingStatusUpdated]: null;\n};\n\n/**\n * trackUnifiedSwapBridgeEvent payload properties consist of required properties from the client\n * and properties from the bridge controller\n */\nexport type CrossChainSwapsEventProperties<\n  T extends UnifiedSwapBridgeEventName,\n> =\n  | {\n      action_type: MetricsActionType;\n      location: MetaMetricsSwapsEventSource;\n    }\n  | Pick<EventPropertiesFromControllerState, T>[T]\n  | Pick<RequiredEventContextFromClient, T>[T];\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/bridge-controller",
-  "version": "66.1.1-preview-33dbba4f3",
+  "version": "67.0.0-preview-a196307b6",
   "description": "Manages bridge-related quote fetching functionality for MetaMask",
   "keywords": [
     "MetaMask",
@@ -64,6 +64,7 @@
     "@metamask/multichain-network-controller": "^3.0.3",
     "@metamask/network-controller": "^29.0.0",
     "@metamask/polling-controller": "^16.0.2",
+    "@metamask/profile-sync-controller": "^27.1.0",
     "@metamask/remote-feature-flag-controller": "^4.0.0",
     "@metamask/snaps-controllers": "^17.2.0",
     "@metamask/transaction-controller": "^62.17.0",