@openzeppelin/ui-react 3.1.0 → 3.2.0

package/dist/index.cjs

@@ -33,7 +33,7 @@ let _tanstack_react_query = require("@tanstack/react-query");
 let _openzeppelin_ui_components = require("@openzeppelin/ui-components");
 
 //#region src/version.ts
-const VERSION = "3.1.0";
+const VERSION = "3.2.0";
 
 //#endregion
 //#region src/hooks/AdapterContext.tsx
@@ -86,11 +86,31 @@ function RuntimeProvider({ children, resolveRuntime }) {
 	const [loadingNetworks, setLoadingNetworks] = (0, react.useState)(/* @__PURE__ */ new Set());
 	const runtimeRegistryRef = (0, react.useRef)(runtimeRegistry);
 	const failedNetworksRef = (0, react.useRef)(/* @__PURE__ */ new Set());
+	const resolverGenerationRef = (0, react.useRef)(0);
+	const resolverInitializedRef = (0, react.useRef)(false);
 	(0, react.useEffect)(() => {
 		runtimeRegistryRef.current = runtimeRegistry;
 	}, [runtimeRegistry]);
 	(0, react.useEffect)(() => {
+		if (resolverInitializedRef.current) resolverGenerationRef.current += 1;
+		else resolverInitializedRef.current = true;
+		const registry = runtimeRegistryRef.current;
+		const runtimes = Object.values(registry);
+		const hadCachedRuntimes = runtimes.length > 0;
 		failedNetworksRef.current = /* @__PURE__ */ new Set();
+		setLoadingNetworks(/* @__PURE__ */ new Set());
+		if (hadCachedRuntimes) {
+			setRuntimeRegistry({});
+			setTimeout(() => {
+				runtimes.forEach((runtime) => {
+					try {
+						runtime.dispose();
+					} catch (error) {
+						_openzeppelin_ui_utils.logger.error("RuntimeProvider", "Error disposing runtime during registry flush:", error);
+					}
+				});
+			}, 0);
+		}
 	}, [resolveRuntime]);
 	(0, react.useEffect)(() => {
 		return () => {
@@ -178,7 +198,23 @@ function RuntimeProvider({ children, resolveRuntime }) {
 			return newSet;
 		});
 		_openzeppelin_ui_utils.logger.info("RuntimeProvider", `Starting runtime initialization for network ${networkId} (${networkConfig.name})`);
+		const generation = resolverGenerationRef.current;
 		resolveRuntime(networkConfig).then((runtime) => {
+			if (generation !== resolverGenerationRef.current) {
+				setTimeout(() => {
+					try {
+						runtime.dispose();
+					} catch (error) {
+						_openzeppelin_ui_utils.logger.error("RuntimeProvider", `Error disposing stale runtime for network ${networkId}:`, error);
+					}
+				}, 0);
+				setLoadingNetworks((prev) => {
+					const newSet = new Set(prev);
+					newSet.delete(networkId);
+					return newSet;
+				});
+				return;
+			}
 			_openzeppelin_ui_utils.logger.info("RuntimeProvider", `Runtime for network ${networkId} loaded successfully`, {
 				type: runtime.constructor.name,
 				objectId: Object.prototype.toString.call(runtime)
@@ -193,6 +229,14 @@ function RuntimeProvider({ children, resolveRuntime }) {
 				return newSet;
 			});
 		}).catch((error) => {
+			if (generation !== resolverGenerationRef.current) {
+				setLoadingNetworks((prev) => {
+					const newSet = new Set(prev);
+					newSet.delete(networkId);
+					return newSet;
+				});
+				return;
+			}
 			_openzeppelin_ui_utils.logger.error("RuntimeProvider", `Error loading runtime for network ${networkId}:`, error);
 			failedNetworksRef.current.add(networkId);
 			setLoadingNetworks((prev) => {
@@ -921,22 +965,42 @@ const DEFAULT_CONFIG = {
 };
 /** Stable prefix for every resolution cache key — namespaces this package's keys. */
 const RESOLUTION_KEY_PREFIX = "oz-name-resolution";
+const runtimeInstanceIds = /* @__PURE__ */ new WeakMap();
+let nextRuntimeInstanceId = 1;
+/**
+* Assign a stable, serializable id to each {@link EcosystemRuntime} object identity.
+* A disposed-and-recreated runtime (e.g. SF-4 opt-in toggle after INV-218 flush) gets
+* a new id so resolution cache keys miss and results refresh (INV-230).
+*/
+function getRuntimeInstanceId(runtime) {
+	if (!runtime) return 0;
+	let id = runtimeInstanceIds.get(runtime);
+	if (id === void 0) {
+		id = nextRuntimeInstanceId;
+		nextRuntimeInstanceId += 1;
+		runtimeInstanceIds.set(runtime, id);
+	}
+	return id;
+}
 /**
 * Build a network-scoped, namespace-separated cache key (INV-40). A name resolves
 * differently per network and provenance can be chain-scoped, so `networkId` is
-* part of the key; `namespace` keeps forward and reverse lookups disjoint.
+* part of the key; `namespace` keeps forward and reverse lookups disjoint;
+* `runtimeInstanceId` scopes entries to the active capability instance (INV-230).
 *
-* @param namespace       - `'name'` (forward) or `'addr'` (reverse).
-* @param networkId       - Active network id (`''` when no network is selected).
-* @param normalizedInput - Trimmed + lowercased input (INV-26).
+* @param namespace           - `'name'` (forward) or `'addr'` (reverse).
+* @param networkId           - Active network id (`''` when no network is selected).
+* @param normalizedInput     - Trimmed + lowercased input (INV-26).
+* @param runtimeInstanceId   - Active runtime instance discriminator (`0` when absent).
 * @returns A readonly tuple suitable for a TanStack Query `queryKey`.
 */
-function buildResolutionKey(namespace, networkId, normalizedInput) {
+function buildResolutionKey(namespace, networkId, normalizedInput, runtimeInstanceId = 0) {
 	return [
 		RESOLUTION_KEY_PREFIX,
 		namespace,
 		networkId,
-		normalizedInput
+		normalizedInput,
+		runtimeInstanceId
 	];
 }
 /**
@@ -1135,12 +1199,13 @@ function useResolutionEngine(params) {
 	const normalizedKey = effectiveTrimmed.toLowerCase();
 	const capability = activeRuntime?.nameResolution;
 	const networkId = activeNetworkId ?? "";
+	const runtimeInstanceId = getRuntimeInstanceId(activeRuntime);
 	const method = capability ? getMethod(capability) : void 0;
 	const liveAttemptable = capability ? shouldAttempt(capability, normalizedLive) : false;
 	const keyAttemptable = capability ? shouldAttempt(capability, normalizedKey) : false;
 	const queryEnabled = enabled && trimmedLive !== "" && capability != null && method != null && normalizedKey !== "" && keyAttemptable;
 	const query = (0, _tanstack_react_query.useQuery)({
-		queryKey: buildResolutionKey(namespace, networkId, normalizedKey),
+		queryKey: buildResolutionKey(namespace, networkId, normalizedKey, runtimeInstanceId),
 		queryFn: async () => {
 			if (!method) throw new ResolutionQueryError({
 				code: "ADAPTER_ERROR",
@@ -1387,8 +1452,10 @@ const EMPTY_RESOLVER = {};
 function useRuntimeNameResolver() {
 	const walletState = (0, react.useContext)(WalletStateContext);
 	const { queryClient, config } = useNameResolutionContext();
-	const capability = walletState?.activeRuntime?.nameResolution;
+	const activeRuntime = walletState?.activeRuntime ?? null;
+	const capability = activeRuntime?.nameResolution;
 	const networkId = walletState?.activeNetworkId ?? "";
+	const runtimeInstanceId = getRuntimeInstanceId(activeRuntime);
 	return (0, react.useMemo)(() => {
 		if (!capability) return EMPTY_RESOLVER;
 		const resolveNameMethod = capability.resolveName;
@@ -1400,7 +1467,7 @@ function useRuntimeNameResolver() {
 					return {
 						ok: true,
 						value: await queryClient.fetchQuery({
-							queryKey: buildResolutionKey("name", networkId, normalized),
+							queryKey: buildResolutionKey("name", networkId, normalized, runtimeInstanceId),
 							queryFn: async () => {
 								let result;
 								try {
@@ -1432,7 +1499,73 @@ function useRuntimeNameResolver() {
 		capability,
 		queryClient,
 		config,
-		networkId
+		networkId,
+		runtimeInstanceId
+	]);
+}
+
+//#endregion
+//#region src/hooks/runtime/runtimeCreationConfig.ts
+/** Safe default: miss-fallback OFF; no uiKit override. INV-204 */
+const DEFAULT_RUNTIME_CREATION_CONFIG = {};
+/**
+* Normalizes the opt-in flag to the adapter's strict-enable contract.
+* UIKit uses this at the threading boundary so `false` and `undefined` never
+* emit `enableMainnetL1MissFallback: false` into adapter options (absent = OFF).
+*/
+function isMainnetL1MissFallbackEnabled(options) {
+	return options?.enableMainnetL1MissFallback === true;
+}
+/**
+* Builds the `createRuntime` options bag for adapter threading.
+* When OFF, `nameResolution` is omitted (INV-207). When ON, spreads only
+* `{ enableMainnetL1MissFallback: true }` (INV-208).
+*/
+function buildCreateRuntimeOptions(options) {
+	return {
+		...options?.uiKit !== void 0 ? { uiKit: options.uiKit } : {},
+		...isMainnetL1MissFallbackEnabled(options?.nameResolution) ? { nameResolution: { enableMainnetL1MissFallback: true } } : {}
+	};
+}
+
+//#endregion
+//#region src/hooks/runtime/createResolveRuntime.ts
+/**
+* Build a `resolveRuntime` callback for {@link RuntimeProvider} that forwards
+* `CreateRuntimeOptions` to `ecosystemDefinition.createRuntime`.
+*
+* Does not cache — {@link RuntimeProvider} owns the per-network singleton registry.
+*/
+function createResolveRuntime(ecosystemDefinition, params) {
+	const { profile, options } = params;
+	const mergedOptions = buildCreateRuntimeOptions(options);
+	return (networkConfig) => Promise.resolve(ecosystemDefinition.createRuntime(profile, networkConfig, mergedOptions));
+}
+
+//#endregion
+//#region src/hooks/runtime/useResolveRuntime.ts
+/**
+* Memoized {@link createResolveRuntime} for React apps. Recompute when
+* `ecosystemDefinition`, `profile`, or opt-in posture change (INV-217, INV-222).
+*
+* Changing the returned function identity MUST trigger runtime registry flush
+* in {@link RuntimeProvider} (INV-218).
+*/
+function useResolveRuntime(ecosystemDefinition, params) {
+	const { profile, options } = params;
+	const uiKit = options?.uiKit;
+	const enableMainnetL1MissFallback = options?.nameResolution?.enableMainnetL1MissFallback;
+	return (0, react.useMemo)(() => createResolveRuntime(ecosystemDefinition, {
+		profile,
+		options: {
+			...uiKit !== void 0 ? { uiKit } : {},
+			...enableMainnetL1MissFallback === true ? { nameResolution: { enableMainnetL1MissFallback: true } } : {}
+		}
+	}), [
+		ecosystemDefinition,
+		profile,
+		uiKit,
+		enableMainnetL1MissFallback
 	]);
 }
 
@@ -1646,6 +1779,7 @@ const NetworkSwitchManager = ({ wallet, networkCatalog, targetNetworkId, onNetwo
 exports.AnalyticsContext = AnalyticsContext;
 exports.AnalyticsProvider = AnalyticsProvider;
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
+exports.DEFAULT_RUNTIME_CREATION_CONFIG = DEFAULT_RUNTIME_CREATION_CONFIG;
 exports.NameResolutionContext = NameResolutionContext;
 exports.NameResolutionProvider = NameResolutionProvider;
 exports.NetworkSwitchManager = NetworkSwitchManager;
@@ -1656,6 +1790,8 @@ exports.WalletConnectionHeader = WalletConnectionHeader;
 exports.WalletConnectionUI = WalletConnectionUI;
 exports.WalletStateContext = WalletStateContext;
 exports.WalletStateProvider = WalletStateProvider;
+exports.createResolveRuntime = createResolveRuntime;
+exports.isMainnetL1MissFallbackEnabled = isMainnetL1MissFallbackEnabled;
 exports.useAnalytics = useAnalytics;
 exports.useDerivedAccountStatus = useDerivedAccountStatus;
 exports.useDerivedChainInfo = useDerivedChainInfo;
@@ -1665,6 +1801,7 @@ exports.useDerivedSwitchChainStatus = useDerivedSwitchChainStatus;
 exports.useNameResolutionContext = useNameResolutionContext;
 exports.useResolveAddress = useResolveAddress;
 exports.useResolveName = useResolveName;
+exports.useResolveRuntime = useResolveRuntime;
 exports.useRuntimeContext = useRuntimeContext;
 exports.useRuntimeNameResolver = useRuntimeNameResolver;
 exports.useWalletComponents = useWalletComponents;