mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-27 21:00:13 +01:00
6e13524bcd
Co-authored-by: metamaskbot <metamaskbot@users.noreply.github.com> Co-authored-by: Brad Decker <bhdecker84@gmail.com> Co-authored-by: Akintayo A. Olusegun <akintayo.segun@gmail.com>
61 lines
2.5 KiB
JavaScript
61 lines
2.5 KiB
JavaScript
import { useMemo } from 'react';
|
|
import { getTokenValueParam } from '../../shared/lib/metamask-controller-utils';
|
|
import { calcTokenAmount } from '../../shared/lib/transactions-controller-utils';
|
|
import { useTokenData } from './useTokenData';
|
|
|
|
/**
|
|
* Defines the shape for the Token input parameter for useTokenDisplayValue
|
|
*
|
|
* @typedef {object} Token
|
|
* @property {string} symbol - The string to use as a suffix for the token (eg. DAI)
|
|
* @property {number} decimals - The number of decimals to show when displaying this type of token
|
|
*/
|
|
|
|
/**
|
|
* useTokenDisplayValue
|
|
* Given the data string from txParams and a token object with symbol and decimals, return
|
|
* a displayValue that represents a string representing that token amount as a string. Also
|
|
* return a tokenData object for downstream usage and the suffix for the token to use as props
|
|
* for other hooks and/or components
|
|
*
|
|
* @param {string} [transactionData] - Raw data string from token transaction
|
|
* @param {Token} [token] - The token associated with this transaction
|
|
* @param {boolean} [isTokenTransaction] - Due to the nature of hooks, it isn't possible
|
|
* to conditionally call this hook. This flag will
|
|
* force this hook to return null if it set as false
|
|
* which indicates the transaction is not associated
|
|
* with a token.
|
|
* @returns {string} The computed displayValue of the provided transactionData and token
|
|
*/
|
|
export function useTokenDisplayValue(
|
|
transactionData,
|
|
token,
|
|
isTokenTransaction = true,
|
|
) {
|
|
const tokenData = useTokenData(transactionData, isTokenTransaction);
|
|
const tokenValue = getTokenValueParam(tokenData);
|
|
|
|
const shouldCalculateTokenValue = Boolean(
|
|
// If we are currently processing a token transaction
|
|
isTokenTransaction &&
|
|
// and raw transaction data string is provided
|
|
transactionData &&
|
|
// and a token object has been provided
|
|
token &&
|
|
// and the provided token object contains a defined decimal value we need to calculate amount
|
|
token.decimals &&
|
|
// and we are able to parse the token detail we to calculate amount from the raw data
|
|
tokenValue,
|
|
);
|
|
|
|
const displayValue = useMemo(() => {
|
|
if (!shouldCalculateTokenValue) {
|
|
return null;
|
|
}
|
|
|
|
return calcTokenAmount(tokenValue, token.decimals).toString(10);
|
|
}, [shouldCalculateTokenValue, tokenValue, token]);
|
|
|
|
return displayValue;
|
|
}
|