Recovery · pause / withdrawuseQuery

useIsPaused

Read the singleton's paused flag.

Import
@tokenops/sdk/fhe-disperse/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Recovery · pause / withdraw

Description

Read the singleton's paused flag. When true, all disperse operations revert until a PAUSER_ROLE member calls unpause().

Signature

@tokenops/sdk/fhe-disperse/react
ts
function useIsPaused(options?: BaseHookOptions): UseQueryResult<boolean, Error>;
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 useIsPaused; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-disperse/react · @example
tsx
const { data: paused } = useIsPaused();
if (paused) { /* disable submit button *\/ }

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

See also

Other Recovery · pause / withdraw hooks in disperse: