@unifold/connect-react 0.1.40 → 0.1.42

package/README.md

@@ -132,6 +132,10 @@ Launches the deposit modal with the specified configuration. **Returns a Promise
 | `destinationTokenAddress` | string | ✅ | Token contract address |
 | `destinationTokenSymbol` | string | ✅ | Token symbol (e.g., "USDC") |
 | `recipientAddress` | string | ✅ | Recipient wallet address |
+| `defaultSourceChainType` | string | - | Pre-select source chain type in Transfer Crypto (e.g. `"solana"`, `"ethereum"`). Must be paired with `defaultSourceChainId` + symbol or token address. If omitted or no match, defaults to the first token from `/supported_deposit_tokens`. |
+| `defaultSourceChainId` | string | - | Source chain ID (e.g. `"mainnet"`, `"137"`). Paired with `defaultSourceChainType`. |
+| `defaultSourceTokenAddress` | string | - | Source token contract address. Paired with chain type + chain ID. |
+| `defaultSourceSymbol` | string | - | Source token symbol (e.g. `"USDC"`). Paired with chain type + chain ID. |
 | `onSuccess` | function | - | Success callback (fired immediately) |
 | `onError` | function | - | Error callback (fired immediately) |
 | `initialScreen` | `'main' \| 'transfer' \| 'card' \| 'tracker'` | - | `main` (default) = deposit menu. `transfer` / `card` use the **same geo/validation gates** as the menu. `tracker` opens the list **without** those gates. If not `main`, the header **back** is hidden (standalone); from `main`, back returns to the menu. Card quotes/onramp and tracker detail still show back for inner steps. |

package/dist/index.d.mts

@@ -1,13 +1,15 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
-export { AllowedCountryResult, BrowserWalletAmountQuickSelect, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ConfirmingView, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
-export { AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SupportedChain, SupportedDepositTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, setApiConfig, useUserIp } from '@unifold/core';
+import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, WithdrawTransactionInfo, AllowedCountryResult } from '@unifold/ui-react';
+export { AllowedCountryResult, BrowserWalletAmountQuickSelect, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ConfirmingView, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode, WithdrawTransactionInfo } from '@unifold/ui-react';
+export { ActionType, AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, DestinationToken, DestinationTokenChain, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SendSolanaTransactionRequest, SendSolanaTransactionResponse, SupportedChain, SupportedDepositTokensResponse, SupportedDestinationTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, sendSolanaTransaction, setApiConfig, useUserIp } from '@unifold/core';
 
 interface UnifoldConnectProviderConfig {
     publishableKey: string;
     config?: {
         modalTitle?: string;
+        /** Custom title for the withdraw modal. @default `"Withdraw"` */
+        withdrawModalTitle?: string;
         hideDepositTracker?: boolean;
         /** Show balance in deposit modal header. Defaults to true */
         showBalanceHeader?: boolean;
@@ -66,6 +68,18 @@ interface DepositConfig {
     destinationTokenAddress: string;
     destinationTokenSymbol: string;
     recipientAddress: string;
+    /**
+     * Pre-select source token/chain in the Transfer Crypto view.
+     * All four props are optional. To match a specific token, 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.
+     */
+    defaultSourceChainType?: ChainType;
+    /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` and a symbol or token address. */
+    defaultSourceChainId?: string;
+    /** Source token contract address. Must be paired with `defaultSourceChainType` + `defaultSourceChainId` to match. */
+    defaultSourceTokenAddress?: string;
+    /** Source token symbol (e.g. `"USDC"`). Must be paired with `defaultSourceChainType` + `defaultSourceChainId` to match. */
+    defaultSourceSymbol?: string;
     /** How to confirm deposit: 'auto_ui' (default), 'auto_silent', or 'manual' */
     depositConfirmationMode?: DepositConfirmationMode;
     onSuccess?: (data: DepositResult) => void;
@@ -80,11 +94,56 @@ interface DepositConfig {
      */
     initialScreen?: DepositModalInitialScreen;
 }
+interface WithdrawResult {
+    message: string;
+    transaction?: unknown;
+}
+interface WithdrawError {
+    message: string;
+    error?: unknown;
+    code?: string;
+}
+interface WithdrawConfig {
+    /** External user ID — required, same as deposit */
+    externalUserId: string;
+    /** Source token chain type (e.g. 'ethereum', 'solana'). Must be a supported stablecoin. */
+    sourceChainType: ChainType;
+    /** Source token chain ID (e.g. '8453', 'mainnet') */
+    sourceChainId: string;
+    /** Source token contract address */
+    sourceTokenAddress: string;
+    /** Source token symbol (e.g. 'USDC'). Optional but recommended for display. */
+    sourceTokenSymbol?: string;
+    /** Optional: pre-fill the recipient address the user is withdrawing to */
+    recipientAddress?: string;
+    /**
+     * The user's wallet address (the sender). Used to:
+     * 1. Fetch balance for quick-select chips (25%/50%/75%/MAX)
+     * 2. Detect if a matching browser wallet is connected
+     */
+    senderAddress: string;
+    /**
+     * Callback invoked with transaction details when user confirms withdrawal.
+     * The platform must implement the actual transaction signing/sending since
+     * we don't have the private key.
+     *
+     * Optional — if omitted, the user must have a matching connected browser wallet
+     * to execute the withdrawal. If neither `withdraw` nor a connected wallet is available,
+     * the modal will show an error.
+     */
+    withdraw?: (txInfo: WithdrawTransactionInfo) => void | Promise<void>;
+    onSuccess?: (data: WithdrawResult) => void;
+    onError?: (error: WithdrawError) => void;
+    onClose?: () => void;
+}
+
 declare function UnifoldProvider({ children, publishableKey, config, }: React.PropsWithChildren<UnifoldConnectProviderConfig>): react_jsx_runtime.JSX.Element;
 declare function useUnifold(): {
     publishableKey: string;
     beginDeposit: (config: DepositConfig) => Promise<DepositResult>;
     closeDeposit: () => void;
+    beginWithdraw: (config: WithdrawConfig) => Promise<WithdrawResult>;
+    closeWithdraw: () => void;
 };
 /**
  * Convenience wrapper for useAllowedCountry that automatically passes publishableKey from context
@@ -110,4 +169,4 @@ declare function useUnifold(): {
  */
 declare function useAllowedCountry(): AllowedCountryResult;
 
-export { type DepositConfig, type DepositError, type DepositResult, type UnifoldConnectProviderConfig, UnifoldProvider, useAllowedCountry, useUnifold };
+export { type DepositConfig, type DepositError, type DepositResult, type UnifoldConnectProviderConfig, UnifoldProvider, type WithdrawConfig, type WithdrawError, type WithdrawResult, useAllowedCountry, useUnifold };

package/dist/index.d.ts

@@ -1,13 +1,15 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
-export { AllowedCountryResult, BrowserWalletAmountQuickSelect, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ConfirmingView, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
-export { AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SupportedChain, SupportedDepositTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, setApiConfig, useUserIp } from '@unifold/core';
+import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, WithdrawTransactionInfo, AllowedCountryResult } from '@unifold/ui-react';
+export { AllowedCountryResult, BrowserWalletAmountQuickSelect, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ConfirmingView, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode, WithdrawTransactionInfo } from '@unifold/ui-react';
+export { ActionType, AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, DestinationToken, DestinationTokenChain, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SendSolanaTransactionRequest, SendSolanaTransactionResponse, SupportedChain, SupportedDepositTokensResponse, SupportedDestinationTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, sendSolanaTransaction, setApiConfig, useUserIp } from '@unifold/core';
 
 interface UnifoldConnectProviderConfig {
     publishableKey: string;
     config?: {
         modalTitle?: string;
+        /** Custom title for the withdraw modal. @default `"Withdraw"` */
+        withdrawModalTitle?: string;
         hideDepositTracker?: boolean;
         /** Show balance in deposit modal header. Defaults to true */
         showBalanceHeader?: boolean;
@@ -66,6 +68,18 @@ interface DepositConfig {
     destinationTokenAddress: string;
     destinationTokenSymbol: string;
     recipientAddress: string;
+    /**
+     * Pre-select source token/chain in the Transfer Crypto view.
+     * All four props are optional. To match a specific token, 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.
+     */
+    defaultSourceChainType?: ChainType;
+    /** Source chain ID (e.g. `"mainnet"`, `"137"`). Must be paired with `defaultSourceChainType` and a symbol or token address. */
+    defaultSourceChainId?: string;
+    /** Source token contract address. Must be paired with `defaultSourceChainType` + `defaultSourceChainId` to match. */
+    defaultSourceTokenAddress?: string;
+    /** Source token symbol (e.g. `"USDC"`). Must be paired with `defaultSourceChainType` + `defaultSourceChainId` to match. */
+    defaultSourceSymbol?: string;
     /** How to confirm deposit: 'auto_ui' (default), 'auto_silent', or 'manual' */
     depositConfirmationMode?: DepositConfirmationMode;
     onSuccess?: (data: DepositResult) => void;
@@ -80,11 +94,56 @@ interface DepositConfig {
      */
     initialScreen?: DepositModalInitialScreen;
 }
+interface WithdrawResult {
+    message: string;
+    transaction?: unknown;
+}
+interface WithdrawError {
+    message: string;
+    error?: unknown;
+    code?: string;
+}
+interface WithdrawConfig {
+    /** External user ID — required, same as deposit */
+    externalUserId: string;
+    /** Source token chain type (e.g. 'ethereum', 'solana'). Must be a supported stablecoin. */
+    sourceChainType: ChainType;
+    /** Source token chain ID (e.g. '8453', 'mainnet') */
+    sourceChainId: string;
+    /** Source token contract address */
+    sourceTokenAddress: string;
+    /** Source token symbol (e.g. 'USDC'). Optional but recommended for display. */
+    sourceTokenSymbol?: string;
+    /** Optional: pre-fill the recipient address the user is withdrawing to */
+    recipientAddress?: string;
+    /**
+     * The user's wallet address (the sender). Used to:
+     * 1. Fetch balance for quick-select chips (25%/50%/75%/MAX)
+     * 2. Detect if a matching browser wallet is connected
+     */
+    senderAddress: string;
+    /**
+     * Callback invoked with transaction details when user confirms withdrawal.
+     * The platform must implement the actual transaction signing/sending since
+     * we don't have the private key.
+     *
+     * Optional — if omitted, the user must have a matching connected browser wallet
+     * to execute the withdrawal. If neither `withdraw` nor a connected wallet is available,
+     * the modal will show an error.
+     */
+    withdraw?: (txInfo: WithdrawTransactionInfo) => void | Promise<void>;
+    onSuccess?: (data: WithdrawResult) => void;
+    onError?: (error: WithdrawError) => void;
+    onClose?: () => void;
+}
+
 declare function UnifoldProvider({ children, publishableKey, config, }: React.PropsWithChildren<UnifoldConnectProviderConfig>): react_jsx_runtime.JSX.Element;
 declare function useUnifold(): {
     publishableKey: string;
     beginDeposit: (config: DepositConfig) => Promise<DepositResult>;
     closeDeposit: () => void;
+    beginWithdraw: (config: WithdrawConfig) => Promise<WithdrawResult>;
+    closeWithdraw: () => void;
 };
 /**
  * Convenience wrapper for useAllowedCountry that automatically passes publishableKey from context
@@ -110,4 +169,4 @@ declare function useUnifold(): {
  */
 declare function useAllowedCountry(): AllowedCountryResult;
 
-export { type DepositConfig, type DepositError, type DepositResult, type UnifoldConnectProviderConfig, UnifoldProvider, useAllowedCountry, useUnifold };
+export { type DepositConfig, type DepositError, type DepositResult, type UnifoldConnectProviderConfig, UnifoldProvider, type WithdrawConfig, type WithdrawError, type WithdrawResult, useAllowedCountry, useUnifold };