@metamask/snap-networks-utils 1.0.0 → 2.0.0

package/dist/services/analytics/AnalyticsService.d.cts

@@ -0,0 +1,175 @@
+import type { TransactionType } from "@metamask/keyring-api";
+import type { Json } from "@metamask/snaps-sdk";
+import type { TrackErrorFn } from "../../utils/errors/index.cjs";
+import type { Logger } from "../../utils/logger/Logger.cjs";
+export declare const TransactionEventType: {
+    readonly TransactionAdded: "Transaction Added";
+    readonly TransactionRejected: "Transaction Rejected";
+    readonly TransactionApproved: "Transaction Approved";
+    readonly TransactionSubmitted: "Transaction Submitted";
+    readonly TransactionFinalized: "Transaction Finalized";
+};
+export type TransactionEventType = (typeof TransactionEventType)[keyof typeof TransactionEventType];
+export declare const SecurityEventType: {
+    readonly SecurityAlertDetected: "Security Alert Detected";
+    readonly SecurityScanCompleted: "Security Scan Completed";
+};
+export type SecurityEventType = (typeof SecurityEventType)[keyof typeof SecurityEventType];
+export type SnapTrackEventRequest = {
+    method: 'snap_trackEvent';
+    params: {
+        event: {
+            event: string;
+            properties: Record<string, Json>;
+        };
+    };
+};
+export type TrackEventCapableProvider = {
+    request: (args: SnapTrackEventRequest) => Promise<unknown>;
+};
+export type AnalyticsServiceOptions<TProvider extends TrackEventCapableProvider = TrackEventCapableProvider> = {
+    getSnapProvider: () => TProvider;
+    logger: Logger;
+    trackError: TrackErrorFn;
+};
+/**
+ * Fields shared by every event tied to an account on a chain.
+ */
+export type AccountEventProperties = {
+    origin: string;
+    accountType: string;
+    chainIdCaip: string;
+};
+/**
+ * Properties of a transaction lifecycle event.
+ *
+ * `transactionType` is the optional classification of the transaction.
+ *
+ * Security events intentionally do not extend this type: they are not tied to a
+ * transaction classification, so advertising `transactionType` there would let
+ * callers pass a value that is silently discarded.
+ */
+export type TransactionEventProperties = AccountEventProperties & {
+    transactionType?: `${TransactionType}`;
+};
+export type TransactionFinalizedEventProperties = TransactionEventProperties & {
+    transactionStatus?: string;
+};
+export type SecurityAlertDetectedEventProperties = AccountEventProperties & {
+    securityAlertResponse: string;
+    securityAlertReason: string | null;
+    securityAlertDescription: string;
+};
+export type SecurityScanCompletedEventProperties = AccountEventProperties & {
+    scanStatus: string;
+    hasSecurityAlerts: boolean;
+};
+export type WebSocketConnectionClosedEventProperties = {
+    origin: string;
+    code: number;
+    reason: string | null;
+};
+/**
+ * Tracks common network Snap analytics events.
+ */
+export declare class AnalyticsService<TProvider extends TrackEventCapableProvider = TrackEventCapableProvider> {
+    #private;
+    constructor({ getSnapProvider, logger, trackError, }: AnalyticsServiceOptions<TProvider>);
+    /**
+     * Track an event in MetaMask analytics.
+     *
+     * Tracking and error-reporting failures are logged but never interrupt the
+     * user flow.
+     *
+     * @param event - Event name.
+     * @param properties - Event properties.
+     */
+    trackEvent(event: string, properties: Record<string, Json>): Promise<void>;
+    /**
+     * Track a "Transaction Added" event when a transaction confirmation is shown.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionAdded(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Rejected" event when the user rejects a transaction.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionRejected(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Approved" event when a transaction is approved.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionApproved(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Submitted" event when a transaction is broadcast.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionSubmitted(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Finalized" event when a transaction reaches a final state.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionStatus - Optional final transaction status.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionFinalized({ origin, accountType, chainIdCaip, transactionStatus, transactionType, }: TransactionFinalizedEventProperties): Promise<void>;
+    /**
+     * Track a "Security Alert Detected" event when a malicious or warning
+     * transaction is detected.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.securityAlertResponse - The type of security alert.
+     * @param properties.securityAlertReason - The reason for the security alert.
+     * @param properties.securityAlertDescription - Human-readable description of the alert.
+     */
+    trackSecurityAlertDetected({ origin, accountType, chainIdCaip, securityAlertResponse, securityAlertReason, securityAlertDescription, }: SecurityAlertDetectedEventProperties): Promise<void>;
+    /**
+     * Track a "Security Scan Completed" event when a transaction security scan
+     * finishes.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.scanStatus - The status of the scan.
+     * @param properties.hasSecurityAlerts - Whether security alerts were detected.
+     */
+    trackSecurityScanCompleted({ origin, accountType, chainIdCaip, scanStatus, hasSecurityAlerts, }: SecurityScanCompletedEventProperties): Promise<void>;
+    /**
+     * Track a "WebSocket Connection Closed Not Cleanly" event when a Snap
+     * WebSocket disconnects without a clean close.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the connection.
+     * @param properties.code - The WebSocket close code.
+     * @param properties.reason - The close reason, if any.
+     */
+    trackWebSocketConnectionClosedNotCleanly({ origin, code, reason, }: WebSocketConnectionClosedEventProperties): Promise<void>;
+}
+//# sourceMappingURL=AnalyticsService.d.cts.map

package/dist/services/analytics/AnalyticsService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsService.d.cts","sourceRoot":"","sources":["../../../src/services/analytics/AnalyticsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,4BAA4B;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,qCAA2B;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,sCAAkC;AAExD,eAAO,MAAM,oBAAoB;;;;;;CAMvB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAC9B,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAClC,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,uBAAuB,CACjC,SAAS,SAAS,yBAAyB,GAAG,yBAAyB,IACrE;IACF,eAAe,EAAE,MAAM,SAAS,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG;IAChE,eAAe,CAAC,EAAE,GAAG,eAAe,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,GAAG;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,GAAG;IAC1E,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,GAAG;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB,CAC3B,SAAS,SAAS,yBAAyB,GAAG,yBAAyB;;gBAQ3D,EACV,eAAe,EACf,MAAM,EACN,UAAU,GACX,EAAE,uBAAuB,CAAC,SAAS,CAAC;IAMrC;;;;;;;;OAQG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IA4BhB;;;;;;;;OAQG;IACG,qBAAqB,CACzB,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;;OASG;IACG,yBAAyB,CAAC,EAC9B,MAAM,EACN,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,EAAE,mCAAmC,GAAG,OAAO,CAAC,IAAI,CAAC;IAetD;;;;;;;;;;;OAWG;IACG,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,mBAAmB,EACnB,wBAAwB,GACzB,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvD;;;;;;;;;;OAUG;IACG,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,UAAU,EACV,iBAAiB,GAClB,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWvD;;;;;;;;OAQG;IACG,wCAAwC,CAAC,EAC7C,MAAM,EACN,IAAI,EACJ,MAAM,GACP,EAAE,wCAAwC,GAAG,OAAO,CAAC,IAAI,CAAC;CA4C5D"}

package/dist/services/analytics/AnalyticsService.d.mts

@@ -0,0 +1,175 @@
+import type { TransactionType } from "@metamask/keyring-api";
+import type { Json } from "@metamask/snaps-sdk";
+import type { TrackErrorFn } from "../../utils/errors/index.mjs";
+import type { Logger } from "../../utils/logger/Logger.mjs";
+export declare const TransactionEventType: {
+    readonly TransactionAdded: "Transaction Added";
+    readonly TransactionRejected: "Transaction Rejected";
+    readonly TransactionApproved: "Transaction Approved";
+    readonly TransactionSubmitted: "Transaction Submitted";
+    readonly TransactionFinalized: "Transaction Finalized";
+};
+export type TransactionEventType = (typeof TransactionEventType)[keyof typeof TransactionEventType];
+export declare const SecurityEventType: {
+    readonly SecurityAlertDetected: "Security Alert Detected";
+    readonly SecurityScanCompleted: "Security Scan Completed";
+};
+export type SecurityEventType = (typeof SecurityEventType)[keyof typeof SecurityEventType];
+export type SnapTrackEventRequest = {
+    method: 'snap_trackEvent';
+    params: {
+        event: {
+            event: string;
+            properties: Record<string, Json>;
+        };
+    };
+};
+export type TrackEventCapableProvider = {
+    request: (args: SnapTrackEventRequest) => Promise<unknown>;
+};
+export type AnalyticsServiceOptions<TProvider extends TrackEventCapableProvider = TrackEventCapableProvider> = {
+    getSnapProvider: () => TProvider;
+    logger: Logger;
+    trackError: TrackErrorFn;
+};
+/**
+ * Fields shared by every event tied to an account on a chain.
+ */
+export type AccountEventProperties = {
+    origin: string;
+    accountType: string;
+    chainIdCaip: string;
+};
+/**
+ * Properties of a transaction lifecycle event.
+ *
+ * `transactionType` is the optional classification of the transaction.
+ *
+ * Security events intentionally do not extend this type: they are not tied to a
+ * transaction classification, so advertising `transactionType` there would let
+ * callers pass a value that is silently discarded.
+ */
+export type TransactionEventProperties = AccountEventProperties & {
+    transactionType?: `${TransactionType}`;
+};
+export type TransactionFinalizedEventProperties = TransactionEventProperties & {
+    transactionStatus?: string;
+};
+export type SecurityAlertDetectedEventProperties = AccountEventProperties & {
+    securityAlertResponse: string;
+    securityAlertReason: string | null;
+    securityAlertDescription: string;
+};
+export type SecurityScanCompletedEventProperties = AccountEventProperties & {
+    scanStatus: string;
+    hasSecurityAlerts: boolean;
+};
+export type WebSocketConnectionClosedEventProperties = {
+    origin: string;
+    code: number;
+    reason: string | null;
+};
+/**
+ * Tracks common network Snap analytics events.
+ */
+export declare class AnalyticsService<TProvider extends TrackEventCapableProvider = TrackEventCapableProvider> {
+    #private;
+    constructor({ getSnapProvider, logger, trackError, }: AnalyticsServiceOptions<TProvider>);
+    /**
+     * Track an event in MetaMask analytics.
+     *
+     * Tracking and error-reporting failures are logged but never interrupt the
+     * user flow.
+     *
+     * @param event - Event name.
+     * @param properties - Event properties.
+     */
+    trackEvent(event: string, properties: Record<string, Json>): Promise<void>;
+    /**
+     * Track a "Transaction Added" event when a transaction confirmation is shown.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionAdded(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Rejected" event when the user rejects a transaction.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionRejected(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Approved" event when a transaction is approved.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionApproved(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Submitted" event when a transaction is broadcast.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionSubmitted(properties: TransactionEventProperties): Promise<void>;
+    /**
+     * Track a "Transaction Finalized" event when a transaction reaches a final state.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionStatus - Optional final transaction status.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    trackTransactionFinalized({ origin, accountType, chainIdCaip, transactionStatus, transactionType, }: TransactionFinalizedEventProperties): Promise<void>;
+    /**
+     * Track a "Security Alert Detected" event when a malicious or warning
+     * transaction is detected.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.securityAlertResponse - The type of security alert.
+     * @param properties.securityAlertReason - The reason for the security alert.
+     * @param properties.securityAlertDescription - Human-readable description of the alert.
+     */
+    trackSecurityAlertDetected({ origin, accountType, chainIdCaip, securityAlertResponse, securityAlertReason, securityAlertDescription, }: SecurityAlertDetectedEventProperties): Promise<void>;
+    /**
+     * Track a "Security Scan Completed" event when a transaction security scan
+     * finishes.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.scanStatus - The status of the scan.
+     * @param properties.hasSecurityAlerts - Whether security alerts were detected.
+     */
+    trackSecurityScanCompleted({ origin, accountType, chainIdCaip, scanStatus, hasSecurityAlerts, }: SecurityScanCompletedEventProperties): Promise<void>;
+    /**
+     * Track a "WebSocket Connection Closed Not Cleanly" event when a Snap
+     * WebSocket disconnects without a clean close.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the connection.
+     * @param properties.code - The WebSocket close code.
+     * @param properties.reason - The close reason, if any.
+     */
+    trackWebSocketConnectionClosedNotCleanly({ origin, code, reason, }: WebSocketConnectionClosedEventProperties): Promise<void>;
+}
+//# sourceMappingURL=AnalyticsService.d.mts.map

package/dist/services/analytics/AnalyticsService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsService.d.mts","sourceRoot":"","sources":["../../../src/services/analytics/AnalyticsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,4BAA4B;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,qCAA2B;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,sCAAkC;AAExD,eAAO,MAAM,oBAAoB;;;;;;CAMvB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAC9B,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAClC,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,uBAAuB,CACjC,SAAS,SAAS,yBAAyB,GAAG,yBAAyB,IACrE;IACF,eAAe,EAAE,MAAM,SAAS,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG;IAChE,eAAe,CAAC,EAAE,GAAG,eAAe,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,GAAG;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,GAAG;IAC1E,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,GAAG;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB,CAC3B,SAAS,SAAS,yBAAyB,GAAG,yBAAyB;;gBAQ3D,EACV,eAAe,EACf,MAAM,EACN,UAAU,GACX,EAAE,uBAAuB,CAAC,SAAS,CAAC;IAMrC;;;;;;;;OAQG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IA4BhB;;;;;;;;OAQG;IACG,qBAAqB,CACzB,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;;OASG;IACG,yBAAyB,CAAC,EAC9B,MAAM,EACN,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,EAAE,mCAAmC,GAAG,OAAO,CAAC,IAAI,CAAC;IAetD;;;;;;;;;;;OAWG;IACG,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,mBAAmB,EACnB,wBAAwB,GACzB,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvD;;;;;;;;;;OAUG;IACG,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,UAAU,EACV,iBAAiB,GAClB,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWvD;;;;;;;;OAQG;IACG,wCAAwC,CAAC,EAC7C,MAAM,EACN,IAAI,EACJ,MAAM,GACP,EAAE,wCAAwC,GAAG,OAAO,CAAC,IAAI,CAAC;CA4C5D"}

package/dist/services/analytics/AnalyticsService.mjs

@@ -0,0 +1,221 @@
+export const TransactionEventType = {
+    TransactionAdded: 'Transaction Added',
+    TransactionRejected: 'Transaction Rejected',
+    TransactionApproved: 'Transaction Approved',
+    TransactionSubmitted: 'Transaction Submitted',
+    TransactionFinalized: 'Transaction Finalized',
+};
+export const SecurityEventType = {
+    SecurityAlertDetected: 'Security Alert Detected',
+    SecurityScanCompleted: 'Security Scan Completed',
+};
+/**
+ * Tracks common network Snap analytics events.
+ */
+export class AnalyticsService {
+    #getSnapProvider;
+    #logger;
+    #trackError;
+    constructor({ getSnapProvider, logger, trackError, }) {
+        this.#getSnapProvider = getSnapProvider;
+        this.#logger = logger.withPrefix('[AnalyticsService]');
+        this.#trackError = trackError;
+    }
+    /**
+     * Track an event in MetaMask analytics.
+     *
+     * Tracking and error-reporting failures are logged but never interrupt the
+     * user flow.
+     *
+     * @param event - Event name.
+     * @param properties - Event properties.
+     */
+    async trackEvent(event, properties) {
+        try {
+            await this.#getSnapProvider().request({
+                method: 'snap_trackEvent',
+                params: {
+                    event: {
+                        event,
+                        properties,
+                    },
+                },
+            });
+        }
+        catch (error) {
+            try {
+                await this.#trackError(error);
+            }
+            catch (trackingError) {
+                this.#logger.warn('Failed to report analytics error', {
+                    error: trackingError,
+                });
+            }
+            this.#logger.warn('Failed to track event', {
+                error,
+                event,
+                properties,
+            });
+        }
+    }
+    /**
+     * Track a "Transaction Added" event when a transaction confirmation is shown.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async trackTransactionAdded(properties) {
+        await this.#trackTransactionEvent(TransactionEventType.TransactionAdded, 'Snap transaction added', properties);
+    }
+    /**
+     * Track a "Transaction Rejected" event when the user rejects a transaction.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async trackTransactionRejected(properties) {
+        await this.#trackTransactionEvent(TransactionEventType.TransactionRejected, 'Snap transaction rejected', properties);
+    }
+    /**
+     * Track a "Transaction Approved" event when a transaction is approved.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async trackTransactionApproved(properties) {
+        await this.#trackTransactionEvent(TransactionEventType.TransactionApproved, 'Snap transaction approved', properties);
+    }
+    /**
+     * Track a "Transaction Submitted" event when a transaction is broadcast.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async trackTransactionSubmitted(properties) {
+        await this.#trackTransactionEvent(TransactionEventType.TransactionSubmitted, 'Snap transaction submitted', properties);
+    }
+    /**
+     * Track a "Transaction Finalized" event when a transaction reaches a final state.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionStatus - Optional final transaction status.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async trackTransactionFinalized({ origin, accountType, chainIdCaip, transactionStatus, transactionType, }) {
+        await this.trackEvent(TransactionEventType.TransactionFinalized, {
+            message: 'Snap transaction finalized',
+            origin,
+            account_type: accountType,
+            chain_id_caip: chainIdCaip,
+            ...(transactionStatus === undefined
+                ? {}
+                : { transaction_status: transactionStatus }),
+            ...(transactionType === undefined
+                ? {}
+                : { transaction_type: transactionType }),
+        });
+    }
+    /**
+     * Track a "Security Alert Detected" event when a malicious or warning
+     * transaction is detected.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.securityAlertResponse - The type of security alert.
+     * @param properties.securityAlertReason - The reason for the security alert.
+     * @param properties.securityAlertDescription - Human-readable description of the alert.
+     */
+    async trackSecurityAlertDetected({ origin, accountType, chainIdCaip, securityAlertResponse, securityAlertReason, securityAlertDescription, }) {
+        await this.trackEvent(SecurityEventType.SecurityAlertDetected, {
+            message: 'Snap security alert detected',
+            origin,
+            account_type: accountType,
+            chain_id_caip: chainIdCaip,
+            security_alert_response: securityAlertResponse,
+            security_alert_reason: securityAlertReason,
+            security_alert_description: securityAlertDescription,
+        });
+    }
+    /**
+     * Track a "Security Scan Completed" event when a transaction security scan
+     * finishes.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.scanStatus - The status of the scan.
+     * @param properties.hasSecurityAlerts - Whether security alerts were detected.
+     */
+    async trackSecurityScanCompleted({ origin, accountType, chainIdCaip, scanStatus, hasSecurityAlerts, }) {
+        await this.trackEvent(SecurityEventType.SecurityScanCompleted, {
+            message: 'Snap security scan completed',
+            origin,
+            account_type: accountType,
+            chain_id_caip: chainIdCaip,
+            scan_status: scanStatus,
+            has_security_alerts: hasSecurityAlerts,
+        });
+    }
+    /**
+     * Track a "WebSocket Connection Closed Not Cleanly" event when a Snap
+     * WebSocket disconnects without a clean close.
+     *
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the connection.
+     * @param properties.code - The WebSocket close code.
+     * @param properties.reason - The close reason, if any.
+     */
+    async trackWebSocketConnectionClosedNotCleanly({ origin, code, reason, }) {
+        await this.trackEvent('WebSocket Connection Closed Not Cleanly', {
+            message: 'Snap WebSocket connection closed not cleanly',
+            origin,
+            code,
+            reason,
+        });
+    }
+    /**
+     * Track a transaction lifecycle event.
+     *
+     * Centralizes the shared payload so the common properties only have to change
+     * in one place. `transaction_type` is added only when the emitting Snap could
+     * classify the transaction.
+     *
+     * @param event - Event name.
+     * @param message - Human-readable event message.
+     * @param properties - Event properties.
+     * @param properties.origin - The origin of the request.
+     * @param properties.accountType - The type of account.
+     * @param properties.chainIdCaip - The CAIP-2 chain ID.
+     * @param properties.transactionType - Optional transaction type.
+     */
+    async #trackTransactionEvent(event, message, { origin, accountType, chainIdCaip, transactionType, }) {
+        await this.trackEvent(event, {
+            message,
+            origin,
+            account_type: accountType,
+            chain_id_caip: chainIdCaip,
+            ...(transactionType === undefined
+                ? {}
+                : { transaction_type: transactionType }),
+        });
+    }
+}
+//# sourceMappingURL=AnalyticsService.mjs.map

package/dist/services/analytics/AnalyticsService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsService.mjs","sourceRoot":"","sources":["../../../src/services/analytics/AnalyticsService.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,gBAAgB,EAAE,mBAAmB;IACrC,mBAAmB,EAAE,sBAAsB;IAC3C,mBAAmB,EAAE,sBAAsB;IAC3C,oBAAoB,EAAE,uBAAuB;IAC7C,oBAAoB,EAAE,uBAAuB;CACrC,CAAC;AAKX,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,qBAAqB,EAAE,yBAAyB;IAChD,qBAAqB,EAAE,yBAAyB;CACxC,CAAC;AAsEX;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAGlB,gBAAgB,CAAkB;IAElC,OAAO,CAAS;IAEhB,WAAW,CAAe;IAEnC,YAAY,EACV,eAAe,EACf,MAAM,EACN,UAAU,GACyB;QACnC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,KAAa,EACb,UAAgC;QAEhC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC;gBACpC,MAAM,EAAE,iBAAiB;gBACzB,MAAM,EAAE;oBACN,KAAK,EAAE;wBACL,KAAK;wBACL,UAAU;qBACX;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;YAAC,OAAO,aAAa,EAAE,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE;oBACpD,KAAK,EAAE,aAAa;iBACrB,CAAC,CAAC;YACL,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;gBACzC,KAAK;gBACL,KAAK;gBACL,UAAU;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CACzB,UAAsC;QAEtC,MAAM,IAAI,CAAC,sBAAsB,CAC/B,oBAAoB,CAAC,gBAAgB,EACrC,wBAAwB,EACxB,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAC5B,UAAsC;QAEtC,MAAM,IAAI,CAAC,sBAAsB,CAC/B,oBAAoB,CAAC,mBAAmB,EACxC,2BAA2B,EAC3B,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAC5B,UAAsC;QAEtC,MAAM,IAAI,CAAC,sBAAsB,CAC/B,oBAAoB,CAAC,mBAAmB,EACxC,2BAA2B,EAC3B,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAC7B,UAAsC;QAEtC,MAAM,IAAI,CAAC,sBAAsB,CAC/B,oBAAoB,CAAC,oBAAoB,EACzC,4BAA4B,EAC5B,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,yBAAyB,CAAC,EAC9B,MAAM,EACN,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,eAAe,GACqB;QACpC,MAAM,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,oBAAoB,EAAE;YAC/D,OAAO,EAAE,4BAA4B;YACrC,MAAM;YACN,YAAY,EAAE,WAAW;YACzB,aAAa,EAAE,WAAW;YAC1B,GAAG,CAAC,iBAAiB,KAAK,SAAS;gBACjC,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;YAC9C,GAAG,CAAC,eAAe,KAAK,SAAS;gBAC/B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,mBAAmB,EACnB,wBAAwB,GACa;QACrC,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,qBAAqB,EAAE;YAC7D,OAAO,EAAE,8BAA8B;YACvC,MAAM;YACN,YAAY,EAAE,WAAW;YACzB,aAAa,EAAE,WAAW;YAC1B,uBAAuB,EAAE,qBAAqB;YAC9C,qBAAqB,EAAE,mBAAmB;YAC1C,0BAA0B,EAAE,wBAAwB;SACrD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,0BAA0B,CAAC,EAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,UAAU,EACV,iBAAiB,GACoB;QACrC,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,qBAAqB,EAAE;YAC7D,OAAO,EAAE,8BAA8B;YACvC,MAAM;YACN,YAAY,EAAE,WAAW;YACzB,aAAa,EAAE,WAAW;YAC1B,WAAW,EAAE,UAAU;YACvB,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wCAAwC,CAAC,EAC7C,MAAM,EACN,IAAI,EACJ,MAAM,GACmC;QACzC,MAAM,IAAI,CAAC,UAAU,CAAC,yCAAyC,EAAE;YAC/D,OAAO,EAAE,8CAA8C;YACvD,MAAM;YACN,IAAI;YACJ,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,sBAAsB,CAC1B,KAA2B,EAC3B,OAAe,EACf,EACE,MAAM,EACN,WAAW,EACX,WAAW,EACX,eAAe,GACY;QAE7B,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;YAC3B,OAAO;YACP,MAAM;YACN,YAAY,EAAE,WAAW;YACzB,aAAa,EAAE,WAAW;YAC1B,GAAG,CAAC,eAAe,KAAK,SAAS;gBAC/B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { TransactionType } from '@metamask/keyring-api';\nimport type { Json } from '@metamask/snaps-sdk';\n\nimport type { TrackErrorFn } from '../../utils/errors';\nimport type { Logger } from '../../utils/logger/Logger';\n\nexport const TransactionEventType = {\n  TransactionAdded: 'Transaction Added',\n  TransactionRejected: 'Transaction Rejected',\n  TransactionApproved: 'Transaction Approved',\n  TransactionSubmitted: 'Transaction Submitted',\n  TransactionFinalized: 'Transaction Finalized',\n} as const;\n\nexport type TransactionEventType =\n  (typeof TransactionEventType)[keyof typeof TransactionEventType];\n\nexport const SecurityEventType = {\n  SecurityAlertDetected: 'Security Alert Detected',\n  SecurityScanCompleted: 'Security Scan Completed',\n} as const;\n\nexport type SecurityEventType =\n  (typeof SecurityEventType)[keyof typeof SecurityEventType];\n\nexport type SnapTrackEventRequest = {\n  method: 'snap_trackEvent';\n  params: {\n    event: {\n      event: string;\n      properties: Record<string, Json>;\n    };\n  };\n};\n\nexport type TrackEventCapableProvider = {\n  request: (args: SnapTrackEventRequest) => Promise<unknown>;\n};\n\nexport type AnalyticsServiceOptions<\n  TProvider extends TrackEventCapableProvider = TrackEventCapableProvider,\n> = {\n  getSnapProvider: () => TProvider;\n  logger: Logger;\n  trackError: TrackErrorFn;\n};\n\n/**\n * Fields shared by every event tied to an account on a chain.\n */\nexport type AccountEventProperties = {\n  origin: string;\n  accountType: string;\n  chainIdCaip: string;\n};\n\n/**\n * Properties of a transaction lifecycle event.\n *\n * `transactionType` is the optional classification of the transaction.\n *\n * Security events intentionally do not extend this type: they are not tied to a\n * transaction classification, so advertising `transactionType` there would let\n * callers pass a value that is silently discarded.\n */\nexport type TransactionEventProperties = AccountEventProperties & {\n  transactionType?: `${TransactionType}`;\n};\n\nexport type TransactionFinalizedEventProperties = TransactionEventProperties & {\n  transactionStatus?: string;\n};\n\nexport type SecurityAlertDetectedEventProperties = AccountEventProperties & {\n  securityAlertResponse: string;\n  securityAlertReason: string | null;\n  securityAlertDescription: string;\n};\n\nexport type SecurityScanCompletedEventProperties = AccountEventProperties & {\n  scanStatus: string;\n  hasSecurityAlerts: boolean;\n};\n\nexport type WebSocketConnectionClosedEventProperties = {\n  origin: string;\n  code: number;\n  reason: string | null;\n};\n\n/**\n * Tracks common network Snap analytics events.\n */\nexport class AnalyticsService<\n  TProvider extends TrackEventCapableProvider = TrackEventCapableProvider,\n> {\n  readonly #getSnapProvider: () => TProvider;\n\n  readonly #logger: Logger;\n\n  readonly #trackError: TrackErrorFn;\n\n  constructor({\n    getSnapProvider,\n    logger,\n    trackError,\n  }: AnalyticsServiceOptions<TProvider>) {\n    this.#getSnapProvider = getSnapProvider;\n    this.#logger = logger.withPrefix('[AnalyticsService]');\n    this.#trackError = trackError;\n  }\n\n  /**\n   * Track an event in MetaMask analytics.\n   *\n   * Tracking and error-reporting failures are logged but never interrupt the\n   * user flow.\n   *\n   * @param event - Event name.\n   * @param properties - Event properties.\n   */\n  async trackEvent(\n    event: string,\n    properties: Record<string, Json>,\n  ): Promise<void> {\n    try {\n      await this.#getSnapProvider().request({\n        method: 'snap_trackEvent',\n        params: {\n          event: {\n            event,\n            properties,\n          },\n        },\n      });\n    } catch (error) {\n      try {\n        await this.#trackError(error);\n      } catch (trackingError) {\n        this.#logger.warn('Failed to report analytics error', {\n          error: trackingError,\n        });\n      }\n\n      this.#logger.warn('Failed to track event', {\n        error,\n        event,\n        properties,\n      });\n    }\n  }\n\n  /**\n   * Track a \"Transaction Added\" event when a transaction confirmation is shown.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async trackTransactionAdded(\n    properties: TransactionEventProperties,\n  ): Promise<void> {\n    await this.#trackTransactionEvent(\n      TransactionEventType.TransactionAdded,\n      'Snap transaction added',\n      properties,\n    );\n  }\n\n  /**\n   * Track a \"Transaction Rejected\" event when the user rejects a transaction.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async trackTransactionRejected(\n    properties: TransactionEventProperties,\n  ): Promise<void> {\n    await this.#trackTransactionEvent(\n      TransactionEventType.TransactionRejected,\n      'Snap transaction rejected',\n      properties,\n    );\n  }\n\n  /**\n   * Track a \"Transaction Approved\" event when a transaction is approved.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async trackTransactionApproved(\n    properties: TransactionEventProperties,\n  ): Promise<void> {\n    await this.#trackTransactionEvent(\n      TransactionEventType.TransactionApproved,\n      'Snap transaction approved',\n      properties,\n    );\n  }\n\n  /**\n   * Track a \"Transaction Submitted\" event when a transaction is broadcast.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async trackTransactionSubmitted(\n    properties: TransactionEventProperties,\n  ): Promise<void> {\n    await this.#trackTransactionEvent(\n      TransactionEventType.TransactionSubmitted,\n      'Snap transaction submitted',\n      properties,\n    );\n  }\n\n  /**\n   * Track a \"Transaction Finalized\" event when a transaction reaches a final state.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionStatus - Optional final transaction status.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async trackTransactionFinalized({\n    origin,\n    accountType,\n    chainIdCaip,\n    transactionStatus,\n    transactionType,\n  }: TransactionFinalizedEventProperties): Promise<void> {\n    await this.trackEvent(TransactionEventType.TransactionFinalized, {\n      message: 'Snap transaction finalized',\n      origin,\n      account_type: accountType,\n      chain_id_caip: chainIdCaip,\n      ...(transactionStatus === undefined\n        ? {}\n        : { transaction_status: transactionStatus }),\n      ...(transactionType === undefined\n        ? {}\n        : { transaction_type: transactionType }),\n    });\n  }\n\n  /**\n   * Track a \"Security Alert Detected\" event when a malicious or warning\n   * transaction is detected.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.securityAlertResponse - The type of security alert.\n   * @param properties.securityAlertReason - The reason for the security alert.\n   * @param properties.securityAlertDescription - Human-readable description of the alert.\n   */\n  async trackSecurityAlertDetected({\n    origin,\n    accountType,\n    chainIdCaip,\n    securityAlertResponse,\n    securityAlertReason,\n    securityAlertDescription,\n  }: SecurityAlertDetectedEventProperties): Promise<void> {\n    await this.trackEvent(SecurityEventType.SecurityAlertDetected, {\n      message: 'Snap security alert detected',\n      origin,\n      account_type: accountType,\n      chain_id_caip: chainIdCaip,\n      security_alert_response: securityAlertResponse,\n      security_alert_reason: securityAlertReason,\n      security_alert_description: securityAlertDescription,\n    });\n  }\n\n  /**\n   * Track a \"Security Scan Completed\" event when a transaction security scan\n   * finishes.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.scanStatus - The status of the scan.\n   * @param properties.hasSecurityAlerts - Whether security alerts were detected.\n   */\n  async trackSecurityScanCompleted({\n    origin,\n    accountType,\n    chainIdCaip,\n    scanStatus,\n    hasSecurityAlerts,\n  }: SecurityScanCompletedEventProperties): Promise<void> {\n    await this.trackEvent(SecurityEventType.SecurityScanCompleted, {\n      message: 'Snap security scan completed',\n      origin,\n      account_type: accountType,\n      chain_id_caip: chainIdCaip,\n      scan_status: scanStatus,\n      has_security_alerts: hasSecurityAlerts,\n    });\n  }\n\n  /**\n   * Track a \"WebSocket Connection Closed Not Cleanly\" event when a Snap\n   * WebSocket disconnects without a clean close.\n   *\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the connection.\n   * @param properties.code - The WebSocket close code.\n   * @param properties.reason - The close reason, if any.\n   */\n  async trackWebSocketConnectionClosedNotCleanly({\n    origin,\n    code,\n    reason,\n  }: WebSocketConnectionClosedEventProperties): Promise<void> {\n    await this.trackEvent('WebSocket Connection Closed Not Cleanly', {\n      message: 'Snap WebSocket connection closed not cleanly',\n      origin,\n      code,\n      reason,\n    });\n  }\n\n  /**\n   * Track a transaction lifecycle event.\n   *\n   * Centralizes the shared payload so the common properties only have to change\n   * in one place. `transaction_type` is added only when the emitting Snap could\n   * classify the transaction.\n   *\n   * @param event - Event name.\n   * @param message - Human-readable event message.\n   * @param properties - Event properties.\n   * @param properties.origin - The origin of the request.\n   * @param properties.accountType - The type of account.\n   * @param properties.chainIdCaip - The CAIP-2 chain ID.\n   * @param properties.transactionType - Optional transaction type.\n   */\n  async #trackTransactionEvent(\n    event: TransactionEventType,\n    message: string,\n    {\n      origin,\n      accountType,\n      chainIdCaip,\n      transactionType,\n    }: TransactionEventProperties,\n  ): Promise<void> {\n    await this.trackEvent(event, {\n      message,\n      origin,\n      account_type: accountType,\n      chain_id_caip: chainIdCaip,\n      ...(transactionType === undefined\n        ? {}\n        : { transaction_type: transactionType }),\n    });\n  }\n}\n"]}

package/dist/ui/ActionHeader/ActionHeader.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionHeader = void 0;
+const jsx_runtime_1 = require("@metamask/snaps-sdk/jsx-runtime");
+const jsx_1 = require("@metamask/snaps-sdk/jsx");
+const Asset_1 = require("../Asset/Asset.cjs");
+/**
+ * Renders the centered header at the top of a confirmation: a large title,
+ * then an optional subtitle and asset icon.
+ *
+ * @param props - The component props.
+ * @param props.title - The title.
+ * @param props.subtitle - The subtitle.
+ * @param props.iconUrl - The asset icon URL.
+ * @returns The header element.
+ * @example
+ * ```tsx
+ * <ActionHeader title={translate('confirmation.signMessage.title')} />;
+ * ```
+ */
+const ActionHeader = ({ title, subtitle, iconUrl, }) => ((0, jsx_runtime_1.jsxs)(jsx_1.Box, { alignment: "center", center: true, children: [(0, jsx_runtime_1.jsx)(jsx_1.Box, { children: null }), (0, jsx_runtime_1.jsx)(jsx_1.Heading, { size: "lg", children: title }), subtitle ? ((0, jsx_runtime_1.jsx)(jsx_1.Text, { color: "muted", alignment: "center", children: subtitle })) : null, iconUrl === undefined ? null : ((0, jsx_runtime_1.jsx)(jsx_1.Box, { children: (0, jsx_runtime_1.jsx)(Asset_1.AssetIcon, { iconUrl: iconUrl, size: "xl" }) })), (0, jsx_runtime_1.jsx)(jsx_1.Box, { children: null })] }));
+exports.ActionHeader = ActionHeader;
+//# sourceMappingURL=ActionHeader.cjs.map

package/dist/ui/ActionHeader/ActionHeader.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionHeader.cjs","sourceRoot":"","sources":["../../../src/ui/ActionHeader/ActionHeader.tsx"],"names":[],"mappings":";;;;AACA,iDAAyE;AAEzE,8CAA2C;AAa3C;;;;;;;;;;;;;GAaG;AACI,MAAM,YAAY,GAAG,CAAC,EAC3B,KAAK,EACL,QAAQ,EACR,OAAO,GACW,EAAsB,EAAE,CAAC,CAC3C,wBAAC,SAAG,IAAC,SAAS,EAAC,QAAQ,EAAC,MAAM,mBAC5B,uBAAC,SAAG,cAAE,IAAI,GAAO,EACjB,uBAAC,aAAO,IAAC,IAAI,EAAC,IAAI,YAAE,KAAK,GAAW,EACnC,QAAQ,CAAC,CAAC,CAAC,CACV,uBAAC,UAAQ,IAAC,KAAK,EAAC,OAAO,EAAC,SAAS,EAAC,QAAQ,YACvC,QAAQ,GACA,CACZ,CAAC,CAAC,CAAC,IAAI,EACP,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC9B,uBAAC,SAAG,cACF,uBAAC,iBAAS,IAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,IAAI,GAAG,GACrC,CACP,EACD,uBAAC,SAAG,cAAE,IAAI,GAAO,IACb,CACP,CAAC;AApBW,QAAA,YAAY,gBAoBvB","sourcesContent":["import type { ComponentOrElement } from '@metamask/snaps-sdk';\nimport { Box, Heading, Text as SnapText } from '@metamask/snaps-sdk/jsx';\n\nimport { AssetIcon } from '../Asset/Asset';\n\nexport type ActionHeaderProps = {\n  title: string;\n  /** Muted text shown below the title. */\n  subtitle?: string;\n  /**\n   * Asset icon URL; when set, an extra-large asset icon is shown below the\n   * title. A blank URL shows the question-mark icon.\n   */\n  iconUrl?: string;\n};\n\n/**\n * Renders the centered header at the top of a confirmation: a large title,\n * then an optional subtitle and asset icon.\n *\n * @param props - The component props.\n * @param props.title - The title.\n * @param props.subtitle - The subtitle.\n * @param props.iconUrl - The asset icon URL.\n * @returns The header element.\n * @example\n * ```tsx\n * <ActionHeader title={translate('confirmation.signMessage.title')} />;\n * ```\n */\nexport const ActionHeader = ({\n  title,\n  subtitle,\n  iconUrl,\n}: ActionHeaderProps): ComponentOrElement => (\n  <Box alignment=\"center\" center>\n    <Box>{null}</Box>\n    <Heading size=\"lg\">{title}</Heading>\n    {subtitle ? (\n      <SnapText color=\"muted\" alignment=\"center\">\n        {subtitle}\n      </SnapText>\n    ) : null}\n    {iconUrl === undefined ? null : (\n      <Box>\n        <AssetIcon iconUrl={iconUrl} size=\"xl\" />\n      </Box>\n    )}\n    <Box>{null}</Box>\n  </Box>\n);\n"]}