Skip to content
LogoLogo

accessKey.isAdmin

Checks whether an access key is an admin key for an account.

Returns true for the account's root key or for an active admin access key (see accessKey.authorize with admin: true).

TIP-1049

Usage

import { client } from './viem.config'
 
const isAdmin = await client.accessKey.isAdmin({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  accessKey: '0x1234567890abcdef1234567890abcdef12345678',
})
 
console.log('Admin:', isAdmin)
Admin: true

Return Type

type ReturnType = boolean

Parameters

accessKey

  • Type: Address | AccessKeyAccount

The access key address or account.

account

  • Type: Address | Account

Account address.

blockNumber (optional)

  • Type: bigint

Block number to read the state from.

blockOverrides (optional)

  • Type: BlockOverrides

Block overrides to apply to the state.

blockTag (optional)

  • Type: BlockTag

Block tag to read the state from.

stateOverride (optional)

  • Type: StateOverride

State override to apply.