@swapped/connect-sdk / react / UseCoinbaseFundingTokensResult

Type Alias: UseCoinbaseFundingTokensResult

UseCoinbaseFundingTokensResult = object

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:34

Result of useCoinbaseFundingTokens.

Properties

aggregatedBalance

aggregatedBalance: CoinbaseSelectionAggregatedBalance

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:56

Combined available balance across selected funding tokens.

---

defaultFundingTokens

defaultFundingTokens: TokenSymbol[]

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:40

Default funding-token symbols suggested for this selection.

---

fundingTokens

fundingTokens: CoinbaseFundingToken[]

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:36

Funding tokens available to cover the withdrawal (including the main token).

---

isDefault

isDefault: boolean

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:54

Whether the current selection matches the defaults.

---

isTokenSelected

isTokenSelected: (currency) => boolean

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:48

Whether the given token is in the funding selection.

Parameters

currency

TokenSymbol

Returns

boolean

---

mainToken

mainToken: CoinbaseFundingToken | undefined

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:38

Primary destination token being withdrawn.

---

reorder

reorder: (fromIndex, toIndex) => void

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:50

Reorder selected funding tokens by index.

Parameters

fromIndex

number

toIndex

number

Returns

void

---

reset

reset: () => void

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:52

Reset funding tokens to the default selection.

Returns

void

---

selected

selected: TokenSymbol[]

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:42

Currently selected funding-token symbols.

---

setSelected

setSelected: (tokens) => void

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:44

Replace the selected funding-token list.

Parameters

tokens

TokenSymbol[]

Returns

void

---

toggle

toggle: (currency) => void

Defined in: src/react/coinbase/hooks/useCoinbaseFundingTokens.ts:46

Toggle a funding token in or out of the selection.

Parameters

currency

TokenSymbol

Returns

void