Skip to content

Commit

Permalink
chore: stop exporting REDESIGN_DEV_TRANSACTION_TYPES
Browse files Browse the repository at this point in the history
  • Loading branch information
cryptotavares committed Nov 19, 2024
1 parent a59ed51 commit 2cd99ef
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 46 deletions.
12 changes: 7 additions & 5 deletions shared/modules/confirmation.utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ const REDESIGN_USER_TRANSACTION_TYPES = [
];

/** List of transaction types that support the redesigned confirmation flow for developers */
export const REDESIGN_DEV_TRANSACTION_TYPES = [
...REDESIGN_USER_TRANSACTION_TYPES,
];
const REDESIGN_DEV_TRANSACTION_TYPES = [...REDESIGN_USER_TRANSACTION_TYPES];

/**
* Determines whether to use the redesigned confirmation flow for a given transaction
Expand Down Expand Up @@ -97,9 +95,13 @@ export function isCorrectSignatureApprovalType(
*
* @param transactionMetadataType - The type of transaction to check
*/
function isCorrectDeveloperTransactionType(
transactionMetadataType: TransactionType,
export function isCorrectDeveloperTransactionType(
transactionMetadataType?: TransactionType,
): boolean {
if (!transactionMetadataType) {
return false;
}

return REDESIGN_DEV_TRANSACTION_TYPES.includes(transactionMetadataType);
}

Expand Down
7 changes: 4 additions & 3 deletions ui/pages/confirmations/components/confirm/footer/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import { getConfirmationSender } from '../utils';
import { MetaMetricsEventLocation } from '../../../../../../shared/constants/metametrics';
import { Alert } from '../../../../../ducks/confirm-alerts/confirm-alerts';
import { Severity } from '../../../../../helpers/constants/design-system';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../../shared/modules/confirmation.utils';

export type OnCancelHandler = ({
location,
Expand Down Expand Up @@ -218,9 +218,10 @@ const Footer = () => {
return;
}

const isTransactionConfirmation = REDESIGN_DEV_TRANSACTION_TYPES.find(
(type) => type === currentConfirmation?.type,
const isTransactionConfirmation = isCorrectDeveloperTransactionType(
currentConfirmation?.type,
);

if (isTransactionConfirmation) {
const mergeTxDataWithNonce = (transactionData: TransactionMeta) =>
customNonceValue
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { TransactionType } from '@metamask/transaction-controller';
import React, { useContext } from 'react';
import { useSelector } from 'react-redux';
import {
Expand Down Expand Up @@ -43,7 +42,7 @@ import { useBalance } from '../../../hooks/useBalance';
import useConfirmationRecipientInfo from '../../../hooks/useConfirmationRecipientInfo';
import { SignatureRequestType } from '../../../types/confirm';
import { isSignatureTransactionType } from '../../../utils/confirm';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../../shared/modules/confirmation.utils';
import { AdvancedDetailsButton } from './advanced-details-button';

const HeaderInfo = () => {
Expand Down Expand Up @@ -87,8 +86,8 @@ const HeaderInfo = () => {
trackEvent(event);
}

const isShowAdvancedDetailsToggle = REDESIGN_DEV_TRANSACTION_TYPES.includes(
currentConfirmation?.type as TransactionType,
const isShowAdvancedDetailsToggle = isCorrectDeveloperTransactionType(
currentConfirmation?.type,
);

return (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React, { useContext, useEffect } from 'react';
import { useSelector } from 'react-redux';
import { TransactionType } from '@metamask/transaction-controller';
import {
Box,
ButtonIcon,
Expand All @@ -21,7 +20,7 @@ import { usePrevious } from '../../../../../hooks/usePrevious';
import { useScrollRequired } from '../../../../../hooks/useScrollRequired';
import { useConfirmContext } from '../../../context/confirm';
import { selectConfirmationAdvancedDetailsOpen } from '../../../selectors/preferences';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../../shared/modules/confirmation.utils';

type ContentProps = {
/**
Expand Down Expand Up @@ -51,8 +50,8 @@ const ScrollToBottom = ({ children }: ContentProps) => {
offsetPxFromBottom: 0,
});

const isTransactionRedesign = REDESIGN_DEV_TRANSACTION_TYPES.includes(
currentConfirmation?.type as TransactionType,
const isTransactionRedesign = isCorrectDeveloperTransactionType(
currentConfirmation?.type,
);

const showScrollToBottom =
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
import {
TransactionMeta,
TransactionType,
} from '@metamask/transaction-controller';
import { TransactionMeta } from '@metamask/transaction-controller';
import { useMemo } from 'react';
import { useSelector } from 'react-redux';

Expand All @@ -11,17 +8,15 @@ import { Alert } from '../../../../../ducks/confirm-alerts/confirm-alerts';
import { Severity } from '../../../../../helpers/constants/design-system';
import { RowAlertKey } from '../../../../../components/app/confirm/info/row/constants';
import { useConfirmContext } from '../../../context/confirm';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../../shared/modules/confirmation.utils';

export function usePendingTransactionAlerts(): Alert[] {
const t = useI18nContext();
const { currentConfirmation } = useConfirmContext();
const { type } = currentConfirmation ?? ({} as TransactionMeta);
const pendingTransactions = useSelector(submittedPendingTransactionsSelector);

const isValidType = REDESIGN_DEV_TRANSACTION_TYPES.includes(
type as TransactionType,
);
const isValidType = isCorrectDeveloperTransactionType(type);

const hasPendingTransactions =
isValidType && Boolean(pendingTransactions.length);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
import {
TransactionMeta,
TransactionType,
} from '@metamask/transaction-controller';
import { TransactionMeta } from '@metamask/transaction-controller';
import { useMemo } from 'react';
import { useSelector } from 'react-redux';

Expand All @@ -10,7 +7,7 @@ import { Severity } from '../../../../../helpers/constants/design-system';
import { useI18nContext } from '../../../../../hooks/useI18nContext';
import { Alert } from '../../../../../ducks/confirm-alerts/confirm-alerts';
import { useConfirmContext } from '../../../context/confirm';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../../shared/modules/confirmation.utils';

export function useSigningOrSubmittingAlerts(): Alert[] {
const t = useI18nContext();
Expand All @@ -21,9 +18,7 @@ export function useSigningOrSubmittingAlerts(): Alert[] {
getApprovedAndSignedTransactions,
);

const isValidType = REDESIGN_DEV_TRANSACTION_TYPES.includes(
type as TransactionType,
);
const isValidType = isCorrectDeveloperTransactionType(type);

const isSigningOrSubmitting =
isValidType && signingOrSubmittingTransactions.length > 0;
Expand Down
10 changes: 3 additions & 7 deletions ui/pages/confirmations/hooks/alerts/useBlockaidAlerts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { Alert } from '../../../../ducks/confirm-alerts/confirm-alerts';
import ZENDESK_URLS from '../../../../helpers/constants/zendesk-url';
import { useI18nContext } from '../../../../hooks/useI18nContext';
import { SIGNATURE_TRANSACTION_TYPES } from '../../utils';
import { REDESIGN_DEV_TRANSACTION_TYPES } from '../../../../../shared/modules/confirmation.utils';
import { isCorrectDeveloperTransactionType } from '../../../../../shared/modules/confirmation.utils';
import {
SecurityAlertResponse,
SignatureRequestType,
Expand All @@ -28,11 +28,6 @@ import { normalizeProviderAlert } from './utils';
// eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
const zlib = require('zlib');

const SUPPORTED_TRANSACTION_TYPES = [
...SIGNATURE_TRANSACTION_TYPES,
...REDESIGN_DEV_TRANSACTION_TYPES,
];

const IGNORED_RESULT_TYPES = [
BlockaidResultType.Benign,
BlockaidResultType.Loading,
Expand Down Expand Up @@ -72,7 +67,8 @@ const useBlockaidAlerts = (): Alert[] => {
signatureSecurityAlertResponse || transactionSecurityAlertResponse;

const isTransactionTypeSupported =
SUPPORTED_TRANSACTION_TYPES.includes(transactionType);
isCorrectDeveloperTransactionType(transactionType) ||
SIGNATURE_TRANSACTION_TYPES.includes(transactionType);

const isResultTypeIgnored = IGNORED_RESULT_TYPES.includes(
securityAlertResponse?.result_type as BlockaidResultType,
Expand Down
13 changes: 6 additions & 7 deletions ui/pages/routes/routes.component.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ import NftFullImage from '../../components/app/assets/nfts/nft-details/nft-full-
import CrossChainSwap from '../bridge';
import { ToastMaster } from '../../components/app/toast-master/toast-master';
import {
REDESIGN_DEV_TRANSACTION_TYPES,
isCorrectDeveloperTransactionType,
isCorrectSignatureApprovalType,
} from '../../../shared/modules/confirmation.utils';
import {
Expand Down Expand Up @@ -474,18 +474,17 @@ export default class Routes extends Component {
const isCorrectApprovalType = isCorrectSignatureApprovalType(
pendingApproval?.type,
);
const isCorrectDeveloperTransactionType =
REDESIGN_DEV_TRANSACTION_TYPES.includes(
transactionsMetadata[confirmationId]?.type,
);
const isCorrectTransactionType = isCorrectDeveloperTransactionType(
transactionsMetadata[confirmationId]?.type,
);

let isLoadingShown =
isLoading &&
completedOnboarding &&
// In the redesigned screens, we hide the general loading spinner and the
// loading states are on a component by component basis.
!isCorrectApprovalType &&
!isCorrectDeveloperTransactionType;
!isCorrectTransactionType;

///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
isLoadingShown =
Expand All @@ -499,7 +498,7 @@ export default class Routes extends Component {
// In the redesigned screens, we hide the general loading spinner and the
// loading states are on a component by component basis.
!isCorrectApprovalType &&
!isCorrectDeveloperTransactionType;
!isCorrectTransactionType;
///: END:ONLY_INCLUDE_IF

return (
Expand Down

0 comments on commit 2cd99ef

Please sign in to comment.