Recovery · pause / withdrawuseMutation

useWithdrawGasFee

Fee-collector: withdraw amount wei of accumulated ETH gas fees from the singleton to to.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Fee-collector: withdraw amount wei of accumulated ETH gas fees from the singleton to to. There is no "drain" sentinel — amount: 0n is a no-op that emits a zero-value GasFeeWithdrawn event. Requires FEE_COLLECTOR_ROLE.

Signature

@tokenops/sdk/fhe-disperse/react

function useWithdrawGasFee(options?: DisperseHookOptions): UseMutationResult<Hex, Error, UseWithdrawGasFeeArgs>;

Parameters

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

Property	Type	Description
torequired	Address	Recipient of the withdrawn ETH.
amountrequired	bigint	Amount in wei to withdraw. The contract does not interpret `0n` as "drain" — passing `0n` succeeds with no ETH movement. Read the singleton balance with `publicClient.getBalance(singleton)` to drain.
account	Account \| Address	Override signer account. Falls back to `walletClient.account`.

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

Example

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

tsx

const withdraw = useWithdrawGasFee();
withdraw.mutate({ to: collectorAddress, amount: 0n });

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 viem-passthrough errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Disperse › 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-disperse"],
    });
  },
});