@metamask-previews/network-controller 33.0.0-preview-5c294abf8 → 33.0.0-preview-e0ee14da7

package/dist/rpc-service-events.d.cts

@@ -0,0 +1,85 @@
+import type { AnalyticsTrackingEvent } from "@metamask/analytics-controller";
+import type { Hex, Json } from "@metamask/utils";
+import type { DegradedEventType, RetryReason } from "./create-network-client.cjs";
+/**
+ * The names of the analytics events that {@link NetworkController} emits when an
+ * RPC endpoint becomes unavailable or degraded.
+ */
+export type RpcServiceEventName = 'RPC Service Unavailable' | 'RPC Service Degraded';
+/**
+ * Configuration that enables {@link NetworkController} to emit analytics events
+ * for unavailable or degraded RPC endpoints.
+ *
+ * The pieces here are client-specific and cannot be derived inside the
+ * controller: deciding whether an endpoint URL is safe to report depends on the
+ * client's lists of known networks, and the sample rate depends on the client's
+ * build environment.
+ */
+export type NetworkControllerAnalyticsOptions = {
+    /**
+     * Returns `true` if the given RPC endpoint URL is safe to report verbatim (a
+     * "public" endpoint), or `false` if it must be reported as the literal string
+     * `'custom'` to avoid leaking private servers.
+     */
+    isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;
+    /**
+     * The proportion of events to emit, between 0 and 1. `1` emits every event,
+     * `0` emits none. Clients typically use a small value (e.g. `0.01`) in
+     * production to stay within their analytics quota, and `1` in development.
+     */
+    rpcServiceEventsSampleRate: number;
+};
+/**
+ * Hides any API key contained in an RPC endpoint URL by reducing it to its
+ * host, but only when the endpoint is considered public. Non-public endpoints
+ * (and URLs that cannot be parsed) are reported as the literal string
+ * `'custom'`.
+ *
+ * @param endpointUrl - The URL of the RPC endpoint.
+ * @param isPublic - Whether the endpoint is safe to report verbatim.
+ * @returns The sanitized value to report.
+ */
+export declare function sanitizeRpcEndpointUrl(endpointUrl: string, isPublic: boolean): string;
+/**
+ * Builds the properties for an "RPC Service Unavailable" or "RPC Service
+ * Degraded" analytics event.
+ *
+ * @param args - The arguments.
+ * @param args.chainId - The chain ID that the endpoint represents.
+ * @param args.endpointUrl - The URL of the endpoint.
+ * @param args.error - The connection or response error encountered after making
+ * a request to the RPC endpoint.
+ * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe
+ * to report verbatim.
+ * @param args.duration - The policy execution time in milliseconds when the
+ * request succeeded but was slow (degraded events only).
+ * @param args.retryReason - The category of error that was retried (degraded
+ * events only).
+ * @param args.rpcMethodName - The JSON-RPC method that was being executed
+ * (degraded events only).
+ * @param args.traceId - The value of the `X-Trace-Id` response header from the
+ * last request attempt (degraded events only).
+ * @param args.type - Why the endpoint became degraded (degraded events only).
+ * @returns The analytics event properties.
+ */
+export declare function buildRpcServiceEventProperties({ chainId, endpointUrl, error, isRpcEndpointUrlPublic, duration, retryReason, rpcMethodName, traceId, type, }: {
+    chainId: Hex;
+    endpointUrl: string;
+    error: unknown;
+    isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;
+    duration?: number;
+    retryReason?: RetryReason;
+    rpcMethodName?: string;
+    traceId?: string;
+    type?: DegradedEventType;
+}): Record<string, Json>;
+/**
+ * Wraps an event name and properties into the shape expected by the
+ * `AnalyticsController:trackEvent` action.
+ *
+ * @param name - The analytics event name.
+ * @param properties - The analytics event properties.
+ * @returns The analytics tracking event.
+ */
+export declare function toAnalyticsTrackingEvent(name: RpcServiceEventName, properties: Record<string, Json>): AnalyticsTrackingEvent;
+//# sourceMappingURL=rpc-service-events.d.cts.map

package/dist/rpc-service-events.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-events.d.cts","sourceRoot":"","sources":["../src/rpc-service-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uCAAuC;AAC7E,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAQjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B,yBAAyB,GACzB,sBAAsB,CAAC;AAE3B;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;;;OAIG;IACH,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD;;;;OAIG;IACH,0BAA0B,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,OAAO,GAChB,MAAM,CAUR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,8BAA8B,CAAC,EAC7C,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,EACtB,QAAQ,EACR,WAAW,EACX,aAAa,EACb,OAAO,EACP,IAAI,GACL,EAAE;IACD,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,OAAO,CAAC;IACf,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAsBvB;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,mBAAmB,EACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/B,sBAAsB,CAQxB"}

package/dist/rpc-service-events.d.mts

@@ -0,0 +1,85 @@
+import type { AnalyticsTrackingEvent } from "@metamask/analytics-controller";
+import type { Hex, Json } from "@metamask/utils";
+import type { DegradedEventType, RetryReason } from "./create-network-client.mjs";
+/**
+ * The names of the analytics events that {@link NetworkController} emits when an
+ * RPC endpoint becomes unavailable or degraded.
+ */
+export type RpcServiceEventName = 'RPC Service Unavailable' | 'RPC Service Degraded';
+/**
+ * Configuration that enables {@link NetworkController} to emit analytics events
+ * for unavailable or degraded RPC endpoints.
+ *
+ * The pieces here are client-specific and cannot be derived inside the
+ * controller: deciding whether an endpoint URL is safe to report depends on the
+ * client's lists of known networks, and the sample rate depends on the client's
+ * build environment.
+ */
+export type NetworkControllerAnalyticsOptions = {
+    /**
+     * Returns `true` if the given RPC endpoint URL is safe to report verbatim (a
+     * "public" endpoint), or `false` if it must be reported as the literal string
+     * `'custom'` to avoid leaking private servers.
+     */
+    isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;
+    /**
+     * The proportion of events to emit, between 0 and 1. `1` emits every event,
+     * `0` emits none. Clients typically use a small value (e.g. `0.01`) in
+     * production to stay within their analytics quota, and `1` in development.
+     */
+    rpcServiceEventsSampleRate: number;
+};
+/**
+ * Hides any API key contained in an RPC endpoint URL by reducing it to its
+ * host, but only when the endpoint is considered public. Non-public endpoints
+ * (and URLs that cannot be parsed) are reported as the literal string
+ * `'custom'`.
+ *
+ * @param endpointUrl - The URL of the RPC endpoint.
+ * @param isPublic - Whether the endpoint is safe to report verbatim.
+ * @returns The sanitized value to report.
+ */
+export declare function sanitizeRpcEndpointUrl(endpointUrl: string, isPublic: boolean): string;
+/**
+ * Builds the properties for an "RPC Service Unavailable" or "RPC Service
+ * Degraded" analytics event.
+ *
+ * @param args - The arguments.
+ * @param args.chainId - The chain ID that the endpoint represents.
+ * @param args.endpointUrl - The URL of the endpoint.
+ * @param args.error - The connection or response error encountered after making
+ * a request to the RPC endpoint.
+ * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe
+ * to report verbatim.
+ * @param args.duration - The policy execution time in milliseconds when the
+ * request succeeded but was slow (degraded events only).
+ * @param args.retryReason - The category of error that was retried (degraded
+ * events only).
+ * @param args.rpcMethodName - The JSON-RPC method that was being executed
+ * (degraded events only).
+ * @param args.traceId - The value of the `X-Trace-Id` response header from the
+ * last request attempt (degraded events only).
+ * @param args.type - Why the endpoint became degraded (degraded events only).
+ * @returns The analytics event properties.
+ */
+export declare function buildRpcServiceEventProperties({ chainId, endpointUrl, error, isRpcEndpointUrlPublic, duration, retryReason, rpcMethodName, traceId, type, }: {
+    chainId: Hex;
+    endpointUrl: string;
+    error: unknown;
+    isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;
+    duration?: number;
+    retryReason?: RetryReason;
+    rpcMethodName?: string;
+    traceId?: string;
+    type?: DegradedEventType;
+}): Record<string, Json>;
+/**
+ * Wraps an event name and properties into the shape expected by the
+ * `AnalyticsController:trackEvent` action.
+ *
+ * @param name - The analytics event name.
+ * @param properties - The analytics event properties.
+ * @returns The analytics tracking event.
+ */
+export declare function toAnalyticsTrackingEvent(name: RpcServiceEventName, properties: Record<string, Json>): AnalyticsTrackingEvent;
+//# sourceMappingURL=rpc-service-events.d.mts.map

package/dist/rpc-service-events.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-events.d.mts","sourceRoot":"","sources":["../src/rpc-service-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uCAAuC;AAC7E,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAQjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B,yBAAyB,GACzB,sBAAsB,CAAC;AAE3B;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;;;OAIG;IACH,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD;;;;OAIG;IACH,0BAA0B,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,OAAO,GAChB,MAAM,CAUR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,8BAA8B,CAAC,EAC7C,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,EACtB,QAAQ,EACR,WAAW,EACX,aAAa,EACb,OAAO,EACP,IAAI,GACL,EAAE;IACD,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,OAAO,CAAC;IACf,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAsBvB;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,mBAAmB,EACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAC/B,sBAAsB,CAQxB"}

package/dist/rpc-service-events.mjs

@@ -0,0 +1,81 @@
+import { hasProperty, hexToNumber, isObject, isValidJson } from "@metamask/utils";
+/**
+ * Hides any API key contained in an RPC endpoint URL by reducing it to its
+ * host, but only when the endpoint is considered public. Non-public endpoints
+ * (and URLs that cannot be parsed) are reported as the literal string
+ * `'custom'`.
+ *
+ * @param endpointUrl - The URL of the RPC endpoint.
+ * @param isPublic - Whether the endpoint is safe to report verbatim.
+ * @returns The sanitized value to report.
+ */
+export function sanitizeRpcEndpointUrl(endpointUrl, isPublic) {
+    if (!isPublic) {
+        return 'custom';
+    }
+    try {
+        return new URL(endpointUrl).host;
+    }
+    catch {
+        return 'custom';
+    }
+}
+/**
+ * Builds the properties for an "RPC Service Unavailable" or "RPC Service
+ * Degraded" analytics event.
+ *
+ * @param args - The arguments.
+ * @param args.chainId - The chain ID that the endpoint represents.
+ * @param args.endpointUrl - The URL of the endpoint.
+ * @param args.error - The connection or response error encountered after making
+ * a request to the RPC endpoint.
+ * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe
+ * to report verbatim.
+ * @param args.duration - The policy execution time in milliseconds when the
+ * request succeeded but was slow (degraded events only).
+ * @param args.retryReason - The category of error that was retried (degraded
+ * events only).
+ * @param args.rpcMethodName - The JSON-RPC method that was being executed
+ * (degraded events only).
+ * @param args.traceId - The value of the `X-Trace-Id` response header from the
+ * last request attempt (degraded events only).
+ * @param args.type - Why the endpoint became degraded (degraded events only).
+ * @returns The analytics event properties.
+ */
+export function buildRpcServiceEventProperties({ chainId, endpointUrl, error, isRpcEndpointUrlPublic, duration, retryReason, rpcMethodName, traceId, type, }) {
+    const sanitizedUrl = sanitizeRpcEndpointUrl(endpointUrl, isRpcEndpointUrlPublic(endpointUrl));
+    // The names of analytics properties have a particular case.
+    return {
+        chain_id_caip: `eip155:${hexToNumber(chainId)}`,
+        rpc_domain: sanitizedUrl,
+        rpc_endpoint_url: sanitizedUrl, // @deprecated - Will be removed in a future release.
+        ...(rpcMethodName ? { rpc_method_name: rpcMethodName } : {}),
+        ...(type ? { type } : {}),
+        ...(retryReason ? { retry_reason: retryReason } : {}),
+        ...(duration === undefined ? {} : { duration_ms: duration }),
+        ...(traceId === undefined ? {} : { trace_id: traceId }),
+        ...(isObject(error) &&
+            hasProperty(error, 'httpStatus') &&
+            isValidJson(error.httpStatus)
+            ? { http_status: error.httpStatus }
+            : {}),
+    };
+}
+/**
+ * Wraps an event name and properties into the shape expected by the
+ * `AnalyticsController:trackEvent` action.
+ *
+ * @param name - The analytics event name.
+ * @param properties - The analytics event properties.
+ * @returns The analytics tracking event.
+ */
+export function toAnalyticsTrackingEvent(name, properties) {
+    return {
+        name,
+        properties,
+        sensitiveProperties: {},
+        saveDataRecording: false,
+        hasProperties: Object.keys(properties).length > 0,
+    };
+}
+//# sourceMappingURL=rpc-service-events.mjs.map

package/dist/rpc-service-events.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-events.mjs","sourceRoot":"","sources":["../src/rpc-service-events.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,WAAW,EACX,QAAQ,EACR,WAAW,EACZ,wBAAwB;AAoCzB;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CACpC,WAAmB,EACnB,QAAiB;IAEjB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,8BAA8B,CAAC,EAC7C,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,EACtB,QAAQ,EACR,WAAW,EACX,aAAa,EACb,OAAO,EACP,IAAI,GAWL;IACC,MAAM,YAAY,GAAG,sBAAsB,CACzC,WAAW,EACX,sBAAsB,CAAC,WAAW,CAAC,CACpC,CAAC;IAEF,4DAA4D;IAC5D,OAAO;QACL,aAAa,EAAE,UAAU,WAAW,CAAC,OAAO,CAAC,EAAE;QAC/C,UAAU,EAAE,YAAY;QACxB,gBAAgB,EAAE,YAAY,EAAE,qDAAqD;QACrF,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;QAC5D,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QACvD,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;YACnB,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC;YAChC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;YAC3B,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,UAAU,EAAE;YACnC,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAyB,EACzB,UAAgC;IAEhC,OAAO;QACL,IAAI;QACJ,UAAU;QACV,mBAAmB,EAAE,EAAE;QACvB,iBAAiB,EAAE,KAAK;QACxB,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC;KAClD,CAAC;AACJ,CAAC","sourcesContent":["import type { AnalyticsTrackingEvent } from '@metamask/analytics-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport {\n  hasProperty,\n  hexToNumber,\n  isObject,\n  isValidJson,\n} from '@metamask/utils';\n\nimport type { DegradedEventType, RetryReason } from './create-network-client';\n\n/**\n * The names of the analytics events that {@link NetworkController} emits when an\n * RPC endpoint becomes unavailable or degraded.\n */\nexport type RpcServiceEventName =\n  | 'RPC Service Unavailable'\n  | 'RPC Service Degraded';\n\n/**\n * Configuration that enables {@link NetworkController} to emit analytics events\n * for unavailable or degraded RPC endpoints.\n *\n * The pieces here are client-specific and cannot be derived inside the\n * controller: deciding whether an endpoint URL is safe to report depends on the\n * client's lists of known networks, and the sample rate depends on the client's\n * build environment.\n */\nexport type NetworkControllerAnalyticsOptions = {\n  /**\n   * Returns `true` if the given RPC endpoint URL is safe to report verbatim (a\n   * \"public\" endpoint), or `false` if it must be reported as the literal string\n   * `'custom'` to avoid leaking private servers.\n   */\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;\n  /**\n   * The proportion of events to emit, between 0 and 1. `1` emits every event,\n   * `0` emits none. Clients typically use a small value (e.g. `0.01`) in\n   * production to stay within their analytics quota, and `1` in development.\n   */\n  rpcServiceEventsSampleRate: number;\n};\n\n/**\n * Hides any API key contained in an RPC endpoint URL by reducing it to its\n * host, but only when the endpoint is considered public. Non-public endpoints\n * (and URLs that cannot be parsed) are reported as the literal string\n * `'custom'`.\n *\n * @param endpointUrl - The URL of the RPC endpoint.\n * @param isPublic - Whether the endpoint is safe to report verbatim.\n * @returns The sanitized value to report.\n */\nexport function sanitizeRpcEndpointUrl(\n  endpointUrl: string,\n  isPublic: boolean,\n): string {\n  if (!isPublic) {\n    return 'custom';\n  }\n\n  try {\n    return new URL(endpointUrl).host;\n  } catch {\n    return 'custom';\n  }\n}\n\n/**\n * Builds the properties for an \"RPC Service Unavailable\" or \"RPC Service\n * Degraded\" analytics event.\n *\n * @param args - The arguments.\n * @param args.chainId - The chain ID that the endpoint represents.\n * @param args.endpointUrl - The URL of the endpoint.\n * @param args.error - The connection or response error encountered after making\n * a request to the RPC endpoint.\n * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe\n * to report verbatim.\n * @param args.duration - The policy execution time in milliseconds when the\n * request succeeded but was slow (degraded events only).\n * @param args.retryReason - The category of error that was retried (degraded\n * events only).\n * @param args.rpcMethodName - The JSON-RPC method that was being executed\n * (degraded events only).\n * @param args.traceId - The value of the `X-Trace-Id` response header from the\n * last request attempt (degraded events only).\n * @param args.type - Why the endpoint became degraded (degraded events only).\n * @returns The analytics event properties.\n */\nexport function buildRpcServiceEventProperties({\n  chainId,\n  endpointUrl,\n  error,\n  isRpcEndpointUrlPublic,\n  duration,\n  retryReason,\n  rpcMethodName,\n  traceId,\n  type,\n}: {\n  chainId: Hex;\n  endpointUrl: string;\n  error: unknown;\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;\n  duration?: number;\n  retryReason?: RetryReason;\n  rpcMethodName?: string;\n  traceId?: string;\n  type?: DegradedEventType;\n}): Record<string, Json> {\n  const sanitizedUrl = sanitizeRpcEndpointUrl(\n    endpointUrl,\n    isRpcEndpointUrlPublic(endpointUrl),\n  );\n\n  // The names of analytics properties have a particular case.\n  return {\n    chain_id_caip: `eip155:${hexToNumber(chainId)}`,\n    rpc_domain: sanitizedUrl,\n    rpc_endpoint_url: sanitizedUrl, // @deprecated - Will be removed in a future release.\n    ...(rpcMethodName ? { rpc_method_name: rpcMethodName } : {}),\n    ...(type ? { type } : {}),\n    ...(retryReason ? { retry_reason: retryReason } : {}),\n    ...(duration === undefined ? {} : { duration_ms: duration }),\n    ...(traceId === undefined ? {} : { trace_id: traceId }),\n    ...(isObject(error) &&\n    hasProperty(error, 'httpStatus') &&\n    isValidJson(error.httpStatus)\n      ? { http_status: error.httpStatus }\n      : {}),\n  };\n}\n\n/**\n * Wraps an event name and properties into the shape expected by the\n * `AnalyticsController:trackEvent` action.\n *\n * @param name - The analytics event name.\n * @param properties - The analytics event properties.\n * @returns The analytics tracking event.\n */\nexport function toAnalyticsTrackingEvent(\n  name: RpcServiceEventName,\n  properties: Record<string, Json>,\n): AnalyticsTrackingEvent {\n  return {\n    name,\n    properties,\n    sensitiveProperties: {},\n    saveDataRecording: false,\n    hasProperties: Object.keys(properties).length > 0,\n  };\n}\n"]}

package/dist/selectors.cjs

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIsRpcFailoverEnabled = void 0;
-function getIsRpcFailoverEnabled(state) {
-    const walletFrameworkRpcFailoverEnabled = state.remoteFeatureFlags
-        .walletFrameworkRpcFailoverEnabled;
-    return walletFrameworkRpcFailoverEnabled ?? false;
+exports.getRpcFailoverMode = void 0;
+/**
+ * Reads the RPC failover mode from the remote feature flags, defaulting to
+ * `disabled` when the flag is absent or not a recognized value.
+ *
+ * @param state - The remote feature flag controller state.
+ * @returns The RPC failover mode.
+ */
+function getRpcFailoverMode(state) {
+    const mode = state.remoteFeatureFlags.corePlatformRpcFailoverMode;
+    return mode === 'enabled' || mode === 'forced' ? mode : 'disabled';
 }
-exports.getIsRpcFailoverEnabled = getIsRpcFailoverEnabled;
+exports.getRpcFailoverMode = getRpcFailoverMode;
 //# sourceMappingURL=selectors.cjs.map

package/dist/selectors.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.cjs","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":";;;AAEA,SAAgB,uBAAuB,CACrC,KAAuC;IAEvC,MAAM,iCAAiC,GAAG,KAAK,CAAC,kBAAkB;SAC/D,iCAAwD,CAAC;IAC5D,OAAO,iCAAiC,IAAI,KAAK,CAAC;AACpD,CAAC;AAND,0DAMC","sourcesContent":["import { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';\n\nexport function getIsRpcFailoverEnabled(\n  state: RemoteFeatureFlagControllerState,\n): boolean {\n  const walletFrameworkRpcFailoverEnabled = state.remoteFeatureFlags\n    .walletFrameworkRpcFailoverEnabled as boolean | undefined;\n  return walletFrameworkRpcFailoverEnabled ?? false;\n}\n"]}
+{"version":3,"file":"selectors.cjs","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":";;;AAeA;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,KAAuC;IAEvC,MAAM,IAAI,GAAG,KAAK,CAAC,kBAAkB,CAAC,2BAA2B,CAAC;IAClE,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;AACrE,CAAC;AALD,gDAKC","sourcesContent":["import { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';\n\n/**\n * The RPC failover behavior for Infura networks, controlled by the\n * `corePlatformRpcFailoverMode` remote feature flag.\n *\n * - `disabled`: failover URLs are ignored; traffic stays on the primary\n *   endpoint.\n * - `enabled`: traffic automatically diverts to failover URLs when the primary\n *   endpoint is unavailable.\n * - `forced`: Infura endpoints that have failover URLs route all traffic to\n *   those failover URLs, bypassing Infura entirely.\n */\nexport type RpcFailoverMode = 'disabled' | 'enabled' | 'forced';\n\n/**\n * Reads the RPC failover mode from the remote feature flags, defaulting to\n * `disabled` when the flag is absent or not a recognized value.\n *\n * @param state - The remote feature flag controller state.\n * @returns The RPC failover mode.\n */\nexport function getRpcFailoverMode(\n  state: RemoteFeatureFlagControllerState,\n): RpcFailoverMode {\n  const mode = state.remoteFeatureFlags.corePlatformRpcFailoverMode;\n  return mode === 'enabled' || mode === 'forced' ? mode : 'disabled';\n}\n"]}

package/dist/selectors.d.cts

@@ -1,3 +1,22 @@
 import { RemoteFeatureFlagControllerState } from "@metamask/remote-feature-flag-controller";
-export declare function getIsRpcFailoverEnabled(state: RemoteFeatureFlagControllerState): boolean;
+/**
+ * The RPC failover behavior for Infura networks, controlled by the
+ * `corePlatformRpcFailoverMode` remote feature flag.
+ *
+ * - `disabled`: failover URLs are ignored; traffic stays on the primary
+ *   endpoint.
+ * - `enabled`: traffic automatically diverts to failover URLs when the primary
+ *   endpoint is unavailable.
+ * - `forced`: Infura endpoints that have failover URLs route all traffic to
+ *   those failover URLs, bypassing Infura entirely.
+ */
+export type RpcFailoverMode = 'disabled' | 'enabled' | 'forced';
+/**
+ * Reads the RPC failover mode from the remote feature flags, defaulting to
+ * `disabled` when the flag is absent or not a recognized value.
+ *
+ * @param state - The remote feature flag controller state.
+ * @returns The RPC failover mode.
+ */
+export declare function getRpcFailoverMode(state: RemoteFeatureFlagControllerState): RpcFailoverMode;
 //# sourceMappingURL=selectors.d.cts.map

package/dist/selectors.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.d.cts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,iDAAiD;AAE5F,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,gCAAgC,GACtC,OAAO,CAIT"}
+{"version":3,"file":"selectors.d.cts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,iDAAiD;AAE5F;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,gCAAgC,GACtC,eAAe,CAGjB"}

package/dist/selectors.d.mts

@@ -1,3 +1,22 @@
 import { RemoteFeatureFlagControllerState } from "@metamask/remote-feature-flag-controller";
-export declare function getIsRpcFailoverEnabled(state: RemoteFeatureFlagControllerState): boolean;
+/**
+ * The RPC failover behavior for Infura networks, controlled by the
+ * `corePlatformRpcFailoverMode` remote feature flag.
+ *
+ * - `disabled`: failover URLs are ignored; traffic stays on the primary
+ *   endpoint.
+ * - `enabled`: traffic automatically diverts to failover URLs when the primary
+ *   endpoint is unavailable.
+ * - `forced`: Infura endpoints that have failover URLs route all traffic to
+ *   those failover URLs, bypassing Infura entirely.
+ */
+export type RpcFailoverMode = 'disabled' | 'enabled' | 'forced';
+/**
+ * Reads the RPC failover mode from the remote feature flags, defaulting to
+ * `disabled` when the flag is absent or not a recognized value.
+ *
+ * @param state - The remote feature flag controller state.
+ * @returns The RPC failover mode.
+ */
+export declare function getRpcFailoverMode(state: RemoteFeatureFlagControllerState): RpcFailoverMode;
 //# sourceMappingURL=selectors.d.mts.map

package/dist/selectors.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.d.mts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,iDAAiD;AAE5F,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,gCAAgC,GACtC,OAAO,CAIT"}
+{"version":3,"file":"selectors.d.mts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,iDAAiD;AAE5F;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,gCAAgC,GACtC,eAAe,CAGjB"}

package/dist/selectors.mjs

@@ -1,6 +1,12 @@
-export function getIsRpcFailoverEnabled(state) {
-    const walletFrameworkRpcFailoverEnabled = state.remoteFeatureFlags
-        .walletFrameworkRpcFailoverEnabled;
-    return walletFrameworkRpcFailoverEnabled ?? false;
+/**
+ * Reads the RPC failover mode from the remote feature flags, defaulting to
+ * `disabled` when the flag is absent or not a recognized value.
+ *
+ * @param state - The remote feature flag controller state.
+ * @returns The RPC failover mode.
+ */
+export function getRpcFailoverMode(state) {
+    const mode = state.remoteFeatureFlags.corePlatformRpcFailoverMode;
+    return mode === 'enabled' || mode === 'forced' ? mode : 'disabled';
 }
 //# sourceMappingURL=selectors.mjs.map

package/dist/selectors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.mjs","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,uBAAuB,CACrC,KAAuC;IAEvC,MAAM,iCAAiC,GAAG,KAAK,CAAC,kBAAkB;SAC/D,iCAAwD,CAAC;IAC5D,OAAO,iCAAiC,IAAI,KAAK,CAAC;AACpD,CAAC","sourcesContent":["import { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';\n\nexport function getIsRpcFailoverEnabled(\n  state: RemoteFeatureFlagControllerState,\n): boolean {\n  const walletFrameworkRpcFailoverEnabled = state.remoteFeatureFlags\n    .walletFrameworkRpcFailoverEnabled as boolean | undefined;\n  return walletFrameworkRpcFailoverEnabled ?? false;\n}\n"]}
+{"version":3,"file":"selectors.mjs","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAeA;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAAuC;IAEvC,MAAM,IAAI,GAAG,KAAK,CAAC,kBAAkB,CAAC,2BAA2B,CAAC;IAClE,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;AACrE,CAAC","sourcesContent":["import { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';\n\n/**\n * The RPC failover behavior for Infura networks, controlled by the\n * `corePlatformRpcFailoverMode` remote feature flag.\n *\n * - `disabled`: failover URLs are ignored; traffic stays on the primary\n *   endpoint.\n * - `enabled`: traffic automatically diverts to failover URLs when the primary\n *   endpoint is unavailable.\n * - `forced`: Infura endpoints that have failover URLs route all traffic to\n *   those failover URLs, bypassing Infura entirely.\n */\nexport type RpcFailoverMode = 'disabled' | 'enabled' | 'forced';\n\n/**\n * Reads the RPC failover mode from the remote feature flags, defaulting to\n * `disabled` when the flag is absent or not a recognized value.\n *\n * @param state - The remote feature flag controller state.\n * @returns The RPC failover mode.\n */\nexport function getRpcFailoverMode(\n  state: RemoteFeatureFlagControllerState,\n): RpcFailoverMode {\n  const mode = state.remoteFeatureFlags.corePlatformRpcFailoverMode;\n  return mode === 'enabled' || mode === 'forced' ? mode : 'disabled';\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/network-controller",
-  "version": "33.0.0-preview-5c294abf8",
+  "version": "33.0.0-preview-e0ee14da7",
   "description": "Provides an interface to the currently selected network via a MetaMask-compatible provider object",
   "keywords": [
     "Ethereum",
@@ -53,6 +53,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
+    "@metamask/analytics-controller": "^1.2.1",
     "@metamask/base-controller": "^9.1.0",
     "@metamask/connectivity-controller": "^0.2.0",
     "@metamask/controller-utils": "^12.3.0",