Recovery · pause / withdrawuseMutationencrypts input

useWithdrawAdmin

Admin: withdraw an encrypted amount of the manager's distribution token to msg.sender.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Admin: withdraw an encrypted amount of the manager's distribution token to msg.sender. Caller must hold WITHDRAWER_ROLE. The SDK encrypts amount (or pass encryptedInput to bypass).

Signature

@tokenops/sdk/fhe-vesting/react

function useWithdrawAdmin(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseWithdrawAdminArgs>;

Parameters

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

Property	Type	Description
amountrequired	bigint
encryptor	Encryptor
encryptedInput	EncryptedInput
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 useWithdrawAdmin; pick another from the dropdown if you'd rather start there.

Example

components/useWithdrawAdminExample.tsx

tsx

"use client";
import { useWithdrawAdmin } from "@tokenops/sdk/fhe-vesting/react";

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

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "WithdrawAdmin"}
    </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 Vesting › 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 withdrawAdmin = useWithdrawAdmin(/* options */);

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