feat: handle duplicate shield sub tx

Author: lwin-kyaw

app/scripts/controller-init/confirmations/transaction-controller-init.test.ts

@@ -251,6 +251,8 @@ describe('Transaction Controller Init', () => {
 
 describe('submitShieldSubscriptionSponsorshipIntent', () => {
   const requestMock = buildInitRequestMock();
+  const transactionController =
+    TransactionControllerInit(requestMock).controller;
   const MOCK_STATE = createSwapsMockStore().metamask;
   const MOCK_TX_META = {
     id: '1',
@@ -284,6 +286,7 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
       MOCK_STATE,
       requestMock.initMessenger,
       MOCK_TX_META,
+      transactionController,
     );
 
     expect(mockInitMessengerCall).toHaveBeenCalledWith(
@@ -296,6 +299,23 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
     );
   });
 
+  it('should not submit sponsorship intent if transaction already exists', async () => {
+    const getTransactionsSpy = jest
+      .spyOn(transactionController, 'getTransactions')
+      // @ts-expect-error mock return value
+      .mockReturnValueOnce([MOCK_TX_META]);
+    await submitShieldSubscriptionSponsorshipIntent(
+      // @ts-expect-error mock state
+      MOCK_STATE,
+      requestMock.initMessenger,
+      MOCK_TX_META,
+      transactionController,
+    );
+
+    expect(getTransactionsSpy).toHaveBeenCalled();
+    expect(mockInitMessengerCall).not.toHaveBeenCalled();
+  });
+
   it('should not submit sponsorship intent if not a shield subscription approve transaction', async () => {
     await submitShieldSubscriptionSponsorshipIntent(
       // @ts-expect-error mock state
@@ -305,6 +325,7 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
         id: '1',
         type: TransactionType.personalSign,
       },
+      transactionController,
     );
 
     expect(mockInitMessengerCall).not.toHaveBeenCalled();
@@ -319,6 +340,7 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
         ...MOCK_TX_META,
         chainId: CHAIN_ID_MOCK,
       },
+      transactionController,
     );
 
     expect(mockInitMessengerCall).not.toHaveBeenCalled();
@@ -339,6 +361,7 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
       MOCK_STATE,
       requestMock.initMessenger,
       MOCK_TX_META,
+      transactionController,
     );
 
     expect(mockInitMessengerCall).not.toHaveBeenCalled();
@@ -357,6 +380,7 @@ describe('submitShieldSubscriptionSponsorshipIntent', () => {
         MOCK_STATE,
         requestMock.initMessenger,
         MOCK_TX_META,
+        transactionController,
       ),
     ).resolves.not.toThrow();
     expect(errorSpy).toHaveBeenCalledWith(

app/scripts/controller-init/confirmations/transaction-controller-init.ts

@@ -157,6 +157,7 @@ export const TransactionControllerInit: ControllerInitFunction<
               getFlatState(),
               initMessenger,
               transactionMeta,
+              controller,
             );
           },
         };
@@ -486,12 +487,21 @@ export async function submitShieldSubscriptionSponsorshipIntent(
   flatState: ControllerFlatState,
   initMessenger: TransactionControllerInitMessenger,
   txMeta: TransactionMeta,
+  transactionController: TransactionController,
 ) {
-  const { chainId, type, txParams } = txMeta;
+  const { chainId, type, txParams, actionId, id } = txMeta;
   if (type !== TransactionType.shieldSubscriptionApprove) {
     return;
   }
 
+  const existingTxMeta = transactionController
+    .getTransactions()
+    ?.find((tx) => tx.actionId === actionId || tx.id === id);
+  // If the transaction already exists, we don't need to submit the sponsorship intent again
+  if (existingTxMeta) {
+    return;
+  }
+
   const uiState = getUIState(flatState);
 
   // @ts-expect-error Smart transaction selector types does not match controller state