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

useFactoryCustomFee

Read one creator's per-claim fee override.

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

Description

Read one creator's per-claim fee override. enabled: false means the factory's defaultGasFee (see useFactoryFees) applies to them instead.

Kept out of the useFactoryFees bundle on purpose: this read is per-creator, and folding it in would put a creator address into that chain-wide fee key and fragment the cache one slot per creator.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react
ts
function useFactoryCustomFee(args?: UseFactoryCustomFeeArgs): UseQueryResult<CustomFee, Error>;

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
creatorAddressThe creator whose override to read. Disabled until set.
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 useFactoryCustomFee; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/advanced/react · @example
tsx
const { data: custom } = useFactoryCustomFee({ creator });
const fee = custom?.enabled ? custom.gasFee : fees?.defaultGasFee;

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

See also

Other Read hooks in airdrop v2: