Classes
Class: MetaMask
MetaMask class for interacting with the MetaMask extension in Cypress tests.
Creates an instance of MetaMask.
Adds a new network to MetaMask.
Adds a new account with the given name.
Adds a new token to MetaMask.
Approves adding a new network.
Approves switching to a new network.
Approves token permission.
Closes the transaction details view.
Confirms a signature request.
Confirms a transaction.
Confirms a transaction and waits for it to be mined.
Connects to an Anvil node.
Connects MetaMask to a dApp.
Creates an Anvil node for testing.
Decrypts a message.
Deploys a token.
Empties the Anvil node pool.
Gets the current account name.
Gets the current account address.
Gets the current network name.
Navigates back to the home page.
Imports a wallet using a seed phrase.
Imports a wallet using a private key.
Locks the MetaMask wallet.
Opens the settings page.
Opens a specific sidebar menu in the settings.
Opens the details of a specific transaction.
Provides a public encryption key.
Rejects adding a new network.
Rejects a signature request.
Rejects switching to a new network.
Rejects token permission.
Rejects a transaction.
Renames an account.
Resets the current account.
Switches to the account with the given name.
Switches to the specified network.
Toggles the dismissal of the secret recovery phrase reminder.
Toggles the display of test networks.
Unlocks the MetaMask wallet.
Constructors
new MetaMask()
Parameters
| Parameter | Type | Description |
|---|---|---|
context | BrowserContext | The browser context |
metamaskExtensionPage | Page | The MetaMask extension page |
metamaskExtensionId | string | The MetaMask extension ID |
Returns
MetaMask
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
metamaskExtensionPage | readonly | Page | The MetaMask extension page |
metamaskPlaywright | readonly | MetaMask | The MetaMask instance for Playwright |
Methods
addNetwork()
Parameters
| Parameter | Type | Description |
|---|---|---|
network | object | The network configuration to add |
network.blockExplorerUrl? | string | - |
network.chainId | number | - |
network.name | string | - |
network.rpcUrl | string | - |
network.symbol | string | - |
Returns
Promise<boolean>
True if the network was added successfully
addNewAccount()
Parameters
| Parameter | Type | Description |
|---|---|---|
accountName | string | The name for the new account |
Returns
Promise<boolean>
True if the account was added successfully
addNewToken()
Returns
Promise<boolean>
True if the token was added successfully
approveNewNetwork()
Returns
Promise<boolean>
True if the new network was approved successfully
approveSwitchNetwork()
Returns
Promise<boolean>
True if the network switch was approved successfully
approveTokenPermission()
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | object | Optional settings for token approval |
options.gasSetting? | | "low" | "market" | "aggressive" | "site" | { "gasLimit": number; "maxBaseFee": number; "priorityFee": number; } | Gas settings for the transaction |
options.spendLimit? | number | "max" | The spend limit for the token (number or ‘max’) |
Returns
Promise<boolean>
True if the permission was approved, false otherwise
closeTransactionDetails()
Returns
Promise<boolean>
True if the transaction details were closed successfully, false otherwise
confirmSignature()
Returns
Promise<boolean>
True if the signature was confirmed successfully, false otherwise
confirmTransaction()
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | object | Optional gas settings for the transaction |
options.gasSetting? | | "low" | "market" | "aggressive" | "site" | { "gasLimit": number; "maxBaseFee": number; "priorityFee": number; } | - |
Returns
Promise<boolean>
True if the transaction was confirmed successfully
confirmTransactionAndWaitForMining()
Returns
Promise<boolean>
True if the transaction was confirmed and mined successfully, false otherwise
connectToAnvil()
Parameters
| Parameter | Type | Description |
|---|---|---|
options | object | Object containing the RPC URL and chain ID |
options.chainId | number | The chain ID of the Anvil node |
options.rpcUrl | string | The RPC URL of the Anvil node |
Returns
Promise<boolean>
True if the connection was successful, false otherwise
connectToDapp()
Parameters
| Parameter | Type | Description |
|---|---|---|
accounts? | string[] | Optional array of account addresses to connect |
Returns
Promise<boolean>
True if the connection was successful
createAnvilNode()
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | CreateAnvilOptions | Optional Anvil node creation options |
Returns
Promise<{
"anvil": Anvil;
"chainId": number;
"rpcUrl": string;
}>
Object containing the Anvil instance, RPC URL, and chain ID
| Member | Type |
|---|---|
anvil | Anvil |
chainId | number |
rpcUrl | string |
decrypt()
Returns
Promise<boolean>
True if the message was decrypted successfully, false otherwise
deployToken()
Returns
Promise<boolean>
True if the token was deployed successfully
emptyAnvilNode()
Returns
Promise<boolean>
True if the operation was successful
getAccount()
Returns
Promise<string>
The current account name
getAccountAddress()
Returns
Promise<string>
The current account address
getNetwork()
Returns
Promise<string>
The current network name
goBackToHomePage()
Returns
Promise<boolean>
True if the navigation was successful
importWallet()
Parameters
| Parameter | Type | Description |
|---|---|---|
seedPhrase | string | The seed phrase to import |
Returns
Promise<boolean>
True if the import was successful
importWalletFromPrivateKey()
Parameters
| Parameter | Type | Description |
|---|---|---|
privateKey | string | The private key to import |
Returns
Promise<boolean>
True if the import was successful
lock()
Returns
Promise<boolean>
True if the wallet was locked successfully
openSettings()
Returns
Promise<boolean>
True if the settings page was opened successfully
openSidebarMenu()
Parameters
| Parameter | Type | Description |
|---|---|---|
menu | SettingsSidebarMenus | The menu to open |
Returns
Promise<boolean>
True if the menu was opened successfully
openTransactionDetails()
Parameters
| Parameter | Type | Description |
|---|---|---|
txIndex | number | The index of the transaction to open |
Returns
Promise<boolean>
True if the transaction details were opened successfully, false otherwise
providePublicEncryptionKey()
Returns
Promise<boolean>
True if the key was provided successfully, false otherwise
rejectNewNetwork()
Returns
Promise<boolean>
True if the new network was rejected successfully
rejectSignature()
Returns
Promise<boolean>
True if the signature was rejected successfully
rejectSwitchNetwork()
Returns
Promise<boolean>
True if the network switch was rejected successfully
rejectTokenPermission()
Returns
Promise<boolean>
True if the permission was rejected successfully
rejectTransaction()
Returns
Promise<boolean>
True if the transaction was rejected successfully
renameAccount()
Parameters
| Parameter | Type | Description |
|---|---|---|
options | object | Object containing the current and new account names |
options.currentAccountName | string | The current name of the account |
options.newAccountName | string | The new name for the account |
Returns
Promise<boolean>
True if the rename was successful
resetAccount()
Returns
Promise<boolean>
True if the reset was successful
switchAccount()
Parameters
| Parameter | Type | Description |
|---|---|---|
accountName | string | The name of the account to switch to |
Returns
Promise<boolean>
True if the switch was successful
switchNetwork()
Parameters
| Parameter | Type | Description |
|---|---|---|
options | object | Object containing the network name and testnet flag |
options.isTestnet? | boolean | Whether the network is a testnet (default: false) |
options.networkName | string | The name of the network to switch to |
Returns
Promise<boolean>
True if the switch was successful, false otherwise
toggleDismissSecretRecoveryPhraseReminder()
Returns
Promise<boolean>
True if the toggle was successful
toggleShowTestNetworks()
Returns
Promise<boolean>
True if the toggle was successful
unlock()
Returns
Promise<boolean>
True if the wallet was unlocked successfully