Skip to content

Documentation / react-auth / UseFundWalletInterface

Interface: UseFundWalletInterface

Method to fund a user's wallet via Privy's funding feature by inputting a valid wallet address. You can access the fields and methods documented here via the useFundWallet hook.

Properties

fundWallet

fundWallet: (address, fundWalletConfig?) => Promise<void>

Prompt the user to go through the funding flow and for a specified wallet.

This will open the modal with a prompt for the user to select a funding method (if multiple are enabled).

Once the user continues to the funding flow, Privy will display the funding status screen, and wait for the transaction to complete.

Note: Even after a successful funding, funds can take a few minutes to arrive in the user's wallet.

Privy currently supports funding via external wallets and Moonpay.

Parameters

address: string

typed data payload to be signed

fundWalletConfig?: FundWalletConfig

FundWalletConfig Funding configuration to specify chain and funding amount (if enabled)

Returns

Promise<void>