Connect SDK

Appearance

@swapped/connect-sdk / react / UseCoinbaseLimitsResult

Type Alias: UseCoinbaseLimitsResult ​

UseCoinbaseLimitsResult = object

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:26

Result of useCoinbaseLimits.

Properties ​

balanceMax ​

balanceMax: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:32

Hard maximum: raw aggregated balance, or null.

balanceMaxFiat ​

balanceMaxFiat: number | null

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

Hard maximum in fiat, or null when unavailable.

error ​

error: Error | null

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:61

Last limits-fetch error, or null.

feeReserve ​

feeReserve: number | null

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

Fee reserve held back from the spendable max, or null when unavailable.

feeReserveFiat ​

feeReserveFiat: number | null

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

Fee reserve in fiat, or null when unavailable.

formatted ​

formatted: object

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

Display-ready limit strings. Prefer over formatting raw limits yourself.

feeReserve ​

feeReserve: string | null

Display-ready fee reserve (crypto), or null.

feeReserveFiat ​

feeReserveFiat: string | null

Display-ready fee reserve (fiat), or null.

maxAmount ​

maxAmount: string | null

Display-ready spendable maximum (crypto), or null.

maxAmountFiat ​

maxAmountFiat: string | null

Display-ready spendable maximum (fiat), or null.

minAmount ​

minAmount: string | null

Display-ready minimum (crypto), or null.

minAmountFiat ​

minAmountFiat: string | null

Display-ready minimum (fiat), or null.

isLoading ​

isLoading: boolean

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:59

Whether limits are still loading.

maxAmount ​

maxAmount: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:30

Soft / spendable maximum (balance minus fee reserve), or null.

maxAmountFiat ​

maxAmountFiat: number | null

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

Soft / spendable maximum in fiat, or null when unavailable.

minAmount ​

minAmount: number | null

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:28

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

minAmountFiat ​

minAmountFiat: number | null

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

Minimum withdrawable amount in fiat, or null when unavailable.

refetch ​

refetch: () => Promise<void>

Defined in: src/react/coinbase/hooks/useCoinbaseLimits.ts:63

Re-fetch min/max/fee-reserve limits.

Returns ​

Promise<void>