getPermissions

Action getting the connected wallet's current permissions.

Import

import { getPermissions } from '@wagmi/core'

Usage

index.ts

import { getPermissions } from '@wagmi/core'
import { config } from './config'

const permissions = await getPermissions(config)

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Parameters

import { type GetPermissionsParameters } from '@wagmi/core'

chainId

config['chains'][number]['id'] | undefined

The ID of chain to get the wallet's permissions for.

index.ts

import { getPermissions } from '@wagmi/core'
import { config } from './config'
import { optimism } from '@wagmi/core/chains'

const permissions = await getPermissions(config, {
  chainId: optimism.id, 
})

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

connector

Connector | undefined

Connector to get permissions for.

index.ts

import { getPermissions } from '@wagmi/core'
import { config } from './config'
import { optimism } from '@wagmi/core/chains'

const { connector } = getAccount(config)
const permissions = await getPermissions(config, {
  connector, 
})

config.ts

import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Return Type

import { type GetPermissionsReturnType } from '@wagmi/core'

WalletPermission[]

The wallet permissions.

Error

import { type GetPermissionsErrorType } from '@wagmi/core'

TanStack Query

import {
  type getPermissionsData,
  type getPermissionsOptions,
  type getPermissionsQueryFnData,
  type getPermissionsQueryKey,
  getPermissionsQueryKey,
  getPermissionsQueryOptions,
} from '@wagmi/core/query'

Viem

• getPermissions