Prompt the user to fund their wallets by calling fundWallet.

import {useFundWallet} from '@privy-io/react-auth/solana';
...
const {fundWallet} = useFundWallet();
await fundWallet('your-wallet-address-here');

Once invoked, the fundWallet method will open a modal that contains a list of funding options the user can take. If only one funding method was enabled for your app, Privy will navigate the user directly to that specific flow.

You can pass additional configurations to the funding flow in the second, optional parameter to fundWallet.

​

Automatically invoking funding

With funding methods enabled for your app, if a user attempts to send a transaction but does not have sufficient funds to do so, Privy will show them an “Add funds” button in the transaction modal that enables them to invoke funding flows.

​

Setting a funding amount in code

Optionally, you can pass in a chain, funding amount, and funding asset to fundWallet to override your Dashboard configuration.

To do so, as the second, optional parameter to fundWallet, pass an object with the following fields:

As examples, you can configure the cluster, amount, and provider to fund like below:

​

Fund with SOL

// `fundWallet` from the useFundWallet() hook
fundWallet('your-wallet-address-here', {
  cluster: {name: 'devnet'},
  amount: '0.01' // SOL
});

​

Fund with Moonpay

fundWallet('your-wallet-address-here', {
  amount: '0.01', // SOL
  card: {
    preferredProvider: 'moonpay'
  }
});

​

Fund with Coinbase exchange immediately

// Replace this with your desired network
import {base} from 'viem/chains'
...
// `fundWallet` from the useFundWallet() hook
fundWallet('your-wallet-address-here', {
  amount: '0.01',
  chain: base,
  card: {
    preferredProvider: 'coinbase',
  },
  defaultFundingMethod: 'exchange'
});

​

Callbacks

To understand when users have gone through a funding flow, you can use the onUserExited callback that can be provided to the useFundWallet hook. The address, chain, fundingMethod, and balance (value of the wallet being funded) are available via the callback, which fires when users exit the funding flow.

For example, if you want to prompt a user to fund their wallet upon logging in for the first time as a part of your onboarding flow:

const {fundWallet} = useFundWallet({
  onUserExited({balance}) {
    if (balance < 1000n) {
      router.push('/insufficient-funds');
    } else {
      router.push('/dashboard');
    }
  }
});

const {login} = useLogin({
  onComplete(user, isNewUser) {
    if (isNewUser && user.wallet?.walletClientType === 'privy') {
      fundWallet(user.wallet.address);
    } else {
      router.push('/dashboard');
    }
  }
});

​

Customizing the “Receive funds” screen

Privy allows to customize the “Receive funds” screen by providing uiConfig options in the fundWallet method. You can set the receiveFundsTitle and receiveFundsSubtitle to customize the title and subtitle of the screen.

You can then call fundWallet like so to customize the UI:

import {useFundWallet} from '@privy-io/react-auth';

// ...
const {fundWallet} = useFundWallet();
fundWallet({
  address: 'your-wallet-address-here',
  uiConfig: {
    receiveFundsTitle: 'Receive 0.05 ETH',
    receiveFundsSubtitle: 'Scan this code or copy your wallet address to receive funds on Base.'
  }
});

This will change the default “Receive funds” screen to:

Prompt the user to fund their wallets by calling fundSolanaWallet.

import { useFundSolanaWallet } from "@privy-io/expo/ui";
...
const {fundWallet} = useFundSolanaWallet();
await fundWallet({address: 'your-wallet-address-here'});

Once invoked, the fundWallet method will open a modal that contains a list of funding options the user can take.

You can pass additional configurations to the funding flow in the second, optional parameter to fundWallet.

​

Setting a funding amount in code

Optionally, you can pass in a chain, funding amount, and funding asset to fundWallet to override your Dashboard configuration.

To do so, as the second, optional parameter to fundWallet, pass an object with the following fields:

As an example, you can configure the cluster and amount to fund like so:

import {useFundSolanaWallet} from '@privy-io/expo/ui';
// ...
const {fundWallet} = useFundSolanaWallet();
fundWallet({
  address: 'address'
  amount: '0.01', // SOL
  defaultPaymentMethod: 'card',
  card: {
    preferredProvider: 'coinbase',
  }
});