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

useWithdrawConfidential

Sweep an airdrop instance's entire remaining confidential balance to recipient.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Sweep an airdrop instance's entire remaining confidential balance to recipient. Requires TREASURY_ROLE. The amount is not a parameter and never appears in plaintext anywhere — the contract reads its own encrypted balance and moves all of it.

Refused while the campaign is unpaused inside its claim window (ClawbackRequiresPauseError): pause with useAirdropPause first, or run it outside the window.

Invalidates: nothing. No read hook in this subpath's list exposes the confidential pool balance (see useFundAirdrop's TSDoc for the same reasoning), so there is no cached query left stale by a withdrawal.

Signature

@tokenops/sdk/fhe-airdrop/react

function useWithdrawConfidential(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, WithdrawConfidentialArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type WithdrawConfidentialArgs. 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 useWithdrawConfidential; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const withdraw = useWithdrawConfidential({ address: airdropAddress });
await withdraw.mutateAsync({ recipient: treasuryAddress });

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 withdrawConfidential = useWithdrawConfidential(/* options */);

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