2.0 RC docsView 1.x docs
v2.0.0-rc.1 release candidate
The API is frozen and later candidates carry fixes only, except the receipt-free and Safe create surface of /fhe-airdrop, which is @beta. Published on the next dist-tag; latest stays on 1.6.0 until 2.0.0.
ReaduseQuery

useFactoryCompliancePolicy

The admin's per-creator compliance view: the stored override AND the value the factory resolves for that creator.

Import
@tokenops/sdk/fhe-airdrop/advanced/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Read

Description

The admin's per-creator compliance view: the stored override AND the value the factory resolves for that creator. Bundled because only the pair answers "is this creator's setting doing anything?" - an overridden: true whose delegateToCompliance already matches the default is a no-op a panel should show as such.

Overlaps the creator-facing useEffectiveDelegateToCompliance by its effective field. Intentional: different subpath, different audience, same split as useEffectiveUpgradeable vs useFactoryUpgradeabilityPolicy.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react
ts
function useFactoryCompliancePolicy(args?: UseFactoryCompliancePolicyArgs): UseQueryResult<FactoryCompliancePolicy, Error>;

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
creatorAddressThe creator whose policy to inspect.
Want to run a similar shape interactively? The Playground ships 12 ready presets across vesting / airdrop / disperse / faucet — deploy a manager, create a vesting, claim, and run the product equivalents. The deep-link above auto-selects the closest preset to useFactoryCompliancePolicy; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/advanced/react · @example
tsx
const { data: policy } = useFactoryCompliancePolicy({ creator });

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

See also

Other Read hooks in airdrop v2: