Skip to content

useCoinbaseFundingTokens

Select optional funding tokens and read the aggregated balance for the destination currency.

When to use

Inside CoinbaseProvider, after a token is selected. Pass aggregatedBalance into limits / networks automatically via the provider; selected symbols are included when you call startWithdrawal().

Example

tsx
import { useCoinbaseFundingTokens } from '@swapped/connect-sdk/react'

function FundingPicker() {
  const funding = useCoinbaseFundingTokens()

  return (
    <ul>
      {funding.fundingTokens.map(token => (
        <li key={token.currency}>
          {token.currency} {token.formatted.balance}
          <button type="button" onClick={() => funding.toggle(token.currency)}>
            {funding.isTokenSelected(token.currency) ? 'Selected' : 'Add'}
          </button>
        </li>
      ))}
      <p>
        Aggregated: {funding.aggregatedBalance.formatted.balance} (~$
        {funding.aggregatedBalance.formatted.valueFiat})
      </p>
    </ul>
  )
}

Returns

ReturnPurpose
fundingTokensCandidates
selected / setSelected / toggle / isTokenSelected / reorder / resetSelection state
defaultFundingTokens / isDefaultDefaults
aggregatedBalanceCombined balance for min/max

Requires CoinbaseProvider. Destination currency comes from useCoinbaseToken.

Errors

Local helpers — no Coinbase API throw from this hook. Ensure balances loaded successfully first (balances).