Recovery · pause / withdrawuseMutation

useAirdropWithdrawGasFee

Fee collector: withdraw collected ETH gas fees from the airdrop clone.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Fee collector: withdraw collected ETH gas fees from the airdrop clone. Requires FEE_COLLECTOR_ROLE. Pass amount = 0n to withdraw the entire balance.

Signature

@tokenops/sdk/fhe-airdrop/react

function useAirdropWithdrawGasFee(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseAirdropWithdrawGasFeeArgs>;

Parameters

Shape of the object you pass to .mutate(args).

Property	Type	Description
recipientrequired	Address
amountrequired	bigint	Amount of ETH to withdraw (in wei). Pass `0n` to withdraw the entire balance.
account	Account \| Address

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

Example

components/useAirdropWithdrawGasFeeExample.tsx

tsx

"use client";
import { useAirdropWithdrawGasFee } from "@tokenops/sdk/fhe-airdrop/react";

export function Example() {
  const { mutate, isPending } = useAirdropWithdrawGasFee();

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "AirdropWithdrawGasFee"}
    </button>
  );
}

Auto-generated from the hook's shape (the SDK doesn't carry a TSDoc @example here yet).

Errors

This mutation can reject with SDK-level, product-level, or viem-passthrough errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop › 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 airdropWithdrawGasFee = useAirdropWithdrawGasFee(/* options */);

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