@metamask-previews/network-controller 34.0.0-preview-e0e795054 → 34.0.0-preview-0d2cbf546

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAmCA,6DAM6B;AAL3B,qIAAA,gCAAgC,OAAA;AAChC,oIAAA,+BAA+B,OAAA;AAC/B,gHAAA,WAAW,OAAA;AACX,sHAAA,iBAAiB,OAAA;AACjB,oHAAA,eAAe,OAAA;AAEjB,kDAA4B;AAO5B,qCAA4C;AAAnC,0GAAA,iBAAiB,OAAA;AAK1B,qEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAC5B,6DAA8D;AAArD,gHAAA,iBAAiB,OAAA","sourcesContent":["export type { AutoManagedNetworkClient } from './create-auto-managed-network-client';\nexport type {\n  Block,\n  NetworkMetadata,\n  NetworkConfiguration,\n  BuiltInNetworkClientId,\n  CustomNetworkClientId,\n  NetworkClientId,\n  NetworksMetadata,\n  NetworkState,\n  BlockTrackerProxy,\n  ProviderProxy,\n  AddNetworkCustomRpcEndpointFields,\n  AddNetworkFields,\n  UpdateNetworkFields,\n  InfuraRpcEndpoint,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerNetworkWillChangeEvent,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerInfuraIsBlockedEvent,\n  NetworkControllerInfuraIsUnblockedEvent,\n  NetworkControllerNetworkAddedEvent,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerEvents,\n  NetworkControllerGetStateAction,\n  NetworkControllerActions,\n  NetworkControllerMessenger,\n  NetworkControllerOptions,\n  NetworkControllerRpcEndpointChainUnavailableEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n  NetworkControllerRpcEndpointChainDegradedEvent,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointChainAvailableEvent,\n  NetworkControllerRpcEndpointRetriedEvent,\n} from './NetworkController';\nexport {\n  getDefaultNetworkControllerState,\n  selectAvailableNetworkClientIds,\n  knownKeysOf,\n  NetworkController,\n  RpcEndpointType,\n} from './NetworkController';\nexport * from './constants';\nexport type { BlockTracker, Provider } from './types';\nexport type {\n  NetworkClientConfiguration,\n  InfuraNetworkClientConfiguration,\n  CustomNetworkClientConfiguration,\n} from './types';\nexport { NetworkClientType } from './types';\nexport type { NetworkClient } from './create-network-client';\nexport type { AbstractRpcService } from './rpc-service/abstract-rpc-service';\nexport type { RpcServiceRequestable } from './rpc-service/rpc-service-requestable';\nexport type { DegradedEventType, RetryReason } from './create-network-client';\nexport { classifyRetryReason } from './create-network-client';\nexport { isConnectionError } from './rpc-service/rpc-service';\nexport type {\n  NetworkControllerGetEthQueryAction,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetSelectedChainIdAction,\n  NetworkControllerGetEIP1559CompatibilityAction,\n  NetworkControllerFindNetworkClientIdByChainIdAction,\n  NetworkControllerSetProviderTypeAction,\n  NetworkControllerSetActiveNetworkAction,\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientIdAction,\n  NetworkControllerAddNetworkAction,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkControllerGetProviderAndBlockTrackerAction,\n  NetworkControllerGetNetworkClientRegistryAction,\n  NetworkControllerLookupNetworkAction,\n  NetworkControllerLookupNetworkByClientIdAction,\n  NetworkControllerGet1559CompatibilityWithNetworkClientIdAction,\n  NetworkControllerResetConnectionAction,\n  NetworkControllerRollbackToPreviousProviderAction,\n  NetworkControllerLoadBackupAction,\n} from './NetworkController-method-action-types';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAmCA,6DAM6B;AAL3B,qIAAA,gCAAgC,OAAA;AAChC,oIAAA,+BAA+B,OAAA;AAC/B,gHAAA,WAAW,OAAA;AACX,sHAAA,iBAAiB,OAAA;AACjB,oHAAA,eAAe,OAAA;AAEjB,kDAA4B;AAO5B,qCAA4C;AAAnC,0GAAA,iBAAiB,OAAA;AAK1B,qEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAK5B,6DAA8D;AAArD,gHAAA,iBAAiB,OAAA","sourcesContent":["export type { AutoManagedNetworkClient } from './create-auto-managed-network-client';\nexport type {\n  Block,\n  NetworkMetadata,\n  NetworkConfiguration,\n  BuiltInNetworkClientId,\n  CustomNetworkClientId,\n  NetworkClientId,\n  NetworksMetadata,\n  NetworkState,\n  BlockTrackerProxy,\n  ProviderProxy,\n  AddNetworkCustomRpcEndpointFields,\n  AddNetworkFields,\n  UpdateNetworkFields,\n  InfuraRpcEndpoint,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerNetworkWillChangeEvent,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerInfuraIsBlockedEvent,\n  NetworkControllerInfuraIsUnblockedEvent,\n  NetworkControllerNetworkAddedEvent,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerEvents,\n  NetworkControllerGetStateAction,\n  NetworkControllerActions,\n  NetworkControllerMessenger,\n  NetworkControllerOptions,\n  NetworkControllerRpcEndpointChainUnavailableEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n  NetworkControllerRpcEndpointChainDegradedEvent,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointChainAvailableEvent,\n  NetworkControllerRpcEndpointRetriedEvent,\n} from './NetworkController';\nexport {\n  getDefaultNetworkControllerState,\n  selectAvailableNetworkClientIds,\n  knownKeysOf,\n  NetworkController,\n  RpcEndpointType,\n} from './NetworkController';\nexport * from './constants';\nexport type { BlockTracker, Provider } from './types';\nexport type {\n  NetworkClientConfiguration,\n  InfuraNetworkClientConfiguration,\n  CustomNetworkClientConfiguration,\n} from './types';\nexport { NetworkClientType } from './types';\nexport type { NetworkClient } from './create-network-client';\nexport type { AbstractRpcService } from './rpc-service/abstract-rpc-service';\nexport type { RpcServiceRequestable } from './rpc-service/rpc-service-requestable';\nexport type { DegradedEventType, RetryReason } from './create-network-client';\nexport { classifyRetryReason } from './create-network-client';\nexport type {\n  NetworkControllerAnalyticsOptions,\n  RpcServiceEventName,\n} from './rpc-service-analytics';\nexport { isConnectionError } from './rpc-service/rpc-service';\nexport type {\n  NetworkControllerGetEthQueryAction,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetSelectedChainIdAction,\n  NetworkControllerGetEIP1559CompatibilityAction,\n  NetworkControllerFindNetworkClientIdByChainIdAction,\n  NetworkControllerSetProviderTypeAction,\n  NetworkControllerSetActiveNetworkAction,\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientIdAction,\n  NetworkControllerAddNetworkAction,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkControllerGetProviderAndBlockTrackerAction,\n  NetworkControllerGetNetworkClientRegistryAction,\n  NetworkControllerLookupNetworkAction,\n  NetworkControllerLookupNetworkByClientIdAction,\n  NetworkControllerGet1559CompatibilityWithNetworkClientIdAction,\n  NetworkControllerResetConnectionAction,\n  NetworkControllerRollbackToPreviousProviderAction,\n  NetworkControllerLoadBackupAction,\n} from './NetworkController-method-action-types';\n"]}

package/dist/index.d.cts

@@ -10,6 +10,7 @@ export type { AbstractRpcService } from "./rpc-service/abstract-rpc-service.cjs"
 export type { RpcServiceRequestable } from "./rpc-service/rpc-service-requestable.cjs";
 export type { DegradedEventType, RetryReason } from "./create-network-client.cjs";
 export { classifyRetryReason } from "./create-network-client.cjs";
+export type { NetworkControllerAnalyticsOptions, RpcServiceEventName, } from "./rpc-service-analytics.cjs";
 export { isConnectionError } from "./rpc-service/rpc-service.cjs";
 export type { NetworkControllerGetEthQueryAction, NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetSelectedNetworkClientAction, NetworkControllerGetSelectedChainIdAction, NetworkControllerGetEIP1559CompatibilityAction, NetworkControllerFindNetworkClientIdByChainIdAction, NetworkControllerSetProviderTypeAction, NetworkControllerSetActiveNetworkAction, NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetNetworkConfigurationByNetworkClientIdAction, NetworkControllerAddNetworkAction, NetworkControllerRemoveNetworkAction, NetworkControllerUpdateNetworkAction, NetworkControllerGetProviderAndBlockTrackerAction, NetworkControllerGetNetworkClientRegistryAction, NetworkControllerLookupNetworkAction, NetworkControllerLookupNetworkByClientIdAction, NetworkControllerGet1559CompatibilityWithNetworkClientIdAction, NetworkControllerResetConnectionAction, NetworkControllerRollbackToPreviousProviderAction, NetworkControllerLoadBackupAction, } from "./NetworkController-method-action-types.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,wBAAwB,EAAE,iDAA6C;AACrF,YAAY,EACV,KAAK,EACL,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,iCAAiC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,qCAAqC,EACrC,uCAAuC,EACvC,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,iDAAiD,EACjD,4CAA4C,EAC5C,8CAA8C,EAC9C,yCAAyC,EACzC,+CAA+C,EAC/C,wCAAwC,GACzC,gCAA4B;AAC7B,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,gCAA4B;AAC7B,gCAA4B;AAC5B,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAgB;AACtD,YAAY,EACV,0BAA0B,EAC1B,gCAAgC,EAChC,gCAAgC,GACjC,oBAAgB;AACjB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAC5C,YAAY,EAAE,aAAa,EAAE,oCAAgC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,+CAA2C;AAC7E,YAAY,EAAE,qBAAqB,EAAE,kDAA8C;AACnF,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,sCAAkC;AAC9D,YAAY,EACV,kCAAkC,EAClC,2CAA2C,EAC3C,+CAA+C,EAC/C,yCAAyC,EACzC,8CAA8C,EAC9C,mDAAmD,EACnD,sCAAsC,EACtC,uCAAuC,EACvC,uDAAuD,EACvD,+DAA+D,EAC/D,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,iDAAiD,EACjD,+CAA+C,EAC/C,oCAAoC,EACpC,8CAA8C,EAC9C,8DAA8D,EAC9D,sCAAsC,EACtC,iDAAiD,EACjD,iCAAiC,GAClC,oDAAgD"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,wBAAwB,EAAE,iDAA6C;AACrF,YAAY,EACV,KAAK,EACL,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,iCAAiC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,qCAAqC,EACrC,uCAAuC,EACvC,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,iDAAiD,EACjD,4CAA4C,EAC5C,8CAA8C,EAC9C,yCAAyC,EACzC,+CAA+C,EAC/C,wCAAwC,GACzC,gCAA4B;AAC7B,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,gCAA4B;AAC7B,gCAA4B;AAC5B,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAgB;AACtD,YAAY,EACV,0BAA0B,EAC1B,gCAAgC,EAChC,gCAAgC,GACjC,oBAAgB;AACjB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAC5C,YAAY,EAAE,aAAa,EAAE,oCAAgC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,+CAA2C;AAC7E,YAAY,EAAE,qBAAqB,EAAE,kDAA8C;AACnF,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAC9D,YAAY,EACV,iCAAiC,EACjC,mBAAmB,GACpB,oCAAgC;AACjC,OAAO,EAAE,iBAAiB,EAAE,sCAAkC;AAC9D,YAAY,EACV,kCAAkC,EAClC,2CAA2C,EAC3C,+CAA+C,EAC/C,yCAAyC,EACzC,8CAA8C,EAC9C,mDAAmD,EACnD,sCAAsC,EACtC,uCAAuC,EACvC,uDAAuD,EACvD,+DAA+D,EAC/D,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,iDAAiD,EACjD,+CAA+C,EAC/C,oCAAoC,EACpC,8CAA8C,EAC9C,8DAA8D,EAC9D,sCAAsC,EACtC,iDAAiD,EACjD,iCAAiC,GAClC,oDAAgD"}

package/dist/index.d.mts

@@ -10,6 +10,7 @@ export type { AbstractRpcService } from "./rpc-service/abstract-rpc-service.mjs"
 export type { RpcServiceRequestable } from "./rpc-service/rpc-service-requestable.mjs";
 export type { DegradedEventType, RetryReason } from "./create-network-client.mjs";
 export { classifyRetryReason } from "./create-network-client.mjs";
+export type { NetworkControllerAnalyticsOptions, RpcServiceEventName, } from "./rpc-service-analytics.mjs";
 export { isConnectionError } from "./rpc-service/rpc-service.mjs";
 export type { NetworkControllerGetEthQueryAction, NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetSelectedNetworkClientAction, NetworkControllerGetSelectedChainIdAction, NetworkControllerGetEIP1559CompatibilityAction, NetworkControllerFindNetworkClientIdByChainIdAction, NetworkControllerSetProviderTypeAction, NetworkControllerSetActiveNetworkAction, NetworkControllerGetNetworkConfigurationByChainIdAction, NetworkControllerGetNetworkConfigurationByNetworkClientIdAction, NetworkControllerAddNetworkAction, NetworkControllerRemoveNetworkAction, NetworkControllerUpdateNetworkAction, NetworkControllerGetProviderAndBlockTrackerAction, NetworkControllerGetNetworkClientRegistryAction, NetworkControllerLookupNetworkAction, NetworkControllerLookupNetworkByClientIdAction, NetworkControllerGet1559CompatibilityWithNetworkClientIdAction, NetworkControllerResetConnectionAction, NetworkControllerRollbackToPreviousProviderAction, NetworkControllerLoadBackupAction, } from "./NetworkController-method-action-types.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,wBAAwB,EAAE,iDAA6C;AACrF,YAAY,EACV,KAAK,EACL,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,iCAAiC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,qCAAqC,EACrC,uCAAuC,EACvC,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,iDAAiD,EACjD,4CAA4C,EAC5C,8CAA8C,EAC9C,yCAAyC,EACzC,+CAA+C,EAC/C,wCAAwC,GACzC,gCAA4B;AAC7B,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,gCAA4B;AAC7B,gCAA4B;AAC5B,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAgB;AACtD,YAAY,EACV,0BAA0B,EAC1B,gCAAgC,EAChC,gCAAgC,GACjC,oBAAgB;AACjB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAC5C,YAAY,EAAE,aAAa,EAAE,oCAAgC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,+CAA2C;AAC7E,YAAY,EAAE,qBAAqB,EAAE,kDAA8C;AACnF,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,sCAAkC;AAC9D,YAAY,EACV,kCAAkC,EAClC,2CAA2C,EAC3C,+CAA+C,EAC/C,yCAAyC,EACzC,8CAA8C,EAC9C,mDAAmD,EACnD,sCAAsC,EACtC,uCAAuC,EACvC,uDAAuD,EACvD,+DAA+D,EAC/D,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,iDAAiD,EACjD,+CAA+C,EAC/C,oCAAoC,EACpC,8CAA8C,EAC9C,8DAA8D,EAC9D,sCAAsC,EACtC,iDAAiD,EACjD,iCAAiC,GAClC,oDAAgD"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,wBAAwB,EAAE,iDAA6C;AACrF,YAAY,EACV,KAAK,EACL,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,iCAAiC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,qCAAqC,EACrC,uCAAuC,EACvC,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,iDAAiD,EACjD,4CAA4C,EAC5C,8CAA8C,EAC9C,yCAAyC,EACzC,+CAA+C,EAC/C,wCAAwC,GACzC,gCAA4B;AAC7B,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,GAChB,gCAA4B;AAC7B,gCAA4B;AAC5B,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAgB;AACtD,YAAY,EACV,0BAA0B,EAC1B,gCAAgC,EAChC,gCAAgC,GACjC,oBAAgB;AACjB,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAC5C,YAAY,EAAE,aAAa,EAAE,oCAAgC;AAC7D,YAAY,EAAE,kBAAkB,EAAE,+CAA2C;AAC7E,YAAY,EAAE,qBAAqB,EAAE,kDAA8C;AACnF,YAAY,EAAE,iBAAiB,EAAE,WAAW,EAAE,oCAAgC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAC9D,YAAY,EACV,iCAAiC,EACjC,mBAAmB,GACpB,oCAAgC;AACjC,OAAO,EAAE,iBAAiB,EAAE,sCAAkC;AAC9D,YAAY,EACV,kCAAkC,EAClC,2CAA2C,EAC3C,+CAA+C,EAC/C,yCAAyC,EACzC,8CAA8C,EAC9C,mDAAmD,EACnD,sCAAsC,EACtC,uCAAuC,EACvC,uDAAuD,EACvD,+DAA+D,EAC/D,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,iDAAiD,EACjD,+CAA+C,EAC/C,oCAAoC,EACpC,8CAA8C,EAC9C,8DAA8D,EAC9D,sCAAsC,EACtC,iDAAiD,EACjD,iCAAiC,GAClC,oDAAgD"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmCA,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,EAChB,gCAA4B;AAC7B,gCAA4B;AAO5B,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAK5C,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,sCAAkC","sourcesContent":["export type { AutoManagedNetworkClient } from './create-auto-managed-network-client';\nexport type {\n  Block,\n  NetworkMetadata,\n  NetworkConfiguration,\n  BuiltInNetworkClientId,\n  CustomNetworkClientId,\n  NetworkClientId,\n  NetworksMetadata,\n  NetworkState,\n  BlockTrackerProxy,\n  ProviderProxy,\n  AddNetworkCustomRpcEndpointFields,\n  AddNetworkFields,\n  UpdateNetworkFields,\n  InfuraRpcEndpoint,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerNetworkWillChangeEvent,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerInfuraIsBlockedEvent,\n  NetworkControllerInfuraIsUnblockedEvent,\n  NetworkControllerNetworkAddedEvent,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerEvents,\n  NetworkControllerGetStateAction,\n  NetworkControllerActions,\n  NetworkControllerMessenger,\n  NetworkControllerOptions,\n  NetworkControllerRpcEndpointChainUnavailableEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n  NetworkControllerRpcEndpointChainDegradedEvent,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointChainAvailableEvent,\n  NetworkControllerRpcEndpointRetriedEvent,\n} from './NetworkController';\nexport {\n  getDefaultNetworkControllerState,\n  selectAvailableNetworkClientIds,\n  knownKeysOf,\n  NetworkController,\n  RpcEndpointType,\n} from './NetworkController';\nexport * from './constants';\nexport type { BlockTracker, Provider } from './types';\nexport type {\n  NetworkClientConfiguration,\n  InfuraNetworkClientConfiguration,\n  CustomNetworkClientConfiguration,\n} from './types';\nexport { NetworkClientType } from './types';\nexport type { NetworkClient } from './create-network-client';\nexport type { AbstractRpcService } from './rpc-service/abstract-rpc-service';\nexport type { RpcServiceRequestable } from './rpc-service/rpc-service-requestable';\nexport type { DegradedEventType, RetryReason } from './create-network-client';\nexport { classifyRetryReason } from './create-network-client';\nexport { isConnectionError } from './rpc-service/rpc-service';\nexport type {\n  NetworkControllerGetEthQueryAction,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetSelectedChainIdAction,\n  NetworkControllerGetEIP1559CompatibilityAction,\n  NetworkControllerFindNetworkClientIdByChainIdAction,\n  NetworkControllerSetProviderTypeAction,\n  NetworkControllerSetActiveNetworkAction,\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientIdAction,\n  NetworkControllerAddNetworkAction,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkControllerGetProviderAndBlockTrackerAction,\n  NetworkControllerGetNetworkClientRegistryAction,\n  NetworkControllerLookupNetworkAction,\n  NetworkControllerLookupNetworkByClientIdAction,\n  NetworkControllerGet1559CompatibilityWithNetworkClientIdAction,\n  NetworkControllerResetConnectionAction,\n  NetworkControllerRollbackToPreviousProviderAction,\n  NetworkControllerLoadBackupAction,\n} from './NetworkController-method-action-types';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmCA,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,WAAW,EACX,iBAAiB,EACjB,eAAe,EAChB,gCAA4B;AAC7B,gCAA4B;AAO5B,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAK5C,OAAO,EAAE,mBAAmB,EAAE,oCAAgC;AAK9D,OAAO,EAAE,iBAAiB,EAAE,sCAAkC","sourcesContent":["export type { AutoManagedNetworkClient } from './create-auto-managed-network-client';\nexport type {\n  Block,\n  NetworkMetadata,\n  NetworkConfiguration,\n  BuiltInNetworkClientId,\n  CustomNetworkClientId,\n  NetworkClientId,\n  NetworksMetadata,\n  NetworkState,\n  BlockTrackerProxy,\n  ProviderProxy,\n  AddNetworkCustomRpcEndpointFields,\n  AddNetworkFields,\n  UpdateNetworkFields,\n  InfuraRpcEndpoint,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerNetworkWillChangeEvent,\n  NetworkControllerNetworkDidChangeEvent,\n  NetworkControllerInfuraIsBlockedEvent,\n  NetworkControllerInfuraIsUnblockedEvent,\n  NetworkControllerNetworkAddedEvent,\n  NetworkControllerNetworkRemovedEvent,\n  NetworkControllerEvents,\n  NetworkControllerGetStateAction,\n  NetworkControllerActions,\n  NetworkControllerMessenger,\n  NetworkControllerOptions,\n  NetworkControllerRpcEndpointChainUnavailableEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n  NetworkControllerRpcEndpointChainDegradedEvent,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointChainAvailableEvent,\n  NetworkControllerRpcEndpointRetriedEvent,\n} from './NetworkController';\nexport {\n  getDefaultNetworkControllerState,\n  selectAvailableNetworkClientIds,\n  knownKeysOf,\n  NetworkController,\n  RpcEndpointType,\n} from './NetworkController';\nexport * from './constants';\nexport type { BlockTracker, Provider } from './types';\nexport type {\n  NetworkClientConfiguration,\n  InfuraNetworkClientConfiguration,\n  CustomNetworkClientConfiguration,\n} from './types';\nexport { NetworkClientType } from './types';\nexport type { NetworkClient } from './create-network-client';\nexport type { AbstractRpcService } from './rpc-service/abstract-rpc-service';\nexport type { RpcServiceRequestable } from './rpc-service/rpc-service-requestable';\nexport type { DegradedEventType, RetryReason } from './create-network-client';\nexport { classifyRetryReason } from './create-network-client';\nexport type {\n  NetworkControllerAnalyticsOptions,\n  RpcServiceEventName,\n} from './rpc-service-analytics';\nexport { isConnectionError } from './rpc-service/rpc-service';\nexport type {\n  NetworkControllerGetEthQueryAction,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetSelectedChainIdAction,\n  NetworkControllerGetEIP1559CompatibilityAction,\n  NetworkControllerFindNetworkClientIdByChainIdAction,\n  NetworkControllerSetProviderTypeAction,\n  NetworkControllerSetActiveNetworkAction,\n  NetworkControllerGetNetworkConfigurationByChainIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientIdAction,\n  NetworkControllerAddNetworkAction,\n  NetworkControllerRemoveNetworkAction,\n  NetworkControllerUpdateNetworkAction,\n  NetworkControllerGetProviderAndBlockTrackerAction,\n  NetworkControllerGetNetworkClientRegistryAction,\n  NetworkControllerLookupNetworkAction,\n  NetworkControllerLookupNetworkByClientIdAction,\n  NetworkControllerGet1559CompatibilityWithNetworkClientIdAction,\n  NetworkControllerResetConnectionAction,\n  NetworkControllerRollbackToPreviousProviderAction,\n  NetworkControllerLoadBackupAction,\n} from './NetworkController-method-action-types';\n"]}

package/dist/rpc-service-analytics.cjs

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trackRpcServiceDegraded = exports.trackRpcServiceUnavailable = exports.buildRpcServiceDegradedAnalyticsTrackingEvent = exports.buildRpcServiceUnavailableAnalyticsTrackingEvent = exports.sanitizeRpcEndpointUrl = void 0;
+const remote_feature_flag_controller_1 = require("@metamask/remote-feature-flag-controller");
+const utils_1 = require("@metamask/utils");
+const rpc_service_1 = require("./rpc-service/rpc-service.cjs");
+/**
+ * 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.
+ */
+function sanitizeRpcEndpointUrl(endpointUrl, isPublic) {
+    if (!isPublic) {
+        return 'custom';
+    }
+    try {
+        return new URL(endpointUrl).host;
+    }
+    catch {
+        return 'custom';
+    }
+}
+exports.sanitizeRpcEndpointUrl = sanitizeRpcEndpointUrl;
+/**
+ * Wraps a 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.
+ */
+function toAnalyticsTrackingEvent(name, properties) {
+    return {
+        name,
+        properties,
+        sensitiveProperties: {},
+        saveDataRecording: false,
+        hasProperties: Object.keys(properties).length > 0,
+    };
+}
+/**
+ * Builds the properties common to both RPC service events.
+ *
+ * @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.
+ * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe
+ * to report verbatim.
+ * @returns The common analytics event properties.
+ */
+function buildCommonRpcServiceEventProperties({ chainId, endpointUrl, error, isRpcEndpointUrlPublic, }) {
+    const sanitizedUrl = sanitizeRpcEndpointUrl(endpointUrl, isRpcEndpointUrlPublic(endpointUrl));
+    // The names of analytics properties have a particular case.
+    return {
+        chain_id_caip: `eip155:${(0, utils_1.hexToNumber)(chainId)}`,
+        rpc_domain: sanitizedUrl,
+        rpc_endpoint_url: sanitizedUrl, // @deprecated - Will be removed in a future release.
+        ...((0, utils_1.isObject)(error) &&
+            (0, utils_1.hasProperty)(error, 'httpStatus') &&
+            (0, utils_1.isValidJson)(error.httpStatus)
+            ? { http_status: error.httpStatus }
+            : {}),
+    };
+}
+/**
+ * Builds the "RPC Service Unavailable" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+function buildRpcServiceUnavailableAnalyticsTrackingEvent(payload, isRpcEndpointUrlPublic) {
+    return toAnalyticsTrackingEvent('RPC Service Unavailable', buildCommonRpcServiceEventProperties({
+        chainId: payload.chainId,
+        endpointUrl: payload.endpointUrl,
+        error: payload.error,
+        isRpcEndpointUrlPublic,
+    }));
+}
+exports.buildRpcServiceUnavailableAnalyticsTrackingEvent = buildRpcServiceUnavailableAnalyticsTrackingEvent;
+/**
+ * Builds the "RPC Service Degraded" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+function buildRpcServiceDegradedAnalyticsTrackingEvent(payload, isRpcEndpointUrlPublic) {
+    const { duration, retryReason, rpcMethodName, traceId, type } = payload;
+    // The names of analytics properties have a particular case.
+    return toAnalyticsTrackingEvent('RPC Service Degraded', {
+        ...buildCommonRpcServiceEventProperties({
+            chainId: payload.chainId,
+            endpointUrl: payload.endpointUrl,
+            error: payload.error,
+            isRpcEndpointUrlPublic,
+        }),
+        rpc_method_name: rpcMethodName,
+        type,
+        ...(retryReason ? { retry_reason: retryReason } : {}),
+        ...(duration === undefined ? {} : { duration_ms: duration }),
+        ...(traceId === undefined ? {} : { trace_id: traceId }),
+    });
+}
+exports.buildRpcServiceDegradedAnalyticsTrackingEvent = buildRpcServiceDegradedAnalyticsTrackingEvent;
+/**
+ * Delivers an RPC service analytics event via the
+ * `AnalyticsController:trackEvent` action, skipping local connection errors,
+ * users without an analytics ID, and events that fall outside the configured
+ * sample. Failures never propagate to the caller.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param error - The error encountered, used to skip local connection errors.
+ * @param buildTrackingEvent - Builds the event to deliver (only called when the
+ * event passes the sampling and analytics-ID checks).
+ */
+function trackRpcServiceEvent(messenger, analyticsOptions, error, buildTrackingEvent) {
+    try {
+        if ((0, rpc_service_1.isConnectionError)(error)) {
+            return;
+        }
+        const { analyticsId } = messenger.call('AnalyticsController:getState');
+        if (!analyticsId) {
+            return;
+        }
+        if ((0, remote_feature_flag_controller_1.generateDeterministicRandomNumber)(analyticsId) >=
+            analyticsOptions.rpcServiceEventsSampleRate) {
+            return;
+        }
+        messenger.call('AnalyticsController:trackEvent', buildTrackingEvent());
+    }
+    catch (caughtError) {
+        messenger.captureException?.((0, utils_1.wrapError)(caughtError, 'Could not create analytics event'));
+    }
+}
+/**
+ * Emits an "RPC Service Unavailable" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ */
+function trackRpcServiceUnavailable(messenger, analyticsOptions, payload) {
+    trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () => buildRpcServiceUnavailableAnalyticsTrackingEvent(payload, analyticsOptions.isRpcEndpointUrlPublic));
+}
+exports.trackRpcServiceUnavailable = trackRpcServiceUnavailable;
+/**
+ * Emits an "RPC Service Degraded" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ */
+function trackRpcServiceDegraded(messenger, analyticsOptions, payload) {
+    trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () => buildRpcServiceDegradedAnalyticsTrackingEvent(payload, analyticsOptions.isRpcEndpointUrlPublic));
+}
+exports.trackRpcServiceDegraded = trackRpcServiceDegraded;
+//# sourceMappingURL=rpc-service-analytics.cjs.map

package/dist/rpc-service-analytics.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-analytics.cjs","sourceRoot":"","sources":["../src/rpc-service-analytics.ts"],"names":[],"mappings":";;;AACA,6FAA6F;AAE7F,2CAMyB;AAOzB,+DAA8D;AAwC9D;;;;;;;;;GASG;AACH,SAAgB,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;AAbD,wDAaC;AAED;;;;;;;GAOG;AACH,SAAS,wBAAwB,CAC/B,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;AAED;;;;;;;;;;GAUG;AACH,SAAS,oCAAoC,CAAC,EAC5C,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,GAMvB;IACC,MAAM,YAAY,GAAG,sBAAsB,CACzC,WAAW,EACX,sBAAsB,CAAC,WAAW,CAAC,CACpC,CAAC;IAEF,4DAA4D;IAC5D,OAAO;QACL,aAAa,EAAE,UAAU,IAAA,mBAAW,EAAC,OAAO,CAAC,EAAE;QAC/C,UAAU,EAAE,YAAY;QACxB,gBAAgB,EAAE,YAAY,EAAE,qDAAqD;QACrF,GAAG,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC;YACnB,IAAA,mBAAW,EAAC,KAAK,EAAE,YAAY,CAAC;YAChC,IAAA,mBAAW,EAAC,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,SAAgB,gDAAgD,CAC9D,OAAsC,EACtC,sBAAwD;IAExD,OAAO,wBAAwB,CAC7B,yBAAyB,EACzB,oCAAoC,CAAC;QACnC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,sBAAsB;KACvB,CAAC,CACH,CAAC;AACJ,CAAC;AAbD,4GAaC;AAED;;;;;;;GAOG;AACH,SAAgB,6CAA6C,CAC3D,OAAmC,EACnC,sBAAwD;IAExD,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAExE,4DAA4D;IAC5D,OAAO,wBAAwB,CAAC,sBAAsB,EAAE;QACtD,GAAG,oCAAoC,CAAC;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,sBAAsB;SACvB,CAAC;QACF,eAAe,EAAE,aAAa;QAC9B,IAAI;QACJ,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;KACxD,CAAC,CAAC;AACL,CAAC;AApBD,sGAoBC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,oBAAoB,CAC3B,SAAqC,EACrC,gBAAmD,EACnD,KAAc,EACd,kBAAgD;IAEhD,IAAI,CAAC;QACH,IAAI,IAAA,+BAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,IACE,IAAA,kEAAiC,EAAC,WAAW,CAAC;YAC9C,gBAAgB,CAAC,0BAA0B,EAC3C,CAAC;YACD,OAAO;QACT,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,gCAAgC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,WAAW,EAAE,CAAC;QACrB,SAAS,CAAC,gBAAgB,EAAE,CAC1B,IAAA,iBAAS,EAAC,WAAW,EAAE,kCAAkC,CAAC,CAC3D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACxC,SAAqC,EACrC,gBAAmD,EACnD,OAAsC;IAEtC,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CACpE,gDAAgD,CAC9C,OAAO,EACP,gBAAgB,CAAC,sBAAsB,CACxC,CACF,CAAC;AACJ,CAAC;AAXD,gEAWC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CACrC,SAAqC,EACrC,gBAAmD,EACnD,OAAmC;IAEnC,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CACpE,6CAA6C,CAC3C,OAAO,EACP,gBAAgB,CAAC,sBAAsB,CACxC,CACF,CAAC;AACJ,CAAC;AAXD,0DAWC","sourcesContent":["import type { AnalyticsTrackingEvent } from '@metamask/analytics-controller';\nimport { generateDeterministicRandomNumber } from '@metamask/remote-feature-flag-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport {\n  hasProperty,\n  hexToNumber,\n  isObject,\n  isValidJson,\n  wrapError,\n} from '@metamask/utils';\n\nimport type {\n  NetworkControllerMessenger,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n} from './NetworkController';\nimport { isConnectionError } from './rpc-service/rpc-service';\n\ntype RpcEndpointUnavailablePayload =\n  NetworkControllerRpcEndpointUnavailableEvent['payload'][0];\n\ntype RpcEndpointDegradedPayload =\n  NetworkControllerRpcEndpointDegradedEvent['payload'][0];\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 * Wraps a 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 */\nfunction 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\n/**\n * Builds the properties common to both RPC service events.\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.\n * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe\n * to report verbatim.\n * @returns The common analytics event properties.\n */\nfunction buildCommonRpcServiceEventProperties({\n  chainId,\n  endpointUrl,\n  error,\n  isRpcEndpointUrlPublic,\n}: {\n  chainId: Hex;\n  endpointUrl: string;\n  error: unknown;\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;\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    ...(isObject(error) &&\n    hasProperty(error, 'httpStatus') &&\n    isValidJson(error.httpStatus)\n      ? { http_status: error.httpStatus }\n      : {}),\n  };\n}\n\n/**\n * Builds the \"RPC Service Unavailable\" analytics tracking event.\n *\n * @param payload - The `rpcEndpointUnavailable` event payload.\n * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to\n * report verbatim.\n * @returns The analytics tracking event.\n */\nexport function buildRpcServiceUnavailableAnalyticsTrackingEvent(\n  payload: RpcEndpointUnavailablePayload,\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean,\n): AnalyticsTrackingEvent {\n  return toAnalyticsTrackingEvent(\n    'RPC Service Unavailable',\n    buildCommonRpcServiceEventProperties({\n      chainId: payload.chainId,\n      endpointUrl: payload.endpointUrl,\n      error: payload.error,\n      isRpcEndpointUrlPublic,\n    }),\n  );\n}\n\n/**\n * Builds the \"RPC Service Degraded\" analytics tracking event.\n *\n * @param payload - The `rpcEndpointDegraded` event payload.\n * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to\n * report verbatim.\n * @returns The analytics tracking event.\n */\nexport function buildRpcServiceDegradedAnalyticsTrackingEvent(\n  payload: RpcEndpointDegradedPayload,\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean,\n): AnalyticsTrackingEvent {\n  const { duration, retryReason, rpcMethodName, traceId, type } = payload;\n\n  // The names of analytics properties have a particular case.\n  return toAnalyticsTrackingEvent('RPC Service Degraded', {\n    ...buildCommonRpcServiceEventProperties({\n      chainId: payload.chainId,\n      endpointUrl: payload.endpointUrl,\n      error: payload.error,\n      isRpcEndpointUrlPublic,\n    }),\n    rpc_method_name: rpcMethodName,\n    type,\n    ...(retryReason ? { retry_reason: retryReason } : {}),\n    ...(duration === undefined ? {} : { duration_ms: duration }),\n    ...(traceId === undefined ? {} : { trace_id: traceId }),\n  });\n}\n\n/**\n * Delivers an RPC service analytics event via the\n * `AnalyticsController:trackEvent` action, skipping local connection errors,\n * users without an analytics ID, and events that fall outside the configured\n * sample. Failures never propagate to the caller.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param error - The error encountered, used to skip local connection errors.\n * @param buildTrackingEvent - Builds the event to deliver (only called when the\n * event passes the sampling and analytics-ID checks).\n */\nfunction trackRpcServiceEvent(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  error: unknown,\n  buildTrackingEvent: () => AnalyticsTrackingEvent,\n): void {\n  try {\n    if (isConnectionError(error)) {\n      return;\n    }\n\n    const { analyticsId } = messenger.call('AnalyticsController:getState');\n    if (!analyticsId) {\n      return;\n    }\n\n    if (\n      generateDeterministicRandomNumber(analyticsId) >=\n      analyticsOptions.rpcServiceEventsSampleRate\n    ) {\n      return;\n    }\n\n    messenger.call('AnalyticsController:trackEvent', buildTrackingEvent());\n  } catch (caughtError) {\n    messenger.captureException?.(\n      wrapError(caughtError, 'Could not create analytics event'),\n    );\n  }\n}\n\n/**\n * Emits an \"RPC Service Unavailable\" analytics event.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param payload - The `rpcEndpointUnavailable` event payload.\n */\nexport function trackRpcServiceUnavailable(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  payload: RpcEndpointUnavailablePayload,\n): void {\n  trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () =>\n    buildRpcServiceUnavailableAnalyticsTrackingEvent(\n      payload,\n      analyticsOptions.isRpcEndpointUrlPublic,\n    ),\n  );\n}\n\n/**\n * Emits an \"RPC Service Degraded\" analytics event.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param payload - The `rpcEndpointDegraded` event payload.\n */\nexport function trackRpcServiceDegraded(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  payload: RpcEndpointDegradedPayload,\n): void {\n  trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () =>\n    buildRpcServiceDegradedAnalyticsTrackingEvent(\n      payload,\n      analyticsOptions.isRpcEndpointUrlPublic,\n    ),\n  );\n}\n"]}

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

@@ -0,0 +1,79 @@
+import type { AnalyticsTrackingEvent } from "@metamask/analytics-controller";
+import type { NetworkControllerMessenger, NetworkControllerRpcEndpointDegradedEvent, NetworkControllerRpcEndpointUnavailableEvent } from "./NetworkController.cjs";
+type RpcEndpointUnavailablePayload = NetworkControllerRpcEndpointUnavailableEvent['payload'][0];
+type RpcEndpointDegradedPayload = NetworkControllerRpcEndpointDegradedEvent['payload'][0];
+/**
+ * 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 "RPC Service Unavailable" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export declare function buildRpcServiceUnavailableAnalyticsTrackingEvent(payload: RpcEndpointUnavailablePayload, isRpcEndpointUrlPublic: (endpointUrl: string) => boolean): AnalyticsTrackingEvent;
+/**
+ * Builds the "RPC Service Degraded" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export declare function buildRpcServiceDegradedAnalyticsTrackingEvent(payload: RpcEndpointDegradedPayload, isRpcEndpointUrlPublic: (endpointUrl: string) => boolean): AnalyticsTrackingEvent;
+/**
+ * Emits an "RPC Service Unavailable" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ */
+export declare function trackRpcServiceUnavailable(messenger: NetworkControllerMessenger, analyticsOptions: NetworkControllerAnalyticsOptions, payload: RpcEndpointUnavailablePayload): void;
+/**
+ * Emits an "RPC Service Degraded" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ */
+export declare function trackRpcServiceDegraded(messenger: NetworkControllerMessenger, analyticsOptions: NetworkControllerAnalyticsOptions, payload: RpcEndpointDegradedPayload): void;
+export {};
+//# sourceMappingURL=rpc-service-analytics.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-analytics.d.cts","sourceRoot":"","sources":["../src/rpc-service-analytics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uCAAuC;AAW7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,yCAAyC,EACzC,4CAA4C,EAC7C,gCAA4B;AAG7B,KAAK,6BAA6B,GAChC,4CAA4C,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7D,KAAK,0BAA0B,GAC7B,yCAAyC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D;;;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;AA+DD;;;;;;;GAOG;AACH,wBAAgB,gDAAgD,CAC9D,OAAO,EAAE,6BAA6B,EACtC,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,GACvD,sBAAsB,CAUxB;AAED;;;;;;;GAOG;AACH,wBAAgB,6CAA6C,CAC3D,OAAO,EAAE,0BAA0B,EACnC,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,GACvD,sBAAsB,CAiBxB;AA6CD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,0BAA0B,EACrC,gBAAgB,EAAE,iCAAiC,EACnD,OAAO,EAAE,6BAA6B,GACrC,IAAI,CAON;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,0BAA0B,EACrC,gBAAgB,EAAE,iCAAiC,EACnD,OAAO,EAAE,0BAA0B,GAClC,IAAI,CAON"}

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

@@ -0,0 +1,79 @@
+import type { AnalyticsTrackingEvent } from "@metamask/analytics-controller";
+import type { NetworkControllerMessenger, NetworkControllerRpcEndpointDegradedEvent, NetworkControllerRpcEndpointUnavailableEvent } from "./NetworkController.mjs";
+type RpcEndpointUnavailablePayload = NetworkControllerRpcEndpointUnavailableEvent['payload'][0];
+type RpcEndpointDegradedPayload = NetworkControllerRpcEndpointDegradedEvent['payload'][0];
+/**
+ * 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 "RPC Service Unavailable" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export declare function buildRpcServiceUnavailableAnalyticsTrackingEvent(payload: RpcEndpointUnavailablePayload, isRpcEndpointUrlPublic: (endpointUrl: string) => boolean): AnalyticsTrackingEvent;
+/**
+ * Builds the "RPC Service Degraded" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export declare function buildRpcServiceDegradedAnalyticsTrackingEvent(payload: RpcEndpointDegradedPayload, isRpcEndpointUrlPublic: (endpointUrl: string) => boolean): AnalyticsTrackingEvent;
+/**
+ * Emits an "RPC Service Unavailable" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ */
+export declare function trackRpcServiceUnavailable(messenger: NetworkControllerMessenger, analyticsOptions: NetworkControllerAnalyticsOptions, payload: RpcEndpointUnavailablePayload): void;
+/**
+ * Emits an "RPC Service Degraded" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ */
+export declare function trackRpcServiceDegraded(messenger: NetworkControllerMessenger, analyticsOptions: NetworkControllerAnalyticsOptions, payload: RpcEndpointDegradedPayload): void;
+export {};
+//# sourceMappingURL=rpc-service-analytics.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-analytics.d.mts","sourceRoot":"","sources":["../src/rpc-service-analytics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uCAAuC;AAW7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,yCAAyC,EACzC,4CAA4C,EAC7C,gCAA4B;AAG7B,KAAK,6BAA6B,GAChC,4CAA4C,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7D,KAAK,0BAA0B,GAC7B,yCAAyC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D;;;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;AA+DD;;;;;;;GAOG;AACH,wBAAgB,gDAAgD,CAC9D,OAAO,EAAE,6BAA6B,EACtC,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,GACvD,sBAAsB,CAUxB;AAED;;;;;;;GAOG;AACH,wBAAgB,6CAA6C,CAC3D,OAAO,EAAE,0BAA0B,EACnC,sBAAsB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,GACvD,sBAAsB,CAiBxB;AA6CD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,0BAA0B,EACrC,gBAAgB,EAAE,iCAAiC,EACnD,OAAO,EAAE,6BAA6B,GACrC,IAAI,CAON;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,0BAA0B,EACrC,gBAAgB,EAAE,iCAAiC,EACnD,OAAO,EAAE,0BAA0B,GAClC,IAAI,CAON"}

package/dist/rpc-service-analytics.mjs

@@ -0,0 +1,159 @@
+import { generateDeterministicRandomNumber } from "@metamask/remote-feature-flag-controller";
+import { hasProperty, hexToNumber, isObject, isValidJson, wrapError } from "@metamask/utils";
+import { isConnectionError } from "./rpc-service/rpc-service.mjs";
+/**
+ * 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';
+    }
+}
+/**
+ * Wraps a 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.
+ */
+function toAnalyticsTrackingEvent(name, properties) {
+    return {
+        name,
+        properties,
+        sensitiveProperties: {},
+        saveDataRecording: false,
+        hasProperties: Object.keys(properties).length > 0,
+    };
+}
+/**
+ * Builds the properties common to both RPC service events.
+ *
+ * @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.
+ * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe
+ * to report verbatim.
+ * @returns The common analytics event properties.
+ */
+function buildCommonRpcServiceEventProperties({ chainId, endpointUrl, error, isRpcEndpointUrlPublic, }) {
+    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.
+        ...(isObject(error) &&
+            hasProperty(error, 'httpStatus') &&
+            isValidJson(error.httpStatus)
+            ? { http_status: error.httpStatus }
+            : {}),
+    };
+}
+/**
+ * Builds the "RPC Service Unavailable" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export function buildRpcServiceUnavailableAnalyticsTrackingEvent(payload, isRpcEndpointUrlPublic) {
+    return toAnalyticsTrackingEvent('RPC Service Unavailable', buildCommonRpcServiceEventProperties({
+        chainId: payload.chainId,
+        endpointUrl: payload.endpointUrl,
+        error: payload.error,
+        isRpcEndpointUrlPublic,
+    }));
+}
+/**
+ * Builds the "RPC Service Degraded" analytics tracking event.
+ *
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to
+ * report verbatim.
+ * @returns The analytics tracking event.
+ */
+export function buildRpcServiceDegradedAnalyticsTrackingEvent(payload, isRpcEndpointUrlPublic) {
+    const { duration, retryReason, rpcMethodName, traceId, type } = payload;
+    // The names of analytics properties have a particular case.
+    return toAnalyticsTrackingEvent('RPC Service Degraded', {
+        ...buildCommonRpcServiceEventProperties({
+            chainId: payload.chainId,
+            endpointUrl: payload.endpointUrl,
+            error: payload.error,
+            isRpcEndpointUrlPublic,
+        }),
+        rpc_method_name: rpcMethodName,
+        type,
+        ...(retryReason ? { retry_reason: retryReason } : {}),
+        ...(duration === undefined ? {} : { duration_ms: duration }),
+        ...(traceId === undefined ? {} : { trace_id: traceId }),
+    });
+}
+/**
+ * Delivers an RPC service analytics event via the
+ * `AnalyticsController:trackEvent` action, skipping local connection errors,
+ * users without an analytics ID, and events that fall outside the configured
+ * sample. Failures never propagate to the caller.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param error - The error encountered, used to skip local connection errors.
+ * @param buildTrackingEvent - Builds the event to deliver (only called when the
+ * event passes the sampling and analytics-ID checks).
+ */
+function trackRpcServiceEvent(messenger, analyticsOptions, error, buildTrackingEvent) {
+    try {
+        if (isConnectionError(error)) {
+            return;
+        }
+        const { analyticsId } = messenger.call('AnalyticsController:getState');
+        if (!analyticsId) {
+            return;
+        }
+        if (generateDeterministicRandomNumber(analyticsId) >=
+            analyticsOptions.rpcServiceEventsSampleRate) {
+            return;
+        }
+        messenger.call('AnalyticsController:trackEvent', buildTrackingEvent());
+    }
+    catch (caughtError) {
+        messenger.captureException?.(wrapError(caughtError, 'Could not create analytics event'));
+    }
+}
+/**
+ * Emits an "RPC Service Unavailable" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointUnavailable` event payload.
+ */
+export function trackRpcServiceUnavailable(messenger, analyticsOptions, payload) {
+    trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () => buildRpcServiceUnavailableAnalyticsTrackingEvent(payload, analyticsOptions.isRpcEndpointUrlPublic));
+}
+/**
+ * Emits an "RPC Service Degraded" analytics event.
+ *
+ * @param messenger - The controller messenger.
+ * @param analyticsOptions - The analytics configuration.
+ * @param payload - The `rpcEndpointDegraded` event payload.
+ */
+export function trackRpcServiceDegraded(messenger, analyticsOptions, payload) {
+    trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () => buildRpcServiceDegradedAnalyticsTrackingEvent(payload, analyticsOptions.isRpcEndpointUrlPublic));
+}
+//# sourceMappingURL=rpc-service-analytics.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-service-analytics.mjs","sourceRoot":"","sources":["../src/rpc-service-analytics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,iDAAiD;AAE7F,OAAO,EACL,WAAW,EACX,WAAW,EACX,QAAQ,EACR,WAAW,EACX,SAAS,EACV,wBAAwB;AAOzB,OAAO,EAAE,iBAAiB,EAAE,sCAAkC;AAwC9D;;;;;;;;;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;;;;;;;GAOG;AACH,SAAS,wBAAwB,CAC/B,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;AAED;;;;;;;;;;GAUG;AACH,SAAS,oCAAoC,CAAC,EAC5C,OAAO,EACP,WAAW,EACX,KAAK,EACL,sBAAsB,GAMvB;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,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,gDAAgD,CAC9D,OAAsC,EACtC,sBAAwD;IAExD,OAAO,wBAAwB,CAC7B,yBAAyB,EACzB,oCAAoC,CAAC;QACnC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,sBAAsB;KACvB,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,6CAA6C,CAC3D,OAAmC,EACnC,sBAAwD;IAExD,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAExE,4DAA4D;IAC5D,OAAO,wBAAwB,CAAC,sBAAsB,EAAE;QACtD,GAAG,oCAAoC,CAAC;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,sBAAsB;SACvB,CAAC;QACF,eAAe,EAAE,aAAa;QAC9B,IAAI;QACJ,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;KACxD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,oBAAoB,CAC3B,SAAqC,EACrC,gBAAmD,EACnD,KAAc,EACd,kBAAgD;IAEhD,IAAI,CAAC;QACH,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACvE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,IACE,iCAAiC,CAAC,WAAW,CAAC;YAC9C,gBAAgB,CAAC,0BAA0B,EAC3C,CAAC;YACD,OAAO;QACT,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,gCAAgC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,WAAW,EAAE,CAAC;QACrB,SAAS,CAAC,gBAAgB,EAAE,CAC1B,SAAS,CAAC,WAAW,EAAE,kCAAkC,CAAC,CAC3D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,SAAqC,EACrC,gBAAmD,EACnD,OAAsC;IAEtC,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CACpE,gDAAgD,CAC9C,OAAO,EACP,gBAAgB,CAAC,sBAAsB,CACxC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAAqC,EACrC,gBAAmD,EACnD,OAAmC;IAEnC,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CACpE,6CAA6C,CAC3C,OAAO,EACP,gBAAgB,CAAC,sBAAsB,CACxC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type { AnalyticsTrackingEvent } from '@metamask/analytics-controller';\nimport { generateDeterministicRandomNumber } from '@metamask/remote-feature-flag-controller';\nimport type { Hex, Json } from '@metamask/utils';\nimport {\n  hasProperty,\n  hexToNumber,\n  isObject,\n  isValidJson,\n  wrapError,\n} from '@metamask/utils';\n\nimport type {\n  NetworkControllerMessenger,\n  NetworkControllerRpcEndpointDegradedEvent,\n  NetworkControllerRpcEndpointUnavailableEvent,\n} from './NetworkController';\nimport { isConnectionError } from './rpc-service/rpc-service';\n\ntype RpcEndpointUnavailablePayload =\n  NetworkControllerRpcEndpointUnavailableEvent['payload'][0];\n\ntype RpcEndpointDegradedPayload =\n  NetworkControllerRpcEndpointDegradedEvent['payload'][0];\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 * Wraps a 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 */\nfunction 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\n/**\n * Builds the properties common to both RPC service events.\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.\n * @param args.isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe\n * to report verbatim.\n * @returns The common analytics event properties.\n */\nfunction buildCommonRpcServiceEventProperties({\n  chainId,\n  endpointUrl,\n  error,\n  isRpcEndpointUrlPublic,\n}: {\n  chainId: Hex;\n  endpointUrl: string;\n  error: unknown;\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean;\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    ...(isObject(error) &&\n    hasProperty(error, 'httpStatus') &&\n    isValidJson(error.httpStatus)\n      ? { http_status: error.httpStatus }\n      : {}),\n  };\n}\n\n/**\n * Builds the \"RPC Service Unavailable\" analytics tracking event.\n *\n * @param payload - The `rpcEndpointUnavailable` event payload.\n * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to\n * report verbatim.\n * @returns The analytics tracking event.\n */\nexport function buildRpcServiceUnavailableAnalyticsTrackingEvent(\n  payload: RpcEndpointUnavailablePayload,\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean,\n): AnalyticsTrackingEvent {\n  return toAnalyticsTrackingEvent(\n    'RPC Service Unavailable',\n    buildCommonRpcServiceEventProperties({\n      chainId: payload.chainId,\n      endpointUrl: payload.endpointUrl,\n      error: payload.error,\n      isRpcEndpointUrlPublic,\n    }),\n  );\n}\n\n/**\n * Builds the \"RPC Service Degraded\" analytics tracking event.\n *\n * @param payload - The `rpcEndpointDegraded` event payload.\n * @param isRpcEndpointUrlPublic - Returns whether the endpoint URL is safe to\n * report verbatim.\n * @returns The analytics tracking event.\n */\nexport function buildRpcServiceDegradedAnalyticsTrackingEvent(\n  payload: RpcEndpointDegradedPayload,\n  isRpcEndpointUrlPublic: (endpointUrl: string) => boolean,\n): AnalyticsTrackingEvent {\n  const { duration, retryReason, rpcMethodName, traceId, type } = payload;\n\n  // The names of analytics properties have a particular case.\n  return toAnalyticsTrackingEvent('RPC Service Degraded', {\n    ...buildCommonRpcServiceEventProperties({\n      chainId: payload.chainId,\n      endpointUrl: payload.endpointUrl,\n      error: payload.error,\n      isRpcEndpointUrlPublic,\n    }),\n    rpc_method_name: rpcMethodName,\n    type,\n    ...(retryReason ? { retry_reason: retryReason } : {}),\n    ...(duration === undefined ? {} : { duration_ms: duration }),\n    ...(traceId === undefined ? {} : { trace_id: traceId }),\n  });\n}\n\n/**\n * Delivers an RPC service analytics event via the\n * `AnalyticsController:trackEvent` action, skipping local connection errors,\n * users without an analytics ID, and events that fall outside the configured\n * sample. Failures never propagate to the caller.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param error - The error encountered, used to skip local connection errors.\n * @param buildTrackingEvent - Builds the event to deliver (only called when the\n * event passes the sampling and analytics-ID checks).\n */\nfunction trackRpcServiceEvent(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  error: unknown,\n  buildTrackingEvent: () => AnalyticsTrackingEvent,\n): void {\n  try {\n    if (isConnectionError(error)) {\n      return;\n    }\n\n    const { analyticsId } = messenger.call('AnalyticsController:getState');\n    if (!analyticsId) {\n      return;\n    }\n\n    if (\n      generateDeterministicRandomNumber(analyticsId) >=\n      analyticsOptions.rpcServiceEventsSampleRate\n    ) {\n      return;\n    }\n\n    messenger.call('AnalyticsController:trackEvent', buildTrackingEvent());\n  } catch (caughtError) {\n    messenger.captureException?.(\n      wrapError(caughtError, 'Could not create analytics event'),\n    );\n  }\n}\n\n/**\n * Emits an \"RPC Service Unavailable\" analytics event.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param payload - The `rpcEndpointUnavailable` event payload.\n */\nexport function trackRpcServiceUnavailable(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  payload: RpcEndpointUnavailablePayload,\n): void {\n  trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () =>\n    buildRpcServiceUnavailableAnalyticsTrackingEvent(\n      payload,\n      analyticsOptions.isRpcEndpointUrlPublic,\n    ),\n  );\n}\n\n/**\n * Emits an \"RPC Service Degraded\" analytics event.\n *\n * @param messenger - The controller messenger.\n * @param analyticsOptions - The analytics configuration.\n * @param payload - The `rpcEndpointDegraded` event payload.\n */\nexport function trackRpcServiceDegraded(\n  messenger: NetworkControllerMessenger,\n  analyticsOptions: NetworkControllerAnalyticsOptions,\n  payload: RpcEndpointDegradedPayload,\n): void {\n  trackRpcServiceEvent(messenger, analyticsOptions, payload.error, () =>\n    buildRpcServiceDegradedAnalyticsTrackingEvent(\n      payload,\n      analyticsOptions.isRpcEndpointUrlPublic,\n    ),\n  );\n}\n"]}