@openzeppelin/ui-builder-adapter-evm 1.2.0 → 1.4.0

package/src/wallet/rainbowkit/utils.ts

@@ -1,96 +0,0 @@
-import type { UiKitConfiguration } from '@openzeppelin/ui-types';
-import { logger } from '@openzeppelin/ui-utils';
-
-/**
- * RainbowKit configuration options definition
- */
-
-/**
- * Validates the RainbowKit configuration to ensure required fields are present.
- *
- * @param kitConfig - The RainbowKit configuration object
- * @returns Object containing the validation result and any missing fields or error message
- */
-export function validateRainbowKitConfig(kitConfig?: UiKitConfiguration['kitConfig']): {
-  isValid: boolean;
-  missingFields?: string[];
-  error?: string;
-} {
-  // Detailed log to inspect the received kitConfig
-  logger.debug(
-    'validateRainbowKitConfig',
-    'Received kitConfig for validation:',
-    JSON.stringify(kitConfig)
-  );
-
-  if (!kitConfig) {
-    logger.warn('validateRainbowKitConfig', 'Validation failed: No kitConfig provided.');
-    return { isValid: false, error: 'No kitConfig provided for RainbowKit' };
-  }
-
-  // kitConfig is the fully resolved configuration object which should contain wagmiParams and providerProps.
-  // Access wagmiParams from within kitConfig.
-  const wagmiParamsFromKitConfig = (kitConfig as Record<string, unknown>).wagmiParams as
-    | Record<string, unknown>
-    | undefined;
-
-  if (
-    !wagmiParamsFromKitConfig ||
-    typeof wagmiParamsFromKitConfig !== 'object' ||
-    wagmiParamsFromKitConfig === null
-  ) {
-    logger.warn(
-      'validateRainbowKitConfig',
-      'Validation failed: kitConfig.wagmiParams is missing or invalid.',
-      { wagmiParamsFromKitConfig }
-    );
-    return { isValid: false, error: 'kitConfig.wagmiParams is missing or not a valid object' };
-  }
-
-  const missingFields: string[] = [];
-  if (
-    !('appName' in wagmiParamsFromKitConfig) ||
-    typeof wagmiParamsFromKitConfig.appName !== 'string'
-  ) {
-    missingFields.push('wagmiParams.appName');
-  }
-  if (
-    !('projectId' in wagmiParamsFromKitConfig) ||
-    typeof wagmiParamsFromKitConfig.projectId !== 'string'
-  ) {
-    missingFields.push('wagmiParams.projectId');
-  }
-
-  if (missingFields.length > 0) {
-    const errorMsg = `Missing or invalid required fields in wagmiParams: ${missingFields.join(', ')}`;
-    logger.warn('validateRainbowKitConfig', 'Validation failed:', errorMsg, { missingFields });
-    return {
-      isValid: false,
-      missingFields,
-      error: errorMsg,
-    };
-  }
-  logger.debug('validateRainbowKitConfig', 'Validation successful.');
-  return { isValid: true };
-}
-
-/**
- * Extracts and type-guards a RainbowKit configuration from a UiKitConfiguration
- *
- * @param config The UI kit configuration
- * @returns The raw kitConfig Record<string, unknown> or undefined.
- */
-export function getRawUserNativeConfig(
-  config: UiKitConfiguration
-): Record<string, unknown> | undefined {
-  if (config.kitName !== 'rainbowkit' || !config.kitConfig) {
-    return undefined;
-  }
-  // kitConfig is already expected to be Record<string, unknown> or undefined by UiKitConfiguration type.
-  // We just ensure it's not null and is an object here for safety if it were `any` somewhere up the chain.
-  if (typeof config.kitConfig === 'object' && config.kitConfig !== null) {
-    return config.kitConfig as Record<string, unknown>;
-  }
-  logger.warn('rainbowkit/utils', 'kitConfig for RainbowKit is not a valid object.');
-  return undefined;
-}

package/src/wallet/services/configResolutionService.ts

@@ -1,65 +0,0 @@
-import type { NativeConfigLoader, UiKitConfiguration } from '@openzeppelin/ui-types';
-import { logger } from '@openzeppelin/ui-utils';
-
-import { resolveAndInitializeKitConfig } from '../utils';
-
-/**
- * Resolves the final, complete UiKitConfiguration by merging various sources.
- *
- * @param programmaticOverrides - Overrides passed directly to the configureUiKit call.
- * @param initialAppServiceKitName - The kitName noted from AppConfigService when the adapter instance was constructed.
- * @param currentAppServiceConfig - The full UiKitConfiguration from AppConfigService, re-fetched at the time of the call.
- * @param options - Options, including the callback to load user's native config file.
- * @returns A Promise resolving to the final UiKitConfiguration.
- */
-export async function resolveFullUiKitConfiguration(
-  programmaticOverrides: Partial<UiKitConfiguration>,
-  initialAppServiceKitName: UiKitConfiguration['kitName'],
-  currentAppServiceConfig: UiKitConfiguration, // This is the result of loadInitialConfigFromAppService()
-  options?: {
-    loadUiKitNativeConfig?: NativeConfigLoader;
-  }
-): Promise<UiKitConfiguration> {
-  logger.debug(
-    'configResolutionService:resolveFullUiKitConfiguration',
-    'Starting resolution with:',
-    {
-      programmaticOverrides,
-      initialAppServiceKitName,
-      currentAppServiceConfig,
-      hasLoadNativeCallback: !!options?.loadUiKitNativeConfig,
-      hasCustomCode: !!programmaticOverrides.customCode,
-    }
-  );
-
-  const effectiveKitName: UiKitConfiguration['kitName'] =
-    programmaticOverrides.kitName ||
-    initialAppServiceKitName ||
-    currentAppServiceConfig.kitName ||
-    'custom';
-
-  // Resolve from native config file (if loader is provided)
-  const resolvedUserNativeAndProgrammaticKitConfig = await resolveAndInitializeKitConfig(
-    effectiveKitName,
-    programmaticOverrides.kitConfig,
-    options?.loadUiKitNativeConfig
-  );
-
-  const finalFullConfig: UiKitConfiguration = {
-    kitName: effectiveKitName,
-    kitConfig: {
-      ...(currentAppServiceConfig.kitConfig || {}),
-      ...(resolvedUserNativeAndProgrammaticKitConfig || {}),
-      // customCode is NOT applied to runtime config
-    },
-    // Pass through customCode for export purposes only
-    customCode: programmaticOverrides.customCode,
-  };
-
-  logger.debug(
-    'configResolutionService:resolveFullUiKitConfiguration',
-    'Resolved finalFullConfig:',
-    finalFullConfig
-  );
-  return finalFullConfig;
-}

package/src/wallet/utils/SafeWagmiComponent.tsx

@@ -1,72 +0,0 @@
-import React, { useEffect, useState } from 'react';
-
-import { logger } from '@openzeppelin/ui-utils';
-
-import { useIsWagmiProviderInitialized } from '../hooks/useIsWagmiProviderInitialized';
-
-/**
- * A wrapper component that safely renders children that use wagmi hooks.
- * It handles errors and provider initialization state to prevent crashes.
- */
-export const SafeWagmiComponent = ({
-  children,
-  fallback = null,
-}: {
-  children: React.ReactNode;
-  fallback?: React.ReactNode;
-}) => {
-  const isProviderInitialized = useIsWagmiProviderInitialized();
-  const [hasError, setHasError] = useState(false);
-
-  useEffect(() => {
-    // Reset error state if provider initializes
-    if (isProviderInitialized) {
-      setHasError(false);
-    }
-  }, [isProviderInitialized]);
-
-  // Setup global error handler for wagmi errors
-  useEffect(() => {
-    const handleError = (event: ErrorEvent) => {
-      // Only handle wagmi-related errors
-      if (
-        event.error?.message?.includes('useConfig') ||
-        event.error?.message?.includes('WagmiProvider')
-      ) {
-        logger.debug(
-          'SafeWagmiComponent',
-          'Caught wagmi error via window error event:',
-          event.error
-        );
-        setHasError(true);
-        event.preventDefault(); // Prevent the error from propagating
-      }
-    };
-
-    window.addEventListener('error', handleError);
-    return () => {
-      window.removeEventListener('error', handleError);
-    };
-  }, []);
-
-  // If provider isn't ready yet or we had an error, show fallback
-  if (!isProviderInitialized || hasError) {
-    return <>{fallback}</>;
-  }
-
-  try {
-    return <>{children}</>;
-  } catch (error) {
-    // Only catch render errors related to wagmi hooks
-    if (
-      error instanceof Error &&
-      (error.message.includes('useConfig') || error.message.includes('WagmiProvider'))
-    ) {
-      logger.debug('SafeWagmiComponent', 'Caught wagmi error:', error);
-      setHasError(true);
-      return <>{fallback}</>;
-    }
-    // Re-throw other errors
-    throw error;
-  }
-};

package/src/wallet/utils/filterWalletComponents.ts

@@ -1,89 +0,0 @@
-import type { EcosystemWalletComponents, UiKitConfiguration } from '@openzeppelin/ui-types';
-import { ECOSYSTEM_WALLET_COMPONENT_KEYS } from '@openzeppelin/ui-types';
-import { logger } from '@openzeppelin/ui-utils';
-
-/**
- * Filters a set of wallet components based on an exclusion list.
- *
- * @param allPossibleComponents - An object containing all potential components for a kit.
- * @param exclusions - An array of component keys to exclude.
- * @param kitName - The name of the kit being filtered (for logging purposes).
- * @returns The filtered EcosystemWalletComponents object, or undefined if all components are excluded.
- */
-export function filterWalletComponents(
-  allPossibleComponents: EcosystemWalletComponents,
-  exclusions: Array<keyof EcosystemWalletComponents>,
-  kitName: string = 'custom' // Default to custom for logging context
-): EcosystemWalletComponents | undefined {
-  logger.debug(
-    'filterWalletComponents',
-    `Filtering components for kit: ${kitName}. Exclusions: ${exclusions.join(', ')}.`
-  );
-  if (!allPossibleComponents || Object.keys(allPossibleComponents).length === 0) {
-    logger.debug('filterWalletComponents', `No components provided to filter for kit: ${kitName}.`);
-    return undefined;
-  }
-
-  if (exclusions.length === 0) {
-    logger.debug(
-      'filterWalletComponents',
-      `Providing all components for kit: ${kitName}.`,
-      allPossibleComponents
-    );
-    return allPossibleComponents;
-  }
-
-  const filteredComponents: Partial<EcosystemWalletComponents> = {};
-  let componentCount = 0;
-  for (const key in allPossibleComponents) {
-    const componentKey = key as keyof EcosystemWalletComponents;
-    if (!exclusions.includes(componentKey)) {
-      if (allPossibleComponents[componentKey]) {
-        // Ensure the component actually exists before adding
-        filteredComponents[componentKey] = allPossibleComponents[componentKey];
-        componentCount++;
-      }
-    }
-  }
-
-  if (componentCount > 0) {
-    logger.debug(
-      'filterWalletComponents',
-      `Providing filtered components for kit: ${kitName} after exclusions (${exclusions.join(', ')}).`,
-      filteredComponents
-    );
-    return filteredComponents as EcosystemWalletComponents;
-  }
-
-  logger.debug('filterWalletComponents', `All components were excluded for kit: ${kitName}.`);
-  return undefined;
-}
-
-/**
- * Extracts the component exclusion list from a UI kit configuration object.
- *
- * @param kitConfig - The `kitConfig` object from `UiKitConfiguration`.
- * @returns An array of component keys to exclude, or an empty array if none are specified or config is invalid.
- */
-export function getComponentExclusionsFromConfig(
-  kitConfig: UiKitConfiguration['kitConfig']
-): Array<keyof EcosystemWalletComponents> {
-  if (kitConfig && typeof kitConfig === 'object' && 'components' in kitConfig) {
-    const componentsCfg = kitConfig.components;
-    if (
-      componentsCfg &&
-      typeof componentsCfg === 'object' &&
-      'exclude' in componentsCfg &&
-      Array.isArray(componentsCfg.exclude)
-    ) {
-      // Ensure all elements are valid keys of EcosystemWalletComponents
-      // This provides a bit more type safety at runtime if the config comes from an untyped source
-      return componentsCfg.exclude.filter(
-        (key): key is keyof EcosystemWalletComponents =>
-          typeof key === 'string' &&
-          (ECOSYSTEM_WALLET_COMPONENT_KEYS as readonly string[]).includes(key)
-      ) as Array<keyof EcosystemWalletComponents>;
-    }
-  }
-  return [];
-}