Add confirmMetamaskTransactionAndWaitForMining

Synthetixio · Sep 7, 2023 · a3f8fcc · a3f8fcc
1 parent 96db944
commit a3f8fcc
Show file tree

Hide file tree

Showing 6 changed files with 142 additions and 0 deletions.
diff --git a/commands/metamask.js b/commands/metamask.js
@@ -1,5 +1,6 @@
 const log = require('debug')('synpress:metamask');
 const playwright = require('./playwright');
+const sleep = require('util').promisify(setTimeout);
 
 const {
   onboardingWelcomePageElements,
@@ -1180,6 +1181,70 @@ const metamask = {
     log('[confirmTransaction] Transaction confirmed!');
     return txData;
   },
+  async confirmTransactionAndWaitForMining(gasConfig) {
+    // Before we switch to MetaMask tab we have to make sure the notification window has opened.
+    //
+    // Chaining `confirmTransactionAndWaitForMining` results in quick tabs switching
+    // which breaks MetaMask and the notification window does not open
+    // until we switch back to the "Cypress" tab.
+    await playwright.switchToMetamaskNotification();
+
+    await switchToMetamaskIfNotActive();
+    await playwright
+      .metamaskWindow()
+      .locator(mainPageElements.tabs.activityButton)
+      .click();
+
+    let retries = 0;
+    const retiresLimit = 600;
+
+    // 120 seconds
+    while (retries < retiresLimit) {
+      const unapprovedTxs = await playwright
+        .metamaskWindow()
+        .getByText('Unapproved')
+        .count();
+      if (unapprovedTxs === 1) {
+        break;
+      }
+      await sleep(200);
+      retries++;
+    }
+
+    if (retries === retiresLimit) {
+      throw new Error(
+        'New unapproved transaction was not detected in 120 seconds.',
+      );
+    }
+
+    const txData = await module.exports.confirmTransaction(gasConfig);
+
+    // 120 seconds
+    while (retries < retiresLimit) {
+      const pendingTxs = await playwright // TODO rename
+        .metamaskWindow()
+        .getByText('Pending')
+        .count();
+      const queuedTxs = await playwright // TODO rename
+        .metamaskWindow()
+        .getByText('Queued')
+        .count();
+      if (pendingTxs === 0 && queuedTxs === 0) {
+        break;
+      }
+      await sleep(200);
+      retries++;
+    }
+
+    if (retries === retiresLimit) {
+      throw new Error('Transaction was not mined in 120 seconds.');
+    }
+
+    await switchToCypressIfNotActive();
+
+    log('[confirmTransactionAndWaitForMining] Transaction confirmed!');
+    return txData;
+  },
   async rejectTransaction() {
     const notificationPage = await playwright.switchToMetamaskNotification();
     await playwright.waitAndClick(

diff --git a/docs/synpress-commands.md b/docs/synpress-commands.md
@@ -368,6 +368,14 @@ Confirm metamask transaction (auto-detects eip-1559 and legacy transactions).
 confirmMetamaskTransaction(gasConfig?: object | string): Chainable<Subject>;
 ```
 
+#### `cy.confirmMetamaskTransactionAndWaitForMining()`
+
+Confirm metamask transaction (auto-detects eip-1559 and legacy transactions) and wait for ALL pending transactions to be mined.
+
+```ts
+confirmMetamaskTransactionAndWaitForMining(gasConfig?: object | string): Chainable<Subject>;
+```
+
 #### `cy.rejectMetamaskTransaction()`
 
 Reject metamask transaction.

diff --git a/plugins/index.js b/plugins/index.js
@@ -108,6 +108,8 @@ module.exports = (on, config) => {
     acceptMetamaskAccess: metamask.acceptAccess,
     rejectMetamaskAccess: metamask.rejectAccess,
     confirmMetamaskTransaction: metamask.confirmTransaction,
+    confirmMetamaskTransactionAndWaitForMining:
+      metamask.confirmTransactionAndWaitForMining,
     rejectMetamaskTransaction: metamask.rejectTransaction,
     allowMetamaskToAddNetwork: async ({ waitForEvent }) =>
       await metamask.allowToAddNetwork({ waitForEvent }),

diff --git a/support/commands.js b/support/commands.js
@@ -196,6 +196,13 @@ Cypress.Commands.add('confirmMetamaskTransaction', gasConfig => {
   return cy.task('confirmMetamaskTransaction', gasConfig);
 });
 
+Cypress.Commands.add(
+  'confirmMetamaskTransactionAndWaitForMining',
+  gasConfig => {
+    return cy.task('confirmMetamaskTransactionAndWaitForMining', gasConfig);
+  },
+);
+
 Cypress.Commands.add('rejectMetamaskTransaction', () => {
   return cy.task('rejectMetamaskTransaction');
 });

diff --git a/support/index.d.ts b/support/index.d.ts
@@ -334,6 +334,30 @@ declare namespace Cypress {
         | 'aggressive'
         | 'site',
     ): Chainable<Subject>;
+    /**
+     * Confirm metamask transaction (auto-detects eip-1559 and legacy transactions) and wait for ALL pending transactions to be mined
+     * @example
+     * cy.confirmMetamaskTransactionAndWaitForMining()
+     * cy.confirmMetamaskTransactionAndWaitForMining({ gasLimit: 1000000, baseFee: 20, priorityFee: 20 }) // eip-1559
+     * cy.confirmMetamaskTransactionAndWaitForMining({ gasLimit: 1000000, gasPrice: 20 }) // legacy
+     * cy.confirmMetamaskTransactionAndWaitForMining('aggressive') // eip-1559 only! => available options: 'low', 'market', 'aggressive', 'site' (site is usually by default)
+     */
+    confirmMetamaskTransactionAndWaitForMining(
+      gasConfig?:
+        | {
+        gasLimit?: number;
+        baseFee?: number;
+        priorityFee?: number;
+      }
+        | {
+        gasLimit?: number;
+        gasPrice?: number;
+      }
+        | 'low'
+        | 'market'
+        | 'aggressive'
+        | 'site',
+    ): Chainable<Subject>;
     /**
      * Reject metamask transaction
      * @example

diff --git a/tests/e2e/specs/metamask-spec.js b/tests/e2e/specs/metamask-spec.js
@@ -387,6 +387,42 @@ describe('Metamask', () => {
         expect(txData.confirmed).to.be.true;
       });
     });
+    it(`confirmMetamaskTransactionAndWaitForMining should confirm legacy transaction and wait for it to be mined`, () => {
+      cy.get('#sendButton').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.recipientPublicAddress).to.be.not.empty;
+        expect(txData.networkName).to.be.not.empty;
+        expect(txData.customNonce).to.be.not.empty;
+        expect(txData.confirmed).to.be.true;
+      });
+    });
+    it(`confirmMetamaskTransactionAndWaitForMining should confirm eip-1559 transaction and wait for it to be mined`, () => {
+      cy.get('#sendEIP1559Button').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.recipientPublicAddress).to.be.not.empty;
+        expect(txData.networkName).to.be.not.empty;
+        expect(txData.customNonce).to.be.not.empty;
+        expect(txData.confirmed).to.be.true;
+      });
+    });
+    it(`chaining confirmMetamaskTransactionAndWaitForMining should work as expected`, () => {
+      cy.get('#sendEIP1559Button').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.confirmed).to.be.true;
+      });
+      cy.get('#sendEIP1559Button').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.confirmed).to.be.true;
+      });
+      cy.get('#sendEIP1559Button').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.confirmed).to.be.true;
+      });
+      cy.get('#sendEIP1559Button').click();
+      cy.confirmMetamaskTransactionAndWaitForMining().then(txData => {
+        expect(txData.confirmed).to.be.true;
+      });
+    });
     it(`confirmMetamaskTransaction should confirm transaction for token creation (contract deployment) and check tx data`, () => {
       cy.get('#createToken').click();
       cy.confirmMetamaskTransaction().then(txData => {