@openzeppelin/ui-utils 1.1.1 → 1.2.0

package/dist/index.cjs

@@ -2256,14 +2256,204 @@ function getWalletNetworkSwitcherVariantClassName(variant) {
 	}
 }
 
+//#endregion
+//#region src/serviceErrorDetection.ts
+/**
+* Utilities for detecting and categorizing network service connection errors.
+* This module provides functions to identify when errors are caused by network
+* service failures (RPC, Explorer, Indexer, etc.) and determine which service
+* type was affected.
+*/
+/**
+* Common patterns that indicate a network service connection failure.
+* These patterns help distinguish network/service issues from other errors.
+*/
+const SERVICE_ERROR_PATTERNS = [
+	"failed to fetch",
+	"network error",
+	"connection refused",
+	"timeout",
+	"econnrefused",
+	"fetch failed",
+	"network request failed",
+	"connection timeout",
+	"unable to connect",
+	"no response",
+	"service unavailable",
+	"could not connect",
+	"connection failed",
+	"network unavailable",
+	"dns resolution failed",
+	"socket hang up",
+	"read econnreset",
+	"503",
+	"502",
+	"504",
+	"500",
+	"gateway timeout",
+	"bad gateway",
+	"internal server error",
+	"rpc error",
+	"rpc endpoint",
+	"indexer",
+	"explorer",
+	"horizon",
+	"api error",
+	"rate limit",
+	"too many requests",
+	"429"
+];
+/**
+* Known network service types with their display names.
+* Adapters can use any service ID, but these are common ones.
+*/
+const SERVICE_DISPLAY_NAMES = {
+	rpc: "RPC Provider",
+	explorer: "Block Explorer",
+	indexer: "Indexer",
+	horizon: "Horizon API",
+	"contract-definitions": "Contract Definitions",
+	soroban: "Soroban RPC",
+	graphql: "GraphQL API",
+	"proof-server": "Proof Server",
+	node: "Node Provider"
+};
+/**
+* Patterns that suggest a specific service type caused the error.
+* More specific patterns take priority in the detection order.
+*/
+const SERVICE_TYPE_HINTS = [
+	{
+		patterns: [
+			"indexer",
+			"graphql",
+			"subquery",
+			"subgraph",
+			"the graph"
+		],
+		serviceType: "indexer"
+	},
+	{
+		patterns: [
+			"explorer",
+			"etherscan",
+			"blockscout",
+			"sourcify",
+			"polygonscan",
+			"bscscan"
+		],
+		serviceType: "explorer"
+	},
+	{
+		patterns: ["horizon", "stellar"],
+		serviceType: "horizon"
+	},
+	{
+		patterns: ["soroban"],
+		serviceType: "soroban"
+	},
+	{
+		patterns: [
+			"rpc",
+			"jsonrpc",
+			"json-rpc",
+			"eth_",
+			"web3",
+			"provider",
+			"node"
+		],
+		serviceType: "rpc"
+	}
+];
+/**
+* Checks if an error message indicates a network service connection failure.
+*
+* @param errorMessage The error message to check
+* @returns True if the error appears to be caused by a service connection issue
+*
+* @example
+* ```ts
+* isServiceConnectionError('Failed to fetch'); // true
+* isServiceConnectionError('Invalid address'); // false
+* ```
+*/
+function isServiceConnectionError(errorMessage) {
+	if (!errorMessage) return false;
+	const lowerCaseError = errorMessage.toLowerCase();
+	return SERVICE_ERROR_PATTERNS.some((pattern) => lowerCaseError.includes(pattern));
+}
+/**
+* Attempts to determine which service type caused the error based on the error message.
+* Falls back to 'rpc' as the most common case for blockchain-related failures.
+*
+* @param errorMessage The error message to analyze
+* @returns The detected service type (e.g., 'rpc', 'explorer', 'indexer')
+*
+* @example
+* ```ts
+* detectServiceType('Indexer connection failed'); // 'indexer'
+* detectServiceType('Etherscan API error'); // 'explorer'
+* detectServiceType('RPC endpoint timeout'); // 'rpc'
+* detectServiceType('Unknown error'); // 'rpc' (default)
+* ```
+*/
+function detectServiceType(errorMessage) {
+	if (!errorMessage) return "rpc";
+	const lowerCaseError = errorMessage.toLowerCase();
+	for (const { patterns, serviceType } of SERVICE_TYPE_HINTS) if (patterns.some((pattern) => lowerCaseError.includes(pattern))) return serviceType;
+	return "rpc";
+}
+/**
+* Gets a user-friendly display name for a service type.
+* Falls back to capitalizing the service ID if not found in known mappings.
+*
+* @param serviceType The service type identifier (e.g., 'rpc', 'explorer')
+* @returns A user-friendly display name (e.g., 'RPC Provider', 'Block Explorer')
+*
+* @example
+* ```ts
+* getServiceDisplayName('rpc'); // 'RPC Provider'
+* getServiceDisplayName('indexer'); // 'Indexer'
+* getServiceDisplayName('custom-service'); // 'Custom service'
+* ```
+*/
+function getServiceDisplayName(serviceType) {
+	return SERVICE_DISPLAY_NAMES[serviceType] || serviceType.charAt(0).toUpperCase() + serviceType.slice(1).replace(/-/g, " ");
+}
+/**
+* Analyzes an error and returns detailed information about the service failure.
+*
+* @param errorMessage The error message to analyze
+* @returns Object containing detection results
+*
+* @example
+* ```ts
+* const result = analyzeServiceError('Indexer timeout');
+* // { isServiceError: true, serviceType: 'indexer', serviceName: 'Indexer' }
+* ```
+*/
+function analyzeServiceError(errorMessage) {
+	const isServiceError = isServiceConnectionError(errorMessage);
+	const serviceType = detectServiceType(errorMessage);
+	return {
+		isServiceError,
+		serviceType,
+		serviceName: getServiceDisplayName(serviceType)
+	};
+}
+
 //#endregion
 exports.AnalyticsService = AnalyticsService;
 exports.AppConfigService = AppConfigService;
 exports.DEFAULT_CONCURRENCY_LIMIT = DEFAULT_CONCURRENCY_LIMIT;
+exports.SERVICE_DISPLAY_NAMES = SERVICE_DISPLAY_NAMES;
+exports.SERVICE_ERROR_PATTERNS = SERVICE_ERROR_PATTERNS;
+exports.SERVICE_TYPE_HINTS = SERVICE_TYPE_HINTS;
 exports.UserExplorerConfigService = UserExplorerConfigService;
 exports.UserNetworkServiceConfigService = UserNetworkServiceConfigService;
 exports.UserRpcConfigService = UserRpcConfigService;
 exports.addressesEqual = addressesEqual;
+exports.analyzeServiceError = analyzeServiceError;
 exports.appConfigService = appConfigService;
 exports.base64ToBytes = base64ToBytes;
 exports.buildRequiredInputSnapshot = buildRequiredInputSnapshot;
@@ -2275,6 +2465,7 @@ exports.createEmptySnapshot = createEmptySnapshot;
 exports.delay = delay;
 exports.deserializeSnapshot = deserializeSnapshot;
 exports.detectBytesEncoding = detectBytesEncoding;
+exports.detectServiceType = detectServiceType;
 exports.enhanceNumericValidation = enhanceNumericValidation;
 exports.findRoleAssignment = findRoleAssignment;
 exports.formatAccessControlError = formatAccessControlError;
@@ -2287,6 +2478,7 @@ exports.getErrorMessage = getErrorMessage;
 exports.getForcedService = getForcedService;
 exports.getInvalidUrlMessage = getInvalidUrlMessage;
 exports.getMissingRequiredContractInputs = getMissingRequiredContractInputs;
+exports.getServiceDisplayName = getServiceDisplayName;
 exports.getTotalMemberCount = getTotalMemberCount;
 exports.getWalletAccountDisplaySizeProps = getWalletAccountDisplaySizeProps;
 exports.getWalletButtonSizeProps = getWalletButtonSizeProps;
@@ -2301,6 +2493,7 @@ exports.isDevelopmentOrTestEnvironment = isDevelopmentOrTestEnvironment;
 exports.isPlainObject = isPlainObject;
 exports.isProductionEnvironment = isProductionEnvironment;
 exports.isRecordWithProperties = isRecordWithProperties;
+exports.isServiceConnectionError = isServiceConnectionError;
 exports.isValidUrl = isValidUrl;
 exports.logger = logger;
 exports.normalizeAddress = normalizeAddress;