TokenOps
ReaduseQuery

useFactoryCustomFee

Read the per-creator fee override set on the factory for creator.

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

Description

Read the per-creator fee override set on the factory for creator. Returns { enabled: false, ... } when no override exists.

Signature

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

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
creatorAddressAddress whose per-creator fee override to read. Hook is disabled until set.
Want to run a similar shape interactively? The Playground ships 8 ready presets across vesting / airdrop / disperse — deploy a manager, create a vesting, claim, and the airdrop / disperse 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-vesting/react · @example
tsx
const { data: customFee } = useFactoryCustomFee({ creator });
if (customFee?.enabled) { ... use customFee.gasFee/tokenFee ... }

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

See also

Other Read hooks in vesting: