propAmm.recipientAllowed

Checks whether a resolved address may receive output from a propAMM pool.

Usage

import { client } from './viem.config'
 
const allowed = await client.propAmm.recipientAllowed({
  pool: '0x0000000000000000000000000000000000000002',
  recipient: '0x0000000000000000000000000000000000000001',
})
true

import { Account, createClient } from 'viem/tempo'
 
export const client = createClient({
  account: Account.fromSecp256k1('0x...'),
})

Return Type

type ReturnType = boolean

Whether the resolved recipient is on the pool allowlist.

Parameters

pool

• Type: Address

Address of the propAMM pool.

recipient

• Type: Address

Resolved recipient 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.