♻️ refactor(metamask): Rename to approveTokenPermission

docs/api/classes/MetaMask.md

@@ -11,8 +11,8 @@ This class is the heart of Synpress's MetaMask API.
   - [addNetwork()](MetaMask.md#addnetwork)
   - [addNewAccount()](MetaMask.md#addnewaccount)
   - [approveNewNetwork()](MetaMask.md#approvenewnetwork)
-  - [approvePermission()](MetaMask.md#approvepermission)
   - [approveSwitchNetwork()](MetaMask.md#approveswitchnetwork)
+  - [approveTokenPermission()](MetaMask.md#approvetokenpermission)
   - [confirmSignature()](MetaMask.md#confirmsignature)
   - [confirmTransaction()](MetaMask.md#confirmtransaction)
   - [connectToDapp()](MetaMask.md#connecttodapp)
@@ -23,9 +23,9 @@ This class is the heart of Synpress's MetaMask API.
   - [openSettings()](MetaMask.md#opensettings)
   - [openSidebarMenu()](MetaMask.md#opensidebarmenu)
   - [rejectNewNetwork()](MetaMask.md#rejectnewnetwork)
-  - [rejectPermission()](MetaMask.md#rejectpermission)
   - [rejectSignature()](MetaMask.md#rejectsignature)
   - [rejectSwitchNetwork()](MetaMask.md#rejectswitchnetwork)
+  - [rejectTokenPermission()](MetaMask.md#rejecttokenpermission)
   - [rejectTransaction()](MetaMask.md#rejecttransaction)
   - [resetAccount()](MetaMask.md#resetaccount)
   - [switchAccount()](MetaMask.md#switchaccount)
@@ -138,16 +138,30 @@ Approves a new network request.
 
 ***
 
-### approvePermission()
+### approveSwitchNetwork()
+
+```ts
+approveSwitchNetwork(): Promise<void>
+```
+
+Approves a switch network request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### approveTokenPermission()
 
 ```ts
-approvePermission(options?): Promise<void>
+approveTokenPermission(options?): Promise<void>
 ```
 
 Approves a permission request to spend tokens.
 
 ::: warning
-This function does not work with the NFTs approvals.
+For NFT approvals, use `confirmTransaction` method.
 :::
 
 #### Parameters
@@ -164,20 +178,6 @@ This function does not work with the NFTs approvals.
 
 ***
 
-### approveSwitchNetwork()
-
-```ts
-approveSwitchNetwork(): Promise<void>
-```
-
-Approves a switch network request.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
 ### confirmSignature()
 
 ```ts
@@ -343,45 +343,45 @@ Rejects a new network request.
 
 ***
 
-### rejectPermission()
+### rejectSignature()
 
 ```ts
-rejectPermission(): Promise<void>
+rejectSignature(): Promise<void>
 ```
 
-Rejects a permission request to spend tokens.
-
-::: warning
-This function does not work with the NFTs approvals.
-:::
+Rejects a signature request. This function supports all types of commonly used signatures.
 
 #### Returns
 
 `Promise`\<`void`\>
 
 ***
 
-### rejectSignature()
+### rejectSwitchNetwork()
 
 ```ts
-rejectSignature(): Promise<void>
+rejectSwitchNetwork(): Promise<void>
 ```
 
-Rejects a signature request. This function supports all types of commonly used signatures.
+Rejects a switch network request.
 
 #### Returns
 
 `Promise`\<`void`\>
 
 ***
 
-### rejectSwitchNetwork()
+### rejectTokenPermission()
 
 ```ts
-rejectSwitchNetwork(): Promise<void>
+rejectTokenPermission(): Promise<void>
 ```
 
-Rejects a switch network request.
+Rejects a permission request to spend tokens.
+
+::: warning
+For NFT approvals, use `confirmTransaction` method.
+:::
 
 #### Returns
 

wallets/metamask/src/metamask.ts

@@ -256,34 +256,34 @@ export class MetaMask {
    * Approves a permission request to spend tokens.
    *
    * ::: warning
-   * This function does not work with the NFTs approvals.
+   * For NFT approvals, use `confirmTransaction` method.
    * :::
    *
    * @param options - The permission options.
    * @param options.spendLimit - The spend limit to use for the permission.
    * @param options.gasSetting - The gas setting to use for the approval transaction.
    */
-  async approvePermission(options?: { spendLimit?: 'max' | number; gasSetting?: GasSetting }) {
+  async approveTokenPermission(options?: { spendLimit?: 'max' | number; gasSetting?: GasSetting }) {
     if (!this.extensionId) {
       throw NO_EXTENSION_ID_ERROR
     }
 
-    await this.notificationPage.approvePermission(this.extensionId, options)
+    await this.notificationPage.approveTokenPermission(this.extensionId, options)
   }
 
   /**
    * Rejects a permission request to spend tokens.
    *
    * ::: warning
-   * This function does not work with the NFTs approvals.
+   * For NFT approvals, use `confirmTransaction` method.
    * :::
    */
-  async rejectPermission() {
+  async rejectTokenPermission() {
     if (!this.extensionId) {
       throw NO_EXTENSION_ID_ERROR
     }
 
-    await this.notificationPage.rejectPermission(this.extensionId)
+    await this.notificationPage.rejectTokenPermission(this.extensionId)
   }
 
   /**

wallets/metamask/src/pages/NotificationPage/page.ts

@@ -108,7 +108,10 @@ export class NotificationPage {
     await transaction.confirmAndWaitForMining(this.page, notificationPage, options?.gasSetting ?? 'site')
   }
 
-  async approvePermission(extensionId: string, options?: { spendLimit?: 'max' | number; gasSetting?: GasSetting }) {
+  async approveTokenPermission(
+    extensionId: string,
+    options?: { spendLimit?: 'max' | number; gasSetting?: GasSetting }
+  ) {
     const notificationPage = await getNotificationPageAndWaitForLoad(this.page.context(), extensionId)
 
     if (options?.spendLimit !== undefined) {
@@ -118,7 +121,7 @@ export class NotificationPage {
     await approvePermission.approve(notificationPage, options?.gasSetting ?? 'site')
   }
 
-  async rejectPermission(extensionId: string) {
+  async rejectTokenPermission(extensionId: string) {
     const notificationPage = await getNotificationPageAndWaitForLoad(this.page.context(), extensionId)
 
     await approvePermission.reject(notificationPage)

wallets/metamask/test/e2e/metamask/approvePermission.spec.ts

@@ -23,23 +23,23 @@ describe('with default gas setting', () => {
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission()
+    await metamask.approveTokenPermission()
   })
 
   test('should approve tokens with the `max` limit', async ({ page, metamask, deployToken }) => {
     await deployToken()
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission({ spendLimit: 'max' })
+    await metamask.approveTokenPermission({ spendLimit: 'max' })
   })
 
   test('should approve tokens with the custom limit', async ({ page, metamask, deployToken }) => {
     await deployToken()
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission({ spendLimit: 420 })
+    await metamask.approveTokenPermission({ spendLimit: 420 })
   })
 })
 
@@ -49,7 +49,7 @@ describe('with custom gas setting', () => {
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission({
+    await metamask.approveTokenPermission({
       gasSetting: 'site'
     })
   })
@@ -63,7 +63,7 @@ describe('with custom gas setting', () => {
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission({
+    await metamask.approveTokenPermission({
       spendLimit: 'max',
       gasSetting: {
         maxBaseFee: 250,
@@ -81,7 +81,7 @@ describe('with custom gas setting', () => {
 
     await page.locator('#approveTokens').click()
 
-    await metamask.approvePermission({
+    await metamask.approveTokenPermission({
       spendLimit: 420,
       gasSetting: {
         maxBaseFee: 250,

wallets/metamask/test/e2e/metamask/rejectPermission.spec.ts

@@ -14,5 +14,5 @@ test('should reject approve request', async ({ page, metamask, connectToAnvil })
 
   await page.locator('#approveTokens').click()
 
-  await metamask.rejectPermission()
+  await metamask.rejectTokenPermission()
 })