policy.isAuthorized

Checks if an address is authorized by a transfer policy.

Usage

import { client } from './viem.config'
 
const isAuthorized = await client.policy.isAuthorized({
  user: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})
 
console.log('Is authorized:', isAuthorized)
Is authorized: true

Return Type

type ReturnType = boolean

Parameters

policyId

• Type: bigint

Policy ID.

user

• Type: Address

User address to check.

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.