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 the per-creator fee override set on the factory for creator.
Import
@tokenops/sdk/fhe-vesting/reactReturn
{ data, isLoading, error, refetch }Lifecycle
ReadDescription
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.
| Property | Type | Description |
|---|---|---|
| creator | Address | Address whose per-creator fee override to read. Hook is disabled until set. |
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 2.0:
useFactoryDefaultGasFeeRead the factory-wide default gas fee (in wei) — applied to new FeeType.Gas manager clones at deployment.useFactoryDefaultTokenFeeRead the factory-wide default token fee in basis points — applied to new FeeType.DistributionToken manager clones at deployment.useFactoryDefaultFeeTypeRead the factory-wide default fee model (FeeType.Gas or FeeType.DistributionToken) applied to newly-created manager clones.useFactoryFeeCollectorRead the factory's current fee collector address.