Skip to content

fix: For batch transactions sum total of gas needed for all transactions in the batched should be check to show insufficient funds error #31555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@ import { ApprovalType } from '@metamask/controller-utils';
import {
TransactionMeta,
TransactionParams,
TransactionType,
} from '@metamask/transaction-controller';
import { createMockInternalAccount } from '../../../../../../test/jest/mocks';
import { getMockConfirmState } from '../../../../../../test/data/confirmations/helper';
import { genUnapprovedContractInteractionConfirmation } from '../../../../../../test/data/confirmations/contract-interaction';
import { renderHookWithConfirmContextProvider } from '../../../../../../test/lib/confirmations/render-helpers';
import { Severity } from '../../../../../helpers/constants/design-system';
import { RowAlertKey } from '../../../../../components/app/confirm/info/row/constants';
import { useInsufficientBalanceAlerts } from './useInsufficientBalanceAlerts';

const TRANSACTION_ID_MOCK = '123-456';
Expand All @@ -27,6 +26,24 @@ const TRANSACTION_MOCK = {
} as TransactionParams,
} as TransactionMeta;

const ALERT = [
{
actions: [
{
key: 'buy',
label: 'Buy ETH',
},
],
field: 'estimatedFee',
isBlocking: true,
key: 'insufficientBalance',
message:
'You do not have enough ETH in your account to pay for network fees.',
reason: 'Insufficient funds',
severity: 'danger',
},
];

function buildState({
balance,
currentConfirmation,
Expand Down Expand Up @@ -113,6 +130,38 @@ describe('useInsufficientBalanceAlerts', () => {
).toEqual([]);
});

it('returns alerts for batch transaction if account has balance less than total of the transactions in the batch', () => {
const BATCH_TRANSACTION_MOCK = {
...TRANSACTION_MOCK,
nestedTransactions: [
{
to: '0x1234567890123456789012345678901234567890',
value: '0x3B9ACA00',
type: TransactionType.simpleSend,
},
{
to: '0x1234567890123456789012345678901234567891',
value: '0x1DCD6500',
type: TransactionType.simpleSend,
},
],
};
expect(
runHook({
balance: 210000000002,
currentConfirmation: TRANSACTION_MOCK as Partial<TransactionMeta>,
transaction: TRANSACTION_MOCK as Partial<TransactionMeta>,
}),
).toEqual([]);
expect(
runHook({
balance: 210000000002,
currentConfirmation: BATCH_TRANSACTION_MOCK as Partial<TransactionMeta>,
transaction: BATCH_TRANSACTION_MOCK as Partial<TransactionMeta>,
}),
).toEqual(ALERT);
});

it('returns no alerts if account has balance greater than gas fee plus value', () => {
expect(
runHook({
Expand Down Expand Up @@ -140,22 +189,6 @@ describe('useInsufficientBalanceAlerts', () => {
transaction: TRANSACTION_MOCK,
});

expect(alerts).toEqual([
{
actions: [
{
key: 'buy',
label: 'Buy ETH',
},
],
field: RowAlertKey.EstimatedFee,
isBlocking: true,
key: 'insufficientBalance',
message:
'You do not have enough ETH in your account to pay for network fees.',
reason: 'Insufficient funds',
severity: Severity.Danger,
},
]);
expect(alerts).toEqual(ALERT);
});
});
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Hex } from '@metamask/utils';
import { useMemo } from 'react';
import { useSelector } from 'react-redux';

Expand All @@ -17,11 +18,23 @@ import {
RowAlertKey,
} from '../../../../../components/app/confirm/info/row/constants';
import { useConfirmContext } from '../../../context/confirm';
import {
decimalToHex,
multiplyHexes,
sumHexes,
} from '../../../../../../shared/modules/conversion.utils';

export function useInsufficientBalanceAlerts(): Alert[] {
const t = useI18nContext();
const { currentConfirmation } = useConfirmContext<TransactionMeta>();
const { id: transactionId, selectedGasFeeToken } = currentConfirmation ?? {};
const batchTransactionCount =
currentConfirmation?.nestedTransactions?.length ?? 0;

const batchTransactionValues =
currentConfirmation?.nestedTransactions?.map(
(trxn) => (trxn.value as Hex) ?? 0x0,
) ?? [];

const balance = useSelector((state) =>
selectTransactionAvailableBalance(state, transactionId),
Expand All @@ -31,15 +44,20 @@ export function useInsufficientBalanceAlerts(): Alert[] {
selectTransactionValue(state, transactionId),
);

const totalValue = sumHexes(value, ...batchTransactionValues);

const { hexMaximumTransactionFee } = useSelector((state) =>
selectTransactionFeeById(state, transactionId),
);

const nativeCurrency = useSelector(getMultichainNativeCurrency);

const insufficientBalance = !isBalanceSufficient({
amount: value,
gasTotal: hexMaximumTransactionFee,
amount: totalValue,
gasTotal: multiplyHexes(
hexMaximumTransactionFee as Hex,
decimalToHex(batchTransactionCount + 1) as Hex,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As these are EIP-7702 batches, there is only one transaction so one gas fee, so no need to multiply.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I see, let me fix this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR is updated

),
balance,
});

Expand Down
3 changes: 2 additions & 1 deletion ui/pages/confirmations/send/send.utils.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { encode } from '@metamask/abi-utils';
import { isHexString } from '@metamask/utils';
// TODO: Remove restricted import
// eslint-disable-next-line import/no-restricted-paths
import { addHexPrefix } from '../../../../app/scripts/lib/util';
Expand Down Expand Up @@ -30,7 +31,7 @@ function isBalanceSufficient({
primaryCurrency = undefined,
}) {
let totalAmount = new Numeric(amount, 16).add(new Numeric(gasTotal, 16));
let balanceNumeric = new Numeric(balance, 16);
let balanceNumeric = new Numeric(balance, isHexString(balance) ? 16 : 10);

if (typeof primaryCurrency !== 'undefined' && primaryCurrency !== null) {
totalAmount = totalAmount.applyConversionRate(conversionRate);
Expand Down
Loading