mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-27 12:56:01 +01:00
3732c5f71e
ESLint rules have been added to enforce our JSDoc conventions. These rules were introduced by updating `@metamask/eslint-config` to v9. Some of the rules have been disabled because the effort to fix all lint errors was too high. It might be easiest to enable these rules one directory at a time, or one rule at a time. Most of the changes in this PR were a result of running `yarn lint:fix`. There were a handful of manual changes that seemed obvious and simple to make. Anything beyond that and the rule was left disabled.
79 lines
3.0 KiB
JavaScript
79 lines
3.0 KiB
JavaScript
import { useSelector } from 'react-redux';
|
|
import { TRANSACTION_TYPES } from '../../shared/constants/transaction';
|
|
import {
|
|
isSwapsDefaultTokenAddress,
|
|
isSwapsDefaultTokenSymbol,
|
|
} from '../../shared/modules/swaps.utils';
|
|
import { getSwapsTokensReceivedFromTxMeta } from '../pages/swaps/swaps.util';
|
|
import { getCurrentChainId } from '../selectors';
|
|
import { useTokenFiatAmount } from './useTokenFiatAmount';
|
|
|
|
/**
|
|
* @typedef {Object} SwappedTokenValue
|
|
* @property {string} swapTokenValue - a primary currency string formatted for display
|
|
* @property {string} swapTokenFiatAmount - a secondary currency string formatted for display
|
|
* @property {boolean} isViewingReceivedTokenFromSwap - true if user is on the asset page for the
|
|
* destination/received asset in a swap.
|
|
*/
|
|
|
|
/**
|
|
* A Swap transaction group's primaryTransaction contains details of the swap,
|
|
* including the source (from) and destination (to) token type (ETH, DAI, etc..)
|
|
* When viewing an asset page that is not for the current chain's default token, we
|
|
* need to determine if that asset is the token that was received (destination) from
|
|
* the swap. In that circumstance we would want to show the primaryCurrency in the
|
|
* activity list that is most relevant for that token (- 1000 DAI, for example, when
|
|
* swapping DAI for ETH).
|
|
*
|
|
* @param {import('../selectors').transactionGroup} transactionGroup - Group of transactions by nonce
|
|
* @param {import('./useTokenDisplayValue').Token} currentAsset - The current asset the user is looking at
|
|
* @returns {SwappedTokenValue}
|
|
*/
|
|
export function useSwappedTokenValue(transactionGroup, currentAsset) {
|
|
const { symbol, decimals, address } = currentAsset;
|
|
const { primaryTransaction, initialTransaction } = transactionGroup;
|
|
const { type } = initialTransaction;
|
|
const { from: senderAddress } = initialTransaction.txParams || {};
|
|
const chainId = useSelector(getCurrentChainId);
|
|
|
|
const isViewingReceivedTokenFromSwap =
|
|
currentAsset?.symbol === primaryTransaction.destinationTokenSymbol ||
|
|
(isSwapsDefaultTokenAddress(currentAsset.address, chainId) &&
|
|
isSwapsDefaultTokenSymbol(
|
|
primaryTransaction.destinationTokenSymbol,
|
|
chainId,
|
|
));
|
|
|
|
const swapTokenValue =
|
|
type === TRANSACTION_TYPES.SWAP && isViewingReceivedTokenFromSwap
|
|
? getSwapsTokensReceivedFromTxMeta(
|
|
primaryTransaction.destinationTokenSymbol,
|
|
initialTransaction,
|
|
address,
|
|
senderAddress,
|
|
decimals,
|
|
null,
|
|
chainId,
|
|
)
|
|
: type === TRANSACTION_TYPES.SWAP && primaryTransaction.swapTokenValue;
|
|
|
|
const isNegative =
|
|
typeof swapTokenValue === 'string'
|
|
? Math.sign(swapTokenValue) === -1
|
|
: false;
|
|
|
|
const _swapTokenFiatAmount = useTokenFiatAmount(
|
|
address,
|
|
swapTokenValue || '',
|
|
symbol,
|
|
);
|
|
const swapTokenFiatAmount =
|
|
swapTokenValue && isViewingReceivedTokenFromSwap && _swapTokenFiatAmount;
|
|
return {
|
|
swapTokenValue,
|
|
swapTokenFiatAmount,
|
|
isViewingReceivedTokenFromSwap,
|
|
isNegative,
|
|
};
|
|
}
|