Skip to content

Commit 1dcc8e2

Browse files
authored
fix: skip calling getFees for sponsored transactions (#37355)
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** <!-- Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions: 1. What is the reason for the change? 2. What is the improvement/solution? --> 1. There is a bug in smart transaction hook that when submitting signed transaction, it still call `getFees` even though it's not needed. This leads to sponsored transactions to fail to submit due to `getFees` call throw errors when users have insufficient funds. 2. To solve this, we'll skip calling `getFees` if transaction is already signed or it's a batch [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/37355?quickstart=1) ## **Changelog** <!-- If this PR is not End-User-Facing and should not show up in the CHANGELOG, you can choose to either: 1. Write `CHANGELOG entry: null` 2. Label with `no-changelog` If this PR is End-User-Facing, please write a short User-Facing description in the past tense like: `CHANGELOG entry: Added a new tab for users to see their NFTs` `CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker` (This helps the Release Engineer do their job more quickly and accurately) --> CHANGELOG entry: ## **Related issues** Fixes: ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <!-- [screenshots/recordings] --> ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [x] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [x] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Conditionally bypasses getFees for pre-signed sponsored smart transactions and updates tests to cover the new behavior and error handling. > > - **Smart Transactions Logic**: > - Skip calling `getFees` when `signedTransactionInHex` is present and `transactionMeta.isGasFeeSponsored` is true. > - Retain `getFees` try/catch with fallback to regular submission on error. > - Continue normal sign-and-submit flow and status page handling. > - **Tests**: > - Add test verifying fees are not fetched for signed, sponsored transactions and that `submitSignedTransactions` is called. > - Strengthen error-path test to assert `getFees` was invoked before fallback. > - Ensure ASAP tx-hash return behavior remains validated via feature flag. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 06aeccd. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 67fcea3 commit 1dcc8e2

File tree

2 files changed

+38
-13
lines changed

2 files changed

+38
-13
lines changed

app/scripts/lib/smart-transaction/smart-transactions.test.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,31 @@ describe('submitSmartTransactionHook', () => {
285285
throw new Error('Backend call to /getFees failed');
286286
});
287287
const result = await submitSmartTransactionHook(request);
288+
expect(request.smartTransactionsController.getFees).toHaveBeenCalled();
288289
expect(endFlowSpy).toHaveBeenCalledWith({
289290
id: 'approvalId',
290291
});
291292
expect(result).toEqual({ transactionHash: undefined });
292293
});
293294
});
294295

296+
it('skips getting fees if the transaction is signed and sponsored', async () => {
297+
withRequest(async ({ request }) => {
298+
request.transactionMeta.isGasFeeSponsored = true;
299+
request.featureFlags.smartTransactions.extensionReturnTxHashAsap = true;
300+
301+
const result = await submitSmartTransactionHook(request);
302+
303+
expect(
304+
request.smartTransactionsController.getFees,
305+
).not.toHaveBeenCalled();
306+
expect(
307+
request.smartTransactionsController.submitSignedTransactions,
308+
).toHaveBeenCalled();
309+
expect(result).toEqual({ transactionHash: txHash });
310+
});
311+
});
312+
295313
it('returns a txHash asap if the feature flag requires it', async () => {
296314
withRequest(async ({ request }) => {
297315
request.featureFlags.smartTransactions.extensionReturnTxHashAsap = true;

app/scripts/lib/smart-transaction/smart-transactions.ts

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -169,20 +169,27 @@ class SmartTransactionHook {
169169
if (this.#shouldShowStatusPage) {
170170
await this.#startApprovalFlow();
171171
}
172+
172173
let getFeesResponse;
173-
try {
174-
getFeesResponse = await this.#smartTransactionsController.getFees(
175-
{ ...this.#txParams, chainId: this.#chainId },
176-
undefined,
177-
{ networkClientId: this.#transactionMeta.networkClientId },
178-
);
179-
} catch (error) {
180-
log.error(
181-
'Error in smart transaction publish hook, falling back to regular transaction submission',
182-
error,
183-
);
184-
this.#onApproveOrReject();
185-
return useRegularTransactionSubmit; // Fallback to regular transaction submission.
174+
// Skip getting fees if the tx is signed and sponsored
175+
if (
176+
!this.#signedTransactionInHex ||
177+
!this.#transactionMeta.isGasFeeSponsored
178+
) {
179+
try {
180+
getFeesResponse = await this.#smartTransactionsController.getFees(
181+
{ ...this.#txParams, chainId: this.#chainId },
182+
undefined,
183+
{ networkClientId: this.#transactionMeta.networkClientId },
184+
);
185+
} catch (error) {
186+
log.error(
187+
'Error in smart transaction publish hook, falling back to regular transaction submission',
188+
error,
189+
);
190+
this.#onApproveOrReject();
191+
return useRegularTransactionSubmit; // Fallback to regular transaction submission.
192+
}
186193
}
187194
try {
188195
const submitTransactionResponse = await this.#signAndSubmitTransactions({

0 commit comments

Comments
 (0)