Phantom support

Author: zgz2020

wallets/phantom/src/cypress/Phantom.ts

@@ -2,8 +2,6 @@ import { type BrowserContext, type Page, expect } from '@playwright/test'
 import { Phantom as PhantomPlaywright } from '../playwright/Phantom'
 import { waitFor } from '../playwright/utils/waitFor'
 import HomePageSelectors from '../selectors/pages/HomePage'
-import Selectors from '../selectors/pages/HomePage'
-import type { SettingsSidebarMenus } from '../selectors/pages/HomePage/settings'
 import TransactionPage from '../selectors/pages/NotificationPage/transactionPage'
 import type { GasSettings } from '../type/GasSettings'
 import type { Networks } from '../type/Networks'
@@ -137,18 +135,8 @@ export default class Phantom {
    * Resets the current account.
    * @returns True if the reset was successful
    */
-  async resetAccount(): Promise<boolean> {
-    await this.phantomPlaywright.resetAccount()
-    return true
-  }
-
-  /**
-   * Adds a new token to Phantom.
-   * @returns True if the token was added successfully
-   */
-  async addNewToken(): Promise<boolean> {
-    await this.phantomPlaywright.addNewToken()
-    await expect(this.phantomExtensionPage.locator(Selectors.portfolio.singleToken).nth(1)).toContainText('TST')
+  async resetApp(): Promise<boolean> {
+    await this.phantomPlaywright.resetApp()
     return true
   }
 
@@ -200,40 +188,12 @@ export default class Phantom {
    */
   async unlock(): Promise<boolean> {
     await this.phantomPlaywright.unlock()
-    await expect(this.phantomExtensionPage.locator(this.phantomPlaywright.homePage.selectors.logo)).toBeVisible()
+    await expect(
+      this.phantomExtensionPage.locator(this.phantomPlaywright.homePage.selectors.accountMenu.accountName)
+    ).toBeVisible()
     return true
   }
 
-  /**
-   * Provides a public encryption key.
-   * @returns True if the key was provided successfully, false otherwise
-   */
-  async providePublicEncryptionKey(): Promise<boolean> {
-    return await this.phantomPlaywright
-      .providePublicEncryptionKey()
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
-  /**
-   * Decrypts a message.
-   * @returns True if the message was decrypted successfully, false otherwise
-   */
-  async decrypt(): Promise<boolean> {
-    return await this.phantomPlaywright
-      .decrypt()
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
   /**
    * Confirms a signature request.
    * @returns True if the signature was confirmed successfully, false otherwise
@@ -284,72 +244,12 @@ export default class Phantom {
     return true
   }
 
-  /**
-   * Confirms a transaction and waits for it to be mined.
-   * @returns True if the transaction was confirmed and mined successfully, false otherwise
-   */
-  async confirmTransactionAndWaitForMining(): Promise<boolean> {
-    await waitFor(
-      () => this.phantomExtensionPage.locator(TransactionPage.nftApproveAllConfirmationPopup.approveButton).isVisible(),
-      5_000,
-      false
-    )
-    return this.phantomPlaywright
-      .confirmTransactionAndWaitForMining()
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
-  /**
-   * Opens the details of a specific transaction.
-   * @param txIndex - The index of the transaction to open
-   * @returns True if the transaction details were opened successfully, false otherwise
-   */
-  async openTransactionDetails(txIndex: number): Promise<boolean> {
-    return this.phantomPlaywright
-      .openTransactionDetails(txIndex)
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
-  /**
-   * Closes the transaction details view.
-   * @returns True if the transaction details were closed successfully, false otherwise
-   */
-  async closeTransactionDetails(): Promise<boolean> {
-    return this.phantomPlaywright
-      .closeTransactionDetails()
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
   /**
    * Toggles the display of test networks.
    * @returns True if the toggle was successful
    */
-  async toggleShowTestNetworks(): Promise<boolean> {
-    await this.phantomPlaywright.toggleShowTestNetworks()
-    return true
-  }
-
-  /**
-   * Toggles the dismissal of the secret recovery phrase reminder.
-   * @returns True if the toggle was successful
-   */
-  async toggleDismissSecretRecoveryPhraseReminder(): Promise<boolean> {
-    await this.phantomPlaywright.toggleDismissSecretRecoveryPhraseReminder()
+  async toggleTestnetMode(): Promise<boolean> {
+    await this.phantomPlaywright.toggleTestnetMode()
     return true
   }
 
@@ -373,15 +273,4 @@ export default class Phantom {
     await this.phantomPlaywright.openSettings()
     return true
   }
-
-  /**
-   * Opens a specific sidebar menu in the settings.
-   * @param menu - The menu to open
-   * @returns True if the menu was opened successfully
-   */
-  async openSidebarMenu(menu: SettingsSidebarMenus): Promise<boolean> {
-    await this.phantomPlaywright.openSidebarMenu(menu)
-    await expect(this.phantomExtensionPage.locator(HomePageSelectors.settings.sidebarMenu(menu))).toBeVisible()
-    return true
-  }
 }

wallets/phantom/src/cypress/configureSynpress.ts

@@ -1,6 +1,5 @@
 import type { BrowserContext, Page } from '@playwright/test'
 import { ensureRdpPort } from '@synthetixio/synpress-core'
-import type { SettingsSidebarMenus } from '../selectors/pages/HomePage/settings'
 import type { GasSettings } from '../type/GasSettings'
 import type { Networks } from '../type/Networks'
 import Phantom from './Phantom'
@@ -124,44 +123,34 @@ export default function configureSynpress(
       currentAccountName: string
       newAccountName: string
     }) => phantom?.renameAccount({ currentAccountName, newAccountName }),
-    resetAccount: () => phantom?.resetAccount(),
+    resetApp: () => phantom?.resetApp(),
 
     // Network
     getNetwork: () => phantom?.getNetwork(),
 
     // Token
-    addNewToken: () => phantom?.addNewToken(),
     approveTokenPermission: (options?: {
       spendLimit?: number | 'max'
       gasSetting?: GasSettings
     }) => phantom?.approveTokenPermission(options),
     rejectTokenPermission: () => phantom?.rejectTokenPermission(),
 
-    // Encryption
-    providePublicEncryptionKey: () => phantom?.providePublicEncryptionKey(),
-    decrypt: () => phantom?.decrypt(),
-
     // Transactions
     confirmSignature: () => phantom?.confirmSignature(),
     rejectSignature: () => phantom?.rejectSignature(),
     confirmTransaction: (options?: { gasSetting?: GasSettings }) => phantom?.confirmTransaction(options),
     rejectTransaction: () => phantom?.rejectTransaction(),
-    confirmTransactionAndWaitForMining: () => phantom?.confirmTransactionAndWaitForMining(),
-    openTransactionDetails: (txIndex: number) => phantom?.openTransactionDetails(txIndex),
-    closeTransactionDetails: () => phantom?.closeTransactionDetails(),
 
     // Lock/Unlock
     lock: () => phantom?.lock(),
     unlock: () => phantom?.unlock(),
 
     // Toggles
-    toggleShowTestNetworks: () => phantom?.toggleShowTestNetworks(),
-    toggleDismissSecretRecoveryPhraseReminder: () => phantom?.toggleDismissSecretRecoveryPhraseReminder(),
+    toggleTestnetMode: () => phantom?.toggleTestnetMode(),
 
     // Others
     goBackToHomePage: () => phantom?.goBackToHomePage(),
-    openSettings: () => phantom?.openSettings(),
-    openSidebarMenu: (menu: SettingsSidebarMenus) => phantom?.openSidebarMenu(menu)
+    openSettings: () => phantom?.openSettings()
   })
 
   return {

wallets/phantom/src/cypress/support/importPhantomWallet.ts

@@ -1,5 +1,5 @@
 import { type BrowserContext, type Page, chromium } from '@playwright/test'
-import { getExtensionId } from '../../playwright'
+import { getExtensionIdPhantom } from '../../playwright'
 import getPlaywrightPhantom from '../getPlaywrightPhantom'
 
 const SEED_PHRASE = 'test test test test test test test test test test test junk'
@@ -24,7 +24,7 @@ export default async function importPhantomWallet(port: number, importDefaultWal
   const extensionPageIndex = context.pages().findIndex((page) => page.url().includes('chrome-extension://'))
   if (extensionPageIndex !== -1) {
     extensionPage = context.pages()[extensionPageIndex] as Page
-    phantomExtensionId = await getExtensionId(context, 'Phantom')
+    phantomExtensionId = await getExtensionIdPhantom(context, 'Phantom')
 
     const phantom = getPlaywrightPhantom(context, extensionPage, phantomExtensionId)
 

wallets/phantom/src/cypress/support/synpressCommands.ts

@@ -9,7 +9,6 @@
 // https://on.cypress.io/custom-commands
 // ***********************************************
 
-import type { SettingsSidebarMenus } from '../../selectors/pages/HomePage/settings'
 import type { GasSettings } from '../../type/GasSettings'
 
 declare global {
@@ -27,36 +26,28 @@ declare global {
       switchAccount(accountName: string): Chainable<void>
       renameAccount(currentAccountName: string, newAccountName: string): Chainable<void>
       getAccountAddress(): Chainable<string>
-      resetAccount(): Chainable<void>
+      resetApp(): Chainable<void>
 
-      addNewToken(): Chainable<void>
       approveTokenPermission(options?: {
         spendLimit?: number | 'max'
         gasSetting?: GasSettings
       }): Chainable<void>
       rejectTokenPermission(): Chainable<void>
 
-      providePublicEncryptionKey(): Chainable<void>
-      decrypt(): Chainable<void>
       confirmSignature(): Chainable<void>
       rejectSignature(): Chainable<void>
       confirmTransaction(options?: {
         gasSetting?: GasSettings
       }): Chainable<void>
       rejectTransaction(): Chainable<void>
-      confirmTransactionAndWaitForMining(): Chainable<void>
-      openTransactionDetails(txIndex: number): Chainable<void>
-      closeTransactionDetails(): Chainable<void>
 
       lock(): Chainable<void>
       unlock(): Chainable<void>
 
-      toggleShowTestNetworks(): Chainable<void>
-      toggleDismissSecretRecoveryPhraseReminder(): Chainable<void>
+      toggleTestnetMode(): Chainable<void>
 
       goBackToHomePage(): Chainable<void>
       openSettings(): Chainable<void>
-      openSidebarMenu(menu: SettingsSidebarMenus): Chainable<void>
     }
   }
 }
@@ -156,8 +147,8 @@ export default function synpressCommandsForPhantom(): void {
   /**
    * Resets the current account
    */
-  Cypress.Commands.add('resetAccount', () => {
-    return cy.task('resetAccount')
+  Cypress.Commands.add('resetApp', () => {
+    return cy.task('resetApp')
   })
 
   // Network
@@ -171,13 +162,6 @@ export default function synpressCommandsForPhantom(): void {
 
   // Token
 
-  /**
-   * Adds a new token
-   */
-  Cypress.Commands.add('addNewToken', () => {
-    return cy.task('addNewToken')
-  })
-
   /**
    * Approves token permission
    * @param options - Options for approving token permission
@@ -219,33 +203,12 @@ export default function synpressCommandsForPhantom(): void {
   /**
    * Toggles showing test networks
    */
-  Cypress.Commands.add('toggleShowTestNetworks', () => {
-    return cy.task('toggleShowTestNetworks')
-  })
-
-  /**
-   * Toggles dismissing the secret recovery phrase reminder
-   */
-  Cypress.Commands.add('toggleDismissSecretRecoveryPhraseReminder', () => {
-    return cy.task('toggleDismissSecretRecoveryPhraseReminder')
+  Cypress.Commands.add('toggleTestnetMode', () => {
+    return cy.task('toggleTestnetMode')
   })
 
   // Others
 
-  /**
-   * Provides a public encryption key
-   */
-  Cypress.Commands.add('providePublicEncryptionKey', () => {
-    return cy.task('providePublicEncryptionKey')
-  })
-
-  /**
-   * Decrypts a message
-   */
-  Cypress.Commands.add('decrypt', () => {
-    return cy.task('decrypt')
-  })
-
   /**
    * Confirms a signature
    */
@@ -276,28 +239,6 @@ export default function synpressCommandsForPhantom(): void {
     return cy.task('rejectTransaction')
   })
 
-  /**
-   * Confirms a transaction and waits for mining
-   */
-  Cypress.Commands.add('confirmTransactionAndWaitForMining', () => {
-    return cy.task('confirmTransactionAndWaitForMining')
-  })
-
-  /**
-   * Opens transaction details
-   * @param txIndex - The index of the transaction to open
-   */
-  Cypress.Commands.add('openTransactionDetails', (txIndex = 0) => {
-    return cy.task('openTransactionDetails', txIndex)
-  })
-
-  /**
-   * Closes transaction details
-   */
-  Cypress.Commands.add('closeTransactionDetails', () => {
-    return cy.task('closeTransactionDetails')
-  })
-
   /**
    * Goes back to the home page
    */
@@ -311,12 +252,4 @@ export default function synpressCommandsForPhantom(): void {
   Cypress.Commands.add('openSettings', () => {
     return cy.task('openSettings')
   })
-
-  /**
-   * Opens a sidebar menu
-   * @param menu - The menu to open
-   */
-  Cypress.Commands.add('openSidebarMenu', (menu: SettingsSidebarMenus) => {
-    return cy.task('openSidebarMenu', menu)
-  })
 }