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.

Recovery · pause / withdrawuseMutation

useAirdropPause

Set an airdrop instance's pause flag.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Set an airdrop instance's pause flag. One hook covers both directions — paused: true submits pause(), paused: false submits unpause() — rather than shipping two near-identical hooks for what is one UI toggle.

Pausing does not stop the clock: endTime still passes while paused. Pair with useExtendClaimWindow when the campaign is meant to survive the pause.

Invalidates: this instance's useAirdropPaused entry, and its useAirdropWindow entry — isClaimWindowActive ANDs the pause flag into window.isActive, so a mounted useAirdropWindow consumer would otherwise keep showing a stale isActive after a pause/unpause.

Not invalidated: usePreflightClaim (its PausedError blocker) and useIsSignatureValid (which answers false while paused) also move with the flag. Refetch them if the same session renders both the admin toggle and a claim form.

Signature

@tokenops/sdk/fhe-airdrop/react

function useAirdropPause(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, AirdropPauseArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type AirdropPauseArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).

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 useAirdropPause; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/react · @example

tsx

const setPause = useAirdropPause({ address: airdropAddress });
await setPause.mutateAsync({ paused: true });

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

Errors

This mutation can reject with SDK-level, product-level, or generic-fallback errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop v2 › Errors for the per-class recovery table.

Invalidation recipe

After this mutation succeeds, invalidate the queries it affects so consumer UI re-fetches fresh state. The SDK never auto-invalidates — that's a consumer decision (different apps cache different shapes).

patterns/invalidation.ts

import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const airdropPause = useAirdropPause(/* options */);

airdropPause.mutate(args, {
  onSuccess() {
    // Coarse invalidation: refresh every cached read on this product surface.
    queryClient.invalidateQueries({
      queryKey: ["tokenops-sdk", "fhe-airdrop"],
    });
  },
});