useNativeTokenAmountFromPlanck()
Call Signature
function useNativeTokenAmountFromPlanck<TUse>(planck, options?): When<TUse, DenominatedNumber, Promise<DenominatedNumber>>;
Defined in: packages/react/src/hooks/use-native-token-amount.ts:20
Hook for returning the native token amount from a planck value.
Type Parameters
| Type Parameter | Default type |
|---|---|
TUse extends boolean | true |
Parameters
| Parameter | Type | Description |
|---|---|---|
planck | string | number | bigint | The planck value |
options? | Partial<ChainOptions<string | number | undefined>> & SuspenseOptions<TUse> | Additional options |
Returns
When<TUse, DenominatedNumber, Promise<DenominatedNumber>>
The native token amount
Call Signature
function useNativeTokenAmountFromPlanck<TUse>(options?): When<TUse, (planck) => DenominatedNumber, Promise<(planck) => DenominatedNumber>>;
Defined in: packages/react/src/hooks/use-native-token-amount.ts:31
Hook for returning a function that converts planck value to native token amount.
Type Parameters
| Type Parameter | Default type |
|---|---|
TUse extends boolean | true |
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | Partial<ChainOptions<string | number | undefined>> & SuspenseOptions<TUse> | Additional options |
Returns
When<TUse, (planck) => DenominatedNumber, Promise<(planck) => DenominatedNumber>>
Function for getting the native token amount from a planck value