> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synpress.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: MetaMask

MetaMask class for interacting with the MetaMask extension in Playwright tests.

This class provides methods to perform various operations on the MetaMask extension,
such as importing wallets, switching networks, confirming transactions, and more.

## Extends

* `MetaMaskAbstract`

## Constructors

### new MetaMask()

```ts theme={null}
new MetaMask(
   context, 
   page, 
   password, 
   extensionId?): MetaMask
```

Creates an instance of MetaMask.

#### Parameters

| Parameter      | Type             | Description                                                                          |
| :------------- | :--------------- | :----------------------------------------------------------------------------------- |
| `context`      | `BrowserContext` | The Playwright BrowserContext in which the MetaMask extension is running.            |
| `page`         | `Page`           | The Playwright Page object representing the MetaMask extension's main page.          |
| `password`     | `string`         | The password for the MetaMask wallet.                                                |
| `extensionId`? | `string`         | The ID of the MetaMask extension. Optional if no interaction with dapps is required. |

#### Returns

[`MetaMask`](./MetaMask)

#### Overrides

`MetaMaskAbstract.constructor`

## Properties

| Property           | Modifier   | Type               | Description                                                              | Overrides                      |
| :----------------- | :--------- | :----------------- | :----------------------------------------------------------------------- | :----------------------------- |
| `context`          | `readonly` | `BrowserContext`   | -                                                                        | -                              |
| `crashPage`        | `readonly` | `CrashPage`        | This property can be used to access selectors for the crash page.        | -                              |
| `extensionId?`     | `readonly` | `string`           | -                                                                        | `MetaMaskAbstract.extensionId` |
| `homePage`         | `readonly` | `HomePage`         | This property can be used to access selectors for the home page.         | -                              |
| `lockPage`         | `readonly` | `LockPage`         | This property can be used to access selectors for the lock page.         | -                              |
| `notificationPage` | `readonly` | `NotificationPage` | This property can be used to access selectors for the notification page. | -                              |
| `onboardingPage`   | `readonly` | `OnboardingPage`   | This property can be used to access selectors for the onboarding page.   | -                              |
| `page`             | `readonly` | `Page`             | -                                                                        | -                              |
| `password`         | `readonly` | `string`           | -                                                                        | `MetaMaskAbstract.password`    |
| `settingsPage`     | `readonly` | `SettingsPage`     | This property can be used to access selectors for the settings page.     | -                              |

## Methods

### addNetwork()

```ts theme={null}
addNetwork(network): Promise<void>
```

Adds a new network to MetaMask.

#### 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`\<`void`>

#### Overrides

`MetaMaskAbstract.addNetwork`

***

### addNewAccount()

```ts theme={null}
addNewAccount(accountName): Promise<void>
```

Adds a new account with the given name.

#### Parameters

| Parameter     | Type     | Description                   |
| :------------ | :------- | :---------------------------- |
| `accountName` | `string` | The name for the new account. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.addNewAccount`

***

### addNewToken()

```ts theme={null}
addNewToken(): Promise<void>
```

Adds a new token.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.addNewToken`

#### Throws

If extensionId is not set.

***

### approveNewNetwork()

```ts theme={null}
approveNewNetwork(): Promise<void>
```

Approves adding a new network.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.approveNewNetwork`

#### Throws

If extensionId is not set.

***

### approveSwitchNetwork()

```ts theme={null}
approveSwitchNetwork(): Promise<void>
```

Approves switching to a new network.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.approveSwitchNetwork`

#### Throws

If extensionId is not set.

***

### approveTokenPermission()

```ts theme={null}
approveTokenPermission(options?): Promise<void>
```

Approves a token permission request.

#### Parameters

| Parameter             | Type                                                                                                                                        | Description                         |
| :-------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------- |
| `options`?            | `object`                                                                                                                                    | Optional settings for the approval. |
| `options.gasSetting`? | \| `"low"` \| `"market"` \| `"aggressive"` \| `"site"` \| \{ `"gasLimit"`: `number`; `"maxBaseFee"`: `number`; `"priorityFee"`: `number`; } | -                                   |
| `options.spendLimit`? | `number` \| `"max"`                                                                                                                         | -                                   |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.approveTokenPermission`

#### Throws

If extensionId is not set.

***

### closeTransactionDetails()

```ts theme={null}
closeTransactionDetails(): Promise<void>
```

Closes the transaction details view.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.closeTransactionDetails`

***

### confirmSignature()

```ts theme={null}
confirmSignature(): Promise<void>
```

Confirms a signature request.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.confirmSignature`

#### Throws

If extensionId is not set.

***

### confirmSignatureWithRisk()

```ts theme={null}
confirmSignatureWithRisk(): Promise<void>
```

Confirms a signature request with risk.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.confirmSignatureWithRisk`

#### Throws

If extensionId is not set.

***

### confirmTransaction()

```ts theme={null}
confirmTransaction(options?): Promise<void>
```

Confirms a transaction.

#### 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`\<`void`>

#### Overrides

`MetaMaskAbstract.confirmTransaction`

#### Throws

If extensionId is not set.

***

### confirmTransactionAndWaitForMining()

```ts theme={null}
confirmTransactionAndWaitForMining(options?): Promise<void>
```

Confirms a transaction and waits for it to be mined.

#### 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`\<`void`>

#### Overrides

`MetaMaskAbstract.confirmTransactionAndWaitForMining`

#### Throws

If extensionId is not set.

***

### connectToDapp()

```ts theme={null}
connectToDapp(accounts?): Promise<void>
```

Connects MetaMask to a dapp.

#### Parameters

| Parameter   | Type        | Description                                     |
| :---------- | :---------- | :---------------------------------------------- |
| `accounts`? | `string`\[] | Optional array of account addresses to connect. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.connectToDapp`

#### Throws

If extensionId is not set.

***

### decrypt()

```ts theme={null}
decrypt(): Promise<void>
```

Decrypts a message.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.decrypt`

#### Throws

If extensionId is not set.

***

### disableEthSign()

```ts theme={null}
disableEthSign(): Promise<void>
```

Disables eth\_sign.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.disableEthSign`

***

### getAccountAddress()

```ts theme={null}
getAccountAddress(): Promise<string>
```

Gets the address of the currently selected account.

#### Returns

`Promise`\<`string`>

The account address.

#### Overrides

`MetaMaskAbstract.getAccountAddress`

***

### goBackToHomePage()

```ts theme={null}
goBackToHomePage(): Promise<void>
```

Navigates back to the home page.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.goBackToHomePage`

***

### importWallet()

```ts theme={null}
importWallet(seedPhrase): Promise<void>
```

Imports a wallet using the given seed phrase.

#### Parameters

| Parameter    | Type     | Description                |
| :----------- | :------- | :------------------------- |
| `seedPhrase` | `string` | The seed phrase to import. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.importWallet`

***

### importWalletFromPrivateKey()

```ts theme={null}
importWalletFromPrivateKey(privateKey): Promise<void>
```

Imports a wallet using the given private key.

#### Parameters

| Parameter    | Type     | Description                |
| :----------- | :------- | :------------------------- |
| `privateKey` | `string` | The private key to import. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.importWalletFromPrivateKey`

***

### lock()

```ts theme={null}
lock(): Promise<void>
```

Locks the MetaMask wallet.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.lock`

***

### openSettings()

```ts theme={null}
openSettings(): Promise<void>
```

Opens the settings page.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.openSettings`

***

### openSidebarMenu()

```ts theme={null}
openSidebarMenu(menu): Promise<void>
```

Opens a specific sidebar menu in the settings.

#### Parameters

| Parameter | Type                   | Description       |
| :-------- | :--------------------- | :---------------- |
| `menu`    | `SettingsSidebarMenus` | The menu to open. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.openSidebarMenu`

***

### openTransactionDetails()

```ts theme={null}
openTransactionDetails(txIndex): Promise<void>
```

Opens the details of a specific transaction.

#### Parameters

| Parameter | Type     | Description                           |
| :-------- | :------- | :------------------------------------ |
| `txIndex` | `number` | The index of the transaction to open. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.openTransactionDetails`

***

### providePublicEncryptionKey()

```ts theme={null}
providePublicEncryptionKey(): Promise<void>
```

Provides a public encryption key.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.providePublicEncryptionKey`

#### Throws

If extensionId is not set.

***

### rejectNewNetwork()

```ts theme={null}
rejectNewNetwork(): Promise<void>
```

Rejects adding a new network.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.rejectNewNetwork`

#### Throws

If extensionId is not set.

***

### rejectSignature()

```ts theme={null}
rejectSignature(): Promise<void>
```

Rejects a signature request.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.rejectSignature`

#### Throws

If extensionId is not set.

***

### rejectSwitchNetwork()

```ts theme={null}
rejectSwitchNetwork(): Promise<void>
```

Rejects switching to a new network.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.rejectSwitchNetwork`

#### Throws

If extensionId is not set.

***

### rejectTokenPermission()

```ts theme={null}
rejectTokenPermission(): Promise<void>
```

Rejects a token permission request.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.rejectTokenPermission`

#### Throws

If extensionId is not set.

***

### rejectTransaction()

```ts theme={null}
rejectTransaction(): Promise<void>
```

Rejects a transaction.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.rejectTransaction`

#### Throws

If extensionId is not set.

***

### renameAccount()

```ts theme={null}
renameAccount(currentAccountName, newAccountName): Promise<void>
```

Renames the currently selected account.

#### Parameters

| Parameter            | Type     | Description                   |
| :------------------- | :------- | :---------------------------- |
| `currentAccountName` | `string` | The current account name.     |
| `newAccountName`     | `string` | The new name for the account. |

#### Returns

`Promise`\<`void`>

***

### resetAccount()

```ts theme={null}
resetAccount(): Promise<void>
```

Resets the account.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.resetAccount`

***

### switchAccount()

```ts theme={null}
switchAccount(accountName): Promise<void>
```

Switches to the account with the given name.

#### Parameters

| Parameter     | Type     | Description                           |
| :------------ | :------- | :------------------------------------ |
| `accountName` | `string` | The name of the account to switch to. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.switchAccount`

***

### switchNetwork()

```ts theme={null}
switchNetwork(networkName, isTestnet?): Promise<void>
```

Switches to the specified network.

#### Parameters

| Parameter     | Type      | Description                                         |
| :------------ | :-------- | :-------------------------------------------------- |
| `networkName` | `string`  | The name of the network to switch to.               |
| `isTestnet`?  | `boolean` | Whether the network is a testnet. Default is false. |

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.switchNetwork`

***

### toggleDismissSecretRecoveryPhraseReminder()

```ts theme={null}
toggleDismissSecretRecoveryPhraseReminder(): Promise<void>
```

Toggles the dismissal of the secret recovery phrase reminder.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.toggleDismissSecretRecoveryPhraseReminder`

***

### toggleShowTestNetworks()

```ts theme={null}
toggleShowTestNetworks(): Promise<void>
```

Toggles the display of test networks.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.toggleShowTestNetworks`

***

### unlock()

```ts theme={null}
unlock(): Promise<void>
```

Unlocks the MetaMask wallet.

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.unlock`

***

### unsafe\_enableEthSign()

```ts theme={null}
unsafe_enableEthSign(): Promise<void>
```

Enables eth\_sign (unsafe).

#### Returns

`Promise`\<`void`>

#### Overrides

`MetaMaskAbstract.unsafe_enableEthSign`