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

useFactoryRegistry

Page through every instance the factory has deployed, plus the total count — the two reads a "list my campaigns" admin view needs together.

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

Description

Page through every instance the factory has deployed, plus the total count — the two reads a "list my campaigns" admin view needs together.

The contract clamps to the tail rather than reverting on an out-of-range offset, so items may come back shorter than limit — page until it does, not until a read throws.

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useFactoryRegistry(args?: UseFactoryRegistryArgs): UseQueryResult<FactoryRegistryPage, Error>;

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
offsetbigintZero-based index to start the page at. Defaults to 0n.
limitbigintPage size. Defaults to 50n.
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 useFactoryRegistry; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const { data } = useFactoryRegistry({ offset: 0n, limit: 20n });

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

See also

Other Read hooks in airdrop v2: