mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-27 21:00:13 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
65 lines
2.2 KiB
JavaScript
65 lines
2.2 KiB
JavaScript
import { useMemo } from 'react'
|
|
import { useSelector } from 'react-redux'
|
|
import {
|
|
getTokenExchangeRates,
|
|
getConversionRate,
|
|
getCurrentCurrency,
|
|
getShouldShowFiat,
|
|
} from '../selectors'
|
|
import { getTokenFiatAmount } from '../helpers/utils/token-util'
|
|
|
|
/**
|
|
* Get the token balance converted to fiat and formatted for display
|
|
*
|
|
* @param {string} [tokenAddress] - The token address
|
|
* @param {string} [tokenAmount] - The token balance
|
|
* @param {string} [tokenSymbol] - The token symbol
|
|
* @param {Object} [overrides] - A configuration object that allows the caller to explicitly pass an exchange rate or
|
|
* ensure fiat is shown even if the property is not set in state.
|
|
* @param {number} [overrides.exchangeRate] - An exhchange rate to use instead of the one selected from state
|
|
* @param {boolean} [overrides.showFiat] - If truthy, ensures the fiat value is shown even if the showFiat value from state is falsey
|
|
* @param {boolean} hideCurrencySymbol Indicates whether the returned formatted amount should include the trailing currency symbol
|
|
* @return {string} - The formatted token amount in the user's chosen fiat currency
|
|
*/
|
|
export function useTokenFiatAmount(
|
|
tokenAddress,
|
|
tokenAmount,
|
|
tokenSymbol,
|
|
overrides = {},
|
|
hideCurrencySymbol,
|
|
) {
|
|
const contractExchangeRates = useSelector(getTokenExchangeRates)
|
|
const conversionRate = useSelector(getConversionRate)
|
|
const currentCurrency = useSelector(getCurrentCurrency)
|
|
const userPrefersShownFiat = useSelector(getShouldShowFiat)
|
|
const showFiat = overrides.showFiat ?? userPrefersShownFiat
|
|
const tokenExchangeRate =
|
|
overrides.exchangeRate ?? contractExchangeRates[tokenAddress]
|
|
const formattedFiat = useMemo(
|
|
() =>
|
|
getTokenFiatAmount(
|
|
tokenExchangeRate,
|
|
conversionRate,
|
|
currentCurrency,
|
|
tokenAmount,
|
|
tokenSymbol,
|
|
true,
|
|
hideCurrencySymbol,
|
|
),
|
|
[
|
|
tokenExchangeRate,
|
|
conversionRate,
|
|
currentCurrency,
|
|
tokenAmount,
|
|
tokenSymbol,
|
|
hideCurrencySymbol,
|
|
],
|
|
)
|
|
|
|
if (!showFiat || currentCurrency.toUpperCase() === tokenSymbol) {
|
|
return undefined
|
|
}
|
|
|
|
return formattedFiat
|
|
}
|