@lukso/up-connector 0.4.0-dev.a8c9315

package/src/auto-setup.ts

@@ -0,0 +1,362 @@
+/**
+ * Auto-setup utilities for LUKSO products
+ *
+ * Provides zero-config setup for:
+ * - Embedded Wallet (passkey-based)
+ * - UP Extension (browser extension)
+ * - UP Mobile (WalletConnect)
+ */
+
+import type { Config } from '@wagmi/core'
+import type { ConnectModalSetup } from './connect-modal/index.js'
+import { setupConnectModal } from './connect-modal/index.js'
+
+/**
+ * Embedded wallet constants
+ */
+export const EMBEDDED_WALLET_ID = 'dev.lukso.auth'
+export const EMBEDDED_WALLET_URL_DEV = 'http://localhost:9100'
+export const EMBEDDED_WALLET_URL_PROD = 'https://auth-simple.pages.dev'
+
+/**
+ * UP Extension ID
+ */
+export const UP_EXTENSION_ID = 'cloud.universalprofile'
+
+/**
+ * Get default wallet URL based on environment
+ */
+function getDefaultWalletUrl(): string {
+  // Check for environment variable (CI builds)
+  if (typeof process !== 'undefined' && process.env?.WALLET_URL) {
+    return process.env.WALLET_URL
+  }
+
+  // Check if we're in production (browser)
+  if (typeof window !== 'undefined') {
+    const isLocalhost =
+      window.location.hostname === 'localhost' ||
+      window.location.hostname === '127.0.0.1'
+    return isLocalhost ? EMBEDDED_WALLET_URL_DEV : EMBEDDED_WALLET_URL_PROD
+  }
+
+  // Default to dev
+  return EMBEDDED_WALLET_URL_DEV
+}
+
+export interface LuksoConnectorConfig {
+  /**
+   * Embedded wallet configuration
+   */
+  embeddedWallet?: {
+    /**
+     * Enable embedded wallet option (default: true)
+     */
+    enabled?: boolean
+
+    /**
+     * URL to the wallet service
+     * @default 'http://localhost:9100'
+     */
+    url?: string
+
+    /**
+     * Storage key for UP Provider state
+     * @default 'up-provider'
+     */
+    storageKey?: string
+
+    /**
+     * Display name for the wallet
+     * @default 'Create Passkey Wallet'
+     */
+    name?: string
+  }
+
+  /**
+   * WalletConnect configuration for mobile app
+   */
+  walletConnect?: {
+    /**
+     * Enable WalletConnect (default: true)
+     */
+    enabled?: boolean
+
+    /**
+     * WalletConnect Project ID
+     * @default LUKSO's default project ID
+     */
+    projectId?: string
+
+    /**
+     * Show QR code modal on mobile devices (default: false)
+     */
+    showQrModal?: boolean
+  }
+
+  /**
+   * Chain configuration
+   */
+  chains?: {
+    /**
+     * Default chain ID
+     * @default 42 (LUKSO mainnet)
+     */
+    defaultChainId?: number
+
+    /**
+     * Enable testnet (default: true)
+     */
+    enableTestnet?: boolean
+  }
+
+  /**
+   * Storage configuration
+   */
+  storage?: {
+    /**
+     * Storage key prefix for wagmi state
+     * @default 'up-wagmi'
+     */
+    key?: string
+  }
+
+  /**
+   * Pass an existing wagmi config instead of auto-creating one
+   */
+  wagmiConfig?: any
+}
+
+const DEFAULT_CONFIG: Required<LuksoConnectorConfig> = {
+  embeddedWallet: {
+    enabled: true,
+    url: getDefaultWalletUrl(),
+    storageKey: 'up-provider',
+    name: 'UE Embedded Wallet',
+  },
+  walletConnect: {
+    enabled: true,
+    projectId: '7d1af65dc2722192d9914b5d6eaeb421', // LUKSO's default
+    showQrModal: false,
+  },
+  chains: {
+    defaultChainId: 42, // LUKSO mainnet
+    enableTestnet: true,
+  },
+  storage: {
+    key: 'up-wagmi',
+  },
+  wagmiConfig: undefined,
+}
+
+/**
+ * Auto-setup LUKSO connector with sensible defaults
+ *
+ * This function creates a wagmi config and sets up the connect modal
+ * with support for:
+ * - Embedded Wallet (passkey-based)
+ * - UP Extension (auto-detected via EIP-6963)
+ * - UP Mobile (WalletConnect)
+ *
+ * @example
+ * ```typescript
+ * // Zero config - uses all defaults
+ * setupLuksoConnector()
+ *
+ * // Custom configuration
+ * setupLuksoConnector({
+ *   embeddedWallet: {
+ *     url: 'https://wallet.example.com'
+ *   },
+ *   chains: {
+ *     defaultChainId: 4201 // LUKSO Testnet
+ *   }
+ * })
+ * ```
+ */
+export async function setupLuksoConnector(
+  config: LuksoConnectorConfig = {}
+): Promise<{ wagmiConfig: Config }> {
+  const cfg = {
+    embeddedWallet: {
+      ...DEFAULT_CONFIG.embeddedWallet,
+      ...config.embeddedWallet,
+    } as Required<typeof DEFAULT_CONFIG.embeddedWallet>,
+    walletConnect: {
+      ...DEFAULT_CONFIG.walletConnect,
+      ...config.walletConnect,
+    } as Required<typeof DEFAULT_CONFIG.walletConnect>,
+    chains: {
+      ...DEFAULT_CONFIG.chains,
+      ...config.chains,
+    } as Required<typeof DEFAULT_CONFIG.chains>,
+    storage: {
+      ...DEFAULT_CONFIG.storage,
+      ...config.storage,
+    } as Required<typeof DEFAULT_CONFIG.storage>,
+    wagmiConfig: config.wagmiConfig,
+  }
+
+  // IMPORTANT: Create UP Provider BEFORE wagmi config
+  // The UP Provider registers via EIP-6963, and wagmi's injected() will detect it
+  // This matches the order in demo-app: UP Provider first, then wagmi config
+
+  // Step 1: Create UP Provider (if enabled)
+  if (cfg.embeddedWallet?.enabled) {
+    await createUPProvider(cfg.embeddedWallet)
+  }
+
+  // Step 2: Create or use provided wagmi config
+  const wagmiConfig = cfg.wagmiConfig || (await createWagmiConfig(cfg))
+
+  // Note: Wagmi will auto-reconnect in the background
+  // The connector's watchWagmiAccount will detect the connection when it completes
+
+  // Step 3: Setup connect modal
+  // The UP Provider is already registered via EIP-6963 and will appear in wagmi connectors
+  // Use the embedded wallet ID to identify it in the connector list
+  setupConnectModal({
+    wagmiConfig,
+    chainId: cfg.chains.defaultChainId,
+    embeddedWalletId: cfg.embeddedWallet.enabled
+      ? EMBEDDED_WALLET_ID
+      : undefined,
+  })
+
+  return { wagmiConfig }
+}
+
+/**
+ * Create wagmi config with LUKSO chains and connectors
+ */
+async function createWagmiConfig(cfg: any): Promise<any> {
+  try {
+    // Dynamic imports to keep dependencies optional
+    const [
+      { createConfig, createStorage, injected },
+      { walletConnect },
+      { createClient, http },
+      { lukso, luksoTestnet },
+    ] = await Promise.all([
+      import('@wagmi/core'),
+      import('@wagmi/connectors'),
+      import('viem'),
+      import('viem/chains'),
+    ])
+
+    // Create storage adapter
+    const storage = createStorage({
+      key: cfg.storage.key,
+      storage: getDefaultStorage(),
+    })
+
+    // Build chains array
+    const chains = cfg.chains.enableTestnet
+      ? ([luksoTestnet, lukso] as const)
+      : ([lukso] as const)
+
+    // Build connectors array
+    const connectors = []
+
+    // Add WalletConnect if enabled
+    if (cfg.walletConnect.enabled) {
+      connectors.push(
+        walletConnect({
+          projectId: cfg.walletConnect.projectId,
+          showQrModal: cfg.walletConnect.showQrModal,
+        })
+      )
+    }
+
+    // Add injected (for UP Extension and other EIP-6963 wallets)
+    connectors.push(injected())
+
+    // Create wagmi config
+    return createConfig({
+      storage,
+      multiInjectedProviderDiscovery: true, // Enable EIP-6963
+      connectors,
+      chains,
+      client({ chain }: any) {
+        return createClient({ chain, transport: http() })
+      },
+    })
+  } catch (error) {
+    console.error('Failed to create wagmi config:', error)
+    throw new Error(
+      'Failed to create wagmi config. Make sure @wagmi/core, @wagmi/connectors, and viem are installed.'
+    )
+  }
+}
+
+/**
+ * Create UP Provider (registers via EIP-6963)
+ */
+async function createUPProvider(config: {
+  url: string
+  storageKey: string
+  name: string
+}): Promise<void> {
+  // Validate URL - throw error if explicitly set to empty string
+  if (config.url != null && config.url.trim() === '') {
+    throw new Error(
+      'UP Provider URL is defined but empty. Please set WALLET_URL environment variable to a valid URL or leave it undefined.'
+    )
+  }
+
+  try {
+    const { createClientUPProvider } = await import('@lukso/up-provider')
+
+    // Create UP Provider - it automatically registers via EIP-6963
+    createClientUPProvider({
+      url: config.url,
+      mode: 'iframe',
+      get: async () => {
+        const stored = localStorage.getItem(config.storageKey)
+        return stored ? JSON.parse(stored) : {}
+      },
+      set: async (value: Record<string, unknown>) => {
+        localStorage.setItem(config.storageKey, JSON.stringify(value))
+      },
+      name: config.name,
+    })
+
+    // Wait for EIP-6963 registration
+    await new Promise((resolve) => setTimeout(resolve, 100))
+  } catch (error) {
+    console.warn('⚠️ Failed to create UP Provider:', error)
+    throw error
+  }
+}
+
+/**
+ * Default storage adapter (localStorage with error handling)
+ */
+function getDefaultStorage() {
+  const storage = (() => {
+    if (typeof window !== 'undefined' && window.localStorage) {
+      return window.localStorage
+    }
+    return {
+      getItem: () => null,
+      setItem: () => {},
+      removeItem: () => {},
+    }
+  })()
+
+  return {
+    getItem(key: string) {
+      return storage.getItem(key)
+    },
+    removeItem(key: string) {
+      storage.removeItem(key)
+    },
+    setItem(key: string, value: string) {
+      try {
+        storage.setItem(key, value)
+      } catch {
+        // Silence QuotaExceededError, SecurityError, etc.
+      }
+    },
+  }
+}