Skip to content

policy.getData

Gets the data for a transfer policy, including its type and admin address.

Usage

example.ts
import { client } from './viem.config'
 
const { admin, type } = await client.policy.getData({
  policyId: 1n,
})
 
console.log('Policy admin:', admin)
Policy admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Policy type:', type)
Policy type: whitelist

Return Type

type ReturnType = {
  /** Address of the policy admin */
  admin: Address
  /** Type of policy */
  type: PolicyType
}

Parameters

policyId

  • Type: bigint

ID of the policy to query.

account (optional)

  • Type: Account | Address

Account that will be used to send the transaction.

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.