Setup · deployuseMutation Curated

useApproveTokenOnWallets

Approve the subwallets to transferFromConfidential for the listed tokens.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Approve the caller's existing registered wallets as ERC-7984 operators for token. Required for wallet-mode disperses on a token different from the one passed at registration.

Prerequisite: call useRegister first — this hook reverts with UserNotRegistered if the caller has no wallet pair on the singleton.

After success, invalidate useHasApprovedSubwallets({ user, token }).

Signature

@tokenops/sdk/fhe-disperse/react

function useApproveTokenOnWallets(options?: DisperseHookOptions): UseMutationResult<Hex, Error, UseApproveTokenOnWalletsArgs>;

Parameters

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

Property	Type	Description
tokenrequired	Address	ERC-7984 token to approve as operator on the caller's wallets.
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 useApproveTokenOnWallets; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const approve = useApproveTokenOnWallets();
approve.mutate({ token });

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 approveTokenOnWallets = useApproveTokenOnWallets(/* options */);

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