feat: requestPermissions

.changeset/four-pants-notice.md

@@ -0,0 +1,5 @@
+---
+"wagmi": minor
+---
+
+Added `useRequestPermissions` hook.

.changeset/seven-terms-guess.md

@@ -0,0 +1,5 @@
+---
+"@wagmi/core": minor
+---
+
+Added `requestPermissions` action.

packages/core/src/actions/requestPermissions.test.ts

@@ -0,0 +1,30 @@
+import { accounts, config } from '@wagmi/test'
+import { expect, test } from 'vitest'
+
+import { connect } from './connect.js'
+import { disconnect } from './disconnect.js'
+import { requestPermissions } from './requestPermissions.js'
+
+const connector = config.connectors[0]!
+
+test('default', async () => {
+  await connect(config, { connector })
+  try {
+    await expect(
+      requestPermissions(config, { eth_accounts: {} }),
+    ).resolves.toEqual([
+      {
+        caveats: [
+          {
+            type: 'filterResponse',
+            value: accounts,
+          },
+        ],
+        invoker: 'https://example.com',
+        parentCapability: 'eth_accounts',
+      },
+    ])
+  } finally {
+    await disconnect(config, { connector })
+  }
+})

packages/core/src/actions/requestPermissions.ts

@@ -0,0 +1,46 @@
+import {
+  type RequestPermissionsErrorType as viem_RequestPermissionsErrorType,
+  type RequestPermissionsParameters as viem_RequestPermissionsParameters,
+  type RequestPermissionsReturnType as viem_RequestPermissionsReturnType,
+  requestPermissions as viem_requestPermissions,
+} from 'viem/actions'
+import type { Config } from '../createConfig.js'
+import type { BaseErrorType, ErrorType } from '../errors/base.js'
+import type { ConnectorParameter } from '../types/properties.js'
+import type { Compute } from '../types/utils.js'
+import { getAction } from '../utils/getAction.js'
+import {
+  type GetConnectorClientErrorType,
+  getConnectorClient,
+} from './getConnectorClient.js'
+
+export type RequestPermissionsParameters = Compute<
+  viem_RequestPermissionsParameters & ConnectorParameter
+>
+
+export type RequestPermissionsReturnType = viem_RequestPermissionsReturnType
+
+export type RequestPermissionsErrorType =
+  // getConnectorClient()
+  | GetConnectorClientErrorType
+  // base
+  | BaseErrorType
+  | ErrorType
+  // viem
+  | viem_RequestPermissionsErrorType
+
+/** https://wagmi.sh/core/api/actions/requestPermissions */
+export async function requestPermissions(
+  config: Config,
+  parameters: RequestPermissionsParameters,
+): Promise<RequestPermissionsReturnType> {
+  const { connector, ...rest } = parameters
+  const client = await getConnectorClient(config, { connector })
+
+  const action = getAction(
+    client,
+    viem_requestPermissions,
+    'requestPermissions',
+  )
+  return action(rest)
+}

packages/core/src/connectors/mock.test.ts

@@ -72,6 +72,7 @@ test('behavior: connector.getProvider request errors', async () => {
   const connectorFn = mock({
     accounts,
     features: {
+      requestPermissionsError: true,
       signMessageError: true,
       signTypedDataError: true,
       switchChainError: true,
@@ -83,6 +84,18 @@ test('behavior: connector.getProvider request errors', async () => {
   ) as ReturnType<typeof connectorFn>
   const provider = await connector.getProvider()
 
+  await expect(
+    provider.request({
+      method: 'wallet_requestPermissions',
+      params: [{ eth_accounts: {} }],
+    }),
+  ).rejects.toThrowErrorMatchingInlineSnapshot(`
+    [UserRejectedRequestError: User rejected the request.
+
+    Details: Failed to request permissions.
+    Version: viem@2.55.7]
+  `)
+
   await expect(
     provider.request({
       method: 'eth_signTypedData_v4',

packages/core/src/connectors/mock.ts

@@ -34,6 +34,7 @@
         signMessageError?: boolean | Error | undefined
         signTypedDataError?: boolean | Error | undefined
         reconnect?: boolean | undefined
+        requestPermissionsError?: boolean | Error | undefined
         watchAssetError?: boolean | Error | undefined
       }
     | undefined
@@ -176,6 +177,28 @@
           }
 
         // wallet methods
+        if (method === 'wallet_requestPermissions') {
+          if (features.requestPermissionsError) {
+            if (typeof features.requestPermissionsError === 'boolean')
+              throw new UserRejectedRequestError(
+                new Error('Failed to request permissions.'),
+              )
+            throw features.requestPermissionsError
+          }
+          return [
+            {
+              invoker: 'https://example.com',
+              parentCapability: 'eth_accounts',
+              caveats: [
+                {
+                  type: 'filterResponse',
+                  value: parameters.accounts,
+                },
+              ],
+            },
+          ]
+        }
+
         if (method === 'wallet_switchEthereumChain') {
           if (features.switchChainError) {
             if (typeof features.switchChainError === 'boolean')

packages/core/src/exports/actions.test.ts

@@ -49,6 +49,7 @@ test('exports', () => {
       "readContract",
       "readContracts",
       "reconnect",
+      "requestPermissions",
       "sendCalls",
       "sendTransaction",
       "showCallsStatus",

packages/core/src/exports/actions.ts

@@ -293,6 +293,13 @@ export {
   reconnect,
 } from '../actions/reconnect.js'
 
+export {
+  type RequestPermissionsErrorType,
+  type RequestPermissionsParameters,
+  type RequestPermissionsReturnType,
+  requestPermissions,
+} from '../actions/requestPermissions.js'
+
 export {
   type SendCallsErrorType,
   type SendCallsParameters,

packages/core/src/exports/index.test.ts

@@ -49,6 +49,7 @@ test('exports', () => {
       "readContract",
       "readContracts",
       "reconnect",
+      "requestPermissions",
       "sendCalls",
       "sendCallsSync",
       "sendTransaction",

packages/core/src/exports/index.ts

@@ -295,6 +295,13 @@ export {
   reconnect,
 } from '../actions/reconnect.js'
 
+export {
+  type RequestPermissionsErrorType,
+  type RequestPermissionsParameters,
+  type RequestPermissionsReturnType,
+  requestPermissions,
+} from '../actions/requestPermissions.js'
+
 export {
   type SendCallsErrorType,
   type SendCallsParameters,

packages/core/src/exports/query.test.ts

@@ -73,6 +73,7 @@ test('exports', () => {
       "readContractsQueryKey",
       "readContractsQueryOptions",
       "reconnectMutationOptions",
+      "requestPermissionsMutationOptions",
       "sendCallsMutationOptions",
       "sendCallsSyncMutationOptions",
       "sendTransactionMutationOptions",

packages/core/src/exports/query.ts

@@ -362,6 +362,16 @@ export {
   reconnectMutationOptions,
 } from '../query/reconnect.js'
 
+export {
+  type RequestPermissionsData,
+  type RequestPermissionsMutate,
+  type RequestPermissionsMutateAsync,
+  type RequestPermissionsMutationOptions,
+  type RequestPermissionsOptions,
+  type RequestPermissionsVariables,
+  requestPermissionsMutationOptions,
+} from '../query/requestPermissions.js'
+
 export {
   type SendCallsData,
   type SendCallsMutate,

packages/core/src/query/requestPermissions.test.ts

@@ -0,0 +1,45 @@
+import { accounts, config } from '@wagmi/test'
+import { expect, test } from 'vitest'
+
+import { connect } from '../actions/connect.js'
+import { disconnect } from '../actions/disconnect.js'
+import { requestPermissionsMutationOptions } from './requestPermissions.js'
+
+const connector = config.connectors[0]!
+
+test('default', () => {
+  expect(requestPermissionsMutationOptions(config)).toMatchInlineSnapshot(`
+    {
+      "mutationFn": [Function],
+      "mutationKey": [
+        "requestPermissions",
+      ],
+    }
+  `)
+})
+
+test('behavior: mutationFn', async () => {
+  await connect(config, { connector })
+  try {
+    const options = requestPermissionsMutationOptions(config)
+    await expect(
+      options.mutationFn?.({
+        connector,
+        eth_accounts: {},
+      }),
+    ).resolves.toEqual([
+      {
+        caveats: [
+          {
+            type: 'filterResponse',
+            value: accounts,
+          },
+        ],
+        invoker: 'https://example.com',
+        parentCapability: 'eth_accounts',
+      },
+    ])
+  } finally {
+    await disconnect(config, { connector })
+  }
+})

packages/core/src/query/requestPermissions.ts

@@ -0,0 +1,55 @@
+import type { MutationOptions } from '@tanstack/query-core'
+import {
+  type RequestPermissionsErrorType,
+  type RequestPermissionsParameters,
+  type RequestPermissionsReturnType,
+  requestPermissions,
+} from '../actions/requestPermissions.js'
+import type { Config } from '../createConfig.js'
+import type { MutationParameter } from '../types/query.js'
+import type { Compute } from '../types/utils.js'
+import type { Mutate, MutateAsync } from './types.js'
+
+export type RequestPermissionsOptions<context = unknown> = MutationParameter<
+  RequestPermissionsData,
+  RequestPermissionsErrorType,
+  RequestPermissionsVariables,
+  context
+>
+
+export function requestPermissionsMutationOptions<context>(
+  config: Config,
+  options: RequestPermissionsOptions<context> = {},
+): RequestPermissionsMutationOptions {
+  return {
+    ...(options.mutation as any),
+    mutationFn(variables) {
+      return requestPermissions(config, variables)
+    },
+    mutationKey: ['requestPermissions'],
+  }
+}
+
+export type RequestPermissionsMutationOptions = MutationOptions<
+  RequestPermissionsData,
+  RequestPermissionsErrorType,
+  RequestPermissionsVariables
+>
+
+export type RequestPermissionsData = RequestPermissionsReturnType
+
+export type RequestPermissionsVariables = Compute<RequestPermissionsParameters>
+
+export type RequestPermissionsMutate<context = unknown> = Mutate<
+  RequestPermissionsData,
+  RequestPermissionsErrorType,
+  RequestPermissionsVariables,
+  context
+>
+
+export type RequestPermissionsMutateAsync<context = unknown> = MutateAsync<
+  RequestPermissionsData,
+  RequestPermissionsErrorType,
+  RequestPermissionsVariables,
+  context
+>

packages/react/src/exports/actions.test.ts

@@ -49,6 +49,7 @@ test('exports', () => {
       "readContract",
       "readContracts",
       "reconnect",
+      "requestPermissions",
       "sendCalls",
       "sendTransaction",
       "showCallsStatus",

packages/react/src/exports/index.test.ts

@@ -75,6 +75,7 @@ test('exports', () => {
       "useReadContract",
       "useReadContracts",
       "useReconnect",
+      "useRequestPermissions",
       "useSendCalls",
       "useSendCallsSync",
       "useSendTransaction",

packages/react/src/exports/index.ts

@@ -267,6 +267,12 @@ export {
   useReconnect,
 } from '../hooks/useReconnect.js'
 
+export {
+  type UseRequestPermissionsParameters,
+  type UseRequestPermissionsReturnType,
+  useRequestPermissions,
+} from '../hooks/useRequestPermissions.js'
+
 export {
   type UseSendCallsParameters,
   type UseSendCallsReturnType,

packages/react/src/exports/query.test.ts

@@ -74,6 +74,7 @@ test('exports', () => {
       "readContractsQueryKey",
       "readContractsQueryOptions",
       "reconnectMutationOptions",
+      "requestPermissionsMutationOptions",
       "sendCallsMutationOptions",
       "sendCallsSyncMutationOptions",
       "sendTransactionMutationOptions",