Connect SDK

Appearance

@swapped/connect-sdk / react / UseCoinbaseSelectionResult

Type Alias: UseCoinbaseSelectionResult ​

UseCoinbaseSelectionResult = object

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:13

Result of useCoinbaseSelection.

Properties ​

aggregatedBalance ​

aggregatedBalance: CoinbaseSelectionAggregatedBalance

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:27

Combined available balance across selected funding tokens.

amount ​

amount: string

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:29

Full-precision crypto amount from useCoinbaseAmount.

amountFiat ​

amountFiat: string

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:33

Fiat amount string from useCoinbaseAmount.

amountFiatFloat ​

amountFiatFloat: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:35

Numeric representation of amountFiat, or null when empty or invalid.

amountFloat ​

amountFloat: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:31

Numeric representation of amount, or null when empty or invalid.

canSubmit ​

canSubmit: boolean

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:41

Whether token, network, and amount are ready to start a withdrawal.

fundingTokens ​

fundingTokens: CoinbaseFundingToken[]

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:25

Funding tokens available for the current destination token.

maxAmount ​

maxAmount: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:39

Maximum withdrawable token amount, or null while loading / unavailable.

minAmount ​

minAmount: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:37

Minimum withdrawable token amount, or null while loading / unavailable.

reset ​

reset: () => void

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:43

Clear token, network, funding tokens, and amount selection.

Returns ​

void

selectedBalance ​

selectedBalance: CoinbaseBalance | undefined

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:17

Balance row for the selected token, or undefined when none.

selectedCurrency ​

selectedCurrency: TokenSymbol | undefined

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:15

Selected withdrawal token symbol, or undefined when none.

selectedFundingTokens ​

selectedFundingTokens: TokenSymbol[]

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:23

Funding-token symbols currently selected.

selectedNetwork ​

selectedNetwork: Network | undefined

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:19

Selected network enum value, or undefined when none.

selectedNetworkItem ​

selectedNetworkItem: CoinbaseNetworkItem | undefined

Defined in: src/react/coinbase/hooks/useCoinbaseSelection.ts:21

Full network item for the selection, or undefined when none.