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

useWithdrawGasFee

Withdraw an airdrop instance's accrued per-claim fee ETH to recipient.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Withdraw an airdrop instance's accrued per-claim fee ETH to recipient.

Requires FEE_COLLECTOR_ROLE, which is self-administered on ConfidentialAirdropBase — no other role can grant it, so useGrantInstanceRoles cannot bootstrap it from an admin key. Use useAirdropRoleMembers(FEE_COLLECTOR_ROLE) to show who can actually call this.

`amount` is public ETH in wei, not a confidential quantity — unlike every other amount in this module it is safe to log and to render.

Invalidates: nothing. No read hook in this subpath exposes the instance's accrued fee balance, so no cached query is left stale. If such a read is ever added, this is its invalidator.

Signature

@tokenops/sdk/fhe-airdrop/react

function useWithdrawGasFee(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, WithdrawGasFeeArgs>;

Parameters

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

Example

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

tsx

const withdrawFees = useWithdrawGasFee({ address: airdropAddress });
await withdrawFees.mutateAsync({ recipient: treasuryAddress, amount: parseEther("0.1") });

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 withdrawGasFee = useWithdrawGasFee(/* options */);

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