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

useFactoryUpgradeabilityPolicy

The admin panel's full upgradeability answer for one creator, in one round trip: the factory default, the per-creator override, and the resolved value.

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

Description

The admin panel's full upgradeability answer for one creator, in one round trip: the factory default, the per-creator override, and the resolved value. Absorbing defaultUpgradeable() here is why it needs no hook of its own.

Duplicates the creator-facing useEffectiveUpgradeable's single field rather than replacing it - that hook stays the cheap read a create form uses to decide whether to offer UUPS.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react
ts
function useFactoryUpgradeabilityPolicy(args?: UseFactoryUpgradeabilityPolicyArgs): UseQueryResult<FactoryUpgradeabilityPolicy, 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 useFactoryUpgradeabilityPolicy; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/advanced/react · @example
tsx
const { data: policy } = useFactoryUpgradeabilityPolicy({ 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: