Skip to content
LogoLogo

accessKey.getMetadata

Gets access key information.

Usage

import { client } from './viem.config'
 
const key = await client.accessKey.getMetadata({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  accessKey: '0x1234567890abcdef1234567890abcdef12345678',
})
 
console.log('Key type:', key.keyType)
Key type: p256
console.log('Spend policy:', key.spendPolicy)
Spend policy: unlimited
console.log('Revoked:', key.isRevoked)
Revoked: false

Return Type

type ReturnType = {
  /** The access key address. */
  address: Address
  /** The key type. */
  keyType: 'secp256k1' | 'p256' | 'webAuthn'
  /** The expiry timestamp. */
  expiry: bigint
  /** The spending policy. */
  spendPolicy: 'limited' | 'unlimited'
  /** Whether the key is revoked. */
  isRevoked: 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.