Recovery · pause / withdrawuseMutation

useRecoverFromWallets

Recover residual confidential ERC-7984 tokens from the caller's registered wallets to to.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Recovery · pause / withdraw

Description

Recover residual confidential ERC-7984 tokens from the caller's registered wallets to to. Useful after a wallet-mode disperse where subtotals were inflated and tokens remain locked in the subwallets.

Signature

@tokenops/sdk/fhe-disperse/react

function useRecoverFromWallets(options?: DisperseHookOptions): UseMutationResult<Hex, Error, UseRecoverFromWalletsArgs>;

Parameters

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

Property	Type	Description
tokenrequired	Address	ERC-7984 token to recover from the caller's wallets.
torequired	Address	Address to receive the recovered tokens.
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 useRecoverFromWallets; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const recover = useRecoverFromWallets();
recover.mutate({ token, to: address });

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 recoverFromWallets = useRecoverFromWallets(/* options */);

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