@unifold/ui-react 0.1.62 → 0.1.64

package/dist/index.d.mts

@@ -27,6 +27,15 @@ interface UseDepositPollingOptions {
     depositConfirmationMode?: DepositConfirmationMode;
     /** Deposit wallet ID used to trigger the backend poll endpoint */
     depositWalletId?: string;
+    /**
+     * Multiple deposit wallet IDs to nudge `/poll` for. Used when the deposit chain
+     * isn't known up front (e.g. the mobile redirect flow, where the user may
+     * deposit on any supported chain) — we iterate the wallets from
+     * `/deposit_addresses` and poll each. Detection itself is via the single
+     * `/query` by `external_user_id` (which already spans all chains). Takes
+     * precedence over `depositWalletId` when non-empty.
+     */
+    depositWalletIds?: string[];
     enabled?: boolean;
     onDepositSuccess?: (data: {
         message: string;
@@ -55,7 +64,7 @@ interface UseDepositPollingResult {
     /** Call this when user clicks "I've made the deposit" (manual mode) */
     handleIveDeposited: () => void;
 }
-declare function useDepositPolling({ userId, publishableKey, clientSecret, depositConfirmationMode, depositWalletId, enabled, immediateDirectPolling, onDepositSuccess, onDepositError, }: UseDepositPollingOptions): UseDepositPollingResult;
+declare function useDepositPolling({ userId, publishableKey, clientSecret, depositConfirmationMode, depositWalletId, depositWalletIds, enabled, immediateDirectPolling, onDepositSuccess, onDepositError, }: UseDepositPollingOptions): UseDepositPollingResult;
 
 declare global {
     interface Window {
@@ -160,9 +169,9 @@ interface DepositModalProps {
      */
     contractCalls?: EvmContractCall[];
     /**
-     * Pre-select source token/chain in the Transfer Crypto view.
+     * Prefer a source token/chain in Transfer Crypto, Wallet Connect, and Connect Exchange flows.
      * All four props are optional. To match, provide `chainType` + `chainId` + (`symbol` OR `tokenAddress`).
-     * If omitted or no match is found in `/supported_deposit_tokens`, the first available token and chain are used.
+     * If omitted or no match is found in `/supported_deposit_tokens`, each flow uses its normal ordering.
      */
     defaultSourceChainType?: ChainType;
     /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` + symbol or token address. */
@@ -171,6 +180,7 @@ interface DepositModalProps {
     defaultSourceTokenAddress?: string;
     /** Source token symbol (e.g. `"USDC"`). Must be paired with `defaultSourceChainType` + `defaultSourceChainId`. */
     defaultSourceSymbol?: string;
+    /** Hide the "Deposit Tracker" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? false (shown). */
     hideDepositTracker?: boolean;
     /** Show balance in deposit modal header. Defaults to false */
     showBalanceHeader?: boolean;
@@ -182,20 +192,22 @@ interface DepositModalProps {
      *  - "manual": User must click "I've made the deposit" to start polling
      */
     depositConfirmationMode?: DepositConfirmationMode;
-    /** Enable browser wallet connection option. Defaults to false */
+    /** Enable "Transfer Crypto" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
+    enableTransferCrypto?: boolean;
+    /** Enable browser wallet connection option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectWallet?: boolean;
     /**
      * Connect Wallet → Enter amount: percentage chips (10%, 25%, 50%, 75%, MAX) from USD balance, or fixed USD ($25…).
      * @default "percentage"
      */
     browserWalletAmountQuickSelect?: BrowserWalletAmountQuickSelect;
-    /** Enable "Pay with Exchange" option. Overrides dashboard default. Defaults to dashboard value or true. */
+    /** Enable "Pay with Exchange" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enablePayWithExchange?: boolean;
-    /** Enable the fiat on-ramp option (shown as "Deposit with Card"). Overrides dashboard default. Defaults to dashboard value or true. */
+    /** Enable the fiat on-ramp option (shown as "Deposit with Card"). Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableFiatOnramp?: boolean;
-    /** Enable "Connect Exchange" option for direct Coinbase Connect integration. Defaults to false. */
+    /** Enable "Connect Exchange" option for direct Coinbase Connect integration. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectExchange?: boolean;
-    /** Enable "Pay with Cash App" option. Defaults to false. */
+    /** Enable "Pay with Cash App" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableCashApp?: boolean;
     /** Deposit with Card — onramp step: hide the You use / You buy / You receive card. @default false */
     hideDepositFlowInfo?: boolean;
@@ -218,7 +230,7 @@ interface DepositModalProps {
     /** First screen when the modal opens. Default `main` (deposit menu). */
     initialScreen?: DepositModalInitialScreen;
 }
-declare function DepositModal({ open, onOpenChange, userId, publishableKey, modalTitle, destinationTokenSymbol, recipientAddress, destinationChainType, destinationChainId, destinationTokenAddress, contractCalls, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, hideDepositTracker, showBalanceHeader, transferInputVariant, depositConfirmationMode, enableConnectWallet, browserWalletAmountQuickSelect, enablePayWithExchange, enableFiatOnramp, enableConnectExchange, enableCashApp, hideDepositFlowInfo, hideDisplayDescription, onDepositSuccess, onDepositError, onEvent, theme, hideOverlay, initialScreen, transferCryptoTitle, depositWithCardTitle, payWithExchangeTitle, depositTrackerTitle, depositTrackerSubTitle, }: DepositModalProps): react_jsx_runtime.JSX.Element;
+declare function DepositModal({ open, onOpenChange, userId, publishableKey, modalTitle, destinationTokenSymbol, recipientAddress, destinationChainType, destinationChainId, destinationTokenAddress, contractCalls, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, hideDepositTracker, showBalanceHeader, transferInputVariant, depositConfirmationMode, enableTransferCrypto, enableConnectWallet, browserWalletAmountQuickSelect, enablePayWithExchange, enableFiatOnramp, enableConnectExchange, enableCashApp, hideDepositFlowInfo, hideDisplayDescription, onDepositSuccess, onDepositError, onEvent, theme, hideOverlay, initialScreen, transferCryptoTitle, depositWithCardTitle, payWithExchangeTitle, depositTrackerTitle, depositTrackerSubTitle, }: DepositModalProps): react_jsx_runtime.JSX.Element;
 
 interface DepositHeaderProps {
     title: string;
@@ -488,8 +500,12 @@ interface CoinbaseConnectProps {
     /** Whether back navigation from the root view is available (false when opened as a standalone initial screen). */
     canGoBack?: boolean;
     onExecutionsChange?: (executions: AutoSwapResponse[]) => void;
+    defaultSourceChainType?: ChainType;
+    defaultSourceChainId?: string;
+    defaultSourceTokenAddress?: string;
+    defaultSourceSymbol?: string;
 }
-declare function CoinbaseConnect({ publishableKey, userId, wallets, recipientAddress, destinationTokenAddress, destinationChainId, destinationChainType, onTransferSuccess, onTransferError, onClose, onBack: parentOnBack, onDisconnect, skipToHoldings, canGoBack, onExecutionsChange, }: CoinbaseConnectProps): react_jsx_runtime.JSX.Element | null;
+declare function CoinbaseConnect({ publishableKey, userId, wallets, recipientAddress, destinationTokenAddress, destinationChainId, destinationChainType, onTransferSuccess, onTransferError, onClose, onBack: parentOnBack, onDisconnect, skipToHoldings, canGoBack, onExecutionsChange, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, }: CoinbaseConnectProps): react_jsx_runtime.JSX.Element | null;
 declare namespace CoinbaseConnect {
     var displayName: string;
 }
@@ -548,12 +564,14 @@ interface CheckoutModalProps {
     clientSecret: string;
     publishableKey: string;
     modalTitle?: string;
-    /** Enable browser wallet connection option. Defaults to false */
+    /** Enable "Transfer Crypto" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
+    enableTransferCrypto?: boolean;
+    /** Enable browser wallet connection option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectWallet?: boolean;
     /**
-     * Pre-select source token/chain in the Transfer Crypto view.
+     * Prefer a source token/chain in Transfer Crypto and Wallet Connect flows.
      * All four props are optional. To match, provide `chainType` + `chainId` + (`symbol` OR `tokenAddress`).
-     * If omitted or no match is found in `/supported_deposit_tokens`, the first available token and chain are used.
+     * If omitted or no match is found in `/supported_deposit_tokens`, each flow uses its normal ordering.
      */
     defaultSourceChainType?: ChainType;
     /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` + symbol or token address. */
@@ -573,7 +591,7 @@ interface CheckoutModalProps {
         code?: string;
     }) => void;
 }
-declare function CheckoutModal({ open, onOpenChange, clientSecret, publishableKey, modalTitle, enableConnectWallet, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, theme, onCheckoutSuccess, onCheckoutError, }: CheckoutModalProps): react_jsx_runtime.JSX.Element;
+declare function CheckoutModal({ open, onOpenChange, clientSecret, publishableKey, modalTitle, enableTransferCrypto, enableConnectWallet, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, theme, onCheckoutSuccess, onCheckoutError, }: CheckoutModalProps): react_jsx_runtime.JSX.Element;
 
 interface WithdrawTransactionInfo {
     /** Source (sending) chain type */

package/dist/index.d.ts

@@ -27,6 +27,15 @@ interface UseDepositPollingOptions {
     depositConfirmationMode?: DepositConfirmationMode;
     /** Deposit wallet ID used to trigger the backend poll endpoint */
     depositWalletId?: string;
+    /**
+     * Multiple deposit wallet IDs to nudge `/poll` for. Used when the deposit chain
+     * isn't known up front (e.g. the mobile redirect flow, where the user may
+     * deposit on any supported chain) — we iterate the wallets from
+     * `/deposit_addresses` and poll each. Detection itself is via the single
+     * `/query` by `external_user_id` (which already spans all chains). Takes
+     * precedence over `depositWalletId` when non-empty.
+     */
+    depositWalletIds?: string[];
     enabled?: boolean;
     onDepositSuccess?: (data: {
         message: string;
@@ -55,7 +64,7 @@ interface UseDepositPollingResult {
     /** Call this when user clicks "I've made the deposit" (manual mode) */
     handleIveDeposited: () => void;
 }
-declare function useDepositPolling({ userId, publishableKey, clientSecret, depositConfirmationMode, depositWalletId, enabled, immediateDirectPolling, onDepositSuccess, onDepositError, }: UseDepositPollingOptions): UseDepositPollingResult;
+declare function useDepositPolling({ userId, publishableKey, clientSecret, depositConfirmationMode, depositWalletId, depositWalletIds, enabled, immediateDirectPolling, onDepositSuccess, onDepositError, }: UseDepositPollingOptions): UseDepositPollingResult;
 
 declare global {
     interface Window {
@@ -160,9 +169,9 @@ interface DepositModalProps {
      */
     contractCalls?: EvmContractCall[];
     /**
-     * Pre-select source token/chain in the Transfer Crypto view.
+     * Prefer a source token/chain in Transfer Crypto, Wallet Connect, and Connect Exchange flows.
      * All four props are optional. To match, provide `chainType` + `chainId` + (`symbol` OR `tokenAddress`).
-     * If omitted or no match is found in `/supported_deposit_tokens`, the first available token and chain are used.
+     * If omitted or no match is found in `/supported_deposit_tokens`, each flow uses its normal ordering.
      */
     defaultSourceChainType?: ChainType;
     /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` + symbol or token address. */
@@ -171,6 +180,7 @@ interface DepositModalProps {
     defaultSourceTokenAddress?: string;
     /** Source token symbol (e.g. `"USDC"`). Must be paired with `defaultSourceChainType` + `defaultSourceChainId`. */
     defaultSourceSymbol?: string;
+    /** Hide the "Deposit Tracker" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? false (shown). */
     hideDepositTracker?: boolean;
     /** Show balance in deposit modal header. Defaults to false */
     showBalanceHeader?: boolean;
@@ -182,20 +192,22 @@ interface DepositModalProps {
      *  - "manual": User must click "I've made the deposit" to start polling
      */
     depositConfirmationMode?: DepositConfirmationMode;
-    /** Enable browser wallet connection option. Defaults to false */
+    /** Enable "Transfer Crypto" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
+    enableTransferCrypto?: boolean;
+    /** Enable browser wallet connection option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectWallet?: boolean;
     /**
      * Connect Wallet → Enter amount: percentage chips (10%, 25%, 50%, 75%, MAX) from USD balance, or fixed USD ($25…).
      * @default "percentage"
      */
     browserWalletAmountQuickSelect?: BrowserWalletAmountQuickSelect;
-    /** Enable "Pay with Exchange" option. Overrides dashboard default. Defaults to dashboard value or true. */
+    /** Enable "Pay with Exchange" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enablePayWithExchange?: boolean;
-    /** Enable the fiat on-ramp option (shown as "Deposit with Card"). Overrides dashboard default. Defaults to dashboard value or true. */
+    /** Enable the fiat on-ramp option (shown as "Deposit with Card"). Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableFiatOnramp?: boolean;
-    /** Enable "Connect Exchange" option for direct Coinbase Connect integration. Defaults to false. */
+    /** Enable "Connect Exchange" option for direct Coinbase Connect integration. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectExchange?: boolean;
-    /** Enable "Pay with Cash App" option. Defaults to false. */
+    /** Enable "Pay with Cash App" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableCashApp?: boolean;
     /** Deposit with Card — onramp step: hide the You use / You buy / You receive card. @default false */
     hideDepositFlowInfo?: boolean;
@@ -218,7 +230,7 @@ interface DepositModalProps {
     /** First screen when the modal opens. Default `main` (deposit menu). */
     initialScreen?: DepositModalInitialScreen;
 }
-declare function DepositModal({ open, onOpenChange, userId, publishableKey, modalTitle, destinationTokenSymbol, recipientAddress, destinationChainType, destinationChainId, destinationTokenAddress, contractCalls, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, hideDepositTracker, showBalanceHeader, transferInputVariant, depositConfirmationMode, enableConnectWallet, browserWalletAmountQuickSelect, enablePayWithExchange, enableFiatOnramp, enableConnectExchange, enableCashApp, hideDepositFlowInfo, hideDisplayDescription, onDepositSuccess, onDepositError, onEvent, theme, hideOverlay, initialScreen, transferCryptoTitle, depositWithCardTitle, payWithExchangeTitle, depositTrackerTitle, depositTrackerSubTitle, }: DepositModalProps): react_jsx_runtime.JSX.Element;
+declare function DepositModal({ open, onOpenChange, userId, publishableKey, modalTitle, destinationTokenSymbol, recipientAddress, destinationChainType, destinationChainId, destinationTokenAddress, contractCalls, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, hideDepositTracker, showBalanceHeader, transferInputVariant, depositConfirmationMode, enableTransferCrypto, enableConnectWallet, browserWalletAmountQuickSelect, enablePayWithExchange, enableFiatOnramp, enableConnectExchange, enableCashApp, hideDepositFlowInfo, hideDisplayDescription, onDepositSuccess, onDepositError, onEvent, theme, hideOverlay, initialScreen, transferCryptoTitle, depositWithCardTitle, payWithExchangeTitle, depositTrackerTitle, depositTrackerSubTitle, }: DepositModalProps): react_jsx_runtime.JSX.Element;
 
 interface DepositHeaderProps {
     title: string;
@@ -488,8 +500,12 @@ interface CoinbaseConnectProps {
     /** Whether back navigation from the root view is available (false when opened as a standalone initial screen). */
     canGoBack?: boolean;
     onExecutionsChange?: (executions: AutoSwapResponse[]) => void;
+    defaultSourceChainType?: ChainType;
+    defaultSourceChainId?: string;
+    defaultSourceTokenAddress?: string;
+    defaultSourceSymbol?: string;
 }
-declare function CoinbaseConnect({ publishableKey, userId, wallets, recipientAddress, destinationTokenAddress, destinationChainId, destinationChainType, onTransferSuccess, onTransferError, onClose, onBack: parentOnBack, onDisconnect, skipToHoldings, canGoBack, onExecutionsChange, }: CoinbaseConnectProps): react_jsx_runtime.JSX.Element | null;
+declare function CoinbaseConnect({ publishableKey, userId, wallets, recipientAddress, destinationTokenAddress, destinationChainId, destinationChainType, onTransferSuccess, onTransferError, onClose, onBack: parentOnBack, onDisconnect, skipToHoldings, canGoBack, onExecutionsChange, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, }: CoinbaseConnectProps): react_jsx_runtime.JSX.Element | null;
 declare namespace CoinbaseConnect {
     var displayName: string;
 }
@@ -548,12 +564,14 @@ interface CheckoutModalProps {
     clientSecret: string;
     publishableKey: string;
     modalTitle?: string;
-    /** Enable browser wallet connection option. Defaults to false */
+    /** Enable "Transfer Crypto" option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
+    enableTransferCrypto?: boolean;
+    /** Enable browser wallet connection option. Overrides dashboard default. Resolves as flag ?? dashboard value ?? true. */
     enableConnectWallet?: boolean;
     /**
-     * Pre-select source token/chain in the Transfer Crypto view.
+     * Prefer a source token/chain in Transfer Crypto and Wallet Connect flows.
      * All four props are optional. To match, provide `chainType` + `chainId` + (`symbol` OR `tokenAddress`).
-     * If omitted or no match is found in `/supported_deposit_tokens`, the first available token and chain are used.
+     * If omitted or no match is found in `/supported_deposit_tokens`, each flow uses its normal ordering.
      */
     defaultSourceChainType?: ChainType;
     /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` + symbol or token address. */
@@ -573,7 +591,7 @@ interface CheckoutModalProps {
         code?: string;
     }) => void;
 }
-declare function CheckoutModal({ open, onOpenChange, clientSecret, publishableKey, modalTitle, enableConnectWallet, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, theme, onCheckoutSuccess, onCheckoutError, }: CheckoutModalProps): react_jsx_runtime.JSX.Element;
+declare function CheckoutModal({ open, onOpenChange, clientSecret, publishableKey, modalTitle, enableTransferCrypto, enableConnectWallet, defaultSourceChainType, defaultSourceChainId, defaultSourceTokenAddress, defaultSourceSymbol, theme, onCheckoutSuccess, onCheckoutError, }: CheckoutModalProps): react_jsx_runtime.JSX.Element;
 
 interface WithdrawTransactionInfo {
     /** Source (sending) chain type */